[JENKINS-41516] Add script console listener

core/src/main/java/hudson/cli/GroovyCommand.java

@@ -27,12 +27,14 @@
 import groovy.lang.Binding;
 import groovy.lang.GroovyShell;
 import hudson.Extension;
+import hudson.model.User;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
 import java.util.ArrayList;
 import java.util.List;
 import jenkins.model.Jenkins;
+import jenkins.model.ScriptListener;
 import org.apache.commons.io.IOUtils;
 import org.kohsuke.args4j.Argument;
 import org.kohsuke.args4j.CmdLineException;
@@ -70,7 +72,9 @@ protected int run() throws Exception {
         binding.setProperty("stderr", stderr);
 
         GroovyShell groovy = new GroovyShell(Jenkins.get().getPluginManager().uberClassLoader, binding);
-        groovy.run(loadScript(), "RemoteClass", remaining.toArray(new String[0]));
+        String script = loadScript();
+        ScriptListener.fireScriptEvent(script, "CLI", User.current());
+        groovy.run(script, "RemoteClass", remaining.toArray(new String[0]));
         return 0;
     }
 

core/src/main/java/hudson/cli/GroovyshCommand.java

@@ -28,6 +28,7 @@
 import groovy.lang.Binding;
 import groovy.lang.Closure;
 import hudson.Extension;
+import hudson.model.User;
 import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -39,6 +40,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import jenkins.model.Jenkins;
+import jenkins.model.ScriptListener;
 import jline.TerminalFactory;
 import jline.UnsupportedTerminal;
 import org.codehaus.groovy.tools.shell.Groovysh;
@@ -79,6 +81,7 @@ protected int run() {
         }
 
         Groovysh shell = createShell(stdin, stdout, stderr);
+        ScriptListener.fireScriptEvent(commandLine.toString(), "CLI", User.current());
         return shell.run(commandLine.toString());
     }
 

core/src/main/java/jenkins/model/Jenkins.java

@@ -142,6 +142,7 @@
 import hudson.model.listeners.SCMListener;
 import hudson.model.listeners.SaveableListener;
 import hudson.remoting.Callable;
+import hudson.remoting.Channel;
 import hudson.remoting.LocalChannel;
 import hudson.remoting.VirtualChannel;
 import hudson.scm.RepositoryBrowser;
@@ -4723,6 +4724,14 @@ public static void _doScript(StaplerRequest req, StaplerResponse rsp, RequestDis
             }
 
             try {
+                String runner = "Script Console ";
+
+                if (!(channel instanceof LocalChannel)) {
+                    runner += ((Channel) channel).getName();
+                } else {
+                    runner += "Controller";
+                }
+                ScriptListener.fireScriptEvent(text, runner, User.current());
                 req.setAttribute("output",
                         RemotingDiagnostics.executeGroovy(text, channel));
             } catch (InterruptedException e) {

core/src/main/java/jenkins/model/ScriptListener.java

@@ -0,0 +1,38 @@
+package jenkins.model;
+
+import hudson.ExtensionPoint;
+import hudson.model.User;
+import jenkins.util.Listeners;
+import org.kohsuke.stapler.StaplerRequest;
+
+/**
+ * A listener to track Groovy scripts.
+ *
+ * @see Jenkins#_doScript(StaplerRequest, org.kohsuke.stapler.StaplerResponse, javax.servlet.RequestDispatcher, hudson.remoting.VirtualChannel, hudson.security.ACL)
+ * @see hudson.cli.GroovyCommand#run()
+ * @see hudson.cli.GroovyshCommand#run()
+ */
+public interface ScriptListener extends ExtensionPoint {
+
+    /**
+     * Called when a (privileged) groovy script is executed.
+     *
+     * @see Jenkins#_doScript(StaplerRequest, org.kohsuke.stapler.StaplerResponse, javax.servlet.RequestDispatcher, hudson.remoting.VirtualChannel, hudson.security.ACL)
+     * @param script The script to be executed.
+     * @param origin Descriptive identifier of the origin where the script is executed (Controller, Agent ID, Run ID).
+     * @param u If available, the user that executed the script. Can be null.
+     */
+    void onScript(String script, String origin, User u);
+
+    /**
+     * Fires the {@link #onScript(String, String, User)} event to track the usage of the script console.
+     *
+     * @see Jenkins#_doScript(StaplerRequest, org.kohsuke.stapler.StaplerResponse, javax.servlet.RequestDispatcher, hudson.remoting.VirtualChannel, hudson.security.ACL)
+     * @param script The script to be executed.
+     * @param origin Descriptive identifier of the origin where the script is executed (Controller, Agent ID, Run ID).
+     * @param u If available, the user that executed the script.
+     */
+    static void fireScriptEvent(String script, String origin, User u) {
+        Listeners.notify(ScriptListener.class, true, listener -> listener.onScript(script, origin, u));
+    }
+}