From 18d398e3ab5227fe10fe3f322798a51ce0cd10ca Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 23 Feb 2012 17:44:53 -0500
Subject: [PATCH] Documentation
---
src/com/gitblit/GitBlit.java | 130 +++++++++++++++++++++++++++++++++++--------
1 files changed, 106 insertions(+), 24 deletions(-)
diff --git a/src/com/gitblit/GitBlit.java b/src/com/gitblit/GitBlit.java
index 89dcbf1..7fb325c 100644
--- a/src/com/gitblit/GitBlit.java
+++ b/src/com/gitblit/GitBlit.java
@@ -23,16 +23,19 @@
import java.io.InputStreamReader;
import java.lang.reflect.Field;
import java.text.MessageFormat;
+import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
+import java.util.Date;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
+import java.util.TimeZone;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.Executors;
@@ -75,6 +78,7 @@
import com.gitblit.models.SettingModel;
import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;
+import com.gitblit.utils.ArrayUtils;
import com.gitblit.utils.ByteFormat;
import com.gitblit.utils.FederationUtils;
import com.gitblit.utils.JGitUtils;
@@ -102,7 +106,7 @@
public class GitBlit implements ServletContextListener {
private static GitBlit gitblit;
-
+
private final Logger logger = LoggerFactory.getLogger(GitBlit.class);
private final ScheduledExecutorService scheduledExecutor = Executors.newScheduledThreadPool(5);
@@ -122,8 +126,6 @@
private File repositoriesFolder;
- private boolean exportAll = true;
-
private IUserService userService;
private IStoredSettings settings;
@@ -133,6 +135,8 @@
private ServerStatus serverStatus;
private MailExecutor mailExecutor;
+
+ private TimeZone timezone;
public GitBlit() {
if (gitblit == null) {
@@ -160,6 +164,23 @@
*/
public static boolean isGO() {
return self().settings instanceof FileSettings;
+ }
+
+ /**
+ * Returns the preferred timezone for the Gitblit instance.
+ *
+ * @return a timezone
+ */
+ public static TimeZone getTimezone() {
+ if (self().timezone == null) {
+ String tzid = getString("web.timezone", null);
+ if (StringUtils.isEmpty(tzid)) {
+ self().timezone = TimeZone.getDefault();
+ return self().timezone;
+ }
+ self().timezone = TimeZone.getTimeZone(tzid);
+ }
+ return self().timezone;
}
/**
@@ -451,7 +472,7 @@
List<String> names = new ArrayList<String>(userService.getAllUsernames());
return names;
}
-
+
/**
* Returns the list of all users available to the login service.
*
@@ -545,7 +566,7 @@
List<String> teams = new ArrayList<String>(userService.getAllTeamNames());
return teams;
}
-
+
/**
* Returns the list of available teams that a user or repository may be
* assigned to.
@@ -641,7 +662,8 @@
* @return list of all repositories
*/
public List<String> getRepositoryList() {
- return JGitUtils.getRepositoryList(repositoriesFolder, exportAll,
+ return JGitUtils.getRepositoryList(repositoriesFolder,
+ settings.getBoolean(Keys.git.onlyAccessBareRepositories, false),
settings.getBoolean(Keys.git.searchRepositoriesSubfolders, true));
}
@@ -652,21 +674,38 @@
* @return repository or null
*/
public Repository getRepository(String repositoryName) {
+ return getRepository(repositoryName, true);
+ }
+
+ /**
+ * Returns the JGit repository for the specified name.
+ *
+ * @param repositoryName
+ * @param logError
+ * @return repository or null
+ */
+ public Repository getRepository(String repositoryName, boolean logError) {
Repository r = null;
try {
r = repositoryResolver.open(null, repositoryName);
} catch (RepositoryNotFoundException e) {
r = null;
- logger.error("GitBlit.getRepository(String) failed to find "
- + new File(repositoriesFolder, repositoryName).getAbsolutePath());
+ if (logError) {
+ logger.error("GitBlit.getRepository(String) failed to find "
+ + new File(repositoriesFolder, repositoryName).getAbsolutePath());
+ }
} catch (ServiceNotAuthorizedException e) {
r = null;
- logger.error("GitBlit.getRepository(String) failed to find "
- + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);
+ if (logError) {
+ logger.error("GitBlit.getRepository(String) failed to find "
+ + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);
+ }
} catch (ServiceNotEnabledException e) {
r = null;
- logger.error("GitBlit.getRepository(String) failed to find "
- + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);
+ if (logError) {
+ logger.error("GitBlit.getRepository(String) failed to find "
+ + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);
+ }
}
return r;
}
@@ -742,6 +781,7 @@
model.name = repositoryName;
model.hasCommits = JGitUtils.hasCommits(r);
model.lastChange = JGitUtils.getLastChange(r, null);
+ model.isBare = r.isBare();
StoredConfig config = JGitUtils.readConfig(r);
if (config != null) {
model.description = getConfig(config, "description", "");
@@ -768,6 +808,8 @@
model.mailingLists = new ArrayList<String>(Arrays.asList(config.getStringList(
"gitblit", null, "mailingList")));
}
+ model.HEAD = JGitUtils.getHEADRef(r);
+ model.availableRefs = JGitUtils.getAvailableHeadTargets(r);
r.close();
return model;
}
@@ -963,6 +1005,18 @@
// update settings
if (r != null) {
updateConfiguration(r, repository);
+ // only update symbolic head if it changes
+ String currentRef = JGitUtils.getHEADRef(r);
+ if (!StringUtils.isEmpty(repository.HEAD) && !repository.HEAD.equals(currentRef)) {
+ logger.info(MessageFormat.format("Relinking {0} HEAD from {1} to {2}",
+ repository.name, currentRef, repository.HEAD));
+ if (JGitUtils.setHEADtoRef(r, repository.HEAD)) {
+ // clear the cache
+ clearRepositoryCache(repository.name);
+ }
+ }
+
+ // close the repository object
r.close();
}
}
@@ -991,14 +1045,14 @@
config.setString("gitblit", null, "federationStrategy",
repository.federationStrategy.name());
config.setBoolean("gitblit", null, "isFederated", repository.isFederated);
- if (repository.preReceiveScripts != null) {
+ if (!ArrayUtils.isEmpty(repository.preReceiveScripts)) {
config.setStringList("gitblit", null, "preReceiveScript", repository.preReceiveScripts);
}
- if (repository.postReceiveScripts != null) {
+ if (!ArrayUtils.isEmpty(repository.postReceiveScripts)) {
config.setStringList("gitblit", null, "postReceiveScript",
repository.postReceiveScripts);
}
- if (repository.mailingLists != null) {
+ if (!ArrayUtils.isEmpty(repository.mailingLists)) {
config.setStringList("gitblit", null, "mailingList", repository.mailingLists);
}
try {
@@ -1734,16 +1788,18 @@
this.settings = settings;
repositoriesFolder = getRepositoriesFolder();
logger.info("Git repositories folder " + repositoriesFolder.getAbsolutePath());
- repositoryResolver = new FileResolver<Void>(repositoriesFolder, exportAll);
+ repositoryResolver = new FileResolver<Void>(repositoriesFolder, true);
+
+ logTimezone("JVM", TimeZone.getDefault());
+ logTimezone(Constants.NAME, getTimezone());
+
serverStatus = new ServerStatus(isGO());
String realm = settings.getString(Keys.realm.userService, "users.properties");
IUserService loginService = null;
try {
// check to see if this "file" is a login service class
Class<?> realmClass = Class.forName(realm);
- if (IUserService.class.isAssignableFrom(realmClass)) {
- loginService = (IUserService) realmClass.newInstance();
- }
+ loginService = (IUserService) realmClass.newInstance();
} catch (Throwable t) {
loginService = new GitblitUserService();
}
@@ -1756,7 +1812,14 @@
}
if (startFederation) {
configureFederation();
- }
+ }
+ }
+
+ private void logTimezone(String type, TimeZone zone) {
+ SimpleDateFormat df = new SimpleDateFormat("z Z");
+ df.setTimeZone(zone);
+ String offset = df.format(new Date());
+ logger.info(type + " timezone is " + zone.getID() + " (" + offset + ")");
}
/**
@@ -1775,18 +1838,37 @@
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);
+ String webProps = context.getRealPath("/WEB-INF/web.properties");
+ if (!StringUtils.isEmpty(webProps)) {
+ File overrideFile = new File(webProps);
+ 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");
+ File overrideFile = getFileOrFolder("gitblit.properties");
if (!overrideFile.getPath().equals("gitblit.properties")) {
webxmlSettings.applyOverrides(overrideFile);
}
configureContext(webxmlSettings, true);
+
+ // Copy the included scripts to the configured groovy folder
+ File localScripts = getFileOrFolder(Keys.groovy.scriptsFolder, "groovy");
+ if (!localScripts.exists()) {
+ File includedScripts = new File(context.getRealPath("/WEB-INF/groovy"));
+ if (!includedScripts.equals(localScripts)) {
+ try {
+ com.gitblit.utils.FileUtils.copy(localScripts, includedScripts.listFiles());
+ } catch (IOException e) {
+ logger.error(MessageFormat.format(
+ "Failed to copy included Groovy scripts from {0} to {1}",
+ includedScripts, localScripts));
+ }
+ }
+ }
}
serverStatus.servletContainer = servletContext.getServerInfo();
--
Gitblit v1.9.1