MyArtJaub\Webtrees\Module\AdminTasks\Tasks\HealthCheckEmailTask::executeSteps()

Complexity

Conditions	29
Paths	2376

Size

Total Lines	152
Code Lines	115

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	HealthCheckEmailTask::run()	0	59	7
A	HealthCheckEmailTask::defaultFrequency()	0	3	1
A	HealthCheckEmailTask::name()	0	3	1
A	HealthCheckEmailTask::configView()	0	4	1
A	HealthCheckEmailTask::__construct()	0	14	1

<?php

/**
 * webtrees-lib: MyArtJaub library for webtrees
 *
 * @package MyArtJaub\Webtrees
 * @subpackage AdminTasks
 * @author Jonathan Jaubart <dev@jaubart.com>
 * @copyright Copyright (c) 2012-2020, Jonathan Jaubart
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
 */

declare(strict_types=1);

namespace MyArtJaub\Webtrees\Module\AdminTasks\Tasks;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Carbon;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Log;
use Fisharebest\Webtrees\NoReplyUser;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\TreeUser;
use Fisharebest\Webtrees\Services\EmailService;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Services\TreeService;
use Fisharebest\Webtrees\Services\UpgradeService;
use Fisharebest\Webtrees\Services\UserService;
use MyArtJaub\Webtrees\Module\AdminTasks\AdminTasksModule;
use MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface;
use MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface;
use MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskSchedule;
use MyArtJaub\Webtrees\Module\AdminTasks\Services\HealthCheckService;
use Psr\Http\Message\ServerRequestInterface;
use Exception;

/**
 * Task to send an email summarising the healthcheck of the site
 */
class HealthCheckEmailTask implements TaskInterface, ConfigurableTaskInterface
{
    /**
     * Name of the Tree preference to check if the task is enabled for that tree
     * @var string
     */
    public const TREE_PREFERENCE_NAME = 'MAJ_AT_HEALTHCHECK_ENABLED';
    
    /**
     * @var AdminTasksModule $module
     */
    private $module;
    
    /**
     * @var HealthCheckService $healthcheck_service;
     */
    private $healthcheck_service;
    
    /**
     * @var EmailService $email_service;
     */
    private $email_service;
    
    /**
     * @var UserService $user_service
     */
    private $user_service;
    
    /**
     * @var TreeService $tree_service
     */
    private $tree_service;
    
    /**
     * @var UpgradeService $upgrade_service
     */
    private $upgrade_service;
    
    /**
     * Constructor for HealthCheckTask
     *
     * @param ModuleService $module_service
     * @param HealthCheckService $healthcheck_service
     * @param EmailService $email_service
     * @param UserService $user_service
     * @param TreeService $tree_service
     * @param UpgradeService $upgrade_service
     */
    public function __construct(
        ModuleService $module_service,
        HealthCheckService $healthcheck_service,
        EmailService $email_service,
        UserService $user_service,
        TreeService $tree_service,
        UpgradeService $upgrade_service
    ) {
        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
        $this->healthcheck_service = $healthcheck_service;
        $this->email_service = $email_service;
        $this->user_service = $user_service;
        $this->tree_service = $tree_service;
        $this->upgrade_service = $upgrade_service;
    }
    
    
    /**
     * {@inheritDoc}
     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::name()
     */
    public function name(): string
    {
        return I18N::translate('Healthcheck Email');
    }
    
    /**
     * {@inheritDoc}
     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::defaultFrequency()
     */
    public function defaultFrequency(): int
    {
        return 10080; // = 1 week = 7 * 24 * 60 min
    }
    
    /**
     * {@inheritDoc}
     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::run()
     */
    public function run(TaskSchedule $task_schedule): bool
    {
        if ($this->module === null) {
            return false;
        }
        
        $res = true;
        
        // Compute the number of days to compute
        $interval_lastrun = $task_schedule->lastRunTime()->diffAsCarbonInterval(Carbon::now());
        //@phpcs:ignore Generic.Files.LineLength.TooLong
        $interval = $interval_lastrun->greaterThan($task_schedule->frequency()) ? $interval_lastrun : $task_schedule->frequency();
        $nb_days = (int) $interval->ceilDay()->totalDays;
        
        $view_params_site = [
            'nb_days'               =>  $nb_days,
            'upgrade_available'     =>  $this->upgrade_service->isUpgradeAvailable(),
            'latest_version'        =>  $this->upgrade_service->latestVersion(),
            'download_url'          =>  $this->upgrade_service->downloadUrl(),
            'all_users'             =>  $this->user_service->all(),
            'unapproved'            =>  $this->user_service->unapproved(),
            'unverified'            =>  $this->user_service->unverified(),
        ];
        
        foreach ($this->tree_service->all() as $tree) {
        /** @var Tree $tree */
            
            if ($tree->getPreference(self::TREE_PREFERENCE_NAME) !== '1') {
                continue;
            }
            
            $webmaster = $this->user_service->find((int) $tree->getPreference('WEBMASTER_USER_ID'));
            if ($webmaster === null) {
                continue;
            }
            I18N::init($webmaster->getPreference('language'));
            
            $error_logs = $this->healthcheck_service->errorLogs($tree, $nb_days);
            $nb_errors = $error_logs->sum('nblogs');
            
            $view_params = array_merge($view_params_site, [
                'tree'              =>  $tree,
                'total_by_type'     =>  $this->healthcheck_service->countByRecordType($tree),
                'change_by_type'    =>  $this->healthcheck_service->changesByRecordType($tree, $nb_days),
                'error_logs'        =>  $error_logs,
                'nb_errors'         =>  $nb_errors
            ]);
            
            $res = $res && $this->email_service->send(
                new TreeUser($tree),
                $webmaster,
                new NoReplyUser(),
                I18N::translate('Health Check Report') . ' - ' . I18N::translate('Tree %s', $tree->name()),
                view($this->module->name() . '::tasks/healthcheck/email-healthcheck-text', $view_params),
                view($this->module->name() . '::tasks/healthcheck/email-healthcheck-html', $view_params)
            );
        }
        
        return $res;
    }

    /**
     * {@inheritDoc}
     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::configView()
     */
    public function configView(ServerRequestInterface $request): string
    {
        return view($this->module->name() . '::tasks/healthcheck/config', [
            'all_trees'     =>  $this->tree_service->all()
        ]);
    }
    
    /**
     * {@inheritDoc}
     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::updateConfig()
     */
    public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool
    {
        try {
            $params = (array) $request->getParsedBody();
            
            foreach ($this->tree_service->all() as $tree) {
                if (Auth::isManager($tree)) {
                    $tree_enabled = (bool) ($params['HEALTHCHECK_ENABLED_' . $tree->id()] ?? false);
                    $tree->setPreference(self::TREE_PREFERENCE_NAME, $tree_enabled ? '1' : '0');
                }
            }
            return true;
        } catch (Exception $ex) {
            Log::addErrorLog(
                sprintf(
                    'Error while updating the Task schedule "%s". Exception: %s',
                    $task_schedule->id(),
                    $ex->getMessage()
                )
            );
        }
        return false;
    }
}