com.google.gerrit.server.change.Revisions.java Source code

Introduction

Here is the source code for com.google.gerrit.server.change.Revisions.java

Source

// 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.change;

import com.google.common.base.Joiner;
import com.google.common.collect.Lists;
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.RestView;
import com.google.gerrit.reviewdb.client.PatchSet;
import com.google.gerrit.reviewdb.client.RevId;
import com.google.gerrit.reviewdb.server.ReviewDb;
import com.google.gerrit.server.PatchSetUtil;
import com.google.gerrit.server.edit.ChangeEdit;
import com.google.gerrit.server.edit.ChangeEditUtil;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.eclipse.jgit.lib.ObjectId;

@Singleton
public class Revisions implements ChildCollection<ChangeResource, RevisionResource> {
    private final DynamicMap<RestView<RevisionResource>> views;
    private final Provider<ReviewDb> dbProvider;
    private final ChangeEditUtil editUtil;
    private final PatchSetUtil psUtil;

    @Inject
    Revisions(DynamicMap<RestView<RevisionResource>> views, Provider<ReviewDb> dbProvider, ChangeEditUtil editUtil,
            PatchSetUtil psUtil) {
        this.views = views;
        this.dbProvider = dbProvider;
        this.editUtil = editUtil;
        this.psUtil = psUtil;
    }

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

    @Override
    public RestView<ChangeResource> list() throws ResourceNotFoundException {
        throw new ResourceNotFoundException();
    }

    @Override
    public RevisionResource parse(ChangeResource change, IdString id)
            throws ResourceNotFoundException, AuthException, OrmException, IOException {
        if (id.equals("current")) {
            PatchSet ps = psUtil.current(dbProvider.get(), change.getNotes());
            if (ps != null && visible(change, ps)) {
                return new RevisionResource(change, ps).doNotCache();
            }
            throw new ResourceNotFoundException(id);
        }

        List<RevisionResource> match = Lists.newArrayListWithExpectedSize(2);
        for (RevisionResource rsrc : find(change, id.get())) {
            if (visible(change, rsrc.getPatchSet())) {
                match.add(rsrc);
            }
        }
        switch (match.size()) {
        case 0:
            throw new ResourceNotFoundException(id);
        case 1:
            return match.get(0);
        default:
            throw new ResourceNotFoundException(
                    "Multiple patch sets for \"" + id.get() + "\": " + Joiner.on("; ").join(match));
        }
    }

    private boolean visible(ChangeResource change, PatchSet ps) throws OrmException {
        return change.getControl().isPatchVisible(ps, dbProvider.get());
    }

    private List<RevisionResource> find(ChangeResource change, String id)
            throws OrmException, IOException, AuthException {
        if (id.equals("0") || id.equals("edit")) {
            return loadEdit(change, null);
        } else if (id.length() < 6 && id.matches("^[1-9][0-9]{0,4}$")) {
            // Legacy patch set number syntax.
            return byLegacyPatchSetId(change, id);
        } else if (id.length() < 4 || id.length() > RevId.LEN) {
            // Require a minimum of 4 digits.
            // Impossibly long identifier will never match.
            return Collections.emptyList();
        } else {
            List<RevisionResource> out = new ArrayList<>();
            for (PatchSet ps : psUtil.byChange(dbProvider.get(), change.getNotes())) {
                if (ps.getRevision() != null && ps.getRevision().get().startsWith(id)) {
                    out.add(new RevisionResource(change, ps));
                }
            }
            // Not an existing patch set on a change, but might be an edit.
            if (out.isEmpty() && id.length() == RevId.LEN) {
                return loadEdit(change, new RevId(id));
            }
            return out;
        }
    }

    private List<RevisionResource> byLegacyPatchSetId(ChangeResource change, String id) throws OrmException {
        PatchSet ps = psUtil.get(dbProvider.get(), change.getNotes(),
                new PatchSet.Id(change.getId(), Integer.parseInt(id)));
        if (ps != null) {
            return Collections.singletonList(new RevisionResource(change, ps));
        }
        return Collections.emptyList();
    }

    private List<RevisionResource> loadEdit(ChangeResource change, RevId revid)
            throws AuthException, IOException, OrmException {
        Optional<ChangeEdit> edit = editUtil.byChange(change.getChange());
        if (edit.isPresent()) {
            PatchSet ps = new PatchSet(new PatchSet.Id(change.getId(), 0));
            RevId editRevId = new RevId(ObjectId.toString(edit.get().getEditCommit()));
            ps.setRevision(editRevId);
            if (revid == null || editRevId.equals(revid)) {
                return Collections.singletonList(new RevisionResource(change, ps, edit));
            }
        }
        return Collections.emptyList();
    }
}