Extract services manager into a top-level injectable manager

James Moger

2014-07-02 7d3a31514afbe88664081b4ea57cd7939de99014

 src/main/java/com/gitblit/manager/GitblitManager.java

@@ -27,6 +27,7 @@
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;

@@ -42,14 +43,16 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import ro.fortsoft.pf4j.PluginState;
import ro.fortsoft.pf4j.PluginWrapper;
import ro.fortsoft.pf4j.Version;

import com.gitblit.Constants;
import com.gitblit.Constants.AccessPermission;
import com.gitblit.Constants.AccessRestrictionType;
import com.gitblit.Constants.FederationRequest;
import com.gitblit.Constants.FederationToken;
import com.gitblit.GitBlitException;
import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
import com.gitblit.models.FederationModel;
import com.gitblit.models.FederationProposal;
import com.gitblit.models.FederationSet;
@@ -57,10 +60,12 @@
import com.gitblit.models.GitClientApplication;
import com.gitblit.models.Mailing;
import com.gitblit.models.Metric;
import com.gitblit.models.PluginRegistry.InstallState;
import com.gitblit.models.PluginRegistry.PluginRegistration;
import com.gitblit.models.PluginRegistry.PluginRelease;
import com.gitblit.models.ProjectModel;
import com.gitblit.models.RegistrantAccessPermission;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.RepositoryUrl;
import com.gitblit.models.SearchResult;
import com.gitblit.models.ServerSettings;
import com.gitblit.models.ServerStatus;
@@ -68,9 +73,9 @@
import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;
import com.gitblit.tickets.ITicketService;
import com.gitblit.transport.ssh.SshSession;
import com.gitblit.transport.ssh.IPublicKeyManager;
import com.gitblit.transport.ssh.SshKey;
import com.gitblit.utils.ArrayUtils;
import com.gitblit.utils.HttpUtils;
import com.gitblit.utils.JsonUtils;
import com.gitblit.utils.ObjectCache;
import com.gitblit.utils.StringUtils;
@@ -78,6 +83,7 @@
import com.google.gson.JsonIOException;
import com.google.gson.JsonSyntaxException;
import com.google.gson.reflect.TypeToken;
import com.google.inject.Injector;

