From 56c549e384b1a648c77bbd09a2cc77976e8a64de Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Tue, 24 May 2011 17:39:55 -0400 Subject: [PATCH] Documentation. --- src/com/gitblit/GitBlit.java | 170 ++++++++++++++++++++++++++++++++++++++++++-------------- 1 files changed, 128 insertions(+), 42 deletions(-) diff --git a/src/com/gitblit/GitBlit.java b/src/com/gitblit/GitBlit.java index c633f6e..acb90d8 100644 --- a/src/com/gitblit/GitBlit.java +++ b/src/com/gitblit/GitBlit.java @@ -4,24 +4,26 @@ import java.io.IOException; import java.text.MessageFormat; import java.util.ArrayList; +import java.util.Collections; import java.util.List; import javax.servlet.ServletContextEvent; import javax.servlet.ServletContextListener; -import javax.servlet.http.Cookie; -import org.apache.wicket.protocol.http.WebResponse; import org.eclipse.jgit.errors.RepositoryNotFoundException; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.lib.StoredConfig; import org.eclipse.jgit.transport.resolver.FileResolver; import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException; +import org.eclipse.jgit.util.FileUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.gitblit.Constants.AccessRestrictionType; import com.gitblit.utils.JGitUtils; -import com.gitblit.wicket.User; +import com.gitblit.utils.StringUtils; import com.gitblit.wicket.models.RepositoryModel; +import com.gitblit.wicket.models.UserModel; public class GitBlit implements ServletContextListener { @@ -58,43 +60,54 @@ return storedSettings.getBoolean(Keys.web.debugMode, false); } - public String getCloneUrl(String repositoryName) { - return storedSettings.getString(Keys.git.cloneUrl, "https://localhost/git/") + repositoryName; + public List<String> getOtherCloneUrls(String repositoryName) { + List<String> cloneUrls = new ArrayList<String>(); + for (String url : storedSettings.getStrings(Keys.git.otherUrls)) { + cloneUrls.add(MessageFormat.format(url, repositoryName)); + } + return cloneUrls; } public void setLoginService(ILoginService loginService) { this.loginService = loginService; } - public User authenticate(String username, char[] password) { + public UserModel authenticate(String username, char[] password) { if (loginService == null) { return null; } return loginService.authenticate(username, password); } - public User authenticate(Cookie[] cookies) { - if (loginService == 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()); - } - } - } - return null; + public List<String> getAllUsernames() { + List<String> names = new ArrayList<String>(loginService.getAllUsernames()); + Collections.sort(names); + return names; } - 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); + public boolean deleteUser(String username) { + return loginService.deleteUser(username); } - + + public UserModel getUserModel(String username) { + UserModel user = loginService.getUserModel(username); + return user; + } + + public List<String> getRepositoryUsers(RepositoryModel repository) { + return loginService.getUsernamesForRole(repository.name); + } + + public boolean setRepositoryUsers(RepositoryModel repository, List<String> repositoryUsers) { + return loginService.setUsernamesForRole(repository.name, repositoryUsers); + } + + public void editUserModel(String username, UserModel user, boolean isCreate) throws GitBlitException { + if (!loginService.updateUserModel(username, user)) { + throw new GitBlitException(isCreate ? "Failed to add user!" : "Failed to update user!"); + } + } + public List<String> getRepositoryList() { return JGitUtils.getRepositoryList(repositoriesFolder, exportAll, storedSettings.getBoolean(Keys.git.nestedRepositories, true)); } @@ -112,17 +125,31 @@ } return r; } - - public List<RepositoryModel> getRepositoryModels() { + + public List<RepositoryModel> getRepositoryModels(UserModel user) { List<String> list = getRepositoryList(); List<RepositoryModel> repositories = new ArrayList<RepositoryModel>(); for (String repo : list) { - RepositoryModel model = getRepositoryModel(repo); - repositories.add(model); + RepositoryModel model = getRepositoryModel(user, repo); + if (model != null) { + repositories.add(model); + } } return repositories; } - + + public RepositoryModel getRepositoryModel(UserModel user, String repositoryName) { + RepositoryModel model = getRepositoryModel(repositoryName); + if (model.accessRestriction.atLeast(AccessRestrictionType.VIEW)) { + if (user != null && user.canAccessRepository(model.name)) { + return model; + } + return null; + } else { + return model; + } + } + public RepositoryModel getRepositoryModel(String repositoryName) { Repository r = getRepository(repositoryName); RepositoryModel model = new RepositoryModel(); @@ -131,28 +158,56 @@ model.lastChange = JGitUtils.getLastChange(r); StoredConfig config = JGitUtils.readConfig(r); if (config != null) { - model.description = config.getString("gitblit", null, "description"); - model.owner = config.getString("gitblit", null, "owner"); - model.group = config.getString("gitblit", null, "group"); - model.useTickets = config.getBoolean("gitblit", "useTickets", false); - model.useDocs = config.getBoolean("gitblit", "useDocs", false); - model.useRestrictedAccess = config.getBoolean("gitblit", "restrictedAccess", false); - model.showRemoteBranches = config.getBoolean("gitblit", "showRemoteBranches", false); + 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); } r.close(); return model; } - public void editRepositoryModel(RepositoryModel repository, boolean isCreate) throws GitBlitException { + private String getConfig(StoredConfig config, String field, String defaultValue) { + String value = config.getString("gitblit", null, field); + if (StringUtils.isEmpty(value)) { + return defaultValue; + } + return value; + } + + private boolean getConfig(StoredConfig config, String field, boolean defaultValue) { + return config.getBoolean("gitblit", field, defaultValue); + } + + public void editRepositoryModel(String repositoryName, RepositoryModel repository, boolean isCreate) throws GitBlitException { Repository r = null; if (isCreate) { if (new File(repositoriesFolder, repository.name).exists()) { - throw new GitBlitException(MessageFormat.format("Can not create repository {0} because it already exists.", repository.name)); + throw new GitBlitException(MessageFormat.format("Can not create repository ''{0}'' because it already exists.", repository.name)); } - // create repository + // create repository logger.info("create repository " + repository.name); r = JGitUtils.createRepository(repositoriesFolder, repository.name, true); } 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 (!loginService.renameRole(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 { @@ -170,8 +225,9 @@ config.setString("gitblit", null, "owner", repository.owner); config.setBoolean("gitblit", null, "useTickets", repository.useTickets); config.setBoolean("gitblit", null, "useDocs", repository.useDocs); - config.setBoolean("gitblit", null, "restrictedAccess", repository.useRestrictedAccess); + config.setString("gitblit", null, "accessRestriction", repository.accessRestriction.name()); config.setBoolean("gitblit", null, "showRemoteBranches", repository.showRemoteBranches); + config.setBoolean("gitblit", null, "isFrozen", repository.isFrozen); try { config.save(); } catch (IOException e) { @@ -180,8 +236,38 @@ r.close(); } + public boolean deleteRepositoryModel(RepositoryModel model) { + return deleteRepository(model.name); + } + + public boolean deleteRepository(String repositoryName) { + try { + File folder = new File(repositoriesFolder, repositoryName); + if (folder.exists() && folder.isDirectory()) { + FileUtils.delete(folder, FileUtils.RECURSIVE); + if (loginService.deleteRole(repositoryName)) { + return true; + } + } + } catch (Throwable t) { + logger.error(MessageFormat.format("Failed to delete repository {0}", repositoryName), t); + } + return false; + } + + public boolean renameRepository(RepositoryModel model, String newName) { + File folder = new File(repositoriesFolder, model.name); + if (folder.exists() && folder.isDirectory()) { + File newFolder = new File(repositoriesFolder, newName); + if (folder.renameTo(newFolder)) { + return loginService.renameRole(model.name, newName); + } + } + return false; + } + public void configureContext(IStoredSettings settings) { - logger.info("Configure GitBlit from " + settings.toString()); + logger.info("Using configuration from " + settings.toString()); this.storedSettings = settings; repositoriesFolder = new File(settings.getString(Keys.git.repositoriesFolder, "repos")); exportAll = settings.getBoolean(Keys.git.exportAll, true); -- Gitblit v1.9.1