Fixed missing format call for certificate authentication logging

James Moger

2012-11-28 579cdd4a691adbbe89f85ce679502cf5d1f045d0

 src/com/gitblit/GitBlit.java

@@ -28,6 +28,7 @@
import java.text.SimpleDateFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Calendar;

import java.util.Collection;

import java.util.Collections;

import java.util.Date;

@@ -78,31 +79,34 @@
import com.gitblit.Constants.FederationRequest;

import com.gitblit.Constants.FederationStrategy;

import com.gitblit.Constants.FederationToken;

import com.gitblit.Constants.PermissionType;

import com.gitblit.Constants.RegistrantType;

import com.gitblit.models.FederationModel;

import com.gitblit.models.FederationProposal;

import com.gitblit.models.FederationSet;

import com.gitblit.models.ForkModel;

import com.gitblit.models.Metric;

import com.gitblit.models.ProjectModel;

import com.gitblit.models.RegistrantAccessPermission;

import com.gitblit.models.RepositoryModel;

import com.gitblit.models.SearchResult;

import com.gitblit.models.ServerSettings;

import com.gitblit.models.ServerStatus;

import com.gitblit.models.SettingModel;

import com.gitblit.models.TeamAccessPermission;

import com.gitblit.models.TeamModel;

import com.gitblit.models.UserAccessPermission;

import com.gitblit.models.UserModel;

import com.gitblit.utils.ArrayUtils;

import com.gitblit.utils.ByteFormat;

import com.gitblit.utils.ContainerUtils;

import com.gitblit.utils.DeepCopier;

import com.gitblit.utils.FederationUtils;

import com.gitblit.utils.HttpUtils;

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;

import com.gitblit.utils.TimeUtils;

import com.gitblit.wicket.WicketUtils;



/**

@@ -159,6 +163,8 @@
   private MailExecutor mailExecutor;

   

   private LuceneExecutor luceneExecutor;

	
   private GCExecutor gcExecutor;

   

   private TimeZone timezone;

   

@@ -250,6 +256,34 @@
    */

   public static int getInteger(String key, int defaultValue) {

      return self().settings.getInteger(key, defaultValue);

   }

	
   /**

    * Returns the value in bytes for the specified key. If the key does not

    * exist or the value for the key can not be interpreted as an integer, the

    * defaultValue is returned.

    * 
    * @see IStoredSettings.getFilesize(String key, int defaultValue)

    * @param key

    * @param defaultValue

    * @return key value or defaultValue

    */

   public static int getFilesize(String key, int defaultValue) {

      return self().settings.getFilesize(key, defaultValue);

   }



   /**

    * Returns the value in bytes for the specified key. If the key does not

    * exist or the value for the key can not be interpreted as a long, the

    * defaultValue is returned.

    * 
    * @see IStoredSettings.getFilesize(String key, long defaultValue)

    * @param key

    * @param defaultValue

    * @return key value or defaultValue

    */

   public static long getFilesize(String key, long defaultValue) {

      return self().settings.getFilesize(key, defaultValue);

   }



   /**

@@ -528,6 +562,15 @@
    * @return a user object or null

    */

   public UserModel authenticate(HttpServletRequest httpRequest) {

      boolean checkValidity = settings.getBoolean(Keys.git.enforceCertificateValidity, true);

      String [] oids = getStrings(Keys.git.certificateUsernameOIDs).toArray(new String[0]);

      UserModel model = HttpUtils.getUserModelFromCertificate(httpRequest, checkValidity, oids);

      if (model != null) {

         UserModel user = GitBlit.self().getUserModel(model.username);

         logger.info(MessageFormat.format("{0} authenticated by client certificate from {1}",

               user.username, httpRequest.getRemoteAddr()));

         return user;

      }

      return null;

   }



