jon48 / webtrees-lib

app/Module/GeoDispersion/Model/MapFeatureAnalysisData.php

Indentation +67 added lines, -67 removed lines

@@ -22,77 +22,77 @@
  */
 class MapFeatureAnalysisData
 {
-    private int $count;
-    private bool $in_map;
-    /**
-     * @var Collection<GeoAnalysisPlace> $places
-     */
-    private Collection $places;
+	private int $count;
+	private bool $in_map;
+	/**
+	 * @var Collection<GeoAnalysisPlace> $places
+	 */
+	private Collection $places;
 
-    /**
-     * Constructor for MapFeatureAnalysisData
-     */
-    public function __construct()
-    {
-        $this->count = 0;
-        $this->places = new Collection();
-        $this->in_map = false;
-    }
+	/**
+	 * Constructor for MapFeatureAnalysisData
+	 */
+	public function __construct()
+	{
+		$this->count = 0;
+		$this->places = new Collection();
+		$this->in_map = false;
+	}
 
-    /**
-     * Get the list of places mapped to the feature
-     *
-     * @return Collection<GeoAnalysisPlace>
-     */
-    public function places(): Collection
-    {
-        return $this->places;
-    }
+	/**
+	 * Get the list of places mapped to the feature
+	 *
+	 * @return Collection<GeoAnalysisPlace>
+	 */
+	public function places(): Collection
+	{
+		return $this->places;
+	}
 
-    /**
-     * Get the count of analysis items occurring in the feature
-     *
-     * @return int
-     */
-    public function count(): int
-    {
-        return $this->count;
-    }
+	/**
+	 * Get the count of analysis items occurring in the feature
+	 *
+	 * @return int
+	 */
+	public function count(): int
+	{
+		return $this->count;
+	}
 
-    /**
-     * Check whether the feature exist in the target map
-     *
-     * @return bool
-     */
-    public function existsInMap(): bool
-    {
-        return $this->in_map;
-    }
+	/**
+	 * Check whether the feature exist in the target map
+	 *
+	 * @return bool
+	 */
+	public function existsInMap(): bool
+	{
+		return $this->in_map;
+	}
 
-    /**
-     * Confirm that the feature exist in the target map
-     *
-     * @return $this
-     */
-    public function tagAsExisting(): self
-    {
-        $this->in_map = true;
-        return $this;
-    }
+	/**
+	 * Confirm that the feature exist in the target map
+	 *
+	 * @return $this
+	 */
+	public function tagAsExisting(): self
+	{
+		$this->in_map = true;
+		return $this;
+	}
 
-    /**
-     * Add a GeoAnalysisPlace to the feature
-     *
-     * @param GeoAnalysisPlace $place
-     * @param int $count
-     * @return $this
-     */
-    public function add(GeoAnalysisPlace $place, int $count): self
-    {
-        if (!$place->isExcluded()) {
-            $this->places->add($place);
-            $this->count += $count;
-        }
-        return $this;
-    }
+	/**
+	 * Add a GeoAnalysisPlace to the feature
+	 *
+	 * @param GeoAnalysisPlace $place
+	 * @param int $count
+	 * @return $this
+	 */
+	public function add(GeoAnalysisPlace $place, int $count): self
+	{
+		if (!$place->isExcluded()) {
+			$this->places->add($place);
+			$this->count += $count;
+		}
+		return $this;
+	}
 }

app/Module/GeoDispersion/Model/MapAdapterResult.php

Indentation +48 added lines, -48 removed lines

