Correct update of HEAD symbolic reference when target is a tag.

Philip L. McMahon

2012-01-27 30f9d25d77ccb5cd978d4cf8fa389ec819e90e95

 src/com/gitblit/GitBlit.java

@@ -25,11 +25,15 @@
import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.HashMap;

import java.util.LinkedHashSet;

import java.util.List;

import java.util.Map;

import java.util.Map.Entry;

import java.util.Set;

import java.util.TreeSet;

import java.util.concurrent.ConcurrentHashMap;

import java.util.concurrent.Executors;

import java.util.concurrent.ScheduledExecutorService;

@@ -65,17 +69,20 @@
import com.gitblit.models.FederationProposal;

import com.gitblit.models.FederationSet;

import com.gitblit.models.Metric;

import com.gitblit.models.ObjectCache;

import com.gitblit.models.RefModel;

import com.gitblit.models.RepositoryModel;

import com.gitblit.models.ServerSettings;

import com.gitblit.models.ServerStatus;

import com.gitblit.models.SettingModel;

import com.gitblit.models.TeamModel;

import com.gitblit.models.UserModel;

import com.gitblit.utils.ArrayUtils;

import com.gitblit.utils.ByteFormat;

import com.gitblit.utils.FederationUtils;

import com.gitblit.utils.JGitUtils;

import com.gitblit.utils.JsonUtils;

import com.gitblit.utils.MetricUtils;

import com.gitblit.utils.ObjectCache;

import com.gitblit.utils.StringUtils;



