Minor usability improvements to job logs page (#1542)

Co-authored-by: Julien Chaffraix <julien.chaffraix@gmail.com>

Author: cpeel

pinc/job_log.inc

@@ -1,6 +1,26 @@
 <?php
 
-function insert_job_log_entry($filename, $event, $comments, $succeeded = null)
+/** @return string[] */
+function get_job_log_filenames(): array
+{
+    $sql = sprintf(
+        "
+        SELECT DISTINCT filename
+        FROM job_logs
+        WHERE tracetime >= %d
+        ORDER BY filename
+        ",
+        time() - (60 * 60 * 24 * 45), // 45 days covers all common jobs
+    );
+    $result = DPDatabase::query($sql);
+    $entries = [];
+    while ([$filename] = mysqli_fetch_row($result)) {
+        $entries[] = $filename;
+    }
+    return $entries;
+}
+
+function insert_job_log_entry(string $filename, string $event, ?string $comments, ?bool $succeeded = null): void
 {
     $sql = sprintf(
         "
@@ -16,17 +36,19 @@ function insert_job_log_entry($filename, $event, $comments, $succeeded = null)
     DPDatabase::query($sql);
 }
 
-function get_job_log_entries($timestamp, $filename = null, $event = null)
+function get_job_log_entries(int $timestamp, ?string $filename = null, ?string $event = null, ?bool $succeeded = null): array
 {
     $filename_where = $filename ? sprintf("AND filename = '%s'", DPDatabase::escape($filename)) : "";
     $event_where = $event ? sprintf("AND event = '%s'", DPDatabase::escape($event)) : "";
+    $succeeded_where = $succeeded !== null ? sprintf("AND succeeded = %d", $succeeded ? 1 : 0) : "";
     $sql = sprintf(
         "
         SELECT *
         FROM job_logs
         WHERE tracetime >= %d
             $filename_where
             $event_where
+            $succeeded_where
         ORDER BY tracetime desc
         ",
         $timestamp
@@ -39,7 +61,7 @@ function get_job_log_entries($timestamp, $filename = null, $event = null)
     return $entries;
 }
 
-function prune_job_log_entries(int $days_to_keep)
+function prune_job_log_entries(int $days_to_keep): void
 {
     $cutoff = new DateTimeImmutable(sprintf("%d days ago", $days_to_keep));
     $sql = sprintf(

pinc/misc.inc

@@ -464,6 +464,8 @@ function get_bool_param(array $arr, string $key, ?bool $default = null, bool $al
                 return true;
             } elseif ($s === "false" || $s === "0") {
                 return false;
+            } elseif ($s === "" && $allownull) {
+                return null;
             }
 
             // fall through to handle other strings as an exception

pinc/theme.inc

@@ -247,7 +247,7 @@ function html_logobar()
             $messages[] = sprintf(
                 _("%d <a href='%s'>background jobs</a> failed in the past day."),
                 $failed_jobs,
-                "$code_url/tools/site_admin/show_job_log.php"
+                "$code_url/tools/site_admin/show_job_log.php?succeeded=0"
             );
         }
     }

tools/site_admin/show_job_log.php

@@ -6,7 +6,7 @@
 
 $days_ago = get_integer_param($_GET, 'days_ago', 1, 0, 365);
 $job = $_GET['job'] ?? null;
-$event = $_GET['event'] ?? '';
+$succeeded = get_bool_param($_GET, 'succeeded', null, true);
 
 $start_timestamp = time() - (60 * 60 * 24 * $days_ago);
 
@@ -30,11 +30,25 @@
 echo "</tr>";
 echo "<tr>";
 echo "  <th>" . _("Job") . "</th>";
-echo "  <td><input name='job' type='text' value='" . attr_safe($job) . "'></td>";
+echo "  <td>";
+echo "    <select name='job'>";
+foreach (array_merge([_("All")], get_job_log_filenames()) as $jobname) {
+    $value = $jobname == _("All") ? "" : attr_safe($jobname);
+    $selected = $jobname == $job ? "selected" : "";
+    echo "<option value='$value' $selected>" . html_safe($jobname) . "</option>";
+}
+echo "    </select>";
+echo "  </td>";
 echo "</tr>";
 echo "<tr>";
-echo "  <th>" . _("Event") . "</th>";
-echo "  <td><input name='event' type='text' value='" . attr_safe($event) . "'></td>";
+echo "  <th>" . _("Status") . "</th>";
+echo "  <td>";
+echo "    <select name='succeeded'>";
+foreach ([_("All") => null, _("Succeeded") => 1, _("Failed") => 0] as $name => $value) {
+    $selected = $succeeded === boolval($value) ? "selected" : "";
+    echo "<option value='$value' $selected>$name</option>";
+}
+echo "  </td>";
 echo "</tr>";
 echo "</table>";
 echo "<input type='submit' value='" . attr_safe(_("Show")) . "'>";
@@ -50,7 +64,7 @@
 echo "<th>" . _("Event") . "</th>";
 echo "<th>" . _("Comments") . "</th>";
 echo "</tr>";
-foreach (get_job_log_entries($start_timestamp, $job, $event) as $row) {
+foreach (get_job_log_entries($start_timestamp, $job, /*$event*/ null, $succeeded) as $row) {
     if ($row["succeeded"] === null) {
         $status = "";
     } elseif ($row["succeeded"]) {