Add managementLink parameter for <l:settings-subpage /> (#23902)

Co-authored-by: Tim Jacomb <[email protected]>

Author: janfaracik

core/src/main/java/hudson/diagnosis/OldDataMonitor.java

@@ -61,6 +61,7 @@
 import jenkins.model.Jenkins;
 import org.jenkinsci.Symbol;
 import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.HttpRedirect;
 import org.kohsuke.stapler.HttpResponse;
@@ -107,6 +108,12 @@ public boolean isActivated() {
         return !data.isEmpty();
     }
 
+    @SuppressWarnings("unused")
+    @Restricted(DoNotUse.class) // used by jelly
+    public ManagementLink getManagementLink() {
+        return ExtensionList.lookupSingleton(ManagementLinkImpl.class);
+    }
+
     public Map<Saveable, VersionRange> getData() {
         Map<Saveable, VersionRange> r = new HashMap<>();
         for (Map.Entry<SaveableReference, VersionRange> entry : this.data.entrySet()) {

core/src/main/java/hudson/logging/LogRecorderManager.java

@@ -28,13 +28,15 @@
 import static java.util.stream.Collectors.toMap;
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import hudson.ExtensionList;
 import hudson.FeedAdapter;
 import hudson.Functions;
 import hudson.RestrictedSince;
 import hudson.Util;
 import hudson.init.Initializer;
 import hudson.model.AbstractModelObject;
 import hudson.model.Failure;
+import hudson.model.ManagementLink;
 import hudson.model.RSS;
 import hudson.util.CopyOnWriteMap;
 import hudson.util.FormValidation;
@@ -54,13 +56,15 @@
 import java.util.logging.LogManager;
 import java.util.logging.LogRecord;
 import java.util.logging.Logger;
+import jenkins.management.SystemLogLink;
 import jenkins.model.Jenkins;
 import jenkins.model.JenkinsLocationConfiguration;
 import jenkins.model.ModelObjectWithChildren;
 import jenkins.model.ModelObjectWithContextMenu.ContextMenu;
 import jenkins.util.SystemProperties;
 import org.apache.commons.io.filefilter.WildcardFileFilter;
 import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
@@ -295,6 +299,12 @@ public Object getTarget() {
         return this;
     }
 
+    @SuppressWarnings("unused")
+    @Restricted(DoNotUse.class) // used by jelly
+    public ManagementLink getManagementLink() {
+        return ExtensionList.lookupSingleton(SystemLogLink.class);
+    }
+
     /**
      * Escape hatch for StaplerProxy-based access control
      */

core/src/main/java/jenkins/agents/CloudSet.java

@@ -25,13 +25,15 @@
 package jenkins.agents;
 
 import hudson.Extension;
+import hudson.ExtensionList;
 import hudson.Functions;
 import hudson.Util;
 import hudson.model.AbstractModelObject;
 import hudson.model.AutoCompletionCandidates;
 import hudson.model.Describable;
 import hudson.model.Descriptor;
 import hudson.model.Failure;
+import hudson.model.ManagementLink;
 import hudson.model.RootAction;
 import hudson.model.UpdateCenter;
 import hudson.slaves.Cloud;
@@ -101,6 +103,12 @@ public String getSearchUrl() {
         return "/cloud/";
     }
 
+    @SuppressWarnings("unused")
+    @Restricted(DoNotUse.class) // used by jelly
+    public ManagementLink getManagementLink() {
+        return ExtensionList.lookupSingleton(CloudsLink.class);
+    }
+
     @SuppressWarnings("unused") // stapler
     @Restricted(DoNotUse.class) // stapler
     public String getCloudUrl(StaplerRequest2 request, Jenkins jenkins, Cloud cloud) {

core/src/main/resources/hudson/diagnosis/OldDataMonitor/manage.jelly

@@ -24,12 +24,7 @@ THE SOFTWARE.
 
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
-  <j:set var="previousIt" value="${it}" />
-  <j:new var="it" className="hudson.diagnosis.OldDataMonitor$ManagementLinkImpl" />
-
-  <l:settings-subpage>
-    <j:set var="it" value="${previousIt}" />
-
+  <l:settings-subpage managementLink="${it.managementLink}">
     <p class="jenkins-!-margin-top-0">${%blurb.1}</p>
     <p>${%blurb.2}</p>
 

core/src/main/resources/hudson/logging/LogRecorderManager/index.jelly

@@ -28,11 +28,8 @@ THE SOFTWARE.
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
   <j:set var="header">
-    <j:set var="previousIt" value="${it}" />
-    <j:new var="it" className="jenkins.management.SystemLogLink" />
-
     <l:view>
-      <l:app-bar title="${it.displayName}">
+      <l:app-bar title="${it.managementLink.displayName}">
         <l:isAdmin>
           <a href="new" class="jenkins-button jenkins-button--primary">
             <l:icon src="symbol-add" />
@@ -46,13 +43,12 @@ THE SOFTWARE.
       </l:app-bar>
 
       <div class="jenkins-page-description">
-        <j:out value="${it.description}" />
+        <j:out value="${it.managementLink.description}" />
       </div>
     </l:view>
   </j:set>
 
-  <l:settings-subpage header="${header}" xmlns:local="local">
-    <j:set var="it" value="${previousIt}" />
+  <l:settings-subpage header="${header}" managementLink="${it.managementLink}" xmlns:local="local">
     <d:taglib uri="local">
       <d:tag name="row">
         <tr>

core/src/main/resources/jenkins/agents/CloudSet/index.jelly

@@ -27,12 +27,7 @@ THE SOFTWARE.
 -->
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:l="/lib/layout" xmlns:f="/lib/form">
-  <j:set var="previousIt" value="${it}" />
-  <j:new var="it" className="jenkins.agents.CloudsLink" />
-
-  <l:settings-subpage header="${null}">
-    <j:set var="it" value="${previousIt}" />
-
+  <l:settings-subpage managementLink="${it.managementLink}" header="${null}">
     <l:isAdmin>
       <script src="${resURL}/jsbundles/pages/cloud-set.js" type="text/javascript" />
       <link rel="stylesheet" href="${resURL}/jsbundles/pages/cloud-set.css" type="text/css" />

core/src/main/resources/lib/layout/settings-subpage.jelly

@@ -26,6 +26,10 @@ THE SOFTWARE.
 <j:jelly xmlns:j="jelly:core" xmlns:l="/lib/layout" xmlns:d="jelly:define" xmlns:st="jelly:stapler" xmlns:f="/lib/form">
   <st:documentation>
     A reusable container for subpages relating under Manage Jenkins.
+    <st:attribute name="managementLink" type="hudson.model.ManagementLink" use="optional">
+      Specifies the object for which page details will be loaded from.
+      Defaults to the "it" object in the current context.
+    </st:attribute>
     <st:attribute name="permission">
       If given, this page is only made available to users who have the specified permission.
       (The permission will be checked against the "it" object.)
@@ -50,19 +54,21 @@ THE SOFTWARE.
   <j:new className="hudson.model.ManageJenkinsAction" var="manageJenkinsAction" />
   <l:userExperimentalFlag var="newManageJenkins" flagClassName="jenkins.model.experimentalflags.NewManageJenkinsUserExperimentalFlag" />
 
-  <l:layout title="${it.displayName} - ${manageJenkinsAction.displayName}"
+  <j:set var="managementLink" value="${attrs.managementLink ?: it}" />
+
+  <l:layout title="${managementLink.displayName} - ${manageJenkinsAction.displayName}"
             permission="${attrs.permission}"
             permissions="${attrs.permissions}"
             type="${newManageJenkins ? 'two-column' : 'one-column'}">
 
     <j:if test="${attrs.includeBreadcrumb}">
       <!-- Hacky - this will be improved in subsequent PRs -->
       <j:choose>
-        <j:when test="${it.class.name eq 'jenkins.management.ConfigureLink'}">
-          <f:breadcrumb-config-outline title="${it.displayName}" />
+        <j:when test="${managementLink.class.name eq 'jenkins.management.ConfigureLink'}">
+          <f:breadcrumb-config-outline title="${managementLink.displayName}" />
         </j:when>
         <j:otherwise>
-          <l:breadcrumb title="${it.displayName}" />
+          <l:breadcrumb title="${managementLink.displayName}" />
         </j:otherwise>
       </j:choose>
     </j:if>
@@ -98,9 +104,9 @@ THE SOFTWARE.
           <div class="app-settings-container">
             <div class="app-settings-container__inner">
               <j:if test="${!attrs.containsKey('header')}">
-                <l:app-bar title="${it.displayName}" />
+                <l:app-bar title="${managementLink.displayName}" />
                 <div class="jenkins-page-description">
-                  ${it.description}
+                  ${managementLink.description}
                 </div>
               </j:if>
 
@@ -128,9 +134,9 @@ THE SOFTWARE.
       <j:otherwise>
         <l:main-panel>
           <j:if test="${!attrs.containsKey('header')}">
-            <l:app-bar title="${it.displayName}" />
+            <l:app-bar title="${managementLink.displayName}" />
             <div class="jenkins-page-description">
-              ${it.description}
+              ${managementLink.description}
             </div>
           </j:if>