com.google.gerrit.server.query.approval.ApprovalQueryBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
The newest version!
// Copyright (C) 2021 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.query.approval;

import static java.util.stream.Collectors.joining;

import com.google.common.base.Enums;
import com.google.common.base.Splitter;
import com.google.common.primitives.Ints;
import com.google.gerrit.entities.AccountGroup;
import com.google.gerrit.entities.GroupDescription;
import com.google.gerrit.extensions.client.ChangeKind;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.index.query.Matchable;
import com.google.gerrit.index.query.OperatorPredicate;
import com.google.gerrit.index.query.Predicate;
import com.google.gerrit.index.query.QueryBuilder;
import com.google.gerrit.index.query.QueryParseException;
import com.google.gerrit.server.account.GroupControl;
import com.google.gerrit.server.group.GroupResolver;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.gerrit.server.query.change.ChangeQueryBuilder;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.Optional;

@Singleton
public class ApprovalQueryBuilder extends QueryBuilder {
  private static final QueryBuilder.Definition mydef =
      new QueryBuilder.Definition<>(ApprovalQueryBuilder.class);

  private static final Splitter PLUGIN_SPLITTER = Splitter.on("_");

  public static class ChangeIsPredicate extends OperatorPredicate
      implements Matchable {
    private final Predicate delegate;

    public ChangeIsPredicate(Predicate delegate, String value) {
      super("changeis", value);
      this.delegate = delegate;
    }

    @Override
    public boolean match(ApprovalContext approvalContext) {
      return delegate.asMatchable().match(approvalContext.changeData());
    }

    @Override
    public int getCost() {
      return delegate.asMatchable().getCost();
    }
  }

  public interface UserInOperandFactory {
    Predicate create(UserInPredicate.Field field) throws QueryParseException;
  }

  private final MagicValuePredicate.Factory magicValuePredicate;
  private final UserInPredicate.Factory userInPredicate;
  private final GroupResolver groupResolver;
  private final GroupControl.Factory groupControl;
  private final ListOfFilesUnchangedPredicate listOfFilesUnchangedPredicate;
  private final ChangeQueryBuilder changeQueryBuilder;
  private final DynamicMap userInOperands;

  @Inject
  protected ApprovalQueryBuilder(
      MagicValuePredicate.Factory magicValuePredicate,
      UserInPredicate.Factory userInPredicate,
      GroupResolver groupResolver,
      GroupControl.Factory groupControl,
      ListOfFilesUnchangedPredicate listOfFilesUnchangedPredicate,
      ChangeQueryBuilder changeQueryBuilder,
      DynamicMap userInOperands) {
    super(mydef, null);
    this.magicValuePredicate = magicValuePredicate;
    this.userInPredicate = userInPredicate;
    this.groupResolver = groupResolver;
    this.groupControl = groupControl;
    this.listOfFilesUnchangedPredicate = listOfFilesUnchangedPredicate;
    this.changeQueryBuilder = changeQueryBuilder;
    this.userInOperands = userInOperands;
  }

  @Operator
  public Predicate changekind(String value) throws QueryParseException {
    return parseEnumValue(ChangeKind.class, value)
        .map(ChangeKindPredicate::new)
        .orElseThrow(
            () ->
                new QueryParseException(
                    String.format(
                        "%s is not a valid value for operator 'changekind'. Valid values: %s",
                        value, formatEnumValues(ChangeKind.class))));
  }

  @Operator
  public Predicate is(String value) throws QueryParseException {
    // try to parse exact value
    Optional exactValue = Optional.ofNullable(Ints.tryParse(value));
    if (exactValue.isPresent()) {
      return new ExactValuePredicate(exactValue.get().shortValue());
    }

    // try to parse magic value
    Optional magicValue =
        parseEnumValue(MagicValuePredicate.MagicValue.class, value);
    if (magicValue.isPresent()) {
      return magicValuePredicate.create(magicValue.get());
    }

    // it's neither an exact value nor a magic value
    throw new QueryParseException(
        String.format(
            "%s is not a valid value for operator 'is'. Valid values: %s or integer",
            value, formatEnumValues(MagicValuePredicate.MagicValue.class)));
  }

  @Operator
  public Predicate approverin(String groupOrPluginOperand)
      throws QueryParseException {
    return userin(UserInPredicate.Field.APPROVER, groupOrPluginOperand);
  }

  @Operator
  public Predicate uploaderin(String groupOrPluginOperand)
      throws QueryParseException {
    return userin(UserInPredicate.Field.UPLOADER, groupOrPluginOperand);
  }

  @Operator
  public Predicate has(String value) throws QueryParseException {
    if (value.equals("unchanged-files")) {
      return listOfFilesUnchangedPredicate;
    }
    throw error(
        String.format(
            "'%s' is not a valid value for operator 'has'."
                + " The only valid value is 'unchanged-files'.",
            value));
  }

  @Operator
  public Predicate changeis(String value) throws QueryParseException {
    Predicate changePredicate = changeQueryBuilder.is(value);
    return new ChangeIsPredicate(changePredicate, value);
  }

  private Predicate userin(
      UserInPredicate.Field field, String groupOrPluginOperand) throws QueryParseException {
    // For plugins the value will be operandName_pluginName
    List names = PLUGIN_SPLITTER.splitToList(groupOrPluginOperand);
    if (names.size() == 2) {
      UserInOperandFactory op = userInOperands.get(names.get(1), names.get(0));
      if (op != null) {
        return op.create(field);
      }
    }

    return userInPredicate.create(field, parseGroupOrThrow(groupOrPluginOperand));
  }

  private static > Optional parseEnumValue(Class clazz, String value) {
    return Optional.ofNullable(
        Enums.getIfPresent(clazz, value.toUpperCase(Locale.US).replace('-', '_')).orNull());
  }

  private > String formatEnumValues(Class clazz) {
    return Arrays.stream(clazz.getEnumConstants())
        .map(Object::toString)
        .sorted()
        .collect(joining(", "));
  }

  private AccountGroup.UUID parseGroupOrThrow(String maybeUUID) throws QueryParseException {
    GroupDescription.Basic g = groupResolver.parseId(maybeUUID);
    if (g == null || !groupControl.controlFor(g).isVisible()) {
      throw error("Group " + maybeUUID + " not found");
    }
    return g.getGroupUUID();
  }
}