From aa45360b2f02223fdcfa63d88fac3fcc81f62daf Mon Sep 17 00:00:00 2001
From: Markus Winter <m.winter@sap.com>
Date: Wed, 17 Apr 2024 20:52:42 +0200
Subject: [PATCH] move the header parts in a taglib

the taglib allows plugins to make use of the searchbox and the login
stuff while easily being able to modify all the other aspects of the
header.
---
 .../views/JenkinsHeader/headerContent.jelly   | 78 +------------------
 .../resources/lib/layout/header/login.jelly   | 37 +++++++++
 .../resources/lib/layout/header/logo.jelly    | 18 +++++
 .../lib/layout/header/searchbox.jelly         | 25 ++++++
 .../main/resources/lib/layout/header/taglib   |  1 +
 5 files changed, 85 insertions(+), 74 deletions(-)
 create mode 100644 core/src/main/resources/lib/layout/header/login.jelly
 create mode 100644 core/src/main/resources/lib/layout/header/logo.jelly
 create mode 100644 core/src/main/resources/lib/layout/header/searchbox.jelly
 create mode 100644 core/src/main/resources/lib/layout/header/taglib

diff --git a/core/src/main/resources/jenkins/views/JenkinsHeader/headerContent.jelly b/core/src/main/resources/jenkins/views/JenkinsHeader/headerContent.jelly
index ce78d10d37e2..1f22ef506358 100644
--- a/core/src/main/resources/jenkins/views/JenkinsHeader/headerContent.jelly
+++ b/core/src/main/resources/jenkins/views/JenkinsHeader/headerContent.jelly
@@ -1,78 +1,8 @@
 <?jelly escape-by-default='true'?>
-<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:i="jelly:fmt" xmlns:x="jelly:xml">
+<j:jelly xmlns:j="jelly:core" xmlns:h="/lib/layout/header">
     <header id="page-header" class="page-header">
-        <div class="page-header__brand">
-            <div class="logo">
-                <a id="jenkins-home-link" href="${rootURL}/">
-                    <img id="jenkins-head-icon" src="${imagesURL}/svgs/logo.svg" alt="[${logoAlt}]" />
-                    <img id="jenkins-name-icon" src="${imagesURL}/title.svg" alt="${title}" width="139" height="34" />
-                </a>
-            </div>
-
-            <a class="page-header__brand-link" href="${rootURL}/">
-                <img src="${imagesURL}/svgs/logo.svg"
-                     alt="[${logoAlt}]"
-                     class="page-header__brand-image" />
-                <span class="page-header__brand-name">Jenkins</span>
-            </a>
-        </div>
-
-        <div class="searchbox hidden-xs">
-            <!-- search box -->
-            <j:set var="searchURL" value="${h.searchURL}"/>
-            <form action="${searchURL}" method="get" style="position:relative;" class="no-json" name="search" role="search">
-                <!-- this div is used to calculate the width of the text box -->
-                <div id="search-box-sizer"/>
-                <div id="searchform">
-                    <input name="q" placeholder="${searchPlaceholder}" id="search-box" class="main-search__input" value="${request.getParameter('q')}" role="searchbox" />
-
-                    <span class="main-search__icon-leading">
-                        <l:icon src="symbol-search"/>
-                    </span>
-                    <a href="${searchHelpUrl}" class="main-search__icon-trailing">
-                        <l:icon src="symbol-help-circle"/>
-                    </a>
-
-                    <div id="search-box-completion" data-search-url="${searchURL}" />
-                    <st:adjunct includes="jenkins.views.JenkinsHeader.search-box" />
-                </div>
-            </form>
-        </div>
-
-        <div class="login page-header__hyperlinks">
-            <div id="visible-am-insertion" class="page-header__am-wrapper" />
-            <div id="visible-sec-am-insertion" class="page-header__am-wrapper" />
-
-            <!-- user icon and login/logout links; only show if authentication is enabled and we're not handling a servlet error -->
-            <j:if test="${app.useSecurity}">
-                <j:choose>
-                    <j:when test="${!h.isAnonymous()}">
-                        <j:invokeStatic var="user" className="hudson.model.User" method="current" />
-                        <j:choose>
-                            <j:when test="${user.fullName == null || user.fullName.trim().isEmpty()}">
-                                <j:set var="userName" value="${user.id}"/>
-                            </j:when>
-                            <j:otherwise>
-                                <j:set var="userName" value="${user.fullName}"/>
-                            </j:otherwise>
-                        </j:choose>
-                        <a href="${rootURL}/${user.url}" class="model-link">
-                            <l:icon src="symbol-person-circle" class="icon-md"/>
-                            <span class="hidden-xs hidden-sm">${userName}</span>
-                        </a>
-                        <j:if test="${app.securityRealm.canLogOut()}">
-                            <a href="${rootURL}/logout">
-                                <l:icon src="symbol-log-out" class="icon-md" />
-                                <span class="hidden-xs hidden-sm">${logout}</span>
-                            </a>
-                        </j:if>
-                    </j:when>
-                    <j:otherwise>
-                        <st:include it="${app.securityRealm}" page="loginLink.jelly" />
-                    </j:otherwise>
-                </j:choose>
-            </j:if>
-        </div>
+      <h:logo/>
+      <h:searchbox/>
+      <h:login/>
     </header>
