HealthCheckEmailTask::__construct() - Code Metrics - Inspection of "Add code styling and analysis tools configuration" - jon48/webtrees-lib - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — feature/2.0 (ef99fd)

by Jonathan

created 2020-07-19 12:05 UTC

HealthCheckEmailTask::__construct() A

↳ Parent: HealthCheckEmailTask

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	6
c	0
b	0
f	0
nc	1
nop	6
dl	0
loc	14
rs	10

<?php

/**
 * webtrees-lib: MyArtJaub library for webtrees
 *
 * @package MyArtJaub\Webtrees
 * @subpackage AdminTasks
 * @author Jonathan Jaubart <[email protected]>
 * @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;
    }
}


1			<?php
2
3			/**
4			* webtrees-lib: MyArtJaub library for webtrees
5			*
6			* @package MyArtJaub\Webtrees
7			* @subpackage AdminTasks
8			* @author Jonathan Jaubart <[email protected]>
9			* @copyright Copyright (c) 2012-2020, Jonathan Jaubart
10			* @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
11			*/
12
13			declare(strict_types=1);
14
15			namespace MyArtJaub\Webtrees\Module\AdminTasks\Tasks;
16
17			use Fisharebest\Webtrees\Auth;
18			use Fisharebest\Webtrees\Carbon;
19			use Fisharebest\Webtrees\I18N;
20			use Fisharebest\Webtrees\Log;
21			use Fisharebest\Webtrees\NoReplyUser;
22			use Fisharebest\Webtrees\Tree;
23			use Fisharebest\Webtrees\TreeUser;
24			use Fisharebest\Webtrees\Services\EmailService;
25			use Fisharebest\Webtrees\Services\ModuleService;
26			use Fisharebest\Webtrees\Services\TreeService;
27			use Fisharebest\Webtrees\Services\UpgradeService;
28			use Fisharebest\Webtrees\Services\UserService;
29			use MyArtJaub\Webtrees\Module\AdminTasks\AdminTasksModule;
30			use MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface;
31			use MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface;
32			use MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskSchedule;
33			use MyArtJaub\Webtrees\Module\AdminTasks\Services\HealthCheckService;
34			use Psr\Http\Message\ServerRequestInterface;
35			use Exception;
36
37			/**
38			* Task to send an email summarising the healthcheck of the site
39			*/
40			class HealthCheckEmailTask implements TaskInterface, ConfigurableTaskInterface
41			{
42			/**
43			* Name of the Tree preference to check if the task is enabled for that tree
44			* @var string
45			*/
46			public const TREE_PREFERENCE_NAME = 'MAJ_AT_HEALTHCHECK_ENABLED';
47
48			/**
49			* @var AdminTasksModule $module
50			*/
51			private $module;
52
53			/**
54			* @var HealthCheckService $healthcheck_service;
55			*/
56			private $healthcheck_service;
57
58			/**
59			* @var EmailService $email_service;
60			*/
61			private $email_service;
62
63			/**
64			* @var UserService $user_service
65			*/
66			private $user_service;
67
68			/**
69			* @var TreeService $tree_service
70			*/
71			private $tree_service;
72
73			/**
74			* @var UpgradeService $upgrade_service
75			*/
76			private $upgrade_service;
77
78			/**
79			* Constructor for HealthCheckTask
80			*
81			* @param ModuleService $module_service
82			* @param HealthCheckService $healthcheck_service
83			* @param EmailService $email_service
84			* @param UserService $user_service
85			* @param TreeService $tree_service
86			* @param UpgradeService $upgrade_service
87			*/
88			public function __construct(
89			ModuleService $module_service,
90			HealthCheckService $healthcheck_service,
91			EmailService $email_service,
92			UserService $user_service,
93			TreeService $tree_service,
94			UpgradeService $upgrade_service
95			) {
96			$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
97			$this->healthcheck_service = $healthcheck_service;
98			$this->email_service = $email_service;
99			$this->user_service = $user_service;
100			$this->tree_service = $tree_service;
101			$this->upgrade_service = $upgrade_service;
102			}
103
104
105			/**
106			* {@inheritDoc}
107			* @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::name()
108			*/
109			public function name(): string
110			{
111			return I18N::translate('Healthcheck Email');
112			}
113
114			/**
115			* {@inheritDoc}
116			* @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::defaultFrequency()
117			*/
118			public function defaultFrequency(): int
119			{
120			return 10080; // = 1 week = 7 * 24 * 60 min
121			}
122
123			/**
124			* {@inheritDoc}
125			* @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::run()
126			*/
127			public function run(TaskSchedule $task_schedule): bool
128			{
129			if ($this->module === null) {
130			return false;
131			}
132
133			$res = true;
134
135			// Compute the number of days to compute
136			$interval_lastrun = $task_schedule->lastRunTime()->diffAsCarbonInterval(Carbon::now());
137			//@phpcs:ignore Generic.Files.LineLength.TooLong
138			$interval = $interval_lastrun->greaterThan($task_schedule->frequency()) ? $interval_lastrun : $task_schedule->frequency();
139			$nb_days = (int) $interval->ceilDay()->totalDays;
140
141			$view_params_site = [
142			'nb_days' => $nb_days,
143			'upgrade_available' => $this->upgrade_service->isUpgradeAvailable(),
144			'latest_version' => $this->upgrade_service->latestVersion(),
145			'download_url' => $this->upgrade_service->downloadUrl(),
146			'all_users' => $this->user_service->all(),
147			'unapproved' => $this->user_service->unapproved(),
148			'unverified' => $this->user_service->unverified(),
149			];
150
151			foreach ($this->tree_service->all() as $tree) {
152			/** @var Tree $tree */
153
154			if ($tree->getPreference(self::TREE_PREFERENCE_NAME) !== '1') {
155			continue;
156			}
157
158			$webmaster = $this->user_service->find((int) $tree->getPreference('WEBMASTER_USER_ID'));
159			if ($webmaster === null) {
160			continue;
161			}
162			I18N::init($webmaster->getPreference('language'));
163
164			$error_logs = $this->healthcheck_service->errorLogs($tree, $nb_days);
165			$nb_errors = $error_logs->sum('nblogs');
166
167			$view_params = array_merge($view_params_site, [
168			'tree' => $tree,
169			'total_by_type' => $this->healthcheck_service->countByRecordType($tree),
170			'change_by_type' => $this->healthcheck_service->changesByRecordType($tree, $nb_days),
171			'error_logs' => $error_logs,
172			'nb_errors' => $nb_errors
173			]);
174
175			$res = $res && $this->email_service->send(
176			new TreeUser($tree),
177			$webmaster,
178			new NoReplyUser(),
179			I18N::translate('Health Check Report') . ' - ' . I18N::translate('Tree %s', $tree->name()),
180			view($this->module->name() . '::tasks/healthcheck/email-healthcheck-text', $view_params),
181			view($this->module->name() . '::tasks/healthcheck/email-healthcheck-html', $view_params)
182			);
183			}
184
185			return $res;
186			}
187
188			/**
189			* {@inheritDoc}
190			* @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::configView()
191			*/
192			public function configView(ServerRequestInterface $request): string
193			{
194			return view($this->module->name() . '::tasks/healthcheck/config', [
195			'all_trees' => $this->tree_service->all()
196			]);
197			}
198
199			/**
200			* {@inheritDoc}
201			* @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::updateConfig()
202			*/
203			public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool
204			{
205			try {
206			$params = (array) $request->getParsedBody();
207
208			foreach ($this->tree_service->all() as $tree) {
209			if (Auth::isManager($tree)) {
210			$tree_enabled = (bool) ($params['HEALTHCHECK_ENABLED_' . $tree->id()] ?? false);
211			$tree->setPreference(self::TREE_PREFERENCE_NAME, $tree_enabled ? '1' : '0');
212			}
213			}
214			return true;
215			} catch (Exception $ex) {
216			Log::addErrorLog(
217			sprintf(
218			'Error while updating the Task schedule "%s". Exception: %s',
219			$task_schedule->id(),
220			$ex->getMessage()
221			)
222			);
223			}
224			return false;
225			}
226			}
227

jon48 / webtrees-lib

Branch — feature/2.0 (ef99fd)

HealthCheckEmailTask::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like