jon48 / webtrees-lib

app/Module/AdminTasks/Services/TokenService.php

Indentation +28 added lines, -28 removed lines

@@ -20,32 +20,32 @@
  */
 class TokenService
 {
-    /**
-     * Returns a random-ish generated token of a given size
-     *
-     * @param int $length Length of the token, default to 32
-     * @return string Random token
-     */
-    public function generateRandomToken(int $length = 32): string
-    {
-        $chars = str_split('abcdefghijkmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789');
-        $len_chars = count($chars);
-        $token = '';
-
-        for ($i = 0; $i < $length; $i++) {
-            $token .= $chars[mt_rand(0, $len_chars - 1)];
-        }
-
-        # Number of 32 char chunks
-        $chunks = ceil(strlen($token) / 32);
-        $md5token = '';
-
-        # Run each chunk through md5
-        for ($i = 1; $i <= $chunks; $i++) {
-            $md5token .= md5(substr($token, $i * 32 - 32, 32));
-        }
-
-        # Trim the token to the required length
-        return substr($md5token, 0, $length);
-    }
+	/**
+	 * Returns a random-ish generated token of a given size
+	 *
+	 * @param int $length Length of the token, default to 32
+	 * @return string Random token
+	 */
+	public function generateRandomToken(int $length = 32): string
+	{
+		$chars = str_split('abcdefghijkmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789');
+		$len_chars = count($chars);
+		$token = '';
+
+		for ($i = 0; $i < $length; $i++) {
+			$token .= $chars[mt_rand(0, $len_chars - 1)];
+		}
+
+		# Number of 32 char chunks
+		$chunks = ceil(strlen($token) / 32);
+		$md5token = '';
+
+		# Run each chunk through md5
+		for ($i = 1; $i <= $chunks; $i++) {
+			$md5token .= md5(substr($token, $i * 32 - 32, 32));
+		}
+
+		# Trim the token to the required length
+		return substr($md5token, 0, $length);
+	}
 }

app/Module/AdminTasks/Services/HealthCheckService.php

Indentation +93 added lines, -93 removed lines

