jon48 / webtrees-lib

app/Module/Certificates/Hooks/SourceCertificateIconHook.php

Spacing +2 added lines, -2 removed lines

@@ -61,12 +61,12 @@
     public function factSourcePrepend(Tree $tree, $fact): string
     {
         $permission_level = $tree->getPreference('MAJ_CERTIF_SHOW_CERT');
-        if (is_numeric($permission_level) && Auth::accessLevel($tree) <= (int) $permission_level) {
+        if (is_numeric($permission_level) && Auth::accessLevel($tree) <= (int)$permission_level) {
             $path = $this->extractPath($fact);
 
             if ($path !== '') {
                 $certificate = new Certificate($tree, $path);
-                return view($this->module->name() . '::components/certificate-icon', [
+                return view($this->module->name().'::components/certificate-icon', [
                     'module_name'               =>  $this->module->name(),
                     'certificate'               =>  $certificate,
                     'url_obfuscator_service'    =>  $this->url_obfuscator_service,

Indentation +77 added lines, -77 removed lines

@@ -30,87 +30,87 @@
  */
 class SourceCertificateIconHook implements FactSourceTextExtenderInterface
 {
-    private CertificatesModule $module;
-    private UrlObfuscatorService $url_obfuscator_service;
+	private CertificatesModule $module;
+	private UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for SourceCertificateIconHook
-     *
-     * @param CertificatesModule $module
-     * @param UrlObfuscatorService $url_obfuscator_service
-     */
-    public function __construct(CertificatesModule $module, UrlObfuscatorService $url_obfuscator_service)
-    {
-        $this->module = $module;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
+	/**
+	 * Constructor for SourceCertificateIconHook
+	 *
+	 * @param CertificatesModule $module
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 */
+	public function __construct(CertificatesModule $module, UrlObfuscatorService $url_obfuscator_service)
+	{
+		$this->module = $module;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
 
-    /**
-     * {@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\FactSourceTextExtenderInterface::factSourcePrepend()
-     */
-    public function factSourcePrepend(Tree $tree, $fact): string
-    {
-        $permission_level = $tree->getPreference('MAJ_CERTIF_SHOW_CERT');
-        if (is_numeric($permission_level) && Auth::accessLevel($tree) <= (int) $permission_level) {
-            $path = $this->extractPath($fact);
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourcePrepend()
+	 */
+	public function factSourcePrepend(Tree $tree, $fact): string
+	{
+		$permission_level = $tree->getPreference('MAJ_CERTIF_SHOW_CERT');
+		if (is_numeric($permission_level) && Auth::accessLevel($tree) <= (int) $permission_level) {
+			$path = $this->extractPath($fact);
 
-            if ($path !== '') {
-                $certificate = new Certificate($tree, $path);
-                return view($this->module->name() . '::components/certificate-icon', [
-                    'module_name'               =>  $this->module->name(),
-                    'certificate'               =>  $certificate,
-                    'url_obfuscator_service'    =>  $this->url_obfuscator_service,
-                    'js_script_url'             =>  $this->module->assetUrl('js/certificates.min.js')
-                ]);
-            }
-        }
-        return '';
-    }
+			if ($path !== '') {
+				$certificate = new Certificate($tree, $path);
+				return view($this->module->name() . '::components/certificate-icon', [
+					'module_name'               =>  $this->module->name(),
+					'certificate'               =>  $certificate,
+					'url_obfuscator_service'    =>  $this->url_obfuscator_service,
+					'js_script_url'             =>  $this->module->assetUrl('js/certificates.min.js')
+				]);
+			}
+		}
+		return '';
+	}
 
-    /**
-     * Extract path from the provided fact objet.
-     *
-     * @param \Fisharebest\Webtrees\Fact|array<array<\Fisharebest\Webtrees\Contracts\ElementInterface|string>> $fact
-     * @return string
-     * @psalm-suppress RedundantConditionGivenDocblockType
-     */
-    private function extractPath($fact): string
-    {
-        if ($fact instanceof Fact && $fact->target() instanceof Source) {
-            return $fact->attribute('_ACT');
-        } elseif (
-            is_array($fact) && count($fact) === 2
-            && null !== ($source_elements = $fact[0]) && is_array($source_elements) // @phpstan-ignore-line
-            && null !== ($source_values = $fact[1]) && is_array($source_values) // @phpstan-ignore-line
-        ) {
-            foreach ($source_elements as $key => $element) {
-                if (
-                    $element instanceof SourceCertificate
-                    && isset($source_values[$key]) && is_string($source_values[$key])
-                ) {
-                    return $element->canonical($source_values[$key]);
-                }
-            }
-        }
-        return '';
-    }
+	/**
+	 * Extract path from the provided fact objet.
+	 *
+	 * @param \Fisharebest\Webtrees\Fact|array<array<\Fisharebest\Webtrees\Contracts\ElementInterface|string>> $fact
+	 * @return string
+	 * @psalm-suppress RedundantConditionGivenDocblockType
+	 */
+	private function extractPath($fact): string
+	{
+		if ($fact instanceof Fact && $fact->target() instanceof Source) {
+			return $fact->attribute('_ACT');
+		} elseif (
+			is_array($fact) && count($fact) === 2
+			&& null !== ($source_elements = $fact[0]) && is_array($source_elements) // @phpstan-ignore-line
+			&& null !== ($source_values = $fact[1]) && is_array($source_values) // @phpstan-ignore-line
+		) {
+			foreach ($source_elements as $key => $element) {
+				if (
+					$element instanceof SourceCertificate
+					&& isset($source_values[$key]) && is_string($source_values[$key])
+				) {
+					return $element->canonical($source_values[$key]);
+				}
+			}
+		}
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourceAppend()
-     */
-    public function factSourceAppend(Tree $tree, $fact): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourceAppend()
+	 */
+	public function factSourceAppend(Tree $tree, $fact): string
+	{
+		return '';
+	}
 }

app/Module/Certificates/Factories/CertificateImageFactory.php

Spacing +10 added lines, -10 removed lines

@@ -79,7 +79,7 @@ 
         bool $add_watermark = false,
         Watermark $watermark = null
     ): ResponseInterface {
-        $filesystem =  $this->filesystem_service->filesystem($certificate->tree());
+        $filesystem = $this->filesystem_service->filesystem($certificate->tree());
         $filename   = $certificate->path();
 
         if (!$add_watermark) {
@@ -98,34 +98,34 @@ 
             $height = $image->height();
 
             $watermark->adjustSize($width);
-            $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5);
+            $watermark_x = (int)ceil($watermark->textLengthEstimate() * 1.5);
             $watermark_y = $watermark->size() * 12 + 1;
 
-            $font_definition = function (AbstractFont $font) use ($watermark): void {
-                $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf');
+            $font_definition = function(AbstractFont $font) use ($watermark): void {
+                $font->file(Webtrees::ROOT_DIR.'resources/fonts/DejaVuSans.ttf');
                 $font->color($watermark->color());
                 $font->size($watermark->size());
                 $font->valign('top');
             };
 
-            for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
-                for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
+            for ($i = min((int)ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
+                for ($j = min((int)ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
                     $image = $image->text($watermark->text(), $i, $j, $font_definition);
                 }
             }
 
             $format  = static::SUPPORTED_FORMATS[$image->mime()] ?? 'jpg';
             $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY);
-            $data    = (string) $image->encode($format, $quality);
+            $data    = (string)$image->encode($format, $quality);
 
             return $this->imageResponse($data, $image->mime(), '');
         } catch (NotReadableException $ex) {
             return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION))
             ->withHeader('X-Image-Exception', $ex->getMessage());
         } catch (FilesystemException | UnableToReadFile $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND);
+            return $this->replacementImageResponse((string)StatusCodeInterface::STATUS_NOT_FOUND);
         } catch (Throwable $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
+            return $this->replacementImageResponse((string)StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
             ->withHeader('X-Image-Exception', $ex->getMessage());
         }
     }
@@ -140,7 +140,7 @@ 
     public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool
     {
         $tree = $certificate->tree();
-        $watermark_level = (int) ($tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK', (string) Auth::PRIV_HIDE));
+        $watermark_level = (int)($tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK', (string)Auth::PRIV_HIDE));
 
         return Auth::accessLevel($tree, $user) > $watermark_level;
     }

Indentation +160 added lines, -160 removed lines

@@ -39,164 +39,164 @@
  */
 class CertificateImageFactory extends ImageFactory implements ImageFactoryInterface
 {
-    /**
-     * @var CertificateFilesystemService $filesystem_service
-     */
-    private $filesystem_service;
-
-    /**
-     * Constructor for the Certificate Image Factory
-     *
-     * @param CertificateFilesystemService $filesystem_service
-     */
-    public function __construct(CertificateFilesystemService $filesystem_service)
-    {
-        $this->filesystem_service = $filesystem_service;
-    }
-
-    /**
-     * Check is a file MIME type is supported by the system.
-     *
-     * @param string $mime
-     * @return bool
-     */
-    public function isMimeTypeSupported(string $mime): bool
-    {
-        return array_key_exists($mime, self::SUPPORTED_FORMATS);
-    }
-
-    /**
-     * Create a full-size version of a certificate.
-     *
-     * @param Certificate $certificate
-     * @param bool $add_watermark
-     * @param Watermark $watermark
-     * @throws InvalidArgumentException
-     * @return ResponseInterface
-     */
-    public function certificateFileResponse(
-        Certificate $certificate,
-        bool $add_watermark = false,
-        Watermark $watermark = null
-    ): ResponseInterface {
-        $filesystem =  $this->filesystem_service->filesystem($certificate->tree());
-        $filename   = $certificate->path();
-
-        if (!$add_watermark) {
-            return $this->fileResponse($filesystem, $filename, false);
-        }
-
-        try {
-            $image = $this->imageManager()->make($filesystem->readStream($filename));
-            $image = $this->autorotateImage($image);
-
-            if ($watermark === null) {
-                throw new InvalidArgumentException('Watermark data not defined');
-            }
-
-            $width = $image->width();
-            $height = $image->height();
-
-            $watermark->adjustSize($width);
-            $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5);
-            $watermark_y = $watermark->size() * 12 + 1;
-
-            $font_definition = function (AbstractFont $font) use ($watermark): void {
-                $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf');
-                $font->color($watermark->color());
-                $font->size($watermark->size());
-                $font->valign('top');
-            };
-
-            for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
-                for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
-                    $image = $image->text($watermark->text(), $i, $j, $font_definition);
-                }
-            }
-
-            $format  = static::SUPPORTED_FORMATS[$image->mime()] ?? 'jpg';
-            $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY);
-            $data    = (string) $image->encode($format, $quality);
-
-            return $this->imageResponse($data, $image->mime(), '');
-        } catch (NotReadableException $ex) {
-            return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION))
-            ->withHeader('X-Image-Exception', $ex->getMessage());
-        } catch (FilesystemException | UnableToReadFile $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND);
-        } catch (Throwable $ex) {
-            return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
-            ->withHeader('X-Image-Exception', $ex->getMessage());
-        }
-    }
-
-    /**
-     * Does a full-sized certificate need a watermark?
-     *
-     * @param Certificate $certificate
-     * @param UserInterface $user
-     * @return bool
-     */
-    public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool
-    {
-        $tree = $certificate->tree();
-        $watermark_level = (int) ($tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK', (string) Auth::PRIV_HIDE));
-
-        return Auth::accessLevel($tree, $user) > $watermark_level;
-    }
-
-    /**
-     * Neutralise the methods associated with MediaFile.
-     */
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileResponse()
-     */
-    public function mediaFileResponse(MediaFile $media_file, bool $add_watermark, bool $download): ResponseInterface
-    {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileThumbnailResponse()
-     */
-    public function mediaFileThumbnailResponse(
-        MediaFile $media_file,
-        int $width,
-        int $height,
-        string $fit,
-        bool $add_watermark
-    ): ResponseInterface {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::createWatermark()
-     */
-    public function createWatermark(int $width, int $height, MediaFile $media_file): Image
-    {
-
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::fileNeedsWatermark()
-     */
-    public function fileNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
-    {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Factories\ImageFactory::thumbnailNeedsWatermark()
-     */
-    public function thumbnailNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
-    {
-        throw new BadMethodCallException("Invalid method for Certificates");
-    }
+	/**
+	 * @var CertificateFilesystemService $filesystem_service
+	 */
+	private $filesystem_service;
+
+	/**
+	 * Constructor for the Certificate Image Factory
+	 *
+	 * @param CertificateFilesystemService $filesystem_service
+	 */
+	public function __construct(CertificateFilesystemService $filesystem_service)
+	{
+		$this->filesystem_service = $filesystem_service;
+	}
+
+	/**
+	 * Check is a file MIME type is supported by the system.
+	 *
+	 * @param string $mime
+	 * @return bool
+	 */
+	public function isMimeTypeSupported(string $mime): bool
+	{
+		return array_key_exists($mime, self::SUPPORTED_FORMATS);
+	}
+
+	/**
+	 * Create a full-size version of a certificate.
+	 *
+	 * @param Certificate $certificate
+	 * @param bool $add_watermark
+	 * @param Watermark $watermark
+	 * @throws InvalidArgumentException
+	 * @return ResponseInterface
+	 */
+	public function certificateFileResponse(
+		Certificate $certificate,
+		bool $add_watermark = false,
+		Watermark $watermark = null
+	): ResponseInterface {
+		$filesystem =  $this->filesystem_service->filesystem($certificate->tree());
+		$filename   = $certificate->path();
+
+		if (!$add_watermark) {
+			return $this->fileResponse($filesystem, $filename, false);
+		}
+
+		try {
+			$image = $this->imageManager()->make($filesystem->readStream($filename));
+			$image = $this->autorotateImage($image);
+
+			if ($watermark === null) {
+				throw new InvalidArgumentException('Watermark data not defined');
+			}
+
+			$width = $image->width();
+			$height = $image->height();
+
+			$watermark->adjustSize($width);
+			$watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5);
+			$watermark_y = $watermark->size() * 12 + 1;
+
+			$font_definition = function (AbstractFont $font) use ($watermark): void {
+				$font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf');
+				$font->color($watermark->color());
+				$font->size($watermark->size());
+				$font->valign('top');
+			};
+
+			for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) {
+				for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) {
+					$image = $image->text($watermark->text(), $i, $j, $font_definition);
+				}
+			}
+
+			$format  = static::SUPPORTED_FORMATS[$image->mime()] ?? 'jpg';
+			$quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY);
+			$data    = (string) $image->encode($format, $quality);
+
+			return $this->imageResponse($data, $image->mime(), '');
+		} catch (NotReadableException $ex) {
+			return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION))
+			->withHeader('X-Image-Exception', $ex->getMessage());
+		} catch (FilesystemException | UnableToReadFile $ex) {
+			return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND);
+		} catch (Throwable $ex) {
+			return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR)
+			->withHeader('X-Image-Exception', $ex->getMessage());
+		}
+	}
+
+	/**
+	 * Does a full-sized certificate need a watermark?
+	 *
+	 * @param Certificate $certificate
+	 * @param UserInterface $user
+	 * @return bool
+	 */
+	public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool
+	{
+		$tree = $certificate->tree();
+		$watermark_level = (int) ($tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK', (string) Auth::PRIV_HIDE));
+
+		return Auth::accessLevel($tree, $user) > $watermark_level;
+	}
+
+	/**
+	 * Neutralise the methods associated with MediaFile.
+	 */
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileResponse()
+	 */
+	public function mediaFileResponse(MediaFile $media_file, bool $add_watermark, bool $download): ResponseInterface
+	{
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileThumbnailResponse()
+	 */
+	public function mediaFileThumbnailResponse(
+		MediaFile $media_file,
+		int $width,
+		int $height,
+		string $fit,
+		bool $add_watermark
+	): ResponseInterface {
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::createWatermark()
+	 */
+	public function createWatermark(int $width, int $height, MediaFile $media_file): Image
+	{
+
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::fileNeedsWatermark()
+	 */
+	public function fileNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
+	{
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Factories\ImageFactory::thumbnailNeedsWatermark()
+	 */
+	public function thumbnailNeedsWatermark(MediaFile $media_file, UserInterface $user): bool
+	{
+		throw new BadMethodCallException("Invalid method for Certificates");
+	}
 }

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;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -71,10 +71,10 @@
             return collect();
         }
 
-        $query  =  Validator::attributes($request)->string('query', '');
+        $query = Validator::attributes($request)->string('query', '');
 
         /** @var Collection<int, string> $results */
-        $results =  $this->certif_filesystem
+        $results = $this->certif_filesystem
             ->certificatesForCityContaining($tree, $city, $query)
             ->map(fn(Certificate $certificate): string => $certificate->filename());
 

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.');
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -83,7 +83,7 @@ 
 
         if ($certificate === null) {
             return $this->certif_image_factory
-                ->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND)
+                ->replacementImageResponse((string)StatusCodeInterface::STATUS_NOT_FOUND)
                 ->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.'))
             ;
         }
@@ -111,7 +111,7 @@ 
         $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);
+        return new Watermark($text, $color, is_numeric($size) ? (int)$size : Watermark::DEFAULT_SIZE);
     }
 
     /**

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

Spacing +4 added lines, -4 removed lines

@@ -62,11 +62,11 @@ 
 
         $tree->setPreference(
             'MAJ_CERTIF_SHOW_CERT',
-            (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE)
+            (string)Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE)
         );
         $tree->setPreference(
             'MAJ_CERTIF_SHOW_NO_WATERMARK',
-            (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE)
+            (string)Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE)
         );
         $tree->setPreference(
             'MAJ_CERTIF_WM_DEFAULT',
@@ -75,7 +75,7 @@ 
 
         $tree->setPreference(
             'MAJ_CERTIF_WM_FONT_MAXSIZE',
-            (string) (
+            (string)(
                 Validator::parsedBody($request)->isBetween(0, PHP_INT_MAX)->integer('MAJ_CERTIF_WM_FONT_MAXSIZE', 18)
             )
         );
@@ -89,7 +89,7 @@ 
         // Only accept valid folders for MAJ_CERT_ROOTDIR
         $cert_root_dir = Validator::parsedBody($request)->string('MAJ_CERTIF_ROOTDIR', '');
         $cert_root_dir = preg_replace('/[:\/\\\\]+/', '/', $cert_root_dir) ?? '';
-        $cert_root_dir = trim($cert_root_dir, '/') . '/';
+        $cert_root_dir = trim($cert_root_dir, '/').'/';
         $tree->setPreference('MAJ_CERTIF_ROOTDIR', $cert_root_dir);
 
         FlashMessages::addMessage(

Indentation +58 added lines, -58 removed lines

@@ -30,71 +30,71 @@
  */
 class AdminConfigAction implements RequestHandlerInterface
 {
-    private ?CertificatesModule $module;
+	private ?CertificatesModule $module;
 
-    /**
-     * Constructor for Admin Config Action request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-    }
+	/**
+	 * Constructor for Admin Config Action request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = Validator::attributes($request)->tree();
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = Validator::attributes($request)->tree();
 
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
-        }
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
+		}
 
-        $tree->setPreference(
-            'MAJ_CERTIF_SHOW_CERT',
-            (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE)
-        );
-        $tree->setPreference(
-            'MAJ_CERTIF_SHOW_NO_WATERMARK',
-            (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE)
-        );
-        $tree->setPreference(
-            'MAJ_CERTIF_WM_DEFAULT',
-            Validator::parsedBody($request)->string('MAJ_CERTIF_WM_DEFAULT', '')
-        );
+		$tree->setPreference(
+			'MAJ_CERTIF_SHOW_CERT',
+			(string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE)
+		);
+		$tree->setPreference(
+			'MAJ_CERTIF_SHOW_NO_WATERMARK',
+			(string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE)
+		);
+		$tree->setPreference(
+			'MAJ_CERTIF_WM_DEFAULT',
+			Validator::parsedBody($request)->string('MAJ_CERTIF_WM_DEFAULT', '')
+		);
 
-        $tree->setPreference(
-            'MAJ_CERTIF_WM_FONT_MAXSIZE',
-            (string) (
-                Validator::parsedBody($request)->isBetween(0, PHP_INT_MAX)->integer('MAJ_CERTIF_WM_FONT_MAXSIZE', 18)
-            )
-        );
+		$tree->setPreference(
+			'MAJ_CERTIF_WM_FONT_MAXSIZE',
+			(string) (
+				Validator::parsedBody($request)->isBetween(0, PHP_INT_MAX)->integer('MAJ_CERTIF_WM_FONT_MAXSIZE', 18)
+			)
+		);
 
-        // Only accept valid color for MAJ_WM_FONT_COLOR
-        $watermark_color = Validator::parsedBody($request)->string('MAJ_CERTIF_WM_FONT_COLOR', '');
-        if (preg_match('/#([a-fA-F0-9]{3}){1,2}/', $watermark_color) === 1) {
-            $tree->setPreference('MAJ_CERTIF_WM_FONT_COLOR', $watermark_color);
-        }
+		// Only accept valid color for MAJ_WM_FONT_COLOR
+		$watermark_color = Validator::parsedBody($request)->string('MAJ_CERTIF_WM_FONT_COLOR', '');
+		if (preg_match('/#([a-fA-F0-9]{3}){1,2}/', $watermark_color) === 1) {
+			$tree->setPreference('MAJ_CERTIF_WM_FONT_COLOR', $watermark_color);
+		}
 
-        // Only accept valid folders for MAJ_CERT_ROOTDIR
-        $cert_root_dir = Validator::parsedBody($request)->string('MAJ_CERTIF_ROOTDIR', '');
-        $cert_root_dir = preg_replace('/[:\/\\\\]+/', '/', $cert_root_dir) ?? '';
-        $cert_root_dir = trim($cert_root_dir, '/') . '/';
-        $tree->setPreference('MAJ_CERTIF_ROOTDIR', $cert_root_dir);
+		// Only accept valid folders for MAJ_CERT_ROOTDIR
+		$cert_root_dir = Validator::parsedBody($request)->string('MAJ_CERTIF_ROOTDIR', '');
+		$cert_root_dir = preg_replace('/[:\/\\\\]+/', '/', $cert_root_dir) ?? '';
+		$cert_root_dir = trim($cert_root_dir, '/') . '/';
+		$tree->setPreference('MAJ_CERTIF_ROOTDIR', $cert_root_dir);
 
-        FlashMessages::addMessage(
-            I18N::translate('The preferences for the module “%s” have been updated.', $this->module->title()),
-            'success'
-        );
+		FlashMessages::addMessage(
+			I18N::translate('The preferences for the module “%s” have been updated.', $this->module->title()),
+			'success'
+		);
 
-        return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
-    }
+		return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
+	}
 }

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;
+	}
 }

Spacing +2 added lines, -3 removed lines

@@ -43,8 +43,7 @@ 
             $server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? '';
             $this->encryption_key = str_pad(md5(
                 $server_name !== '' && $server_software !== '' ?
-                $server_name . $server_software :
-                'STANDARDKEYIFNOSERVER'
+                $server_name.$server_software : 'STANDARDKEYIFNOSERVER'
             ), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF");
         }
         return $this->encryption_key;
@@ -77,7 +76,7 @@ 
         }
 
         $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key);
-        return strtr(base64_encode($nonce . $encryted), '+/=', '._-');
+        return strtr(base64_encode($nonce.$encryted), '+/=', '._-');
     }
 
     /**

app/Module/IsSourced/Services/SourceStatusService.php

Indentation +122 added lines, -122 removed lines

@@ -29,126 +29,126 @@
  */
 class SourceStatusService
 {
-    /**
-     * Maximum timespan between the date of a source and the date of the event to consider the source precise.
-     * Arbitrally set to approximately a year around the event date.
-     *
-     * @var int DATE_PRECISION_MARGIN
-     */
-    private const DATE_PRECISION_MARGIN = 180;
-
-    /**
-     * Return the status of source citations for a fact.
-     *
-     * @param Fact $fact
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForFact(Fact $fact): FactSourceStatus
-    {
-        $source_status = new FactSourceStatus();
-
-        $date = $fact->date();
-        $source_status
-            ->setFactHasDate($date->isOK())
-            ->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay());
-
-        foreach ($fact->getCitations() as $citation) {
-            $source_status
-                ->setHasSource(true)
-                ->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1);
-
-            preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER);
-            foreach ($date_matches as $date_match) {
-                $source_date = new Date($date_match[1]);
-                $source_status
-                    ->addSourceHasDate($source_date->isOK())
-                    ->addSourceMatchesFactDate($date->isOK() && $source_date->isOK()
-                        && abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN);
-            }
-
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of sources for a Gedcom record.
-     *
-     * @param GedcomRecord $record
-     * @return SourceStatus
-     */
-    public function sourceStatusForRecord(GedcomRecord $record): SourceStatus
-    {
-        $source_status = new SourceStatus();
-
-        foreach ($record->facts(['SOUR']) as $source) {
-            $source_status
-                ->setHasSource(true)
-                ->addHasSupportingDocument($source->attribute('_ACT') !== '');
-
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of source citations for a list of fact types associated with a record.
-     *
-     * @param GedcomRecord $record
-     * @param string[] $tags
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus
-    {
-        $source_status = new NullFactSourceStatus();
-
-        foreach ($record->facts($tags) as $fact) {
-            $source_status = $source_status->combineWith($this->sourceStatusForFact($fact));
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of source citations for an individual's birth events.
-     *
-     * @param Individual $individual
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForBirth(Individual $individual): FactSourceStatus
-    {
-        return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS);
-    }
-
-    /**
-     * Return the status of source citations for an individual's death events.
-     *
-     * @param Individual $individual
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForDeath(Individual $individual): FactSourceStatus
-    {
-        return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS);
-    }
-
-    /**
-     * Return the status of source citations for a family's marriage events.
-     *
-     * @param Family $family
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForMarriage(Family $family): FactSourceStatus
-    {
-        $marr_events = [...Gedcom::MARRIAGE_EVENTS, 'MARC', 'MARL', 'MARS'];
-        return $this->sourceStatusForFactsWithTags($family, $marr_events);
-    }
+	/**
+	 * Maximum timespan between the date of a source and the date of the event to consider the source precise.
+	 * Arbitrally set to approximately a year around the event date.
+	 *
+	 * @var int DATE_PRECISION_MARGIN
+	 */
+	private const DATE_PRECISION_MARGIN = 180;
+
+	/**
+	 * Return the status of source citations for a fact.
+	 *
+	 * @param Fact $fact
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForFact(Fact $fact): FactSourceStatus
+	{
+		$source_status = new FactSourceStatus();
+
+		$date = $fact->date();
+		$source_status
+			->setFactHasDate($date->isOK())
+			->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay());
+
+		foreach ($fact->getCitations() as $citation) {
+			$source_status
+				->setHasSource(true)
+				->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1);
+
+			preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER);
+			foreach ($date_matches as $date_match) {
+				$source_date = new Date($date_match[1]);
+				$source_status
+					->addSourceHasDate($source_date->isOK())
+					->addSourceMatchesFactDate($date->isOK() && $source_date->isOK()
+						&& abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN);
+			}
+
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of sources for a Gedcom record.
+	 *
+	 * @param GedcomRecord $record
+	 * @return SourceStatus
+	 */
+	public function sourceStatusForRecord(GedcomRecord $record): SourceStatus
+	{
+		$source_status = new SourceStatus();
+
+		foreach ($record->facts(['SOUR']) as $source) {
+			$source_status
+				->setHasSource(true)
+				->addHasSupportingDocument($source->attribute('_ACT') !== '');
+
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of source citations for a list of fact types associated with a record.
+	 *
+	 * @param GedcomRecord $record
+	 * @param string[] $tags
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus
+	{
+		$source_status = new NullFactSourceStatus();
+
+		foreach ($record->facts($tags) as $fact) {
+			$source_status = $source_status->combineWith($this->sourceStatusForFact($fact));
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of source citations for an individual's birth events.
+	 *
+	 * @param Individual $individual
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForBirth(Individual $individual): FactSourceStatus
+	{
+		return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS);
+	}
+
+	/**
+	 * Return the status of source citations for an individual's death events.
+	 *
+	 * @param Individual $individual
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForDeath(Individual $individual): FactSourceStatus
+	{
+		return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS);
+	}
+
+	/**
+	 * Return the status of source citations for a family's marriage events.
+	 *
+	 * @param Family $family
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForMarriage(Family $family): FactSourceStatus
+	{
+		$marr_events = [...Gedcom::MARRIAGE_EVENTS, 'MARC', 'MARL', 'MARS'];
+		return $this->sourceStatusForFactsWithTags($family, $marr_events);
+	}
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisPlace.php

Indentation +129 added lines, -129 removed lines

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

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResultItem.php

Indentation +57 added lines, -57 removed lines

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