From f08aab5c5e632431635e73b47b6096dc47243755 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Tue, 13 Dec 2011 08:37:02 -0500
Subject: [PATCH] Teams JSON-RPC support
---
src/com/gitblit/GitBlit.java | 217 +++++++++++++++++++++++++++++++++++++++++++++++++----
1 files changed, 199 insertions(+), 18 deletions(-)
diff --git a/src/com/gitblit/GitBlit.java b/src/com/gitblit/GitBlit.java
index ffef94a..13dc3fa 100644
--- a/src/com/gitblit/GitBlit.java
+++ b/src/com/gitblit/GitBlit.java
@@ -25,7 +25,6 @@
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
@@ -66,17 +65,18 @@
import com.gitblit.models.FederationProposal;
import com.gitblit.models.FederationSet;
import com.gitblit.models.Metric;
-import com.gitblit.models.ObjectCache;
import com.gitblit.models.RepositoryModel;
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;
import com.gitblit.utils.JGitUtils;
import com.gitblit.utils.JsonUtils;
import com.gitblit.utils.MetricUtils;
+import com.gitblit.utils.ObjectCache;
import com.gitblit.utils.StringUtils;
/**
@@ -248,14 +248,61 @@
}
/**
+ * 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");
+ }
+
+ /**
* Updates the list of server settings.
*
* @param settings
* @return true if the update succeeded
*/
- public boolean updateSettings(Collection<SettingModel> settings) {
- // TODO update the settings
- return false;
+ public boolean updateSettings(Map<String, String> updatedSettings) {
+ return settings.saveSettings(updatedSettings);
}
public ServerStatus getStatus() {
@@ -465,6 +512,83 @@
}
/**
+ * 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);
+ }
+
+ /**
* Clears all the cached data for the specified repository.
*
* @param repositoryName
@@ -557,7 +681,7 @@
return null;
}
if (model.accessRestriction.atLeast(AccessRestrictionType.VIEW)) {
- if (user != null && user.canAccessRepository(model.name)) {
+ if (user != null && user.canAccessRepository(model)) {
return model;
}
return null;
@@ -1069,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);
@@ -1122,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
@@ -1155,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
@@ -1278,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();
}
@@ -1309,7 +1433,12 @@
*/
public ServerSettings getSettingsModel() {
// ensure that the current values are updated in the setting models
- settingsModel.updateCurrentValues(settings);
+ for (String key : settings.getAllKeys(null)) {
+ SettingModel setting = settingsModel.get(key);
+ if (setting != null) {
+ setting.currentValue = settings.getString(key, "");
+ }
+ }
return settingsModel;
}
@@ -1326,7 +1455,7 @@
// Read bundled Gitblit properties to extract setting descriptions.
// This copy is pristine and only used for populating the setting
// models map.
- InputStream is = servletContext.getResourceAsStream("/WEB-INF/gitblit.properties");
+ InputStream is = servletContext.getResourceAsStream("/WEB-INF/reference.properties");
BufferedReader propertiesReader = new BufferedReader(new InputStreamReader(is));
StringBuilder description = new StringBuilder();
SettingModel setting = new SettingModel();
@@ -1385,13 +1514,14 @@
*
* @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();
+ serverStatus = new ServerStatus(isGO());
String realm = settings.getString(Keys.realm.userService, "users.properties");
IUserService loginService = null;
try {
@@ -1403,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);
@@ -1438,9 +1603,25 @@
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);
}
+
+ serverStatus.servletContainer = servletContext.getServerInfo();
}
/**
--
Gitblit v1.9.1