@@ -627,23 +670,76 @@
    * @return a user object or null

    */

   public UserModel getUserModel(String username) {

      UserModel user = userService.getUserModel(username);

      UserModel user = userService.getUserModel(username);		
      return user;

   }

	
   /**

    * Returns the effective list of permissions for this user, taking into account

    * team memberships, ownerships.

    * 
    * @param user

    * @return the effective list of permissions for the user

    */

   public List<RegistrantAccessPermission> getUserAccessPermissions(UserModel user) {

      Set<RegistrantAccessPermission> set = new LinkedHashSet<RegistrantAccessPermission>();

      set.addAll(user.getRepositoryPermissions());

      // Flag missing repositories

      for (RegistrantAccessPermission permission : set) {

         if (permission.mutable && PermissionType.EXPLICIT.equals(permission.permissionType)) {

            RepositoryModel rm = GitBlit.self().getRepositoryModel(permission.registrant);

            if (rm == null) {

               permission.permissionType = PermissionType.MISSING;

               permission.mutable = false;

               continue;

            }

         }

      }



      // TODO reconsider ownership as a user property

      // manually specify personal repository ownerships

      for (RepositoryModel rm : repositoryListCache.values()) {

         if (rm.isUsersPersonalRepository(user.username) || rm.isOwner(user.username)) {

            RegistrantAccessPermission rp = new RegistrantAccessPermission(rm.name, AccessPermission.REWIND,

                  PermissionType.OWNER, RegistrantType.REPOSITORY, null, false);

            // user may be owner of a repository to which they've inherited

            // a team permission, replace any existing perm with owner perm

            set.remove(rp);

            set.add(rp);

         }

      }

		
      List<RegistrantAccessPermission> list = new ArrayList<RegistrantAccessPermission>(set);

      Collections.sort(list);

      return list;

   }



   /**

    * Returns the list of users and their access permissions for the specified repository.

    * Returns the list of users and their access permissions for the specified

    * repository including permission source information such as the team or

    * regular expression which sets the permission.

    * 

    * @param repository

    * @return a list of User-AccessPermission tuples

    * @return a list of RegistrantAccessPermissions

    */

   public List<UserAccessPermission> getUserAccessPermissions(RepositoryModel repository) {

      List<UserAccessPermission> permissions = new ArrayList<UserAccessPermission>();

      for (String user : userService.getUsernamesForRepositoryRole(repository.name)) {

         AccessPermission ap = userService.getUserModel(user).getRepositoryPermission(repository);

         permissions.add(new UserAccessPermission(user, ap));

   public List<RegistrantAccessPermission> getUserAccessPermissions(RepositoryModel repository) {

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

      if (AccessRestrictionType.NONE.equals(repository.accessRestriction)) {

         // no permissions needed, REWIND for everyone!

         return list;

      }

      return permissions;

      if (AuthorizationControl.AUTHENTICATED.equals(repository.authorizationControl)) {

         // no permissions needed, REWIND for authenticated!

         return list;

      }

      // NAMED users and teams

      for (UserModel user : userService.getAllUsers()) {

         RegistrantAccessPermission ap = user.getRepositoryPermission(repository);

         if (ap.permission.exceeds(AccessPermission.NONE)) {

            list.add(ap);

         }

      }

      return list;

   }

   

   /**

@@ -653,12 +749,15 @@
    * @param permissions

    * @return true if the user models have been updated

    */

   public boolean setUserAccessPermissions(RepositoryModel repository, List<UserAccessPermission> permissions) {

   public boolean setUserAccessPermissions(RepositoryModel repository, Collection<RegistrantAccessPermission> permissions) {

      List<UserModel> users = new ArrayList<UserModel>();

      for (UserAccessPermission up : permissions) {

         UserModel user = userService.getUserModel(up.user);

         user.setRepositoryPermission(repository.name, up.permission);

         users.add(user);

      for (RegistrantAccessPermission up : permissions) {

         if (up.mutable) {

            // only set editable defined permissions

            UserModel user = userService.getUserModel(up.registrant);

            user.setRepositoryPermission(repository.name, up.permission);

            users.add(user);

         }

      }

      return userService.updateUserModels(users);

   }

@@ -686,7 +785,9 @@
    */

   @Deprecated

   public boolean setRepositoryUsers(RepositoryModel repository, List<String> repositoryUsers) {

      return userService.setUsernamesForRepositoryRole(repository.name, repositoryUsers);

      // rejects all changes since 1.2.0 because this would elevate

      // all discrete access permissions to RW+

      return false;

   }



   /**

@@ -762,18 +863,23 @@
   }

   

   /**

    * Returns the list of teams and their access permissions for the specified repository.

    * Returns the list of teams and their access permissions for the specified

    * repository including the source of the permission such as the admin flag

    * or a regular expression.

    * 

    * @param repository

    * @return a list of Team-AccessPermission tuples

    * @return a list of RegistrantAccessPermissions

    */

   public List<TeamAccessPermission> getTeamAccessPermissions(RepositoryModel repository) {

      List<TeamAccessPermission> permissions = new ArrayList<TeamAccessPermission>();

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

         AccessPermission ap = userService.getTeamModel(team).getRepositoryPermission(repository);

         permissions.add(new TeamAccessPermission(team, ap));

   public List<RegistrantAccessPermission> getTeamAccessPermissions(RepositoryModel repository) {

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

      for (TeamModel team : userService.getAllTeams()) {

         RegistrantAccessPermission ap = team.getRepositoryPermission(repository);

         if (ap.permission.exceeds(AccessPermission.NONE)) {

            list.add(ap);

         }

      }

      return permissions;

      Collections.sort(list);

      return list;

   }

   

   /**

@@ -783,25 +889,27 @@
    * @param permissions

    * @return true if the team models have been updated

    */

   public boolean setTeamAccessPermissions(RepositoryModel repository, List<TeamAccessPermission> permissions) {

   public boolean setTeamAccessPermissions(RepositoryModel repository, Collection<RegistrantAccessPermission> permissions) {

      List<TeamModel> teams = new ArrayList<TeamModel>();

      for (TeamAccessPermission tp : permissions) {

         TeamModel team = userService.getTeamModel(tp.team);

         team.setRepositoryPermission(repository.name, tp.permission);

         teams.add(team);

      for (RegistrantAccessPermission tp : permissions) {

         if (tp.mutable) {

            // only set explicitly defined access permissions

            TeamModel team = userService.getTeamModel(tp.registrant);

            team.setRepositoryPermission(repository.name, tp.permission);

            teams.add(team);

         }

      }

      return userService.updateTeamModels(teams);

   }

   

   /**

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

    * restriction placed on the specified repository.

    * Returns the list of all teams who have an explicit access permission for

    * the specified repository.

    * 

    * @see IUserService.getTeamnamesForRepositoryRole(String)

    * @param repository

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

    * @return list of all teamnames with explicit access permissions to the repository

    */

   @Deprecated

   public List<String> getRepositoryTeams(RepositoryModel repository) {

      return userService.getTeamnamesForRepositoryRole(repository.name);

   }

@@ -817,7 +925,9 @@
    */

   @Deprecated

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

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

      // rejects all changes since 1.2.0 because this would elevate

      // all discrete access permissions to RW+

      return false;

   }



   /**

@@ -860,7 +970,7 @@
    */

   private void addToCachedRepositoryList(RepositoryModel model) {

      if (settings.getBoolean(Keys.git.cacheRepositoryList, true)) {

         repositoryListCache.put(model.name, model);

         repositoryListCache.put(model.name.toLowerCase(), model);

         

         // update the fork origin repository with this repository clone

         if (!StringUtils.isEmpty(model.originRepository)) {

@@ -882,7 +992,7 @@
      if (StringUtils.isEmpty(name)) {

         return null;

      }

      return repositoryListCache.remove(name);

      return repositoryListCache.remove(name.toLowerCase());

   }



   /**

@@ -976,6 +1086,16 @@
               }

            }

            

            // rebuild fork networks

            for (RepositoryModel model : repositoryListCache.values()) {

               if (!StringUtils.isEmpty(model.originRepository)) {

                  if (repositoryListCache.containsKey(model.originRepository)) {

                     RepositoryModel origin = repositoryListCache.get(model.originRepository);

                     origin.addFork(model.name);

                  }

               }

            }

				
            long duration = System.currentTimeMillis() - startTime;

            logger.info(MessageFormat.format(msg, repositoryListCache.size(), duration));

         }

@@ -1005,10 +1125,15 @@
    * @return repository or null

    */

   public Repository getRepository(String repositoryName, boolean logError) {

      if (isCollectingGarbage(repositoryName)) {

         logger.warn(MessageFormat.format("Rejecting request for {0}, busy collecting garbage!", repositoryName));

         return null;

      }



      File dir = FileKey.resolve(new File(repositoriesFolder, repositoryName), FS.DETECTED);

      if (dir == null)

         return null;



		
      Repository r = null;

      try {

         FileKey key = FileKey.exact(dir, FS.DETECTED);

@@ -1101,8 +1226,15 @@
      }

      

      // cached model

      RepositoryModel model = repositoryListCache.get(repositoryName);

		
      RepositoryModel model = repositoryListCache.get(repositoryName.toLowerCase());



      if (gcExecutor.isCollectingGarbage(model.name)) {

         // Gitblit is busy collecting garbage, use our cached model

         RepositoryModel rm = DeepCopier.copy(model);

         rm.isCollectingGarbage = true;

         return rm;

      }



      // check for updates

      Repository r = getRepository(repositoryName);

      if (r == null) {

@@ -1167,12 +1299,6 @@
            }

            project.title = projectConfigs.getString("project", name, "title");

            project.description = projectConfigs.getString("project", name, "description");

            // TODO add more interesting metadata

            // project manager?

            // commit message regex?

            // RW+

            // RW

            // R

            configs.put(name.toLowerCase(), project);            

         }

         projectCache.clear();

@@ -1366,6 +1492,13 @@
         model.federationSets = new ArrayList<String>(Arrays.asList(config.getStringList(

               Constants.CONFIG_GITBLIT, null, "federationSets")));

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

         model.gcThreshold = getConfig(config, "gcThreshold", settings.getString(Keys.git.defaultGarbageCollectionThreshold, "500KB"));

         model.gcPeriod = getConfig(config, "gcPeriod", settings.getInteger(Keys.git.defaultGarbageCollectionPeriod, 7));

         try {

            model.lastGC = new SimpleDateFormat(Constants.ISO8601).parse(getConfig(config, "lastGC", "1970-01-01'T'00:00:00Z"));

         } catch (Exception e) {

            model.lastGC = new Date(0);

         }

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

         if (model.origin != null) {

            model.origin = model.origin.replace('\\', '/');

@@ -1398,7 +1531,7 @@
               // ensure origin still exists

               File repoFolder = new File(getRepositoriesFolder(), originRepo);

               if (repoFolder.exists()) {

                  model.originRepository = originRepo;

                  model.originRepository = originRepo.toLowerCase();

               }

            }

         } catch (URISyntaxException e) {

@@ -1418,7 +1551,7 @@
      if (settings.getBoolean(Keys.git.cacheRepositoryList, true)) {

         // if we are caching use the cache to determine availability

         // otherwise we end up adding a phantom repository to the cache

         return repositoryListCache.containsKey(repositoryName);

         return repositoryListCache.containsKey(repositoryName.toLowerCase());

      }      

      Repository r = getRepository(repositoryName, false);

      if (r == null) {

@@ -1476,7 +1609,7 @@
         }

         

         for (String repository : repositoryListCache.keySet()) {

            if (repository.toLowerCase().startsWith(userPath)) {

            if (repository.startsWith(userPath)) {

               RepositoryModel model = repositoryListCache.get(repository);

               if (!StringUtils.isEmpty(model.originRepository)) {

                  if (roots.contains(model.originRepository)) {

@@ -1490,7 +1623,7 @@
         // not caching

         ProjectModel project = getProjectModel(userProject);

         for (String repository : project.repositories) {

            if (repository.toLowerCase().startsWith(userProject)) {

            if (repository.startsWith(userProject)) {

               RepositoryModel model = repositoryListCache.get(repository);

               if (model.originRepository.equalsIgnoreCase(origin)) {

                  // user has a fork

@@ -1513,7 +1646,7 @@
   public ForkModel getForkNetwork(String repository) {

      if (settings.getBoolean(Keys.git.cacheRepositoryList, true)) {

         // find the root

         RepositoryModel model = repositoryListCache.get(repository);

         RepositoryModel model = repositoryListCache.get(repository.toLowerCase());

         while (model.originRepository != null) {

            model = repositoryListCache.get(model.originRepository);

         }

@@ -1524,7 +1657,7 @@
   }

   

   private ForkModel getForkModel(String repository) {

      RepositoryModel model = repositoryListCache.get(repository);

      RepositoryModel model = repositoryListCache.get(repository.toLowerCase());

      ForkModel fork = new ForkModel(model);

      if (!ArrayUtils.isEmpty(model.forks)) {

         for (String aFork : model.forks) {

@@ -1645,6 +1778,27 @@
   private boolean getConfig(StoredConfig config, String field, boolean defaultValue) {

      return config.getBoolean(Constants.CONFIG_GITBLIT, field, defaultValue);

   }

	
   /**

    * Returns the gitblit string value for the specified key. If key is not

    * set, returns defaultValue.

    * 
    * @param config

    * @param field

    * @param defaultValue

    * @return field value or defaultValue

    */

   private int getConfig(StoredConfig config, String field, int defaultValue) {

      String value = config.getString(Constants.CONFIG_GITBLIT, null, field);

      if (StringUtils.isEmpty(value)) {

         return defaultValue;

      }

      try {

         return Integer.parseInt(value);

      } catch (Exception e) {

      }

      return defaultValue;

   }



   /**

    * Creates/updates the repository model keyed by reopsitoryName. Saves all

@@ -1662,6 +1816,10 @@
    */

   public void updateRepositoryModel(String repositoryName, RepositoryModel repository,

         boolean isCreate) throws GitBlitException {

      if (gcExecutor.isCollectingGarbage(repositoryName)) {

         throw new GitBlitException(MessageFormat.format("sorry, Gitblit is busy collecting garbage in {0}",

               repositoryName));

      }

      Repository r = null;

      String projectPath = StringUtils.getFirstPathElement(repository.name);

      if (!StringUtils.isEmpty(projectPath)) {

@@ -1806,6 +1964,11 @@
      config.setString(Constants.CONFIG_GITBLIT, null, "federationStrategy",

            repository.federationStrategy.name());

      config.setBoolean(Constants.CONFIG_GITBLIT, null, "isFederated", repository.isFederated);

      config.setString(Constants.CONFIG_GITBLIT, null, "gcThreshold", repository.gcThreshold);

      config.setInt(Constants.CONFIG_GITBLIT, null, "gcPeriod", repository.gcPeriod);

      if (repository.lastGC != null) {

         config.setString(Constants.CONFIG_GITBLIT, null, "lastGC", new SimpleDateFormat(Constants.ISO8601).format(repository.lastGC));

      }



      updateList(config, "federationSets", repository.federationSets);

      updateList(config, "preReceiveScript", repository.preReceiveScripts);

@@ -2101,6 +2264,8 @@
      case PULL_SETTINGS:

      case PULL_SCRIPTS:

         return token.equals(all);

      default:

         break;

      }

      return false;

   }

@@ -2243,6 +2408,8 @@
            if (!StringUtils.isEmpty(model.origin)) {

               url = model.origin;

            }

            break;

         default:

            break;

         }



@@ -2501,6 +2668,37 @@
   }



   /**

    * Notify users by email of something.

    * 
    * @param subject

    * @param message

    * @param toAddresses

    */

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

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

   }



   /**

    * Notify users by email of something.

    * 
    * @param subject

    * @param message

    * @param toAddresses

    */

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

      try {

         Message mail = mailExecutor.createMessage(toAddresses);

         if (mail != null) {

            mail.setSubject(subject);

            mail.setContent(message, "text/html");

            mailExecutor.queue(mail);

         }

      } catch (MessagingException e) {

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

      }

   }



   /**

    * Returns the descriptions/comments of the Gitblit config settings.

    * 

    * @return SettingsModel

@@ -2601,9 +2799,15 @@
   public void configureContext(IStoredSettings settings, boolean startFederation) {

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

      this.settings = settings;



      repositoriesFolder = getRepositoriesFolder();

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



      // prepare service executors

      mailExecutor = new MailExecutor(settings);

      luceneExecutor = new LuceneExecutor(settings, repositoriesFolder);

      gcExecutor = new GCExecutor(settings);

		
      // calculate repository list settings checksum for future config changes

      repositoryListSettingsChecksum.set(getRepositoryListSettingsChecksum());



@@ -2634,16 +2838,43 @@
      // load and cache the project metadata

      projectConfigs = new FileBasedConfig(getFileOrFolder(Keys.web.projectsFile, "projects.conf"), FS.detect());

      getProjectConfigs();

      mailExecutor = new MailExecutor(settings);

		
      // schedule mail engine

      if (mailExecutor.isReady()) {

         logger.info("Mail executor is scheduled to process the message queue every 2 minutes.");

         scheduledExecutor.scheduleAtFixedRate(mailExecutor, 1, 2, TimeUnit.MINUTES);

      } else {

         logger.warn("Mail server is not properly configured.  Mail services disabled.");

      }

      luceneExecutor = new LuceneExecutor(settings, repositoriesFolder);

		
      // schedule lucene engine

      logger.info("Lucene executor is scheduled to process indexed branches every 2 minutes.");

      scheduledExecutor.scheduleAtFixedRate(luceneExecutor, 1, 2, TimeUnit.MINUTES);

		
      // schedule gc engine

      if (gcExecutor.isReady()) {

         logger.info("GC executor is scheduled to scan repositories every 24 hours.");

         Calendar c = Calendar.getInstance();

         c.set(Calendar.HOUR_OF_DAY, settings.getInteger(Keys.git.garbageCollectionHour, 0));

         c.set(Calendar.MINUTE, 0);

         c.set(Calendar.SECOND, 0);

         c.set(Calendar.MILLISECOND, 0);

         Date cd = c.getTime();

         Date now = new Date();

         int delay = 0;

         if (cd.before(now)) {

            c.add(Calendar.DATE, 1);

            cd = c.getTime();

         }

         delay = (int) ((cd.getTime() - now.getTime())/TimeUtils.MIN);

         String when = delay + " mins";

         if (delay > 60) {

            when = MessageFormat.format("{0,number,0.0} hours", ((float)delay)/60f);

         }

         logger.info(MessageFormat.format("Next scheculed GC scan is in {0}", when));

         scheduledExecutor.scheduleAtFixedRate(gcExecutor, delay, 60*24, TimeUnit.MINUTES);

      }

		
      if (startFederation) {

         configureFederation();

      }

@@ -2745,9 +2976,28 @@
      logger.info("Gitblit context destroyed by servlet container.");

      scheduledExecutor.shutdownNow();

      luceneExecutor.close();

      gcExecutor.close();

   }

   

   /**

    * 
    * @return true if we are running the gc executor

    */

   public boolean isCollectingGarbage() {

      return gcExecutor.isRunning();

   }

	
   /**

    * Returns true if Gitblit is actively collecting garbage in this repository.

    * 
    * @param repositoryName

    * @return true if actively collecting garbage

    */

   public boolean isCollectingGarbage(String repositoryName) {

      return gcExecutor.isCollectingGarbage(repositoryName);

   }



   /**

    * Creates a personal fork of the specified repository. The clone is view

    * restricted by default and the owner of the source repository is given

    * access to the clone.