com.google.gerrit.server.restapi.project.BranchesCollection 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
There is a newer version: 3.11.0-rc3
// 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.restapi.project;

import com.google.gerrit.entities.Project;
import com.google.gerrit.entities.RefNames;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.ChildCollection;
import com.google.gerrit.extensions.restapi.IdString;
import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.RestApiException;
import com.google.gerrit.extensions.restapi.RestView;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.RefPermission;
import com.google.gerrit.server.project.BranchResource;
import com.google.gerrit.server.project.ProjectResource;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.Repository;

@Singleton
public class BranchesCollection implements ChildCollection {
  private final DynamicMap> views;
  private final Provider list;
  private final PermissionBackend permissionBackend;
  private final GitRepositoryManager repoManager;

  @Inject
  BranchesCollection(
      DynamicMap> views,
      Provider list,
      PermissionBackend permissionBackend,
      GitRepositoryManager repoManager) {
    this.views = views;
    this.list = list;
    this.permissionBackend = permissionBackend;
    this.repoManager = repoManager;
  }

  @Override
  public RestView list() {
    return list.get();
  }

  @Override
  public BranchResource parse(ProjectResource parent, IdString id)
      throws RestApiException, IOException, PermissionBackendException {
    parent.getProjectState().checkStatePermitsRead();
    Project.NameKey project = parent.getNameKey();
    try (Repository repo = repoManager.openRepository(project)) {
      Ref ref = repo.exactRef(RefNames.fullName(id.get()));
      if (ref == null) {
        throw new ResourceNotFoundException(id);
      }

      // ListBranches checks the target of a symbolic reference to determine access
      // rights on the symbolic reference itself. This check prevents seeing a hidden
      // branch simply because the symbolic reference name was visible.
      permissionBackend
          .currentUser()
          .project(project)
          .ref(ref.isSymbolic() ? ref.getTarget().getName() : ref.getName())
          .check(RefPermission.READ);
      return new BranchResource(parent.getProjectState(), parent.getUser(), ref);
    } catch (AuthException notAllowed) {
      throw new ResourceNotFoundException(id, notAllowed);
    } catch (RepositoryNotFoundException noRepo) {
      throw new ResourceNotFoundException(id, noRepo);
    }
  }

  @Override
  public DynamicMap> views() {
    return views;
  }
}