java/com/google/gerrit/server/query/project/ProjectIsVisibleToPredicate.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.flogger.FluentLogger;
import com.google.gerrit.index.project.ProjectData;
import com.google.gerrit.index.query.IsVisibleToPredicate;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.index.IndexUtils;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.ProjectPermission;
import com.google.gerrit.server.query.account.AccountQueryBuilder;

public class ProjectIsVisibleToPredicate extends IsVisibleToPredicate<ProjectData> {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  protected final PermissionBackend permissionBackend;
  protected final CurrentUser user;

  public ProjectIsVisibleToPredicate(PermissionBackend permissionBackend, CurrentUser user) {
    super(AccountQueryBuilder.FIELD_VISIBLETO, IndexUtils.describe(user));
    this.permissionBackend = permissionBackend;
    this.user = user;
  }

  @Override
  public boolean match(ProjectData pd) {
    if (!pd.getProject().getState().permitsRead()) {
      logger.atFine().log("Filter out non-readable project: %s", pd);
      return false;
    }

    boolean canSee =
        permissionBackend
            .user(user)
            .project(pd.getProject().getNameKey())
            .testOrFalse(ProjectPermission.ACCESS);
    if (!canSee) {
      logger.atFine().log("Filter out non-visible project: %s", pd);
    }
    return canSee;
  }

  @Override
  public int getCost() {
    return 1;
  }
}