org.sonar.server.ui.Views Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.ui;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import org.apache.commons.lang.ArrayUtils;
import org.sonar.api.server.ServerSide;
import org.sonar.api.web.Page;
import org.sonar.api.web.View;
import org.sonar.api.web.Widget;

import javax.annotation.Nullable;

import java.util.List;
import java.util.Map;
import java.util.Set;
import org.sonar.server.user.UserSession;

@ServerSide
public class Views {

  private Map> pagesPerId = Maps.newHashMap();
  private Set> pages = Sets.newTreeSet();

  private Map> widgetsPerId = Maps.newHashMap();
  private Set> widgets = Sets.newTreeSet();

  private final UserSession userSession;

  public Views(UserSession userSession) {
    this.userSession = userSession;
  }

  public Views(UserSession userSession, View[] views) {
    this.userSession = userSession;
    for (View view : views) {
      register(view);
    }
  }

  private void register(View view) {
    if (view instanceof Widget) {
      ViewProxy proxy = new ViewProxy<>((Widget) view, userSession);
      widgets.add(proxy);
      widgetsPerId.put(proxy.getId(), proxy);

    } else if (view instanceof Page) {
      ViewProxy proxy = new ViewProxy<>((Page) view, userSession);
      pagesPerId.put(proxy.getId(), proxy);
      pages.add(proxy);
    }
  }

  public ViewProxy getPage(String id) {
    return pagesPerId.get(id);
  }

  public List> getPages(String section) {
    return getPages(section, null, null, null);
  }

  public List> getPages(String section,
    @Nullable String resourceScope, @Nullable String resourceQualifier, @Nullable String resourceLanguage) {
    List> result = Lists.newArrayList();
    for (ViewProxy proxy : pages) {
      if (accept(proxy, section, resourceScope, resourceQualifier, resourceLanguage)) {
        result.add(proxy);
      }
    }
    return result;
  }

  public ViewProxy getWidget(String id) {
    return widgetsPerId.get(id);
  }

  public List> getWidgets() {
    return Lists.newArrayList(widgets);
  }

  protected static boolean accept(ViewProxy proxy,
    @Nullable String section, @Nullable String resourceScope, @Nullable String resourceQualifier, @Nullable String resourceLanguage) {
    return acceptNavigationSection(proxy, section)
      && acceptResourceScope(proxy, resourceScope)
      && acceptResourceQualifier(proxy, resourceQualifier)
      && acceptResourceLanguage(proxy, resourceLanguage);
  }

  protected static boolean acceptResourceLanguage(ViewProxy proxy, @Nullable String resourceLanguage) {
    return resourceLanguage == null || ArrayUtils.isEmpty(proxy.getResourceLanguages()) || ArrayUtils.contains(proxy.getResourceLanguages(), resourceLanguage);
  }

  protected static boolean acceptResourceScope(ViewProxy proxy, @Nullable String resourceScope) {
    return resourceScope == null || ArrayUtils.isEmpty(proxy.getResourceScopes()) || ArrayUtils.contains(proxy.getResourceScopes(), resourceScope);
  }

  protected static boolean acceptResourceQualifier(ViewProxy proxy, @Nullable String resourceQualifier) {
    return resourceQualifier == null || ArrayUtils.isEmpty(proxy.getResourceQualifiers()) || ArrayUtils.contains(proxy.getResourceQualifiers(), resourceQualifier);
  }

  protected static boolean acceptNavigationSection(ViewProxy proxy, @Nullable String section) {
    return proxy.isWidget() || section == null || ArrayUtils.contains(proxy.getSections(), section);
  }
}