generated from smedev/Template-for-SMEServer-Contribs-Package
Add in software files and templates
This commit is contained in:
165
root/opt/dmarc-srg/classes/Directories/Directory.php
Normal file
165
root/opt/dmarc-srg/classes/Directories/Directory.php
Normal file
@@ -0,0 +1,165 @@
|
||||
<?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 file contains the class Directory
|
||||
*
|
||||
* @category API
|
||||
* @package DmarcSrg
|
||||
* @author Aleksey Andreev (liuch)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0.html GNU/GPLv3
|
||||
*/
|
||||
|
||||
namespace Liuch\DmarcSrg\Directories;
|
||||
|
||||
use Liuch\DmarcSrg\ErrorHandler;
|
||||
use Liuch\DmarcSrg\Exception\SoftException;
|
||||
use Liuch\DmarcSrg\Exception\LogicException;
|
||||
use Liuch\DmarcSrg\Exception\RuntimeException;
|
||||
|
||||
/**
|
||||
* This class is designed to work with the report directories which are listed in the configuration file.
|
||||
*/
|
||||
class Directory
|
||||
{
|
||||
private $id = null;
|
||||
private $name = null;
|
||||
private $location = null;
|
||||
|
||||
/**
|
||||
* It's the constructor of the class
|
||||
*
|
||||
* @param int $id Id of the directory. In fact, it is a serial number in the configuration file.
|
||||
* @param array $data An array with the following fields:
|
||||
* `location` (string) - Location of the directory in the file system.
|
||||
* `name` (string) - Name of the directory. It is optional.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function __construct(int $id, array $data)
|
||||
{
|
||||
if (isset($data['name']) && gettype($data['name']) !== 'string') {
|
||||
throw new LogicException('Directory name must be either null or a string value');
|
||||
}
|
||||
if (!isset($data['location']) || gettype($data['location']) !== 'string') {
|
||||
throw new LogicException('Directory location must be a string value');
|
||||
}
|
||||
if (empty($data['location'])) {
|
||||
throw new LogicException('Directory location must not be an empty string');
|
||||
}
|
||||
|
||||
$this->id = $id;
|
||||
$this->name = $data['name'] ?? null;
|
||||
$this->location = $data['location'];
|
||||
if (empty($this->name)) {
|
||||
$this->name = 'Directory ' . $this->id;
|
||||
}
|
||||
if (substr($this->location, -1) !== '/') {
|
||||
$this->location .= '/';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array with directory configuration data.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function toArray(): array
|
||||
{
|
||||
return [
|
||||
'id' => $this->id,
|
||||
'name' => $this->name,
|
||||
'location' => $this->location
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the existence and accessibility of the directory. Returns the result as an array.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function check(): array
|
||||
{
|
||||
try {
|
||||
self::checkPath($this->location, true);
|
||||
self::checkPath($this->location . 'failed/', false);
|
||||
} catch (RuntimeException $e) {
|
||||
return ErrorHandler::exceptionResult($e);
|
||||
}
|
||||
|
||||
return [
|
||||
'error_code' => 0,
|
||||
'message' => 'Successfully',
|
||||
'status' => [
|
||||
'files' => $this->count()
|
||||
]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the total number of files in the directory.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function count(): int
|
||||
{
|
||||
$cnt = 0;
|
||||
try {
|
||||
$fs = new \FilesystemIterator($this->location);
|
||||
} catch (\Exception $e) {
|
||||
throw new RuntimeException("Error accessing directory {$this->location}", -1, $e);
|
||||
}
|
||||
foreach ($fs as $entry) {
|
||||
if ($entry->isFile()) {
|
||||
++$cnt;
|
||||
}
|
||||
}
|
||||
return $cnt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks accessibility of a directory by its path. Throws an exception in case of any error.
|
||||
*
|
||||
* @param string $path Path to the directory to check.
|
||||
* @param bool $existence If true, the absence of the directory causes an error.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private static function checkPath(string $path, bool $existence): void
|
||||
{
|
||||
if (!file_exists($path)) {
|
||||
if ($existence) {
|
||||
throw new SoftException($path . ' directory does not exist!');
|
||||
}
|
||||
return;
|
||||
}
|
||||
if (!is_dir($path)) {
|
||||
throw new SoftException($path . ' is not a directory!');
|
||||
}
|
||||
if (!is_readable($path)) {
|
||||
throw new SoftException($path . ' directory is not readable!');
|
||||
}
|
||||
if (!is_writable($path)) {
|
||||
throw new SoftException($path . ' directory is not writable!');
|
||||
}
|
||||
}
|
||||
}
|
||||
147
root/opt/dmarc-srg/classes/Directories/DirectoryList.php
Normal file
147
root/opt/dmarc-srg/classes/Directories/DirectoryList.php
Normal file
@@ -0,0 +1,147 @@
|
||||
<?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 file contains the class DirectoryList
|
||||
*
|
||||
* @category API
|
||||
* @package DmarcSrg
|
||||
* @author Aleksey Andreev (liuch)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0.html GNU/GPLv3
|
||||
*/
|
||||
|
||||
namespace Liuch\DmarcSrg\Directories;
|
||||
|
||||
use Liuch\DmarcSrg\Core;
|
||||
use Liuch\DmarcSrg\Exception\LogicException;
|
||||
|
||||
/**
|
||||
* This class is designed to work with the list of report directories which are listed in the configuration file.
|
||||
*/
|
||||
class DirectoryList
|
||||
{
|
||||
private $list = null;
|
||||
|
||||
/**
|
||||
* Returns a list of directories for the setting file
|
||||
*
|
||||
* @return array Array with instances of Directory class
|
||||
*/
|
||||
public function list(): array
|
||||
{
|
||||
$this->ensureList();
|
||||
return $this->list;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an instance of the Directory class by its Id
|
||||
*
|
||||
* @param int $id Id of the required directory
|
||||
*
|
||||
* @return Directory
|
||||
*/
|
||||
public function directory(int $id)
|
||||
{
|
||||
$this->ensureList();
|
||||
if ($id <= 0 || $id > count($this->list)) {
|
||||
throw new LogicException('Incorrect directory Id');
|
||||
}
|
||||
return $this->list[$id - 1];
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the accessibility of the specified directory or all the directories from configuration file if $id is 0.
|
||||
*
|
||||
* @param int $id Directory Id to check
|
||||
*
|
||||
* @return array Result array with `error_code` and `message` fields. For one directory and if there is no error,
|
||||
* a field `status` will be added to the result.
|
||||
*/
|
||||
public function check(int $id): array
|
||||
{
|
||||
if ($id !== 0) {
|
||||
$dir = $this->directory($id);
|
||||
return $dir->check();
|
||||
}
|
||||
|
||||
$this->ensureList();
|
||||
$results = [];
|
||||
$err_cnt = 0;
|
||||
$dir_cnt = count($this->list);
|
||||
for ($i = 0; $i < $dir_cnt; ++$i) {
|
||||
$r = $this->list[$i]->check();
|
||||
if ($r['error_code'] !== 0) {
|
||||
++$err_cnt;
|
||||
}
|
||||
$results[] = $r;
|
||||
}
|
||||
$res = [];
|
||||
if ($err_cnt === 0) {
|
||||
$res['error_code'] = 0;
|
||||
$res['message'] = 'Successfully';
|
||||
} else {
|
||||
$res['error_code'] = -1;
|
||||
$res['message'] = sprintf('%d of %d directories have failed the check', $err_cnt, $dir_cnt);
|
||||
}
|
||||
$res['results'] = $results;
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an array of directories from the configuration file if it does not exist
|
||||
* for using in other methods of the class.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function ensureList(): void
|
||||
{
|
||||
if (!is_null($this->list)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$directories = Core::instance()->config('directories');
|
||||
|
||||
$this->list = [];
|
||||
if (is_array($directories)) {
|
||||
$cnt = count($directories);
|
||||
if ($cnt > 0) {
|
||||
if (isset($directories[0])) {
|
||||
$id = 1;
|
||||
for ($i = 0; $i < $cnt; ++$i) {
|
||||
try {
|
||||
$this->list[] = new Directory($id, $directories[$i]);
|
||||
++$id;
|
||||
} catch (LogicException $d) {
|
||||
// Just ignore this directory setting.
|
||||
}
|
||||
}
|
||||
} else {
|
||||
try {
|
||||
$this->list[] = new Directory(1, $directories);
|
||||
} catch (LogicException $e) {
|
||||
// Just ignore this directory setting.
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user