| // Copyright (C) 2018 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.googlesource.gerrit.modules.gitrefsfilter; |
| |
| import static com.googlesource.gerrit.modules.gitrefsfilter.ChangesTsCache.CHANGES_CACHE_TS; |
| import static com.googlesource.gerrit.modules.gitrefsfilter.OpenChangesCache.OPEN_CHANGES_CACHE; |
| |
| import com.google.common.cache.LoadingCache; |
| import com.google.common.flogger.FluentLogger; |
| import com.google.gerrit.common.Nullable; |
| import com.google.gerrit.extensions.conditions.BooleanCondition; |
| import com.google.gerrit.extensions.restapi.AuthException; |
| import com.google.gerrit.reviewdb.client.Change; |
| import com.google.gerrit.reviewdb.client.Project; |
| import com.google.gerrit.reviewdb.client.Project.NameKey; |
| import com.google.gerrit.reviewdb.client.RefNames; |
| import com.google.gerrit.reviewdb.server.ReviewDb; |
| import com.google.gerrit.server.notedb.ChangeNotes; |
| import com.google.gerrit.server.permissions.PermissionBackend.ForProject; |
| import com.google.gerrit.server.permissions.PermissionBackend.ForRef; |
| import com.google.gerrit.server.permissions.PermissionBackend.RefFilterOptions; |
| import com.google.gerrit.server.permissions.PermissionBackendException; |
| import com.google.gerrit.server.permissions.ProjectPermission; |
| import com.google.gerrit.server.project.NoSuchProjectException; |
| import com.google.inject.Inject; |
| import com.google.inject.Provider; |
| import com.google.inject.assistedinject.Assisted; |
| import com.google.inject.name.Named; |
| import java.sql.Timestamp; |
| import java.time.Instant; |
| import java.time.temporal.ChronoUnit; |
| import java.util.Collection; |
| import java.util.HashMap; |
| import java.util.Map; |
| import java.util.Set; |
| import java.util.concurrent.ExecutionException; |
| import java.util.stream.Collectors; |
| import org.eclipse.jgit.lib.ObjectId; |
| import org.eclipse.jgit.lib.Ref; |
| import org.eclipse.jgit.lib.Repository; |
| |
| public class ForProjectWrapper extends ForProject { |
| private static final FluentLogger logger = FluentLogger.forEnclosingClass(); |
| private final LoadingCache<ChangeCacheKey, Boolean> openChangesCache; |
| private final LoadingCache<ChangeCacheKey, Long> changesTsCache; |
| private final ForProject defaultForProject; |
| private final NameKey project; |
| private final ChangeNotes.Factory changeNotesFactory; |
| private final Provider<ReviewDb> dbProvider; |
| private final FilterRefsConfig config; |
| private long closedChangesGraceTime; |
| |
| public interface Factory { |
| ForProjectWrapper get(ForProject defaultForProject, Project.NameKey project); |
| } |
| |
| @Inject |
| public ForProjectWrapper( |
| ChangeNotes.Factory changeNotesFactory, |
| Provider<ReviewDb> dbProvider, |
| FilterRefsConfig config, |
| @Named(OPEN_CHANGES_CACHE) LoadingCache<ChangeCacheKey, Boolean> openChangesCache, |
| @Named(CHANGES_CACHE_TS) LoadingCache<ChangeCacheKey, Long> changesTsCache, |
| @Assisted ForProject defaultForProject, |
| @Assisted Project.NameKey project) |
| throws NoSuchProjectException { |
| this.openChangesCache = openChangesCache; |
| this.changesTsCache = changesTsCache; |
| this.defaultForProject = defaultForProject; |
| this.project = project; |
| this.changeNotesFactory = changeNotesFactory; |
| this.dbProvider = dbProvider; |
| this.config = config; |
| this.closedChangesGraceTime = config.getClosedChangeGraceTimeSec(project); |
| } |
| |
| @Override |
| public ForRef ref(String ref) { |
| return defaultForProject.ref(ref); |
| } |
| |
| @Override |
| public void check(ProjectPermission perm) throws AuthException, PermissionBackendException { |
| defaultForProject.check(perm); |
| } |
| |
| @Override |
| public Set<ProjectPermission> test(Collection<ProjectPermission> permSet) |
| throws PermissionBackendException { |
| return defaultForProject.test(permSet); |
| } |
| |
| @Override |
| public Map<String, Ref> filter(Map<String, Ref> refs, Repository repo, RefFilterOptions opts) |
| throws PermissionBackendException { |
| Map<String, Ref> filteredRefs = new HashMap<>(); |
| Map<String, Ref> defaultFilteredRefs = |
| defaultForProject.filter(refs, repo, opts); // FIXME: can we filter the closed refs here? |
| Map<Change.Id, ObjectId> changeRevisions = |
| refs.values().stream() |
| .filter(ref -> ref.getName().endsWith("/meta")) |
| .collect(Collectors.toMap(ForProjectWrapper::changeIdFromRef, Ref::getObjectId)); |
| |
| for (String changeKey : defaultFilteredRefs.keySet()) { |
| Ref ref = defaultFilteredRefs.get(changeKey); |
| String refName = ref.getName(); |
| if (refName.startsWith(RefNames.REFS_USERS) |
| || refName.startsWith(RefNames.REFS_CACHE_AUTOMERGE) |
| || !config.isRefToShow(ref)) { |
| continue; |
| } |
| Change.Id changeId = changeIdFromRef(ref); |
| if (!isChangeRef(changeKey) |
| || (!isChangeMetaRef(refName) |
| && changeId != null |
| && (isOpen(repo, changeId, changeRevisions.get(changeId)) |
| || isRecent(repo, changeId, changeRevisions.get(changeId))))) { |
| filteredRefs.put(changeKey, defaultFilteredRefs.get(changeKey)); |
| } |
| } |
| |
| return filteredRefs; |
| } |
| |
| private static Change.Id changeIdFromRef(Ref ref) { |
| return Change.Id.fromRef(ref.getName()); |
| } |
| |
| private boolean isChangeRef(String changeKey) { |
| return changeKey.startsWith("refs/changes"); |
| } |
| |
| private boolean isChangeMetaRef(String changeKey) { |
| return isChangeRef(changeKey) && changeKey.endsWith("/meta"); |
| } |
| |
| private boolean isOpen(Repository repo, Change.Id changeId, @Nullable ObjectId changeRevision) { |
| try { |
| return openChangesCache.get(ChangeCacheKey.create(repo, changeId, changeRevision, project)); |
| } catch (ExecutionException e) { |
| logger.atWarning().withCause(e).log( |
| "Error getting change '%d' from the cache. Do not hide from the advertised refs", |
| changeId.get()); |
| return true; |
| } |
| } |
| |
| private boolean isRecent(Repository repo, Change.Id changeId, @Nullable ObjectId changeRevision) { |
| try { |
| Timestamp cutOffTs = |
| Timestamp.from( |
| Instant.now().truncatedTo(ChronoUnit.SECONDS).minusSeconds(closedChangesGraceTime)); |
| return changesTsCache |
| .get(ChangeCacheKey.create(repo, changeId, changeRevision, project)) |
| .longValue() |
| >= cutOffTs.getTime(); |
| |
| } catch (ExecutionException e) { |
| logger.atWarning().withCause(e).log( |
| "Error getting change '%d' from the cache. Do not hide from the advertised refs", |
| changeId.get()); |
| return true; |
| } |
| } |
| |
| @Override |
| public BooleanCondition testCond(ProjectPermission perm) { |
| return defaultForProject.testCond(perm); |
| } |
| |
| @Override |
| public String resourcePath() { |
| return defaultForProject.resourcePath(); |
| } |
| } |