From aa1361d04cfe09f90e7d8bece90c00dd6e4185bb Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 03 Jul 2014 16:57:47 -0400
Subject: [PATCH] Replace Dagger with Guice 4.0 beta and update Guava to 16.0.1
---
src/main/java/com/gitblit/servlet/GitblitContext.java | 135 ++++++++++++++++++++++++++++++++-------------
1 files changed, 96 insertions(+), 39 deletions(-)
diff --git a/src/main/java/com/gitblit/servlet/GitblitContext.java b/src/main/java/com/gitblit/servlet/GitblitContext.java
index 3e95b4b..fb16d32 100644
--- a/src/main/java/com/gitblit/servlet/GitblitContext.java
+++ b/src/main/java/com/gitblit/servlet/GitblitContext.java
@@ -34,44 +34,43 @@
import javax.servlet.annotation.WebListener;
import com.gitblit.Constants;
-import com.gitblit.DaggerModule;
import com.gitblit.FileSettings;
import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
import com.gitblit.WebXmlSettings;
-import com.gitblit.dagger.DaggerContextListener;
-import com.gitblit.git.GitServlet;
+import com.gitblit.extensions.LifeCycleListener;
+import com.gitblit.guice.GuiceContext;
+import com.gitblit.guice.GuiceModule;
+import com.gitblit.manager.IAuthenticationManager;
import com.gitblit.manager.IFederationManager;
-import com.gitblit.manager.IGitblitManager;
+import com.gitblit.manager.IGitblit;
import com.gitblit.manager.IManager;
import com.gitblit.manager.INotificationManager;
+import com.gitblit.manager.IPluginManager;
import com.gitblit.manager.IProjectManager;
import com.gitblit.manager.IRepositoryManager;
import com.gitblit.manager.IRuntimeManager;
-import com.gitblit.manager.IServicesManager;
-import com.gitblit.manager.IAuthenticationManager;
import com.gitblit.manager.IUserManager;
+import com.gitblit.transport.ssh.IPublicKeyManager;
import com.gitblit.utils.ContainerUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.GitblitWicketFilter;
-
-import dagger.ObjectGraph;
+import com.google.inject.AbstractModule;
+import com.google.inject.Injector;
/**
* This class is the main entry point for the entire webapp. It is a singleton
* created manually by Gitblit GO or dynamically by the WAR/Express servlet
- * container. This class instantiates and starts all managers followed by
- * instantiating and registering all servlets and filters.
+ * container. This class instantiates and starts all managers.
*
- * Leveraging Servlet 3 and Dagger static dependency injection allows Gitblit to
- * be modular and completely code-driven rather then relying on the fragility of
- * a web.xml descriptor and the static & monolithic design previously used.
+ * Servlets and filters are injected which allows Gitblit to be completely
+ * code-driven.
*
* @author James Moger
*
*/
@WebListener
-public class GitblitContext extends DaggerContextListener {
+public class GitblitContext extends GuiceContext {
private static GitblitContext gitblit;
@@ -85,9 +84,7 @@
* Construct a Gitblit WAR/Express context.
*/
public GitblitContext() {
- this.goSettings = null;
- this.goBaseFolder = null;
- gitblit = this;
+ this(null, null);
}
/**
@@ -119,11 +116,11 @@
}
/**
- * Returns Gitblit's Dagger injection modules.
+ * Returns Gitblit's Guice injection modules.
*/
@Override
- protected Object [] getModules() {
- return new Object [] { new DaggerModule() };
+ protected AbstractModule [] getModules() {
+ return new AbstractModule [] { new GuiceModule() };
}
/**
@@ -131,10 +128,10 @@
*/
@Override
protected void beforeServletInjection(ServletContext context) {
- ObjectGraph injector = getInjector(context);
+ Injector injector = getInjector(context);
// create the runtime settings object
- IStoredSettings runtimeSettings = injector.get(IStoredSettings.class);
+ IStoredSettings runtimeSettings = injector.getInstance(IStoredSettings.class);
final File baseFolder;
if (goSettings != null) {
@@ -146,7 +143,11 @@
String contextRealPath = context.getRealPath("/");
File contextFolder = (contextRealPath != null) ? new File(contextRealPath) : null;
- if (!StringUtils.isEmpty(System.getenv("OPENSHIFT_DATA_DIR"))) {
+ // if the base folder dosen't match the default assume they don't want to use express,
+ // this allows for other containers to customise the basefolder per context.
+ String defaultBase = Constants.contextFolder$ + "/WEB-INF/data";
+ String base = lookupBaseFolderFromJndi();
+ if (!StringUtils.isEmpty(System.getenv("OPENSHIFT_DATA_DIR")) && defaultBase.equals(base)) {
// RedHat OpenShift
baseFolder = configureExpress(context, webxmlSettings, contextFolder, runtimeSettings);
} else {
@@ -160,31 +161,64 @@
// Manually configure IRuntimeManager
logManager(IRuntimeManager.class);
- IRuntimeManager runtime = injector.get(IRuntimeManager.class);
+ IRuntimeManager runtime = injector.getInstance(IRuntimeManager.class);
runtime.setBaseFolder(baseFolder);
runtime.getStatus().isGO = goSettings != null;
runtime.getStatus().servletContainer = context.getServerInfo();
runtime.start();
managers.add(runtime);
+ // create the plugin manager instance but do not start it
+ loadManager(injector, IPluginManager.class);
+
// start all other managers
startManager(injector, INotificationManager.class);
startManager(injector, IUserManager.class);
startManager(injector, IAuthenticationManager.class);
+ startManager(injector, IPublicKeyManager.class);
startManager(injector, IRepositoryManager.class);
startManager(injector, IProjectManager.class);
- startManager(injector, IGitblitManager.class);
startManager(injector, IFederationManager.class);
- startManager(injector, IServicesManager.class);
+ startManager(injector, IGitblit.class);
+
+ // start the plugin manager last so that plugins can depend on
+ // deterministic access to all other managers in their start() methods
+ startManager(injector, IPluginManager.class);
logger.info("");
logger.info("All managers started.");
logger.info("");
+
+ IPluginManager pluginManager = injector.getInstance(IPluginManager.class);
+ for (LifeCycleListener listener : pluginManager.getExtensions(LifeCycleListener.class)) {
+ try {
+ listener.onStartup();
+ } catch (Throwable t) {
+ logger.error(null, t);
+ }
+ }
}
- protected <X extends IManager> X startManager(ObjectGraph injector, Class<X> clazz) {
+ private String lookupBaseFolderFromJndi() {
+ try {
+ // try to lookup JNDI env-entry for the baseFolder
+ InitialContext ic = new InitialContext();
+ Context env = (Context) ic.lookup("java:comp/env");
+ return (String) env.lookup("baseFolder");
+ } catch (NamingException n) {
+ logger.error("Failed to get JNDI env-entry: " + n.getExplanation());
+ }
+ return null;
+ }
+
+ protected <X extends IManager> X loadManager(Injector injector, Class<X> clazz) {
+ X x = injector.getInstance(clazz);
+ return x;
+ }
+
+ protected <X extends IManager> X startManager(Injector injector, Class<X> clazz) {
+ X x = loadManager(injector, clazz);
logManager(clazz);
- X x = injector.get(clazz);
x.start();
managers.add(x);
return x;
@@ -202,7 +236,9 @@
@Override
protected void injectServlets(ServletContext context) {
// access restricted servlets
+ serve(context, Constants.R_PATH, GitServlet.class, GitFilter.class);
serve(context, Constants.GIT_PATH, GitServlet.class, GitFilter.class);
+ serve(context, Constants.RAW_PATH, RawServlet.class, RawFilter.class);
serve(context, Constants.PAGES, PagesServlet.class, PagesFilter.class);
serve(context, Constants.RPC_PATH, RpcServlet.class, RpcFilter.class);
serve(context, Constants.ZIP_PATH, DownloadZipServlet.class, DownloadZipFilter.class);
@@ -212,10 +248,12 @@
serve(context, Constants.FEDERATION_PATH, FederationServlet.class);
serve(context, Constants.SPARKLESHARE_INVITE_PATH, SparkleShareInviteServlet.class);
serve(context, Constants.BRANCH_GRAPH_PATH, BranchGraphServlet.class);
+ serve(context, Constants.PT_PATH, PtServlet.class);
file(context, "/robots.txt", RobotsTxtServlet.class);
file(context, "/logo.png", LogoServlet.class);
- // optional force basic authentication
+ // global filters
+ filter(context, "/*", ProxyFilter.class, null);
filter(context, "/*", EnforceAuthenticationFilter.class, null);
// Wicket
@@ -233,6 +271,16 @@
@Override
protected void destroyContext(ServletContext context) {
logger.info("Gitblit context destroyed by servlet container.");
+
+ IPluginManager pluginManager = getManager(IPluginManager.class);
+ for (LifeCycleListener listener : pluginManager.getExtensions(LifeCycleListener.class)) {
+ try {
+ listener.onShutdown();
+ } catch (Throwable t) {
+ logger.error(null, t);
+ }
+ }
+
for (IManager manager : managers) {
logger.debug("stopping {}", manager.getClass().getSimpleName());
manager.stop();
@@ -297,16 +345,9 @@
logger.error("");
}
- try {
- // try to lookup JNDI env-entry for the baseFolder
- InitialContext ic = new InitialContext();
- Context env = (Context) ic.lookup("java:comp/env");
- String val = (String) env.lookup("baseFolder");
- if (!StringUtils.isEmpty(val)) {
- path = val;
- }
- } catch (NamingException n) {
- logger.error("Failed to get JNDI env-entry: " + n.getExplanation());
+ String baseFromJndi = lookupBaseFolderFromJndi();
+ if (!StringUtils.isEmpty(baseFromJndi)) {
+ path = baseFromJndi;
}
File base = com.gitblit.utils.FileUtils.resolveParameter(Constants.contextFolder$, contextFolder, path);
@@ -367,6 +408,22 @@
}
}
+ // Copy the included gitignore files to the configured gitignore folder
+ String gitignorePath = webxmlSettings.getString(Keys.git.gitignoreFolder, "gitignore");
+ File localGitignores = com.gitblit.utils.FileUtils.resolveParameter(Constants.baseFolder$, base, gitignorePath);
+ if (!localGitignores.exists()) {
+ File warGitignores = new File(contextFolder, "/WEB-INF/data/gitignore");
+ if (!warGitignores.equals(localGitignores)) {
+ try {
+ com.gitblit.utils.FileUtils.copy(localGitignores, warGitignores.listFiles());
+ } catch (IOException e) {
+ logger.error(MessageFormat.format(
+ "Failed to copy included .gitignore files from {0} to {1}",
+ warGitignores, localGitignores));
+ }
+ }
+ }
+
// merge the WebXmlSettings into the runtime settings (for backwards-compatibilty)
runtimeSettings.merge(webxmlSettings);
--
Gitblit v1.9.1