jon48 / webtrees-lib

app/Module/AdminTasks/Tasks/HealthCheckEmailTask.php

Indentation +162 added lines, -162 removed lines

@@ -41,166 +41,166 @@
  */
 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 =
-            Registry::timestampFactory()->now()->timestamp() -  $task_schedule->lastRunTime()->timestamp();
-        $task_freq_seconds = 60 * $task_schedule->frequency();
-        $interval = $interval_lastrun > $task_freq_seconds ? $interval_lastrun : $task_freq_seconds;
-        $nb_days = (int) CarbonInterval::seconds($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 = $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 {
-            $validator = Validator::parsedBody($request);
-
-            foreach ($this->tree_service->all() as $tree) {
-                if (Auth::isManager($tree)) {
-                    $tree_enabled = $validator->boolean('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 =
+			Registry::timestampFactory()->now()->timestamp() -  $task_schedule->lastRunTime()->timestamp();
+		$task_freq_seconds = 60 * $task_schedule->frequency();
+		$interval = $interval_lastrun > $task_freq_seconds ? $interval_lastrun : $task_freq_seconds;
+		$nb_days = (int) CarbonInterval::seconds($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 = $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 {
+			$validator = Validator::parsedBody($request);
+
+			foreach ($this->tree_service->all() as $tree) {
+				if (Auth::isManager($tree)) {
+					$tree_enabled = $validator->boolean('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/Module/AdminTasks/Services/TaskScheduleService.php

Indentation +271 added lines, -271 removed lines

@@ -35,275 +35,275 @@
  */
 class TaskScheduleService
 {
-    /**
-     * Time-out after which the task will be considered not running any more.
-     * In seconds, default 5 mins.
-     * @var integer
-     */
-    public const TASK_TIME_OUT = 600;
-
-    private ModuleService $module_service;
-
-    /**
-     * Constructor for TaskScheduleService
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module_service = $module_service;
-    }
-
-    /**
-     * Returns all Tasks schedules in database.
-     * Stored records can be synchronised with the tasks actually available to the system.
-     *
-     * @param bool $sync_available Should tasks synchronised with available ones
-     * @param bool $include_disabled Should disabled tasks be returned
-     * @return Collection<TaskSchedule> Collection of TaskSchedule
-     */
-    public function all(bool $sync_available = false, bool $include_disabled = true): Collection
-    {
-        $tasks_schedules = DB::table('maj_admintasks')
-            ->select()
-            ->get()
-            ->map(self::rowMapper());
-
-        if ($sync_available) {
-            $available_tasks = clone $this->available();
-            foreach ($tasks_schedules as $task_schedule) {
-                /** @var TaskSchedule $task_schedule */
-                if ($available_tasks->has($task_schedule->taskId())) {
-                    $available_tasks->forget($task_schedule->taskId());
-                } else {
-                    $this->delete($task_schedule);
-                }
-            }
-
-            foreach ($available_tasks as $task_name => $task_class) {
-                if (null !== $task = app($task_class)) {
-                    $this->insertTask($task_name, $task->defaultFrequency());
-                }
-            }
-
-            return $this->all(false, $include_disabled);
-        }
-
-        return $tasks_schedules;
-    }
-
-    /**
-     * Returns tasks exposed through modules implementing ModuleTasksProviderInterface.
-     *
-     * @return Collection<string, string>
-     */
-    public function available(): Collection
-    {
-        return Registry::cache()->array()->remember(
-            'maj-available-admintasks',
-            function (): Collection {
-                /** @var Collection<string, string> $tasks */
-                $tasks = $this->module_service
-                    ->findByInterface(ModuleTasksProviderInterface::class)
-                    ->flatMap(fn(ModuleTasksProviderInterface $module) => $module->listTasks());
-                return $tasks;
-            }
-        );
-    }
-
-    /**
-     * Find a task schedule by its ID.
-     *
-     * @param int $task_schedule_id
-     * @return TaskSchedule|NULL
-     */
-    public function find(int $task_schedule_id): ?TaskSchedule
-    {
-        return DB::table('maj_admintasks')
-            ->select()
-            ->where('majat_id', '=', $task_schedule_id)
-            ->get()
-            ->map(self::rowMapper())
-            ->first();
-    }
-
-    /**
-     * Add a new task schedule with the specified task ID, and frequency if defined.
-     * Uses default for other settings.
-     *
-     * @param string $task_id
-     * @param int $frequency
-     * @return bool
-     */
-    public function insertTask(string $task_id, int $frequency = 0): bool
-    {
-        $values = ['majat_task_id' => $task_id];
-        if ($frequency > 0) {
-            $values['majat_frequency'] = $frequency;
-        }
-
-        return DB::table('maj_admintasks')
-            ->insert($values);
-    }
-
-    /**
-     * Update a task schedule.
-     * Returns the number of tasks schedules updated.
-     *
-     * @param TaskSchedule $task_schedule
-     * @return int
-     */
-    public function update(TaskSchedule $task_schedule): int
-    {
-        return DB::table('maj_admintasks')
-            ->where('majat_id', '=', $task_schedule->id())
-            ->update([
-                'majat_status'      =>  $task_schedule->isEnabled() ? 'enabled' : 'disabled',
-                'majat_last_run'    =>  $task_schedule->lastRunTime()->toDateTimeString(),
-                'majat_last_result' =>  $task_schedule->wasLastRunSuccess(),
-                'majat_frequency'   =>  $task_schedule->frequency(),
-                'majat_nb_occur'    =>  $task_schedule->remainingOccurrences(),
-                'majat_running'     =>  $task_schedule->isRunning()
-            ]);
-    }
-
-    /**
-     * Delete a task schedule.
-     *
-     * @param TaskSchedule $task_schedule
-     * @return int
-     */
-    public function delete(TaskSchedule $task_schedule): int
-    {
-        return DB::table('maj_admintasks')
-            ->where('majat_id', '=', $task_schedule->id())
-            ->delete();
-    }
-
-    /**
-     * Find a task by its name
-     *
-     * @param string $task_id
-     * @return TaskInterface|NULL
-     */
-    public function findTask(string $task_id): ?TaskInterface
-    {
-        if ($this->available()->has($task_id)) {
-            return app($this->available()->get($task_id));
-        }
-        return null;
-    }
-
-    /**
-     * Retrieve all tasks that are candidates to be run.
-     *
-     * @param bool $force Should the run be forced
-     * @param string $task_id Specific task ID to be run
-     * @return Collection<TaskSchedule>
-     */
-    public function findTasksToRun(bool $force, string $task_id = null): Collection
-    {
-        $query = DB::table('maj_admintasks')
-            ->select()
-            ->where('majat_status', '=', 'enabled')
-            ->where(function (Builder $query): void {
-
-                $query->where('majat_running', '=', 0)
-                ->orWhere(
-                    'majat_last_run',
-                    '<=',
-                    Registry::timestampFactory()->now()->addSeconds(-self::TASK_TIME_OUT)->toDateTimeString()
-                );
-            });
-
-        if (!$force) {
-            $query->where(function (Builder $query): void {
-
-                $query->where('majat_running', '=', 0)
-                    ->orWhereRaw('DATE_ADD(majat_last_run, INTERVAL majat_frequency MINUTE) <= NOW()');
-            });
-        }
-
-        if ($task_id !== null) {
-            $query->where('majat_task_id', '=', $task_id);
-        }
-
-        return $query->get()->map(self::rowMapper());
-    }
-
-    /**
-     * Run the task associated with the schedule.
-     * The task will run if either forced to, or its next scheduled run time has been exceeded.
-     * The last run time is recorded only if the task is successful.
-     *
-     * @param TaskSchedule $task_schedule
-     * @param boolean $force
-     */
-    public function run(TaskSchedule $task_schedule, $force = false): void
-    {
-        /** @var TaskSchedule $task_schedule */
-        $task_schedule = DB::table('maj_admintasks')
-            ->select()
-            ->where('majat_id', '=', $task_schedule->id())
-            ->lockForUpdate()
-            ->get()
-            ->map(self::rowMapper())
-            ->first();
-
-        if (
-            !$task_schedule->isRunning() &&
-            ($force ||
-                $task_schedule->lastRunTime()->addMinutes($task_schedule->frequency())
-                    ->compare(Registry::timestampFactory()->now()) < 0
-            )
-        ) {
-            $task_schedule->setLastResult(false);
-
-            $task = $this->findTask($task_schedule->taskId());
-            if ($task !== null) {
-                $task_schedule->startRunning();
-                $this->update($task_schedule);
-
-                $first_error = $task_schedule->wasLastRunSuccess();
-                try {
-                    $task_schedule->setLastResult($task->run($task_schedule));
-                } catch (Throwable $ex) {
-                    if ($first_error) { // Only record the first error, as this could fill the log.
-                        Log::addErrorLog(I18N::translate('Error while running task %s:', $task->name()) . ' ' .
-                            '[' . get_class($ex) . '] ' . $ex->getMessage() . ' ' . $ex->getFile() . ':'
-                            . $ex->getLine() . PHP_EOL . $ex->getTraceAsString());
-                    }
-                }
-
-                if ($task_schedule->wasLastRunSuccess()) {
-                    $task_schedule->setLastRunTime(Registry::timestampFactory()->now());
-                    $task_schedule->decrementRemainingOccurrences();
-                }
-                $task_schedule->stopRunning();
-            }
-            $this->update($task_schedule);
-        }
-    }
-
-    /**
-     * Mapper to return a TaskSchedule object from an object.
-     *
-     * @return Closure(stdClass $row): TaskSchedule
-     */
-    public static function rowMapper(): Closure
-    {
-        return static function (stdClass $row): TaskSchedule {
-
-            return new TaskSchedule(
-                (int) $row->majat_id,
-                $row->majat_task_id,
-                $row->majat_status === 'enabled',
-                Registry::timestampFactory()->fromString($row->majat_last_run),
-                (bool) $row->majat_last_result,
-                (int) $row->majat_frequency,
-                (int) $row->majat_nb_occur,
-                (bool) $row->majat_running
-            );
-        };
-    }
+	/**
+	 * Time-out after which the task will be considered not running any more.
+	 * In seconds, default 5 mins.
+	 * @var integer
+	 */
+	public const TASK_TIME_OUT = 600;
+
+	private ModuleService $module_service;
+
+	/**
+	 * Constructor for TaskScheduleService
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module_service = $module_service;
+	}
+
+	/**
+	 * Returns all Tasks schedules in database.
+	 * Stored records can be synchronised with the tasks actually available to the system.
+	 *
+	 * @param bool $sync_available Should tasks synchronised with available ones
+	 * @param bool $include_disabled Should disabled tasks be returned
+	 * @return Collection<TaskSchedule> Collection of TaskSchedule
+	 */
+	public function all(bool $sync_available = false, bool $include_disabled = true): Collection
+	{
+		$tasks_schedules = DB::table('maj_admintasks')
+			->select()
+			->get()
+			->map(self::rowMapper());
+
+		if ($sync_available) {
+			$available_tasks = clone $this->available();
+			foreach ($tasks_schedules as $task_schedule) {
+				/** @var TaskSchedule $task_schedule */
+				if ($available_tasks->has($task_schedule->taskId())) {
+					$available_tasks->forget($task_schedule->taskId());
+				} else {
+					$this->delete($task_schedule);
+				}
+			}
+
+			foreach ($available_tasks as $task_name => $task_class) {
+				if (null !== $task = app($task_class)) {
+					$this->insertTask($task_name, $task->defaultFrequency());
+				}
+			}
+
+			return $this->all(false, $include_disabled);
+		}
+
+		return $tasks_schedules;
+	}
+
+	/**
+	 * Returns tasks exposed through modules implementing ModuleTasksProviderInterface.
+	 *
+	 * @return Collection<string, string>
+	 */
+	public function available(): Collection
+	{
+		return Registry::cache()->array()->remember(
+			'maj-available-admintasks',
+			function (): Collection {
+				/** @var Collection<string, string> $tasks */
+				$tasks = $this->module_service
+					->findByInterface(ModuleTasksProviderInterface::class)
+					->flatMap(fn(ModuleTasksProviderInterface $module) => $module->listTasks());
+				return $tasks;
+			}
+		);
+	}
+
+	/**
+	 * Find a task schedule by its ID.
+	 *
+	 * @param int $task_schedule_id
+	 * @return TaskSchedule|NULL
+	 */
+	public function find(int $task_schedule_id): ?TaskSchedule
+	{
+		return DB::table('maj_admintasks')
+			->select()
+			->where('majat_id', '=', $task_schedule_id)
+			->get()
+			->map(self::rowMapper())
+			->first();
+	}
+
+	/**
+	 * Add a new task schedule with the specified task ID, and frequency if defined.
+	 * Uses default for other settings.
+	 *
+	 * @param string $task_id
+	 * @param int $frequency
+	 * @return bool
+	 */
+	public function insertTask(string $task_id, int $frequency = 0): bool
+	{
+		$values = ['majat_task_id' => $task_id];
+		if ($frequency > 0) {
+			$values['majat_frequency'] = $frequency;
+		}
+
+		return DB::table('maj_admintasks')
+			->insert($values);
+	}
+
+	/**
+	 * Update a task schedule.
+	 * Returns the number of tasks schedules updated.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @return int
+	 */
+	public function update(TaskSchedule $task_schedule): int
+	{
+		return DB::table('maj_admintasks')
+			->where('majat_id', '=', $task_schedule->id())
+			->update([
+				'majat_status'      =>  $task_schedule->isEnabled() ? 'enabled' : 'disabled',
+				'majat_last_run'    =>  $task_schedule->lastRunTime()->toDateTimeString(),
+				'majat_last_result' =>  $task_schedule->wasLastRunSuccess(),
+				'majat_frequency'   =>  $task_schedule->frequency(),
+				'majat_nb_occur'    =>  $task_schedule->remainingOccurrences(),
+				'majat_running'     =>  $task_schedule->isRunning()
+			]);
+	}
+
+	/**
+	 * Delete a task schedule.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @return int
+	 */
+	public function delete(TaskSchedule $task_schedule): int
+	{
+		return DB::table('maj_admintasks')
+			->where('majat_id', '=', $task_schedule->id())
+			->delete();
+	}
+
+	/**
+	 * Find a task by its name
+	 *
+	 * @param string $task_id
+	 * @return TaskInterface|NULL
+	 */
+	public function findTask(string $task_id): ?TaskInterface
+	{
+		if ($this->available()->has($task_id)) {
+			return app($this->available()->get($task_id));
+		}
+		return null;
+	}
+
+	/**
+	 * Retrieve all tasks that are candidates to be run.
+	 *
+	 * @param bool $force Should the run be forced
+	 * @param string $task_id Specific task ID to be run
+	 * @return Collection<TaskSchedule>
+	 */
+	public function findTasksToRun(bool $force, string $task_id = null): Collection
+	{
+		$query = DB::table('maj_admintasks')
+			->select()
+			->where('majat_status', '=', 'enabled')
+			->where(function (Builder $query): void {
+
+				$query->where('majat_running', '=', 0)
+				->orWhere(
+					'majat_last_run',
+					'<=',
+					Registry::timestampFactory()->now()->addSeconds(-self::TASK_TIME_OUT)->toDateTimeString()
+				);
+			});
+
+		if (!$force) {
+			$query->where(function (Builder $query): void {
+
+				$query->where('majat_running', '=', 0)
+					->orWhereRaw('DATE_ADD(majat_last_run, INTERVAL majat_frequency MINUTE) <= NOW()');
+			});
+		}
+
+		if ($task_id !== null) {
+			$query->where('majat_task_id', '=', $task_id);
+		}
+
+		return $query->get()->map(self::rowMapper());
+	}
+
+	/**
+	 * Run the task associated with the schedule.
+	 * The task will run if either forced to, or its next scheduled run time has been exceeded.
+	 * The last run time is recorded only if the task is successful.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @param boolean $force
+	 */
+	public function run(TaskSchedule $task_schedule, $force = false): void
+	{
+		/** @var TaskSchedule $task_schedule */
+		$task_schedule = DB::table('maj_admintasks')
+			->select()
+			->where('majat_id', '=', $task_schedule->id())
+			->lockForUpdate()
+			->get()
+			->map(self::rowMapper())
+			->first();
+
+		if (
+			!$task_schedule->isRunning() &&
+			($force ||
+				$task_schedule->lastRunTime()->addMinutes($task_schedule->frequency())
+					->compare(Registry::timestampFactory()->now()) < 0
+			)
+		) {
+			$task_schedule->setLastResult(false);
+
+			$task = $this->findTask($task_schedule->taskId());
+			if ($task !== null) {
+				$task_schedule->startRunning();
+				$this->update($task_schedule);
+
+				$first_error = $task_schedule->wasLastRunSuccess();
+				try {
+					$task_schedule->setLastResult($task->run($task_schedule));
+				} catch (Throwable $ex) {
+					if ($first_error) { // Only record the first error, as this could fill the log.
+						Log::addErrorLog(I18N::translate('Error while running task %s:', $task->name()) . ' ' .
+							'[' . get_class($ex) . '] ' . $ex->getMessage() . ' ' . $ex->getFile() . ':'
+							. $ex->getLine() . PHP_EOL . $ex->getTraceAsString());
+					}
+				}
+
+				if ($task_schedule->wasLastRunSuccess()) {
+					$task_schedule->setLastRunTime(Registry::timestampFactory()->now());
+					$task_schedule->decrementRemainingOccurrences();
+				}
+				$task_schedule->stopRunning();
+			}
+			$this->update($task_schedule);
+		}
+	}
+
+	/**
+	 * Mapper to return a TaskSchedule object from an object.
+	 *
+	 * @return Closure(stdClass $row): TaskSchedule
+	 */
+	public static function rowMapper(): Closure
+	{
+		return static function (stdClass $row): TaskSchedule {
+
+			return new TaskSchedule(
+				(int) $row->majat_id,
+				$row->majat_task_id,
+				$row->majat_status === 'enabled',
+				Registry::timestampFactory()->fromString($row->majat_last_run),
+				(bool) $row->majat_last_result,
+				(int) $row->majat_frequency,
+				(int) $row->majat_nb_occur,
+				(bool) $row->majat_running
+			);
+		};
+	}
 }

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 occurrence of the same error message
-     *          - lastoccurred: Date/time of the last occurrence 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 occurrence of the same error message
+	 *          - lastoccurred: Date/time of the last occurrence 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/GeoDispersion/Views/GeoAnalysisMap.php

Indentation +113 added lines, -113 removed lines

@@ -32,117 +32,117 @@
  */
 class GeoAnalysisMap extends AbstractGeoAnalysisView
 {
-    private ?MapColorsConfig $colors_config = null;
-
-    public function type(): string
-    {
-        return I18N::translateContext('GEODISPERSION', 'Map');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::icon()
-     */
-    public function icon(ModuleInterface $module): string
-    {
-        return view($module->name() . '::icons/view-map', ['type' => $this->type()]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalSettingsContent()
-     */
-    public function globalSettingsContent(ModuleInterface $module): string
-    {
-        return view($module->name() . '::admin/view-edit-map', [
-            'module_name'   =>  $module->name(),
-            'view'          =>  $this,
-            'colors'        =>  $this->colors(),
-            'map_adapters'  =>  app(MapAdapterDataService::class)->allForView($this, true)
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::withGlobalSettingsUpdate()
-     * @return static
-     */
-    public function withGlobalSettingsUpdate(ServerRequestInterface $request): self
-    {
-        $default_color  = Validator::parsedBody($request)->string('view_map_color_default', '');
-        $stroke_color   = Validator::parsedBody($request)->string('view_map_color_stroke', '');
-        $maxvalue_color  = Validator::parsedBody($request)->string('view_map_color_maxvalue', '');
-        $hover_color  = Validator::parsedBody($request)->string('view_map_color_hover', '');
-
-        try {
-            return $this->withColors(new MapColorsConfig(
-                Hex::fromString($default_color),
-                Hex::fromString($stroke_color),
-                Hex::fromString($maxvalue_color),
-                Hex::fromString($hover_color)
-            ));
-        } catch (InvalidColorValue $ex) {
-        }
-
-        return $this;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalTabContent()
-     */
-    public function globalTabContent(GeoDispersionModule $module, GeoAnalysisResult $result, array $params): string
-    {
-        $map_adapters = app(MapAdapterDataService::class)->allForView($this);
-
-        $adapter_result = null;
-        foreach ($map_adapters as $map_adapter) {
-            $adapter_result_tmp = $map_adapter->convert($result);
-            $adapter_result = $adapter_result === null ?
-                $adapter_result_tmp :
-                $adapter_result->merge($adapter_result_tmp);
-        }
-
-        if ($adapter_result === null) {
-            return view($module->name() . '::errors/tab-error', [
-                'message'   =>  I18N::translate('The map could not be loaded.'),
-            ]);
-        }
-
-        return view($module->name() . '::geoanalysisview-tab-glb-map', $params + [
-            'result'            =>  $adapter_result->geoAnalysisResult(),
-            'features'          =>  $adapter_result->features(),
-            'colors'            =>  $this->colors(),
-            'leaflet_config'    =>  app(LeafletJsService::class)->config(),
-            'js_script_url'     =>  $module->assetUrl('js/geodispersion.min.js')
-        ]);
-    }
-
-    /**
-     * Get the color scheme configuration for the map view
-     *
-     * @return MapColorsConfig
-     */
-    public function colors(): MapColorsConfig
-    {
-        return $this->colors_config ?? new MapColorsConfig(
-            new Rgb(245, 245, 245),
-            new Rgb(213, 213, 213),
-            new Rgb(4, 147, 171),
-            new Rgb(255, 102, 0)
-        );
-    }
-
-    /**
-     * Returns a map view with a new color scheme configuration
-     *
-     * @param MapColorsConfig $config
-     * @return static
-     */
-    public function withColors(?MapColorsConfig $config): self
-    {
-        $new = clone $this;
-        $new->colors_config = $config;
-        return $new;
-    }
+	private ?MapColorsConfig $colors_config = null;
+
+	public function type(): string
+	{
+		return I18N::translateContext('GEODISPERSION', 'Map');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::icon()
+	 */
+	public function icon(ModuleInterface $module): string
+	{
+		return view($module->name() . '::icons/view-map', ['type' => $this->type()]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalSettingsContent()
+	 */
+	public function globalSettingsContent(ModuleInterface $module): string
+	{
+		return view($module->name() . '::admin/view-edit-map', [
+			'module_name'   =>  $module->name(),
+			'view'          =>  $this,
+			'colors'        =>  $this->colors(),
+			'map_adapters'  =>  app(MapAdapterDataService::class)->allForView($this, true)
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::withGlobalSettingsUpdate()
+	 * @return static
+	 */
+	public function withGlobalSettingsUpdate(ServerRequestInterface $request): self
+	{
+		$default_color  = Validator::parsedBody($request)->string('view_map_color_default', '');
+		$stroke_color   = Validator::parsedBody($request)->string('view_map_color_stroke', '');
+		$maxvalue_color  = Validator::parsedBody($request)->string('view_map_color_maxvalue', '');
+		$hover_color  = Validator::parsedBody($request)->string('view_map_color_hover', '');
+
+		try {
+			return $this->withColors(new MapColorsConfig(
+				Hex::fromString($default_color),
+				Hex::fromString($stroke_color),
+				Hex::fromString($maxvalue_color),
+				Hex::fromString($hover_color)
+			));
+		} catch (InvalidColorValue $ex) {
+		}
+
+		return $this;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalTabContent()
+	 */
+	public function globalTabContent(GeoDispersionModule $module, GeoAnalysisResult $result, array $params): string
+	{
+		$map_adapters = app(MapAdapterDataService::class)->allForView($this);
+
+		$adapter_result = null;
+		foreach ($map_adapters as $map_adapter) {
+			$adapter_result_tmp = $map_adapter->convert($result);
+			$adapter_result = $adapter_result === null ?
+				$adapter_result_tmp :
+				$adapter_result->merge($adapter_result_tmp);
+		}
+
+		if ($adapter_result === null) {
+			return view($module->name() . '::errors/tab-error', [
+				'message'   =>  I18N::translate('The map could not be loaded.'),
+			]);
+		}
+
+		return view($module->name() . '::geoanalysisview-tab-glb-map', $params + [
+			'result'            =>  $adapter_result->geoAnalysisResult(),
+			'features'          =>  $adapter_result->features(),
+			'colors'            =>  $this->colors(),
+			'leaflet_config'    =>  app(LeafletJsService::class)->config(),
+			'js_script_url'     =>  $module->assetUrl('js/geodispersion.min.js')
+		]);
+	}
+
+	/**
+	 * Get the color scheme configuration for the map view
+	 *
+	 * @return MapColorsConfig
+	 */
+	public function colors(): MapColorsConfig
+	{
+		return $this->colors_config ?? new MapColorsConfig(
+			new Rgb(245, 245, 245),
+			new Rgb(213, 213, 213),
+			new Rgb(4, 147, 171),
+			new Rgb(255, 102, 0)
+		);
+	}
+
+	/**
+	 * Returns a map view with a new color scheme configuration
+	 *
+	 * @param MapColorsConfig $config
+	 * @return static
+	 */
+	public function withColors(?MapColorsConfig $config): self
+	{
+		$new = clone $this;
+		$new->colors_config = $config;
+		return $new;
+	}
 }

app/Module/GeoDispersion/Schema/Migration0.php

Indentation +8 added lines, -8 removed lines

@@ -21,12 +21,12 @@
  */
 class Migration0 implements MigrationInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        // This migration has been superseded by migration 1.
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		// This migration has been superseded by migration 1.
+	}
 }

app/Module/GeoDispersion/Schema/Migration2.php

Indentation +193 added lines, -193 removed lines

@@ -39,219 +39,219 @@
  */
 class Migration2 implements MigrationInterface
 {
-    /**
-     * Mapping from old map definitions to new ones
-     * @var array<string,mixed> MAPS_XML_MAPPING
-     */
-    private const MAPS_XML_MAPPING = [
-        'aubracmargeridebycommunes.xml' =>  'fr-area-aubrac-lot-margeride-planeze-communes',
-        'calvadosbycommunes.xml'        =>  'fr-dpt-14-communes',
-        'cantalbycommunes.xml'          =>  'fr-dpt-15-communes',
-        'cotesdarmorbycommunes.xml'     =>  'fr-dpt-22-communes',
-        'essonnebycommunes.xml'         =>  'fr-dpt-91-communes',
-        'eurebycommunes.xml'            =>  'fr-dpt-27-communes',
-        'eureetloirbycommunes.xml'      =>  'fr-dpt-28-communes',
-        'francebydepartements.xml'      =>  'fr-metropole-departements',
-        'francebyregions1970.xml'       =>  'fr-metropole-regions-1970',
-        'francebyregions2016.xml'       =>  'fr-metropole-regions-2016',
-        'hauteloirebycommunes.xml'      =>  'fr-dpt-43-communes',
-        'illeetvilainebycommunes.xml'   =>  'fr-dpt-35-communes',
-        'loiretbycommunes.xml'          =>  'fr-dpt-45-communes',
-        'lozerebycodepostaux.xml'       =>  'fr-dpt-48-codespostaux',
-        'lozerebycommunes.xml'          =>  'fr-dpt-48-communes',
-        'mayennebycommunes.xml'         =>  'fr-dpt-53-communes',
-        'oisebycommunes.xml'            =>  'fr-dpt-60-communes',
-        'ornebycommunes.xml'            =>  'fr-dpt-61-communes',
-        'puydedomebycommunes.xml'       =>  'fr-dpt-63-communes',
-        'sarthebycommunes.xml'          =>  'fr-dpt-72-communes',
-        'seinemaritimebycommunes.xml'   =>  'fr-dpt-76-communes',
-        'seinesommeoisebycommunes.xml'  =>  ['fr-dpt-60-communes', 'fr-dpt-76-communes', 'fr-dpt-80-communes'],
-        'valdoisebycommunes.xml'        =>  'fr-dpt-95-communes',
-        'yvelinesbycommunes.xml'        =>  'fr-dpt-78-communes'
-    ];
+	/**
+	 * Mapping from old map definitions to new ones
+	 * @var array<string,mixed> MAPS_XML_MAPPING
+	 */
+	private const MAPS_XML_MAPPING = [
+		'aubracmargeridebycommunes.xml' =>  'fr-area-aubrac-lot-margeride-planeze-communes',
+		'calvadosbycommunes.xml'        =>  'fr-dpt-14-communes',
+		'cantalbycommunes.xml'          =>  'fr-dpt-15-communes',
+		'cotesdarmorbycommunes.xml'     =>  'fr-dpt-22-communes',
+		'essonnebycommunes.xml'         =>  'fr-dpt-91-communes',
+		'eurebycommunes.xml'            =>  'fr-dpt-27-communes',
+		'eureetloirbycommunes.xml'      =>  'fr-dpt-28-communes',
+		'francebydepartements.xml'      =>  'fr-metropole-departements',
+		'francebyregions1970.xml'       =>  'fr-metropole-regions-1970',
+		'francebyregions2016.xml'       =>  'fr-metropole-regions-2016',
+		'hauteloirebycommunes.xml'      =>  'fr-dpt-43-communes',
+		'illeetvilainebycommunes.xml'   =>  'fr-dpt-35-communes',
+		'loiretbycommunes.xml'          =>  'fr-dpt-45-communes',
+		'lozerebycodepostaux.xml'       =>  'fr-dpt-48-codespostaux',
+		'lozerebycommunes.xml'          =>  'fr-dpt-48-communes',
+		'mayennebycommunes.xml'         =>  'fr-dpt-53-communes',
+		'oisebycommunes.xml'            =>  'fr-dpt-60-communes',
+		'ornebycommunes.xml'            =>  'fr-dpt-61-communes',
+		'puydedomebycommunes.xml'       =>  'fr-dpt-63-communes',
+		'sarthebycommunes.xml'          =>  'fr-dpt-72-communes',
+		'seinemaritimebycommunes.xml'   =>  'fr-dpt-76-communes',
+		'seinesommeoisebycommunes.xml'  =>  ['fr-dpt-60-communes', 'fr-dpt-76-communes', 'fr-dpt-80-communes'],
+		'valdoisebycommunes.xml'        =>  'fr-dpt-95-communes',
+		'yvelinesbycommunes.xml'        =>  'fr-dpt-78-communes'
+	];
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        if (!DB::schema()->hasTable('maj_geodispersion')) {
-            return;
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		if (!DB::schema()->hasTable('maj_geodispersion')) {
+			return;
+		}
 
-        /** @var TreeService $tree_service */
-        $tree_service = app(TreeService::class);
-        /** @var GeoAnalysisViewDataService $geoview_data_service */
-        $geoview_data_service = app(GeoAnalysisViewDataService::class);
+		/** @var TreeService $tree_service */
+		$tree_service = app(TreeService::class);
+		/** @var GeoAnalysisViewDataService $geoview_data_service */
+		$geoview_data_service = app(GeoAnalysisViewDataService::class);
 
-        $existing_views = DB::table('maj_geodispersion')
-            ->select()
-            ->get();
+		$existing_views = DB::table('maj_geodispersion')
+			->select()
+			->get();
 
-        foreach ($existing_views as $old_view) {
-            try {
-                $tree = $tree_service->find((int) $old_view->majgd_file);
-            } catch (RuntimeException $ex) {
-                continue;
-            }
+		foreach ($existing_views as $old_view) {
+			try {
+				$tree = $tree_service->find((int) $old_view->majgd_file);
+			} catch (RuntimeException $ex) {
+				continue;
+			}
 
-            if ($old_view->majgd_map === null) {
-                $this->migrateGeoAnalysisTable($old_view, $tree, $geoview_data_service);
-            } else {
-                DB::connection()->beginTransaction();
-                if ($this->migrateGeoAnalysisMap($old_view, $tree, $geoview_data_service)) {
-                    DB::connection()->commit();
-                } else {
-                    DB::connection()->rollBack();
-                }
-            }
-        }
+			if ($old_view->majgd_map === null) {
+				$this->migrateGeoAnalysisTable($old_view, $tree, $geoview_data_service);
+			} else {
+				DB::connection()->beginTransaction();
+				if ($this->migrateGeoAnalysisMap($old_view, $tree, $geoview_data_service)) {
+					DB::connection()->commit();
+				} else {
+					DB::connection()->rollBack();
+				}
+			}
+		}
 
-        $in_transaction = DB::connection()->getPdo()->inTransaction();
+		$in_transaction = DB::connection()->getPdo()->inTransaction();
 
-        DB::schema()->drop('maj_geodispersion');
+		DB::schema()->drop('maj_geodispersion');
 
-        if ($in_transaction && !DB::connection()->getPdo()->inTransaction()) {
-            DB::connection()->beginTransaction();
-        }
+		if ($in_transaction && !DB::connection()->getPdo()->inTransaction()) {
+			DB::connection()->beginTransaction();
+		}
 
-        FlashMessages::addMessage(I18N::translate(
-            'The geographical dispersion analyses have been migrated for webtrees 2. Please review their settings.'
-        ));
-    }
+		FlashMessages::addMessage(I18N::translate(
+			'The geographical dispersion analyses have been migrated for webtrees 2. Please review their settings.'
+		));
+	}
 
-    /**
-     * Create a Table geographical analysis view from a migrated item.
-     *
-     * @param stdClass $old_view
-     * @param Tree $tree
-     * @param GeoAnalysisViewDataService $geoview_data_service
-     * @return bool
-     */
-    private function migrateGeoAnalysisTable(
-        stdClass $old_view,
-        Tree $tree,
-        GeoAnalysisViewDataService $geoview_data_service
-    ): bool {
-        $new_view = new GeoAnalysisTable(
-            0,
-            $tree,
-            $old_view->majgd_status === 'enabled',
-            $old_view->majgd_descr,
-            app(SosaByGenerationGeoAnalysis::class),
-            (int) $old_view->majgd_sublevel,
-            (int) $old_view->majgd_detailsgen
-        );
+	/**
+	 * Create a Table geographical analysis view from a migrated item.
+	 *
+	 * @param stdClass $old_view
+	 * @param Tree $tree
+	 * @param GeoAnalysisViewDataService $geoview_data_service
+	 * @return bool
+	 */
+	private function migrateGeoAnalysisTable(
+		stdClass $old_view,
+		Tree $tree,
+		GeoAnalysisViewDataService $geoview_data_service
+	): bool {
+		$new_view = new GeoAnalysisTable(
+			0,
+			$tree,
+			$old_view->majgd_status === 'enabled',
+			$old_view->majgd_descr,
+			app(SosaByGenerationGeoAnalysis::class),
+			(int) $old_view->majgd_sublevel,
+			(int) $old_view->majgd_detailsgen
+		);
 
-        return $geoview_data_service->insertGetId($new_view) > 0;
-    }
+		return $geoview_data_service->insertGetId($new_view) > 0;
+	}
 
-    /**
-     * Create a Map geographical analysis view from a migrated item.
-     *
-     * @param stdClass $old_view
-     * @param Tree $tree
-     * @param GeoAnalysisViewDataService $geoview_data_service
-     * @return bool
-     */
-    private function migrateGeoAnalysisMap(
-        stdClass $old_view,
-        Tree $tree,
-        GeoAnalysisViewDataService $geoview_data_service
-    ): bool {
-        /** @var MapDefinitionsService $map_definition_service */
-        $map_definition_service = app(MapDefinitionsService::class);
-        /** @var MapAdapterDataService $mapadapter_data_service */
-        $mapadapter_data_service = app(MapAdapterDataService::class);
+	/**
+	 * Create a Map geographical analysis view from a migrated item.
+	 *
+	 * @param stdClass $old_view
+	 * @param Tree $tree
+	 * @param GeoAnalysisViewDataService $geoview_data_service
+	 * @return bool
+	 */
+	private function migrateGeoAnalysisMap(
+		stdClass $old_view,
+		Tree $tree,
+		GeoAnalysisViewDataService $geoview_data_service
+	): bool {
+		/** @var MapDefinitionsService $map_definition_service */
+		$map_definition_service = app(MapDefinitionsService::class);
+		/** @var MapAdapterDataService $mapadapter_data_service */
+		$mapadapter_data_service = app(MapAdapterDataService::class);
 
-        $new_view = new GeoAnalysisMap(
-            0,
-            $tree,
-            $old_view->majgd_status === 'enabled',
-            $old_view->majgd_descr,
-            app(SosaByGenerationGeoAnalysis::class),
-            (int) $old_view->majgd_sublevel,
-            (int) $old_view->majgd_detailsgen
-        );
+		$new_view = new GeoAnalysisMap(
+			0,
+			$tree,
+			$old_view->majgd_status === 'enabled',
+			$old_view->majgd_descr,
+			app(SosaByGenerationGeoAnalysis::class),
+			(int) $old_view->majgd_sublevel,
+			(int) $old_view->majgd_detailsgen
+		);
 
-        $view_id = $geoview_data_service->insertGetId($new_view);
-        if ($view_id === 0) {
-            return false;
-        }
-        $new_view = $new_view->withId($view_id);
+		$view_id = $geoview_data_service->insertGetId($new_view);
+		if ($view_id === 0) {
+			return false;
+		}
+		$new_view = $new_view->withId($view_id);
 
-        $colors = $new_view->colors();
-        foreach ($this->mapIdsFromOld($old_view->majgd_map) as $new_map_id) {
-            $map = $map_definition_service->find($new_map_id);
-            if ($map === null) {
-                return false;
-            }
-            $colors = $this->colorsFromMap($new_map_id);
+		$colors = $new_view->colors();
+		foreach ($this->mapIdsFromOld($old_view->majgd_map) as $new_map_id) {
+			$map = $map_definition_service->find($new_map_id);
+			if ($map === null) {
+				return false;
+			}
+			$colors = $this->colorsFromMap($new_map_id);
 
-            /** @var SimplePlaceMapper $mapper */
-            $mapper = app(SimplePlaceMapper::class);
-            $mapview_config = new MapViewConfig($this->mappingPropertyForMap($new_map_id), $mapper->config());
-            $map_adapter = new GeoAnalysisMapAdapter(0, $view_id, $map, $mapper, $mapview_config);
+			/** @var SimplePlaceMapper $mapper */
+			$mapper = app(SimplePlaceMapper::class);
+			$mapview_config = new MapViewConfig($this->mappingPropertyForMap($new_map_id), $mapper->config());
+			$map_adapter = new GeoAnalysisMapAdapter(0, $view_id, $map, $mapper, $mapview_config);
 
-            $mapadapter_data_service->insertGetId($map_adapter);
-        }
+			$mapadapter_data_service->insertGetId($map_adapter);
+		}
 
-        return $geoview_data_service->update($new_view->withColors($colors)) > 0;
-    }
+		return $geoview_data_service->update($new_view->withColors($colors)) > 0;
+	}
 
-    /**
-     * Get all new map definitions IDs representing an old map definition
-     *
-     * @param string $map_xml
-     * @return string[]
-     */
-    private function mapIdsFromOld(string $map_xml): array
-    {
-        $mapping = self::MAPS_XML_MAPPING[$map_xml] ?? [];
-        return is_array($mapping) ? $mapping : [ $mapping ];
-    }
+	/**
+	 * Get all new map definitions IDs representing an old map definition
+	 *
+	 * @param string $map_xml
+	 * @return string[]
+	 */
+	private function mapIdsFromOld(string $map_xml): array
+	{
+		$mapping = self::MAPS_XML_MAPPING[$map_xml] ?? [];
+		return is_array($mapping) ? $mapping : [ $mapping ];
+	}
 
-    /**
-     * Get the mapping property to be used for the migrated map adapter
-     *
-     * @param string $map_id
-     * @return string
-     */
-    private function mappingPropertyForMap(string $map_id): string
-    {
-        switch ($map_id) {
-            case 'fr-metropole-regions-1970':
-            case 'fr-metropole-regions-2016':
-                return 'region_insee_libelle';
-            case 'fr-metropole-departements':
-                return 'dpt_insee_libelle';
-            case 'fr-dpt-48-codespostaux':
-                return 'code_postal';
-            default:
-                return 'commune_insee_libelle';
-        }
-    }
+	/**
+	 * Get the mapping property to be used for the migrated map adapter
+	 *
+	 * @param string $map_id
+	 * @return string
+	 */
+	private function mappingPropertyForMap(string $map_id): string
+	{
+		switch ($map_id) {
+			case 'fr-metropole-regions-1970':
+			case 'fr-metropole-regions-2016':
+				return 'region_insee_libelle';
+			case 'fr-metropole-departements':
+				return 'dpt_insee_libelle';
+			case 'fr-dpt-48-codespostaux':
+				return 'code_postal';
+			default:
+				return 'commune_insee_libelle';
+		}
+	}
 
-    /**
-     * Get the color configuration to be used for the migrated map view
-     *
-     * @param string $map_id
-     * @return MapColorsConfig
-     */
-    private function colorsFromMap(string $map_id): MapColorsConfig
-    {
-        $default = Hex::fromString('#f5f5f5');
-        $stroke = Hex::fromString('#d5d5d5');
-        $hover = Hex::fromString('#ff6600');
+	/**
+	 * Get the color configuration to be used for the migrated map view
+	 *
+	 * @param string $map_id
+	 * @return MapColorsConfig
+	 */
+	private function colorsFromMap(string $map_id): MapColorsConfig
+	{
+		$default = Hex::fromString('#f5f5f5');
+		$stroke = Hex::fromString('#d5d5d5');
+		$hover = Hex::fromString('#ff6600');
 
-        switch ($map_id) {
-            case 'fr-metropole-departements':
-                return new MapColorsConfig($default, $stroke, Hex::fromString('#0493ab'), $hover);
-            case 'fr-dpt-48-codespostaux':
-                return new MapColorsConfig($default, $stroke, Hex::fromString('#44aa00'), $hover);
-            default:
-                return new MapColorsConfig($default, $stroke, Hex::fromString('#e2a61d'), $hover);
-        }
-    }
+		switch ($map_id) {
+			case 'fr-metropole-departements':
+				return new MapColorsConfig($default, $stroke, Hex::fromString('#0493ab'), $hover);
+			case 'fr-dpt-48-codespostaux':
+				return new MapColorsConfig($default, $stroke, Hex::fromString('#44aa00'), $hover);
+			default:
+				return new MapColorsConfig($default, $stroke, Hex::fromString('#e2a61d'), $hover);
+		}
+	}
 }

app/Module/GeoDispersion/Schema/Migration1.php

Indentation +37 added lines, -37 removed lines

@@ -23,41 +23,41 @@
  */
 class Migration1 implements MigrationInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        $in_transaction = DB::connection()->getPdo()->inTransaction();
-
-        DB::schema()->create('maj_geodisp_views', static function (Blueprint $table): void {
-            $table->integer('majgv_id')->autoIncrement();
-            $table->integer('majgv_gedcom_id')->index();
-            $table->string('majgv_view_class', 255);
-            $table->enum('majgv_status', ['enabled', 'disabled'])->default('enabled');
-            $table->string('majgv_descr', 248);
-            $table->string('majgv_analysis', 255);
-            $table->tinyInteger('majgv_place_depth')->default(1);
-            $table->tinyInteger('majgv_top_places')->default(0);
-            $table->json('majgv_colors')->nullable();
-
-            $table->foreign('majgv_gedcom_id')->references('gedcom_id')->on('gedcom')->onDelete('cascade');
-        });
-
-        DB::schema()->create('maj_geodisp_mapviews', static function (Blueprint $table): void {
-            $table->integer('majgm_id')->autoIncrement();
-            $table->integer('majgm_majgv_id')->index();
-            $table->string('majgm_map_id', 127);
-            $table->string('majgm_mapper', 255);
-            $table->string('majgm_feature_prop', 31);
-            $table->json('majgm_config')->nullable();
-
-            $table->foreign('majgm_majgv_id')->references('majgv_id')->on('maj_geodisp_views')->onDelete('cascade');
-        });
-
-        if ($in_transaction && !DB::connection()->getPdo()->inTransaction()) {
-            DB::connection()->beginTransaction();
-        }
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		$in_transaction = DB::connection()->getPdo()->inTransaction();
+
+		DB::schema()->create('maj_geodisp_views', static function (Blueprint $table): void {
+			$table->integer('majgv_id')->autoIncrement();
+			$table->integer('majgv_gedcom_id')->index();
+			$table->string('majgv_view_class', 255);
+			$table->enum('majgv_status', ['enabled', 'disabled'])->default('enabled');
+			$table->string('majgv_descr', 248);
+			$table->string('majgv_analysis', 255);
+			$table->tinyInteger('majgv_place_depth')->default(1);
+			$table->tinyInteger('majgv_top_places')->default(0);
+			$table->json('majgv_colors')->nullable();
+
+			$table->foreign('majgv_gedcom_id')->references('gedcom_id')->on('gedcom')->onDelete('cascade');
+		});
+
+		DB::schema()->create('maj_geodisp_mapviews', static function (Blueprint $table): void {
+			$table->integer('majgm_id')->autoIncrement();
+			$table->integer('majgm_majgv_id')->index();
+			$table->string('majgm_map_id', 127);
+			$table->string('majgm_mapper', 255);
+			$table->string('majgm_feature_prop', 31);
+			$table->json('majgm_config')->nullable();
+
+			$table->foreign('majgm_majgv_id')->references('majgv_id')->on('maj_geodisp_views')->onDelete('cascade');
+		});
+
+		if ($in_transaction && !DB::connection()->getPdo()->inTransaction()) {
+			DB::connection()->beginTransaction();
+		}
+	}
 }

app/Module/GeoDispersion/Http/RequestHandlers/GeoAnalysisViewEditAction.php

Indentation +82 added lines, -82 removed lines

@@ -34,86 +34,86 @@
  */
 class GeoAnalysisViewEditAction implements RequestHandlerInterface
 {
-    private ?GeoDispersionModule $module;
-    private GeoAnalysisViewDataService $geoview_data_service;
-
-    /**
-     * Constructor for GeoAnalysisViewEditAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param GeoAnalysisViewDataService $geoview_data_service
-     */
-    public function __construct(ModuleService $module_service, GeoAnalysisViewDataService $geoview_data_service)
-    {
-        $this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
-        $this->geoview_data_service = $geoview_data_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = Validator::attributes($request)->tree();
-
-        $admin_config_route = route(AdminConfigPage::class, ['tree' => $tree->name()]);
-
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-
-        $view_id = Validator::attributes($request)->integer('view_id', -1);
-        $view = $this->geoview_data_service->find($tree, $view_id, true);
-
-        $description    = Validator::parsedBody($request)->string('view_description', '');
-        $place_depth    = Validator::parsedBody($request)->integer('view_depth', 1);
-        $top_places     = Validator::parsedBody($request)->integer('view_top_places', 0);
-
-        $analysis = null;
-        try {
-            $analysis = app(Validator::parsedBody($request)->string('view_analysis', ''));
-        } catch (BindingResolutionException $ex) {
-        }
-
-        if (
-            $view === null
-            || $analysis === null || !($analysis instanceof GeoAnalysisInterface)
-            || $place_depth <= 0 && $top_places < 0
-        ) {
-            FlashMessages::addMessage(
-                I18N::translate('The parameters for view with ID “%s” are not valid.', I18N::number($view_id)),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-        $new_view = $view
-            ->with($view->isEnabled(), $description, $analysis, $place_depth, $top_places)
-            ->withGlobalSettingsUpdate($request);
-
-        try {
-            $this->geoview_data_service->update($new_view);
-            FlashMessages::addMessage(
-                I18N::translate('The geographical dispersion analysis view has been successfully updated.'),
-                'success'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : View “' . $view->id() . '” has been updated.');
-        } catch (Throwable $ex) {
-            FlashMessages::addMessage(
-                I18N::translate('An error occured while updating the geographical dispersion analysis view.'),
-                'danger'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addErrorLog('Module ' . $this->module->title() . ' : Error when updating view “' . $view->id() . '”: ' . $ex->getMessage());
-        }
-
-        return redirect($admin_config_route);
-    }
+	private ?GeoDispersionModule $module;
+	private GeoAnalysisViewDataService $geoview_data_service;
+
+	/**
+	 * Constructor for GeoAnalysisViewEditAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param GeoAnalysisViewDataService $geoview_data_service
+	 */
+	public function __construct(ModuleService $module_service, GeoAnalysisViewDataService $geoview_data_service)
+	{
+		$this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
+		$this->geoview_data_service = $geoview_data_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = Validator::attributes($request)->tree();
+
+		$admin_config_route = route(AdminConfigPage::class, ['tree' => $tree->name()]);
+
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+
+		$view_id = Validator::attributes($request)->integer('view_id', -1);
+		$view = $this->geoview_data_service->find($tree, $view_id, true);
+
+		$description    = Validator::parsedBody($request)->string('view_description', '');
+		$place_depth    = Validator::parsedBody($request)->integer('view_depth', 1);
+		$top_places     = Validator::parsedBody($request)->integer('view_top_places', 0);
+
+		$analysis = null;
+		try {
+			$analysis = app(Validator::parsedBody($request)->string('view_analysis', ''));
+		} catch (BindingResolutionException $ex) {
+		}
+
+		if (
+			$view === null
+			|| $analysis === null || !($analysis instanceof GeoAnalysisInterface)
+			|| $place_depth <= 0 && $top_places < 0
+		) {
+			FlashMessages::addMessage(
+				I18N::translate('The parameters for view with ID “%s” are not valid.', I18N::number($view_id)),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+		$new_view = $view
+			->with($view->isEnabled(), $description, $analysis, $place_depth, $top_places)
+			->withGlobalSettingsUpdate($request);
+
+		try {
+			$this->geoview_data_service->update($new_view);
+			FlashMessages::addMessage(
+				I18N::translate('The geographical dispersion analysis view has been successfully updated.'),
+				'success'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : View “' . $view->id() . '” has been updated.');
+		} catch (Throwable $ex) {
+			FlashMessages::addMessage(
+				I18N::translate('An error occured while updating the geographical dispersion analysis view.'),
+				'danger'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addErrorLog('Module ' . $this->module->title() . ' : Error when updating view “' . $view->id() . '”: ' . $ex->getMessage());
+		}
+
+		return redirect($admin_config_route);
+	}
 }

app/Module/GeoDispersion/Http/RequestHandlers/GeoAnalysisViewAddPage.php

Indentation +39 added lines, -39 removed lines

@@ -32,48 +32,48 @@
  */
 class GeoAnalysisViewAddPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?GeoDispersionModule $module;
-    private GeoAnalysisService $geoanalysis_service;
-    private GeoAnalysisDataService $geoanalysis_data_service;
+	private ?GeoDispersionModule $module;
+	private GeoAnalysisService $geoanalysis_service;
+	private GeoAnalysisDataService $geoanalysis_data_service;
 
-    /**
-     * Constructor for GeoAnalysisViewAddPage Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param GeoAnalysisService $geoanalysis_service
-     * @param GeoAnalysisDataService $geoanalysis_data_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        GeoAnalysisService $geoanalysis_service,
-        GeoAnalysisDataService $geoanalysis_data_service
-    ) {
-        $this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
-        $this->geoanalysis_service = $geoanalysis_service;
-        $this->geoanalysis_data_service = $geoanalysis_data_service;
-    }
+	/**
+	 * Constructor for GeoAnalysisViewAddPage Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param GeoAnalysisService $geoanalysis_service
+	 * @param GeoAnalysisDataService $geoanalysis_data_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		GeoAnalysisService $geoanalysis_service,
+		GeoAnalysisDataService $geoanalysis_data_service
+	) {
+		$this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
+		$this->geoanalysis_service = $geoanalysis_service;
+		$this->geoanalysis_data_service = $geoanalysis_data_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/administration';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/administration';
 
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
-        $tree = Validator::attributes($request)->tree();
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
+		$tree = Validator::attributes($request)->tree();
 
-        return $this->viewResponse($this->module->name() . '::admin/view-add', [
-            'module'        =>  $this->module,
-            'title'         =>  I18N::translate('Add a geographical dispersion analysis view'),
-            'tree'          =>  $tree,
-            'geoanalysis_list'  =>  $this->geoanalysis_service->all(),
-            'place_example'     =>  $this->geoanalysis_data_service->placeHierarchyExample($tree)
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/view-add', [
+			'module'        =>  $this->module,
+			'title'         =>  I18N::translate('Add a geographical dispersion analysis view'),
+			'tree'          =>  $tree,
+			'geoanalysis_list'  =>  $this->geoanalysis_service->all(),
+			'place_example'     =>  $this->geoanalysis_data_service->placeHierarchyExample($tree)
+		]);
+	}
 }