Add in software files and templates

2023-06-21 14:19:40 +01:00
parent f42fdb947c
commit 5228fc5e9f
143 changed files with 23175 additions and 2 deletions
--- a/root/opt/dmarc-srg/classes/Database/Mariadb/SettingMapper.php
+++ b/root/opt/dmarc-srg/classes/Database/Mariadb/SettingMapper.php
@@ -0,0 +1,130 @@
+<?php
+
+/**
+ * dmarc-srg - A php parser, viewer and summary report generator for incoming DMARC reports.
+ * Copyright (C) 2022 Aleksey Andreev (liuch)
+ *
+ * Available at:
+ * https://github.com/liuch/dmarc-srg
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, either version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * =========================
+ *
+ * This file contains the SettingMapper class
+ *
+ * @category API
+ * @package  DmarcSrg
+ * @author   Aleksey Andreev (liuch)
+ * @license  https://www.gnu.org/licenses/gpl-3.0.html GNU/GPLv3
+ */
+
+namespace Liuch\DmarcSrg\Database\Mariadb;
+
+use Liuch\DmarcSrg\Database\SettingMapperInterface;
+use Liuch\DmarcSrg\Exception\DatabaseFatalException;
+use Liuch\DmarcSrg\Exception\DatabaseNotFoundException;
+
+/**
+ * SettingMapper class implementation for MariaDB
+ */
+class SettingMapper implements SettingMapperInterface
+{
+    private $connector = null;
+
+    /**
+     * The constructor
+     *
+     * @param Connector $connector DatabaseConnector
+     */
+    public function __construct(object $connector)
+    {
+        $this->connector = $connector;
+    }
+
+    /**
+     * Returns setting value as a string by key
+     *
+     * @param string $key
+     *
+     * @return string
+     */
+    public function value(string $key): string
+    {
+        try {
+            $st = $this->connector->dbh()->prepare(
+                'SELECT `value` FROM `' . $this->connector->tablePrefix('system') . '` WHERE `key` = ?'
+            );
+            $st->bindValue(1, $key, \PDO::PARAM_STR);
+            $st->execute();
+            if (!$res = $st->fetch(\PDO::FETCH_NUM)) {
+                throw new DatabaseNotFoundException('Setting not found: ' . $key);
+            }
+            $st->closeCursor();
+            return $res[0];
+        } catch (\PDOException $e) {
+            throw new DatabaseFatalException('Failed to get a setting', -1, $e);
+        }
+    }
+
+    /**
+     * Returns a key-value array of the setting list like this:
+     * [ 'name1' => 'value1', 'name2' => 'value2' ]
+     *
+     * @return array
+     */
+    public function list(): array
+    {
+        $res = [];
+        try {
+            $st = $this->connector->dbh()->query(
+                'SELECT `key`, `value` FROM `' . $this->connector->tablePrefix('system') . '` ORDER BY `key`'
+            );
+            while ($row = $st->fetch(\PDO::FETCH_NUM)) {
+                $res[$row[0]] = $row[1];
+            }
+            $st->closeCursor();
+        } catch (\PDOException $e) {
+            throw new DatabaseFatalException('Failed to get a list of the settings', -1, $e);
+        }
+        return $res;
+    }
+
+    /**
+     * Saves the setting to the database
+     *
+     * Updates the value of the setting in the database if the setting exists there or insert a new record otherwise.
+     *
+     * @param string $name  Setting name
+     * @param string $value Setting value
+     *
+     * @return void
+     */
+    public function save(string $name, string $value): void
+    {
+        $db = $this->connector->dbh();
+        try {
+            $st = $db->prepare(
+                'INSERT INTO `' . $this->connector->tablePrefix('system') .
+                '` (`key`, `value`) VALUES (?, ?) ON DUPLICATE KEY UPDATE `value` = ?'
+            );
+            $st->bindValue(1, $name, \PDO::PARAM_STR);
+            $st->bindValue(2, $value, \PDO::PARAM_STR);
+            $st->bindValue(3, $value, \PDO::PARAM_STR);
+            $st->execute();
+            $st->closeCursor();
+        } catch (\PDOException $e) {
+            throw new DatabaseFatalException('Failed to update a setting', -1, $e);
+        }
+    }
+}