/**

@@ -247,6 +254,64 @@
   }



   /**

    * Returns the file object for the specified configuration key.

    * 
    * @return the file

    */

   public static File getFileOrFolder(String key, String defaultFileOrFolder) {

      String fileOrFolder = GitBlit.getString(key, defaultFileOrFolder);

      return getFileOrFolder(fileOrFolder);

   }



   /**

    * Returns the file object which may have it's base-path determined by

    * environment variables for running on a cloud hosting service. All Gitblit

    * file or folder retrievals are (at least initially) funneled through this

    * method so it is the correct point to globally override/alter filesystem

    * access based on environment or some other indicator.

    * 
    * @return the file

    */

   public static File getFileOrFolder(String fileOrFolder) {

      String openShift = System.getenv("OPENSHIFT_DATA_DIR");

      if (!StringUtils.isEmpty(openShift)) {

         // running on RedHat OpenShift

         return new File(openShift, fileOrFolder);

      }

      return new File(fileOrFolder);

   }



   /**

    * Returns the path of the repositories folder. This method checks to see if

    * Gitblit is running on a cloud service and may return an adjusted path.

    * 
    * @return the repositories folder path

    */

   public static File getRepositoriesFolder() {

      return getFileOrFolder(Keys.git.repositoriesFolder, "git");

   }



   /**

    * Returns the path of the proposals folder. This method checks to see if

    * Gitblit is running on a cloud service and may return an adjusted path.

    * 
    * @return the proposals folder path

    */

   public static File getProposalsFolder() {

      return getFileOrFolder(Keys.federation.proposalsFolder, "proposals");

   }



   /**

    * Returns the path of the Groovy folder. This method checks to see if

    * Gitblit is running on a cloud service and may return an adjusted path.

    * 
    * @return the Groovy scripts folder path

    */

   public static File getGroovyScriptsFolder() {

      return getFileOrFolder(Keys.groovy.scriptsFolder, "groovy");

   }



   /**

    * Updates the list of server settings.

    * 

    * @param settings

@@ -386,8 +451,18 @@
    */

   public List<String> getAllUsernames() {

      List<String> names = new ArrayList<String>(userService.getAllUsernames());

      Collections.sort(names);

      return names;

   }



   /**

    * Returns the list of all users available to the login service.

    * 
    * @see IUserService.getAllUsernames()

    * @return list of all usernames

    */

   public List<UserModel> getAllUsers() {

      List<UserModel> users = userService.getAllUsers();

      return users;

   }



   /**

@@ -463,6 +538,95 @@
   }



   /**

    * Returns the list of available teams that a user or repository may be

    * assigned to.

    * 
    * @return the list of teams

    */

   public List<String> getAllTeamnames() {

      List<String> teams = new ArrayList<String>(userService.getAllTeamNames());

      return teams;

   }



   /**

    * Returns the list of available teams that a user or repository may be

    * assigned to.

    * 
    * @return the list of teams

    */

   public List<TeamModel> getAllTeams() {

      List<TeamModel> teams = userService.getAllTeams();

      return teams;

   }



   /**

    * Returns the TeamModel object for the specified name.

    * 
    * @param teamname

    * @return a TeamModel object or null

    */

   public TeamModel getTeamModel(String teamname) {

      return userService.getTeamModel(teamname);

   }



   /**

    * Returns the list of all teams who are allowed to bypass the access

    * restriction placed on the specified repository.

    * 
    * @see IUserService.getTeamnamesForRepositoryRole(String)

    * @param repository

    * @return list of all teamnames that can bypass the access restriction

    */

   public List<String> getRepositoryTeams(RepositoryModel repository) {

      return userService.getTeamnamesForRepositoryRole(repository.name);

   }



   /**

    * Sets the list of all uses who are allowed to bypass the access

    * restriction placed on the specified repository.

    * 
    * @see IUserService.setTeamnamesForRepositoryRole(String, List<String>)

    * @param repository

    * @param teamnames

    * @return true if successful

    */

   public boolean setRepositoryTeams(RepositoryModel repository, List<String> repositoryTeams) {

      return userService.setTeamnamesForRepositoryRole(repository.name, repositoryTeams);

   }



   /**

    * Updates the TeamModel object for the specified name.

    * 
    * @param teamname

    * @param team

    * @param isCreate

    */

   public void updateTeamModel(String teamname, TeamModel team, boolean isCreate)

         throws GitBlitException {

      if (!teamname.equalsIgnoreCase(team.name)) {

         if (userService.getTeamModel(team.name) != null) {

            throw new GitBlitException(MessageFormat.format(

                  "Failed to rename ''{0}'' because ''{1}'' already exists.", teamname,

                  team.name));

         }

      }

      if (!userService.updateTeamModel(teamname, team)) {

         throw new GitBlitException(isCreate ? "Failed to add team!" : "Failed to update team!");

      }

   }



   /**

    * Delete the team object with the specified teamname

    * 
    * @see IUserService.deleteTeam(String)

    * @param teamname

    * @return true if successful

    */

   public boolean deleteTeam(String teamname) {

      return userService.deleteTeam(teamname);

   }



   /**

    * Clears all the cached data for the specified repository.

    * 

    * @param repositoryName

@@ -490,21 +654,38 @@
    * @return repository or null

    */

   public Repository getRepository(String repositoryName) {

      return getRepository(repositoryName, true);

   }



   /**

    * Returns the JGit repository for the specified name.

    * 
    * @param repositoryName

    * @param logError

    * @return repository or null

    */

   public Repository getRepository(String repositoryName, boolean logError) {

      Repository r = null;

      try {

         r = repositoryResolver.open(null, repositoryName);

      } catch (RepositoryNotFoundException e) {

         r = null;

         logger.error("GitBlit.getRepository(String) failed to find "

               + new File(repositoriesFolder, repositoryName).getAbsolutePath());

         if (logError) {

            logger.error("GitBlit.getRepository(String) failed to find "

                  + new File(repositoriesFolder, repositoryName).getAbsolutePath());

         }

      } catch (ServiceNotAuthorizedException e) {

         r = null;

         logger.error("GitBlit.getRepository(String) failed to find "

               + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);

         if (logError) {

            logger.error("GitBlit.getRepository(String) failed to find "

                  + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);

         }

      } catch (ServiceNotEnabledException e) {

         r = null;

         logger.error("GitBlit.getRepository(String) failed to find "

               + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);

         if (logError) {

            logger.error("GitBlit.getRepository(String) failed to find "

                  + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);

         }

      }

      return r;

   }

