smeserver-dmarc-srg/root/opt/dmarc-srg/settings.php

114 lines
4.0 KiB
PHP
Raw Permalink Normal View History

2023-06-21 15:19:40 +02:00
<?php
/**
* dmarc-srg - A php parser, viewer and summary report generator for incoming DMARC reports.
* Copyright (C) 2020 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 script is used to manage the settings via the web interface
*
* HTTP GET query:
* When the header 'Accept' is 'application/json':
* It returns the setting specified in the GET parameter `name`.
* Otherwise it returns a list of the settings. The request may have the following GET parameters:
* `direction` string The sort direction. Can be one of the following values: `ascent`, `descent'.
* The default value is `ascent`. The list will be sorted by Setting name.
* The data will be returned in json format.
* Otherwise:
* It returns the content of the index.html file.
*
* HTTP POST query:
* Updates data for the specified setting. Data must be in json format with the following fields:
* `name` string Name of the setting.
* `action` string Must be `update`.
* `value` string|int Value to update.
* Example:
* { "name": "web.report-view.sort-records-by", "value": "ip", "action": "update" }
*
* Other HTTP methods:
* It returns an error.
*
* @category Web
* @package DmarcSrg
* @author Aleksey Andreev (liuch)
* @license https://www.gnu.org/licenses/gpl-3.0.html GNU/GPLv3
*/
namespace Liuch\DmarcSrg;
use Liuch\DmarcSrg\ErrorHandler;
use Liuch\DmarcSrg\Settings\SettingsList;
use Liuch\DmarcSrg\Exception\SoftException;
use Liuch\DmarcSrg\Exception\RuntimeException;
require 'init.php';
if (Core::isJson()) {
try {
Core::instance()->auth()->isAllowed();
if (Core::method() == 'GET') {
if (isset($_GET['name'])) {
Core::sendJson(SettingsList::getSettingByName($_GET['name'])->toArray());
return;
}
$dir = $_GET['direction'] ?? 'ascent';
$ndir = $dir === 'ascent' ? SettingsList::ORDER_ASCENT : SettingsList::ORDER_DESCENT;
$res = (new SettingsList())->setOrder($ndir)->getList();
$list = array_map(function ($setting) {
return $setting->toArray();
}, $res['list']);
Core::sendJson([
'settings' => $list,
'more' => $res['more']
]);
return;
}
if (Core::method() == 'POST' && Core::isJson()) {
$data = Core::getJsonData();
if ($data) {
$sett = SettingsList::getSettingByName($data['name'] ?? '');
$action = $data['action'] ?? '';
switch ($action) {
case 'update':
$sett->setValue($data['value']);
$sett->save();
Core::sendJson([
'error_code' => 0,
'message' => 'Successfully updated'
]);
break;
default:
throw new SoftException('Unknown action. The only valid value is "update".');
}
return;
}
}
} catch (RuntimeException $e) {
Core::sendJson(ErrorHandler::exceptionResult($e));
return;
}
} elseif (Core::method() == 'GET') {
Core::sendHtml();
return;
}
Core::sendBad();