@@ -24,57 +24,57 @@
  */
 class MapAdapterResult
 {
-    private GeoAnalysisResult $result;
+	private GeoAnalysisResult $result;
 
-    /**
-     * @var array<int, \Brick\Geo\IO\GeoJSON\Feature> $features
-     */
-    private array $features;
+	/**
+	 * @var array<int, \Brick\Geo\IO\GeoJSON\Feature> $features
+	 */
+	private array $features;
 
-    /**
-     * Constructor for MapAdapterResult
-     *
-     * @param GeoAnalysisResult $result
-     * @param \Brick\Geo\IO\GeoJSON\Feature[] $features
-     */
-    final public function __construct(GeoAnalysisResult $result, array $features)
-    {
-        $this->result = $result;
-        $this->features = $features;
-    }
+	/**
+	 * Constructor for MapAdapterResult
+	 *
+	 * @param GeoAnalysisResult $result
+	 * @param \Brick\Geo\IO\GeoJSON\Feature[] $features
+	 */
+	final public function __construct(GeoAnalysisResult $result, array $features)
+	{
+		$this->result = $result;
+		$this->features = $features;
+	}
 
-    /**
-     * Get the GeoAnalysisResult after mapping of the places
-     *
-     * @return GeoAnalysisResult
-     */
-    public function geoAnalysisResult(): GeoAnalysisResult
-    {
-        return $this->result;
-    }
+	/**
+	 * Get the GeoAnalysisResult after mapping of the places
+	 *
+	 * @return GeoAnalysisResult
+	 */
+	public function geoAnalysisResult(): GeoAnalysisResult
+	{
+		return $this->result;
+	}
 
-    /**
-     * Get the list of features to display on the map
-     *
-     * @return array<int, \Brick\Geo\IO\GeoJSON\Feature>
-     */
-    public function features(): array
-    {
-        return $this->features;
-    }
+	/**
+	 * Get the list of features to display on the map
+	 *
+	 * @return array<int, \Brick\Geo\IO\GeoJSON\Feature>
+	 */
+	public function features(): array
+	{
+		return $this->features;
+	}
 
-    /**
-     * Merge the current MapAdapter with another.
-     * The current object is modified, not the second one.
-     *
-     * @param MapAdapterResult $other
-     * @return static
-     */
-    public function merge(MapAdapterResult $other): self
-    {
-        return new static(
-            $this->result->merge($other->result),
-            [...$this->features, ...$other->features]
-        );
-    }
+	/**
+	 * Merge the current MapAdapter with another.
+	 * The current object is modified, not the second one.
+	 *
+	 * @param MapAdapterResult $other
+	 * @return static
+	 */
+	public function merge(MapAdapterResult $other): self
+	{
+		return new static(
+			$this->result->merge($other->result),
+			[...$this->features, ...$other->features]
+		);
+	}
 }

app/Module/MiscExtensions/Hooks/TitlesCardHook.php

Indentation +57 added lines, -57 removed lines

