jon48 / webtrees-lib

app/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);
+	}
 }

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

Indentation +124 added lines, -124 removed lines

@@ -37,128 +37,128 @@
  */
 class CertificateImage implements RequestHandlerInterface
 {
-    /**
-     * @var CertificatesModule|null $module
-     */
-    private $module;
-
-    /**
-     * @var CertificateFilesystemService $certif_filesystem
-     */
-    private $certif_filesystem;
-
-    /**
-     * @var CertificateImageFactory $certif_image_factory
-     */
-    private $certif_image_factory;
-
-    /**
-     * @var CertificateDataService $certif_data_service
-     */
-    private $certif_data_service;
-
-    /**
-     * @var UrlObfuscatorService $url_obfuscator_service
-     */
-    private $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 = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $user = $request->getAttribute('user');
-        assert($user instanceof UserInterface);
-
-        $certif_path = $request->getAttribute('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 = $request->getQueryParams()['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 $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.');
-    }
+	/**
+	 * @var CertificatesModule|null $module
+	 */
+	private $module;
+
+	/**
+	 * @var CertificateFilesystemService $certif_filesystem
+	 */
+	private $certif_filesystem;
+
+	/**
+	 * @var CertificateImageFactory $certif_image_factory
+	 */
+	private $certif_image_factory;
+
+	/**
+	 * @var CertificateDataService $certif_data_service
+	 */
+	private $certif_data_service;
+
+	/**
+	 * @var UrlObfuscatorService $url_obfuscator_service
+	 */
+	private $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 = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$user = $request->getAttribute('user');
+		assert($user instanceof UserInterface);
+
+		$certif_path = $request->getAttribute('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 = $request->getQueryParams()['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 $source->fullName();
+		}
+		$default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT');
+		return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.');
+	}
 }

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

Indentation +69 added lines, -69 removed lines

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

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

Indentation +44 added lines, -44 removed lines

@@ -34,58 +34,58 @@
  */
 class AdminConfigPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?CertificatesModule $module;
-    private TreeService $tree_service;
+	private ?CertificatesModule $module;
+	private TreeService $tree_service;
 
-    /**
-     * Constructor for Admin Config page request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, TreeService $tree_service)
-    {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->tree_service = $tree_service;
-    }
+	/**
+	 * Constructor for Admin Config page request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, TreeService $tree_service)
+	{
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->tree_service = $tree_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/administration';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/administration';
 
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $user = $request->getAttribute('user');
-        assert($user instanceof UserInterface);
+		$user = $request->getAttribute('user');
+		assert($user instanceof UserInterface);
 
-        $all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user));
-        if ($all_trees->count() === 0) {
-            throw new HttpAccessDeniedException();
-        }
+		$all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user));
+		if ($all_trees->count() === 0) {
+			throw new HttpAccessDeniedException();
+		}
 
-        $tree = $request->getAttribute('tree') ?? $all_trees->first();
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree') ?? $all_trees->first();
+		assert($tree instanceof Tree);
 
-        $data_folder = Registry::filesystem()->dataName();
+		$data_folder = Registry::filesystem()->dataName();
 
-        $same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id();
-        if (!$all_trees->contains($same_tree)) {
-            throw new HttpAccessDeniedException();
-        }
+		$same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id();
+		if (!$all_trees->contains($same_tree)) {
+			throw new HttpAccessDeniedException();
+		}
 
-        return $this->viewResponse($this->module->name() . '::admin/config', [
-            'module_name'       =>  $this->module->name(),
-            'title'             =>  $this->module->title(),
-            'tree'              =>  $tree,
-            'other_trees'       =>  $all_trees->reject($same_tree),
-            'data_folder'       =>  $data_folder
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/config', [
+			'module_name'       =>  $this->module->name(),
+			'title'             =>  $this->module->title(),
+			'tree'              =>  $tree,
+			'other_trees'       =>  $all_trees->reject($same_tree),
+			'data_folder'       =>  $data_folder
+		]);
+	}
 }

app/Module/Certificates/Http/RequestHandlers/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)
+		]);
+	}
 }

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

Indentation +43 added lines, -43 removed lines

@@ -30,55 +30,55 @@
  */
 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 = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search()
+	 */
+	protected function search(ServerRequestInterface $request): Collection
+	{
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $city = $request->getQueryParams()['cityobf'] ?? '';
+		$city = $request->getQueryParams()['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  = $request->getAttribute('query') ?? '';
+		$query  = $request->getAttribute('query') ?? '';
 
-        /** @var Collection<string> $results */
-        $results =  $this->certif_filesystem
-            ->certificatesForCityContaining($tree, $city, $query)
-            ->map(fn(Certificate $certificate): string => $certificate->filename());
+		/** @var Collection<string> $results */
+		$results =  $this->certif_filesystem
+			->certificatesForCityContaining($tree, $city, $query)
+			->map(fn(Certificate $certificate): string => $certificate->filename());
 
-        return $results;
-    }
+		return $results;
+	}
 }

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

