From 729d41cfe8493e6b39ad9ab6f8a160dcef9a6637 Mon Sep 17 00:00:00 2001
From: Kohsuke Kawaguchi <kk@kohsuke.org>
Date: Sat, 16 Nov 2013 10:24:21 -0800
Subject: [PATCH] [FIXED JENKINS-20609]

Implemented the hook
---
 changelog.html                                |  3 ++
 core/src/main/java/hudson/WebAppMain.java     | 36 ++++++++-----------
 .../src/main/java/hudson/util/AWTProblem.java |  7 +++-
 .../main/java/hudson/util/BootFailure.java    | 36 +++++++++++++++++++
 .../main/java/hudson/util/ErrorObject.java    | 14 +++++++-
 .../java/hudson/util/HudsonFailedToLoad.java  | 13 ++++---
 .../util/IncompatibleAntVersionDetected.java  | 11 +++++-
 .../IncompatibleServletVersionDetected.java   |  2 +-
 .../hudson/util/IncompatibleVMDetected.java   |  3 +-
 .../util/InsufficientPermissionDetected.java  | 11 +++---
 .../java/hudson/util/JenkinsReloadFailed.java |  7 +++-
 core/src/main/java/hudson/util/NoHomeDir.java |  2 +-
 core/src/main/java/hudson/util/NoTempDir.java | 10 +++---
 core/src/main/java/jenkins/model/Jenkins.java |  2 +-
 .../util/HudsonFailedToLoad/index.jelly       |  2 +-
 .../index.jelly                               |  2 +-
 .../hudson/util/JNADoublyLoaded/index.jelly   |  2 +-
 .../hudson/util/NoTempDir/index.jelly         |  2 +-
 18 files changed, 112 insertions(+), 53 deletions(-)
 create mode 100644 core/src/main/java/hudson/util/BootFailure.java

diff --git a/changelog.html b/changelog.html
index 7b606a1d5c..09e4e830b1 100644
--- a/changelog.html
+++ b/changelog.html
@@ -55,6 +55,9 @@ Upcoming changes</a>
 <!-- Record your changes in the trunk here. -->
 <div id="trunk" style="display:none"><!--=TRUNK-BEGIN=-->
 <ul class=image>
+  <li class=rfe>
+    Introduced the boot failure hook script that gets executed when Jenkins fails to start.
+    (<a href="https://issues.jenkins-ci.org/browse/JENKINS-20609">issue 20609</a>)
   <li class=bug>
     Fixed "java.lang.NoClassDefFoundError: JarURLConnection" on OpenJDK
     (<a href="https://issues.jenkins-ci.org/browse/JENKINS-20163">issue 20163</a>)
diff --git a/core/src/main/java/hudson/WebAppMain.java b/core/src/main/java/hudson/WebAppMain.java
index f6cf979bf8..12b407a8ff 100644
--- a/core/src/main/java/hudson/WebAppMain.java
+++ b/core/src/main/java/hudson/WebAppMain.java
@@ -26,6 +26,7 @@ package hudson;
 import com.thoughtworks.xstream.converters.reflection.PureJavaReflectionProvider;
 import com.thoughtworks.xstream.core.JVM;
 import hudson.model.Hudson;
+import hudson.util.BootFailure;
 import jenkins.model.Jenkins;
 import hudson.util.HudsonIsLoading;
 import hudson.util.IncompatibleServletVersionDetected;
