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 | 255 ++++++++++++++++++++++++++++++++++++++------------ 1 files changed, 193 insertions(+), 62 deletions(-) diff --git a/src/com/gitblit/GitBlit.java b/src/com/gitblit/GitBlit.java index f285daf..acb90d8 100644 --- a/src/com/gitblit/GitBlit.java +++ b/src/com/gitblit/GitBlit.java @@ -1,28 +1,29 @@ 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.List; 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.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 { @@ -30,9 +31,9 @@ private final Logger logger = LoggerFactory.getLogger(GitBlit.class); - private FileResolver repositoryResolver; + private FileResolver<Void> repositoryResolver; - private File repositories; + private File repositoriesFolder; private boolean exportAll; @@ -59,72 +60,65 @@ 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(repositories, exportAll, storedSettings.getBoolean(Keys.git.nestedRepositories, true)); + return JGitUtils.getRepositoryList(repositoriesFolder, exportAll, storedSettings.getBoolean(Keys.git.nestedRepositories, true)); } - public List<RepositoryModel> getRepositories(Request request) { - List<String> list = getRepositoryList(); - ServletWebRequest servletWebRequest = (ServletWebRequest) request; - HttpServletRequest req = servletWebRequest.getHttpServletRequest(); - - 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)); - } - return repositories; - } - - public Repository getRepository(HttpServletRequest req, String repositoryName) { + public Repository getRepository(String repositoryName) { Repository r = null; try { - r = repositoryResolver.open(req, repositoryName); + r = repositoryResolver.open(null, repositoryName); } catch (RepositoryNotFoundException e) { r = null; - logger.error("Failed to find repository " + repositoryName); - e.printStackTrace(); + logger.error("GitBlit.getRepository(String) failed to find repository " + repositoryName); } catch (ServiceNotEnabledException e) { r = null; e.printStackTrace(); @@ -132,22 +126,159 @@ return r; } - public void setupContext(IStoredSettings settings) { - logger.info("Setting up GitBlit context from " + settings.toString()); + public List<RepositoryModel> getRepositoryModels(UserModel user) { + List<String> list = getRepositoryList(); + List<RepositoryModel> repositories = new ArrayList<RepositoryModel>(); + for (String repo : list) { + 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(); + model.name = repositoryName; + model.hasCommits = JGitUtils.hasCommits(r); + model.lastChange = JGitUtils.getLastChange(r); + 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); + } + r.close(); + return model; + } + + 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)); + } + // 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 { + r = repositoryResolver.open(null, repository.name); + } catch (RepositoryNotFoundException e) { + logger.error("Repository not found", e); + } catch (ServiceNotEnabledException e) { + logger.error("Service not enabled", e); + } + } + + // update settings + 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); + try { + config.save(); + } catch (IOException e) { + logger.error("Failed to save repository config!", e); + } + 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("Using configuration from " + settings.toString()); this.storedSettings = settings; - repositories = new File(settings.getString(Keys.git.repositoriesFolder, "repos")); + repositoriesFolder = new File(settings.getString(Keys.git.repositoriesFolder, "repos")); exportAll = settings.getBoolean(Keys.git.exportAll, true); - repositoryResolver = new FileResolver(repositories, exportAll); + repositoryResolver = new FileResolver<Void>(repositoriesFolder, exportAll); } @Override public void contextInitialized(ServletContextEvent contextEvent) { - logger.info("GitBlit context initialization by servlet container..."); if (storedSettings == null) { WebXmlSettings webxmlSettings = new WebXmlSettings(contextEvent.getServletContext()); - setupContext(webxmlSettings); - } else { - logger.info("GitBlit context already setup by " + storedSettings.toString()); + configureContext(webxmlSettings); } } -- Gitblit v1.9.1