smeserver-dmarc-srg/root/opt/dmarc-srg/classes/Statistics.php

170 lines
5.4 KiB
PHP
Raw 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 file contains the class Statistics
*
* @category API
* @package DmarcSrg
* @author Aleksey Andreev (liuch)
* @license https://www.gnu.org/licenses/gpl-3.0.html GNU/GPLv3
*/
namespace Liuch\DmarcSrg;
use Liuch\DmarcSrg\DateTime;
/**
* This class is designed to get statistics on DMARC reports of a specified period
*/
class Statistics
{
private $db = null;
private $domain = null;
private $range = [
'date1' => null,
'date2' => null
];
/**
* The constructor of the class, it only uses in static methods of this class
*
* @param Domain|null $domain The domain for which you need to get statistics, null for all the domains.
* @param DatabaseController $db The database controller
*
* @return void
*/
private function __construct($domain, $db)
{
$this->domain = $domain;
$this->db = $db ?? Core::instance()->database();
}
/**
* Returns an instance of the class for the period from $date1 to $date2
*
* @param Domain|null $domain See the constructor for the details
* @param DateTime $date1 The date you need statistics from
* @param DateTime $date2 The date you need statistics to (not included)
* @param DatabaseController $db The database controller
*
* @return Statistics Instance of the class
*/
public static function fromTo($domain, $date1, $date2, $db = null)
{
$r = new Statistics($domain, $db);
$r->range['date1'] = $date1;
$r->range['date2'] = $date2;
return $r;
}
/**
* Returns an instance of the class for the last week
*
* @param Domain|null $domain See the constructor for the details
* @param DatabaseController $db The database controller
*
* @return Statistics Instance of the class
*/
public static function lastWeek($domain, $db = null)
{
$r = new Statistics($domain, $db);
$r->range['date1'] = new DateTime('monday last week');
$r->range['date2'] = (clone $r->range['date1'])->add(new \DateInterval('P7D'));
return $r;
}
/**
* Returns an instance of the class for the last month
*
* @param Domain|null $domain See the construct for the details
* @param DatabaseController $db The database controller
*
* @return Statistics Instance of the class
*/
public static function lastMonth($domain, $db = null)
{
$r = new Statistics($domain, $db);
$r->range['date1'] = new DateTime('midnight first day of last month');
$r->range['date2'] = new DateTime('midnight first day of this month');
return $r;
}
/**
* Returns an instance of the class for the last N days
*
* @param Domain|null $domain See the construct for the details
* @param int $ndays Number of days
* @param DatabaseController $db The database controller
*
* @return Statistics Instance of the class
*/
public static function lastNDays($domain, int $ndays, $db = null)
{
$r = new Statistics($domain, $db);
$r->range['date2'] = new DateTime('midnight');
$r->range['date1'] = (clone $r->range['date2'])->sub(new \DateInterval("P{$ndays}D"));
return $r;
}
/**
* Returns the date from and the date to in an array
*
* @return array - The range of the statistics
*/
public function range(): array
{
return [ (clone $this->range['date1']), (clone $this->range['date2'])->sub(new \DateInterval('PT1S')) ];
}
/**
* Returns summary information for e-mail messages as an array
*
* @return array Array with summary information
*/
public function summary(): array
{
return $this->db->getMapper('statistics')->summary($this->domain, $this->range);
}
/**
* Returns a list of ip-addresses from which the e-mail messages were received, with some statistics for each one
*
* @return array A list of ip-addresses with fields
* `ip`, `emails`, `dkim_aligned`, `spf_aligned`
*/
public function ips(): array
{
return $this->db->getMapper('statistics')->ips($this->domain, $this->range);
}
/**
* Returns a list of organizations that sent the reports with some statistics for each one
*
* @return array List of organizations with fields `name`, `reports`, `emails`
*/
public function organizations(): array
{
return $this->db->getMapper('statistics')->organizations($this->domain, $this->range);
}
}