Merge pull request 'WIP Port LogDriver from upstream' (#111) from log-driver-port into config

Reviewed-on: leftypol/leftypol#111

inc/Data/Driver/ErrorLogLogDriver.php

@@ -0,0 +1,28 @@
+<?php
+namespace Vichan\Data\Driver;
+
+defined('TINYBOARD') or exit;
+
+
+/**
+ * Log via the php function error_log.
+ */
+class ErrorLogLogDriver implements LogDriver {
+	use LogTrait;
+
+	private string $name;
+	private int $level;
+
+	public function __construct(string $name, int $level) {
+		$this->name = $name;
+		$this->level = $level;
+	}
+
+	public function log(int $level, string $message): void {
+		if ($level <= $this->level) {
+			$lv = $this->levelToString($level);
+			$line = "{$this->name} $lv: $message";
+			\error_log($line, 0, null, null);
+		}
+	}
+}

inc/Data/Driver/FileLogDriver.php

@@ -0,0 +1,61 @@
+<?php
+namespace Vichan\Data\Driver;
+
+defined('TINYBOARD') or exit;
+
+
+/**
+ * Log to a file.
+ */
+class FileLogDriver implements LogDriver {
+	use LogTrait;
+
+	private string $name;
+	private int $level;
+	private mixed $fd;
+
+	public function __construct(string $name, int $level, string $file_path) {
+		/*
+		 * error_log is slow as hell in it's 3rd mode, so use fopen + file locking instead.
+		 * https://grobmeier.solutions/performance-ofnonblocking-write-to-files-via-php-21082009.html
+		 *
+		 * Whatever file appending is atomic is contentious:
+		 *  - There are no POSIX guarantees: https://stackoverflow.com/a/7237901
+		 *  - But linus suggested they are on linux, on some filesystems: https://web.archive.org/web/20151201111541/http://article.gmane.org/gmane.linux.kernel/43445
+		 *  - But it doesn't seem to be always the case: https://www.notthewizard.com/2014/06/17/are-files-appends-really-atomic/
+		 *
+		 * So we just use file locking to be sure.
+		 */
+
+		$this->fd = \fopen($file_path, 'a');
+		if ($this->fd === false) {
+			throw new \RuntimeException("Unable to open log file at $file_path");
+		}
+
+		$this->name = $name;
+		$this->level = $level;
+
+		// In some cases PHP does not run the destructor.
+		\register_shutdown_function([$this, 'close']);
+	}
+
+	public function __destruct() {
+		$this->close();
+	}
+
+	public function log(int $level, string $message): void {
+		if ($level <= $this->level) {
+			$lv = $this->levelToString($level);
+			$line = "{$this->name} $lv: $message\n";
+			\flock($this->fd, LOCK_EX);
+			\fwrite($this->fd, $line);
+			\fflush($this->fd);
+			\flock($this->fd, LOCK_UN);
+		}
+	}
+
+	public function close() {
+		\flock($this->fd, LOCK_UN);
+		\fclose($this->fd);
+	}
+}

inc/Data/Driver/LogDriver.php

@@ -0,0 +1,22 @@
+<?php
+namespace Vichan\Data\Driver;
+
+defined('TINYBOARD') or exit;
+
+
+interface LogDriver {
+	public const EMERG = \LOG_EMERG;
+	public const ERROR = \LOG_ERR;
+	public const WARNING = \LOG_WARNING;
+	public const NOTICE = \LOG_NOTICE;
+	public const INFO = \LOG_INFO;
+	public const DEBUG = \LOG_DEBUG;
+
+	/**
+	 * Log a message if the level of relevancy is at least the minimum.
+	 *
+	 * @param int $level Message level. Use Log interface constants.
+	 * @param string $message The message to log.
+	 */
+	public function log(int $level, string $message): void;
+}

inc/Data/Driver/LogTrait.php

@@ -0,0 +1,26 @@
+<?php
+namespace Vichan\Data\Driver;
+
+defined('TINYBOARD') or exit;
+
+
+trait LogTrait {
+	public static function levelToString(int $level): string {
+		switch ($level) {
+			case LogDriver::EMERG:
+				return 'EMERG';
+			case LogDriver::ERROR:
+				return 'ERROR';
+			case LogDriver::WARNING:
+				return 'WARNING';
+			case LogDriver::NOTICE:
+				return 'NOTICE';
+			case LogDriver::INFO:
+				return 'INFO';
+			case LogDriver::DEBUG:
+				return 'DEBUG';
+			default:
+				throw new \InvalidArgumentException('Not a logging level');
+		}
+	}
+}

inc/Data/Driver/StderrLogDriver.php

@@ -0,0 +1,27 @@
+<?php
+namespace Vichan\Data\Driver;
+
+defined('TINYBOARD') or exit;
+
+
+/**
+ * Log to php's standard error file stream.
+ */
+class StderrLogDriver implements LogDriver {
+	use LogTrait;
+
+	private string $name;
+	private int $level;
+
+	public function __construct(string $name, int $level) {
+		$this->name = $name;
+		$this->level = $level;
+	}
+
+	public function log(int $level, string $message): void {
+		if ($level <= $this->level) {
+			$lv = $this->levelToString($level);
+			\fwrite(\STDERR, "{$this->name} $lv: $message\n");
+		}
+	}
+}

inc/Data/Driver/SyslogLogDriver.php

@@ -0,0 +1,35 @@
+<?php
+namespace Vichan\Data\Driver;
+
+defined('TINYBOARD') or exit;
+
+/**
+ * Log to syslog.
+ */
+class SyslogLogDriver implements LogDriver {
+	private int $level;
+
+	public function __construct(string $name, int $level, bool $print_stderr) {
+		$flags = \LOG_ODELAY;
+		if ($print_stderr) {
+			$flags |= \LOG_PERROR;
+		}
+
+		if (!\openlog($name, $flags, \LOG_USER)) {
+			throw new \RuntimeException('Unable to open syslog');
+		}
+
+		$this->level = $level;
+	}
+
+	public function log(int $level, string $message): void {
+		if ($level <= $this->level) {
+			if (isset($_SERVER['REMOTE_ADDR'], $_SERVER['REQUEST_METHOD'], $_SERVER['REQUEST_URI'])) {
+				// CGI
+				\syslog($level, "$message - client: {$_SERVER['REMOTE_ADDR']}, request: \"{$_SERVER['REQUEST_METHOD']} {$_SERVER['REQUEST_URI']}\"");
+			} else {
+				\syslog($level, $message);
+			}
+		}
+	}
+}

inc/config.php

@@ -63,9 +63,29 @@
     // been generated. This keeps the script from querying the database and causing strain when not needed.
     $config['has_installed'] = '.installed';
 
-    // Use syslog() for logging all error messages and unauthorized login attempts.
+    // Deprecated, use 'log_system'.
     $config['syslog'] = false;
 
+    $config['log_system'] = [
+        /*
+         * Log all error messages and unauthorized login attempts.
+         * Can be "syslog", "error_log" (default), "file", or "stderr".
+         */
+        'type' => 'error_log',
+        // The application name used by the logging system. Defaults to "tinyboard" for backwards compatibility.
+        'name' => 'tinyboard',
+        /*
+         * Only relevant if 'log_system' is set to "syslog". If true, double print the logs also in stderr. Defaults to
+         * false.
+         */
+        'syslog_stderr' => false,
+        /*
+         * Only relevant if "log_system" is set to `file`. Sets the file that vichan will log to. Defaults to
+         * '/var/log/vichan.log'.
+         */
+        'file_path' => '/var/log/vichan.log',
+    ];
+
     // Use `host` via shell_exec() to lookup hostnames, avoiding query timeouts. May not work on your system.
     // Requires safe_mode to be disabled.
     $config['dns_system'] = false;

inc/context.php

@@ -1,8 +1,8 @@
 <?php
 namespace Vichan;
 
-use Vichan\Data\Driver\CacheDriver;
 use Vichan\Data\{IpNoteQueries, ReportQueries, UserPostQueries};
+use Vichan\Data\Driver\{CacheDriver, ErrorLogLogDriver, FileLogDriver, LogDriver, StderrLogDriver, SyslogLogDriver};
 
 defined('TINYBOARD') or exit;
 
@@ -31,6 +31,34 @@ class Context {
 function build_context(array $config): Context {
 	return new Context([
 		'config' => $config,
+		LogDriver::class => function($c) {
+			$config = $c->get('config');
+
+			$name = $config['log_system']['name'];
+			$level = $config['debug'] ? LogDriver::DEBUG : LogDriver::NOTICE;
+			$backend = $config['log_system']['type'];
+
+			$legacy_syslog = isset($config['syslog']) && $config['syslog'];
+
+			// Check 'syslog' for backwards compatibility.
+			if ($legacy_syslog || $backend === 'syslog') {
+				$log_driver = new SyslogLogDriver($name, $level, $config['log_system']['syslog_stderr']);
+				if ($legacy_syslog) {
+					$log_driver->log(LogDriver::NOTICE, 'The configuration setting \'syslog\' is deprecated. Please use \'log_system\' instead');
+				}
+				return $log_driver;
+			} elseif ($backend === 'file') {
+				return new FileLogDriver($name, $level, $config['log_system']['file_path']);
+			} elseif ($backend === 'stderr') {
+				return new StderrLogDriver($name, $level);
+			} elseif ($backend === 'error_log') {
+				return new ErrorLogLogDriver($name, $level);
+			} else {
+				$log_driver = new ErrorLogLogDriver($name, $level);
+				$log_driver->log(LogDriver::ERROR, "Unknown 'log_system' value '$backend', using 'error_log' default");
+				return $log_driver;
+			}
+		},
 		CacheDriver::class => function($c) {
 			// Use the global for backwards compatibility.
 			return \cache::getCache();

inc/mod/pages.php

@@ -4,16 +4,19 @@
  */
 use Vichan\Context;
 use Vichan\Data\{IpNoteQueries, UserPostQueries, ReportQueries};
+use Vichan\Data\Driver\LogDriver;
 use Vichan\Functions\Net;
 
 defined('TINYBOARD') or exit;
 
-function _link_or_copy(string $target, string $link): bool {
-    if (!link($target, $link)) {
-        error_log("Failed to link() $target to $link. FAlling back to copy()");
-        return copy($target, $link);
-    }
-    return true;
+function _link_or_copy_factory(Context $ctx): callable {
+    return function(string $target, string $link) use ($ctx) {
+        if (!\link($target, $link)) {
+            $ctx->get(LogDriver::class)->log(LogDriver::NOTICE, "Failed to link() $target to $link. FAlling back to copy()");
+            return \copy($target, $link);
+        }
+        return true;
+    };
 }
 
 function mod_page($title, $template, $args, $subtitle = false) {
@@ -54,8 +57,7 @@ function mod_login(Context $ctx, $redirect = false) {
         if (!isset($_POST['username'], $_POST['password']) || $_POST['username'] == '' || $_POST['password'] == '') {
             $args['error'] = $config['error']['invalid'];
         } elseif (!login($_POST['username'], $_POST['password'])) {
-            if ($config['syslog'])
-                _syslog(LOG_WARNING, 'Unauthorized login attempt!');
+            $ctx->get(LogDriver::class)->log(LogDriver::INFO, 'Unauthorized login attempt!');
 
             $args['error'] = $config['error']['invalid'];
         } else {
@@ -1489,8 +1491,9 @@ function mod_move(Context $ctx, $originBoard, $postID) {
         if ($targetBoard === $originBoard)
             error(_('Target and source board are the same.'));
 
+        $_link_or_copy = _link_or_copy_factory($ctx);
         // link() if leaving a shadow thread behind; else, rename().
-        $clone = $shadow ? '_link_or_copy' : 'rename';
+        $clone = $shadow ? $_link_or_copy : 'rename';
 
         // indicate that the post is a thread
         $post['op'] = true;
@@ -1784,7 +1787,8 @@ function mod_merge(Context $ctx, $originBoard, $postID) {
             $op = $post;
             $op['id'] = $newID;
 
-            $clone = $shadow ? '_link_or_copy' : 'rename';
+            $_link_or_copy = _link_or_copy_factory($ctx);
+            $clone = $shadow ? $_link_or_copy : 'rename';
 
             if ($post['has_file']) {
                 // copy image

post.php

@@ -5,6 +5,7 @@
 
 use Vichan\Context;
 use Vichan\Data\ReportQueries;
+use Vichan\Data\Driver\LogDriver;
 
 require_once 'inc/bootstrap.php';
 
@@ -354,7 +355,7 @@ function db_select_ban_appeals($ban_id)
 
 $dropped_post = false;
 
-function handle_nntpchan()
+function handle_nntpchan(Context $ctx)
 {
     global $config;
     if ($_SERVER['REMOTE_ADDR'] != $config['nntpchan']['trusted_peer']) {
@@ -433,7 +434,7 @@ function handle_nntpchan()
     if ($ct == 'text/plain') {
         $content = file_get_contents("php://input");
     } elseif ($ct == 'multipart/mixed' || $ct == 'multipart/form-data') {
-        _syslog(LOG_INFO, "MM: Files: " . print_r($GLOBALS, true)); // Debug
+        $ctx->get(LogDriver::class)->log(LogDriver::DEBUG, 'MM: Files: ' . print_r($GLOBALS, true));
 
         $content = '';
 
@@ -610,8 +611,8 @@ function handle_delete(Context $ctx)
                 modLog("User at $ip deleted his own post #$id");
             }
 
-            _syslog(
-                LOG_INFO,
+            $ctx->get(LogDriver::class)->log(
+                LogDriver::INFO,
                 'Deleted post: ' .
                     '/' . $board['dir'] . $config['dir']['res'] . sprintf($config['file_page'], $post['thread'] ? $post['thread'] : $id) . ($post['thread'] ? '#' . $id : '')
             );
@@ -699,9 +700,7 @@ function handle_report(Context $ctx)
     foreach ($report as $id) {
         $post = db_select_post_minimal($board['uri'], $id);
         if ($post === false) {
-            if ($config['syslog']) {
-                _syslog(LOG_INFO, "Failed to report non-existing post #{$id} in {$board['dir']}");
-            }
+            $ctx->get(LogDriver::class)->log(LogDriver::INFO, "Failed to report non-existing post #{$id} in {$board['dir']}");
             error($config['error']['nopost']);
         }
 
@@ -716,13 +715,12 @@ function handle_report(Context $ctx)
             error($error);
         }
 
-        if ($config['syslog'])
-            _syslog(
-                LOG_INFO,
-                'Reported post: ' .
-                    '/' . $board['dir'] . $config['dir']['res'] . link_for($post) . ($post['thread'] ? '#' . $id : '') .
-                    ' for "' . $reason . '"'
-            );
+        $ctx->get(LogDriver::class)->log(
+            LogDriver::INFO,
+            'Reported post: ' .
+                '/' . $board['dir'] . $config['dir']['res'] . link_for($post) . ($post['thread'] ? '#' . $id : '') .
+                ' for "' . $reason . '"'
+        );
 
         $report_queries->add($_SERVER['REMOTE_ADDR'], $board['uri'], $id, $reason);
 
@@ -1783,10 +1781,10 @@ function handle_post(Context $ctx)
 
     buildThread($post['op'] ? $id : $post['thread']);
 
-    if ($config['syslog']) {
-        _syslog(LOG_INFO, 'New post: /' . $board['dir'] . $config['dir']['res'] .
-            link_for($post) . (!$post['op'] ? '#' . $id : ''));
-    }
+    $ctx->get(LogDriver::class)->log(
+        LogDriver::INFO,
+        'New post: /' . $board['dir'] . $config['dir']['res'] . link_for($post) . (!$post['op'] ? '#' . $id : '')
+    );
 
     if (!$post['mod']) {
         header('X-Associated-Content: "' . $redirect . '"');
@@ -1879,17 +1877,17 @@ function handle_appeal(Context $ctx)
     displayBan($ban);
 }
 
+$ctx = Vichan\build_context($config);
+
 // Is it a post coming from NNTP? Let's extract it and pretend it's a normal post.
 if (isset($_GET['Newsgroups'])) {
     if ($config['nntpchan']['enabled']) {
-        handle_nntpchan();
+        handle_nntpchan($ctx);
     } else {
         error("NNTPChan: NNTPChan support is disabled");
     }
 }
 
-$ctx = Vichan\build_context($config);
-
 if (isset($_POST['delete'])) {
     handle_delete($ctx);
 } elseif (isset($_POST['report'])) {