Revise push/mirror tickets branch triggering

James Moger

2014-03-06 9883341c1fbb35abcb7a1d09f93f6a9e805ea551

 src/main/java/com/gitblit/git/GitblitReceivePack.java

@@ -44,11 +44,13 @@


import com.gitblit.Constants;

import com.gitblit.Constants.AccessRestrictionType;

import com.gitblit.GitBlit;

import com.gitblit.IStoredSettings;

import com.gitblit.Keys;

import com.gitblit.client.Translation;

import com.gitblit.manager.IGitblit;

import com.gitblit.models.RepositoryModel;

import com.gitblit.models.UserModel;

import com.gitblit.tickets.BranchTicketService;

import com.gitblit.utils.ArrayUtils;

import com.gitblit.utils.ClientLogger;

import com.gitblit.utils.CommitCache;

@@ -84,18 +86,27 @@


   protected String gitblitUrl;



   protected String repositoryUrl;



   protected GroovyScriptEngine gse;



   public GitblitReceivePack(Repository db, RepositoryModel repository, UserModel user) {

   protected final IStoredSettings settings;



   protected final IGitblit gitblit;



   public GitblitReceivePack(

         IGitblit gitblit,

         Repository db,

         RepositoryModel repository,

         UserModel user) {



      super(db);

      this.settings = gitblit.getSettings();

      this.gitblit = gitblit;

      this.repository = repository;

      this.user = user == null ? UserModel.ANONYMOUS : user;

      this.groovyDir = GitBlit.getGroovyScriptsFolder();

      this.user = user;

      this.groovyDir = gitblit.getHooksFolder();

      try {

         // set Grape root

         File grapeRoot = GitBlit.getFileOrFolder(Keys.groovy.grapeFolder, "${baseFolder}/groovy/grape").getAbsoluteFile();

         File grapeRoot = gitblit.getGrapesFolder();

         grapeRoot.mkdirs();

         System.setProperty("grape.root", grapeRoot.getAbsolutePath());

         this.gse = new GroovyScriptEngine(groovyDir.getAbsolutePath());

@@ -119,6 +130,14 @@
    */

   @Override

   public void onPreReceive(ReceivePack rp, Collection<ReceiveCommand> commands) {



      if (repository.isMirror) {

         // repository is a mirror

         for (ReceiveCommand cmd : commands) {

            sendRejection(cmd, "Gitblit does not allow pushes to \"{0}\" because it is a mirror!", repository.name);

         }

         return;

      }



      if (repository.isFrozen) {

         // repository is frozen/readonly

@@ -147,8 +166,11 @@
      if (repository.accessRestriction.atLeast(AccessRestrictionType.PUSH) && repository.verifyCommitter) {

         // enforce committer verification

         if (StringUtils.isEmpty(user.emailAddress)) {

            // emit warning if user does not have an email address

            LOGGER.warn(MessageFormat.format("Consider setting an email address for {0} ({1}) to improve committer verification.", user.getDisplayName(), user.username));

            // reject the push because the pushing account does not have an email address

            for (ReceiveCommand cmd : commands) {

               sendRejection(cmd, "Sorry, the account \"{0}\" does not have an email address set for committer verification!", user.username);

            }

            return;

         }



         // Optionally enforce that the committer of first parent chain

@@ -181,16 +203,9 @@


                  PersonIdent committer = commit.getCommitterIdent();

                  if (!user.is(committer.getName(), committer.getEmailAddress())) {

                     String reason;

                     if (StringUtils.isEmpty(user.emailAddress)) {

                        // account does not have an email address

                        reason = MessageFormat.format("{0} by {1} <{2}> was not committed by {3} ({4})",

                              commit.getId().name(), committer.getName(), StringUtils.isEmpty(committer.getEmailAddress()) ? "?":committer.getEmailAddress(), user.getDisplayName(), user.username);

                     } else {

                        // account has an email address

                        reason = MessageFormat.format("{0} by {1} <{2}> was not committed by {3} ({4}) <{5}>",

                              commit.getId().name(), committer.getName(), StringUtils.isEmpty(committer.getEmailAddress()) ? "?":committer.getEmailAddress(), user.getDisplayName(), user.username, user.emailAddress);

                     }

                     // verification failed

                     String reason = MessageFormat.format("{0} by {1} <{2}> was not committed by {3} ({4}) <{5}>",

                           commit.getId().name(), committer.getName(), StringUtils.isEmpty(committer.getEmailAddress()) ? "?":committer.getEmailAddress(), user.getDisplayName(), user.username, user.emailAddress);

                     LOGGER.warn(reason);

                     cmd.setResult(Result.REJECTED_OTHER_REASON, reason);

                     allRejected &= true;

@@ -210,23 +225,33 @@
         }

      }



      // reset branch commit cache on REWIND and DELETE

      for (ReceiveCommand cmd : commands) {

         String ref = cmd.getRefName();

         if (ref.startsWith(Constants.R_HEADS)) {

            switch (cmd.getType()) {

            case UPDATE_NONFASTFORWARD:

            case DELETE:

               // reset branch commit cache on REWIND and DELETE

               CommitCache.instance().clear(repository.name, ref);

               break;

            default:

               break;

            }

         } else if (ref.equals(BranchTicketService.BRANCH)) {

            // ensure pushing user is an administrator OR an owner

            // i.e. prevent ticket tampering

            boolean permitted = user.canAdmin() || repository.isOwner(user.username);

            if (!permitted) {

               sendRejection(cmd, "{0} is not permitted to push to {1}", user.username, ref);

            }

         } else if (ref.startsWith(Constants.R_FOR)) {

            // prevent accidental push to refs/for

            sendRejection(cmd, "{0} is not configured to receive patchsets", repository.name);

         }

      }



      Set<String> scripts = new LinkedHashSet<String>();

      scripts.addAll(GitBlit.self().getPreReceiveScriptsInherited(repository));

      scripts.addAll(gitblit.getPreReceiveScriptsInherited(repository));

      if (!ArrayUtils.isEmpty(repository.preReceiveScripts)) {

         scripts.addAll(repository.preReceiveScripts);

      }

@@ -295,7 +320,7 @@
               String msg = MessageFormat.format(template, branch);

               String prefix;

               if (StringUtils.isEmpty(repository.incrementalPushTagPrefix)) {

                  prefix = GitBlit.getString(Keys.git.defaultIncrementalPushTagPrefix, "r");

                  prefix = settings.getString(Keys.git.defaultIncrementalPushTagPrefix, "r");

               } else {

                  prefix = repository.incrementalPushTagPrefix;

               }

@@ -319,9 +344,18 @@
         LOGGER.error(MessageFormat.format("Failed to update {0} pushlog", repository.name), e);

      }



      // check for updates pushed to the BranchTicketService branch

      // if the BranchTicketService is active it will reindex, as appropriate

      for (ReceiveCommand cmd : commands) {

         if (Result.OK.equals(cmd.getResult())

               && BranchTicketService.BRANCH.equals(cmd.getRefName())) {

            rp.getRepository().fireEvent(new ReceiveCommandEvent(repository, cmd));

         }

      }



      // run Groovy hook scripts

      Set<String> scripts = new LinkedHashSet<String>();

      scripts.addAll(GitBlit.self().getPostReceiveScriptsInherited(repository));

      scripts.addAll(gitblit.getPostReceiveScriptsInherited(repository));

      if (!ArrayUtils.isEmpty(repository.postReceiveScripts)) {

         scripts.addAll(repository.postReceiveScripts);

      }

@@ -374,10 +408,6 @@
      this.gitblitUrl = url;

   }



   protected void setRepositoryUrl(String url) {

      this.repositoryUrl = url;

   }



   protected void sendRejection(final ReceiveCommand cmd, final String why, Object... objects) {

      String text;

      if (ArrayUtils.isEmpty(objects)) {

@@ -389,16 +419,26 @@
      LOGGER.error(text + " (" + user.username + ")");

   }



   protected void sendMessage(String msg, Object... objects) {

   protected void sendHeader(String msg, Object... objects) {

      sendInfo("--> ", msg, objects);

   }



   protected void sendInfo(String msg, Object... objects) {

      sendInfo("    ", msg, objects);

   }



   protected void sendInfo(String prefix, String msg, Object... objects) {

      String text;

      if (ArrayUtils.isEmpty(objects)) {

         text = msg;

         super.sendMessage(msg);

         super.sendMessage(prefix + msg);

      } else {

         text = MessageFormat.format(msg, objects);

         super.sendMessage(text);

         super.sendMessage(prefix + text);

      }

      LOGGER.info(text + " (" + user.username + ")");

      if (!StringUtils.isEmpty(msg)) {

         LOGGER.info(text + " (" + user.username + ")");

      }

   }



   protected void sendError(String msg, Object... objects) {

@@ -410,7 +450,9 @@
         text = MessageFormat.format(msg, objects);

         super.sendError(text);

      }

      LOGGER.error(text + " (" + user.username + ")");

      if (!StringUtils.isEmpty(msg)) {

         LOGGER.error(text + " (" + user.username + ")");

      }

   }



   /**

@@ -421,14 +463,14 @@
    * @param commands

    * @param scripts

    */

   protected void runGroovy(Collection<ReceiveCommand> commands, Set<String> scripts) {

   private void runGroovy(Collection<ReceiveCommand> commands, Set<String> scripts) {

      if (scripts == null || scripts.size() == 0) {

         // no Groovy scripts to execute

         return;

      }



      Binding binding = new Binding();

      binding.setVariable("gitblit", GitBlit.self());

      binding.setVariable("gitblit", gitblit);

      binding.setVariable("repository", repository);

      binding.setVariable("receivePack", this);

      binding.setVariable("user", user);