com.google.gerrit.server.extensions.webui.UiActions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.10.0-rc4
// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.server.extensions.webui;

import com.google.common.base.Predicate;
import com.google.common.collect.FluentIterable;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.RestCollection;
import com.google.gerrit.extensions.restapi.RestResource;
import com.google.gerrit.extensions.restapi.RestView;
import com.google.gerrit.extensions.webui.PrivateInternals_UiActionDescription;
import com.google.gerrit.extensions.webui.UiAction;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.account.CapabilityUtils;
import com.google.inject.Provider;
import java.util.Objects;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class UiActions {
  private static final Logger log = LoggerFactory.getLogger(UiActions.class);

  public static Predicate enabled() {
    return UiAction.Description::isEnabled;
  }

  public static  FluentIterable from(
      RestCollection collection, R resource, Provider userProvider) {
    return from(collection.views(), resource, userProvider);
  }

  public static  FluentIterable from(
      DynamicMap> views, R resource, Provider userProvider) {
    return FluentIterable.from(views)
        .transform(
            (DynamicMap.Entry> e) -> {
              int d = e.getExportName().indexOf('.');
              if (d < 0) {
                return null;
              }

              RestView view;
              try {
                view = e.getProvider().get();
              } catch (RuntimeException err) {
                log.error("error creating view {}.{}", e.getPluginName(), e.getExportName(), err);
                return null;
              }

              if (!(view instanceof UiAction)) {
                return null;
              }

              try {
                CapabilityUtils.checkRequiresCapability(
                    userProvider, e.getPluginName(), view.getClass());
              } catch (AuthException exc) {
                return null;
              }

              UiAction.Description dsc = ((UiAction) view).getDescription(resource);
              if (dsc == null || !dsc.isVisible()) {
                return null;
              }

              String name = e.getExportName().substring(d + 1);
              PrivateInternals_UiActionDescription.setMethod(
                  dsc, e.getExportName().substring(0, d));
              PrivateInternals_UiActionDescription.setId(
                  dsc, "gerrit".equals(e.getPluginName()) ? name : e.getPluginName() + '~' + name);
              return dsc;
            })
        .filter(Objects::nonNull);
  }

  private UiActions() {}
}