@@ -555,7 +736,7 @@
         return null;

      }

      if (model.accessRestriction.atLeast(AccessRestrictionType.VIEW)) {

         if (user != null && user.canAccessRepository(model.name)) {

         if (user != null && user.canAccessRepository(model)) {

            return model;

         }

         return null;

@@ -599,7 +780,17 @@
               "gitblit", null, "federationSets")));

         model.isFederated = getConfig(config, "isFederated", false);

         model.origin = config.getString("remote", "origin", "url");

         model.preReceiveScripts = new ArrayList<String>(Arrays.asList(config.getStringList(

               "gitblit", null, "preReceiveScript")));

         model.postReceiveScripts = new ArrayList<String>(Arrays.asList(config.getStringList(

               "gitblit", null, "postReceiveScript")));

         model.mailingLists = new ArrayList<String>(Arrays.asList(config.getStringList(

               "gitblit", null, "mailingList")));

      }

      model.defaultHead = JGitUtils.getDefaultHead(r);

      model.availableHeads = new ArrayList<RefModel>();

      model.availableHeads.addAll(JGitUtils.getLocalBranches(r, true, -1));

      model.availableHeads.addAll(JGitUtils.getTags(r, true, -1));

      r.close();

      return model;

   }

@@ -758,6 +949,11 @@
                           .format("Can not rename repository ''{0}'' to ''{1}'' because ''{1}'' already exists.",

                                 repositoryName, repository.name));

            }

            File parentFile = destFolder.getParentFile();

            if (!parentFile.exists() && !parentFile.mkdirs()) {

               throw new GitBlitException(MessageFormat.format(

                     "Failed to create folder ''{0}''", parentFile.getAbsolutePath()));

            }

            if (!folder.renameTo(destFolder)) {

               throw new GitBlitException(MessageFormat.format(

                     "Failed to rename repository ''{0}'' to ''{1}''.", repositoryName,

@@ -790,6 +986,9 @@
      // update settings

      if (r != null) {

         updateConfiguration(r, repository);

         if (repository.defaultHead != null) {

            JGitUtils.setDefaultHead(r, repository.defaultHead.reference);

         }

         r.close();

      }

   }

@@ -818,6 +1017,16 @@
      config.setString("gitblit", null, "federationStrategy",

            repository.federationStrategy.name());

      config.setBoolean("gitblit", null, "isFederated", repository.isFederated);

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

         config.setStringList("gitblit", null, "preReceiveScript", repository.preReceiveScripts);

      }

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

         config.setStringList("gitblit", null, "postReceiveScript",

               repository.postReceiveScripts);

      }

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

         config.setStringList("gitblit", null, "mailingList", repository.mailingLists);

      }

      try {

         config.save();

      } catch (IOException e) {

@@ -1067,8 +1276,10 @@
      case PULL_REPOSITORIES:

         return token.equals(all) || token.equals(unr) || token.equals(jur);

      case PULL_USERS:

      case PULL_TEAMS:

         return token.equals(all) || token.equals(unr);

      case PULL_SETTINGS:

      case PULL_SCRIPTS:

         return token.equals(all);

      }

      return false;

