James Moger
2011-07-18 b795b83d76b7a044c7d5bafeb8e45eefb1303581
src/com/gitblit/GitBlit.java
@@ -1,127 +1,721 @@
/*
 * Copyright 2011 gitblit.com.
 *
 * 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.gitblit;
import java.io.File;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.Request;
import org.apache.wicket.protocol.http.WebResponse;
import org.apache.wicket.protocol.http.servlet.ServletWebRequest;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.http.server.resolver.FileResolver;
import org.eclipse.jgit.http.server.resolver.ServiceNotEnabledException;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.RepositoryCache.FileKey;
import org.eclipse.jgit.lib.StoredConfig;
import org.eclipse.jgit.transport.resolver.FileResolver;
import org.eclipse.jgit.transport.resolver.RepositoryResolver;
import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException;
import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException;
import org.eclipse.jgit.util.FS;
import org.eclipse.jgit.util.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.gitblit.Constants.AccessRestrictionType;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.UserModel;
import com.gitblit.utils.JGitUtils;
import com.gitblit.wicket.User;
import com.gitblit.wicket.models.RepositoryModel;
import com.gitblit.utils.StringUtils;
public class GitBlit {
/**
 * GitBlit is the servlet context listener singleton that acts as the core for
 * the web ui and the servlets. This class is either directly instantiated by
 * the GitBlitServer class (Gitblit GO) or is reflectively instantiated from the
 * definition in the web.xml file (Gitblit WAR).
 *
 * This class is the central logic processor for Gitblit. All settings, user
 * object, and repository object operations pass through this class.
 *
 * Repository Resolution. There are two pathways for finding repositories. One
 * pathway, for web ui display and repository authentication & authorization, is
 * within this class. The other pathway is through the standard GitServlet.
 *
 * @author James Moger
 *
 */
