show log in Web UI see #224

Author: vincent-peugnet

MANUAL.md

@@ -920,6 +920,10 @@ LDAP users cannot be created from the user management interface. User may be con
 But it's possible to automatically create new user as they connect for the first time using LDAP. To do this, __a default user class__ must be set in the admin panel.
 
 
+### Log file
+
+W generate a log file called `w_error.log` located at the root of W installation path. It's also possible to browse a simplified version in the Web interface from the admin interface.
+
 
 Profile
 -------

app/class/Controlleradmin.php

@@ -98,4 +98,27 @@ public function database(): void
         }
         $this->routedirect('admin');
     }
+
+    public function log(): void
+    {
+        if (!$this->user->isadmin()) {
+            http_response_code(403);
+            $this->showtemplate('forbidden');
+            exit;
+        }
+
+        $loglines = file(Model::ERROR_LOG);
+
+        $logs = [];
+        foreach ($loglines as $line) {
+            if (!str_starts_with($line, '#')) {
+                try {
+                    $logs[] = new Logline($line);
+                } catch (RuntimeException $e) {
+                    // Skip the line if parsing failed
+                }
+            }
+        }
+        $this->showtemplate('adminlog', ['logs' => $logs]);
+    }
 }

app/class/Logline.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Wcms;
+
+use DateTime;
+use DateTimeInterface;
+use RuntimeException;
+
+class Logline
+{
+    public DateTime $date;
+    public string $level;
+    public string $ref;
+    public string $message;
+    public string $in = '';
+
+    public const LEVELS = ['ERROR', 'WARN', 'INFO', 'DEBUG'];
+
+    /**
+     * @throws RuntimeException if parsing failed
+     */
+    public function __construct(string $line)
+    {
+        $length = strlen($line);
+        $date = substr($line, 0, 25);
+        $datetime = DateTime::createFromFormat(DateTimeInterface::ATOM, $date);
+
+        if ($datetime === false) {
+            throw new RuntimeException("Date $date is not parsable from '$line'");
+        }
+        $this->date = $datetime;
+
+        $level = substr($line, 28, 5);
+        $level = trim($level);
+        if (in_array($level, self::LEVELS)) {
+            $this->level = strtolower($level);
+        }
+
+        $rest = substr($line, 36);
+
+        $refpos = strpos($rest, ' ');
+
+        if ($refpos === false) {
+            throw new RuntimeException();
+        }
+        $this->ref = substr($rest, 0, $refpos);
+
+        $rest = substr($rest, $refpos + 1);
+
+        $inpos = strrpos($rest, ' in /');
+
+        if ($inpos === false) {
+            $this->message = $rest;
+        } else {
+            $this->message = substr($rest, 0, $inpos);
+            $this->in = substr($rest, $inpos + 4);
+        }
+    }
+}

app/class/Model.php

@@ -27,6 +27,7 @@ abstract class Model
     public const FONTS_CSS_FILE = self::CSS_DIR . 'fonts.css';
     public const DATABASE_DIR = './database/';
     public const PAGES_DIR = self::DATABASE_DIR . 'pages/';
+    public const ERROR_LOG = 'w_error.log';
 
     public const FILE_PERMISSION    = 0660;
     public const FOLDER_PERMISSION  = 0770;

app/class/Routes.php

@@ -59,6 +59,7 @@ public function match(): void
             ['POST', '/!media/edit', 'Controllermedia#edit', 'mediaedit'],
             ['POST', '/!media/rename', 'Controllermedia#rename', 'mediarename'],
             ['GET', '/!admin', 'Controlleradmin#desktop', 'admin'],
+            ['GET', '/!admin/log', 'Controlleradmin#log', 'adminlog'],
             ['POST', '/!admin', 'Controlleradmin#update', 'adminupdate'],
             ['POST', '/!admin/database', 'Controlleradmin#database', 'admindatabase'],
             ['GET', '/!user', 'Controlleruser#desktop', 'user'],

app/view/templates/admin.php

@@ -9,6 +9,12 @@
             <span>Save</span>
         </button>
     </form>
+    <div class="hbar-section">
+        <a href="<?= $this->url('adminlog') ?>">
+            <i class="fa fa-align-left"></i>
+            logs
+        </a>
+    </div>
 </nav>
 
 <main class="admin grid">

app/view/templates/adminlog.php

@@ -0,0 +1,47 @@
+<?php $this->layout('layout', ['title' => 'admin', 'stylesheets' => [$css . 'back.css', $css . 'adminlog.css']]) ?>
+<?php $this->start('page') ?>
+<?php $this->insert('backtopbar', ['user' => $user, 'tab' => 'admin', 'pagelist' => $pagelist]) ?>
+
+<main>
+    <section>
+        <h2>
+            Logs
+        </h2>
+        <div class="scroll">
+            <table>
+                <thead>
+                    <tr>
+                        <th>
+                            date
+                        </th>
+                        <th>
+                            level
+                        </th>
+                        <th>
+                            message
+                        </th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <?php foreach($logs as $log) : ?>
+                    <tr>
+                        <td class="date">
+                            <?= $this->datemedium($log->date) ?>
+                        </td>
+                        <td class="level">
+                        <div class="<?= $log->level ?>">
+                                <?= $log->level ?>
+                        </div> 
+                        </td>
+                        <td>
+                            <?= $log->message ?>
+                        </td>
+                    </tr>
+                    <?php endforeach ?>
+                </tbody>
+            </table>
+        </div>
+    </section>
+</main>
+
+<?php $this->stop('page') ?>

assets/css/adminlog.css

@@ -0,0 +1,25 @@
+.level div {
+    width: 70px;
+    text-align: center;
+    color: white;
+    line-height: 20px;
+    border-radius: var(--radius);
+}
+
+.level div.warn {
+    background-color: orange;
+}
+
+.level div.error {
+    background-color: red;
+
+}
+
+.level div.info {
+    background-color: green;
+
+}
+
+.date {
+    white-space: nowrap;
+}

index.php

@@ -3,8 +3,10 @@
 require('./vendor/autoload.php');
 mb_internal_encoding('UTF-8');
 
+use Wcms\Model;
+
 try {
-    Wcms\Logger::init('w_error.log', 3);
+    Wcms\Logger::init(Model::ERROR_LOG, 3);
 } catch (RuntimeException $e) {
     die('Unable to init logs: ' . $e->getMessage());
 }