From cacf8bff097fbb66a7be1bfe267b5da2605145f8 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Fri, 29 Nov 2013 11:05:46 -0500 Subject: [PATCH] Use Dagger to inject managers into all filters and servlets --- src/main/java/com/gitblit/GitBlit.java | 600 ++++++++++++++++++++++++++++++++++------------------------- 1 files changed, 349 insertions(+), 251 deletions(-) diff --git a/src/main/java/com/gitblit/GitBlit.java b/src/main/java/com/gitblit/GitBlit.java index a0e8b0a..8be50fb 100644 --- a/src/main/java/com/gitblit/GitBlit.java +++ b/src/main/java/com/gitblit/GitBlit.java @@ -65,13 +65,12 @@ import javax.naming.InitialContext; import javax.naming.NamingException; import javax.servlet.ServletContext; -import javax.servlet.ServletContextEvent; -import javax.servlet.ServletContextListener; +import javax.servlet.annotation.WebListener; import javax.servlet.http.Cookie; import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; import org.apache.wicket.RequestCycle; -import org.apache.wicket.protocol.http.WebResponse; import org.apache.wicket.resource.ContextRelativeResource; import org.apache.wicket.util.resource.ResourceStreamNotFoundException; import org.eclipse.jgit.lib.Repository; @@ -83,7 +82,6 @@ import org.eclipse.jgit.util.FS; import org.eclipse.jgit.util.FileUtils; import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import com.gitblit.Constants.AccessPermission; import com.gitblit.Constants.AccessRestrictionType; @@ -96,10 +94,20 @@ import com.gitblit.Constants.FederationToken; import com.gitblit.Constants.PermissionType; import com.gitblit.Constants.RegistrantType; +import com.gitblit.dagger.DaggerContextListener; import com.gitblit.fanout.FanoutNioService; import com.gitblit.fanout.FanoutService; import com.gitblit.fanout.FanoutSocketService; import com.gitblit.git.GitDaemon; +import com.gitblit.git.GitServlet; +import com.gitblit.manager.IFederationManager; +import com.gitblit.manager.IGitblitManager; +import com.gitblit.manager.INotificationManager; +import com.gitblit.manager.IProjectManager; +import com.gitblit.manager.IRepositoryManager; +import com.gitblit.manager.IRuntimeManager; +import com.gitblit.manager.ISessionManager; +import com.gitblit.manager.IUserManager; import com.gitblit.models.FederationModel; import com.gitblit.models.FederationProposal; import com.gitblit.models.FederationSet; @@ -136,6 +144,7 @@ import com.gitblit.utils.TimeUtils; import com.gitblit.utils.X509Utils.X509Metadata; import com.gitblit.wicket.GitBlitWebSession; +import com.gitblit.wicket.GitblitWicketFilter; import com.gitblit.wicket.WicketUtils; import com.google.gson.Gson; import com.google.gson.JsonIOException; @@ -145,24 +154,29 @@ /** * 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). + * the GitBlitServer class (Gitblit GO) or is reflectively instantiated by the + * servlet 3 container (Gitblit WAR or Express). * * 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 { +@WebListener +public class GitBlit extends DaggerContextListener + implements IRuntimeManager, + INotificationManager, + IUserManager, + ISessionManager, + IRepositoryManager, + IProjectManager, + IFederationManager, + IGitblitManager { private static GitBlit gitblit; - private final Logger logger = LoggerFactory.getLogger(GitBlit.class); + private final IStoredSettings goSettings; private final ScheduledExecutorService scheduledExecutor = Executors.newScheduledThreadPool(10); @@ -186,8 +200,6 @@ private final ObjectCache<String> projectMarkdownCache = new ObjectCache<String>(); private final ObjectCache<String> projectRepositoriesMarkdownCache = new ObjectCache<String>(); - - private ServletContext servletContext; private File baseFolder; @@ -218,14 +230,18 @@ private GitDaemon gitDaemon; public GitBlit() { - if (gitblit == null) { - // set the static singleton reference - gitblit = this; - } + this.goSettings = null; } - public GitBlit(final IUserService userService) { + protected GitBlit(final IUserService userService) { + this.goSettings = null; this.userService = userService; + gitblit = this; + } + + public GitBlit(IStoredSettings settings, File baseFolder) { + this.goSettings = settings; + this.baseFolder = baseFolder; gitblit = this; } @@ -235,10 +251,25 @@ * @return gitblit singleton */ public static GitBlit self() { - if (gitblit == null) { - new GitBlit(); - } return gitblit; + } + + @SuppressWarnings("unchecked") + public static <X> X getManager(Class<X> managerClass) { + if (managerClass.isAssignableFrom(GitBlit.class)) { + return (X) gitblit; + } + return null; + } + + @Override + public File getBaseFolder() { + return baseFolder; + } + + @Override + public void setBaseFolder(File folder) { + this.baseFolder = folder; } /** @@ -246,8 +277,9 @@ * * @return the boot date of Gitblit */ - public static Date getBootDate() { - return self().serverStatus.bootDate; + @Override + public Date getBootDate() { + return serverStatus.bootDate; } /** @@ -255,10 +287,11 @@ * * @return a date */ - public static Date getLastActivityDate() { + @Override + public Date getLastActivityDate() { Date date = null; - for (String name : self().getRepositoryList()) { - Repository r = self().getRepository(name); + for (String name : getRepositoryList()) { + Repository r = getRepository(name); Date lastChange = JGitUtils.getLastChange(r).when; r.close(); if (lastChange != null && (date == null || lastChange.after(date))) { @@ -269,32 +302,14 @@ } /** - * Determine if this is the GO variant of Gitblit. - * - * @return true if this is the GO variant of Gitblit. - */ - public static boolean isGO() { - return self().settings instanceof FileSettings; - } - - /** * Determine if this Gitblit instance is actively serving git repositories * or if it is merely a repository viewer. * * @return true if Gitblit is serving repositories */ - public static boolean isServingRepositories() { - return getBoolean(Keys.git.enableGitServlet, true) || (getInteger(Keys.git.daemonPort, 0) > 0); - } - - /** - * Determine if this Gitblit instance is actively serving git repositories - * or if it is merely a repository viewer. - * - * @return true if Gitblit is serving repositories - */ - public static boolean isSendingMail() { - return self().mailExecutor.isReady(); + @Override + public boolean isServingRepositories() { + return settings.getBoolean(Keys.git.enableGitServlet, true) || (settings.getInteger(Keys.git.daemonPort, 0) > 0); } /** @@ -302,167 +317,17 @@ * * @return a timezone */ - public static TimeZone getTimezone() { - if (self().timezone == null) { - String tzid = getString("web.timezone", null); + @Override + public TimeZone getTimezone() { + if (timezone == null) { + String tzid = settings.getString("web.timezone", null); if (StringUtils.isEmpty(tzid)) { - self().timezone = TimeZone.getDefault(); - return self().timezone; + timezone = TimeZone.getDefault(); + return timezone; } - self().timezone = TimeZone.getTimeZone(tzid); + timezone = TimeZone.getTimeZone(tzid); } - return self().timezone; - } - - /** - * Returns the active settings. - * - * @return the active settings - */ - public static IStoredSettings getSettings() { - return self().settings; - } - - /** - * Returns the user-defined blob encodings. - * - * @return an array of encodings, may be empty - */ - public static String [] getEncodings() { - return getStrings(Keys.web.blobEncodings).toArray(new String[0]); - } - - - /** - * 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); - } - - /** - * 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); - } - - /** - * Returns the integer list for the specified key. If the key does not - * exist or the value for the key can not be interpreted as an integer, an - * empty list is returned. - * - * @see IStoredSettings.getIntegers(String key) - * @param key - * @return key value or defaultValue - */ - public static List<Integer> getIntegers(String key) { - return self().settings.getIntegers(key); - } - - /** - * 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); - } - - /** - * Returns the char value for the specified key. If the key does not exist - * or the value for the key can not be interpreted as a character, the - * defaultValue is returned. - * - * @see IStoredSettings.getChar(String key, char defaultValue) - * @param key - * @param defaultValue - * @return key value or defaultValue - */ - public static char getChar(String key, char defaultValue) { - return self().settings.getChar(key, defaultValue); - } - - /** - * 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 n - * @return list of strings - */ - public static List<String> getStrings(String key) { - return self().settings.getStrings(key); - } - - /** - * Returns a map of space-separated key-value pairs from the specified key. - * - * @see IStoredSettings.getStrings(String key) - * @param n - * @return map of string, string - */ - public static Map<String, String> getMap(String key) { - return self().settings.getMap(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); + return timezone; } /** @@ -470,8 +335,9 @@ * * @return true if Gitblit is running in debug mode */ - public static boolean isDebugMode() { - return self().settings.getBoolean(Keys.web.debugMode, false); + @Override + public boolean isDebugMode() { + return settings.getBoolean(Keys.web.debugMode, false); } /** @@ -479,8 +345,9 @@ * * @return the file */ - public static File getFileOrFolder(String key, String defaultFileOrFolder) { - String fileOrFolder = GitBlit.getString(key, defaultFileOrFolder); + @Override + public File getFileOrFolder(String key, String defaultFileOrFolder) { + String fileOrFolder = settings.getString(key, defaultFileOrFolder); return getFileOrFolder(fileOrFolder); } @@ -493,9 +360,10 @@ * * @return the file */ - public static File getFileOrFolder(String fileOrFolder) { + @Override + public File getFileOrFolder(String fileOrFolder) { return com.gitblit.utils.FileUtils.resolveParameter(Constants.baseFolder$, - self().baseFolder, fileOrFolder); + baseFolder, fileOrFolder); } /** @@ -504,7 +372,8 @@ * * @return the repositories folder path */ - public static File getRepositoriesFolder() { + @Override + public File getRepositoriesFolder() { return getFileOrFolder(Keys.git.repositoriesFolder, "${baseFolder}/git"); } @@ -514,7 +383,8 @@ * * @return the proposals folder path */ - public static File getProposalsFolder() { + @Override + public File getProposalsFolder() { return getFileOrFolder(Keys.federation.proposalsFolder, "${baseFolder}/proposals"); } @@ -524,20 +394,44 @@ * * @return the Groovy scripts folder path */ - public static File getGroovyScriptsFolder() { + @Override + public File getHooksFolder() { return getFileOrFolder(Keys.groovy.scriptsFolder, "${baseFolder}/groovy"); } /** - * Updates the list of server settings. + * Returns the path of the Groovy Grape folder. This method checks to see if + * Gitblit is running on a cloud service and may return an adjusted path. + * + * @return the Groovy Grape folder path + */ + @Override + public File getGrapesFolder() { + return getFileOrFolder(Keys.groovy.grapeFolder, "${baseFolder}/groovy/grape"); + } + + /** + * Returns the runtime settings. + * + * @return runtime settings + */ + @Override + public IStoredSettings getSettings() { + return settings; + } + + /** + * Updates the runtime settings. * * @param settings * @return true if the update succeeded */ + @Override public boolean updateSettings(Map<String, String> updatedSettings) { return settings.saveSettings(updatedSettings); } + @Override public ServerStatus getStatus() { // update heap memory status serverStatus.heapAllocated = Runtime.getRuntime().totalMemory(); @@ -553,6 +447,7 @@ * @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; @@ -650,6 +545,7 @@ * * @return a collection of client applications */ + @Override public Collection<GitClientApplication> getClientApplications() { // prefer user definitions, if they exist File userDefs = new File(baseFolder, "clientapps.json"); @@ -718,6 +614,7 @@ this.userService.setup(settings); } + @Override public boolean supportsAddUser() { return supportsCredentialChanges(new UserModel("")); } @@ -728,6 +625,7 @@ * @param user * @return true if the user service supports credential changes */ + @Override public boolean supportsCredentialChanges(UserModel user) { if (user == null) { return false; @@ -746,6 +644,7 @@ * @param user * @return true if the user service supports display name changes */ + @Override public boolean supportsDisplayNameChanges(UserModel user) { return (user != null && user.isLocalAccount()) || userService.supportsDisplayNameChanges(); } @@ -756,6 +655,7 @@ * @param user * @return true if the user service supports email address changes */ + @Override public boolean supportsEmailAddressChanges(UserModel user) { return (user != null && user.isLocalAccount()) || userService.supportsEmailAddressChanges(); } @@ -766,6 +666,7 @@ * @param user * @return true if the user service supports team membership changes */ + @Override public boolean supportsTeamMembershipChanges(UserModel user) { return (user != null && user.isLocalAccount()) || userService.supportsTeamMembershipChanges(); } @@ -790,6 +691,7 @@ * @param password * @return a user object or null */ + @Override public UserModel authenticate(String username, char[] password) { if (StringUtils.isEmpty(username)) { // can not authenticate empty username @@ -850,6 +752,7 @@ * @param httpRequest * @return a user object or null */ + @Override public UserModel authenticate(HttpServletRequest httpRequest) { return authenticate(httpRequest, false); } @@ -864,10 +767,11 @@ * @param requiresCertificate * @return a user object or null */ + @Override public UserModel authenticate(HttpServletRequest httpRequest, boolean requiresCertificate) { // try to authenticate by certificate boolean checkValidity = settings.getBoolean(Keys.git.enforceCertificateValidity, true); - String [] oids = getStrings(Keys.git.certificateUsernameOIDs).toArray(new String[0]); + String [] oids = settings.getStrings(Keys.git.certificateUsernameOIDs).toArray(new String[0]); UserModel model = HttpUtils.getUserModelFromCertificate(httpRequest, checkValidity, oids); if (model != null) { // grab real user model and preserve certificate serial number @@ -921,7 +825,7 @@ } // try to authenticate by cookie - if (allowCookieAuthentication()) { + if (supportsCookies()) { UserModel user = authenticate(httpRequest.getCookies()); if (user != null) { flagWicketSession(AuthenticationType.COOKIE); @@ -985,7 +889,8 @@ * @param response * @param user */ - public void setCookie(WebResponse response, UserModel user) { + @Override + public void setCookie(HttpServletResponse response, UserModel user) { if (userService == null) { return; } @@ -1019,6 +924,7 @@ * * @param user */ + @Override public void logout(UserModel user) { if (userService == null) { return; @@ -1052,6 +958,7 @@ * @see IUserService.getAllUsernames() * @return list of all usernames */ + @Override public List<String> getAllUsernames() { List<String> names = new ArrayList<String>(userService.getAllUsernames()); return names; @@ -1063,6 +970,7 @@ * @see IUserService.getAllUsernames() * @return list of all usernames */ + @Override public List<UserModel> getAllUsers() { List<UserModel> users = userService.getAllUsers(); return users; @@ -1075,6 +983,7 @@ * @param username * @return true if successful */ + @Override public boolean deleteUser(String username) { if (StringUtils.isEmpty(username)) { return false; @@ -1083,7 +992,8 @@ return userService.deleteUser(usernameDecoded); } - protected UserModel getFederationUser() { + @Override + public UserModel getFederationUser() { // the federation user is an administrator UserModel federationUser = new UserModel(Constants.FEDERATION_USER); federationUser.canAdmin = true; @@ -1097,6 +1007,7 @@ * @param username * @return a user object or null */ + @Override public UserModel getUserModel(String username) { if (StringUtils.isEmpty(username)) { return null; @@ -1113,6 +1024,7 @@ * @param user * @return the effective list of permissions for the user */ + @Override public List<RegistrantAccessPermission> getUserAccessPermissions(UserModel user) { if (StringUtils.isEmpty(user.username)) { // new user @@ -1123,7 +1035,7 @@ // Flag missing repositories for (RegistrantAccessPermission permission : set) { if (permission.mutable && PermissionType.EXPLICIT.equals(permission.permissionType)) { - RepositoryModel rm = GitBlit.self().getRepositoryModel(permission.registrant); + RepositoryModel rm = getRepositoryModel(permission.registrant); if (rm == null) { permission.permissionType = PermissionType.MISSING; permission.mutable = false; @@ -1158,6 +1070,7 @@ * @param repository * @return a list of RegistrantAccessPermissions */ + @Override public List<RegistrantAccessPermission> getUserAccessPermissions(RepositoryModel repository) { List<RegistrantAccessPermission> list = new ArrayList<RegistrantAccessPermission>(); if (AccessRestrictionType.NONE.equals(repository.accessRestriction)) { @@ -1185,6 +1098,7 @@ * @param permissions * @return true if the user models have been updated */ + @Override public boolean setUserAccessPermissions(RepositoryModel repository, Collection<RegistrantAccessPermission> permissions) { List<UserModel> users = new ArrayList<UserModel>(); for (RegistrantAccessPermission up : permissions) { @@ -1206,6 +1120,7 @@ * @param repository * @return list of all usernames that have an access permission for the repository */ + @Override public List<String> getRepositoryUsers(RepositoryModel repository) { return userService.getUsernamesForRepositoryRole(repository.name); } @@ -1236,6 +1151,7 @@ * @param isCreate * @throws GitBlitException */ + @Override public void updateUserModel(String username, UserModel user, boolean isCreate) throws GitBlitException { if (!username.equalsIgnoreCase(user.username)) { @@ -1283,6 +1199,7 @@ * * @return the list of teams */ + @Override public List<TeamModel> getAllTeams() { List<TeamModel> teams = userService.getAllTeams(); return teams; @@ -1294,6 +1211,7 @@ * @param teamname * @return a TeamModel object or null */ + @Override public TeamModel getTeamModel(String teamname) { return userService.getTeamModel(teamname); } @@ -1306,6 +1224,7 @@ * @param repository * @return a list of RegistrantAccessPermissions */ + @Override public List<RegistrantAccessPermission> getTeamAccessPermissions(RepositoryModel repository) { List<RegistrantAccessPermission> list = new ArrayList<RegistrantAccessPermission>(); for (TeamModel team : userService.getAllTeams()) { @@ -1325,6 +1244,7 @@ * @param permissions * @return true if the team models have been updated */ + @Override public boolean setTeamAccessPermissions(RepositoryModel repository, Collection<RegistrantAccessPermission> permissions) { List<TeamModel> teams = new ArrayList<TeamModel>(); for (RegistrantAccessPermission tp : permissions) { @@ -1346,6 +1266,7 @@ * @param repository * @return list of all teamnames with explicit access permissions to the repository */ + @Override public List<String> getRepositoryTeams(RepositoryModel repository) { return userService.getTeamnamesForRepositoryRole(repository.name); } @@ -1373,6 +1294,7 @@ * @param team * @param isCreate */ + @Override public void updateTeamModel(String teamname, TeamModel team, boolean isCreate) throws GitBlitException { if (!teamname.equalsIgnoreCase(team.name)) { @@ -1394,6 +1316,7 @@ * @param teamname * @return true if successful */ + @Override public boolean deleteTeam(String teamname) { return userService.deleteTeam(teamname); } @@ -1404,7 +1327,8 @@ * * @param model */ - private void addToCachedRepositoryList(RepositoryModel model) { + @Override + public void addToCachedRepositoryList(RepositoryModel model) { if (settings.getBoolean(Keys.git.cacheRepositoryList, true)) { repositoryListCache.put(model.name.toLowerCase(), model); @@ -1445,6 +1369,7 @@ * Resets the repository list cache. * */ + @Override public void resetRepositoryListCache() { logger.info("Repository cache manually reset"); repositoryListCache.clear(); @@ -1488,6 +1413,7 @@ * * @return list of all repositories */ + @Override public List<String> getRepositoryList() { if (repositoryListCache.size() == 0 || !isValidRepositoryList()) { // we are not caching OR we have not yet cached OR the cached list is invalid @@ -1505,7 +1431,7 @@ } else { // we are caching this list String msg = "{0} repositories identified in {1} msecs"; - if (getBoolean(Keys.web.showRepositorySizes, true)) { + if (settings.getBoolean(Keys.web.showRepositorySizes, true)) { // optionally (re)calculate repository sizes msg = "{0} repositories identified with calculated folder sizes in {1} msecs"; } @@ -1544,6 +1470,7 @@ * @param repositoryName * @return repository or null */ + @Override public Repository getRepository(String repositoryName) { return getRepository(repositoryName, true); } @@ -1555,6 +1482,7 @@ * @param logError * @return repository or null */ + @Override public Repository getRepository(String repositoryName, boolean logError) { // Decode url-encoded repository name (issue-278) // http://stackoverflow.com/questions/17183110 @@ -1588,6 +1516,7 @@ * @param user * @return list of repository models accessible to user */ + @Override public List<RepositoryModel> getRepositoryModels(UserModel user) { long methodStart = System.currentTimeMillis(); List<String> list = getRepositoryList(); @@ -1620,6 +1549,7 @@ * @param repositoryName * @return repository model or null */ + @Override public RepositoryModel getRepositoryModel(UserModel user, String repositoryName) { RepositoryModel model = getRepositoryModel(repositoryName); if (model == null) { @@ -1641,6 +1571,7 @@ * @param repositoryName * @return repository model or null */ + @Override public RepositoryModel getRepositoryModel(String repositoryName) { // Decode url-encoded repository name (issue-278) // http://stackoverflow.com/questions/17183110 @@ -1702,6 +1633,7 @@ * @param repository * @return the star count */ + @Override public long getStarCount(RepositoryModel repository) { long count = 0; for (UserModel user : getAllUsers()) { @@ -1752,7 +1684,7 @@ } // project configs - String rootName = GitBlit.getString(Keys.web.repositoryRootGroupName, "main"); + String rootName = settings.getString(Keys.web.repositoryRootGroupName, "main"); ProjectModel rootProject = new ProjectModel(rootName, true); Map<String, ProjectModel> configs = new HashMap<String, ProjectModel>(); @@ -1787,6 +1719,7 @@ * @param includeUsers * @return list of projects that are accessible to the user */ + @Override public List<ProjectModel> getProjectModels(UserModel user, boolean includeUsers) { Map<String, ProjectModel> configs = getProjectConfigs(); @@ -1841,6 +1774,7 @@ * @param user * @return a project model, or null if it does not exist */ + @Override public ProjectModel getProjectModel(String name, UserModel user) { for (ProjectModel project : getProjectModels(user, true)) { if (project.name.equalsIgnoreCase(name)) { @@ -1856,6 +1790,7 @@ * @param name a project name * @return a project model or null if the project does not exist */ + @Override public ProjectModel getProjectModel(String name) { Map<String, ProjectModel> configs = getProjectConfigs(); ProjectModel project = configs.get(name.toLowerCase()); @@ -1906,6 +1841,7 @@ * @param includeUsers * @return a list of project models */ + @Override public List<ProjectModel> getProjectModels(List<RepositoryModel> repositoryModels, boolean includeUsers) { Map<String, ProjectModel> projects = new LinkedHashMap<String, ProjectModel>(); for (RepositoryModel repository : repositoryModels) { @@ -2006,7 +1942,6 @@ model.description = getConfig(config, "description", ""); model.originRepository = getConfig(config, "originRepository", null); model.addOwners(ArrayUtils.fromString(getConfig(config, "owner", ""))); - model.useDocs = getConfig(config, "useDocs", false); model.useIncrementalPushTags = getConfig(config, "useIncrementalPushTags", false); model.incrementalPushTagPrefix = getConfig(config, "incrementalPushTagPrefix", null); model.allowForks = getConfig(config, "allowForks", true); @@ -2091,6 +2026,7 @@ * @param n * @return true if the repository exists */ + @Override public boolean hasRepository(String repositoryName) { return hasRepository(repositoryName, false); } @@ -2102,6 +2038,7 @@ * @param caseInsensitive * @return true if the repository exists */ + @Override public boolean hasRepository(String repositoryName, boolean caseSensitiveCheck) { if (!caseSensitiveCheck && settings.getBoolean(Keys.git.cacheRepositoryList, true)) { // if we are caching use the cache to determine availability @@ -2124,6 +2061,7 @@ * @param origin * @return true the if the user has a fork */ + @Override public boolean hasFork(String username, String origin) { return getFork(username, origin) != null; } @@ -2136,6 +2074,7 @@ * @param origin * @return the name of the user's fork, null otherwise */ + @Override public String getFork(String username, String origin) { String userProject = ModelUtils.getPersonalPath(username); if (settings.getBoolean(Keys.git.cacheRepositoryList, true)) { @@ -2201,6 +2140,7 @@ * @param repository * @return a ForkModel */ + @Override public ForkModel getForkNetwork(String repository) { if (settings.getBoolean(Keys.git.cacheRepositoryList, true)) { // find the root, cached @@ -2264,12 +2204,13 @@ * @param model * @return size in bytes of the repository */ + @Override public long updateLastChangeFields(Repository r, RepositoryModel model) { LastChange lc = JGitUtils.getLastChange(r); model.lastChange = lc.when; model.lastChangeAuthor = lc.who; - if (!getBoolean(Keys.web.showRepositorySizes, true) || model.skipSizeCalculation) { + if (!settings.getBoolean(Keys.web.showRepositorySizes, true) || model.skipSizeCalculation) { model.size = null; return 0L; } @@ -2337,6 +2278,7 @@ * @param repository * @return a new array list of metrics */ + @Override public List<Metric> getRepositoryDefaultMetrics(RepositoryModel model, Repository repository) { if (repositoryMetricsCache.hasCurrent(model.name, model.lastChange)) { return new ArrayList<Metric>(repositoryMetricsCache.getObject(model.name)); @@ -2411,6 +2353,7 @@ * @param isCreate * @throws GitBlitException */ + @Override public void updateRepositoryModel(String repositoryName, RepositoryModel repository, boolean isCreate) throws GitBlitException { if (gcExecutor.isCollectingGarbage(repositoryName)) { @@ -2420,7 +2363,7 @@ Repository r = null; String projectPath = StringUtils.getFirstPathElement(repository.name); if (!StringUtils.isEmpty(projectPath)) { - if (projectPath.equalsIgnoreCase(getString(Keys.web.repositoryRootGroupName, "main"))) { + if (projectPath.equalsIgnoreCase(settings.getString(Keys.web.repositoryRootGroupName, "main"))) { // strip leading group name repository.name = repository.name.substring(projectPath.length() + 1); } @@ -2437,7 +2380,7 @@ } // create repository logger.info("create repository " + repository.name); - String shared = getString(Keys.git.createRepositoriesShared, "FALSE"); + String shared = settings.getString(Keys.git.createRepositoriesShared, "FALSE"); r = JGitUtils.createRepository(repositoriesFolder, repository.name, shared); } else { // rename repository @@ -2539,9 +2482,9 @@ // Adjust permissions in case we updated the config files JGitUtils.adjustSharedPerm(new File(r.getDirectory().getAbsolutePath(), "config"), - getString(Keys.git.createRepositoriesShared, "FALSE")); + settings.getString(Keys.git.createRepositoriesShared, "FALSE")); JGitUtils.adjustSharedPerm(new File(r.getDirectory().getAbsolutePath(), "HEAD"), - getString(Keys.git.createRepositoriesShared, "FALSE")); + settings.getString(Keys.git.createRepositoriesShared, "FALSE")); // close the repository object r.close(); @@ -2561,12 +2504,12 @@ * @param repository * the Gitblit repository model */ + @Override public void updateConfiguration(Repository r, RepositoryModel repository) { StoredConfig config = r.getConfig(); config.setString(Constants.CONFIG_GITBLIT, null, "description", repository.description); config.setString(Constants.CONFIG_GITBLIT, null, "originRepository", repository.originRepository); config.setString(Constants.CONFIG_GITBLIT, null, "owner", ArrayUtils.toString(repository.owners)); - config.setBoolean(Constants.CONFIG_GITBLIT, null, "useDocs", repository.useDocs); config.setBoolean(Constants.CONFIG_GITBLIT, null, "useIncrementalPushTags", repository.useIncrementalPushTags); if (StringUtils.isEmpty(repository.incrementalPushTagPrefix) || repository.incrementalPushTagPrefix.equals(settings.getString(Keys.git.defaultIncrementalPushTagPrefix, "r"))) { @@ -2661,6 +2604,7 @@ * @param model * @return true if successful */ + @Override public boolean deleteRepositoryModel(RepositoryModel model) { return deleteRepository(model.name); } @@ -2672,6 +2616,7 @@ * @param repositoryName * @return true if successful */ + @Override public boolean deleteRepository(String repositoryName) { try { closeRepository(repositoryName); @@ -2793,8 +2738,9 @@ return scheduledExecutor; } - public static boolean canFederate() { - String passphrase = getString(Keys.federation.passphrase, ""); + @Override + public boolean canFederate() { + String passphrase = settings.getString(Keys.federation.passphrase, ""); return !StringUtils.isEmpty(passphrase); } @@ -2837,6 +2783,7 @@ * * @return list of registered gitblit instances */ + @Override public List<FederationModel> getFederationRegistrations() { if (federationRegistrations.isEmpty()) { federationRegistrations.addAll(FederationUtils.getFederationRegistrations(settings)); @@ -2851,6 +2798,7 @@ * the name of the registration * @return a federation registration */ + @Override public FederationModel getFederationRegistration(String url, String name) { // check registrations for (FederationModel r : getFederationRegistrations()) { @@ -2873,6 +2821,7 @@ * * @return list of federation sets */ + @Override public List<FederationSet> getFederationSets(String gitblitUrl) { List<FederationSet> list = new ArrayList<FederationSet>(); // generate standard tokens @@ -2896,6 +2845,7 @@ * * @return list of federation tokens */ + @Override public List<String> getFederationTokens() { List<String> tokens = new ArrayList<String>(); // generate standard tokens @@ -2915,6 +2865,7 @@ * @param type * @return a federation token */ + @Override public String getFederationToken(FederationToken type) { return getFederationToken(type.name()); } @@ -2925,6 +2876,7 @@ * @param value * @return a federation token */ + @Override public String getFederationToken(String value) { String passphrase = settings.getString(Keys.federation.passphrase, ""); return StringUtils.getSHA1(passphrase + "-" + value); @@ -2938,6 +2890,7 @@ * @param token * @return true if the request can be executed */ + @Override public boolean validateFederationRequest(FederationRequest req, String token) { String all = getFederationToken(FederationToken.ALL); String unr = getFederationToken(FederationToken.USERS_AND_REPOSITORIES); @@ -2966,6 +2919,7 @@ * the registration from the pulling Gitblit instance * @return true if acknowledged */ + @Override public boolean acknowledgeFederationStatus(String identification, FederationModel registration) { // reset the url to the identification of the pulling Gitblit instance registration.url = identification; @@ -2982,6 +2936,7 @@ * * @return the list of registration results */ + @Override public List<FederationModel> getFederationResultRegistrations() { return new ArrayList<FederationModel>(federationPullResults.values()); } @@ -2997,6 +2952,7 @@ * administrators * @return true if the proposal was submitted */ + @Override public boolean submitFederationProposal(FederationProposal proposal, String gitblitUrl) { // convert proposal to json String json = JsonUtils.toJsonString(proposal); @@ -3024,6 +2980,7 @@ * * @return list of federation proposals */ + @Override public List<FederationProposal> getPendingFederationProposals() { List<FederationProposal> list = new ArrayList<FederationProposal>(); File folder = getProposalsFolder(); @@ -3054,9 +3011,10 @@ * the federation token * @return a map of <cloneurl, RepositoryModel> */ + @Override public Map<String, RepositoryModel> getRepositories(String gitblitUrl, String token) { Map<String, String> federationSets = new HashMap<String, String>(); - for (String set : getStrings(Keys.federation.sets)) { + for (String set : settings.getStrings(Keys.federation.sets)) { federationSets.put(getFederationToken(set), set); } @@ -3112,6 +3070,7 @@ * @param token * @return a potential proposal */ + @Override public FederationProposal createFederationProposal(String gitblitUrl, String token) { FederationToken tokenType = FederationToken.REPOSITORIES; for (FederationToken type : FederationToken.values()) { @@ -3132,6 +3091,7 @@ * @param token * @return the specified proposal or null */ + @Override public FederationProposal getPendingFederationProposal(String token) { List<FederationProposal> list = getPendingFederationProposals(); for (FederationProposal proposal : list) { @@ -3149,6 +3109,7 @@ * proposal * @return true if the proposal was deleted */ + @Override public boolean deletePendingFederationProposal(FederationProposal proposal) { File folder = getProposalsFolder(); File file = new File(folder, proposal.token + Constants.PROPOSAL_EXT); @@ -3161,8 +3122,9 @@ * * @return list of available hook scripts */ + @Override public List<String> getAllScripts() { - File groovyFolder = getGroovyScriptsFolder(); + File groovyFolder = getHooksFolder(); File[] files = groovyFolder.listFiles(new FileFilter() { @Override public boolean accept(File pathname) { @@ -3187,10 +3149,11 @@ * if null only the globally specified scripts are returned * @return a list of scripts */ + @Override public List<String> getPreReceiveScriptsInherited(RepositoryModel repository) { Set<String> scripts = new LinkedHashSet<String>(); // Globals - for (String script : getStrings(Keys.groovy.preReceiveScripts)) { + for (String script : settings.getStrings(Keys.groovy.preReceiveScripts)) { if (script.endsWith(".groovy")) { scripts.add(script.substring(0, script.lastIndexOf('.'))); } else { @@ -3219,6 +3182,7 @@ * optional parameter * @return list of available hook scripts */ + @Override public List<String> getPreReceiveScriptsUnused(RepositoryModel repository) { Set<String> inherited = new TreeSet<String>(getPreReceiveScriptsInherited(repository)); @@ -3240,10 +3204,11 @@ * if null only the globally specified scripts are returned * @return a list of scripts */ + @Override public List<String> getPostReceiveScriptsInherited(RepositoryModel repository) { Set<String> scripts = new LinkedHashSet<String>(); // Global Scripts - for (String script : getStrings(Keys.groovy.postReceiveScripts)) { + for (String script : settings.getStrings(Keys.groovy.postReceiveScripts)) { if (script.endsWith(".groovy")) { scripts.add(script.substring(0, script.lastIndexOf('.'))); } else { @@ -3271,6 +3236,7 @@ * optional parameter * @return list of available hook scripts */ + @Override public List<String> getPostReceiveScriptsUnused(RepositoryModel repository) { Set<String> inherited = new TreeSet<String>(getPostReceiveScriptsInherited(repository)); @@ -3293,6 +3259,7 @@ * @param repositories * @return */ + @Override public List<SearchResult> search(String query, int page, int pageSize, List<String> repositories) { List<SearchResult> srs = luceneExecutor.search(query, page, pageSize, repositories); return srs; @@ -3304,6 +3271,7 @@ * @param subject * @param message */ + @Override public void sendMailToAdministrators(String subject, String message) { List<String> toAddresses = settings.getStrings(Keys.mail.adminAddresses); sendMail(subject, message, toAddresses); @@ -3316,6 +3284,7 @@ * @param message * @param toAddresses */ + @Override public void sendMail(String subject, String message, Collection<String> toAddresses) { this.sendMail(subject, message, toAddresses.toArray(new String[0])); } @@ -3327,6 +3296,7 @@ * @param message * @param toAddresses */ + @Override public void sendMail(String subject, String message, String... toAddresses) { if (toAddresses == null || toAddresses.length == 0) { logger.debug(MessageFormat.format("Dropping message {0} because there are no recipients", subject)); @@ -3360,6 +3330,7 @@ * @param message * @param toAddresses */ + @Override public void sendHtmlMail(String subject, String message, Collection<String> toAddresses) { this.sendHtmlMail(subject, message, toAddresses.toArray(new String[0])); } @@ -3371,6 +3342,7 @@ * @param message * @param toAddresses */ + @Override public void sendHtmlMail(String subject, String message, String... toAddresses) { if (toAddresses == null || toAddresses.length == 0) { logger.debug(MessageFormat.format("Dropping message {0} because there are no recipients", subject)); @@ -3402,6 +3374,7 @@ * * @return SettingsModel */ + @Override public ServerSettings getSettingsModel() { // ensure that the current values are updated in the setting models for (String key : settings.getAllKeys(null)) { @@ -3506,9 +3479,9 @@ // prepare service executors mailExecutor = new MailExecutor(settings); - luceneExecutor = new LuceneExecutor(settings, repositoriesFolder); - gcExecutor = new GCExecutor(settings); - mirrorExecutor = new MirrorExecutor(settings); + luceneExecutor = new LuceneExecutor(settings, getManager(IRepositoryManager.class)); + gcExecutor = new GCExecutor(settings, getManager(IRepositoryManager.class)); + mirrorExecutor = new MirrorExecutor(settings, getManager(IRepositoryManager.class)); // initialize utilities String prefix = settings.getString(Keys.git.userRepositoryPrefix, "~"); @@ -3526,7 +3499,7 @@ logTimezone("JVM", TimeZone.getDefault()); logTimezone(Constants.NAME, getTimezone()); - serverStatus = new ServerStatus(isGO()); + serverStatus = new ServerStatus(goSettings != null); if (this.userService == null) { String realm = settings.getString(Keys.realm.userService, "${baseFolder}/users.properties"); @@ -3556,8 +3529,6 @@ configureFanout(); configureGitDaemon(); configureCommitCache(); - - ContainerUtils.CVE_2007_0450.test(); } protected void configureMailExecutor() { @@ -3670,7 +3641,7 @@ String bindInterface = settings.getString(Keys.git.daemonBindInterface, "localhost"); if (port > 0) { try { - gitDaemon = new GitDaemon(bindInterface, port, getRepositoriesFolder()); + gitDaemon = new GitDaemon(this, this, this, this); gitDaemon.start(); } catch (IOException e) { gitDaemon = null; @@ -3741,11 +3712,9 @@ * @see ServletContextListener.contextInitialize(ServletContextEvent) */ @Override - public void contextInitialized(ServletContextEvent contextEvent) { - servletContext = contextEvent.getServletContext(); + protected void beforeServletInjection(ServletContext context) { if (settings == null) { // Gitblit is running in a servlet container - ServletContext context = contextEvent.getServletContext(); WebXmlSettings webxmlSettings = new WebXmlSettings(context); String contextRealPath = context.getRealPath("/"); File contextFolder = (contextRealPath != null) ? new File(contextRealPath) : null; @@ -3775,6 +3744,10 @@ } } } + + // disable Git daemon on Express - we can't bind 9418 and we + // can't port-forward to the daemon + webxmlSettings.overrideSetting(Keys.git.daemonPort, 0); // configure context using the web.xml configureContext(webxmlSettings, base, true); @@ -3819,10 +3792,14 @@ FileSettings settings = new FileSettings(localSettings.getAbsolutePath()); configureContext(settings, base, true); } + + // WAR or Express is likely to be running on a Tomcat. + // Test for the forward-slash/%2F issue and auto-adjust settings. + ContainerUtils.CVE_2007_0450.test(settings); } settingsModel = loadSettingModels(); - serverStatus.servletContainer = servletContext.getServerInfo(); + serverStatus.servletContainer = context.getServerInfo(); } protected void extractResources(ServletContext context, String path, File toDir) { @@ -3877,7 +3854,7 @@ * shutting down or because the servlet container is re-deploying Gitblit. */ @Override - public void contextDestroyed(ServletContextEvent contextEvent) { + protected void destroyContext(ServletContext context) { logger.info("Gitblit context destroyed by servlet container."); scheduledExecutor.shutdownNow(); luceneExecutor.close(); @@ -3895,6 +3872,7 @@ * * @return true if we are running the gc executor */ + @Override public boolean isCollectingGarbage() { return gcExecutor.isRunning(); } @@ -3905,6 +3883,7 @@ * @param repositoryName * @return true if actively collecting garbage */ + @Override public boolean isCollectingGarbage(String repositoryName) { return gcExecutor.isCollectingGarbage(repositoryName); } @@ -3919,6 +3898,7 @@ * @return the repository model of the fork, if successful * @throws GitBlitException */ + @Override public RepositoryModel fork(RepositoryModel repository, UserModel user) throws GitBlitException { String cloneName = MessageFormat.format("{0}/{1}.git", user.getPersonalPath(), StringUtils.stripDotGit(StringUtils.getLastPathElement(repository.name))); String fromUrl = MessageFormat.format("file://{0}/{1}", repositoriesFolder.getAbsolutePath(), repository.name); @@ -3986,7 +3966,125 @@ * * @return status of Cookie authentication enablement. */ - public boolean allowCookieAuthentication() { - return GitBlit.getBoolean(Keys.web.allowCookieAuthentication, true) && userService.supportsCookies(); + @Override + public boolean supportsCookies() { + return settings.getBoolean(Keys.web.allowCookieAuthentication, true) && userService.supportsCookies(); + } + + @Override + public String getCookie(UserModel model) { + return userService.getCookie(model); + } + + @Override + public UserModel authenticate(char[] cookie) { + return userService.authenticate(cookie); + } + + @Override + public boolean updateUserModel(UserModel model) { + return userService.updateUserModel(model); + } + + @Override + public boolean updateUserModels(Collection<UserModel> models) { + return userService.updateUserModels(models); + } + + @Override + public boolean updateUserModel(String username, UserModel model) { + return userService.updateUserModel(username, model); + } + + @Override + public boolean deleteUserModel(UserModel model) { + return userService.deleteUserModel(model); + } + + @Override + public List<String> getAllTeamNames() { + return userService.getAllTeamNames(); + } + + @Override + public List<String> getTeamnamesForRepositoryRole(String role) { + return userService.getTeamnamesForRepositoryRole(role); + } + + @Override + public boolean updateTeamModel(TeamModel model) { + return userService.updateTeamModel(model); + } + + @Override + public boolean updateTeamModels(Collection<TeamModel> models) { + return userService.updateTeamModels(models); + } + + @Override + public boolean updateTeamModel(String teamname, TeamModel model) { + return userService.updateTeamModel(teamname, model); + } + + @Override + public boolean deleteTeamModel(TeamModel model) { + return userService.deleteTeamModel(model); + } + + @Override + public List<String> getUsernamesForRepositoryRole(String role) { + return userService.getUsernamesForRepositoryRole(role); + } + + @Override + public boolean renameRepositoryRole(String oldRole, String newRole) { + return userService.renameRepositoryRole(oldRole, newRole); + } + + @Override + public boolean deleteRepositoryRole(String role) { + return userService.deleteRepositoryRole(role); + } + + @Override + public void logout(HttpServletResponse response, UserModel user) { + setCookie(response, null); + userService.logout(user); + } + + @Override + protected Object [] getModules() { + return new Object [] { new DaggerModule(this) }; + } + + /** + * Instantiate and inject all filters and servlets into the container using + * the servlet 3 specification. + */ + @Override + protected void injectServlets(ServletContext context) { + // access restricted servlets + serve(context, Constants.GIT_PATH, GitServlet.class, GitFilter.class); + serve(context, Constants.PAGES, PagesServlet.class, PagesFilter.class); + serve(context, Constants.RPC_PATH, RpcServlet.class, RpcFilter.class); + serve(context, Constants.ZIP_PATH, DownloadZipServlet.class, DownloadZipFilter.class); + serve(context, Constants.SYNDICATION_PATH, SyndicationServlet.class, SyndicationFilter.class); + + // servlets + serve(context, Constants.FEDERATION_PATH, FederationServlet.class); + serve(context, Constants.SPARKLESHARE_INVITE_PATH, SparkleShareInviteServlet.class); + serve(context, Constants.BRANCH_GRAPH_PATH, BranchGraphServlet.class); + file(context, "/robots.txt", RobotsTxtServlet.class); + file(context, "/logo.png", LogoServlet.class); + + // optional force basic authentication + filter(context, "/*", EnforceAuthenticationFilter.class, null); + + // Wicket + String toIgnore = StringUtils.flattenStrings(getRegisteredPaths(), ","); + Map<String, String> params = new HashMap<String, String>(); + params.put(GitblitWicketFilter.FILTER_MAPPING_PARAM, "/*"); + params.put(GitblitWicketFilter.IGNORE_PATHS_PARAM, toIgnore); + filter(context, "/*", GitblitWicketFilter.class, params); } } -- Gitblit v1.9.1