/**
 * GitblitManager is an aggregate interface delegate.  It implements all the manager
@@ -101,11 +107,15 @@

   protected final IRuntimeManager runtimeManager;

   protected final IPluginManager pluginManager;

   protected final INotificationManager notificationManager;

   protected final IUserManager userManager;

   protected final IAuthenticationManager authenticationManager;

   protected final IPublicKeyManager publicKeyManager;

   protected final IRepositoryManager repositoryManager;

@@ -115,18 +125,22 @@

   public GitblitManager(
         IRuntimeManager runtimeManager,
         IPluginManager pluginManager,
         INotificationManager notificationManager,
         IUserManager userManager,
         IAuthenticationManager authenticationManager,
         IPublicKeyManager publicKeyManager,
         IRepositoryManager repositoryManager,
         IProjectManager projectManager,
         IFederationManager federationManager) {

      this.settings = runtimeManager.getSettings();
      this.runtimeManager = runtimeManager;
      this.pluginManager = pluginManager;
      this.notificationManager = notificationManager;
      this.userManager = userManager;
      this.authenticationManager = authenticationManager;
      this.publicKeyManager = publicKeyManager;
      this.repositoryManager = repositoryManager;
      this.projectManager = projectManager;
      this.federationManager = federationManager;
@@ -323,71 +337,14 @@
               repositoryManager.updateRepositoryModel(model.name, model, false);
            }
         }

         // rename the user's ssh public keystore
         getPublicKeyManager().renameUser(username, user.username);
      }
      if (!userManager.updateUserModel(username, user)) {
         throw new GitBlitException("Failed to update user!");
      }
   }

   /**
    * Returns a list of repository URLs and the user access permission.
    *
    * @param request
    * @param user
    * @param repository
    * @return a list of repository urls
    */
   @Override
   public List<RepositoryUrl> getRepositoryUrls(HttpServletRequest request, UserModel user, RepositoryModel repository) {
      if (user == null) {
         user = UserModel.ANONYMOUS;
      }
      String username = StringUtils.encodeUsername(UserModel.ANONYMOUS.equals(user) ? "" : user.username);

      List<RepositoryUrl> list = new ArrayList<RepositoryUrl>();
      // http/https url
      if (settings.getBoolean(Keys.git.enableGitServlet, true)) {
         AccessPermission permission = user.getRepositoryPermission(repository).permission;
         if (permission.exceeds(AccessPermission.NONE)) {
            list.add(new RepositoryUrl(getRepositoryUrl(request, username, repository), permission));
         }
      }

      // add all other urls
      // {0} = repository
      // {1} = username
      for (String url : settings.getStrings(Keys.web.otherUrls)) {
         if (url.contains("{1}")) {
            // external url requires username, only add url IF we have one
            if (!StringUtils.isEmpty(username)) {
               list.add(new RepositoryUrl(MessageFormat.format(url, repository.name, username), null));
            }
         } else {
            // external url does not require username
            list.add(new RepositoryUrl(MessageFormat.format(url, repository.name), null));
         }
      }
      return list;
   }

   protected String getRepositoryUrl(HttpServletRequest request, String username, RepositoryModel repository) {
      String gitblitUrl = settings.getString(Keys.web.canonicalUrl, null);
      if (StringUtils.isEmpty(gitblitUrl)) {
         gitblitUrl = HttpUtils.getGitblitURL(request);
      }
      StringBuilder sb = new StringBuilder();
      sb.append(gitblitUrl);
      sb.append(Constants.R_PATH);
      sb.append(repository.name);

      // inject username into repository url if authentication is required
      if (repository.accessRestriction.exceeds(AccessRestrictionType.NONE)
            && !StringUtils.isEmpty(username)) {
         sb.insert(sb.indexOf("://") + 3, username + "@");
      }
      return sb.toString();
   }


   /**
    * Returns the list of custom client applications to be used for the
@@ -422,7 +379,7 @@
      // no user definitions, use system definitions
      if (!clientApplications.hasCurrent("system", new Date(0))) {
         try {
            InputStream is = getClass().getResourceAsStream("/clientapps.json");
            InputStream is = GitblitManager.class.getResourceAsStream("/clientapps.json");
            Collection<GitClientApplication> clients = readClientApplications(is);
            is.close();
            if (clients != null) {
@@ -464,7 +421,7 @@
         // Read bundled Gitblit properties to extract setting descriptions.
         // This copy is pristine and only used for populating the setting
         // models map.
         InputStream is = getClass().getResourceAsStream("/reference.properties");
         InputStream is = GitblitManager.class.getResourceAsStream("/reference.properties");
         BufferedReader propertiesReader = new BufferedReader(new InputStreamReader(is));
         StringBuilder description = new StringBuilder();
         SettingModel setting = new SettingModel();
@@ -524,6 +481,11 @@
      throw new RuntimeException("This class does not have a ticket service!");
   }

   @Override
   public IPublicKeyManager getPublicKeyManager() {
      return publicKeyManager;
   }

   /*
    * ISTOREDSETTINGS
    *
@@ -572,13 +534,13 @@
   }

   @Override
   public boolean isServingRepositories() {
      return runtimeManager.isServingRepositories();
   public TimeZone getTimezone() {
      return runtimeManager.getTimezone();
   }

   @Override
   public TimeZone getTimezone() {
      return runtimeManager.getTimezone();
   public Locale getLocale() {
      return runtimeManager.getLocale();
   }

   @Override
@@ -611,9 +573,19 @@
      return runtimeManager.getStatus();
   }

   @Override
   public Injector getInjector() {
      return runtimeManager.getInjector();
   }

   /*
    * NOTIFICATION MANAGER
    */

   @Override
   public boolean isSendingMail() {
      return notificationManager.isSendingMail();
   }

   @Override
   public void sendMailToAdministrators(String subject, String message) {
@@ -652,12 +624,12 @@
      }
      return user;
   }
	

   @Override
   public UserModel authenticate(SshSession sshSession) {
      return authenticationManager.authenticate(sshSession);
   public UserModel authenticate(String username, SshKey key) {
      return authenticationManager.authenticate(username, key);
   }
	

   @Override
   public UserModel authenticate(HttpServletRequest httpRequest, boolean requiresCertificate) {
      UserModel user = authenticationManager.authenticate(httpRequest, requiresCertificate);
@@ -899,6 +871,11 @@
   }

   @Override
   public void resetRepositoryCache(String repositoryName) {
      repositoryManager.resetRepositoryCache(repositoryName);
   }

   @Override
   public List<String> getRepositoryList() {
      return repositoryManager.getRepositoryList();
   }
@@ -977,6 +954,11 @@
   @Override
   public void updateConfiguration(Repository r, RepositoryModel repository) {
      repositoryManager.updateConfiguration(r, repository);
   }

   @Override
   public boolean canDelete(RepositoryModel model) {
      return repositoryManager.canDelete(model);
   }

   @Override
@@ -1161,4 +1143,108 @@
   public boolean isIdle(Repository repository) {
      return repositoryManager.isIdle(repository);
   }

   /*
    * PLUGIN MANAGER
    */

   @Override
   public Version getSystemVersion() {
      return pluginManager.getSystemVersion();
   }

   @Override
   public void startPlugins() {
      pluginManager.startPlugins();
   }

   @Override
   public void stopPlugins() {
      pluginManager.stopPlugins();
   }

   @Override
   public List<PluginWrapper> getPlugins() {
      return pluginManager.getPlugins();
   }

   @Override
   public PluginWrapper getPlugin(String pluginId) {
      return pluginManager.getPlugin(pluginId);
   }

   @Override
   public List<Class<?>> getExtensionClasses(String pluginId) {
      return pluginManager.getExtensionClasses(pluginId);
   }

   @Override
   public <T> List<T> getExtensions(Class<T> clazz) {
      return pluginManager.getExtensions(clazz);
   }

   @Override
   public PluginWrapper whichPlugin(Class<?> clazz) {
      return pluginManager.whichPlugin(clazz);
   }

   @Override
   public PluginState startPlugin(String pluginId) {
      return pluginManager.startPlugin(pluginId);
   }

   @Override
   public PluginState stopPlugin(String pluginId) {
      return pluginManager.stopPlugin(pluginId);
   }

   @Override
   public boolean disablePlugin(String pluginId) {
      return pluginManager.disablePlugin(pluginId);
   }

   @Override
   public boolean enablePlugin(String pluginId) {
      return pluginManager.enablePlugin(pluginId);
   }

   @Override
   public boolean uninstallPlugin(String pluginId) {
      return pluginManager.uninstallPlugin(pluginId);
   }

   @Override
   public boolean refreshRegistry(boolean verifyChecksum) {
      return pluginManager.refreshRegistry(verifyChecksum);
   }

   @Override
   public boolean installPlugin(String url, boolean verifyChecksum) throws IOException {
      return pluginManager.installPlugin(url, verifyChecksum);
   }

   @Override
   public boolean upgradePlugin(String pluginId, String url, boolean verifyChecksum) throws IOException {
      return pluginManager.upgradePlugin(pluginId, url, verifyChecksum);
   }

   @Override
   public List<PluginRegistration> getRegisteredPlugins() {
      return pluginManager.getRegisteredPlugins();
   }

   @Override
   public List<PluginRegistration> getRegisteredPlugins(InstallState state) {
      return pluginManager.getRegisteredPlugins(state);
   }

   @Override
   public PluginRegistration lookupPlugin(String pluginId) {
      return pluginManager.lookupPlugin(pluginId);
   }

   @Override
   public PluginRelease lookupRelease(String pluginId, String version) {
      return pluginManager.lookupRelease(pluginId, version);
   }
}