@@ -27,101 +27,101 @@
  */
 class HealthCheckService
 {
-    /**
-     * Returns a query collating all gedcom records, for use in other queries
-     *
-     * @param Tree $tree
-     * @return Builder
-     */
-    private function allGedcomRecords(Tree $tree): Builder
-    {
-        return DB::table('individuals')
-            ->select(DB::raw("'indi' AS ged_type"), 'i_id AS ged_id')->where('i_file', '=', $tree->id())
-            ->unionAll(DB::table('families')
-                ->select(DB::raw("'fam' AS ged_type"), 'f_id AS ged_id')->where('f_file', '=', $tree->id()))
-            ->unionAll(DB::table('sources')
-                ->select(DB::raw("'sour' AS ged_type"), 's_id AS ged_id')->where('s_file', '=', $tree->id()))
-            ->unionAll(DB::table('media')
-                ->select(DB::raw("'media' AS ged_type"), 'm_id AS ged_id')->where('m_file', '=', $tree->id()))
-            ->unionAll(DB::table('other')
-                ->select(DB::raw('LOWER(o_type) AS ged_type'), 'o_id AS ged_id')->where('o_file', '=', $tree->id()));
-    }
+	/**
+	 * Returns a query collating all gedcom records, for use in other queries
+	 *
+	 * @param Tree $tree
+	 * @return Builder
+	 */
+	private function allGedcomRecords(Tree $tree): Builder
+	{
+		return DB::table('individuals')
+			->select(DB::raw("'indi' AS ged_type"), 'i_id AS ged_id')->where('i_file', '=', $tree->id())
+			->unionAll(DB::table('families')
+				->select(DB::raw("'fam' AS ged_type"), 'f_id AS ged_id')->where('f_file', '=', $tree->id()))
+			->unionAll(DB::table('sources')
+				->select(DB::raw("'sour' AS ged_type"), 's_id AS ged_id')->where('s_file', '=', $tree->id()))
+			->unionAll(DB::table('media')
+				->select(DB::raw("'media' AS ged_type"), 'm_id AS ged_id')->where('m_file', '=', $tree->id()))
+			->unionAll(DB::table('other')
+				->select(DB::raw('LOWER(o_type) AS ged_type'), 'o_id AS ged_id')->where('o_file', '=', $tree->id()));
+	}
 
-    /**
-     * Returns the count of gedcom records by type in a Tree, as a keyed Collection.
-     *
-     * Collection output:
-     *      - Key : gedcom record type
-     *      - Value: count of records
-     *
-     * @param Tree $tree
-     * @return Collection<string, int>
-     */
-    public function countByRecordType(Tree $tree): Collection
-    {
-        return DB::query()
-            ->fromSub($this->allGedcomRecords($tree), 'gedrecords')
-            ->select('ged_type', new Expression('COUNT(ged_id) AS total'))
-            ->groupBy('ged_type')
-            ->pluck('total', 'ged_type');
-    }
+	/**
+	 * Returns the count of gedcom records by type in a Tree, as a keyed Collection.
+	 *
+	 * Collection output:
+	 *      - Key : gedcom record type
+	 *      - Value: count of records
+	 *
+	 * @param Tree $tree
+	 * @return Collection<string, int>
+	 */
+	public function countByRecordType(Tree $tree): Collection
+	{
+		return DB::query()
+			->fromSub($this->allGedcomRecords($tree), 'gedrecords')
+			->select('ged_type', new Expression('COUNT(ged_id) AS total'))
+			->groupBy('ged_type')
+			->pluck('total', 'ged_type');
+	}
 
-    /**
-     * Returns the count of gedcom records changes by type in a Tree across a number of days, as a keyed Collection.
-     *
-     * Collection output:
-     *      - Key : gedcom record type
-     *      - Value: count of changes
-     *
-     * @param Tree $tree
-     * @return Collection<string, int>
-     */
-    public function changesByRecordType(Tree $tree, int $nb_days): Collection
-    {
-        return DB::table('change')
-            ->joinSub($this->allGedcomRecords($tree), 'gedrecords', function (JoinClause $join) use ($tree): void {
+	/**
+	 * Returns the count of gedcom records changes by type in a Tree across a number of days, as a keyed Collection.
+	 *
+	 * Collection output:
+	 *      - Key : gedcom record type
+	 *      - Value: count of changes
+	 *
+	 * @param Tree $tree
+	 * @return Collection<string, int>
+	 */
+	public function changesByRecordType(Tree $tree, int $nb_days): Collection
+	{
+		return DB::table('change')
+			->joinSub($this->allGedcomRecords($tree), 'gedrecords', function (JoinClause $join) use ($tree): void {
 
-                $join->on('change.xref', '=', 'gedrecords.ged_id')
-                    ->where('change.gedcom_id', '=', $tree->id());
-            })
-            ->select('ged_type AS type', new Expression('COUNT(change_id) AS count'))
-            ->where('change.status', '', 'accepted')
-            ->where('change.change_time', '>=', Carbon::now()->subDays($nb_days))
-            ->groupBy('ged_type')
-            ->pluck('total', 'ged_type');
-    }
+				$join->on('change.xref', '=', 'gedrecords.ged_id')
+					->where('change.gedcom_id', '=', $tree->id());
+			})
+			->select('ged_type AS type', new Expression('COUNT(change_id) AS count'))
+			->where('change.status', '', 'accepted')
+			->where('change.change_time', '>=', Carbon::now()->subDays($nb_days))
+			->groupBy('ged_type')
+			->pluck('total', 'ged_type');
+	}
 
-    /**
-     * Return the error logs associated with a tree across a number of days, grouped by error message, as a Collection.
-     *
-     * Collection output:
-     *      - Value: stdClass object
-     *          - log message:  Error log message
-     *          - type:         'site' if no associated Tree, the Tree ID otherwise
-     *          - nblogs:       The number of occurence of the same error message
-     *          - lastoccurred: Date/time of the last occurence of the error message
-     *
-     * @param Tree $tree
-     * @param int $nb_days
-     * @return Collection<\stdClass>
-     */
-    public function errorLogs(Tree $tree, int $nb_days): Collection
-    {
-        return DB::table('log')
-            ->select(
-                'log_message',
-                new Expression("IFNULL(gedcom_id, 'site') as type"),
-                new Expression('COUNT(log_id) AS nblogs'),
-                new Expression('MAX(log_time) AS lastoccurred')
-            )
-            ->where('log_type', '=', 'error')
-            ->where(function (Builder $query) use ($tree): void {
-                $query->where('gedcom_id', '=', $tree->id())
-                    ->orWhereNull('gedcom_id');
-            })
-            ->where('log_time', '>=', Carbon::now()->subDays($nb_days))
-            ->groupBy('log_message', 'gedcom_id')
-            ->orderByDesc('lastoccurred')
-            ->get();
-    }
+	/**
+	 * Return the error logs associated with a tree across a number of days, grouped by error message, as a Collection.
+	 *
+	 * Collection output:
+	 *      - Value: stdClass object
+	 *          - log message:  Error log message
+	 *          - type:         'site' if no associated Tree, the Tree ID otherwise
+	 *          - nblogs:       The number of occurence of the same error message
+	 *          - lastoccurred: Date/time of the last occurence of the error message
+	 *
+	 * @param Tree $tree
+	 * @param int $nb_days
+	 * @return Collection<\stdClass>
+	 */
+	public function errorLogs(Tree $tree, int $nb_days): Collection
+	{
+		return DB::table('log')
+			->select(
+				'log_message',
+				new Expression("IFNULL(gedcom_id, 'site') as type"),
+				new Expression('COUNT(log_id) AS nblogs'),
+				new Expression('MAX(log_time) AS lastoccurred')
+			)
+			->where('log_type', '=', 'error')
+			->where(function (Builder $query) use ($tree): void {
+				$query->where('gedcom_id', '=', $tree->id())
+					->orWhereNull('gedcom_id');
+			})
+			->where('log_time', '>=', Carbon::now()->subDays($nb_days))
+			->groupBy('log_message', 'gedcom_id')
+			->orderByDesc('lastoccurred')
+			->get();
+	}
 }

