com.google.gerrit.server.restapi.change.ChangesCollection Maven / Gradle / Ivy
// Copyright (C) 2012 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.change;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.Project;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.IdString;
import com.google.gerrit.extensions.restapi.ResourceConflictException;
import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.RestApiException;
import com.google.gerrit.extensions.restapi.RestCollection;
import com.google.gerrit.extensions.restapi.RestView;
import com.google.gerrit.extensions.restapi.TopLevelResource;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.change.ChangeFinder;
import com.google.gerrit.server.change.ChangeResource;
import com.google.gerrit.server.notedb.ChangeNotes;
import com.google.gerrit.server.permissions.ChangePermission;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.project.ProjectCache;
import com.google.gerrit.server.project.ProjectState;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
import org.eclipse.jgit.lib.ObjectId;
@Singleton
public class ChangesCollection implements RestCollection {
private final Provider user;
private final Provider queryFactory;
private final DynamicMap> views;
private final ChangeFinder changeFinder;
private final ChangeResource.Factory changeResourceFactory;
private final PermissionBackend permissionBackend;
private final ProjectCache projectCache;
private final ChangeNotes.Factory changeNotesFactory;
@Inject
public ChangesCollection(
Provider user,
Provider queryFactory,
DynamicMap> views,
ChangeFinder changeFinder,
ChangeResource.Factory changeResourceFactory,
PermissionBackend permissionBackend,
ProjectCache projectCache,
ChangeNotes.Factory changeNotesFactory) {
this.changeNotesFactory = changeNotesFactory;
this.user = user;
this.queryFactory = queryFactory;
this.views = views;
this.changeFinder = changeFinder;
this.changeResourceFactory = changeResourceFactory;
this.permissionBackend = permissionBackend;
this.projectCache = projectCache;
}
@Override
public QueryChanges list() {
return queryFactory.get();
}
@Override
public DynamicMap> views() {
return views;
}
/**
* Parses {@link ChangeResource} from {@link com.google.gerrit.entities.Change.Id}
*
* Reads the change from index, since project is unknown.
*/
@Override
public ChangeResource parse(TopLevelResource root, IdString id)
throws RestApiException, PermissionBackendException, IOException {
List notes = changeFinder.find(id.encoded(), 2);
if (notes.isEmpty()) {
throw new ResourceNotFoundException(id);
} else if (notes.size() != 1) {
throw new ResourceNotFoundException("Multiple changes found for " + id);
}
ChangeNotes change = notes.get(0);
if (!canRead(change)) {
throw new ResourceNotFoundException(id);
}
checkProjectStatePermitsRead(change.getProjectName());
return changeResourceFactory.create(change, user.get());
}
/**
* Parses {@link ChangeResource} from {@link com.google.gerrit.entities.Change.Id} in {@code
* project} at {@code metaRevId}
*
* Read change from ChangeNotesCache, so the method can be used upon creation, when the change
* might not be yet available in the index.
*/
public ChangeResource parse(Project.NameKey project, Change.Id id, ObjectId metaRevId)
throws ResourceConflictException, ResourceNotFoundException, PermissionBackendException {
checkProjectStatePermitsRead(project);
ChangeNotes change = changeNotesFactory.createChecked(project, id, metaRevId);
if (!canRead(change)) {
throw new ResourceNotFoundException(toIdString(id));
}
return changeResourceFactory.create(change, user.get());
}
/**
* Parses {@link ChangeResource} from {@link com.google.gerrit.entities.Change.Id}
*
*
Reads the change from index, since project is unknown.
*/
public ChangeResource parse(Change.Id id)
throws ResourceConflictException, ResourceNotFoundException, PermissionBackendException {
List notes = changeFinder.find(id);
if (notes.isEmpty()) {
throw new ResourceNotFoundException(toIdString(id));
} else if (notes.size() != 1) {
throw new ResourceNotFoundException("Multiple changes found for " + id);
}
ChangeNotes change = notes.get(0);
if (!canRead(change)) {
throw new ResourceNotFoundException(toIdString(id));
}
checkProjectStatePermitsRead(change.getProjectName());
return changeResourceFactory.create(change, user.get());
}
private static IdString toIdString(Change.Id id) {
return IdString.fromDecoded(id.toString());
}
public ChangeResource parse(ChangeNotes notes, CurrentUser user) {
return changeResourceFactory.create(notes, user);
}
private boolean canRead(ChangeNotes notes) throws PermissionBackendException {
if (!permissionBackend.currentUser().change(notes).test(ChangePermission.READ)) {
return false;
}
Optional projectState = projectCache.get(notes.getProjectName());
if (!projectState.isPresent()) {
return false;
}
return projectState.get().statePermitsRead();
}
private void checkProjectStatePermitsRead(Project.NameKey project)
throws ResourceNotFoundException, ResourceConflictException {
projectCache
.get(project)
.orElseThrow(() -> new ResourceNotFoundException("project not found: " + project.get()))
.checkStatePermitsRead();
}
}