jon48 / webtrees-lib

src/Webtrees/Module/Certificates/Http/RequestHandlers/CertificatePage.php

Indentation +76 added lines, -76 removed lines

@@ -34,80 +34,80 @@
  */
 class CertificatePage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var CertificatesModule|null $module
-     */
-    private $module;
-
-    /**
-     * @var CertificateFilesystemService $certif_filesystem
-     */
-    private $certif_filesystem;
-
-    /**
-     * @var CertificateDataService $certif_data_service
-     */
-    private $certif_data_service;
-
-    /**
-     * @var UrlObfuscatorService $url_obfuscator_service
-     */
-    private $url_obfuscator_service;
-
-
-    /**
-     * Constructor for CertificatePage Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param CertificateFilesystemService $certif_filesystem
-     * @param CertificateDataService $certif_data_service
-     * @param UrlObfuscatorService $url_obfuscator_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_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 = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $certif_path = $request->getAttribute('cid');
-        if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) {
-            $certificate = $this->certif_filesystem->certificate($tree, $certif_path);
-        }
-
-        if (!isset($certificate)) {
-            FlashMessages::addMessage('The requested certificate is not valid.');
-            return redirect(route(TreePage::class, ['tree' => $tree->name()]));
-        }
-
-        return $this->viewResponse($this->module->name() . '::certificate-page', [
-            'title'                     =>  I18N::translate('Certificate - %s', $certificate->name()),
-            'tree'                      =>  $tree,
-            'module_name'               =>  $this->module->name(),
-            'certificate'               =>  $certificate,
-            'url_obfuscator_service'    =>  $this->url_obfuscator_service,
-            'linked_individuals'        =>  $this->certif_data_service->linkedIndividuals($certificate),
-            'linked_families'           =>  $this->certif_data_service->linkedFamilies($certificate)
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var CertificatesModule|null $module
+	 */
+	private $module;
+
+	/**
+	 * @var CertificateFilesystemService $certif_filesystem
+	 */
+	private $certif_filesystem;
+
+	/**
+	 * @var CertificateDataService $certif_data_service
+	 */
+	private $certif_data_service;
+
+	/**
+	 * @var UrlObfuscatorService $url_obfuscator_service
+	 */
+	private $url_obfuscator_service;
+
+
+	/**
+	 * Constructor for CertificatePage Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param CertificateFilesystemService $certif_filesystem
+	 * @param CertificateDataService $certif_data_service
+	 * @param UrlObfuscatorService $url_obfuscator_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_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 = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$certif_path = $request->getAttribute('cid');
+		if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) {
+			$certificate = $this->certif_filesystem->certificate($tree, $certif_path);
+		}
+
+		if (!isset($certificate)) {
+			FlashMessages::addMessage('The requested certificate is not valid.');
+			return redirect(route(TreePage::class, ['tree' => $tree->name()]));
+		}
+
+		return $this->viewResponse($this->module->name() . '::certificate-page', [
+			'title'                     =>  I18N::translate('Certificate - %s', $certificate->name()),
+			'tree'                      =>  $tree,
+			'module_name'               =>  $this->module->name(),
+			'certificate'               =>  $certificate,
+			'url_obfuscator_service'    =>  $this->url_obfuscator_service,
+			'linked_individuals'        =>  $this->certif_data_service->linkedIndividuals($certificate),
+			'linked_families'           =>  $this->certif_data_service->linkedFamilies($certificate)
+		]);
+	}
 }

src/Webtrees/Module/Certificates/Http/RequestHandlers/AdminConfigAction.php

Indentation +67 added lines, -67 removed lines

@@ -29,71 +29,71 @@
  */
 class AdminConfigAction implements RequestHandlerInterface
 {
-    /**
-     * @var CertificatesModule|null $module
-     */
-    private $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();
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $admin_config_route = route(AdminConfigPage::class, ['tree' => $tree->name()]);
-
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-        $params = (array) $request->getParsedBody();
-
-        $tree->setPreference('MAJ_CERTIF_SHOW_CERT', $params['MAJ_CERTIF_SHOW_CERT'] ?? (string) Auth::PRIV_HIDE);
-        $tree->setPreference(
-            'MAJ_CERTIF_SHOW_NO_WATERMARK',
-            $params['MAJ_CERTIF_SHOW_NO_WATERMARK'] ?? (string) Auth::PRIV_HIDE
-        );
-        $tree->setPreference('MAJ_CERTIF_WM_DEFAULT', $params['MAJ_CERTIF_WM_DEFAULT'] ?? '');
-
-        $watermark_font_size = $params['MAJ_CERTIF_WM_FONT_MAXSIZE'] ?? '';
-        if (is_numeric($watermark_font_size) && $watermark_font_size > 0) {
-            $tree->setPreference('MAJ_CERTIF_WM_FONT_MAXSIZE', $params['MAJ_CERTIF_WM_FONT_MAXSIZE']);
-        }
-
-        // Only accept valid color for MAJ_WM_FONT_COLOR
-        $watermark_color = $params['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 = $params['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'
-        );
-
-        return redirect($admin_config_route);
-    }
+	/**
+	 * @var CertificatesModule|null $module
+	 */
+	private $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();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$admin_config_route = route(AdminConfigPage::class, ['tree' => $tree->name()]);
+
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+		$params = (array) $request->getParsedBody();
+
+		$tree->setPreference('MAJ_CERTIF_SHOW_CERT', $params['MAJ_CERTIF_SHOW_CERT'] ?? (string) Auth::PRIV_HIDE);
+		$tree->setPreference(
+			'MAJ_CERTIF_SHOW_NO_WATERMARK',
+			$params['MAJ_CERTIF_SHOW_NO_WATERMARK'] ?? (string) Auth::PRIV_HIDE
+		);
+		$tree->setPreference('MAJ_CERTIF_WM_DEFAULT', $params['MAJ_CERTIF_WM_DEFAULT'] ?? '');
+
+		$watermark_font_size = $params['MAJ_CERTIF_WM_FONT_MAXSIZE'] ?? '';
+		if (is_numeric($watermark_font_size) && $watermark_font_size > 0) {
+			$tree->setPreference('MAJ_CERTIF_WM_FONT_MAXSIZE', $params['MAJ_CERTIF_WM_FONT_MAXSIZE']);
+		}
+
+		// Only accept valid color for MAJ_WM_FONT_COLOR
+		$watermark_color = $params['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 = $params['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'
+		);
+
+		return redirect($admin_config_route);
+	}
 }

