com.google.gerrit.server.restapi.change.GetArchive 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.10.1
// Copyright (C) 2014 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 static com.google.gerrit.git.ObjectIds.abbreviateName;

import com.google.common.base.Strings;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.BinaryResult;
import com.google.gerrit.extensions.restapi.MethodNotAllowedException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.server.change.ArchiveFormatInternal;
import com.google.gerrit.server.change.RevisionResource;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.inject.Inject;
import java.io.IOException;
import java.io.OutputStream;
import org.eclipse.jgit.api.ArchiveCommand;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;
import org.kohsuke.args4j.Option;

public class GetArchive implements RestReadView {
  private final GitRepositoryManager repoManager;
  private final AllowedFormats allowedFormats;
  @Nullable private String format;

  @Option(name = "--format")
  public void setFormat(String format) {
    this.format = format;
  }

  @Inject
  GetArchive(GitRepositoryManager repoManager, AllowedFormats allowedFormats) {
    this.repoManager = repoManager;
    this.allowedFormats = allowedFormats;
  }

  @Override
  public Response apply(RevisionResource rsrc)
      throws BadRequestException, IOException, MethodNotAllowedException {
    if (Strings.isNullOrEmpty(format)) {
      throw new BadRequestException("format is not specified");
    }
    ArchiveFormatInternal f = allowedFormats.extensions.get("." + format);
    if (f == null) {
      throw new BadRequestException("unknown archive format");
    }
    if (f == ArchiveFormatInternal.ZIP) {
      throw new MethodNotAllowedException("zip format is disabled");
    }
    boolean close = true;
    Repository repo = repoManager.openRepository(rsrc.getProject());
    try {
      RevCommit commit;
      String name;
      try (RevWalk rw = new RevWalk(repo)) {
        commit = rw.parseCommit(rsrc.getPatchSet().commitId());
        name = name(f, rw, commit);
      }

      BinaryResult bin =
          new BinaryResult() {
            @Override
            public void writeTo(OutputStream out) throws IOException {
              try {
                new ArchiveCommand(repo)
                    .setFormat(f.name())
                    .setTree(commit.getTree())
                    .setOutputStream(out)
                    .call();
              } catch (GitAPIException e) {
                throw new IOException(e);
              }
            }

            @Override
            public void close() throws IOException {
              repo.close();
            }
          };

      bin.disableGzip().setContentType(f.getMimeType()).setAttachmentName(name);

      close = false;
      return Response.ok(bin);
    } finally {
      if (close) {
        repo.close();
      }
    }
  }

  private static String name(ArchiveFormatInternal format, RevWalk rw, RevCommit commit)
      throws IOException {
    return String.format(
        "%s%s", abbreviateName(commit, rw.getObjectReader()), format.getDefaultSuffix());
  }
}