@@ -25,68 +25,68 @@
  */
 class TitlesCardHook implements NameAccordionExtenderInterface
 {
-    private ModuleInterface $module;
+	private ModuleInterface $module;
 
-    /**
-     * Constructor for TitlesCardHook
-     *
-     * @param ModuleInterface $module
-     */
-    public function __construct(ModuleInterface $module)
-    {
-        $this->module = $module;
-    }
+	/**
+	 * Constructor for TitlesCardHook
+	 *
+	 * @param ModuleInterface $module
+	 */
+	public function __construct(ModuleInterface $module)
+	{
+		$this->module = $module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
-     */
-    public function module(): ModuleInterface
-    {
-        return $this->module;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
+	 */
+	public function module(): ModuleInterface
+	{
+		return $this->module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\NameAccordionExtenderInterface::accordionCard()
-     */
-    public function accordionCard(Individual $individual): string
-    {
-        $title_separator = $this->module->getPreference('MAJ_TITLE_PREFIX');
-        if ($title_separator === '') {
-            return '';
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\NameAccordionExtenderInterface::accordionCard()
+	 */
+	public function accordionCard(Individual $individual): string
+	{
+		$title_separator = $this->module->getPreference('MAJ_TITLE_PREFIX');
+		if ($title_separator === '') {
+			return '';
+		}
 
-        $titles = $this->individualTitles($individual, '/(.*?) ((' . $title_separator .  ')(.*))/i');
+		$titles = $this->individualTitles($individual, '/(.*?) ((' . $title_separator .  ')(.*))/i');
 
-        return count($titles) === 0 ? '' :
-            view($this->module()->name() . '::components/accordion-item-titles', [ 'titles' => $titles ]);
-    }
+		return count($titles) === 0 ? '' :
+			view($this->module()->name() . '::components/accordion-item-titles', [ 'titles' => $titles ]);
+	}
 
-    /**
-     * Extract the individual titles from the TITL tags.
-     * Split the title based on a pattern to identify the title and the land it refers to.
-     *
-     * @param Individual $individual
-     * @param string $pattern
-     * @return array<string, string[]>
-     */
-    protected function individualTitles(Individual $individual, string $pattern): array
-    {
-        $titles_list = [];
-        /** @var \Illuminate\Support\Collection<string> $titles */
-        $titles = $individual->facts(['TITL'])
-            ->sortByDesc(fn(Fact $fact) => $fact->date()->julianDay())
-            ->map(fn(Fact $fact) => $fact->value());
+	/**
+	 * Extract the individual titles from the TITL tags.
+	 * Split the title based on a pattern to identify the title and the land it refers to.
+	 *
+	 * @param Individual $individual
+	 * @param string $pattern
+	 * @return array<string, string[]>
+	 */
+	protected function individualTitles(Individual $individual, string $pattern): array
+	{
+		$titles_list = [];
+		/** @var \Illuminate\Support\Collection<string> $titles */
+		$titles = $individual->facts(['TITL'])
+			->sortByDesc(fn(Fact $fact) => $fact->date()->julianDay())
+			->map(fn(Fact $fact) => $fact->value());
 
-        foreach ($titles as $title) {
-            if (preg_match($pattern, $title, $match) === 1) {
-                /** @var array<int, string> $match */
-                $titles_list[$match[1]][] = trim($match[2]);
-            } else {
-                $titles_list[$title][] = '';
-            }
-        }
-        return $titles_list;
-    }
+		foreach ($titles as $title) {
+			if (preg_match($pattern, $title, $match) === 1) {
+				/** @var array<int, string> $match */
+				$titles_list[$match[1]][] = trim($match[2]);
+			} else {
+				$titles_list[$title][] = '';
+			}
+		}
+		return $titles_list;
+	}
 }

app/Module/Certificates/Http/RequestHandlers/AutoCompleteFile.php

Indentation +42 added lines, -42 removed lines

@@ -31,53 +31,53 @@
  */
 class AutoCompleteFile extends AbstractAutocompleteHandler
 {
-    // Tell the browser to cache the results
-    protected const CACHE_LIFE = 10;
+	// Tell the browser to cache the results
+	protected const CACHE_LIFE = 10;
 
-    private ?CertificatesModule $module;
-    private CertificateFilesystemService $certif_filesystem;
-    private UrlObfuscatorService $url_obfuscator_service;
+	private ?CertificatesModule $module;
+	private CertificateFilesystemService $certif_filesystem;
+	private UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for AutoCompleteFile Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param CertificateFilesystemService $certif_filesystem
-     * @param UrlObfuscatorService $url_obfuscator_service
-     * @param SearchService $search_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        UrlObfuscatorService $url_obfuscator_service,
-        SearchService $search_service
-    ) {
-        parent::__construct($search_service);
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
+	/**
+	 * Constructor for AutoCompleteFile Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param CertificateFilesystemService $certif_filesystem
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 * @param SearchService $search_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		UrlObfuscatorService $url_obfuscator_service,
+		SearchService $search_service
+	) {
+		parent::__construct($search_service);
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search()
-     */
-    protected function search(ServerRequestInterface $request): Collection
-    {
-        $tree = Validator::attributes($request)->tree();
-        $city = Validator::queryParams($request)->string('cityobf', '');
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search()
+	 */
+	protected function search(ServerRequestInterface $request): Collection
+	{
+		$tree = Validator::attributes($request)->tree();
+		$city = Validator::queryParams($request)->string('cityobf', '');
 
-        if ($this->module === null || $city === '' || !$this->url_obfuscator_service->tryDeobfuscate($city)) {
-            return collect();
-        }
+		if ($this->module === null || $city === '' || !$this->url_obfuscator_service->tryDeobfuscate($city)) {
+			return collect();
+		}
 
-        $query  =  Validator::attributes($request)->string('query', '');
+		$query  =  Validator::attributes($request)->string('query', '');
 
-        /** @var Collection<int, string> $results */
-        $results =  $this->certif_filesystem
-            ->certificatesForCityContaining($tree, $city, $query)
-            ->map(fn(Certificate $certificate): string => $certificate->filename());
+		/** @var Collection<int, string> $results */
+		$results =  $this->certif_filesystem
+			->certificatesForCityContaining($tree, $city, $query)
+			->map(fn(Certificate $certificate): string => $certificate->filename());
 
-        return $results;
-    }
+		return $results;
+	}
 }

app/Module/Certificates/Http/RequestHandlers/AdminConfigPage.php

Indentation +42 added lines, -42 removed lines

@@ -35,56 +35,56 @@
  */
 class AdminConfigPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?CertificatesModule $module;
-    private TreeService $tree_service;
+	private ?CertificatesModule $module;
+	private TreeService $tree_service;
 
-    /**
-     * Constructor for Admin Config page request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, TreeService $tree_service)
-    {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->tree_service = $tree_service;
-    }
+	/**
+	 * Constructor for Admin Config page request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, TreeService $tree_service)
+	{
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->tree_service = $tree_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.'));
-        }
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $user = Validator::attributes($request)->user();
+		$user = Validator::attributes($request)->user();
 
-        $all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user));
-        if ($all_trees->count() === 0) {
-            throw new HttpAccessDeniedException();
-        }
+		$all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user));
+		if ($all_trees->count() === 0) {
+			throw new HttpAccessDeniedException();
+		}
 
-        $tree = Validator::attributes($request)->treeOptional('tree') ?? $all_trees->first();
+		$tree = Validator::attributes($request)->treeOptional('tree') ?? $all_trees->first();
 
-        $data_folder = Registry::filesystem()->dataName();
+		$data_folder = Registry::filesystem()->dataName();
 
-        $same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id();
-        if (!$all_trees->contains($same_tree)) {
-            throw new HttpAccessDeniedException();
-        }
+		$same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id();
+		if (!$all_trees->contains($same_tree)) {
+			throw new HttpAccessDeniedException();
+		}
 
-        return $this->viewResponse($this->module->name() . '::admin/config', [
-            'module_name'       =>  $this->module->name(),
-            'title'             =>  $this->module->title(),
-            'tree'              =>  $tree,
-            'other_trees'       =>  $all_trees->reject($same_tree),
-            'data_folder'       =>  $data_folder
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/config', [
+			'module_name'       =>  $this->module->name(),
+			'title'             =>  $this->module->title(),
+			'tree'              =>  $tree,
+			'other_trees'       =>  $all_trees->reject($same_tree),
+			'data_folder'       =>  $data_folder
+		]);
+	}
 }

app/Module/Certificates/Http/RequestHandlers/CertificateImage.php

Indentation +102 added lines, -102 removed lines

@@ -38,106 +38,106 @@
  */
 class CertificateImage implements RequestHandlerInterface
 {
-    private ?CertificatesModule $module;
-    private CertificateFilesystemService $certif_filesystem;
-    private CertificateImageFactory $certif_image_factory;
-    private CertificateDataService $certif_data_service;
-    private UrlObfuscatorService $url_obfuscator_service;
-
-    /**
-     * Constructor for Certificate Image Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        CertificateDataService $certif_data_service,
-        UrlObfuscatorService $url_obfuscator_service
-    ) {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->certif_image_factory = new CertificateImageFactory($this->certif_filesystem);
-        $this->certif_data_service = $certif_data_service;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
-
-        $tree = Validator::attributes($request)->tree();
-        $user = Validator::attributes($request)->user();
-
-        $certif_path = Validator::attributes($request)->string('cid', '');
-        $certificate = null;
-        if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) {
-            $certificate = $this->certif_filesystem->certificate($tree, $certif_path);
-        }
-
-        if ($certificate === null) {
-            return $this->certif_image_factory
-                ->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND)
-                ->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.'))
-            ;
-        }
-
-        $use_watermark = $this->certif_image_factory->certificateNeedsWatermark($certificate, $user);
-        $watermark = $use_watermark ? $this->watermark($request, $certificate) : null;
-
-        return $this->certif_image_factory->certificateFileResponse(
-            $certificate,
-            $use_watermark,
-            $watermark
-        );
-    }
-
-    /**
-     * Get watermark data for a certificate.
-     *
-     * @param ServerRequestInterface $request
-     * @param Certificate $certificate
-     * @return Watermark
-     */
-    private function watermark(ServerRequestInterface $request, Certificate $certificate): Watermark
-    {
-        $color = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_COLOR', Watermark::DEFAULT_COLOR);
-        $size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE');
-        $text = $this->watermarkText($request, $certificate);
-
-        return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE);
-    }
-
-    /**
-     * Get the text to be watermarked for a certificate.
-     *
-     * @param ServerRequestInterface $request
-     * @param Certificate $certificate
-     * @return string
-     */
-    private function watermarkText(ServerRequestInterface $request, Certificate $certificate): string
-    {
-        $sid = Validator::queryParams($request)->isXref()->string('sid', '');
-        if ($sid !== '') {
-            $source = Registry::sourceFactory()->make($sid, $certificate->tree());
-        } else {
-            $source = $this->certif_data_service->oneLinkedSource($certificate);
-        }
-
-        if ($source !== null && $source->canShowName()) {
-            $repo = $source->facts(['REPO'])->first();
-            if ($repo !== null && ($repo = $repo->target()) !== null && $repo->canShowName()) {
-                return I18N::translate('© %s - %s', strip_tags($repo->fullName()), strip_tags($source->fullName()));
-            }
-            return strip_tags($source->fullName());
-        }
-        $default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT');
-        return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.');
-    }
+	private ?CertificatesModule $module;
+	private CertificateFilesystemService $certif_filesystem;
+	private CertificateImageFactory $certif_image_factory;
+	private CertificateDataService $certif_data_service;
+	private UrlObfuscatorService $url_obfuscator_service;
+
+	/**
+	 * Constructor for Certificate Image Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		CertificateDataService $certif_data_service,
+		UrlObfuscatorService $url_obfuscator_service
+	) {
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->certif_image_factory = new CertificateImageFactory($this->certif_filesystem);
+		$this->certif_data_service = $certif_data_service;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
+
+		$tree = Validator::attributes($request)->tree();
+		$user = Validator::attributes($request)->user();
+
+		$certif_path = Validator::attributes($request)->string('cid', '');
+		$certificate = null;
+		if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) {
+			$certificate = $this->certif_filesystem->certificate($tree, $certif_path);
+		}
+
+		if ($certificate === null) {
+			return $this->certif_image_factory
+				->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND)
+				->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.'))
+			;
+		}
+
+		$use_watermark = $this->certif_image_factory->certificateNeedsWatermark($certificate, $user);
+		$watermark = $use_watermark ? $this->watermark($request, $certificate) : null;
+
+		return $this->certif_image_factory->certificateFileResponse(
+			$certificate,
+			$use_watermark,
+			$watermark
+		);
+	}
+
+	/**
+	 * Get watermark data for a certificate.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @param Certificate $certificate
+	 * @return Watermark
+	 */
+	private function watermark(ServerRequestInterface $request, Certificate $certificate): Watermark
+	{
+		$color = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_COLOR', Watermark::DEFAULT_COLOR);
+		$size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE');
+		$text = $this->watermarkText($request, $certificate);
+
+		return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE);
+	}
+
+	/**
+	 * Get the text to be watermarked for a certificate.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @param Certificate $certificate
+	 * @return string
+	 */
+	private function watermarkText(ServerRequestInterface $request, Certificate $certificate): string
+	{
+		$sid = Validator::queryParams($request)->isXref()->string('sid', '');
+		if ($sid !== '') {
+			$source = Registry::sourceFactory()->make($sid, $certificate->tree());
+		} else {
+			$source = $this->certif_data_service->oneLinkedSource($certificate);
+		}
+
+		if ($source !== null && $source->canShowName()) {
+			$repo = $source->facts(['REPO'])->first();
+			if ($repo !== null && ($repo = $repo->target()) !== null && $repo->canShowName()) {
+				return I18N::translate('© %s - %s', strip_tags($repo->fullName()), strip_tags($source->fullName()));
+			}
+			return strip_tags($source->fullName());
+		}
+		$default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT');
+		return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.');
+	}
 }

app/Module/Certificates/Http/RequestHandlers/CertificatesList.php

Indentation +50 added lines, -50 removed lines

@@ -32,63 +32,63 @@
  */
 class CertificatesList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?CertificatesModule $module;
-    private CertificateFilesystemService $certif_filesystem;
-    private UrlObfuscatorService $url_obfuscator_service;
+	private ?CertificatesModule $module;
+	private CertificateFilesystemService $certif_filesystem;
+	private UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for CertificatesList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        UrlObfuscatorService $url_obfuscator_service
-    ) {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
+	/**
+	 * Constructor for CertificatesList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		UrlObfuscatorService $url_obfuscator_service
+	) {
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = Validator::attributes($request)->tree();
+		$tree = Validator::attributes($request)->tree();
 
-        $title = I18N::translate('Certificates');
+		$title = I18N::translate('Certificates');
 
-        $cities = array_map(function (string $item): array {
-            return [$this->url_obfuscator_service->obfuscate($item), $item];
-        }, $this->certif_filesystem->cities($tree));
+		$cities = array_map(function (string $item): array {
+			return [$this->url_obfuscator_service->obfuscate($item), $item];
+		}, $this->certif_filesystem->cities($tree));
 
-        $city = Validator::queryParams($request)->string(
-            'cityobf',
-            Validator::attributes($request)->string('cityobf', '')
-        );
+		$city = Validator::queryParams($request)->string(
+			'cityobf',
+			Validator::attributes($request)->string('cityobf', '')
+		);
 
-        if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) {
-            $title = I18N::translate('Certificates for %s', $city);
-            $certificates = $this->certif_filesystem->certificatesForCity($tree, $city);
-        }
+		if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) {
+			$title = I18N::translate('Certificates for %s', $city);
+			$certificates = $this->certif_filesystem->certificatesForCity($tree, $city);
+		}
 
-        return $this->viewResponse($this->module->name() . '::certificates-list', [
-            'title'                     =>  $title,
-            'tree'                      =>  $tree,
-            'module_name'               =>  $this->module->name(),
-            'cities'                    =>  $cities,
-            'selected_city'             =>  $city,
-            'certificates_list'         =>  $certificates ?? collect(),
-            'url_obfuscator_service'    =>  $this->url_obfuscator_service
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::certificates-list', [
+			'title'                     =>  $title,
+			'tree'                      =>  $tree,
+			'module_name'               =>  $this->module->name(),
+			'cities'                    =>  $cities,
+			'selected_city'             =>  $city,
+			'certificates_list'         =>  $certificates ?? collect(),
+			'url_obfuscator_service'    =>  $this->url_obfuscator_service
+		]);
+	}
 }

app/Module/Certificates/Services/CertificateDataService.php

Indentation +132 added lines, -132 removed lines

@@ -28,144 +28,144 @@
  */
 class CertificateDataService
 {
-    /**
-     * Find individuals linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Individual>
-     */
-    public function linkedIndividuals(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('individuals')
-            ->where('i_file', '=', $tree->id())
-            ->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['individuals.*'])
-            ->get()
-            ->map(Registry::individualFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find individuals linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Individual>
+	 */
+	public function linkedIndividuals(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('individuals')
+			->where('i_file', '=', $tree->id())
+			->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['individuals.*'])
+			->get()
+			->map(Registry::individualFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find families linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Family>
-     */
-    public function linkedFamilies(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('families')
-            ->where('f_file', '=', $tree->id())
-            ->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['families.*'])
-            ->get()
-            ->map(Registry::familyFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find families linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Family>
+	 */
+	public function linkedFamilies(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('families')
+			->where('f_file', '=', $tree->id())
+			->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['families.*'])
+			->get()
+			->map(Registry::familyFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find media objects linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Media>
-     */
-    public function linkedMedias(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('media')
-            ->where('m_file', '=', $tree->id())
-            ->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['media.*'])
-            ->get()
-            ->map(Registry::mediaFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find media objects linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Media>
+	 */
+	public function linkedMedias(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('media')
+			->where('m_file', '=', $tree->id())
+			->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['media.*'])
+			->get()
+			->map(Registry::mediaFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find notes linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Note>
-     */
-    public function linkedNotes(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('other')
-            ->where('o_file', '=', $tree->id())
-            ->where('o_type', '=', 'NOTE')
-            ->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['other.*'])
-            ->get()
-            ->map(Registry::noteFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find notes linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Note>
+	 */
+	public function linkedNotes(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('other')
+			->where('o_file', '=', $tree->id())
+			->where('o_type', '=', 'NOTE')
+			->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['other.*'])
+			->get()
+			->map(Registry::noteFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Return an escaped string to be used in SQL LIKE comparisons.
-     * This would not work well for Sqlite, if the escape character is not defined.
-     *
-     * @param Certificate $certificate
-     * @return string
-     */
-    protected function escapedSqlPath(Certificate $certificate): string
-    {
-        return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath());
-    }
+	/**
+	 * Return an escaped string to be used in SQL LIKE comparisons.
+	 * This would not work well for Sqlite, if the escape character is not defined.
+	 *
+	 * @param Certificate $certificate
+	 * @return string
+	 */
+	protected function escapedSqlPath(Certificate $certificate): string
+	{
+		return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath());
+	}
 
-    /**
-     * Find a source linked to a citation where a certificate file is referenced.
-     *
-     * @param Certificate $certificate
-     * @return Source|NULL
-     */
-    public function oneLinkedSource(Certificate $certificate): ?Source
-    {
-        $regex_query = preg_quote($certificate->gedcomPath(), '/');
-        $regex_pattern = '/[1-9] SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[2-9]\s(?:(?!SOUR)\w+)\s.*)*\n[2-9] _ACT ' . $regex_query . '/i'; //phpcs:ignore Generic.Files.LineLength.TooLong
+	/**
+	 * Find a source linked to a citation where a certificate file is referenced.
+	 *
+	 * @param Certificate $certificate
+	 * @return Source|NULL
+	 */
+	public function oneLinkedSource(Certificate $certificate): ?Source
+	{
+		$regex_query = preg_quote($certificate->gedcomPath(), '/');
+		$regex_pattern = '/[1-9] SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[2-9]\s(?:(?!SOUR)\w+)\s.*)*\n[2-9] _ACT ' . $regex_query . '/i'; //phpcs:ignore Generic.Files.LineLength.TooLong
 
-        foreach ($this->linkedRecordsLists($certificate) as $linked_records) {
-            foreach ($linked_records as $gedcom_record) {
-                foreach ($gedcom_record->facts() as $fact) {
-                    if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) {
-                        foreach ($matches as $match) {
-                            $source = Registry::sourceFactory()->make($match[1], $certificate->tree());
-                            if ($source !== null && $source->canShowName()) {
-                                return $source;
-                            }
-                        }
-                    }
-                }
-            }
-        }
+		foreach ($this->linkedRecordsLists($certificate) as $linked_records) {
+			foreach ($linked_records as $gedcom_record) {
+				foreach ($gedcom_record->facts() as $fact) {
+					if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) {
+						foreach ($matches as $match) {
+							$source = Registry::sourceFactory()->make($match[1], $certificate->tree());
+							if ($source !== null && $source->canShowName()) {
+								return $source;
+							}
+						}
+					}
+				}
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 
-    /**
-     * Yield lists of gedcom records linked to a certificate.
-     *
-     * @param Certificate $certificate
-     * @return Generator<int, Collection<GedcomRecord>, mixed, void>
-     * @psalm-suppress InvalidReturnType
-     */
-    protected function linkedRecordsLists(Certificate $certificate): Generator
-    {
-        yield $this->linkedIndividuals($certificate);
-        yield $this->linkedFamilies($certificate);
-        yield $this->linkedMedias($certificate);
-        yield $this->linkedNotes($certificate);
-    }
+	/**
+	 * Yield lists of gedcom records linked to a certificate.
+	 *
+	 * @param Certificate $certificate
+	 * @return Generator<int, Collection<GedcomRecord>, mixed, void>
+	 * @psalm-suppress InvalidReturnType
+	 */
+	protected function linkedRecordsLists(Certificate $certificate): Generator
+	{
+		yield $this->linkedIndividuals($certificate);
+		yield $this->linkedFamilies($certificate);
+		yield $this->linkedMedias($certificate);
+		yield $this->linkedNotes($certificate);
+	}
 }

app/Module/Certificates/Services/UrlObfuscatorService.php

Indentation +116 added lines, -116 removed lines

@@ -23,120 +23,120 @@
  */
 class UrlObfuscatorService
 {
-    /**
-     * @var string|null $encryption_key
-     */
-    private $encryption_key;
-
-
-    /**
-     * Return (and generate) the key to be used for the encryption step
-     *
-     * @return string Encryption key
-     */
-    protected function encryptionKey(): string
-    {
-        if ($this->encryption_key === null) {
-            /** @var ServerRequestInterface $request **/
-            $request = app(ServerRequestInterface::class);
-            $server_name = $request->getServerParams()['SERVER_NAME'] ?? '';
-            $server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? '';
-            $this->encryption_key = str_pad(md5(
-                $server_name !== '' && $server_software !== '' ?
-                $server_name . $server_software :
-                'STANDARDKEYIFNOSERVER'
-            ), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF");
-        }
-        return $this->encryption_key;
-    }
-
-    /**
-     * Obfuscate a clear text, with a combination of encryption and base64 encoding.
-     * The return string is URL-safe.
-     *
-     * @param string $cleartext Text to obfuscate
-     * @param string $key
-     * @param string $nonce
-     * @return string
-     */
-    public function obfuscate(string $cleartext, string $key = '', string $nonce = ''): string
-    {
-        if ($nonce === '') {
-            $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
-        }
-        if ($key === '') {
-            $key = $this->encryptionKey();
-        }
-
-        if (strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) {
-            throw new InvalidArgumentException('The nonce needs to be SODIUM_CRYPTO_SECRETBOX_NONCEBYTES long');
-        }
-
-        if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
-            throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
-        }
-
-        $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key);
-        return strtr(base64_encode($nonce . $encryted), '+/=', '._-');
-    }
-
-    /**
-     * Deobfuscate a string from an URL to a clear text.
-     *
-     * @param string $obfuscated Text to deobfuscate
-     * @param string $key
-     * @throws InvalidArgumentException
-     * @return string
-     */
-    public function deobfuscate(string $obfuscated, string $key = ''): string
-    {
-        $obfuscated = strtr($obfuscated, '._-', '+/=');
-        if ($key === '') {
-            $key = $this->encryptionKey();
-        }
-
-        if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
-            throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
-        }
-
-        $encrypted = base64_decode($obfuscated, true);
-        if ($encrypted === false) {
-            throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
-        }
-
-        if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) {
-            throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
-        }
-
-        $nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit');
-        $ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit');
-
-        $decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
-
-        if ($decrypted === false) {
-            throw new InvalidArgumentException('The message has been tampered with in transit.');
-        }
-
-        //sodium_memzero($ciphertext);    // sodium_compat cannot handle it, only through libsodium
-
-        /** @var string $decrypted - Psalm detect as string|true otherwise */
-        return $decrypted;
-    }
-
-    /**
-     * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success.
-     *
-     * @param string $obfuscated Text to deobfuscate
-     * @param string $key
-     * @return bool
-     */
-    public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool
-    {
-        try {
-            $obfuscated = $this->deobfuscate($obfuscated, $key);
-            return true;
-        } catch (InvalidArgumentException $ex) {
-        }
-        return false;
-    }
+	/**
+	 * @var string|null $encryption_key
+	 */
+	private $encryption_key;
+
+
+	/**
+	 * Return (and generate) the key to be used for the encryption step
+	 *
+	 * @return string Encryption key
+	 */
+	protected function encryptionKey(): string
+	{
+		if ($this->encryption_key === null) {
+			/** @var ServerRequestInterface $request **/
+			$request = app(ServerRequestInterface::class);
+			$server_name = $request->getServerParams()['SERVER_NAME'] ?? '';
+			$server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? '';
+			$this->encryption_key = str_pad(md5(
+				$server_name !== '' && $server_software !== '' ?
+				$server_name . $server_software :
+				'STANDARDKEYIFNOSERVER'
+			), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF");
+		}
+		return $this->encryption_key;
+	}
+
+	/**
+	 * Obfuscate a clear text, with a combination of encryption and base64 encoding.
+	 * The return string is URL-safe.
+	 *
+	 * @param string $cleartext Text to obfuscate
+	 * @param string $key
+	 * @param string $nonce
+	 * @return string
+	 */
+	public function obfuscate(string $cleartext, string $key = '', string $nonce = ''): string
+	{
+		if ($nonce === '') {
+			$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
+		}
+		if ($key === '') {
+			$key = $this->encryptionKey();
+		}
+
+		if (strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) {
+			throw new InvalidArgumentException('The nonce needs to be SODIUM_CRYPTO_SECRETBOX_NONCEBYTES long');
+		}
+
+		if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
+			throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
+		}
+
+		$encryted = sodium_crypto_secretbox($cleartext, $nonce, $key);
+		return strtr(base64_encode($nonce . $encryted), '+/=', '._-');
+	}
+
+	/**
+	 * Deobfuscate a string from an URL to a clear text.
+	 *
+	 * @param string $obfuscated Text to deobfuscate
+	 * @param string $key
+	 * @throws InvalidArgumentException
+	 * @return string
+	 */
+	public function deobfuscate(string $obfuscated, string $key = ''): string
+	{
+		$obfuscated = strtr($obfuscated, '._-', '+/=');
+		if ($key === '') {
+			$key = $this->encryptionKey();
+		}
+
+		if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
+			throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long');
+		}
+
+		$encrypted = base64_decode($obfuscated, true);
+		if ($encrypted === false) {
+			throw new InvalidArgumentException('The encrypted value is not in correct base64 format.');
+		}
+
+		if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) {
+			throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.');
+		}
+
+		$nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit');
+		$ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit');
+
+		$decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
+
+		if ($decrypted === false) {
+			throw new InvalidArgumentException('The message has been tampered with in transit.');
+		}
+
+		//sodium_memzero($ciphertext);    // sodium_compat cannot handle it, only through libsodium
+
+		/** @var string $decrypted - Psalm detect as string|true otherwise */
+		return $decrypted;
+	}
+
+	/**
+	 * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success.
+	 *
+	 * @param string $obfuscated Text to deobfuscate
+	 * @param string $key
+	 * @return bool
+	 */
+	public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool
+	{
+		try {
+			$obfuscated = $this->deobfuscate($obfuscated, $key);
+			return true;
+		} catch (InvalidArgumentException $ex) {
+		}
+		return false;
+	}
 }