src/Webtrees/Module/Certificates/Http/RequestHandlers/AdminConfigPage.php

Indentation +33 added lines, -33 removed lines

@@ -30,44 +30,44 @@
  */
 class AdminConfigPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var CertificatesModule|null $module
-     */
-    private $module;
+	/**
+	 * @var CertificatesModule|null $module
+	 */
+	private $module;
 
-    /**
-     * Constructor for Admin Config page request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-    }
+	/**
+	 * Constructor for Admin Config page 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
-    {
-        $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.'));
+		}
 
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $data_folder = Registry::filesystem()->dataName();
+		$data_folder = Registry::filesystem()->dataName();
 
-        return $this->viewResponse($this->module->name() . '::admin/config', [
-            'title'             =>  $this->module->title(),
-            'tree'              =>  $tree,
-            'data_folder'       =>  $data_folder
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/config', [
+			'title'             =>  $this->module->title(),
+			'tree'              =>  $tree,
+			'data_folder'       =>  $data_folder
+		]);
+	}
 }

src/Webtrees/Module/Certificates/Elements/SourceCertificate.php

Indentation +8 added lines, -8 removed lines

@@ -24,12 +24,12 @@
  */
 class SourceCertificate extends AbstractElement
 {
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
-     */
-    public function canonical($value): string
-    {
-        return strtr($value, '\\', '/');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
+	 */
+	public function canonical($value): string
+	{
+		return strtr($value, '\\', '/');
+	}
 }

src/Webtrees/Module/Certificates/Services/CertificateFilesystemService.php

Indentation +125 added lines, -125 removed lines

@@ -31,139 +31,139 @@
  */
 class CertificateFilesystemService
 {
-    /**
-     * @var array<int,FilesystemOperator> $filesystem
-     */
-    private $filesystem = [];
+	/**
+	 * @var array<int,FilesystemOperator> $filesystem
+	 */
+	private $filesystem = [];
 
-    /**
-     * Get the filesystem containing certificates for a tree.
-     *
-     * @param Tree $tree
-     * @return FilesystemOperator
-     */
-    public function filesystem(Tree $tree): FilesystemOperator
-    {
-        if (!isset($this->filesystem[$tree->id()])) {
-            $cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/');
-            $adapter   = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir);
+	/**
+	 * Get the filesystem containing certificates for a tree.
+	 *
+	 * @param Tree $tree
+	 * @return FilesystemOperator
+	 */
+	public function filesystem(Tree $tree): FilesystemOperator
+	{
+		if (!isset($this->filesystem[$tree->id()])) {
+			$cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/');
+			$adapter   = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir);
 
-            $this->filesystem[$tree->id()] = new FileSystem($adapter);
-        }
-        return $this->filesystem[$tree->id()];
-    }
+			$this->filesystem[$tree->id()] = new FileSystem($adapter);
+		}
+		return $this->filesystem[$tree->id()];
+	}
 