public class GitBlit implements ServletContextListener {
   private static GitBlit gitblit;
   private final Logger logger = LoggerFactory.getLogger(GitBlit.class);
   private final boolean debugMode;
   private RepositoryResolver<Void> repositoryResolver;
   private final FileResolver repositoryResolver;
   private File repositoriesFolder;
   private final File repositories;
   private boolean exportAll = true;
   private final boolean exportAll;
   private IUserService userService;
   private ILoginService loginService;
   private IStoredSettings settings;
   public GitBlit() {
      if (gitblit == null) {
         // set the static singleton reference
         gitblit = this;
      }
   }
   /**
    * Returns the Gitblit singleton.
    *
    * @return gitblit singleton
    */
   public static GitBlit self() {
      if (gitblit == null) {
         gitblit = new GitBlit();
         new GitBlit();
      }
      return gitblit;
   }
   private GitBlit() {
      repositories = new File(StoredSettings.getString("repositoriesFolder", "repos"));
      exportAll = StoredSettings.getBoolean("exportAll", true);
      repositoryResolver = new FileResolver(repositories, exportAll);
      debugMode = StoredSettings.getBoolean("debugMode", false);
   }
   public boolean isDebugMode() {
      return debugMode;
   /**
    * Returns the boolean value for the specified key. If the key does not
    * exist or the value for the key can not be interpreted as a boolean, the
    * defaultValue is returned.
    *
    * @see IStoredSettings.getBoolean(String, boolean)
    * @param key
    * @param defaultValue
    * @return key value or defaultValue
    */
   public static boolean getBoolean(String key, boolean defaultValue) {
      return self().settings.getBoolean(key, defaultValue);
   }
   public void setLoginService(ILoginService loginService) {
      this.loginService = loginService;
   /**
    * Returns the integer value 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.getInteger(String key, int defaultValue)
    * @param key
    * @param defaultValue
    * @return key value or defaultValue
    */
   public static int getInteger(String key, int defaultValue) {
      return self().settings.getInteger(key, defaultValue);
   }
   public User authenticate(String username, char[] password) {
      if (loginService == null) {
   /**
    * Returns the string value for the specified key. If the key does not exist
    * or the value for the key can not be interpreted as a string, the
    * defaultValue is returned.
    *
    * @see IStoredSettings.getString(String key, String defaultValue)
    * @param key
    * @param defaultValue
    * @return key value or defaultValue
    */
   public static String getString(String key, String defaultValue) {
      return self().settings.getString(key, defaultValue);
   }
   /**
    * Returns a list of space-separated strings from the specified key.
    *
    * @see IStoredSettings.getStrings(String key)
    * @param name
    * @return list of strings
    */
   public static List<String> getStrings(String key) {
      return self().settings.getStrings(key);
   }
   /**
    * Returns the list of keys whose name starts with the specified prefix. If
    * the prefix is null or empty, all key names are returned.
    *
    * @see IStoredSettings.getAllKeys(String key)
    * @param startingWith
    * @return list of keys
    */
   public static List<String> getAllKeys(String startingWith) {
      return self().settings.getAllKeys(startingWith);
   }
   /**
    * Is Gitblit running in debug mode?
    *
    * @return true if Gitblit is running in debug mode
    */
   public static boolean isDebugMode() {
      return self().settings.getBoolean(Keys.web.debugMode, false);
   }
   /**
    * Returns the list of non-Gitblit clone urls. This allows Gitblit to
    * advertise alternative urls for Git client repository access.
    *
    * @param repositoryName
    * @return list of non-gitblit clone urls
    */
   public List<String> getOtherCloneUrls(String repositoryName) {
      List<String> cloneUrls = new ArrayList<String>();
      for (String url : settings.getStrings(Keys.web.otherUrls)) {
         cloneUrls.add(MessageFormat.format(url, repositoryName));
      }
      return cloneUrls;
   }
   /**
    * Set the user service. The user service authenticates all users and is
    * responsible for managing user permissions.
    *
    * @param userService
    */
   public void setUserService(IUserService userService) {
      logger.info("Setting up user service " + userService.toString());
      this.userService = userService;
   }
   /**
    * Authenticate a user based on a username and password.
    *
    * @see IUserService.authenticate(String, char[])
    * @param username
    * @param password
    * @return a user object or null
    */
   public UserModel authenticate(String username, char[] password) {
      if (userService == null) {
         return null;
      }
      return loginService.authenticate(username, password);
      return userService.authenticate(username, password);
   }
   public User authenticate(Cookie[] cookies) {
      if (loginService == null) {
   /**
    * Authenticate a user based on their cookie.
    *
    * @param cookies
    * @return a user object or null
    */
   public UserModel authenticate(Cookie[] cookies) {
      if (userService == null) {
         return null;
      }
      if (cookies != null && cookies.length > 0) {
         for (Cookie cookie : cookies) {
            if (cookie.getName().equals(Constants.NAME)) {
               String value = cookie.getValue();
               return loginService.authenticate(value.toCharArray());
      if (userService.supportsCookies()) {
         if (cookies != null && cookies.length > 0) {
            for (Cookie cookie : cookies) {
               if (cookie.getName().equals(Constants.NAME)) {
                  String value = cookie.getValue();
                  return userService.authenticate(value.toCharArray());
               }
            }
         }
      }
      return null;
   }
   public void setCookie(WebResponse response, User user) {
      Cookie userCookie = new Cookie(Constants.NAME, user.getCookie());
      userCookie.setMaxAge(Integer.MAX_VALUE);
      userCookie.setPath("/");
      response.addCookie(userCookie);
   /**
    * Sets a cookie for the specified user.
    *
    * @param response
    * @param user
    */
   public void setCookie(WebResponse response, UserModel user) {
      if (userService == null) {
         return;
      }
      if (userService.supportsCookies()) {
         Cookie userCookie;
         if (user == null) {
            // clear cookie for logout
            userCookie = new Cookie(Constants.NAME, "");
         } else {
            // set cookie for login
            char[] cookie = userService.getCookie(user);
            userCookie = new Cookie(Constants.NAME, new String(cookie));
            userCookie.setMaxAge(Integer.MAX_VALUE);
         }
         userCookie.setPath("/");
         response.addCookie(userCookie);
      }
   }
   /**
    * Returns the list of all users available to the login service.
    *
    * @see IUserService.getAllUsernames()
    * @return list of all usernames
    */
   public List<String> getAllUsernames() {
      List<String> names = new ArrayList<String>(userService.getAllUsernames());
      Collections.sort(names);
      return names;
   }
   /**
    * Delete the user object with the specified username
    *
    * @see IUserService.deleteUser(String)
    * @param username
    * @return true if successful
    */
   public boolean deleteUser(String username) {
      return userService.deleteUser(username);
   }
   /**
    * Retrieve the user object for the specified username.
    *
    * @see IUserService.getUserModel(String)
    * @param username
    * @return a user object or null
    */
   public UserModel getUserModel(String username) {
      UserModel user = userService.getUserModel(username);
      return user;
   }
   /**
    * Returns the list of all users who are allowed to bypass the access
    * restriction placed on the specified repository.
    *
    * @see IUserService.getUsernamesForRepositoryRole(String)
    * @param repository
    * @return list of all usernames that can bypass the access restriction
    */
   public List<String> getRepositoryUsers(RepositoryModel repository) {
      return userService.getUsernamesForRepositoryRole(repository.name);
   }
   /**
    * Sets the list of all uses who are allowed to bypass the access
    * restriction placed on the specified repository.
    *
    * @see IUserService.setUsernamesForRepositoryRole(String, List<String>)
    * @param repository
    * @param usernames
    * @return true if successful
    */
   public boolean setRepositoryUsers(RepositoryModel repository, List<String> repositoryUsers) {
      return userService.setUsernamesForRepositoryRole(repository.name, repositoryUsers);
   }
   /**
    * Adds/updates a complete user object keyed by username. This method allows
    * for renaming a user.
    *
    * @see IUserService.updateUserModel(String, UserModel)
    * @param username
    * @param user
    * @param isCreate
    * @throws GitBlitException
    */
   public void updateUserModel(String username, UserModel user, boolean isCreate)
         throws GitBlitException {
      if (!userService.updateUserModel(username, user)) {
         throw new GitBlitException(isCreate ? "Failed to add user!" : "Failed to update user!");
      }
   }
   /**
    * Returns the list of all repositories available to Gitblit. This method
    * does not consider user access permissions.
    *
    * @return list of all repositories
    */
   public List<String> getRepositoryList() {
      return JGitUtils.getRepositoryList(repositories, exportAll, StoredSettings.getBoolean("nestedRepositories", true));
      return JGitUtils.getRepositoryList(repositoriesFolder, exportAll,
            settings.getBoolean(Keys.git.searchRepositoriesSubfolders, true));
   }
   public List<RepositoryModel> getRepositories(Request request) {
      List<String> list = getRepositoryList();
      ServletWebRequest servletWebRequest = (ServletWebRequest) request;
      HttpServletRequest req = servletWebRequest.getHttpServletRequest();
   /**
    * Returns the JGit repository for the specified name.
    *
    * @param repositoryName
    * @return repository or null
    */
   public Repository getRepository(String repositoryName) {
      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());
      } catch (ServiceNotAuthorizedException e) {
         r = null;
         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);
      }
      return r;
   }
   /**
    * Returns the list of repository models that are accessible to the user.
    *
    * @param user
    * @return list of repository models accessible to user
    */
   public List<RepositoryModel> getRepositoryModels(UserModel user) {
      List<String> list = getRepositoryList();
      List<RepositoryModel> repositories = new ArrayList<RepositoryModel>();
      for (String repo : list) {
         Repository r = getRepository(req, repo);
         String description = JGitUtils.getRepositoryDescription(r);
         String owner = JGitUtils.getRepositoryOwner(r);
         Date lastchange = JGitUtils.getLastChange(r);
         r.close();
         repositories.add(new RepositoryModel(repo, description, owner, lastchange));
         RepositoryModel model = getRepositoryModel(user, repo);
         if (model != null) {
            repositories.add(model);
         }
      }
      return repositories;
   }
   public Repository getRepository(HttpServletRequest req, String repositoryName) {
      Repository r = null;
      try {
         r = repositoryResolver.open(req, repositoryName);
      } catch (RepositoryNotFoundException e) {
         r = null;
         logger.error("Failed to find repository " + repositoryName);
         e.printStackTrace();
      } catch (ServiceNotEnabledException e) {
         r = null;
         e.printStackTrace();
   /**
    * Returns a repository model if the repository exists and the user may
    * access the repository.
    *
    * @param user
    * @param repositoryName
    * @return repository model or null
    */
   public RepositoryModel getRepositoryModel(UserModel user, String repositoryName) {
      RepositoryModel model = getRepositoryModel(repositoryName);
      if (model == null) {
         return null;
      }
      return r;
      if (model.accessRestriction.atLeast(AccessRestrictionType.VIEW)) {
         if (user != null && user.canAccessRepository(model.name)) {
            return model;
         }
         return null;
      } else {
         return model;
      }
   }
   /**
    * Returns the repository model for the specified repository. This method
    * does not consider user access permissions.
    *
    * @param repositoryName
    * @return repository model or null
    */
   public RepositoryModel getRepositoryModel(String repositoryName) {
      Repository r = getRepository(repositoryName);
      if (r == null) {
         return null;
      }
      RepositoryModel model = new RepositoryModel();
      model.name = repositoryName;
      model.hasCommits = JGitUtils.hasCommits(r);
      model.lastChange = JGitUtils.getLastChange(r, null);
      StoredConfig config = JGitUtils.readConfig(r);
      if (config != null) {
         model.description = getConfig(config, "description", "");
         model.owner = getConfig(config, "owner", "");
         model.useTickets = getConfig(config, "useTickets", false);
         model.useDocs = getConfig(config, "useDocs", false);
         model.accessRestriction = AccessRestrictionType.fromName(getConfig(config,
               "accessRestriction", null));
         model.showRemoteBranches = getConfig(config, "showRemoteBranches", false);
         model.isFrozen = getConfig(config, "isFrozen", false);
         model.showReadme = getConfig(config, "showReadme", false);
      }
      r.close();
      return model;
   }
   /**
    * Returns the size in bytes of the repository.
    *
    * @param model
    * @return size in bytes
    */
   public long calculateSize(RepositoryModel model) {
      File gitDir = FileKey.resolve(new File(repositoriesFolder, model.name), FS.DETECTED);
      return com.gitblit.utils.FileUtils.folderSize(gitDir);
   }
   /**
    * Returns the gitblit string vlaue for the specified key. If key is not
    * set, returns defaultValue.
    *
    * @param config
    * @param field
    * @param defaultValue
    * @return field value or defaultValue
    */
   private String getConfig(StoredConfig config, String field, String defaultValue) {
      String value = config.getString("gitblit", null, field);
      if (StringUtils.isEmpty(value)) {
         return defaultValue;
      }
      return value;
   }
   /**
    * Returns the gitblit boolean vlaue for the specified key. If key is not
    * set, returns defaultValue.
    *
    * @param config
    * @param field
    * @param defaultValue
    * @return field value or defaultValue
    */
   private boolean getConfig(StoredConfig config, String field, boolean defaultValue) {
      return config.getBoolean("gitblit", field, defaultValue);
   }
   /**
    * Creates/updates the repository model keyed by reopsitoryName. Saves all
    * repository settings in .git/config. This method allows for renaming
    * repositories and will update user access permissions accordingly.
    *
    * All repositories created by this method are bare and automatically have
    * .git appended to their names, which is the standard convention for bare
    * repositories.
    *
    * @param repositoryName
    * @param repository
    * @param isCreate
    * @throws GitBlitException
    */
   public void updateRepositoryModel(String repositoryName, RepositoryModel repository,
         boolean isCreate) throws GitBlitException {
      Repository r = null;
      if (isCreate) {
         // ensure created repository name ends with .git
         if (!repository.name.toLowerCase().endsWith(org.eclipse.jgit.lib.Constants.DOT_GIT_EXT)) {
            repository.name += org.eclipse.jgit.lib.Constants.DOT_GIT_EXT;
         }
         if (new File(repositoriesFolder, repository.name).exists()) {
            throw new GitBlitException(MessageFormat.format(
                  "Can not create repository ''{0}'' because it already exists.",
                  repository.name));
         }
         // create repository
         logger.info("create repository " + repository.name);
         r = JGitUtils.createRepository(repositoriesFolder, repository.name);
      } else {
         // rename repository
         if (!repositoryName.equalsIgnoreCase(repository.name)) {
            File folder = new File(repositoriesFolder, repositoryName);
            File destFolder = new File(repositoriesFolder, repository.name);
            if (destFolder.exists()) {
               throw new GitBlitException(
                     MessageFormat
                           .format("Can not rename repository ''{0}'' to ''{1}'' because ''{1}'' already exists.",
                                 repositoryName, repository.name));
            }
            if (!folder.renameTo(destFolder)) {
               throw new GitBlitException(MessageFormat.format(
                     "Failed to rename repository ''{0}'' to ''{1}''.", repositoryName,
                     repository.name));
            }
            // rename the roles
            if (!userService.renameRepositoryRole(repositoryName, repository.name)) {
               throw new GitBlitException(MessageFormat.format(
                     "Failed to rename repository permissions ''{0}'' to ''{1}''.",
                     repositoryName, repository.name));
            }
         }
         // load repository
         logger.info("edit repository " + repository.name);
         try {
            r = repositoryResolver.open(null, repository.name);
         } catch (RepositoryNotFoundException e) {
            logger.error("Repository not found", e);
         } catch (ServiceNotAuthorizedException e) {
            logger.error("Service not authorized", e);
         } catch (ServiceNotEnabledException e) {
            logger.error("Service not enabled", e);
         }
      }
      // update settings
      if (r != null) {
         StoredConfig config = JGitUtils.readConfig(r);
         config.setString("gitblit", null, "description", repository.description);
         config.setString("gitblit", null, "owner", repository.owner);
         config.setBoolean("gitblit", null, "useTickets", repository.useTickets);
         config.setBoolean("gitblit", null, "useDocs", repository.useDocs);
         config.setString("gitblit", null, "accessRestriction",
               repository.accessRestriction.name());
         config.setBoolean("gitblit", null, "showRemoteBranches", repository.showRemoteBranches);
         config.setBoolean("gitblit", null, "isFrozen", repository.isFrozen);
         config.setBoolean("gitblit", null, "showReadme", repository.showReadme);
         try {
            config.save();
         } catch (IOException e) {
            logger.error("Failed to save repository config!", e);
         }
         r.close();
      }
   }
   /**
    * Deletes the repository from the file system and removes the repository
    * permission from all repository users.
    *
    * @param model
    * @return true if successful
    */
   public boolean deleteRepositoryModel(RepositoryModel model) {
      return deleteRepository(model.name);
   }
   /**
    * Deletes the repository from the file system and removes the repository
    * permission from all repository users.
    *
    * @param repositoryName
    * @return true if successful
    */
   public boolean deleteRepository(String repositoryName) {
      try {
         File folder = new File(repositoriesFolder, repositoryName);
         if (folder.exists() && folder.isDirectory()) {
            FileUtils.delete(folder, FileUtils.RECURSIVE | FileUtils.RETRY);
            if (userService.deleteRepositoryRole(repositoryName)) {
               return true;
            }
         }
      } catch (Throwable t) {
         logger.error(MessageFormat.format("Failed to delete repository {0}", repositoryName), t);
      }
      return false;
   }
   /**
    * Returns an html version of the commit message with any global or
    * repository-specific regular expression substitution applied.
    *
    * @param repositoryName
    * @param text
    * @return html version of the commit message
    */
   public String processCommitMessage(String repositoryName, String text) {
      String html = StringUtils.breakLinesForHtml(text);
      Map<String, String> map = new HashMap<String, String>();
      // global regex keys
      if (settings.getBoolean(Keys.regex.global, false)) {
         for (String key : settings.getAllKeys(Keys.regex.global)) {
            if (!key.equals(Keys.regex.global)) {
               String subKey = key.substring(key.lastIndexOf('.') + 1);
               map.put(subKey, settings.getString(key, ""));
            }
         }
      }
      // repository-specific regex keys
      List<String> keys = settings.getAllKeys(Keys.regex._ROOT + "."
            + repositoryName.toLowerCase());
      for (String key : keys) {
         String subKey = key.substring(key.lastIndexOf('.') + 1);
         map.put(subKey, settings.getString(key, ""));
      }
      for (Entry<String, String> entry : map.entrySet()) {
         String definition = entry.getValue().trim();
         String[] chunks = definition.split("!!!");
         if (chunks.length == 2) {
            html = html.replaceAll(chunks[0], chunks[1]);
         } else {
            logger.warn(entry.getKey()
                  + " improperly formatted.  Use !!! to separate match from replacement: "
                  + definition);
         }
      }
      return html;
   }
   /**
    * Configure the Gitblit singleton with the specified settings source. This
    * source may be file settings (Gitblit GO) or may be web.xml settings
    * (Gitblit WAR).
    *
    * @param settings
    */
   public void configureContext(IStoredSettings settings) {
      logger.info("Reading configuration from " + settings.toString());
      this.settings = settings;
      repositoriesFolder = new File(settings.getString(Keys.git.repositoriesFolder, "git"));
      logger.info("Git repositories folder " + repositoriesFolder.getAbsolutePath());
      repositoryResolver = new FileResolver<Void>(repositoriesFolder, exportAll);
      String realm = settings.getString(Keys.realm.userService, "users.properties");
      IUserService loginService = null;
      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();
         }
      } 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);
      }
      setUserService(loginService);
   }
   /**
    * Configure Gitblit from the web.xml, if no configuration has already been
    * specified.
    *
    * @see ServletContextListener.contextInitialize(ServletContextEvent)
    */
   @Override
   public void contextInitialized(ServletContextEvent contextEvent) {
      if (settings == null) {
         // Gitblit WAR is running in a servlet container
         WebXmlSettings webxmlSettings = new WebXmlSettings(contextEvent.getServletContext());
         configureContext(webxmlSettings);
      }
   }
   /**
    * Gitblit is being shutdown either because the servlet container is
    * shutting down or because the servlet container is re-deploying Gitblit.
    */
   @Override
   public void contextDestroyed(ServletContextEvent contextEvent) {
      logger.info("Gitblit context destroyed by servlet container.");
   }
}