From 3b6904b1d92b987e308f5fb3308fec215ba1f1ae Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Tue, 13 Dec 2011 16:51:36 -0500 Subject: [PATCH] Integrated Clippy for a better copy-to-clipboard experience --- src/com/gitblit/GitBlit.java | 194 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 files changed, 185 insertions(+), 9 deletions(-) diff --git a/src/com/gitblit/GitBlit.java b/src/com/gitblit/GitBlit.java index bc35667..13dc3fa 100644 --- a/src/com/gitblit/GitBlit.java +++ b/src/com/gitblit/GitBlit.java @@ -69,6 +69,7 @@ import com.gitblit.models.ServerSettings; import com.gitblit.models.ServerStatus; import com.gitblit.models.SettingModel; +import com.gitblit.models.TeamModel; import com.gitblit.models.UserModel; import com.gitblit.utils.ByteFormat; import com.gitblit.utils.FederationUtils; @@ -244,6 +245,54 @@ */ public static boolean isDebugMode() { return self().settings.getBoolean(Keys.web.debugMode, false); + } + + /** + * Returns the file object for the specified configuration key. + * + * @return the file + */ + public static File getFileOrFolder(String key, String defaultFileOrFolder) { + String fileOrFolder = GitBlit.getString(key, defaultFileOrFolder); + return getFileOrFolder(fileOrFolder); + } + + /** + * Returns the file object which may have it's base-path determined by + * environment variables for running on a cloud hosting service. All Gitblit + * file or folder retrievals are (at least initially) funneled through this + * method so it is the correct point to globally override/alter filesystem + * access based on environment or some other indicator. + * + * @return the file + */ + public static File getFileOrFolder(String fileOrFolder) { + String openShift = System.getenv("OPENSHIFT_DATA_DIR"); + if (!StringUtils.isEmpty(openShift)) { + // running on RedHat OpenShift + return new File(openShift, fileOrFolder); + } + return new File(fileOrFolder); + } + + /** + * Returns the path of the repositories folder. This method checks to see if + * Gitblit is running on a cloud service and may return an adjusted path. + * + * @return the repositories folder path + */ + public static File getRepositoriesFolder() { + return getFileOrFolder(Keys.git.repositoriesFolder, "git"); + } + + /** + * Returns the path of the proposals folder. This method checks to see if + * Gitblit is running on a cloud service and may return an adjusted path. + * + * @return the proposals folder path + */ + public static File getProposalsFolder() { + return getFileOrFolder(Keys.federation.proposalsFolder, "proposals"); } /** @@ -460,6 +509,83 @@ if (!userService.updateUserModel(username, user)) { throw new GitBlitException(isCreate ? "Failed to add user!" : "Failed to update user!"); } + } + + /** + * Returns the list of available teams that a user or repository may be + * assigned to. + * + * @return the list of teams + */ + public List<String> getAllTeamnames() { + List<String> teams = new ArrayList<String>(userService.getAllTeamNames()); + Collections.sort(teams); + return teams; + } + + /** + * Returns the TeamModel object for the specified name. + * + * @param teamname + * @return a TeamModel object or null + */ + public TeamModel getTeamModel(String teamname) { + return userService.getTeamModel(teamname); + } + + /** + * Returns the list of all teams who are allowed to bypass the access + * restriction placed on the specified repository. + * + * @see IUserService.getTeamnamesForRepositoryRole(String) + * @param repository + * @return list of all teamnames that can bypass the access restriction + */ + public List<String> getRepositoryTeams(RepositoryModel repository) { + return userService.getTeamnamesForRepositoryRole(repository.name); + } + + /** + * Sets the list of all uses who are allowed to bypass the access + * restriction placed on the specified repository. + * + * @see IUserService.setTeamnamesForRepositoryRole(String, List<String>) + * @param repository + * @param teamnames + * @return true if successful + */ + public boolean setRepositoryTeams(RepositoryModel repository, List<String> repositoryTeams) { + return userService.setTeamnamesForRepositoryRole(repository.name, repositoryTeams); + } + /** + * Updates the TeamModel object for the specified name. + * + * @param teamname + * @param team + * @param isCreate + */ + public void updateTeamModel(String teamname, TeamModel team, boolean isCreate) throws GitBlitException { + if (!teamname.equalsIgnoreCase(team.name)) { + if (userService.getTeamModel(team.name) != null) { + throw new GitBlitException(MessageFormat.format( + "Failed to rename ''{0}'' because ''{1}'' already exists.", teamname, + team.name)); + } + } + if (!userService.updateTeamModel(teamname, team)) { + throw new GitBlitException(isCreate ? "Failed to add team!" : "Failed to update team!"); + } + } + + /** + * Delete the team object with the specified teamname + * + * @see IUserService.deleteTeam(String) + * @param teamname + * @return true if successful + */ + public boolean deleteTeam(String teamname) { + return userService.deleteTeam(teamname); } /** @@ -1067,6 +1193,7 @@ case PULL_REPOSITORIES: return token.equals(all) || token.equals(unr) || token.equals(jur); case PULL_USERS: + case PULL_TEAMS: return token.equals(all) || token.equals(unr); case PULL_SETTINGS: return token.equals(all); @@ -1120,8 +1247,7 @@ try { // make the proposals folder - File proposalsFolder = new File(getString(Keys.federation.proposalsFolder, "proposals") - .trim()); + File proposalsFolder = getProposalsFolder(); proposalsFolder.mkdirs(); // cache json to a file @@ -1153,7 +1279,7 @@ */ public List<FederationProposal> getPendingFederationProposals() { List<FederationProposal> list = new ArrayList<FederationProposal>(); - File folder = new File(getString(Keys.federation.proposalsFolder, "proposals").trim()); + File folder = getProposalsFolder(); if (folder.exists()) { File[] files = folder.listFiles(new FileFilter() { @Override @@ -1276,7 +1402,7 @@ * @return true if the proposal was deleted */ public boolean deletePendingFederationProposal(FederationProposal proposal) { - File folder = new File(getString(Keys.federation.proposalsFolder, "proposals").trim()); + File folder = getProposalsFolder(); File file = new File(folder, proposal.token + Constants.PROPOSAL_EXT); return file.delete(); } @@ -1388,10 +1514,11 @@ * * @param settings */ + @SuppressWarnings("deprecation") public void configureContext(IStoredSettings settings, boolean startFederation) { logger.info("Reading configuration from " + settings.toString()); this.settings = settings; - repositoriesFolder = new File(settings.getString(Keys.git.repositoriesFolder, "git")); + repositoriesFolder = getRepositoriesFolder(); logger.info("Git repositories folder " + repositoriesFolder.getAbsolutePath()); repositoryResolver = new FileResolver<Void>(repositoriesFolder, exportAll); serverStatus = new ServerStatus(isGO()); @@ -1406,16 +1533,51 @@ } 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()) { + File realmFile = getFileOrFolder(Keys.realm.userService, "users.conf"); + if (realmFile.exists()) { + // load the existing realm file + if (realmFile.getName().toLowerCase().endsWith(".properties")) { + // load the v0.5.0 - v0.7.0 properties-based realm file + loginService = new FileUserService(realmFile); + + // automatically create a users.conf realm file from the + // original users.properties file + File usersConfig = new File(realmFile.getParentFile(), "users.conf"); + if (!usersConfig.exists()) { + logger.info(MessageFormat.format("Automatically creating {0} based on {1}", + usersConfig.getAbsolutePath(), realmFile.getAbsolutePath())); + ConfigUserService configService = new ConfigUserService(usersConfig); + for (String username : loginService.getAllUsernames()) { + UserModel userModel = loginService.getUserModel(username); + configService.updateUserModel(userModel); + } + } + + // issue suggestion about switching to users.conf + logger.warn("Please consider using \"users.conf\" instead of the deprecated \"users.properties\" file"); + } else if (realmFile.getName().toLowerCase().endsWith(".conf")) { + // load the config-based realm file + loginService = new ConfigUserService(realmFile); + } + } else { + // Create a new realm file and add the default admin + // account. This is necessary for bootstrapping a dynamic + // environment like running on a cloud service. + // As of v0.8.0 the default realm file is ConfigUserService. try { + realmFile = getFileOrFolder(Keys.realm.userService, "users.conf"); realmFile.createNewFile(); + loginService = new ConfigUserService(realmFile); + UserModel admin = new UserModel("admin"); + admin.password = "admin"; + admin.canAdmin = true; + admin.excludeFromFederation = true; + loginService.updateUserModel(admin); } catch (IOException x) { logger.error( MessageFormat.format("COULD NOT CREATE REALM FILE {0}!", realmFile), x); } } - loginService = new FileUserService(realmFile); } setUserService(loginService); mailExecutor = new MailExecutor(settings); @@ -1441,7 +1603,21 @@ settingsModel = loadSettingModels(); if (settings == null) { // Gitblit WAR is running in a servlet container - WebXmlSettings webxmlSettings = new WebXmlSettings(contextEvent.getServletContext()); + ServletContext context = contextEvent.getServletContext(); + WebXmlSettings webxmlSettings = new WebXmlSettings(context); + + // 0.7.0 web.properties in the deployed war folder + File overrideFile = new File(context.getRealPath("/WEB-INF/web.properties")); + if (overrideFile.exists()) { + webxmlSettings.applyOverrides(overrideFile); + } + + // 0.8.0 gitblit.properties file located outside the deployed war + // folder lie, for example, on RedHat OpenShift. + overrideFile = getFileOrFolder("gitblit.properties"); + if (!overrideFile.getPath().equals("gitblit.properties")) { + webxmlSettings.applyOverrides(overrideFile); + } configureContext(webxmlSettings, true); } -- Gitblit v1.9.1