java/com/google/gerrit/server/query/project/ProjectQueryBuilderImpl.java

// Copyright (C) 2017 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.project;

import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import com.google.common.primitives.Ints;
import com.google.gerrit.entities.Project;
import com.google.gerrit.extensions.client.ProjectState;
import com.google.gerrit.index.SchemaFieldDefs.SchemaField;
import com.google.gerrit.index.project.ProjectData;
import com.google.gerrit.index.project.ProjectField;
import com.google.gerrit.index.project.ProjectIndex;
import com.google.gerrit.index.project.ProjectIndexCollection;
import com.google.gerrit.index.project.ProjectSubstringPredicate;
import com.google.gerrit.index.query.LimitPredicate;
import com.google.gerrit.index.query.Predicate;
import com.google.gerrit.index.query.QueryBuilder;
import com.google.gerrit.index.query.QueryParseException;
import com.google.inject.Inject;
import java.util.List;
import java.util.Locale;

/** Parses a query string meant to be applied to project objects. */
public class ProjectQueryBuilderImpl extends QueryBuilder<ProjectData, ProjectQueryBuilderImpl>
    implements ProjectQueryBuilder {
  private static final QueryBuilder.Definition<ProjectData, ProjectQueryBuilderImpl> mydef =
      new QueryBuilder.Definition<>(ProjectQueryBuilderImpl.class);

  private final ProjectIndex index;

  @Inject
  ProjectQueryBuilderImpl(ProjectIndexCollection indexes) {
    super(mydef, null);
    this.index = indexes.getSearchIndex();
  }

  @Operator
  public Predicate<ProjectData> name(String name) {
    return ProjectPredicates.name(Project.nameKey(name));
  }

  @Operator
  public Predicate<ProjectData> prefix(String prefix) throws QueryParseException {
    checkOperatorAvailable(ProjectField.PREFIX_NAME_SPEC, "prefix");
    return ProjectPredicates.prefix(prefix);
  }

  @Operator
  public Predicate<ProjectData> substring(String substring) {
    return new ProjectSubstringPredicate(ProjectQueryBuilder.FIELD_SUBSTRING, substring);
  }

  @Operator
  public Predicate<ProjectData> parent(String parentName) {
    if (!index.getSchema().hasField(ProjectField.PARENT_NAME_2_SPEC)) {
      return ProjectPredicates.parent(Project.nameKey(parentName));
    }
    return ProjectPredicates.parent2(Project.nameKey(parentName));
  }

  @Operator
  public Predicate<ProjectData> inname(String namePart) {
    if (namePart.isEmpty()) {
      return name(namePart);
    }
    return ProjectPredicates.inname(namePart);
  }

  @Operator
  public Predicate<ProjectData> description(String description) throws QueryParseException {
    if (Strings.isNullOrEmpty(description)) {
      throw error("description operator requires a value");
    }

    return ProjectPredicates.description(description);
  }

  @Operator
  public Predicate<ProjectData> state(String state) throws QueryParseException {
    if (Strings.isNullOrEmpty(state)) {
      throw error("state operator requires a value");
    }
    ProjectState parsedState;
    try {
      parsedState = ProjectState.valueOf(state.replace('-', '_').toUpperCase(Locale.US));
    } catch (IllegalArgumentException e) {
      throw error("state operator must be either 'active' or 'read-only'", e);
    }
    if (parsedState == ProjectState.HIDDEN) {
      throw error("state operator must be either 'active' or 'read-only'");
    }
    return ProjectPredicates.state(parsedState);
  }

  @Override
  protected Predicate<ProjectData> defaultField(String query) throws QueryParseException {
    // Adapt the capacity of this list when adding more default predicates.
    List<Predicate<ProjectData>> preds = Lists.newArrayListWithCapacity(3);
    preds.add(name(query));
    preds.add(inname(query));
    if (!Strings.isNullOrEmpty(query)) {
      preds.add(description(query));
    }
    return Predicate.or(preds);
  }

  @Operator
  public Predicate<ProjectData> limit(String query) throws QueryParseException {
    Integer limit = Ints.tryParse(query);
    if (limit == null) {
      throw error("Invalid limit: " + query);
    }
    return new LimitPredicate<>(FIELD_LIMIT, limit);
  }

  private void checkOperatorAvailable(SchemaField<ProjectData, ?> field, String operator)
      throws QueryParseException {
    checkFieldAvailable(
        field, String.format("'%s' operator is not supported on this gerrit host", operator));
  }

  private void checkFieldAvailable(SchemaField<ProjectData, ?> field, String errorMessage)
      throws QueryParseException {
    if (!index.getSchema().hasField(field)) {
      throw new QueryParseException(errorMessage);
    }
  }
}