Your IP : 216.73.216.95
<?php
namespace Duplicator\Utils\Email;
use DUP_PRO_Log;
use DUP_PRO_Package;
use DUP_PRO_Global_Entity;
use DUP_PRO_Schedule_Entity;
use Duplicator\Core\Views\TplMng;
use Duplicator\Core\Models\AbstractEntitySingleton;
use Duplicator\Models\Storages\AbstractStorageEntity;
use Duplicator\Controllers\EmailSummaryPreviewPageController;
/**
* Email Summary
*/
class EmailSummary extends AbstractEntitySingleton
{
const SEND_FREQ_NEVER = 'never';
const SEND_FREQ_DAILY = 'daily';
const SEND_FREQ_WEEKLY = 'weekly';
const SEND_FREQ_MONTHLY = 'monthly';
const PREVIEW_SLUG = 'duplicator-pro-email-summary-preview';
/** @var int[] Manual package ids */
private $manualPackageIds = [];
/** @var array<array<int, int[]>> Scheduled package ids */
private $scheduledPackageIds = [];
/** @var int[] Failed package ids */
private $failedPackageIds = [];
/** @var int[] info about created schedules*/
private $scheduleIds = [];
/** @var int[] info about created storages*/
private $storageIds = [];
/**
* Constructor
*/
protected function __construct()
{
//do nothing
}
/**
* Returns the summary data
*
* @return array{packages: array<mixed>, storages: array<mixed>, schedules: array<mixed>}
*/
public function getData()
{
return [
'packages' => $this->getPackagesInfo(),
'storages' => $this->getStoragesInfo(),
'schedules' => $this->getSchedulesInfo(),
];
}
/**
* Returns the preview link
*
* @return string
*/
public static function getPreviewLink()
{
return EmailSummaryPreviewPageController::getInstance()->getPageUrl();
}
/**
* Add storage info
*
* @param int $storageId Storage id
*
* @return void
*/
public function addStorage($storageId)
{
$this->storageIds[] = $storageId;
$this->save();
}
/**
* Remove storage info
*
* @param int $storageId Storage id to remove
*
* @return void
*/
public function removeStorage($storageId)
{
$key = array_search($storageId, $this->storageIds);
if ($key !== false) {
array_splice($this->storageIds, $key, 1);
}
$this->save();
}
/**
* Add schedule id
*
* @param DUP_PRO_Schedule_Entity $schedule Storage entity
*
* @return void
*/
public function addSchedule(DUP_PRO_Schedule_Entity $schedule)
{
$this->scheduleIds[] = $schedule->getId();
$this->save();
}
/**
* Remove schedule id
*
* @param int $scheduleId Schedule id to remove
*
* @return void
*/
public function removeSchedule($scheduleId)
{
$key = array_search($scheduleId, $this->scheduleIds);
if ($key !== false) {
array_splice($this->scheduleIds, $key, 1);
}
$this->save();
}
/**
* Add package id
*
* @param DUP_PRO_Package $package The package
*
* @return void
*/
public function addPackage(DUP_PRO_Package $package)
{
if ($package->schedule_id > 0) {
$this->scheduledPackageIds[$package->schedule_id][] = $package->ID;
} else {
$this->manualPackageIds[] = $package->ID;
}
$this->save();
}
/**
* Add package id
*
* @param DUP_PRO_Package $package The package
*
* @return void
*/
public function addFailed(DUP_PRO_Package $package)
{
$this->failedPackageIds[] = $package->ID;
$this->save();
}
/**
* Returns info about created packages
*
* @return array<int|string, array<string, string|int>>
*/
private function getPackagesInfo()
{
$packagesInfo = [];
foreach ($this->scheduledPackageIds as $scheduleId => $packageIds) {
if (($scheduleInfo = $this->getSingleScheduleInfo($scheduleId)) === false) {
$scheduleInfo = [
'name' => __('[Schedule Deleted]', 'duplicator-pro'),
'storages' => __('N/A', 'duplicator-pro'),
];
}
$packagesInfo[] = array_merge($scheduleInfo, ['count' => count($packageIds)]);
}
if (count($this->manualPackageIds) > 0) {
$packagesInfo['manual'] = [
'name' => __('Manual', 'duplicator-pro'),
'storages' => __('N/A', 'duplicator-pro'),
'count' => count($this->manualPackageIds),
];
}
if (count($this->failedPackageIds) > 0) {
$packagesInfo['failed'] = [
'name' => __('Failed', 'duplicator-pro'),
'storages' => __('N/A', 'duplicator-pro'),
'count' => count($this->failedPackageIds),
];
}
return $packagesInfo;
}
/**
* Returns info about created schedules
*
* @return array<array{'name': string, 'storages': string}>
*/
private function getSchedulesInfo()
{
$schedulesInfo = [];
foreach ($this->scheduleIds as $scheduleId) {
if (($scheduleInfo = $this->getSingleScheduleInfo($scheduleId)) === false) {
DUP_PRO_Log::trace("A Schedule with the ID {$scheduleId} was not found.");
continue;
}
$schedulesInfo[] = $scheduleInfo;
}
return $schedulesInfo;
}
/**
* Get schedule info or false if it doesn't exist
*
* @param int $scheduleId The schedule id
*
* @return array{'name': string, 'storages': string}|false
*/
private function getSingleScheduleInfo($scheduleId)
{
if (($schedule = DUP_PRO_Schedule_Entity::getById($scheduleId)) === false) {
return false;
}
$result = [];
$result['name'] = $schedule->name;
$result['storages'] = '';
foreach ($schedule->storage_ids as $i => $storageId) {
if (($storageInfo = $this->getSingleStorageInfo($storageId)) === false) {
continue;
}
$seperator = ($i == count($schedule->storage_ids) - 1) ? '' : ', ';
$result['storages'] .= $storageInfo['name'] . $seperator;
}
return $result;
}
/**
* Returns info about created storages
*
* @return array<array{'name': string, 'type': string}>
*/
private function getStoragesInfo()
{
$storagesInfo = [];
foreach ($this->storageIds as $storageId) {
if (($storageInfo = $this->getSingleStorageInfo($storageId)) === false) {
DUP_PRO_Log::trace("A Storage with the ID {$storageId} was not found.");
continue;
}
$storagesInfo[] = $storageInfo;
}
return $storagesInfo;
}
/**
* Get storage info
*
* @param int $storageId The storage id
*
* @return array{'name': string, 'type': string}|false
*/
private function getSingleStorageInfo($storageId)
{
if (($storage = AbstractStorageEntity::getById($storageId)) === false) {
return false;
}
return [
'name' => $storage->getName(),
'type' => $storage->getStypeName(),
];
}
/**
* Get default recipient emails
*
* @return array<string>
*/
public static function getDefaultRecipients()
{
$recipients = [];
$adminEmail = get_option('admin_email');
if (!empty($adminEmail)) {
$recipients[] = $adminEmail;
}
return $recipients;
}
/**
* Get default recipient emails
*
* @return array<string>
*/
public static function getRecipientSuggestions()
{
$recipients = [];
foreach (self::getDefaultRecipients() as $recipient) {
if (in_array($recipient, DUP_PRO_Global_Entity::getInstance()->getEmailSummaryRecipients())) {
continue;
}
$recipients[] = $recipient;
}
return $recipients;
}
/**
* Get all frequency options
*
* @return array<string, string>
*/
public static function getAllFrequencyOptions()
{
return [
self::SEND_FREQ_NEVER => esc_html__('Never', 'duplicator-pro'),
self::SEND_FREQ_DAILY => esc_html__('Daily', 'duplicator-pro'),
self::SEND_FREQ_WEEKLY => esc_html__('Weekly', 'duplicator-pro'),
self::SEND_FREQ_MONTHLY => esc_html__('Monthly', 'duplicator-pro'),
];
}
/**
* Get the frequency text displayed in the email
*
* @return string
*/
public static function getFrequencyText()
{
switch (DUP_PRO_Global_Entity::getInstance()->getEmailSummaryFrequency()) {
case self::SEND_FREQ_DAILY:
return esc_html__('day', 'duplicator-pro');
case self::SEND_FREQ_MONTHLY:
return esc_html__('month', 'duplicator-pro');
case self::SEND_FREQ_WEEKLY:
default:
return esc_html__('week', 'duplicator-pro');
}
}
/**
* Return entity type identifier
*
* @return string
*/
public static function getType()
{
return 'EmailSummary';
}
}