app/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");
+	}
 }

app/Module/Certificates/Model/Watermark.php

Indentation +108 added lines, -108 removed lines

@@ -19,112 +19,112 @@
  */
 class Watermark
 {
-    /**
-     * Default font color for watermarks
-     * @var string DEFAULT_COLOR
-     * */
-    public const DEFAULT_COLOR = '#4D6DF3';
-
-    /**
-     * Default maximum font size for watermarks
-     * @var string DEFAULT_SIZE
-     * */
-    public const DEFAULT_SIZE = 18;
-
-    /**
-     * @var string $text
-     */
-    private $text;
-
-    /**
-     * @var string $color;
-     */
-    private $color;
-
-
-    /**
-     * @var int $size
-     */
-    private $size;
-
-    /**
-     * Constructor for Watermark data class
-     *
-     * @param string $text
-     * @param string $color
-     * @param int $size
-     */
-    public function __construct(string $text, string $color, int $size)
-    {
-        $this->text = $text;
-        $this->color = $color;
-        $this->size = $size;
-    }
-
-    /**
-     * Get the watermark text.
-     *
-     * @return string
-     */
-    public function text(): string
-    {
-        return $this->text;
-    }
-
-    /**
-     * Get the watermark font color.
-     *
-     * @return string
-     */
-    public function color(): string
-    {
-        return $this->color;
-    }
-
-    /**
-     * Get the watermark maximum font size.
-     * @return int
-     */
-    public function size(): int
-    {
-        return $this->size;
-    }
-
-    /**
-     * Return an estimate of the size in pixels of the watermark text length.
-     *
-     * @return int
-     */
-    public function textLengthEstimate(): int
-    {
-        return $this->stringLengthEstimate(mb_strlen($this->text), $this->size);
-    }
-
-    /**
-     * Decrease the font size if necessary, based on the image width.
-     *
-     * @param int $width
-     */
-    public function adjustSize(int $width): void
-    {
-        $len = mb_strlen($this->text);
-        while ($this->stringLengthEstimate($len, $this->size) > 0.9 * $width) {
-            $this->size--;
-            if ($this->size == 2) {
-                return;
-            }
-        }
-    }
-
-    /**
-     * Return an estimate of the size in pixels of a text in a specified font size.
-     *
-     * @param int $text_length
-     * @param int $font_size
-     * @return int
-     */
-    private function stringLengthEstimate(int $text_length, int $font_size): int
-    {
-        return $text_length * (int) ceil(($font_size + 2) * 0.5);
-    }
+	/**
+	 * Default font color for watermarks
+	 * @var string DEFAULT_COLOR
+	 * */
+	public const DEFAULT_COLOR = '#4D6DF3';
+
+	/**
+	 * Default maximum font size for watermarks
+	 * @var string DEFAULT_SIZE
+	 * */
+	public const DEFAULT_SIZE = 18;
+
+	/**
+	 * @var string $text
+	 */
+	private $text;
+
+	/**
+	 * @var string $color;
+	 */
+	private $color;
+
+
+	/**
+	 * @var int $size
+	 */
+	private $size;
+
+	/**
+	 * Constructor for Watermark data class
+	 *
+	 * @param string $text
+	 * @param string $color
+	 * @param int $size
+	 */
+	public function __construct(string $text, string $color, int $size)
+	{
+		$this->text = $text;
+		$this->color = $color;
+		$this->size = $size;
+	}
+
+	/**
+	 * Get the watermark text.
+	 *
+	 * @return string
+	 */
+	public function text(): string
+	{
+		return $this->text;
+	}
+
+	/**
+	 * Get the watermark font color.
+	 *
+	 * @return string
+	 */
+	public function color(): string
+	{
+		return $this->color;
+	}
+
+	/**
+	 * Get the watermark maximum font size.
+	 * @return int
+	 */
+	public function size(): int
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Return an estimate of the size in pixels of the watermark text length.
+	 *
+	 * @return int
+	 */
+	public function textLengthEstimate(): int
+	{
+		return $this->stringLengthEstimate(mb_strlen($this->text), $this->size);
+	}
+
+	/**
+	 * Decrease the font size if necessary, based on the image width.
+	 *
+	 * @param int $width
+	 */
+	public function adjustSize(int $width): void
+	{
+		$len = mb_strlen($this->text);
+		while ($this->stringLengthEstimate($len, $this->size) > 0.9 * $width) {
+			$this->size--;
+			if ($this->size == 2) {
+				return;
+			}
+		}
+	}
+
+	/**
+	 * Return an estimate of the size in pixels of a text in a specified font size.
+	 *
+	 * @param int $text_length
+	 * @param int $font_size
+	 * @return int
+	 */
+	private function stringLengthEstimate(int $text_length, int $font_size): int
+	{
+		return $text_length * (int) ceil(($font_size + 2) * 0.5);
+	}
 }