Adding upstream version 2.12.1.upstream/2.12.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

5 files changed, 284 insertions, 0 deletions

diff --git a/library/Icinga/Application/Logger/Writer/FileWriter.php b/library/Icinga/Application/Logger/Writer/FileWriter.php
new file mode 100644
index 0000000..6b4ed54
--- /dev/null
+++ b/library/Icinga/Application/Logger/Writer/FileWriter.php
@@ -0,0 +1,80 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Application\Logger\Writer;
+
+use Exception;
+use Icinga\Data\ConfigObject;
+use Icinga\Application\Logger;
+use Icinga\Application\Logger\LogWriter;
+use Icinga\Exception\ConfigurationError;
+use Icinga\Util\File;
+
+/**
+ * Log to a file
+ */
+class FileWriter extends LogWriter
+{
+    /**
+     * Path to the file
+     *
+     * @var string
+     */
+    protected $file;
+
+    /**
+     * Create a new file log writer
+     *
+     * @param   ConfigObject  $config
+     *
+     * @throws  ConfigurationError  If the configuration directive 'file' is missing or if the path to 'file' does
+     *                              not exist or if writing to 'file' is not possible
+     */
+    public function __construct(ConfigObject $config)
+    {
+        if ($config->file === null) {
+            throw new ConfigurationError('Required logging configuration directive \'file\' missing');
+        }
+        $this->file = $config->file;
+
+        if (substr($this->file, 0, 6) !== 'php://' && ! file_exists(dirname($this->file))) {
+            throw new ConfigurationError(
+                'Log path "%s" does not exist',
+                dirname($this->file)
+            );
+        }
+
+        try {
+            $this->write(''); // Avoid to handle such errors on every write access
+        } catch (Exception $e) {
+            throw new ConfigurationError(
+                'Cannot write to log file "%s" (%s)',
+                $this->file,
+                $e->getMessage()
+            );
+        }
+    }
+
+    /**
+     * Log a message
+     *
+     * @param   int     $level      The logging level
+     * @param   string  $message    The log message
+     */
+    public function log($level, $message)
+    {
+        $this->write(date('c') . ' - ' . Logger::$levels[$level] . ' - ' . $message . PHP_EOL);
+    }
+
+    /**
+     * Write a message to the log
+     *
+     * @param string $message
+     */
+    protected function write($message)
+    {
+        $file = new File($this->file, 'a');
+        $file->fwrite($message);
+        $file->fflush();
+    }
+}
diff --git a/library/Icinga/Application/Logger/Writer/PhpWriter.php b/library/Icinga/Application/Logger/Writer/PhpWriter.php
new file mode 100644
index 0000000..dedb2bd
--- /dev/null
+++ b/library/Icinga/Application/Logger/Writer/PhpWriter.php
@@ -0,0 +1,39 @@
+<?php
+/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Application\Logger\Writer;
+
+use Icinga\Application\Logger;
+use Icinga\Application\Logger\LogWriter;
+use Icinga\Data\ConfigObject;
+use Icinga\Exception\NotWritableError;
+
+/**
+ * Log to the webserver log, a file or syslog
+ *
+ * @see https://secure.php.net/manual/en/errorfunc.configuration.php#ini.error-log
+ */
+class PhpWriter extends LogWriter
+{
+    /**
+     * Prefix to prepend to each message
+     *
+     * @var string
+     */
+    protected $ident;
+
+    public function __construct(ConfigObject $config)
+    {
+        parent::__construct($config);
+        $this->ident = $config->get('application', 'icingaweb2');
+    }
+
+    public function log($severity, $message)
+    {
+        if (ini_get('error_log') === 'syslog') {
+            $message = str_replace("\n", '    ', $message);
+        }
+
+        error_log($this->ident . ': ' . Logger::$levels[$severity] . ' - ' . $message);
+    }
+}
diff --git a/library/Icinga/Application/Logger/Writer/StderrWriter.php b/library/Icinga/Application/Logger/Writer/StderrWriter.php
new file mode 100644
index 0000000..7df4278
--- /dev/null
+++ b/library/Icinga/Application/Logger/Writer/StderrWriter.php
@@ -0,0 +1,62 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Application\Logger\Writer;
+
+use Icinga\Cli\Screen;
+use Icinga\Application\Logger;
+use Icinga\Application\Logger\LogWriter;
+
+/**
+ * Class to write log messages to STDERR
+ */
+class StderrWriter extends LogWriter
+{
+    /**
+     * The current Screen in use
+     *
+     * @var Screen
+     */
+    protected $screen;
+
+    /**
+     * Return the current Screen
+     *
+     * @return  Screen
+     */
+    protected function screen()
+    {
+        if ($this->screen === null) {
+            $this->screen = Screen::instance(STDERR);
+        }
+
+        return $this->screen;
+    }
+
+    /**
+     * Log a message with the given severity
+     *
+     * @param   int     $severity   The severity to use
+     * @param   string  $message    The message to log
+     */
+    public function log($severity, $message)
+    {
+        $color = null;
+        switch ($severity) {
+            case Logger::ERROR:
+                $color = 'red';
+                break;
+            case Logger::WARNING:
+                $color = 'yellow';
+                break;
+            case Logger::INFO:
+                $color = 'green';
+                break;
+            case Logger::DEBUG:
+                $color = 'blue';
+                break;
+        }
+
+        file_put_contents('php://stderr', $this->screen()->colorize($message, $color) . "\n");
+    }
+}
diff --git a/library/Icinga/Application/Logger/Writer/StdoutWriter.php b/library/Icinga/Application/Logger/Writer/StdoutWriter.php
new file mode 100644
index 0000000..a6f43e5
--- /dev/null
+++ b/library/Icinga/Application/Logger/Writer/StdoutWriter.php
@@ -0,0 +1,13 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Application\Logger\Writer;
+
+/**
+ * Deprecated, compat only.
+ *
+ * Use Icinga\Application\Logger\Writer\StderrWriter instead.
+ */
+class StdoutWriter extends StderrWriter
+{
+}
diff --git a/library/Icinga/Application/Logger/Writer/SyslogWriter.php b/library/Icinga/Application/Logger/Writer/SyslogWriter.php
new file mode 100644
index 0000000..93efc2a
--- /dev/null
+++ b/library/Icinga/Application/Logger/Writer/SyslogWriter.php
@@ -0,0 +1,90 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Application\Logger\Writer;
+
+use Icinga\Data\ConfigObject;
+use Icinga\Application\Logger;
+use Icinga\Application\Logger\LogWriter;
+use Icinga\Exception\ConfigurationError;
+
+/**
+ * Log to the syslog service
+ */
+class SyslogWriter extends LogWriter
+{
+    /**
+     * Syslog facility
+     *
+     * @var int
+     */
+    protected $facility;
+
+    /**
+     * Prefix to prepend to each message
+     *
+     * @var string
+     */
+    protected $ident;
+
+    /**
+     * Known syslog facilities
+     *
+     * @var array
+     */
+    public static $facilities = array(
+        'user'      => LOG_USER,
+        'local0'    => LOG_LOCAL0,
+        'local1'    => LOG_LOCAL1,
+        'local2'    => LOG_LOCAL2,
+        'local3'    => LOG_LOCAL3,
+        'local4'    => LOG_LOCAL4,
+        'local5'    => LOG_LOCAL5,
+        'local6'    => LOG_LOCAL6,
+        'local7'    => LOG_LOCAL7
+    );
+
+    /**
+     * Log level to syslog severity map
+     *
+     * @var array
+     */
+    public static $severityMap = array(
+        Logger::ERROR   => LOG_ERR,
+        Logger::WARNING => LOG_WARNING,
+        Logger::INFO    => LOG_INFO,
+        Logger::DEBUG   => LOG_DEBUG
+    );
+
+    /**
+     * Create a new syslog log writer
+     *
+     * @param   ConfigObject    $config
+     */
+    public function __construct(ConfigObject $config)
+    {
+        $this->ident = $config->get('application', 'icingaweb2');
+
+        $configuredFacility = $config->get('facility', 'user');
+        if (! isset(static::$facilities[$configuredFacility])) {
+            throw new ConfigurationError(
+                'Invalid logging facility: "%s" (expected one of: %s)',
+                $configuredFacility,
+                implode(', ', array_keys(static::$facilities))
+            );
+        }
+        $this->facility = static::$facilities[$configuredFacility];
+    }
+
+    /**
+     * Log a message
+     *
+     * @param   int     $level      The logging level
+     * @param   string  $message    The log message
+     */
+    public function log($level, $message)
+    {
+        openlog($this->ident, LOG_PID, $this->facility);
+        syslog(static::$severityMap[$level], str_replace("\n", '    ', $message));
+    }
+}