src/main/java/com/googlesource/gerrit/plugins/uploadvalidator/FileExtensionValidator.java

// 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.googlesource.gerrit.plugins.uploadvalidator;

import com.google.common.io.Files;
import com.google.gerrit.extensions.annotations.PluginName;
import com.google.gerrit.server.config.PluginConfig;
import com.google.gerrit.server.config.PluginConfigFactory;
import com.google.gerrit.server.events.CommitReceivedEvent;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.git.validators.CommitValidationException;
import com.google.gerrit.server.git.validators.CommitValidationListener;
import com.google.gerrit.server.git.validators.CommitValidationMessage;
import com.google.gerrit.server.project.NoSuchProjectException;
import com.google.inject.Inject;

import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.diff.DiffEntry;
import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;
import org.eclipse.jgit.treewalk.AbstractTreeIterator;
import org.eclipse.jgit.treewalk.CanonicalTreeParser;
import org.eclipse.jgit.treewalk.TreeWalk;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;

public class FileExtensionValidator implements CommitValidationListener {
  public static String KEY_BLOCKED_FILE_EXTENSION = "blockedFileExtension";

  private final String pluginName;
  private final PluginConfigFactory cfgFactory;
  private final GitRepositoryManager repoManager;

  @Inject
  FileExtensionValidator(@PluginName String pluginName,
      PluginConfigFactory cfgFactory, GitRepositoryManager repoManager) {
    this.pluginName = pluginName;
    this.cfgFactory = cfgFactory;
    this.repoManager = repoManager;
  }

  @Override
  public List<CommitValidationMessage> onCommitReceived(
      CommitReceivedEvent receiveEvent) throws CommitValidationException {
    try {
      PluginConfig cfg =
          cfgFactory.getFromProjectConfig(
              receiveEvent.project.getNameKey(), pluginName);
      String[] blockedFileExtensions =
          cfg.getStringList(KEY_BLOCKED_FILE_EXTENSION);
      if (blockedFileExtensions.length > 0) {
        Repository repo = repoManager.openRepository(receiveEvent.project.getNameKey());
        try {
          List<CommitValidationMessage> messages = new LinkedList<>();
          List<String> files = getFiles(repo, receiveEvent.commit);
          for (String file : files) {
            String ext = Files.getFileExtension(file);
            for (int i = 0; i < blockedFileExtensions.length; i++) {
              if (ext.equalsIgnoreCase(blockedFileExtensions[i])) {
                messages.add(new CommitValidationMessage("blocked file: " + file, true));
                break;
              }
            }
          }
          if (!messages.isEmpty()) {
            throw new CommitValidationException(
                "contains files with blocked file extensions", messages);
          }
        } finally {
          repo.close();
        }
      }
    } catch (NoSuchProjectException | IOException | GitAPIException e) {
      throw new CommitValidationException("failed to check on file extensions", e);
    }

    return Collections.emptyList();
  }

  private List<String> getFiles(Repository repo, RevCommit c) throws IOException, GitAPIException {
    List<String> files = new ArrayList<>();

    if (c.getParentCount() > 0) {
      Git git = new Git(repo);
      List<DiffEntry> diffEntries =
          git.diff().setOldTree(getTreeIterator(repo, c.getName() + "^"))
              .setNewTree(getTreeIterator(repo, c.getName())).call();
      for (DiffEntry e : diffEntries) {
        if (e.getNewPath() != null) {
          files.add(e.getNewPath());
        }
      }
    } else {
      TreeWalk tw = new TreeWalk(repo);
      tw.addTree(c.getTree());
      tw.setRecursive(true);
      while (tw.next()) {
        files.add(tw.getPathString());
      }
    }

    return files;
  }

  private AbstractTreeIterator getTreeIterator(Repository repo, String name)
      throws IOException {
    CanonicalTreeParser p = new CanonicalTreeParser();
    ObjectReader or = repo.newObjectReader();
    try {
      p.reset(or, new RevWalk(repo).parseTree(repo.resolve(name)));
      return p;
    } finally {
      or.release();
    }
  }
}