app/Module/AdminTasks/AdminTasksModule.php

Indentation +122 added lines, -122 removed lines

@@ -41,127 +41,127 @@
  * Allow for tasks to be run on a (nearly-)regular schedule
  */
 class AdminTasksModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleConfigInterface,
-    ModuleGlobalInterface,
-    ModuleTasksProviderInterface
+	ModuleMyArtJaubInterface,
+	ModuleConfigInterface,
+	ModuleGlobalInterface,
+	ModuleTasksProviderInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleConfigTrait;
-    use ModuleGlobalTrait;
-
-    //How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 2;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Administration Tasks');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Manage and run nearly-scheduled administration tasks.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot(): void
-    {
-        $this->traitBoot();
-        app(MigrationService::class)->updateSchema(
-            self::SCHEMA_MIGRATION_PREFIX,
-            self::SCHEMA_SETTING_NAME,
-            self::SCHEMA_TARGET_VERSION
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/admintasks', static function (Map $router): void {
-                $router->tokens(['enable' => '[01]']);
-
-                $router->attach('', '/admin', static function (Map $router): void {
-
-                    $router->extras([
-                        'middleware' => [
-                            AuthAdministrator::class,
-                        ],
-                    ]);
-                    $router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
-
-                    $router->attach('', '/tasks', static function (Map $router): void {
-
-                        $router->get(TasksList::class, '', TasksList::class);
-                        $router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
-                        $router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
-                        $router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
-                    });
-                });
-
-                $router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
-                    ->allows(RequestMethodInterface::METHOD_POST);
-
-                $router->post(TokenGenerate::class, '/token', TokenGenerate::class)
-                    ->extras(['middleware' => [AuthAdministrator::class]]);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.0-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink(): string
-    {
-        return route(AdminConfigPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see ModuleTasksProviderInterface::listTasks()
-     */
-    public function listTasks(): array
-    {
-        return [
-            'maj-healthcheck' => HealthCheckEmailTask::class
-        ];
-    }
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleConfigTrait;
+	use ModuleGlobalTrait;
+
+	//How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 2;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Administration Tasks');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Manage and run nearly-scheduled administration tasks.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot(): void
+	{
+		$this->traitBoot();
+		app(MigrationService::class)->updateSchema(
+			self::SCHEMA_MIGRATION_PREFIX,
+			self::SCHEMA_SETTING_NAME,
+			self::SCHEMA_TARGET_VERSION
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/admintasks', static function (Map $router): void {
+				$router->tokens(['enable' => '[01]']);
+
+				$router->attach('', '/admin', static function (Map $router): void {
+
+					$router->extras([
+						'middleware' => [
+							AuthAdministrator::class,
+						],
+					]);
+					$router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
+
+					$router->attach('', '/tasks', static function (Map $router): void {
+
+						$router->get(TasksList::class, '', TasksList::class);
+						$router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
+						$router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
+						$router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
+					});
+				});
+
+				$router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
+					->allows(RequestMethodInterface::METHOD_POST);
+
+				$router->post(TokenGenerate::class, '/token', TokenGenerate::class)
+					->extras(['middleware' => [AuthAdministrator::class]]);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.0-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink(): string
+	{
+		return route(AdminConfigPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see ModuleTasksProviderInterface::listTasks()
+	 */
+	public function listTasks(): array
+	{
+		return [
+			'maj-healthcheck' => HealthCheckEmailTask::class
+		];
+	}
 }

app/Module/AdminTasks/Tasks/HealthCheckEmailTask.php

Indentation +161 added lines, -161 removed lines

@@ -39,165 +39,165 @@
  */
 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';
-
-    private ?AdminTasksModule $module;
-    private HealthCheckService $healthcheck_service;
-    private EmailService $email_service;
-    private UserService $user_service;
-    private TreeService $tree_service;
-    private UpgradeService $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\Contracts\Tasks\TaskInterface::name()
-     */
-    public function name(): string
-    {
-        return I18N::translate('Healthcheck Email');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface::defaultFrequency()
-     */
-    public function defaultFrequency(): int
-    {
-        return 10080; // = 1 week = 7 * 24 * 60 min
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Tasks\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\Contracts\Tasks\ConfigurableTaskInterface::configView()
-     */
-    public function configView(ServerRequestInterface $request): string
-    {
-        return $this->module === null ? '' : view($this->module->name() . '::tasks/healthcheck/config', [
-            'all_trees'     =>  $this->tree_service->all()
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Tasks\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 (Throwable $ex) {
-            Log::addErrorLog(
-                sprintf(
-                    'Error while updating the Task schedule "%s". Exception: %s',
-                    $task_schedule->id(),
-                    $ex->getMessage()
-                )
-            );
-        }
-        return false;
-    }
+	/**
+	 * 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';
+
+	private ?AdminTasksModule $module;
+	private HealthCheckService $healthcheck_service;
+	private EmailService $email_service;
+	private UserService $user_service;
+	private TreeService $tree_service;
+	private UpgradeService $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\Contracts\Tasks\TaskInterface::name()
+	 */
+	public function name(): string
+	{
+		return I18N::translate('Healthcheck Email');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface::defaultFrequency()
+	 */
+	public function defaultFrequency(): int
+	{
+		return 10080; // = 1 week = 7 * 24 * 60 min
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Tasks\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\Contracts\Tasks\ConfigurableTaskInterface::configView()
+	 */
+	public function configView(ServerRequestInterface $request): string
+	{
+		return $this->module === null ? '' : view($this->module->name() . '::tasks/healthcheck/config', [
+			'all_trees'     =>  $this->tree_service->all()
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Tasks\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 (Throwable $ex) {
+			Log::addErrorLog(
+				sprintf(
+					'Error while updating the Task schedule "%s". Exception: %s',
+					$task_schedule->id(),
+					$ex->getMessage()
+				)
+			);
+		}
+		return false;
+	}
 }

app/Helpers/functions.php

Indentation +9 added lines, -9 removed lines

@@ -28,15 +28,15 @@ 
  */
 function hook(string $hook_interface, callable $apply, $default = null)
 {
-    try {
-        $hook_collector = app(HookServiceInterface::class)->use($hook_interface);
-        if ($hook_collector !== null) {
-            return $apply($hook_collector);
-        }
-    } catch (BindingResolutionException $ex) {
-    }
+	try {
+		$hook_collector = app(HookServiceInterface::class)->use($hook_interface);
+		if ($hook_collector !== null) {
+			return $apply($hook_collector);
+		}
+	} catch (BindingResolutionException $ex) {
+	}
 
-    return $default;
+	return $default;
 }
 
 /**
@@ -48,5 +48,5 @@ 
  */
 function columnIndex(int $initial_index, Collection $new_column_indexes): int
 {
-    return $initial_index + $new_column_indexes->filter(fn(int $i) => $i <= $initial_index)->count();
+	return $initial_index + $new_column_indexes->filter(fn(int $i) => $i <= $initial_index)->count();
 }

app/Http/Middleware/AuthTreePreference.php

Indentation +32 added lines, -32 removed lines

@@ -30,43 +30,43 @@
  */
 class AuthTreePreference implements MiddlewareInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\MiddlewareInterface::process()
-     */
-    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
-    {
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-        /** @var Tree $tree */
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\MiddlewareInterface::process()
+	 */
+	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+	{
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+		/** @var Tree $tree */
 
-        $route = $request->getAttribute('route');
-        assert($route instanceof \Aura\Router\Route);
-        /** @var \Aura\Router\Route $route */
+		$route = $request->getAttribute('route');
+		assert($route instanceof \Aura\Router\Route);
+		/** @var \Aura\Router\Route $route */
 
-        $user = $request->getAttribute('user');
+		$user = $request->getAttribute('user');
 
-        $permission_preference = $route->extras['permission_preference'] ?? '';
-        $permission_level = $permission_preference === '' ? '' : $tree->getPreference($permission_preference);
+		$permission_preference = $route->extras['permission_preference'] ?? '';
+		$permission_level = $permission_preference === '' ? '' : $tree->getPreference($permission_preference);
 
-        // Permissions are configured
-        if (is_numeric($permission_level)) {
-            // Logged in with the correct role?
-            if (Auth::accessLevel($tree, $user) <= (int) $permission_level) {
-                    return $handler->handle($request);
-            }
+		// Permissions are configured
+		if (is_numeric($permission_level)) {
+			// Logged in with the correct role?
+			if (Auth::accessLevel($tree, $user) <= (int) $permission_level) {
+					return $handler->handle($request);
+			}
 
-            // Logged in, but without the correct role?
-            if ($user instanceof User) {
-                throw new HttpAccessDeniedException();
-            }
-        }
+			// Logged in, but without the correct role?
+			if ($user instanceof User) {
+				throw new HttpAccessDeniedException();
+			}
+		}
 
-        // Permissions no configured, or not logged in
-        if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
-            throw new HttpAccessDeniedException();
-        }
+		// Permissions no configured, or not logged in
+		if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
+			throw new HttpAccessDeniedException();
+		}
 
-        return redirect(route(LoginPage::class, ['tree' => $tree->name(), 'url' => $request->getUri()]));
-    }
+		return redirect(route(LoginPage::class, ['tree' => $tree->name(), 'url' => $request->getUri()]));
+	}
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResultItem.php

Indentation +57 added lines, -57 removed lines

@@ -20,67 +20,67 @@
  */
 class GeoAnalysisResultItem
 {
-    private GeoAnalysisPlace $place;
-    private int $count;
+	private GeoAnalysisPlace $place;
+	private int $count;
 
-    /**
-     * Constructor for GeoAnalysisResultItem
-     *
-     * @param GeoAnalysisPlace $place
-     * @param int $count
-     */
-    public function __construct(GeoAnalysisPlace $place, int $count = 0)
-    {
-        $this->place = $place;
-        $this->count = $count;
-    }
+	/**
+	 * Constructor for GeoAnalysisResultItem
+	 *
+	 * @param GeoAnalysisPlace $place
+	 * @param int $count
+	 */
+	public function __construct(GeoAnalysisPlace $place, int $count = 0)
+	{
+		$this->place = $place;
+		$this->count = $count;
+	}
 
-    /**
-     * Get the item key.
-     *
-     * @return string
-     */
-    public function key(): string
-    {
-        return $this->place->key();
-    }
+	/**
+	 * Get the item key.
+	 *
+	 * @return string
+	 */
+	public function key(): string
+	{
+		return $this->place->key();
+	}
 
-    /**
-     * Get the referenced GeoAnalysis Place
-     *
-     * @return GeoAnalysisPlace
-     */
-    public function place(): GeoAnalysisPlace
-    {
-        return $this->place;
-    }
+	/**
+	 * Get the referenced GeoAnalysis Place
+	 *
+	 * @return GeoAnalysisPlace
+	 */
+	public function place(): GeoAnalysisPlace
+	{
+		return $this->place;
+	}
 
-    /**
-     * Get the count of occurences of the GeoAnalysis Place in the analysis
-     *
-     * @return int
-     */
-    public function count(): int
-    {
-        return $this->count;
-    }
+	/**
+	 * Get the count of occurences of the GeoAnalysis Place in the analysis
+	 *
+	 * @return int
+	 */
+	public function count(): int
+	{
+		return $this->count;
+	}
 
-    /**
-     * Increment the count of occurrences of the GeoAnalysis Place in the analysis
-     *
-     * @return $this
-     */
-    public function increment(): self
-    {
-        $this->count++;
-        return $this;
-    }
+	/**
+	 * Increment the count of occurrences of the GeoAnalysis Place in the analysis
+	 *
+	 * @return $this
+	 */
+	public function increment(): self
+	{
+		$this->count++;
+		return $this;
+	}
 
-    /**
-     * Clone the item object
-     */
-    public function __clone()
-    {
-        $this->place = clone $this->place;
-    }
+	/**
+	 * Clone the item object
+	 */
+	public function __clone()
+	{
+		$this->place = clone $this->place;
+	}
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisPlace.php

Indentation +133 added lines, -133 removed lines

@@ -28,137 +28,137 @@
  */
 class GeoAnalysisPlace
 {
-    /**
-     * The default place name for invalid places
-     * @var string INVALID_PLACE
-     */
-    private const INVALID_PLACE = '##INVALID##';
-
-    private Place $place;
-    private int $depth;
-    private bool $strict_depth;
-    private bool $is_excluded;
-
-    /**
-     * Constructor for GeoAnalysisPlace
-     *
-     * @param Tree $tree Default tree
-     * @param Place|null $place Place resulting from the analysis
-     * @param int $depth Place hierarchy depth defined by the geographical analysis view
-     * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid
-     */
-    public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false)
-    {
-        $this->depth = $depth;
-        $this->strict_depth = $strict_depth;
-        $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree);
-        $this->is_excluded = false;
-    }
-
-    /**
-     * Process the provided Place to determine its status for further usage
-     *
-     * @param Place|null $place
-     * @param int $depth
-     * @param bool $strict_depth
-     * @return Place|NULL
-     */
-    private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place
-    {
-        if ($place === null) {
-            return null;
-        }
-        if (mb_strlen($place->gedcomName()) === 0) {
-            return null;
-        }
-        $parts = $place->lastParts($depth);
-        if ($strict_depth && $parts->count() !== $depth) {
-            return new Place(self::INVALID_PLACE, $place->tree());
-        }
-        return new Place($parts->implode(', '), $place->tree());
-    }
-
-    /**
-     * Get the GeoAnalysis Place key
-     *
-     * @return string
-     */
-    public function key(): string
-    {
-        return $this->place->gedcomName();
-    }
-
-    /**
-     * Get the underlying Place object
-     *
-     * @return Place
-     */
-    public function place(): Place
-    {
-        return $this->place;
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Known status
-     *
-     * @return bool
-     */
-    public function isKnown(): bool
-    {
-        return !$this->isUnknown();
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Unknown status
-     *
-     * @return bool
-     */
-    public function isUnknown(): bool
-    {
-        return mb_strlen($this->place->gedcomName()) === 0;
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Invalid status
-     *
-     * @return bool
-     */
-    public function isInvalid(): bool
-    {
-        return $this->place->gedcomName() === self::INVALID_PLACE;
-    }
-
-    /**
-     * Check if the GeoAnalysis Place is in the Excluded status
-     *
-     * @return bool
-     */
-    public function isExcluded(): bool
-    {
-        return $this->isUnknown() || $this->isInvalid() || $this->is_excluded;
-    }
-
-    /**
-     * Set the GeoAnalysis Place status to Found, if the parameter is true
-     *
-     * @param bool $include
-     * @return $this
-     */
-    public function include(bool $include = true): self
-    {
-        $this->is_excluded = !$include;
-        return $this;
-    }
-
-    /**
-     * Set the GeoAnalysis Place status to Excluded, if the parameter is true
-     *
-     * @param bool $exclude
-     * @return $this
-     */
-    public function exclude(bool $exclude = true): self
-    {
-        $this->is_excluded = $exclude;
-        return $this;
-    }
+	/**
+	 * The default place name for invalid places
+	 * @var string INVALID_PLACE
+	 */
+	private const INVALID_PLACE = '##INVALID##';
+
+	private Place $place;
+	private int $depth;
+	private bool $strict_depth;
+	private bool $is_excluded;
+
+	/**
+	 * Constructor for GeoAnalysisPlace
+	 *
+	 * @param Tree $tree Default tree
+	 * @param Place|null $place Place resulting from the analysis
+	 * @param int $depth Place hierarchy depth defined by the geographical analysis view
+	 * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid
+	 */
+	public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false)
+	{
+		$this->depth = $depth;
+		$this->strict_depth = $strict_depth;
+		$this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree);
+		$this->is_excluded = false;
+	}
+
+	/**
+	 * Process the provided Place to determine its status for further usage
+	 *
+	 * @param Place|null $place
+	 * @param int $depth
+	 * @param bool $strict_depth
+	 * @return Place|NULL
+	 */
+	private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place
+	{
+		if ($place === null) {
+			return null;
+		}
+		if (mb_strlen($place->gedcomName()) === 0) {
+			return null;
+		}
+		$parts = $place->lastParts($depth);
+		if ($strict_depth && $parts->count() !== $depth) {
+			return new Place(self::INVALID_PLACE, $place->tree());
+		}
+		return new Place($parts->implode(', '), $place->tree());
+	}
+
+	/**
+	 * Get the GeoAnalysis Place key
+	 *
+	 * @return string
+	 */
+	public function key(): string
+	{
+		return $this->place->gedcomName();
+	}
+
+	/**
+	 * Get the underlying Place object
+	 *
+	 * @return Place
+	 */
+	public function place(): Place
+	{
+		return $this->place;
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Known status
+	 *
+	 * @return bool
+	 */
+	public function isKnown(): bool
+	{
+		return !$this->isUnknown();
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Unknown status
+	 *
+	 * @return bool
+	 */
+	public function isUnknown(): bool
+	{
+		return mb_strlen($this->place->gedcomName()) === 0;
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Invalid status
+	 *
+	 * @return bool
+	 */
+	public function isInvalid(): bool
+	{
+		return $this->place->gedcomName() === self::INVALID_PLACE;
+	}
+
+	/**
+	 * Check if the GeoAnalysis Place is in the Excluded status
+	 *
+	 * @return bool
+	 */
+	public function isExcluded(): bool
+	{
+		return $this->isUnknown() || $this->isInvalid() || $this->is_excluded;
+	}
+
+	/**
+	 * Set the GeoAnalysis Place status to Found, if the parameter is true
+	 *
+	 * @param bool $include
+	 * @return $this
+	 */
+	public function include(bool $include = true): self
+	{
+		$this->is_excluded = !$include;
+		return $this;
+	}
+
+	/**
+	 * Set the GeoAnalysis Place status to Excluded, if the parameter is true
+	 *
+	 * @param bool $exclude
+	 * @return $this
+	 */
+	public function exclude(bool $exclude = true): self
+	{
+		$this->is_excluded = $exclude;
+		return $this;
+	}
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResult.php

Indentation +221 added lines, -221 removed lines

@@ -24,225 +24,225 @@
  */
 class GeoAnalysisResult
 {
-    private string $description;
-    private int $order;
-    private int $unknown_count;
-    /**
-     * @var Collection<GeoAnalysisResultItem>
-     */
-    private Collection $places;
-
-    /**
-     * Constructor for GeoAnalysisResult
-     *
-     * @param string $description
-     * @param int $order
-     * @param Collection<GeoAnalysisResultItem> $places
-     * @param int $unknown
-     */
-    final public function __construct(
-        string $description,
-        int $order = 0,
-        Collection $places = null,
-        int $unknown = 0
-    ) {
-        $this->description = $description;
-        $this->order = $order;
-        $this->places = $places ?? new Collection();
-        $this->unknown_count = $unknown;
-    }
-
-    /**
-     * Get the category description
-     *
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description;
-    }
-
-    /**
-     * Get the category order
-     *
-     * @return int
-     */
-    public function order(): int
-    {
-        return $this->order;
-    }
-
-    /**
-     * Add a place to the analysis result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlace(GeoAnalysisPlace $place): void
-    {
-        if ($place->isKnown()) {
-            /** @var GeoAnalysisResultItem $item */
-            $item = $this->places->get($place->key(), new GeoAnalysisResultItem($place));
-            $this->places->put($item->key(), $item->increment());
-        } else {
-            $this->addUnknown();
-        }
-    }
-
-    /**
-     * Exclude a place from the analysis result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function exclude(GeoAnalysisPlace $place): void
-    {
-        /** @var GeoAnalysisResultItem|null $item */
-        $item = $this->places->get($place->key());
-        if ($item !== null) {
-            $item->place()->exclude();
-        }
-    }
-
-    /**
-     * Add an unknown place to the analysis result
-     */
-    public function addUnknown(): void
-    {
-        $this->unknown_count++;
-    }
-
-    /**
-     * Take a copy of the current analysis result
-     *
-     * @return static
-     */
-    public function copy(): self
-    {
-        return new static(
-            $this->description(),
-            $this->order(),
-            $this->places->map(fn(GeoAnalysisResultItem $item): GeoAnalysisResultItem => clone $item),
-            $this->countUnknown()
-        );
-    }
-
-    /**
-     * Merge the current analysis result with another.
-     * The current object is modified, not the second one.
-     *
-     * @param GeoAnalysisResult $other
-     * @return $this
-     */
-    public function merge(GeoAnalysisResult $other): self
-    {
-        $this->places->each(function (GeoAnalysisResultItem $item) use ($other): void {
-            if ($other->places->has($item->key())) {
-                $item->place()->exclude(
-                    $item->place()->isExcluded()
-                    && $other->places->get($item->key())->place()->isExcluded()
-                );
-            }
-        });
-
-        $other->places->each(function (GeoAnalysisResultItem $item): void {
-            if (!$this->places->has($item->key())) {
-                $this->addPlace($item->place());
-            }
-        });
-
-        return $this;
-    }
-
-    /**
-     * Get the count of Known places
-     *
-     * @return int
-     */
-    public function countKnown(): int
-    {
-        return $this->places->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the count of Found places
-     *
-     * @return int
-     */
-    public function countFound(): int
-    {
-        return $this->places
-            ->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
-            ->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the count of Excluded places
-     *
-     * @return int
-     */
-    public function countExcluded(): int
-    {
-        return $this->places
-            ->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
-            ->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the count of Unknown places
-     *
-     * @return int
-     */
-    public function countUnknown(): int
-    {
-        return $this->unknown_count;
-    }
-
-    /**
-     * Get the count of the most represented Place in the analysis result
-     *
-     * @return int
-     */
-    public function maxCount(): int
-    {
-        return $this->places->max(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-
-    /**
-     * Get the list of Known places with their associated count
-     *
-     * @param bool $exclude_other
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function knownPlaces(bool $exclude_other = false): Collection
-    {
-        if ($exclude_other) {
-            return $this->places->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
-        }
-        return $this->places;
-    }
-
-    /**
-     * Get the list of Known places with their associated count.
-     * The list is sorted first by descending count, then by ascending Place name
-     *
-     * @param bool $exclude_other
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function sortedKnownPlaces(bool $exclude_other = false): Collection
-    {
-        return $this->knownPlaces($exclude_other)->sortBy([
-            fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => $b->count() <=> $a->count(),
-            fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int =>
-                I18N::comparator()($a->place()->place()->gedcomName(), $b->place()->place()->gedcomName())
-        ]);
-    }
-
-    /**
-     * Get the list of Excluded places
-     *
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function excludedPlaces(): Collection
-    {
-        return $this->places->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
-    }
+	private string $description;
+	private int $order;
+	private int $unknown_count;
+	/**
+	 * @var Collection<GeoAnalysisResultItem>
+	 */
+	private Collection $places;
+
+	/**
+	 * Constructor for GeoAnalysisResult
+	 *
+	 * @param string $description
+	 * @param int $order
+	 * @param Collection<GeoAnalysisResultItem> $places
+	 * @param int $unknown
+	 */
+	final public function __construct(
+		string $description,
+		int $order = 0,
+		Collection $places = null,
+		int $unknown = 0
+	) {
+		$this->description = $description;
+		$this->order = $order;
+		$this->places = $places ?? new Collection();
+		$this->unknown_count = $unknown;
+	}
+
+	/**
+	 * Get the category description
+	 *
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description;
+	}
+
+	/**
+	 * Get the category order
+	 *
+	 * @return int
+	 */
+	public function order(): int
+	{
+		return $this->order;
+	}
+
+	/**
+	 * Add a place to the analysis result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlace(GeoAnalysisPlace $place): void
+	{
+		if ($place->isKnown()) {
+			/** @var GeoAnalysisResultItem $item */
+			$item = $this->places->get($place->key(), new GeoAnalysisResultItem($place));
+			$this->places->put($item->key(), $item->increment());
+		} else {
+			$this->addUnknown();
+		}
+	}
+
+	/**
+	 * Exclude a place from the analysis result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function exclude(GeoAnalysisPlace $place): void
+	{
+		/** @var GeoAnalysisResultItem|null $item */
+		$item = $this->places->get($place->key());
+		if ($item !== null) {
+			$item->place()->exclude();
+		}
+	}
+
+	/**
+	 * Add an unknown place to the analysis result
+	 */
+	public function addUnknown(): void
+	{
+		$this->unknown_count++;
+	}
+
+	/**
+	 * Take a copy of the current analysis result
+	 *
+	 * @return static
+	 */
+	public function copy(): self
+	{
+		return new static(
+			$this->description(),
+			$this->order(),
+			$this->places->map(fn(GeoAnalysisResultItem $item): GeoAnalysisResultItem => clone $item),
+			$this->countUnknown()
+		);
+	}
+
+	/**
+	 * Merge the current analysis result with another.
+	 * The current object is modified, not the second one.
+	 *
+	 * @param GeoAnalysisResult $other
+	 * @return $this
+	 */
+	public function merge(GeoAnalysisResult $other): self
+	{
+		$this->places->each(function (GeoAnalysisResultItem $item) use ($other): void {
+			if ($other->places->has($item->key())) {
+				$item->place()->exclude(
+					$item->place()->isExcluded()
+					&& $other->places->get($item->key())->place()->isExcluded()
+				);
+			}
+		});
+
+		$other->places->each(function (GeoAnalysisResultItem $item): void {
+			if (!$this->places->has($item->key())) {
+				$this->addPlace($item->place());
+			}
+		});
+
+		return $this;
+	}
+
+	/**
+	 * Get the count of Known places
+	 *
+	 * @return int
+	 */
+	public function countKnown(): int
+	{
+		return $this->places->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the count of Found places
+	 *
+	 * @return int
+	 */
+	public function countFound(): int
+	{
+		return $this->places
+			->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
+			->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the count of Excluded places
+	 *
+	 * @return int
+	 */
+	public function countExcluded(): int
+	{
+		return $this->places
+			->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
+			->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the count of Unknown places
+	 *
+	 * @return int
+	 */
+	public function countUnknown(): int
+	{
+		return $this->unknown_count;
+	}
+
+	/**
+	 * Get the count of the most represented Place in the analysis result
+	 *
+	 * @return int
+	 */
+	public function maxCount(): int
+	{
+		return $this->places->max(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+
+	/**
+	 * Get the list of Known places with their associated count
+	 *
+	 * @param bool $exclude_other
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function knownPlaces(bool $exclude_other = false): Collection
+	{
+		if ($exclude_other) {
+			return $this->places->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
+		}
+		return $this->places;
+	}
+
+	/**
+	 * Get the list of Known places with their associated count.
+	 * The list is sorted first by descending count, then by ascending Place name
+	 *
+	 * @param bool $exclude_other
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function sortedKnownPlaces(bool $exclude_other = false): Collection
+	{
+		return $this->knownPlaces($exclude_other)->sortBy([
+			fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => $b->count() <=> $a->count(),
+			fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int =>
+				I18N::comparator()($a->place()->place()->gedcomName(), $b->place()->place()->gedcomName())
+		]);
+	}
+
+	/**
+	 * Get the list of Excluded places
+	 *
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function excludedPlaces(): Collection
+	{
+		return $this->places->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
+	}
 }