@@ -82,8 +83,8 @@ public final class WebAppMain implements ServletContextListener {
      * Creates the sole instance of {@link jenkins.model.Jenkins} and register it to the {@link ServletContext}.
      */
     public void contextInitialized(ServletContextEvent event) {
+        final ServletContext context = event.getServletContext();
         try {
-            final ServletContext context = event.getServletContext();
 
             // use the current request to determine the language
             LocaleProvider.setProvider(new LocaleProvider() {
@@ -98,8 +99,7 @@ public final class WebAppMain implements ServletContextListener {
                 jvm = new JVM();
                 new URLClassLoader(new URL[0],getClass().getClassLoader());
             } catch(SecurityException e) {
-                context.setAttribute(APP,new InsufficientPermissionDetected(e));
-                return;
+                throw new InsufficientPermissionDetected(e);
             }
 
             try {// remove Sun PKCS11 provider if present. See http://wiki.jenkins-ci.org/display/JENKINS/Solaris+Issue+6276483
@@ -116,16 +116,12 @@ public final class WebAppMain implements ServletContextListener {
             System.out.println("Jenkins home directory: "+home+" found at: "+describedHomeDir.description);
 
             // check that home exists (as mkdirs could have failed silently), otherwise throw a meaningful error
-            if (! home.exists()) {
-                context.setAttribute(APP,new NoHomeDir(home));
-                return;
-            }
+            if (!home.exists())
+                throw new NoHomeDir(home);
 
             // make sure that we are using XStream in the "enhanced" (JVM-specific) mode
             if(jvm.bestReflectionProvider().getClass()==PureJavaReflectionProvider.class) {
-                // nope
-                context.setAttribute(APP,new IncompatibleVMDetected());
-                return;
+                throw new IncompatibleVMDetected(); // nope
             }
 
 //  JNA is no longer a hard requirement. It's just nice to have. See HUDSON-4820 for more context.
@@ -163,22 +159,19 @@ public final class WebAppMain implements ServletContextListener {
             try {
                 ServletResponse.class.getMethod("setCharacterEncoding",String.class);
             } catch (NoSuchMethodException e) {
-                context.setAttribute(APP,new IncompatibleServletVersionDetected(ServletResponse.class));
-                return;
+                throw new IncompatibleServletVersionDetected(ServletResponse.class);
             }
 
             // make sure that we see Ant 1.7
             try {
                 FileSet.class.getMethod("getDirectoryScanner");
             } catch (NoSuchMethodException e) {
-                context.setAttribute(APP,new IncompatibleAntVersionDetected(FileSet.class));
-                return;
+                throw new IncompatibleAntVersionDetected(FileSet.class);
             }
 
             // make sure AWT is functioning, or else JFreeChart won't even load.
             if(ChartUtil.awtProblemCause!=null) {
-                context.setAttribute(APP,new AWTProblem(ChartUtil.awtProblemCause));
-                return;
+                throw new AWTProblem(ChartUtil.awtProblemCause);
             }
 
             // some containers (in particular Tomcat) doesn't abort a launch
@@ -188,8 +181,7 @@ public final class WebAppMain implements ServletContextListener {
                 File f = File.createTempFile("test", "test");
                 f.delete();
             } catch (IOException e) {
-                context.setAttribute(APP,new NoTempDir(e));
-                return;
+                throw new NoTempDir(e);
             }
 
             // Tomcat breaks XSLT with JDK 5.0 and onward. Check if that's the case, and if so,
@@ -225,12 +217,10 @@ public final class WebAppMain implements ServletContextListener {
                         LOGGER.info("Jenkins is fully up and running");
                         success = true;
                     } catch (Error e) {
-                        LOGGER.log(Level.SEVERE, "Failed to initialize Jenkins",e);
-                        context.setAttribute(APP,new HudsonFailedToLoad(e));
+                        new HudsonFailedToLoad(e).publish(context);
                         throw e;
                     } catch (Exception e) {
-                        LOGGER.log(Level.SEVERE, "Failed to initialize Jenkins",e);
-                        context.setAttribute(APP,new HudsonFailedToLoad(e));
+                        new HudsonFailedToLoad(e).publish(context);
                     } finally {
                         Jenkins instance = Jenkins.getInstance();
                         if(!success && instance!=null)
@@ -239,6 +229,8 @@ public final class WebAppMain implements ServletContextListener {
                 }
             };
             initThread.start();
+        } catch (BootFailure e) {
+            e.publish(context);
         } catch (Error e) {
             LOGGER.log(Level.SEVERE, "Failed to initialize Jenkins",e);
             throw e;
diff --git a/core/src/main/java/hudson/util/AWTProblem.java b/core/src/main/java/hudson/util/AWTProblem.java
index c880efa9f7..86f2340b2e 100644
--- a/core/src/main/java/hudson/util/AWTProblem.java
+++ b/core/src/main/java/hudson/util/AWTProblem.java
@@ -23,13 +23,18 @@
  */
 package hudson.util;
 
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+
 /**
  * @author Kohsuke Kawaguchi
  */
-public class AWTProblem extends ErrorObject {
+public class AWTProblem extends BootFailure {
+    @Restricted(NoExternalUse.class) @Deprecated
     public final Throwable cause;
 
     public AWTProblem(Throwable cause) {
+        super(cause);
         this.cause = cause;
     }
 }
diff --git a/core/src/main/java/hudson/util/BootFailure.java b/core/src/main/java/hudson/util/BootFailure.java
new file mode 100644
index 0000000000..78f3ba41a3
--- /dev/null
+++ b/core/src/main/java/hudson/util/BootFailure.java
@@ -0,0 +1,36 @@
+package hudson.util;
+
+import jenkins.util.groovy.GroovyHookScript;
+import org.kohsuke.stapler.WebApp;
+
+import javax.servlet.ServletContext;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Indicates a fatal boot problem, among {@link ErrorObject}
+ *
+ * @author Kohsuke Kawaguchi
+ */
+public abstract class BootFailure extends ErrorObject {
+    protected BootFailure() {
+    }
+
+    protected BootFailure(Throwable cause) {
+        super(cause);
+    }
+
+    /**
+     * Exposes this failure to UI and invoke the hook.
+     */
+    public void publish(ServletContext context) {
+        LOGGER.log(Level.SEVERE, "Failed to initialize Jenkins",this);
+
+        WebApp.get(context).setApp(this);
+        new GroovyHookScript("boot-failure")
+                .bind("exception",this)
+                .run();
+    }
+
+    private static final Logger LOGGER = Logger.getLogger(BootFailure.class.getName());
+}
diff --git a/core/src/main/java/hudson/util/ErrorObject.java b/core/src/main/java/hudson/util/ErrorObject.java
index 69107c8310..def3df9adb 100644
--- a/core/src/main/java/hudson/util/ErrorObject.java
+++ b/core/src/main/java/hudson/util/ErrorObject.java
@@ -23,6 +23,7 @@
  */
 package hudson.util;
 
+import hudson.Functions;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
 
@@ -38,7 +39,18 @@ import java.io.IOException;
  *
  * @author Kohsuke Kawaguchi
  */
-public abstract class ErrorObject {
+public abstract class ErrorObject extends Exception {
+    protected ErrorObject() {
+    }
+
+    protected ErrorObject(Throwable cause) {
+        super(cause);
+    }
+
+    public String getStackTraceString() {
+        return Functions.printThrowable(this);
+    }
+
     public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, InterruptedException {
         rsp.setStatus(SC_SERVICE_UNAVAILABLE);
         req.getView(this,"index.jelly").forward(req,rsp);
diff --git a/core/src/main/java/hudson/util/HudsonFailedToLoad.java b/core/src/main/java/hudson/util/HudsonFailedToLoad.java
index b682d451b1..72ad0a4f9c 100644
--- a/core/src/main/java/hudson/util/HudsonFailedToLoad.java
+++ b/core/src/main/java/hudson/util/HudsonFailedToLoad.java
@@ -23,24 +23,23 @@
  */
 package hudson.util;
 
-import hudson.Functions;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
 
 /**
- * Model object used to display the generic error when Hudson start up fails fatally during initialization.
+ * Model object used to display the generic error when Jenkins start up fails fatally during initialization.
  *
  * <p>
  * <tt>index.jelly</tt> would display a nice friendly error page.
  *
  * @author Kohsuke Kawaguchi
  */
-public class HudsonFailedToLoad extends ErrorObject {
+public class HudsonFailedToLoad extends BootFailure {
+    @Restricted(NoExternalUse.class) @Deprecated
     public final Throwable exception;
 
     public HudsonFailedToLoad(Throwable exception) {
+        super(exception);
         this.exception = exception;
     }
-
-    public String getStackTrace() {
-        return Functions.printThrowable(exception);
-    }
 }
diff --git a/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java b/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
index 2f654e475a..1a89b82e6f 100644
--- a/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
@@ -37,13 +37,22 @@ import java.net.URL;
  *
  * @author Kohsuke Kawaguchi
  */
-public class IncompatibleAntVersionDetected extends ErrorObject {
+public class IncompatibleAntVersionDetected extends BootFailure {
     private final Class antClass;
 
     public IncompatibleAntVersionDetected(Class antClass) {
         this.antClass = antClass;
     }
 
+    @Override
+    public String getMessage() {
+        try {
+            return "Incompatible Ant loaded from "+getWhereAntIsLoaded();
+        } catch (IOException e) {
+            return "Incompatible Ant loaded";
+        }
+    }
+
     public URL getWhereAntIsLoaded() throws IOException {
         return Which.jarURL(antClass);
     }
diff --git a/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java b/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
index b90c32789f..92d17d185d 100644
--- a/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
@@ -37,7 +37,7 @@ import java.net.URL;
  *
  * @author Kohsuke Kawaguchi
  */
-public class IncompatibleServletVersionDetected extends ErrorObject {
+public class IncompatibleServletVersionDetected extends BootFailure {
     private final Class servletClass;
 
     public IncompatibleServletVersionDetected(Class servletClass) {
diff --git a/core/src/main/java/hudson/util/IncompatibleVMDetected.java b/core/src/main/java/hudson/util/IncompatibleVMDetected.java
index 3abc3553d9..ae690c162b 100644
--- a/core/src/main/java/hudson/util/IncompatibleVMDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleVMDetected.java
@@ -34,8 +34,7 @@ import java.util.Map;
  *
  * @author Kohsuke Kawaguchi
  */
-public class IncompatibleVMDetected extends ErrorObject {
-
+public class IncompatibleVMDetected extends BootFailure {
     public Map getSystemProperties() {
         return System.getProperties();
     }
diff --git a/core/src/main/java/hudson/util/InsufficientPermissionDetected.java b/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
index 0e22a94b4a..739e930bb9 100644
--- a/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
+++ b/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
@@ -23,7 +23,8 @@
  */
 package hudson.util;
 
-import hudson.Functions;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
 
 /**
  * Model object used to display the error top page if
@@ -34,14 +35,12 @@ import hudson.Functions;
  *
  * @author Kohsuke Kawaguchi
  */
-public class InsufficientPermissionDetected extends ErrorObject {
+public class InsufficientPermissionDetected extends BootFailure {
+    @Restricted(NoExternalUse.class) @Deprecated
     public final SecurityException exception;
 
     public InsufficientPermissionDetected(SecurityException e) {
+        super(e);
         this.exception = e;
     }
-
-    public String getExceptionTrace() {
-        return Functions.printThrowable(exception);
-    }
 }
diff --git a/core/src/main/java/hudson/util/JenkinsReloadFailed.java b/core/src/main/java/hudson/util/JenkinsReloadFailed.java
index a2607bb642..7022844bce 100644
--- a/core/src/main/java/hudson/util/JenkinsReloadFailed.java
+++ b/core/src/main/java/hudson/util/JenkinsReloadFailed.java
@@ -1,14 +1,19 @@
 package hudson.util;
 
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+
 /**
  * Indicates that Jenkins is interrupted during reload.
  *
  * @author Kohsuke Kawaguchi
  */
-public class JenkinsReloadFailed extends ErrorObject {
+public class JenkinsReloadFailed extends BootFailure {
+    @Restricted(NoExternalUse.class) @Deprecated
     public final Throwable cause;
 
     public JenkinsReloadFailed(Throwable cause) {
+        super(cause);
         this.cause = cause;
     }
 }
diff --git a/core/src/main/java/hudson/util/NoHomeDir.java b/core/src/main/java/hudson/util/NoHomeDir.java
index 315d4ad341..cae6089554 100644
--- a/core/src/main/java/hudson/util/NoHomeDir.java
+++ b/core/src/main/java/hudson/util/NoHomeDir.java
@@ -34,7 +34,7 @@ import java.io.File;
  *
  * @author Kohsuke Kawaguchi
  */
-public class NoHomeDir extends ErrorObject {
+public class NoHomeDir extends BootFailure {
     public final File home;
 
     public NoHomeDir(File home) {
diff --git a/core/src/main/java/hudson/util/NoTempDir.java b/core/src/main/java/hudson/util/NoTempDir.java
index 99fdfe3a2d..b45aff8d4f 100644
--- a/core/src/main/java/hudson/util/NoTempDir.java
+++ b/core/src/main/java/hudson/util/NoTempDir.java
@@ -24,6 +24,8 @@
 package hudson.util;
 
 import hudson.Functions;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
 
 import java.io.IOException;
 
@@ -36,17 +38,15 @@ import java.io.IOException;
  *
  * @author Kohsuke Kawaguchi
  */
-public class NoTempDir extends ErrorObject {
+public class NoTempDir extends BootFailure {
+    @Restricted(NoExternalUse.class) @Deprecated
     public final IOException exception;
 
     public NoTempDir(IOException exception) {
+        super(exception);
         this.exception = exception;
     }
 
-    public String getStackTrace() {
-        return Functions.printThrowable(exception);
-    }
-
     public String getTempDir() {
         return System.getProperty("java.io.tmpdir");
     }
diff --git a/core/src/main/java/jenkins/model/Jenkins.java b/core/src/main/java/jenkins/model/Jenkins.java
index eef75a402b..aa1ebab66a 100755
--- a/core/src/main/java/jenkins/model/Jenkins.java
+++ b/core/src/main/java/jenkins/model/Jenkins.java
@@ -3086,7 +3086,7 @@ public class Jenkins extends AbstractCIBase implements ModifiableTopLevelItemGro
                     reload();
                 } catch (Exception e) {
                     LOGGER.log(SEVERE,"Failed to reload Jenkins config",e);
-                    WebApp.get(servletContext).setApp(new JenkinsReloadFailed(e));
+                    new JenkinsReloadFailed(e).publish(servletContext);
                 }
             }
         }.start();
diff --git a/core/src/main/resources/hudson/util/HudsonFailedToLoad/index.jelly b/core/src/main/resources/hudson/util/HudsonFailedToLoad/index.jelly
index 2e47bc5e95..b9875ec52f 100644
--- a/core/src/main/resources/hudson/util/HudsonFailedToLoad/index.jelly
+++ b/core/src/main/resources/hudson/util/HudsonFailedToLoad/index.jelly
@@ -29,7 +29,7 @@ THE SOFTWARE.
     <l:side-panel />
     <l:main-panel>
       <h1><img src="${imagesURL}/48x48/error.png" alt="[!]" height="48" width="48"/><st:nbsp/>${%Error}</h1>
-      <pre>${it.stackTrace}</pre>
+      <pre>${it.stackTraceString}</pre>
     </l:main-panel>
   </l:layout>
 </j:jelly>
diff --git a/core/src/main/resources/hudson/util/InsufficientPermissionDetected/index.jelly b/core/src/main/resources/hudson/util/InsufficientPermissionDetected/index.jelly
index 3f1c7ab46a..4b7031456e 100644
--- a/core/src/main/resources/hudson/util/InsufficientPermissionDetected/index.jelly
+++ b/core/src/main/resources/hudson/util/InsufficientPermissionDetected/index.jelly
@@ -35,7 +35,7 @@ THE SOFTWARE.
       <p>
          ${%errorMessage.2}
       </p>
-      <pre>${it.exceptionTrace}</pre>
+      <pre>${it.stackTraceString}</pre>
     </l:main-panel>
   </l:layout>
 </j:jelly>
diff --git a/core/src/main/resources/hudson/util/JNADoublyLoaded/index.jelly b/core/src/main/resources/hudson/util/JNADoublyLoaded/index.jelly
index 5955612bd6..b87254c68b 100644
--- a/core/src/main/resources/hudson/util/JNADoublyLoaded/index.jelly
+++ b/core/src/main/resources/hudson/util/JNADoublyLoaded/index.jelly
@@ -30,7 +30,7 @@ THE SOFTWARE.
     <l:main-panel>
       <h1><img src="${imagesURL}/48x48/error.png" alt="[!]" height="48" width="48"/><st:nbsp/>${%Failed to load JNA}</h1>
       <p>${%blurb}</p>
-      <pre>${it.stackTrace}</pre>
+      <pre>${it.stackTraceString}</pre>
     </l:main-panel>
   </l:layout>
 </j:jelly>
diff --git a/core/src/main/resources/hudson/util/NoTempDir/index.jelly b/core/src/main/resources/hudson/util/NoTempDir/index.jelly
index b156046fab..6729a4e741 100644
--- a/core/src/main/resources/hudson/util/NoTempDir/index.jelly
+++ b/core/src/main/resources/hudson/util/NoTempDir/index.jelly
@@ -30,7 +30,7 @@ THE SOFTWARE.
     <l:main-panel>
       <h1><img src="${imagesURL}/48x48/error.png" alt="[!]" height="48" width="48"/><st:nbsp/>${%Error}</h1>
       <p>${%description(it.tempDir)}</p>
-      <pre>${it.stackTrace}</pre>
+      <pre>${it.stackTraceString}</pre>
     </l:main-panel>
   </l:layout>
 </j:jelly>
-- 
GitLab