@@ -1120,8 +1331,7 @@


      try {

         // make the proposals folder

         File proposalsFolder = new File(getString(Keys.federation.proposalsFolder, "proposals")

               .trim());

         File proposalsFolder = getProposalsFolder();

         proposalsFolder.mkdirs();



         // cache json to a file

@@ -1153,7 +1363,7 @@
    */

   public List<FederationProposal> getPendingFederationProposals() {

      List<FederationProposal> list = new ArrayList<FederationProposal>();

      File folder = new File(getString(Keys.federation.proposalsFolder, "proposals").trim());

      File folder = getProposalsFolder();

      if (folder.exists()) {

         File[] files = folder.listFiles(new FileFilter() {

            @Override

@@ -1276,9 +1486,134 @@
    * @return true if the proposal was deleted

    */

   public boolean deletePendingFederationProposal(FederationProposal proposal) {

      File folder = new File(getString(Keys.federation.proposalsFolder, "proposals").trim());

      File folder = getProposalsFolder();

      File file = new File(folder, proposal.token + Constants.PROPOSAL_EXT);

      return file.delete();

   }



   /**

    * Returns the list of all Groovy push hook scripts. Script files must have

    * .groovy extension

    * 
    * @return list of available hook scripts

    */

   public List<String> getAllScripts() {

      File groovyFolder = getGroovyScriptsFolder();

      File[] files = groovyFolder.listFiles(new FileFilter() {

         @Override

         public boolean accept(File pathname) {

            return pathname.isFile() && pathname.getName().endsWith(".groovy");

         }

      });

      List<String> scripts = new ArrayList<String>();

      if (files != null) {

         for (File file : files) {

            String script = file.getName().substring(0, file.getName().lastIndexOf('.'));

            scripts.add(script);

         }

      }

      return scripts;

   }



   /**

    * Returns the list of pre-receive scripts the repository inherited from the

    * global settings and team affiliations.

    * 
    * @param repository

    *            if null only the globally specified scripts are returned

    * @return a list of scripts

    */

   public List<String> getPreReceiveScriptsInherited(RepositoryModel repository) {

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

      // Globals

      for (String script : getStrings(Keys.groovy.preReceiveScripts)) {

         if (script.endsWith(".groovy")) {

            scripts.add(script.substring(0, script.lastIndexOf('.')));

         } else {

            scripts.add(script);

         }

      }



      // Team Scripts

      if (repository != null) {

         for (String teamname : userService.getTeamnamesForRepositoryRole(repository.name)) {

            TeamModel team = userService.getTeamModel(teamname);

            scripts.addAll(team.preReceiveScripts);

         }

      }

      return new ArrayList<String>(scripts);

   }



   /**

    * Returns the list of all available Groovy pre-receive push hook scripts

    * that are not already inherited by the repository. Script files must have

    * .groovy extension

    * 
    * @param repository

    *            optional parameter

    * @return list of available hook scripts

    */

   public List<String> getPreReceiveScriptsUnused(RepositoryModel repository) {

      Set<String> inherited = new TreeSet<String>(getPreReceiveScriptsInherited(repository));



      // create list of available scripts by excluding inherited scripts

      List<String> scripts = new ArrayList<String>();

      for (String script : getAllScripts()) {

         if (!inherited.contains(script)) {

            scripts.add(script);

         }

      }

      return scripts;

   }



   /**

    * Returns the list of post-receive scripts the repository inherited from

    * the global settings and team affiliations.

    * 
    * @param repository

    *            if null only the globally specified scripts are returned

    * @return a list of scripts

    */

   public List<String> getPostReceiveScriptsInherited(RepositoryModel repository) {

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

      // Global Scripts

      for (String script : getStrings(Keys.groovy.postReceiveScripts)) {

         if (script.endsWith(".groovy")) {

            scripts.add(script.substring(0, script.lastIndexOf('.')));

         } else {

            scripts.add(script);

         }

      }

      // Team Scripts

      if (repository != null) {

         for (String teamname : userService.getTeamnamesForRepositoryRole(repository.name)) {

            TeamModel team = userService.getTeamModel(teamname);

            scripts.addAll(team.postReceiveScripts);

         }

      }

      return new ArrayList<String>(scripts);

   }



   /**

    * Returns the list of unused Groovy post-receive push hook scripts that are

    * not already inherited by the repository. Script files must have .groovy

    * extension

    * 
    * @param repository

    *            optional parameter

    * @return list of available hook scripts

    */

   public List<String> getPostReceiveScriptsUnused(RepositoryModel repository) {

      Set<String> inherited = new TreeSet<String>(getPostReceiveScriptsInherited(repository));



      // create list of available scripts by excluding inherited scripts

      List<String> scripts = new ArrayList<String>();

      for (String script : getAllScripts()) {

         if (!inherited.contains(script)) {

            scripts.add(script);

         }

      }

      return scripts;

   }



   /**

@@ -1287,9 +1622,40 @@
    * @param subject

    * @param message

    */

   public void notifyAdministrators(String subject, String message) {

   public void sendMailToAdministrators(String subject, String message) {

      try {

         Message mail = mailExecutor.createMessageForAdministrators();

         if (mail != null) {

            mail.setSubject(subject);

            mail.setText(message);

            mailExecutor.queue(mail);

         }

      } catch (MessagingException e) {

         logger.error("Messaging error", e);

      }

   }



   /**

    * Notify users by email of something.

    * 
    * @param subject

    * @param message

    * @param toAddresses

    */

   public void sendMail(String subject, String message, Collection<String> toAddresses) {

      this.sendMail(subject, message, toAddresses.toArray(new String[0]));

   }



   /**

    * Notify users by email of something.

    * 
    * @param subject

    * @param message

    * @param toAddresses

    */

   public void sendMail(String subject, String message, String... toAddresses) {

      try {

         Message mail = mailExecutor.createMessage(toAddresses);

         if (mail != null) {

            mail.setSubject(subject);

            mail.setText(message);

@@ -1307,7 +1673,13 @@
    */

   public ServerSettings getSettingsModel() {

      // ensure that the current values are updated in the setting models

      settingsModel.updateCurrentValues(settings);

      for (String key : settings.getAllKeys(null)) {

         SettingModel setting = settingsModel.get(key);

         if (setting != null) {

            setting.currentValue = settings.getString(key, "");

         }

      }

      settingsModel.pushScripts = getAllScripts();

      return settingsModel;

   }



@@ -1386,7 +1758,7 @@
   public void configureContext(IStoredSettings settings, boolean startFederation) {

      logger.info("Reading configuration from " + settings.toString());

      this.settings = settings;

      repositoriesFolder = new File(settings.getString(Keys.git.repositoriesFolder, "git"));

      repositoriesFolder = getRepositoriesFolder();

      logger.info("Git repositories folder " + repositoriesFolder.getAbsolutePath());

      repositoryResolver = new FileResolver<Void>(repositoriesFolder, exportAll);

      serverStatus = new ServerStatus(isGO());

@@ -1395,22 +1767,9 @@
      try {

         // check to see if this "file" is a login service class

         Class<?> realmClass = Class.forName(realm);

         if (IUserService.class.isAssignableFrom(realmClass)) {

            loginService = (IUserService) realmClass.newInstance();

         }

         loginService = (IUserService) realmClass.newInstance();

      } catch (Throwable t) {

         // not a login service class or class could not be instantiated.

         // try to use default file login service

         File realmFile = new File(realm);

         if (!realmFile.exists()) {

            try {

               realmFile.createNewFile();

            } catch (IOException x) {

               logger.error(

                     MessageFormat.format("COULD NOT CREATE REALM FILE {0}!", realmFile), x);

            }

         }

         loginService = new FileUserService(realmFile);

         loginService = new GitblitUserService();

      }

      setUserService(loginService);

      mailExecutor = new MailExecutor(settings);

@@ -1433,13 +1792,42 @@
   @Override

   public void contextInitialized(ServletContextEvent contextEvent) {

      servletContext = contextEvent.getServletContext();

      settingsModel = loadSettingModels();		
      settingsModel = loadSettingModels();

      if (settings == null) {

         // Gitblit WAR is running in a servlet container

         WebXmlSettings webxmlSettings = new WebXmlSettings(contextEvent.getServletContext());

         ServletContext context = contextEvent.getServletContext();

         WebXmlSettings webxmlSettings = new WebXmlSettings(context);



         // 0.7.0 web.properties in the deployed war folder

         File overrideFile = new File(context.getRealPath("/WEB-INF/web.properties"));

         if (overrideFile.exists()) {

            webxmlSettings.applyOverrides(overrideFile);

         }



         // 0.8.0 gitblit.properties file located outside the deployed war

         // folder lie, for example, on RedHat OpenShift.

         overrideFile = getFileOrFolder("gitblit.properties");

         if (!overrideFile.getPath().equals("gitblit.properties")) {

            webxmlSettings.applyOverrides(overrideFile);

         }

         configureContext(webxmlSettings, true);



         // Copy the included scripts to the configured groovy folder

         File localScripts = getFileOrFolder(Keys.groovy.scriptsFolder, "groovy");

         if (!localScripts.exists()) {

            File includedScripts = new File(context.getRealPath("/WEB-INF/groovy"));

            if (!includedScripts.equals(localScripts)) {

               try {

                  com.gitblit.utils.FileUtils.copy(localScripts, includedScripts.listFiles());

               } catch (IOException e) {

                  logger.error(MessageFormat.format(

                        "Failed to copy included Groovy scripts from {0} to {1}",

                        includedScripts, localScripts));

               }

            }

         }

      }

		


      serverStatus.servletContainer = servletContext.getServerInfo();

   }