-    /**
-     * Set the filesystem containing certificates for a tree.
-     *
-     * @param Tree $tree
-     * @param FilesystemOperator $filesystem
-     */
-    public function setFilesystem(Tree $tree, FilesystemOperator $filesystem): void
-    {
-        $this->filesystem[$tree->id()] = $filesystem;
-    }
+	/**
+	 * Set the filesystem containing certificates for a tree.
+	 *
+	 * @param Tree $tree
+	 * @param FilesystemOperator $filesystem
+	 */
+	public function setFilesystem(Tree $tree, FilesystemOperator $filesystem): void
+	{
+		$this->filesystem[$tree->id()] = $filesystem;
+	}
 
-    /**
-     * Create the Certificate object defined by a path on the filesystem.
-     *
-     * @param Tree $tree
-     * @param string $path
-     * @return Certificate|NULL
-     */
-    public function certificate(Tree $tree, string $path): ?Certificate
-    {
-        $filesystem = $this->filesystem($tree);
-        if ($filesystem->fileExists($path) && $this->isFileSupported($filesystem, $path)) {
-            return new Certificate($tree, $path);
-        }
-        return null;
-    }
+	/**
+	 * Create the Certificate object defined by a path on the filesystem.
+	 *
+	 * @param Tree $tree
+	 * @param string $path
+	 * @return Certificate|NULL
+	 */
+	public function certificate(Tree $tree, string $path): ?Certificate
+	{
+		$filesystem = $this->filesystem($tree);
+		if ($filesystem->fileExists($path) && $this->isFileSupported($filesystem, $path)) {
+			return new Certificate($tree, $path);
+		}
+		return null;
+	}
 
-    /**
-     * Get the cities (first-level folder) available in a the filesystem.
-     *
-     * @param Tree $tree
-     * @return string[]
-     */
-    public function cities(Tree $tree): array
-    {
-        return $this->filesystem($tree)
-            ->listContents('')
-            ->filter(function (StorageAttributes $attributes): bool {
-                return $attributes->isDir();
-            })->map(function (StorageAttributes $attributes): string {
-                return $attributes->path();
-            })->toArray();
-    }
+	/**
+	 * Get the cities (first-level folder) available in a the filesystem.
+	 *
+	 * @param Tree $tree
+	 * @return string[]
+	 */
+	public function cities(Tree $tree): array
+	{
+		return $this->filesystem($tree)
+			->listContents('')
+			->filter(function (StorageAttributes $attributes): bool {
+				return $attributes->isDir();
+			})->map(function (StorageAttributes $attributes): string {
+				return $attributes->path();
+			})->toArray();
+	}
 
-    /**
-     * Get the certificates available for a city (first-level folder).
-     *
-     * @param Tree $tree
-     * @param string $city
-     * @return Collection<Certificate>
-     */
-    public function certificatesForCity(Tree $tree, string $city): Collection
-    {
-        $filesystem = $this->filesystem($tree);
-        $certificate_paths = collect($filesystem
-            ->listContents($city)
-            ->filter(function (StorageAttributes $attributes) use ($filesystem): bool {
-                return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path());
-            })->map(function (StorageAttributes $attributes): string {
-                return $attributes->path();
-            })->toArray());
+	/**
+	 * Get the certificates available for a city (first-level folder).
+	 *
+	 * @param Tree $tree
+	 * @param string $city
+	 * @return Collection<Certificate>
+	 */
+	public function certificatesForCity(Tree $tree, string $city): Collection
+	{
+		$filesystem = $this->filesystem($tree);
+		$certificate_paths = collect($filesystem
+			->listContents($city)
+			->filter(function (StorageAttributes $attributes) use ($filesystem): bool {
+				return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path());
+			})->map(function (StorageAttributes $attributes): string {
+				return $attributes->path();
+			})->toArray());
 
-        return $certificate_paths->map(function (string $path) use ($tree): Certificate {
-            return new Certificate($tree, $path);
-        });
-    }
+		return $certificate_paths->map(function (string $path) use ($tree): Certificate {
+			return new Certificate($tree, $path);
+		});
+	}
 
-    /**
-     * Get the certificates available for a city (first-level folder), containing a specified text.
-     *
-     * @param Tree $tree
-     * @param string $city
-     * @param string $contains
-     * @return Collection<Certificate>
-     */
-    public function certificatesForCityContaining(Tree $tree, string $city, string $contains): Collection
-    {
-        $filesystem = $this->filesystem($tree);
-        $certificate_paths = collect($filesystem
-            ->listContents($city)
-            ->filter(function (StorageAttributes $attributes) use ($filesystem, $contains): bool {
-                return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path())
-                    && mb_stripos($attributes->path(), $contains) !== false;
-            })->map(function (StorageAttributes $attributes): string {
-                return $attributes->path();
-            })->toArray());
+	/**
+	 * Get the certificates available for a city (first-level folder), containing a specified text.
+	 *
+	 * @param Tree $tree
+	 * @param string $city
+	 * @param string $contains
+	 * @return Collection<Certificate>
+	 */
+	public function certificatesForCityContaining(Tree $tree, string $city, string $contains): Collection
+	{
+		$filesystem = $this->filesystem($tree);
+		$certificate_paths = collect($filesystem
+			->listContents($city)
+			->filter(function (StorageAttributes $attributes) use ($filesystem, $contains): bool {
+				return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path())
+					&& mb_stripos($attributes->path(), $contains) !== false;
+			})->map(function (StorageAttributes $attributes): string {
+				return $attributes->path();
+			})->toArray());
 
