change default settings to preferences per user via cookies

Author: ChristianMa97

src/main/java/io/jenkins/plugins/agent_build_history/AgentBuildHistory.java

@@ -23,6 +23,7 @@
 import org.kohsuke.stapler.Stapler;
 import org.kohsuke.stapler.StaplerRequest;
 
+import javax.servlet.http.Cookie;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
@@ -43,6 +44,18 @@ public AgentBuildHistory(Computer computer) {
     LOGGER.log(Level.CONFIG, () -> "Creating AgentBuildHistory for " + computer.getName());
   }
 
+  public static String getCookieValue(StaplerRequest req, String name, String defaultValue) {
+    Cookie[] cookies = req.getCookies();
+    if (cookies != null) {
+      for (Cookie cookie : cookies) {
+        if (cookie.getName().equals(name)) {
+          return cookie.getValue();
+        }
+      }
+    }
+    return defaultValue; // Fallback to default if cookie not found
+  }
+
   /*
    * used by jelly
    */
@@ -75,9 +88,9 @@ public RunListTable getHandler() {
     //Get Parameters from URL
     StaplerRequest req = Stapler.getCurrentRequest();
     int page = req.getParameter("page") != null ? Integer.parseInt(req.getParameter("page")) : 1;
-    int pageSize = req.getParameter("pageSize") != null ? Integer.parseInt(req.getParameter("pageSize")) : AgentBuildHistoryConfig.get().getEntriesPerPage();
-    String sortColumn = req.getParameter("sortColumn") != null ? req.getParameter("sortColumn") : AgentBuildHistoryConfig.get().getDefaultSortColumn();
-    String sortOrder = req.getParameter("sortOrder") != null ? req.getParameter("sortOrder") : AgentBuildHistoryConfig.get().getDefaultSortOrder();
+    int pageSize = req.getParameter("pageSize") != null ? Integer.parseInt(req.getParameter("pageSize")) : Integer.parseInt(getCookieValue(req, "pageSize", "20"));
+    String sortColumn = req.getParameter("sortColumn") != null ? req.getParameter("sortColumn") : getCookieValue(req, "sortColumn", "startTime");
+    String sortOrder = req.getParameter("sortOrder") != null ? req.getParameter("sortOrder") : getCookieValue(req, "sortOrder", "desc");
     //Update totalPages depending on pageSize
     int totalEntries = BuildHistoryFileManager.readIndexFile(computer.getName(), AgentBuildHistoryConfig.get().getStorageDir()).size();
     totalPages = (int) Math.ceil((double) totalEntries / pageSize);
@@ -223,24 +236,6 @@ public static void startJobExecution(Computer c, Run<?, ?> run) {
   public static void startFlowNodeExecution(Computer c, WorkflowRun run, FlowNode node) {
     BuildHistoryFileManager.addRunToNodeIndex(c.getName(), run, AgentBuildHistoryConfig.get().getStorageDir());
   }
-  /*
-  used by jelly
-   */
-  public int getEntriesPerPage() {
-    return AgentBuildHistoryConfig.get().getEntriesPerPage();
-  }
-  /*
-    used by jelly
-   */
-  public String getDefaultSortColumn() {
-    return AgentBuildHistoryConfig.get().getDefaultSortColumn();
-  }
-  /*
-    used by jelly
-   */
-  public String getDefaultSortOrder() {
-    return AgentBuildHistoryConfig.get().getDefaultSortOrder();
-  }
 
   @Override
   public String getIconFileName() {

src/main/java/io/jenkins/plugins/agent_build_history/AgentBuildHistoryConfig.java

@@ -1,7 +1,6 @@
 package io.jenkins.plugins.agent_build_history;
 
 import hudson.Extension;
-import hudson.util.ListBoxModel;
 import jenkins.model.GlobalConfiguration;
 import jenkins.model.Jenkins;
 import org.kohsuke.stapler.DataBoundSetter;
@@ -15,9 +14,6 @@ public class AgentBuildHistoryConfig extends GlobalConfiguration {
     private static final Logger LOGGER = Logger.getLogger(AgentBuildHistoryConfig.class.getName());
 
     private String storageDir = getDefaultStorageDir();
-    private int entriesPerPage = 20;
-    private String defaultSortColumn = "startTime";
-    private String defaultSortOrder = "desc";
 
     public AgentBuildHistoryConfig() {
         load(); // Load the persisted configuration
@@ -61,53 +57,9 @@ public void setStorageDir(String storageDir) {
         }
     }
 
-    public int getEntriesPerPage() {
-        return entriesPerPage;
-    }
-
-    @DataBoundSetter
-    public void setEntriesPerPage(int entriesPerPage) {
-        this.entriesPerPage = entriesPerPage;
-        save(); // Save the configuration
-    }
-
-    public String getDefaultSortColumn() {
-        return defaultSortColumn;
-    }
-
-    @DataBoundSetter
-    public void setDefaultSortColumn(String defaultSortColumn) {
-        this.defaultSortColumn = defaultSortColumn;
-        save(); // Save the configuration
-    }
-
-    public String getDefaultSortOrder() {
-        return defaultSortOrder;
-    }
-
-    @DataBoundSetter
-    public void setDefaultSortOrder(String defaultSortOrder) {
-        this.defaultSortOrder = defaultSortOrder;
-        save(); // Save the configuration
-    }
-
     // Static method to access the configuration instance
     public static AgentBuildHistoryConfig get() {
         return GlobalConfiguration.all().get(AgentBuildHistoryConfig.class);
     }
-
-    public ListBoxModel doFillDefaultSortColumnItems() {
-        ListBoxModel items = new ListBoxModel();
-        items.add("Start Time", "startTime");
-        items.add("Build Name and Build Number", "build");
-        return items;
-    }
-
-    public ListBoxModel doFillDefaultSortOrderItems() {
-        ListBoxModel items = new ListBoxModel();
-        items.add("Ascending", "asc");
-        items.add("Descending", "desc");
-        return items;
-    }
 }
 

src/main/resources/io/jenkins/plugins/agent_build_history/AgentBuildHistory/index.jelly

@@ -36,10 +36,10 @@
       <l:progressiveRendering handler="${it.handler}" callback="abhDisplayExtendedBuildHistory"/>
       <!-- Pagination Controls -->
       <j:set var="page" value="${request.getParameter('page') != null ? request.getParameter('page') : 1}"/>
-      <j:set var="pageSize" value="${request.getParameter('pageSize') != null ? request.getParameter('pageSize') : it.entriesPerPage}"/>
+      <j:set var="pageSize" value="${request.getParameter('pageSize') != null ? request.getParameter('pageSize') : h.getCookie(request, 'pageSize', '20')}"/>
       <j:set var="totalPages" value="${it.totalPages}"/>
-      <j:set var="sortColumn" value="${request.getParameter('sortColumn') != null ? request.getParameter('sortColumn') : it.defaultSortColumn}"/>
-      <j:set var="sortOrder" value="${request.getParameter('sortOrder') != null ? request.getParameter('sortOrder') : it.defaultSortOrder}"/>
+      <j:set var="sortColumn" value="${request.getParameter('sortColumn') != null ? request.getParameter('sortColumn') : h.getCookie(request, 'sortColumn', 'startTime')}"/>
+      <j:set var="sortOrder" value="${request.getParameter('sortOrder') != null ? request.getParameter('sortOrder') : h.getCookie(request, 'sortOrder', 'desc')}"/>
       <div class="abh-pagination-container">
         <!-- Pagination Previous/Next Buttons -->
         <nav aria-label="Page navigation" class="abh-pagination">
@@ -99,8 +99,12 @@
                 ${%Started}
                 <j:if test="${sortColumn == 'startTime'}">
                   <j:choose>
-                    <j:when test="${sortOrder == 'asc'}"> <span class="sortarrow" style="font-size: large;">  ↑</span> <!-- Up arrow for ascending order --></j:when>
-                    <j:otherwise> <span class="sortarrow" style="font-size: large;">  ↓</span> <!-- Down arrow for descending order --></j:otherwise>
+                    <j:when test="${sortOrder == 'asc'}">
+                      <span class="sortarrow" style="font-size: large;">  ↑</span> <!-- Up arrow for ascending order -->
+                    </j:when>
+                    <j:otherwise>
+                      <span class="sortarrow" style="font-size: large;">  ↓</span> <!-- Down arrow for descending order -->
+                    </j:otherwise>
                   </j:choose>
                 </j:if>
               </a>

src/main/resources/io/jenkins/plugins/agent_build_history/AgentBuildHistoryConfig/config.jelly

@@ -5,14 +5,5 @@
         <f:textbox />
     </f:entry>
     <p class="info">Note: On storage directory change, old data must be removed manually. A new synchronization will start on the next access to the Agent History.</p>
-    <f:entry title="Default Entries per Page" field="entriesPerPage">
-        <f:number min="1" default="30"/>
-    </f:entry>
-    <f:entry title="Default Sort Column">
-        <f:select field="defaultSortColumn"/>
-    </f:entry>
-    <f:entry title="Default Sort Order">
-        <f:select field="defaultSortOrder"/>
-    </f:entry>
 </f:section>
 </j:jelly>

src/main/resources/io/jenkins/plugins/agent_build_history/agentBuildHistory.js

@@ -171,6 +171,12 @@ window.abhDisplayExtendedBuildHistory = function(data) {
   ts_refresh(table);
 };
 
+function setCookie(name, value) {
+  const expires = new Date();
+  expires.setFullYear(expires.getFullYear() + 1); // Cookie expires in 1 year
+  document.cookie = `${name}=${encodeURIComponent(value)}; expires=${expires.toUTCString()}; path=/`;
+}
+
 document.addEventListener("DOMContentLoaded", function () {
   const pageSizeInput = document.getElementById("pageSizeInput");
   const pageInput = document.getElementById("pageInput");
@@ -179,6 +185,7 @@ document.addEventListener("DOMContentLoaded", function () {
   if (pageSizeInput) {
     pageSizeInput.addEventListener("change", function () {
       const pageSize = pageSizeInput.value;
+      setCookie("pageSize", pageSize);
       const page = 1; // Reset to the first page when page size changes
       const sortColumn = pageSizeInput.getAttribute('data-sort-column');
       const sortOrder = pageSizeInput.getAttribute('data-sort-order');
@@ -200,5 +207,26 @@ document.addEventListener("DOMContentLoaded", function () {
       window.location.href = newUrl;
     });
   }
+  const sortLinks = document.querySelectorAll('.sortheader');
+    sortLinks.forEach(function (link) {
+      link.addEventListener('click', function (event) {
+        event.preventDefault();  // Prevent default link behavior
+
+        const urlParams = new URLSearchParams(link.search);
+        const sortColumn = urlParams.get('sortColumn');
+        const sortOrder = urlParams.get('sortOrder');
+
+        // Set cookies for sortColumn and sortOrder
+        setCookie("sortColumn", sortColumn);
+        setCookie("sortOrder", sortOrder);
+
+        // Redirect to the new URL with sorting parameters
+        const pageSize = pageSizeInput ? pageSizeInput.value : '20';
+        const page = pageInput ? pageInput.value : '1';
+
+        const newUrl = `${window.location.pathname}?page=${page}&pageSize=${pageSize}&sortColumn=${sortColumn}&sortOrder=${sortOrder}`;
+        window.location.href = newUrl;
+      });
+    });
 });