-    <script src="${resURL}/jsbundles/keyboard-shortcuts.js" type="text/javascript"/>
 </j:jelly>
diff --git a/core/src/main/resources/lib/layout/header/login.jelly b/core/src/main/resources/lib/layout/header/login.jelly
new file mode 100644
index 000000000000..f546b5d28f11
--- /dev/null
+++ b/core/src/main/resources/lib/layout/header/login.jelly
@@ -0,0 +1,37 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:l="/lib/layout">
+  <div class="login page-header__hyperlinks">
+    <div id="visible-am-insertion" class="page-header__am-wrapper" />
+    <div id="visible-sec-am-insertion" class="page-header__am-wrapper" />
+
+    <!-- user icon and login/logout links; only show if authentication is enabled and we're not handling a servlet error -->
+    <j:if test="${app.useSecurity}">
+      <j:choose>
+        <j:when test="${!h.isAnonymous()}">
+          <j:invokeStatic var="user" className="hudson.model.User" method="current" />
+          <j:choose>
+            <j:when test="${user.fullName == null || user.fullName.trim().isEmpty()}">
+              <j:set var="userName" value="${user.id}"/>
+            </j:when>
+            <j:otherwise>
+              <j:set var="userName" value="${user.fullName}"/>
+            </j:otherwise>
+          </j:choose>
+          <a href="${rootURL}/${user.url}" class="model-link">
+            <l:icon src="symbol-person-circle" class="icon-md"/>
+            <span class="hidden-xs hidden-sm">${userName}</span>
+          </a>
+          <j:if test="${app.securityRealm.canLogOut()}">
+            <a href="${rootURL}/logout">
+              <l:icon src="symbol-log-out" class="icon-md" />
+              <span class="hidden-xs hidden-sm">${logout}</span>
+            </a>
+          </j:if>
+        </j:when>
+        <j:otherwise>
+          <st:include it="${app.securityRealm}" page="loginLink.jelly" />
+        </j:otherwise>
+      </j:choose>
+    </j:if>
+  </div>
+</j:jelly>
diff --git a/core/src/main/resources/lib/layout/header/logo.jelly b/core/src/main/resources/lib/layout/header/logo.jelly
new file mode 100644
index 000000000000..4bdb29cea7ec
--- /dev/null
+++ b/core/src/main/resources/lib/layout/header/logo.jelly
@@ -0,0 +1,18 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  <div class="page-header__brand">
+    <div class="logo">
+      <a id="jenkins-home-link" href="${rootURL}/">
+        <img id="jenkins-head-icon" src="${imagesURL}/svgs/logo.svg" alt="[${logoAlt}]" />
+        <img id="jenkins-name-icon" src="${imagesURL}/title.svg" alt="${title}" width="139" height="34" />
+      </a>
+    </div>
+
+    <a class="page-header__brand-link" href="${rootURL}/">
+      <img src="${imagesURL}/svgs/logo.svg"
+           alt="[${logoAlt}]"
+           class="page-header__brand-image" />
+      <span class="page-header__brand-name">Jenkins</span>
+    </a>
+  </div>
+</j:jelly>
diff --git a/core/src/main/resources/lib/layout/header/searchbox.jelly b/core/src/main/resources/lib/layout/header/searchbox.jelly
new file mode 100644
index 000000000000..916f5ad49c22
--- /dev/null
+++ b/core/src/main/resources/lib/layout/header/searchbox.jelly
@@ -0,0 +1,25 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:l="/lib/layout">
+  <div class="searchbox hidden-xs">
+    <!-- search box -->
+    <j:set var="searchURL" value="${h.searchURL}"/>
+    <form action="${searchURL}" method="get" style="position:relative;" class="no-json" name="search" role="search">
+      <!-- this div is used to calculate the width of the text box -->
+      <div id="search-box-sizer"/>
+      <div id="searchform">
+        <input name="q" placeholder="${searchPlaceholder}" id="search-box" class="main-search__input" value="${request.getParameter('q')}" role="searchbox" />
+
+        <span class="main-search__icon-leading">
+          <l:icon src="symbol-search"/>
+        </span>
+        <a href="${searchHelpUrl}" class="main-search__icon-trailing">
+          <l:icon src="symbol-help-circle"/>
+        </a>
+
+        <div id="search-box-completion" data-search-url="${searchURL}" />
+        <st:adjunct includes="jenkins.views.JenkinsHeader.search-box" />
+      </div>
+    </form>
+  </div>
+  <script src="${resURL}/jsbundles/keyboard-shortcuts.js" type="text/javascript"/>
+</j:jelly>
diff --git a/core/src/main/resources/lib/layout/header/taglib b/core/src/main/resources/lib/layout/header/taglib
new file mode 100644
index 000000000000..43777e443981
--- /dev/null
+++ b/core/src/main/resources/lib/layout/header/taglib
@@ -0,0 +1 @@
+Tag library that defines components for headers