-        return $certificate_paths->map(function (string $path) use ($tree): Certificate {
-            return new Certificate($tree, $path);
-        });
-    }
+		return $certificate_paths->map(function (string $path) use ($tree): Certificate {
+			return new Certificate($tree, $path);
+		});
+	}
 
-    /**
-     * Check if a file on the filesystem is supported by the certificate module.
-     *
-     * @param FilesystemOperator $filesystem
-     * @param string $path
-     * @return bool
-     */
-    protected function isFileSupported(FilesystemOperator $filesystem, string $path): bool
-    {
-        try {
-            $mime = $filesystem->mimeType($path);
-            return Registry::cache()->array()->remember(
-                'maj-certif-supportedfiles-' . $mime,
-                function () use ($mime): bool {
-                    return app(CertificateImageFactory::class)->isMimeTypeSupported($mime);
-                }
-            );
-        } catch (UnableToRetrieveMetadata | FilesystemException $ex) {
-        }
-        return false;
-    }
+	/**
+	 * Check if a file on the filesystem is supported by the certificate module.
+	 *
+	 * @param FilesystemOperator $filesystem
+	 * @param string $path
+	 * @return bool
+	 */
+	protected function isFileSupported(FilesystemOperator $filesystem, string $path): bool
+	{
+		try {
+			$mime = $filesystem->mimeType($path);
+			return Registry::cache()->array()->remember(
+				'maj-certif-supportedfiles-' . $mime,
+				function () use ($mime): bool {
+					return app(CertificateImageFactory::class)->isMimeTypeSupported($mime);
+				}
+			);
+		} catch (UnableToRetrieveMetadata | FilesystemException $ex) {
+		}
+		return false;
+	}
 }

src/Webtrees/Module/Certificates/Services/UrlObfuscatorService.php

Indentation +117 added lines, -117 removed lines

@@ -23,121 +23,121 @@
  */
 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');
-        }
-
-        \Fisharebest\Webtrees\DebugBar::addMessage($key);
-        $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');
+		}
+
+		\Fisharebest\Webtrees\DebugBar::addMessage($key);
+		$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;
+	}
 }

src/Webtrees/Module/Certificates/Services/CertificateDataService.php

Indentation +131 added lines, -131 removed lines

@@ -29,143 +29,143 @@
 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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	protected function linkedRecordsLists(Certificate $certificate): Generator
+	{
+		yield $this->linkedIndividuals($certificate);
+		yield $this->linkedFamilies($certificate);
+		yield $this->linkedMedias($certificate);
+		yield $this->linkedNotes($certificate);
+	}
 }

src/Webtrees/Module/Certificates/Factories/CertificateImageFactory.php

Indentation +159 added lines, -159 removed lines

@@ -39,163 +39,163 @@
  */
 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::INTERVENTION_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::INTERVENTION_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();
-
-        return Auth::accessLevel($tree, $user) > $tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK');
-    }
-
-    /**
-     * 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::INTERVENTION_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::INTERVENTION_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();
+
+		return Auth::accessLevel($tree, $user) > $tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK');
+	}
+
+	/**
+	 * 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");
+	}
 }

src/Webtrees/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 \Brick\Geo\IO\GeoJSON\Feature[] $features
-     */
-    private array $features;
+	/**
+	 * @var \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 \Brick\Geo\IO\GeoJSON\Feature[]
-     */
-    public function features(): array
-    {
-        return $this->features;
-    }
+	/**
+	 * Get the list of features to display on the map
+	 *
+	 * @return \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 self
-     */
-    public function merge(MapAdapterResult $other): self
-    {
-        return new static(
-            $this->result->merge($other->result),
-            array_merge($this->features, $other->features)
-        );
-    }
+	/**
+	 * Merge the current MapAdapter with another.
+	 * The current object is modified, not the second one.
+	 *
+	 * @param MapAdapterResult $other
+	 * @return self
+	 */
+	public function merge(MapAdapterResult $other): self
+	{
+		return new static(
+			$this->result->merge($other->result),
+			array_merge($this->features, $other->features)
+		);
+	}
 }