@@ -37,128 +37,128 @@ |
||
| 37 | 37 | */ |
| 38 | 38 | class CertificateImage implements RequestHandlerInterface |
| 39 | 39 | { |
| 40 | - /** |
|
| 41 | - * @var CertificatesModule|null $module |
|
| 42 | - */ |
|
| 43 | - private $module; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var CertificateFilesystemService $certif_filesystem |
|
| 47 | - */ |
|
| 48 | - private $certif_filesystem; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @var CertificateImageFactory $certif_image_factory |
|
| 52 | - */ |
|
| 53 | - private $certif_image_factory; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @var CertificateDataService $certif_data_service |
|
| 57 | - */ |
|
| 58 | - private $certif_data_service; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * @var UrlObfuscatorService $url_obfuscator_service |
|
| 62 | - */ |
|
| 63 | - private $url_obfuscator_service; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Constructor for Certificate Image Request Handler |
|
| 67 | - * |
|
| 68 | - * @param ModuleService $module_service |
|
| 69 | - */ |
|
| 70 | - public function __construct( |
|
| 71 | - ModuleService $module_service, |
|
| 72 | - CertificateFilesystemService $certif_filesystem, |
|
| 73 | - CertificateDataService $certif_data_service, |
|
| 74 | - UrlObfuscatorService $url_obfuscator_service |
|
| 75 | - ) { |
|
| 76 | - $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 77 | - $this->certif_filesystem = $certif_filesystem; |
|
| 78 | - $this->certif_image_factory = new CertificateImageFactory($this->certif_filesystem); |
|
| 79 | - $this->certif_data_service = $certif_data_service; |
|
| 80 | - $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * {@inheritDoc} |
|
| 85 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 86 | - */ |
|
| 87 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 88 | - { |
|
| 89 | - if ($this->module === null) { |
|
| 90 | - throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - $tree = $request->getAttribute('tree'); |
|
| 94 | - assert($tree instanceof Tree); |
|
| 95 | - |
|
| 96 | - $user = $request->getAttribute('user'); |
|
| 97 | - assert($user instanceof UserInterface); |
|
| 98 | - |
|
| 99 | - $certif_path = $request->getAttribute('cid'); |
|
| 100 | - $certificate = null; |
|
| 101 | - if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) { |
|
| 102 | - $certificate = $this->certif_filesystem->certificate($tree, $certif_path); |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - if ($certificate === null) { |
|
| 106 | - return $this->certif_image_factory |
|
| 107 | - ->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND) |
|
| 108 | - ->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.')) |
|
| 109 | - ; |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - $use_watermark = $this->certif_image_factory->certificateNeedsWatermark($certificate, $user); |
|
| 113 | - $watermark = $use_watermark ? $this->watermark($request, $certificate) : null; |
|
| 114 | - |
|
| 115 | - return $this->certif_image_factory->certificateFileResponse( |
|
| 116 | - $certificate, |
|
| 117 | - $use_watermark, |
|
| 118 | - $watermark |
|
| 119 | - ); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Get watermark data for a certificate. |
|
| 124 | - * |
|
| 125 | - * @param ServerRequestInterface $request |
|
| 126 | - * @param Certificate $certificate |
|
| 127 | - * @return Watermark |
|
| 128 | - */ |
|
| 129 | - private function watermark(ServerRequestInterface $request, Certificate $certificate): Watermark |
|
| 130 | - { |
|
| 131 | - $color = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_COLOR', Watermark::DEFAULT_COLOR); |
|
| 132 | - $size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE'); |
|
| 133 | - $text = $this->watermarkText($request, $certificate); |
|
| 134 | - |
|
| 135 | - return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE); |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * Get the text to be watermarked for a certificate. |
|
| 140 | - * |
|
| 141 | - * @param ServerRequestInterface $request |
|
| 142 | - * @param Certificate $certificate |
|
| 143 | - * @return string |
|
| 144 | - */ |
|
| 145 | - private function watermarkText(ServerRequestInterface $request, Certificate $certificate): string |
|
| 146 | - { |
|
| 147 | - $sid = $request->getQueryParams()['sid'] ?? ''; |
|
| 148 | - if ($sid !== '') { |
|
| 149 | - $source = Registry::sourceFactory()->make($sid, $certificate->tree()); |
|
| 150 | - } else { |
|
| 151 | - $source = $this->certif_data_service->oneLinkedSource($certificate); |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - if ($source !== null && $source->canShowName()) { |
|
| 155 | - $repo = $source->facts(['REPO'])->first(); |
|
| 156 | - if ($repo !== null && ($repo = $repo->target()) !== null && $repo->canShowName()) { |
|
| 157 | - return I18N::translate('© %s - %s', strip_tags($repo->fullName()), strip_tags($source->fullName())); |
|
| 158 | - } |
|
| 159 | - return $source->fullName(); |
|
| 160 | - } |
|
| 161 | - $default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT'); |
|
| 162 | - return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.'); |
|
| 163 | - } |
|
| 40 | + /** |
|
| 41 | + * @var CertificatesModule|null $module |
|
| 42 | + */ |
|
| 43 | + private $module; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var CertificateFilesystemService $certif_filesystem |
|
| 47 | + */ |
|
| 48 | + private $certif_filesystem; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @var CertificateImageFactory $certif_image_factory |
|
| 52 | + */ |
|
| 53 | + private $certif_image_factory; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @var CertificateDataService $certif_data_service |
|
| 57 | + */ |
|
| 58 | + private $certif_data_service; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * @var UrlObfuscatorService $url_obfuscator_service |
|
| 62 | + */ |
|
| 63 | + private $url_obfuscator_service; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Constructor for Certificate Image Request Handler |
|
| 67 | + * |
|
| 68 | + * @param ModuleService $module_service |
|
| 69 | + */ |
|
| 70 | + public function __construct( |
|
| 71 | + ModuleService $module_service, |
|
| 72 | + CertificateFilesystemService $certif_filesystem, |
|
| 73 | + CertificateDataService $certif_data_service, |
|
| 74 | + UrlObfuscatorService $url_obfuscator_service |
|
| 75 | + ) { |
|
| 76 | + $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 77 | + $this->certif_filesystem = $certif_filesystem; |
|
| 78 | + $this->certif_image_factory = new CertificateImageFactory($this->certif_filesystem); |
|
| 79 | + $this->certif_data_service = $certif_data_service; |
|
| 80 | + $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * {@inheritDoc} |
|
| 85 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 86 | + */ |
|
| 87 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 88 | + { |
|
| 89 | + if ($this->module === null) { |
|
| 90 | + throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + $tree = $request->getAttribute('tree'); |
|
| 94 | + assert($tree instanceof Tree); |
|
| 95 | + |
|
| 96 | + $user = $request->getAttribute('user'); |
|
| 97 | + assert($user instanceof UserInterface); |
|
| 98 | + |
|
| 99 | + $certif_path = $request->getAttribute('cid'); |
|
| 100 | + $certificate = null; |
|
| 101 | + if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) { |
|
| 102 | + $certificate = $this->certif_filesystem->certificate($tree, $certif_path); |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + if ($certificate === null) { |
|
| 106 | + return $this->certif_image_factory |
|
| 107 | + ->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND) |
|
| 108 | + ->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.')) |
|
| 109 | + ; |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + $use_watermark = $this->certif_image_factory->certificateNeedsWatermark($certificate, $user); |
|
| 113 | + $watermark = $use_watermark ? $this->watermark($request, $certificate) : null; |
|
| 114 | + |
|
| 115 | + return $this->certif_image_factory->certificateFileResponse( |
|
| 116 | + $certificate, |
|
| 117 | + $use_watermark, |
|
| 118 | + $watermark |
|
| 119 | + ); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Get watermark data for a certificate. |
|
| 124 | + * |
|
| 125 | + * @param ServerRequestInterface $request |
|
| 126 | + * @param Certificate $certificate |
|
| 127 | + * @return Watermark |
|
| 128 | + */ |
|
| 129 | + private function watermark(ServerRequestInterface $request, Certificate $certificate): Watermark |
|
| 130 | + { |
|
| 131 | + $color = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_COLOR', Watermark::DEFAULT_COLOR); |
|
| 132 | + $size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE'); |
|
| 133 | + $text = $this->watermarkText($request, $certificate); |
|
| 134 | + |
|
| 135 | + return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE); |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * Get the text to be watermarked for a certificate. |
|
| 140 | + * |
|
| 141 | + * @param ServerRequestInterface $request |
|
| 142 | + * @param Certificate $certificate |
|
| 143 | + * @return string |
|
| 144 | + */ |
|
| 145 | + private function watermarkText(ServerRequestInterface $request, Certificate $certificate): string |
|
| 146 | + { |
|
| 147 | + $sid = $request->getQueryParams()['sid'] ?? ''; |
|
| 148 | + if ($sid !== '') { |
|
| 149 | + $source = Registry::sourceFactory()->make($sid, $certificate->tree()); |
|
| 150 | + } else { |
|
| 151 | + $source = $this->certif_data_service->oneLinkedSource($certificate); |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + if ($source !== null && $source->canShowName()) { |
|
| 155 | + $repo = $source->facts(['REPO'])->first(); |
|
| 156 | + if ($repo !== null && ($repo = $repo->target()) !== null && $repo->canShowName()) { |
|
| 157 | + return I18N::translate('© %s - %s', strip_tags($repo->fullName()), strip_tags($source->fullName())); |
|
| 158 | + } |
|
| 159 | + return $source->fullName(); |
|
| 160 | + } |
|
| 161 | + $default_text = $certificate->tree()->getPreference('MAJ_CERTIF_WM_DEFAULT'); |
|
| 162 | + return $default_text !== '' ? $default_text : I18N::translate('This image is protected under copyright law.'); |
|
| 163 | + } |
|
| 164 | 164 | } |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | |
| 105 | 105 | if ($certificate === null) { |
| 106 | 106 | return $this->certif_image_factory |
| 107 | - ->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND) |
|
| 107 | + ->replacementImageResponse((string)StatusCodeInterface::STATUS_NOT_FOUND) |
|
| 108 | 108 | ->withHeader('X-Image-Exception', I18N::translate('The certificate was not found in this family tree.')) |
| 109 | 109 | ; |
| 110 | 110 | } |
@@ -132,7 +132,7 @@ discard block |
||
| 132 | 132 | $size = $certificate->tree()->getPreference('MAJ_CERTIF_WM_FONT_MAXSIZE'); |
| 133 | 133 | $text = $this->watermarkText($request, $certificate); |
| 134 | 134 | |
| 135 | - return new Watermark($text, $color, is_numeric($size) ? (int) $size : Watermark::DEFAULT_SIZE); |
|
| 135 | + return new Watermark($text, $color, is_numeric($size) ? (int)$size : Watermark::DEFAULT_SIZE); |
|
| 136 | 136 | } |
| 137 | 137 | |
| 138 | 138 | /** |
@@ -31,73 +31,73 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class CertificatesList implements RequestHandlerInterface |
| 33 | 33 | { |
| 34 | - use ViewResponseTrait; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var CertificatesModule|null $module |
|
| 38 | - */ |
|
| 39 | - private $module; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * @var CertificateFilesystemService $certif_filesystem |
|
| 43 | - */ |
|
| 44 | - private $certif_filesystem; |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * @var UrlObfuscatorService $url_obfuscator_service |
|
| 48 | - */ |
|
| 49 | - private $url_obfuscator_service; |
|
| 50 | - |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Constructor for CertificatesList Request Handler |
|
| 54 | - * |
|
| 55 | - * @param ModuleService $module_service |
|
| 56 | - */ |
|
| 57 | - public function __construct( |
|
| 58 | - ModuleService $module_service, |
|
| 59 | - CertificateFilesystemService $certif_filesystem, |
|
| 60 | - UrlObfuscatorService $url_obfuscator_service |
|
| 61 | - ) { |
|
| 62 | - $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 63 | - $this->certif_filesystem = $certif_filesystem; |
|
| 64 | - $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * {@inheritDoc} |
|
| 69 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 70 | - */ |
|
| 71 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 72 | - { |
|
| 73 | - if ($this->module === null) { |
|
| 74 | - throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - $tree = $request->getAttribute('tree'); |
|
| 78 | - assert($tree instanceof Tree); |
|
| 79 | - |
|
| 80 | - $title = I18N::translate('Certificates'); |
|
| 81 | - |
|
| 82 | - $cities = array_map(function (string $item): array { |
|
| 83 | - return [$this->url_obfuscator_service->obfuscate($item), $item]; |
|
| 84 | - }, $this->certif_filesystem->cities($tree)); |
|
| 85 | - |
|
| 86 | - $city = $request->getQueryParams()['cityobf'] ?? $request->getAttribute('cityobf') ?? ''; |
|
| 87 | - |
|
| 88 | - if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) { |
|
| 89 | - $title = I18N::translate('Certificates for %s', $city); |
|
| 90 | - $certificates = $this->certif_filesystem->certificatesForCity($tree, $city); |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - return $this->viewResponse($this->module->name() . '::certificates-list', [ |
|
| 94 | - 'title' => $title, |
|
| 95 | - 'tree' => $tree, |
|
| 96 | - 'module_name' => $this->module->name(), |
|
| 97 | - 'cities' => $cities, |
|
| 98 | - 'selected_city' => $city, |
|
| 99 | - 'certificates_list' => $certificates ?? collect(), |
|
| 100 | - 'url_obfuscator_service' => $this->url_obfuscator_service |
|
| 101 | - ]); |
|
| 102 | - } |
|
| 34 | + use ViewResponseTrait; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var CertificatesModule|null $module |
|
| 38 | + */ |
|
| 39 | + private $module; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * @var CertificateFilesystemService $certif_filesystem |
|
| 43 | + */ |
|
| 44 | + private $certif_filesystem; |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * @var UrlObfuscatorService $url_obfuscator_service |
|
| 48 | + */ |
|
| 49 | + private $url_obfuscator_service; |
|
| 50 | + |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Constructor for CertificatesList Request Handler |
|
| 54 | + * |
|
| 55 | + * @param ModuleService $module_service |
|
| 56 | + */ |
|
| 57 | + public function __construct( |
|
| 58 | + ModuleService $module_service, |
|
| 59 | + CertificateFilesystemService $certif_filesystem, |
|
| 60 | + UrlObfuscatorService $url_obfuscator_service |
|
| 61 | + ) { |
|
| 62 | + $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 63 | + $this->certif_filesystem = $certif_filesystem; |
|
| 64 | + $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * {@inheritDoc} |
|
| 69 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 70 | + */ |
|
| 71 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 72 | + { |
|
| 73 | + if ($this->module === null) { |
|
| 74 | + throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + $tree = $request->getAttribute('tree'); |
|
| 78 | + assert($tree instanceof Tree); |
|
| 79 | + |
|
| 80 | + $title = I18N::translate('Certificates'); |
|
| 81 | + |
|
| 82 | + $cities = array_map(function (string $item): array { |
|
| 83 | + return [$this->url_obfuscator_service->obfuscate($item), $item]; |
|
| 84 | + }, $this->certif_filesystem->cities($tree)); |
|
| 85 | + |
|
| 86 | + $city = $request->getQueryParams()['cityobf'] ?? $request->getAttribute('cityobf') ?? ''; |
|
| 87 | + |
|
| 88 | + if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) { |
|
| 89 | + $title = I18N::translate('Certificates for %s', $city); |
|
| 90 | + $certificates = $this->certif_filesystem->certificatesForCity($tree, $city); |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + return $this->viewResponse($this->module->name() . '::certificates-list', [ |
|
| 94 | + 'title' => $title, |
|
| 95 | + 'tree' => $tree, |
|
| 96 | + 'module_name' => $this->module->name(), |
|
| 97 | + 'cities' => $cities, |
|
| 98 | + 'selected_city' => $city, |
|
| 99 | + 'certificates_list' => $certificates ?? collect(), |
|
| 100 | + 'url_obfuscator_service' => $this->url_obfuscator_service |
|
| 101 | + ]); |
|
| 102 | + } |
|
| 103 | 103 | } |
@@ -79,7 +79,7 @@ discard block |
||
| 79 | 79 | |
| 80 | 80 | $title = I18N::translate('Certificates'); |
| 81 | 81 | |
| 82 | - $cities = array_map(function (string $item): array { |
|
| 82 | + $cities = array_map(function(string $item): array { |
|
| 83 | 83 | return [$this->url_obfuscator_service->obfuscate($item), $item]; |
| 84 | 84 | }, $this->certif_filesystem->cities($tree)); |
| 85 | 85 | |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | $certificates = $this->certif_filesystem->certificatesForCity($tree, $city); |
| 91 | 91 | } |
| 92 | 92 | |
| 93 | - return $this->viewResponse($this->module->name() . '::certificates-list', [ |
|
| 93 | + return $this->viewResponse($this->module->name().'::certificates-list', [ |
|
| 94 | 94 | 'title' => $title, |
| 95 | 95 | 'tree' => $tree, |
| 96 | 96 | 'module_name' => $this->module->name(), |
@@ -34,58 +34,58 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | class AdminConfigPage implements RequestHandlerInterface |
| 36 | 36 | { |
| 37 | - use ViewResponseTrait; |
|
| 37 | + use ViewResponseTrait; |
|
| 38 | 38 | |
| 39 | - private ?CertificatesModule $module; |
|
| 40 | - private TreeService $tree_service; |
|
| 39 | + private ?CertificatesModule $module; |
|
| 40 | + private TreeService $tree_service; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Constructor for Admin Config page request handler |
|
| 44 | - * |
|
| 45 | - * @param ModuleService $module_service |
|
| 46 | - */ |
|
| 47 | - public function __construct(ModuleService $module_service, TreeService $tree_service) |
|
| 48 | - { |
|
| 49 | - $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 50 | - $this->tree_service = $tree_service; |
|
| 51 | - } |
|
| 42 | + /** |
|
| 43 | + * Constructor for Admin Config page request handler |
|
| 44 | + * |
|
| 45 | + * @param ModuleService $module_service |
|
| 46 | + */ |
|
| 47 | + public function __construct(ModuleService $module_service, TreeService $tree_service) |
|
| 48 | + { |
|
| 49 | + $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 50 | + $this->tree_service = $tree_service; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * {@inheritDoc} |
|
| 55 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 56 | - */ |
|
| 57 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 58 | - { |
|
| 59 | - $this->layout = 'layouts/administration'; |
|
| 53 | + /** |
|
| 54 | + * {@inheritDoc} |
|
| 55 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 56 | + */ |
|
| 57 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 58 | + { |
|
| 59 | + $this->layout = 'layouts/administration'; |
|
| 60 | 60 | |
| 61 | - if ($this->module === null) { |
|
| 62 | - throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 63 | - } |
|
| 61 | + if ($this->module === null) { |
|
| 62 | + throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - $user = $request->getAttribute('user'); |
|
| 66 | - assert($user instanceof UserInterface); |
|
| 65 | + $user = $request->getAttribute('user'); |
|
| 66 | + assert($user instanceof UserInterface); |
|
| 67 | 67 | |
| 68 | - $all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user)); |
|
| 69 | - if ($all_trees->count() === 0) { |
|
| 70 | - throw new HttpAccessDeniedException(); |
|
| 71 | - } |
|
| 68 | + $all_trees = $this->tree_service->all()->filter(fn(Tree $tree) => Auth::isManager($tree, $user)); |
|
| 69 | + if ($all_trees->count() === 0) { |
|
| 70 | + throw new HttpAccessDeniedException(); |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - $tree = $request->getAttribute('tree') ?? $all_trees->first(); |
|
| 74 | - assert($tree instanceof Tree); |
|
| 73 | + $tree = $request->getAttribute('tree') ?? $all_trees->first(); |
|
| 74 | + assert($tree instanceof Tree); |
|
| 75 | 75 | |
| 76 | - $data_folder = Registry::filesystem()->dataName(); |
|
| 76 | + $data_folder = Registry::filesystem()->dataName(); |
|
| 77 | 77 | |
| 78 | - $same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id(); |
|
| 79 | - if (!$all_trees->contains($same_tree)) { |
|
| 80 | - throw new HttpAccessDeniedException(); |
|
| 81 | - } |
|
| 78 | + $same_tree = fn(Tree $tree_collection): bool => $tree->id() === $tree_collection->id(); |
|
| 79 | + if (!$all_trees->contains($same_tree)) { |
|
| 80 | + throw new HttpAccessDeniedException(); |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - return $this->viewResponse($this->module->name() . '::admin/config', [ |
|
| 84 | - 'module_name' => $this->module->name(), |
|
| 85 | - 'title' => $this->module->title(), |
|
| 86 | - 'tree' => $tree, |
|
| 87 | - 'other_trees' => $all_trees->reject($same_tree), |
|
| 88 | - 'data_folder' => $data_folder |
|
| 89 | - ]); |
|
| 90 | - } |
|
| 83 | + return $this->viewResponse($this->module->name() . '::admin/config', [ |
|
| 84 | + 'module_name' => $this->module->name(), |
|
| 85 | + 'title' => $this->module->title(), |
|
| 86 | + 'tree' => $tree, |
|
| 87 | + 'other_trees' => $all_trees->reject($same_tree), |
|
| 88 | + 'data_folder' => $data_folder |
|
| 89 | + ]); |
|
| 90 | + } |
|
| 91 | 91 | } |
@@ -87,7 +87,7 @@ |
||
| 87 | 87 | throw new HttpAccessDeniedException(); |
| 88 | 88 | } |
| 89 | 89 | |
| 90 | - return $this->viewResponse($this->module->name() . '::admin/config', [ |
|
| 90 | + return $this->viewResponse($this->module->name().'::admin/config', [ |
|
| 91 | 91 | 'module_name' => $this->module->name(), |
| 92 | 92 | 'title' => $this->module->title(), |
| 93 | 93 | 'tree' => $tree, |
@@ -34,80 +34,80 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | class CertificatePage implements RequestHandlerInterface |
| 36 | 36 | { |
| 37 | - use ViewResponseTrait; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @var CertificatesModule|null $module |
|
| 41 | - */ |
|
| 42 | - private $module; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * @var CertificateFilesystemService $certif_filesystem |
|
| 46 | - */ |
|
| 47 | - private $certif_filesystem; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * @var CertificateDataService $certif_data_service |
|
| 51 | - */ |
|
| 52 | - private $certif_data_service; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * @var UrlObfuscatorService $url_obfuscator_service |
|
| 56 | - */ |
|
| 57 | - private $url_obfuscator_service; |
|
| 58 | - |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Constructor for CertificatePage Request Handler |
|
| 62 | - * |
|
| 63 | - * @param ModuleService $module_service |
|
| 64 | - * @param CertificateFilesystemService $certif_filesystem |
|
| 65 | - * @param CertificateDataService $certif_data_service |
|
| 66 | - * @param UrlObfuscatorService $url_obfuscator_service |
|
| 67 | - */ |
|
| 68 | - public function __construct( |
|
| 69 | - ModuleService $module_service, |
|
| 70 | - CertificateFilesystemService $certif_filesystem, |
|
| 71 | - CertificateDataService $certif_data_service, |
|
| 72 | - UrlObfuscatorService $url_obfuscator_service |
|
| 73 | - ) { |
|
| 74 | - $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 75 | - $this->certif_filesystem = $certif_filesystem; |
|
| 76 | - $this->certif_data_service = $certif_data_service; |
|
| 77 | - $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * {@inheritDoc} |
|
| 82 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 83 | - */ |
|
| 84 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 85 | - { |
|
| 86 | - if ($this->module === null) { |
|
| 87 | - throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - $tree = $request->getAttribute('tree'); |
|
| 91 | - assert($tree instanceof Tree); |
|
| 92 | - |
|
| 93 | - $certif_path = $request->getAttribute('cid'); |
|
| 94 | - if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) { |
|
| 95 | - $certificate = $this->certif_filesystem->certificate($tree, $certif_path); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - if (!isset($certificate)) { |
|
| 99 | - FlashMessages::addMessage('The requested certificate is not valid.'); |
|
| 100 | - return redirect(route(TreePage::class, ['tree' => $tree->name()])); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - return $this->viewResponse($this->module->name() . '::certificate-page', [ |
|
| 104 | - 'title' => I18N::translate('Certificate - %s', $certificate->name()), |
|
| 105 | - 'tree' => $tree, |
|
| 106 | - 'module_name' => $this->module->name(), |
|
| 107 | - 'certificate' => $certificate, |
|
| 108 | - 'url_obfuscator_service' => $this->url_obfuscator_service, |
|
| 109 | - 'linked_individuals' => $this->certif_data_service->linkedIndividuals($certificate), |
|
| 110 | - 'linked_families' => $this->certif_data_service->linkedFamilies($certificate) |
|
| 111 | - ]); |
|
| 112 | - } |
|
| 37 | + use ViewResponseTrait; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @var CertificatesModule|null $module |
|
| 41 | + */ |
|
| 42 | + private $module; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * @var CertificateFilesystemService $certif_filesystem |
|
| 46 | + */ |
|
| 47 | + private $certif_filesystem; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @var CertificateDataService $certif_data_service |
|
| 51 | + */ |
|
| 52 | + private $certif_data_service; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * @var UrlObfuscatorService $url_obfuscator_service |
|
| 56 | + */ |
|
| 57 | + private $url_obfuscator_service; |
|
| 58 | + |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Constructor for CertificatePage Request Handler |
|
| 62 | + * |
|
| 63 | + * @param ModuleService $module_service |
|
| 64 | + * @param CertificateFilesystemService $certif_filesystem |
|
| 65 | + * @param CertificateDataService $certif_data_service |
|
| 66 | + * @param UrlObfuscatorService $url_obfuscator_service |
|
| 67 | + */ |
|
| 68 | + public function __construct( |
|
| 69 | + ModuleService $module_service, |
|
| 70 | + CertificateFilesystemService $certif_filesystem, |
|
| 71 | + CertificateDataService $certif_data_service, |
|
| 72 | + UrlObfuscatorService $url_obfuscator_service |
|
| 73 | + ) { |
|
| 74 | + $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 75 | + $this->certif_filesystem = $certif_filesystem; |
|
| 76 | + $this->certif_data_service = $certif_data_service; |
|
| 77 | + $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * {@inheritDoc} |
|
| 82 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 83 | + */ |
|
| 84 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 85 | + { |
|
| 86 | + if ($this->module === null) { |
|
| 87 | + throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + $tree = $request->getAttribute('tree'); |
|
| 91 | + assert($tree instanceof Tree); |
|
| 92 | + |
|
| 93 | + $certif_path = $request->getAttribute('cid'); |
|
| 94 | + if ($certif_path !== '' && $this->url_obfuscator_service->tryDeobfuscate($certif_path)) { |
|
| 95 | + $certificate = $this->certif_filesystem->certificate($tree, $certif_path); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + if (!isset($certificate)) { |
|
| 99 | + FlashMessages::addMessage('The requested certificate is not valid.'); |
|
| 100 | + return redirect(route(TreePage::class, ['tree' => $tree->name()])); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + return $this->viewResponse($this->module->name() . '::certificate-page', [ |
|
| 104 | + 'title' => I18N::translate('Certificate - %s', $certificate->name()), |
|
| 105 | + 'tree' => $tree, |
|
| 106 | + 'module_name' => $this->module->name(), |
|
| 107 | + 'certificate' => $certificate, |
|
| 108 | + 'url_obfuscator_service' => $this->url_obfuscator_service, |
|
| 109 | + 'linked_individuals' => $this->certif_data_service->linkedIndividuals($certificate), |
|
| 110 | + 'linked_families' => $this->certif_data_service->linkedFamilies($certificate) |
|
| 111 | + ]); |
|
| 112 | + } |
|
| 113 | 113 | } |
@@ -100,7 +100,7 @@ |
||
| 100 | 100 | return redirect(route(TreePage::class, ['tree' => $tree->name()])); |
| 101 | 101 | } |
| 102 | 102 | |
| 103 | - return $this->viewResponse($this->module->name() . '::certificate-page', [ |
|
| 103 | + return $this->viewResponse($this->module->name().'::certificate-page', [ |
|
| 104 | 104 | 'title' => I18N::translate('Certificate - %s', $certificate->name()), |
| 105 | 105 | 'tree' => $tree, |
| 106 | 106 | 'module_name' => $this->module->name(), |
@@ -30,55 +30,55 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | class AutoCompleteFile extends AbstractAutocompleteHandler |
| 32 | 32 | { |
| 33 | - // Tell the browser to cache the results |
|
| 34 | - protected const CACHE_LIFE = 10; |
|
| 33 | + // Tell the browser to cache the results |
|
| 34 | + protected const CACHE_LIFE = 10; |
|
| 35 | 35 | |
| 36 | - private ?CertificatesModule $module; |
|
| 37 | - private CertificateFilesystemService $certif_filesystem; |
|
| 38 | - private UrlObfuscatorService $url_obfuscator_service; |
|
| 36 | + private ?CertificatesModule $module; |
|
| 37 | + private CertificateFilesystemService $certif_filesystem; |
|
| 38 | + private UrlObfuscatorService $url_obfuscator_service; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Constructor for AutoCompleteFile Request Handler |
|
| 42 | - * |
|
| 43 | - * @param ModuleService $module_service |
|
| 44 | - * @param CertificateFilesystemService $certif_filesystem |
|
| 45 | - * @param UrlObfuscatorService $url_obfuscator_service |
|
| 46 | - * @param SearchService $search_service |
|
| 47 | - */ |
|
| 48 | - public function __construct( |
|
| 49 | - ModuleService $module_service, |
|
| 50 | - CertificateFilesystemService $certif_filesystem, |
|
| 51 | - UrlObfuscatorService $url_obfuscator_service, |
|
| 52 | - SearchService $search_service |
|
| 53 | - ) { |
|
| 54 | - parent::__construct($search_service); |
|
| 55 | - $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 56 | - $this->certif_filesystem = $certif_filesystem; |
|
| 57 | - $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 58 | - } |
|
| 40 | + /** |
|
| 41 | + * Constructor for AutoCompleteFile Request Handler |
|
| 42 | + * |
|
| 43 | + * @param ModuleService $module_service |
|
| 44 | + * @param CertificateFilesystemService $certif_filesystem |
|
| 45 | + * @param UrlObfuscatorService $url_obfuscator_service |
|
| 46 | + * @param SearchService $search_service |
|
| 47 | + */ |
|
| 48 | + public function __construct( |
|
| 49 | + ModuleService $module_service, |
|
| 50 | + CertificateFilesystemService $certif_filesystem, |
|
| 51 | + UrlObfuscatorService $url_obfuscator_service, |
|
| 52 | + SearchService $search_service |
|
| 53 | + ) { |
|
| 54 | + parent::__construct($search_service); |
|
| 55 | + $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 56 | + $this->certif_filesystem = $certif_filesystem; |
|
| 57 | + $this->url_obfuscator_service = $url_obfuscator_service; |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * {@inheritDoc} |
|
| 62 | - * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search() |
|
| 63 | - */ |
|
| 64 | - protected function search(ServerRequestInterface $request): Collection |
|
| 65 | - { |
|
| 66 | - $tree = $request->getAttribute('tree'); |
|
| 67 | - assert($tree instanceof Tree); |
|
| 60 | + /** |
|
| 61 | + * {@inheritDoc} |
|
| 62 | + * @see \Fisharebest\Webtrees\Http\RequestHandlers\AbstractAutocompleteHandler::search() |
|
| 63 | + */ |
|
| 64 | + protected function search(ServerRequestInterface $request): Collection |
|
| 65 | + { |
|
| 66 | + $tree = $request->getAttribute('tree'); |
|
| 67 | + assert($tree instanceof Tree); |
|
| 68 | 68 | |
| 69 | - $city = $request->getQueryParams()['cityobf'] ?? ''; |
|
| 69 | + $city = $request->getQueryParams()['cityobf'] ?? ''; |
|
| 70 | 70 | |
| 71 | - if ($this->module === null || $city === '' || !$this->url_obfuscator_service->tryDeobfuscate($city)) { |
|
| 72 | - return collect(); |
|
| 73 | - } |
|
| 71 | + if ($this->module === null || $city === '' || !$this->url_obfuscator_service->tryDeobfuscate($city)) { |
|
| 72 | + return collect(); |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - $query = $request->getAttribute('query') ?? ''; |
|
| 75 | + $query = $request->getAttribute('query') ?? ''; |
|
| 76 | 76 | |
| 77 | - /** @var Collection<string> $results */ |
|
| 78 | - $results = $this->certif_filesystem |
|
| 79 | - ->certificatesForCityContaining($tree, $city, $query) |
|
| 80 | - ->map(fn(Certificate $certificate): string => $certificate->filename()); |
|
| 77 | + /** @var Collection<string> $results */ |
|
| 78 | + $results = $this->certif_filesystem |
|
| 79 | + ->certificatesForCityContaining($tree, $city, $query) |
|
| 80 | + ->map(fn(Certificate $certificate): string => $certificate->filename()); |
|
| 81 | 81 | |
| 82 | - return $results; |
|
| 83 | - } |
|
| 82 | + return $results; |
|
| 83 | + } |
|
| 84 | 84 | } |
@@ -72,10 +72,10 @@ |
||
| 72 | 72 | return collect(); |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - $query = $request->getAttribute('query') ?? ''; |
|
| 75 | + $query = $request->getAttribute('query') ?? ''; |
|
| 76 | 76 | |
| 77 | 77 | /** @var Collection<string> $results */ |
| 78 | - $results = $this->certif_filesystem |
|
| 78 | + $results = $this->certif_filesystem |
|
| 79 | 79 | ->certificatesForCityContaining($tree, $city, $query) |
| 80 | 80 | ->map(fn(Certificate $certificate): string => $certificate->filename()); |
| 81 | 81 | |
@@ -29,143 +29,143 @@ |
||
| 29 | 29 | class CertificateDataService |
| 30 | 30 | { |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Find individuals linked to a certificate. |
|
| 34 | - * |
|
| 35 | - * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 36 | - * but does not work with Sqlite if no default escape has been defined} |
|
| 37 | - * |
|
| 38 | - * @param Certificate $certificate |
|
| 39 | - * @return Collection<\Fisharebest\Webtrees\Individual> |
|
| 40 | - */ |
|
| 41 | - public function linkedIndividuals(Certificate $certificate): Collection |
|
| 42 | - { |
|
| 43 | - $tree = $certificate->tree(); |
|
| 44 | - return DB::table('individuals') |
|
| 45 | - ->where('i_file', '=', $tree->id()) |
|
| 46 | - ->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 47 | - ->select(['individuals.*']) |
|
| 48 | - ->get() |
|
| 49 | - ->map(Registry::individualFactory()->mapper($tree)) |
|
| 50 | - ->filter(GedcomRecord::accessFilter()); |
|
| 51 | - } |
|
| 32 | + /** |
|
| 33 | + * Find individuals linked to a certificate. |
|
| 34 | + * |
|
| 35 | + * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 36 | + * but does not work with Sqlite if no default escape has been defined} |
|
| 37 | + * |
|
| 38 | + * @param Certificate $certificate |
|
| 39 | + * @return Collection<\Fisharebest\Webtrees\Individual> |
|
| 40 | + */ |
|
| 41 | + public function linkedIndividuals(Certificate $certificate): Collection |
|
| 42 | + { |
|
| 43 | + $tree = $certificate->tree(); |
|
| 44 | + return DB::table('individuals') |
|
| 45 | + ->where('i_file', '=', $tree->id()) |
|
| 46 | + ->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 47 | + ->select(['individuals.*']) |
|
| 48 | + ->get() |
|
| 49 | + ->map(Registry::individualFactory()->mapper($tree)) |
|
| 50 | + ->filter(GedcomRecord::accessFilter()); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Find families linked to a certificate. |
|
| 55 | - * |
|
| 56 | - * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 57 | - * but does not work with Sqlite if no default escape has been defined} |
|
| 58 | - * |
|
| 59 | - * @param Certificate $certificate |
|
| 60 | - * @return Collection<\Fisharebest\Webtrees\Family> |
|
| 61 | - */ |
|
| 62 | - public function linkedFamilies(Certificate $certificate): Collection |
|
| 63 | - { |
|
| 64 | - $tree = $certificate->tree(); |
|
| 65 | - return DB::table('families') |
|
| 66 | - ->where('f_file', '=', $tree->id()) |
|
| 67 | - ->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 68 | - ->select(['families.*']) |
|
| 69 | - ->get() |
|
| 70 | - ->map(Registry::familyFactory()->mapper($tree)) |
|
| 71 | - ->filter(GedcomRecord::accessFilter()); |
|
| 72 | - } |
|
| 53 | + /** |
|
| 54 | + * Find families linked to a certificate. |
|
| 55 | + * |
|
| 56 | + * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 57 | + * but does not work with Sqlite if no default escape has been defined} |
|
| 58 | + * |
|
| 59 | + * @param Certificate $certificate |
|
| 60 | + * @return Collection<\Fisharebest\Webtrees\Family> |
|
| 61 | + */ |
|
| 62 | + public function linkedFamilies(Certificate $certificate): Collection |
|
| 63 | + { |
|
| 64 | + $tree = $certificate->tree(); |
|
| 65 | + return DB::table('families') |
|
| 66 | + ->where('f_file', '=', $tree->id()) |
|
| 67 | + ->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 68 | + ->select(['families.*']) |
|
| 69 | + ->get() |
|
| 70 | + ->map(Registry::familyFactory()->mapper($tree)) |
|
| 71 | + ->filter(GedcomRecord::accessFilter()); |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Find media objects linked to a certificate. |
|
| 76 | - * |
|
| 77 | - * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 78 | - * but does not work with Sqlite if no default escape has been defined} |
|
| 79 | - * |
|
| 80 | - * @param Certificate $certificate |
|
| 81 | - * @return Collection<\Fisharebest\Webtrees\Media> |
|
| 82 | - */ |
|
| 83 | - public function linkedMedias(Certificate $certificate): Collection |
|
| 84 | - { |
|
| 85 | - $tree = $certificate->tree(); |
|
| 86 | - return DB::table('media') |
|
| 87 | - ->where('m_file', '=', $tree->id()) |
|
| 88 | - ->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 89 | - ->select(['media.*']) |
|
| 90 | - ->get() |
|
| 91 | - ->map(Registry::mediaFactory()->mapper($tree)) |
|
| 92 | - ->filter(GedcomRecord::accessFilter()); |
|
| 93 | - } |
|
| 74 | + /** |
|
| 75 | + * Find media objects linked to a certificate. |
|
| 76 | + * |
|
| 77 | + * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 78 | + * but does not work with Sqlite if no default escape has been defined} |
|
| 79 | + * |
|
| 80 | + * @param Certificate $certificate |
|
| 81 | + * @return Collection<\Fisharebest\Webtrees\Media> |
|
| 82 | + */ |
|
| 83 | + public function linkedMedias(Certificate $certificate): Collection |
|
| 84 | + { |
|
| 85 | + $tree = $certificate->tree(); |
|
| 86 | + return DB::table('media') |
|
| 87 | + ->where('m_file', '=', $tree->id()) |
|
| 88 | + ->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 89 | + ->select(['media.*']) |
|
| 90 | + ->get() |
|
| 91 | + ->map(Registry::mediaFactory()->mapper($tree)) |
|
| 92 | + ->filter(GedcomRecord::accessFilter()); |
|
| 93 | + } |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Find notes linked to a certificate. |
|
| 97 | - * |
|
| 98 | - * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 99 | - * but does not work with Sqlite if no default escape has been defined} |
|
| 100 | - * |
|
| 101 | - * @param Certificate $certificate |
|
| 102 | - * @return Collection<\Fisharebest\Webtrees\Note> |
|
| 103 | - */ |
|
| 104 | - public function linkedNotes(Certificate $certificate): Collection |
|
| 105 | - { |
|
| 106 | - $tree = $certificate->tree(); |
|
| 107 | - return DB::table('other') |
|
| 108 | - ->where('o_file', '=', $tree->id()) |
|
| 109 | - ->where('o_type', '=', 'NOTE') |
|
| 110 | - ->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 111 | - ->select(['other.*']) |
|
| 112 | - ->get() |
|
| 113 | - ->map(Registry::noteFactory()->mapper($tree)) |
|
| 114 | - ->filter(GedcomRecord::accessFilter()); |
|
| 115 | - } |
|
| 95 | + /** |
|
| 96 | + * Find notes linked to a certificate. |
|
| 97 | + * |
|
| 98 | + * {@internal Ideally, the underscore should be escaped in the WHERE clause, |
|
| 99 | + * but does not work with Sqlite if no default escape has been defined} |
|
| 100 | + * |
|
| 101 | + * @param Certificate $certificate |
|
| 102 | + * @return Collection<\Fisharebest\Webtrees\Note> |
|
| 103 | + */ |
|
| 104 | + public function linkedNotes(Certificate $certificate): Collection |
|
| 105 | + { |
|
| 106 | + $tree = $certificate->tree(); |
|
| 107 | + return DB::table('other') |
|
| 108 | + ->where('o_file', '=', $tree->id()) |
|
| 109 | + ->where('o_type', '=', 'NOTE') |
|
| 110 | + ->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 111 | + ->select(['other.*']) |
|
| 112 | + ->get() |
|
| 113 | + ->map(Registry::noteFactory()->mapper($tree)) |
|
| 114 | + ->filter(GedcomRecord::accessFilter()); |
|
| 115 | + } |
|
| 116 | 116 | |
| 117 | - /** |
|
| 118 | - * Return an escaped string to be used in SQL LIKE comparisons. |
|
| 119 | - * This would not work well for Sqlite, if the escape character is not defined. |
|
| 120 | - * |
|
| 121 | - * @param Certificate $certificate |
|
| 122 | - * @return string |
|
| 123 | - */ |
|
| 124 | - protected function escapedSqlPath(Certificate $certificate): string |
|
| 125 | - { |
|
| 126 | - return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath()); |
|
| 127 | - } |
|
| 117 | + /** |
|
| 118 | + * Return an escaped string to be used in SQL LIKE comparisons. |
|
| 119 | + * This would not work well for Sqlite, if the escape character is not defined. |
|
| 120 | + * |
|
| 121 | + * @param Certificate $certificate |
|
| 122 | + * @return string |
|
| 123 | + */ |
|
| 124 | + protected function escapedSqlPath(Certificate $certificate): string |
|
| 125 | + { |
|
| 126 | + return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath()); |
|
| 127 | + } |
|
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * Find a source linked to a citation where a certificate file is referenced. |
|
| 131 | - * |
|
| 132 | - * @param Certificate $certificate |
|
| 133 | - * @return Source|NULL |
|
| 134 | - */ |
|
| 135 | - public function oneLinkedSource(Certificate $certificate): ?Source |
|
| 136 | - { |
|
| 137 | - $regex_query = preg_quote($certificate->gedcomPath(), '/'); |
|
| 138 | - $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 |
|
| 129 | + /** |
|
| 130 | + * Find a source linked to a citation where a certificate file is referenced. |
|
| 131 | + * |
|
| 132 | + * @param Certificate $certificate |
|
| 133 | + * @return Source|NULL |
|
| 134 | + */ |
|
| 135 | + public function oneLinkedSource(Certificate $certificate): ?Source |
|
| 136 | + { |
|
| 137 | + $regex_query = preg_quote($certificate->gedcomPath(), '/'); |
|
| 138 | + $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 |
|
| 139 | 139 | |
| 140 | - foreach ($this->linkedRecordsLists($certificate) as $linked_records) { |
|
| 141 | - foreach ($linked_records as $gedcom_record) { |
|
| 142 | - foreach ($gedcom_record->facts() as $fact) { |
|
| 143 | - if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) { |
|
| 144 | - foreach ($matches as $match) { |
|
| 145 | - $source = Registry::sourceFactory()->make($match[1], $certificate->tree()); |
|
| 146 | - if ($source !== null && $source->canShowName()) { |
|
| 147 | - return $source; |
|
| 148 | - } |
|
| 149 | - } |
|
| 150 | - } |
|
| 151 | - } |
|
| 152 | - } |
|
| 153 | - } |
|
| 140 | + foreach ($this->linkedRecordsLists($certificate) as $linked_records) { |
|
| 141 | + foreach ($linked_records as $gedcom_record) { |
|
| 142 | + foreach ($gedcom_record->facts() as $fact) { |
|
| 143 | + if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) { |
|
| 144 | + foreach ($matches as $match) { |
|
| 145 | + $source = Registry::sourceFactory()->make($match[1], $certificate->tree()); |
|
| 146 | + if ($source !== null && $source->canShowName()) { |
|
| 147 | + return $source; |
|
| 148 | + } |
|
| 149 | + } |
|
| 150 | + } |
|
| 151 | + } |
|
| 152 | + } |
|
| 153 | + } |
|
| 154 | 154 | |
| 155 | - return null; |
|
| 156 | - } |
|
| 155 | + return null; |
|
| 156 | + } |
|
| 157 | 157 | |
| 158 | - /** |
|
| 159 | - * Yield lists of gedcom records linked to a certificate. |
|
| 160 | - * |
|
| 161 | - * @param Certificate $certificate |
|
| 162 | - * @return Generator |
|
| 163 | - */ |
|
| 164 | - protected function linkedRecordsLists(Certificate $certificate): Generator |
|
| 165 | - { |
|
| 166 | - yield $this->linkedIndividuals($certificate); |
|
| 167 | - yield $this->linkedFamilies($certificate); |
|
| 168 | - yield $this->linkedMedias($certificate); |
|
| 169 | - yield $this->linkedNotes($certificate); |
|
| 170 | - } |
|
| 158 | + /** |
|
| 159 | + * Yield lists of gedcom records linked to a certificate. |
|
| 160 | + * |
|
| 161 | + * @param Certificate $certificate |
|
| 162 | + * @return Generator |
|
| 163 | + */ |
|
| 164 | + protected function linkedRecordsLists(Certificate $certificate): Generator |
|
| 165 | + { |
|
| 166 | + yield $this->linkedIndividuals($certificate); |
|
| 167 | + yield $this->linkedFamilies($certificate); |
|
| 168 | + yield $this->linkedMedias($certificate); |
|
| 169 | + yield $this->linkedNotes($certificate); |
|
| 170 | + } |
|
| 171 | 171 | } |
@@ -43,7 +43,7 @@ discard block |
||
| 43 | 43 | $tree = $certificate->tree(); |
| 44 | 44 | return DB::table('individuals') |
| 45 | 45 | ->where('i_file', '=', $tree->id()) |
| 46 | - ->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 46 | + ->where('i_gedcom', 'like', '% _ACT '.$this->escapedSqlPath($certificate).'%') |
|
| 47 | 47 | ->select(['individuals.*']) |
| 48 | 48 | ->get() |
| 49 | 49 | ->map(Registry::individualFactory()->mapper($tree)) |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | $tree = $certificate->tree(); |
| 65 | 65 | return DB::table('families') |
| 66 | 66 | ->where('f_file', '=', $tree->id()) |
| 67 | - ->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 67 | + ->where('f_gedcom', 'like', '% _ACT '.$this->escapedSqlPath($certificate).'%') |
|
| 68 | 68 | ->select(['families.*']) |
| 69 | 69 | ->get() |
| 70 | 70 | ->map(Registry::familyFactory()->mapper($tree)) |
@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | $tree = $certificate->tree(); |
| 86 | 86 | return DB::table('media') |
| 87 | 87 | ->where('m_file', '=', $tree->id()) |
| 88 | - ->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 88 | + ->where('m_gedcom', 'like', '% _ACT '.$this->escapedSqlPath($certificate).'%') |
|
| 89 | 89 | ->select(['media.*']) |
| 90 | 90 | ->get() |
| 91 | 91 | ->map(Registry::mediaFactory()->mapper($tree)) |
@@ -107,7 +107,7 @@ discard block |
||
| 107 | 107 | return DB::table('other') |
| 108 | 108 | ->where('o_file', '=', $tree->id()) |
| 109 | 109 | ->where('o_type', '=', 'NOTE') |
| 110 | - ->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%') |
|
| 110 | + ->where('o_gedcom', 'like', '% _ACT '.$this->escapedSqlPath($certificate).'%') |
|
| 111 | 111 | ->select(['other.*']) |
| 112 | 112 | ->get() |
| 113 | 113 | ->map(Registry::noteFactory()->mapper($tree)) |
@@ -135,7 +135,7 @@ discard block |
||
| 135 | 135 | public function oneLinkedSource(Certificate $certificate): ?Source |
| 136 | 136 | { |
| 137 | 137 | $regex_query = preg_quote($certificate->gedcomPath(), '/'); |
| 138 | - $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 |
|
| 138 | + $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 |
|
| 139 | 139 | |
| 140 | 140 | foreach ($this->linkedRecordsLists($certificate) as $linked_records) { |
| 141 | 141 | foreach ($linked_records as $gedcom_record) { |
@@ -31,139 +31,139 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class CertificateFilesystemService |
| 33 | 33 | { |
| 34 | - /** |
|
| 35 | - * @var array<int,FilesystemOperator> $filesystem |
|
| 36 | - */ |
|
| 37 | - private $filesystem = []; |
|
| 34 | + /** |
|
| 35 | + * @var array<int,FilesystemOperator> $filesystem |
|
| 36 | + */ |
|
| 37 | + private $filesystem = []; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Get the filesystem containing certificates for a tree. |
|
| 41 | - * |
|
| 42 | - * @param Tree $tree |
|
| 43 | - * @return FilesystemOperator |
|
| 44 | - */ |
|
| 45 | - public function filesystem(Tree $tree): FilesystemOperator |
|
| 46 | - { |
|
| 47 | - if (!isset($this->filesystem[$tree->id()])) { |
|
| 48 | - $cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/'); |
|
| 49 | - $adapter = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir); |
|
| 39 | + /** |
|
| 40 | + * Get the filesystem containing certificates for a tree. |
|
| 41 | + * |
|
| 42 | + * @param Tree $tree |
|
| 43 | + * @return FilesystemOperator |
|
| 44 | + */ |
|
| 45 | + public function filesystem(Tree $tree): FilesystemOperator |
|
| 46 | + { |
|
| 47 | + if (!isset($this->filesystem[$tree->id()])) { |
|
| 48 | + $cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/'); |
|
| 49 | + $adapter = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir); |
|
| 50 | 50 | |
| 51 | - $this->filesystem[$tree->id()] = new FileSystem($adapter); |
|
| 52 | - } |
|
| 53 | - return $this->filesystem[$tree->id()]; |
|
| 54 | - } |
|
| 51 | + $this->filesystem[$tree->id()] = new FileSystem($adapter); |
|
| 52 | + } |
|
| 53 | + return $this->filesystem[$tree->id()]; |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Set the filesystem containing certificates for a tree. |
|
| 58 | - * |
|
| 59 | - * @param Tree $tree |
|
| 60 | - * @param FilesystemOperator $filesystem |
|
| 61 | - */ |
|
| 62 | - public function setFilesystem(Tree $tree, FilesystemOperator $filesystem): void |
|
| 63 | - { |
|
| 64 | - $this->filesystem[$tree->id()] = $filesystem; |
|
| 65 | - } |
|
| 56 | + /** |
|
| 57 | + * Set the filesystem containing certificates for a tree. |
|
| 58 | + * |
|
| 59 | + * @param Tree $tree |
|
| 60 | + * @param FilesystemOperator $filesystem |
|
| 61 | + */ |
|
| 62 | + public function setFilesystem(Tree $tree, FilesystemOperator $filesystem): void |
|
| 63 | + { |
|
| 64 | + $this->filesystem[$tree->id()] = $filesystem; |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Create the Certificate object defined by a path on the filesystem. |
|
| 69 | - * |
|
| 70 | - * @param Tree $tree |
|
| 71 | - * @param string $path |
|
| 72 | - * @return Certificate|NULL |
|
| 73 | - */ |
|
| 74 | - public function certificate(Tree $tree, string $path): ?Certificate |
|
| 75 | - { |
|
| 76 | - $filesystem = $this->filesystem($tree); |
|
| 77 | - if ($filesystem->fileExists($path) && $this->isFileSupported($filesystem, $path)) { |
|
| 78 | - return new Certificate($tree, $path); |
|
| 79 | - } |
|
| 80 | - return null; |
|
| 81 | - } |
|
| 67 | + /** |
|
| 68 | + * Create the Certificate object defined by a path on the filesystem. |
|
| 69 | + * |
|
| 70 | + * @param Tree $tree |
|
| 71 | + * @param string $path |
|
| 72 | + * @return Certificate|NULL |
|
| 73 | + */ |
|
| 74 | + public function certificate(Tree $tree, string $path): ?Certificate |
|
| 75 | + { |
|
| 76 | + $filesystem = $this->filesystem($tree); |
|
| 77 | + if ($filesystem->fileExists($path) && $this->isFileSupported($filesystem, $path)) { |
|
| 78 | + return new Certificate($tree, $path); |
|
| 79 | + } |
|
| 80 | + return null; |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Get the cities (first-level folder) available in a the filesystem. |
|
| 85 | - * |
|
| 86 | - * @param Tree $tree |
|
| 87 | - * @return string[] |
|
| 88 | - */ |
|
| 89 | - public function cities(Tree $tree): array |
|
| 90 | - { |
|
| 91 | - return $this->filesystem($tree) |
|
| 92 | - ->listContents('') |
|
| 93 | - ->filter(function (StorageAttributes $attributes): bool { |
|
| 94 | - return $attributes->isDir(); |
|
| 95 | - })->map(function (StorageAttributes $attributes): string { |
|
| 96 | - return $attributes->path(); |
|
| 97 | - })->toArray(); |
|
| 98 | - } |
|
| 83 | + /** |
|
| 84 | + * Get the cities (first-level folder) available in a the filesystem. |
|
| 85 | + * |
|
| 86 | + * @param Tree $tree |
|
| 87 | + * @return string[] |
|
| 88 | + */ |
|
| 89 | + public function cities(Tree $tree): array |
|
| 90 | + { |
|
| 91 | + return $this->filesystem($tree) |
|
| 92 | + ->listContents('') |
|
| 93 | + ->filter(function (StorageAttributes $attributes): bool { |
|
| 94 | + return $attributes->isDir(); |
|
| 95 | + })->map(function (StorageAttributes $attributes): string { |
|
| 96 | + return $attributes->path(); |
|
| 97 | + })->toArray(); |
|
| 98 | + } |
|
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * Get the certificates available for a city (first-level folder). |
|
| 102 | - * |
|
| 103 | - * @param Tree $tree |
|
| 104 | - * @param string $city |
|
| 105 | - * @return Collection<Certificate> |
|
| 106 | - */ |
|
| 107 | - public function certificatesForCity(Tree $tree, string $city): Collection |
|
| 108 | - { |
|
| 109 | - $filesystem = $this->filesystem($tree); |
|
| 110 | - $certificate_paths = collect($filesystem |
|
| 111 | - ->listContents($city) |
|
| 112 | - ->filter(function (StorageAttributes $attributes) use ($filesystem): bool { |
|
| 113 | - return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()); |
|
| 114 | - })->map(function (StorageAttributes $attributes): string { |
|
| 115 | - return $attributes->path(); |
|
| 116 | - })->toArray()); |
|
| 100 | + /** |
|
| 101 | + * Get the certificates available for a city (first-level folder). |
|
| 102 | + * |
|
| 103 | + * @param Tree $tree |
|
| 104 | + * @param string $city |
|
| 105 | + * @return Collection<Certificate> |
|
| 106 | + */ |
|
| 107 | + public function certificatesForCity(Tree $tree, string $city): Collection |
|
| 108 | + { |
|
| 109 | + $filesystem = $this->filesystem($tree); |
|
| 110 | + $certificate_paths = collect($filesystem |
|
| 111 | + ->listContents($city) |
|
| 112 | + ->filter(function (StorageAttributes $attributes) use ($filesystem): bool { |
|
| 113 | + return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()); |
|
| 114 | + })->map(function (StorageAttributes $attributes): string { |
|
| 115 | + return $attributes->path(); |
|
| 116 | + })->toArray()); |
|
| 117 | 117 | |
| 118 | - return $certificate_paths->map(function (string $path) use ($tree): Certificate { |
|
| 119 | - return new Certificate($tree, $path); |
|
| 120 | - }); |
|
| 121 | - } |
|
| 118 | + return $certificate_paths->map(function (string $path) use ($tree): Certificate { |
|
| 119 | + return new Certificate($tree, $path); |
|
| 120 | + }); |
|
| 121 | + } |
|
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * Get the certificates available for a city (first-level folder), containing a specified text. |
|
| 125 | - * |
|
| 126 | - * @param Tree $tree |
|
| 127 | - * @param string $city |
|
| 128 | - * @param string $contains |
|
| 129 | - * @return Collection<Certificate> |
|
| 130 | - */ |
|
| 131 | - public function certificatesForCityContaining(Tree $tree, string $city, string $contains): Collection |
|
| 132 | - { |
|
| 133 | - $filesystem = $this->filesystem($tree); |
|
| 134 | - $certificate_paths = collect($filesystem |
|
| 135 | - ->listContents($city) |
|
| 136 | - ->filter(function (StorageAttributes $attributes) use ($filesystem, $contains): bool { |
|
| 137 | - return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()) |
|
| 138 | - && mb_stripos($attributes->path(), $contains) !== false; |
|
| 139 | - })->map(function (StorageAttributes $attributes): string { |
|
| 140 | - return $attributes->path(); |
|
| 141 | - })->toArray()); |
|
| 123 | + /** |
|
| 124 | + * Get the certificates available for a city (first-level folder), containing a specified text. |
|
| 125 | + * |
|
| 126 | + * @param Tree $tree |
|
| 127 | + * @param string $city |
|
| 128 | + * @param string $contains |
|
| 129 | + * @return Collection<Certificate> |
|
| 130 | + */ |
|
| 131 | + public function certificatesForCityContaining(Tree $tree, string $city, string $contains): Collection |
|
| 132 | + { |
|
| 133 | + $filesystem = $this->filesystem($tree); |
|
| 134 | + $certificate_paths = collect($filesystem |
|
| 135 | + ->listContents($city) |
|
| 136 | + ->filter(function (StorageAttributes $attributes) use ($filesystem, $contains): bool { |
|
| 137 | + return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()) |
|
| 138 | + && mb_stripos($attributes->path(), $contains) !== false; |
|
| 139 | + })->map(function (StorageAttributes $attributes): string { |
|
| 140 | + return $attributes->path(); |
|
| 141 | + })->toArray()); |
|
| 142 | 142 | |
| 143 | - return $certificate_paths->map(function (string $path) use ($tree): Certificate { |
|
| 144 | - return new Certificate($tree, $path); |
|
| 145 | - }); |
|
| 146 | - } |
|
| 143 | + return $certificate_paths->map(function (string $path) use ($tree): Certificate { |
|
| 144 | + return new Certificate($tree, $path); |
|
| 145 | + }); |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Check if a file on the filesystem is supported by the certificate module. |
|
| 150 | - * |
|
| 151 | - * @param FilesystemOperator $filesystem |
|
| 152 | - * @param string $path |
|
| 153 | - * @return bool |
|
| 154 | - */ |
|
| 155 | - protected function isFileSupported(FilesystemOperator $filesystem, string $path): bool |
|
| 156 | - { |
|
| 157 | - try { |
|
| 158 | - $mime = $filesystem->mimeType($path); |
|
| 159 | - return Registry::cache()->array()->remember( |
|
| 160 | - 'maj-certif-supportedfiles-' . $mime, |
|
| 161 | - function () use ($mime): bool { |
|
| 162 | - return app(CertificateImageFactory::class)->isMimeTypeSupported($mime); |
|
| 163 | - } |
|
| 164 | - ); |
|
| 165 | - } catch (UnableToRetrieveMetadata | FilesystemException $ex) { |
|
| 166 | - } |
|
| 167 | - return false; |
|
| 168 | - } |
|
| 148 | + /** |
|
| 149 | + * Check if a file on the filesystem is supported by the certificate module. |
|
| 150 | + * |
|
| 151 | + * @param FilesystemOperator $filesystem |
|
| 152 | + * @param string $path |
|
| 153 | + * @return bool |
|
| 154 | + */ |
|
| 155 | + protected function isFileSupported(FilesystemOperator $filesystem, string $path): bool |
|
| 156 | + { |
|
| 157 | + try { |
|
| 158 | + $mime = $filesystem->mimeType($path); |
|
| 159 | + return Registry::cache()->array()->remember( |
|
| 160 | + 'maj-certif-supportedfiles-' . $mime, |
|
| 161 | + function () use ($mime): bool { |
|
| 162 | + return app(CertificateImageFactory::class)->isMimeTypeSupported($mime); |
|
| 163 | + } |
|
| 164 | + ); |
|
| 165 | + } catch (UnableToRetrieveMetadata | FilesystemException $ex) { |
|
| 166 | + } |
|
| 167 | + return false; |
|
| 168 | + } |
|
| 169 | 169 | } |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | { |
| 47 | 47 | if (!isset($this->filesystem[$tree->id()])) { |
| 48 | 48 | $cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/'); |
| 49 | - $adapter = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir); |
|
| 49 | + $adapter = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir); |
|
| 50 | 50 | |
| 51 | 51 | $this->filesystem[$tree->id()] = new FileSystem($adapter); |
| 52 | 52 | } |
@@ -90,9 +90,9 @@ discard block |
||
| 90 | 90 | { |
| 91 | 91 | return $this->filesystem($tree) |
| 92 | 92 | ->listContents('') |
| 93 | - ->filter(function (StorageAttributes $attributes): bool { |
|
| 93 | + ->filter(function(StorageAttributes $attributes): bool { |
|
| 94 | 94 | return $attributes->isDir(); |
| 95 | - })->map(function (StorageAttributes $attributes): string { |
|
| 95 | + })->map(function(StorageAttributes $attributes): string { |
|
| 96 | 96 | return $attributes->path(); |
| 97 | 97 | })->toArray(); |
| 98 | 98 | } |
@@ -109,13 +109,13 @@ discard block |
||
| 109 | 109 | $filesystem = $this->filesystem($tree); |
| 110 | 110 | $certificate_paths = collect($filesystem |
| 111 | 111 | ->listContents($city) |
| 112 | - ->filter(function (StorageAttributes $attributes) use ($filesystem): bool { |
|
| 112 | + ->filter(function(StorageAttributes $attributes) use ($filesystem): bool { |
|
| 113 | 113 | return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()); |
| 114 | - })->map(function (StorageAttributes $attributes): string { |
|
| 114 | + })->map(function(StorageAttributes $attributes): string { |
|
| 115 | 115 | return $attributes->path(); |
| 116 | 116 | })->toArray()); |
| 117 | 117 | |
| 118 | - return $certificate_paths->map(function (string $path) use ($tree): Certificate { |
|
| 118 | + return $certificate_paths->map(function(string $path) use ($tree): Certificate { |
|
| 119 | 119 | return new Certificate($tree, $path); |
| 120 | 120 | }); |
| 121 | 121 | } |
@@ -133,14 +133,14 @@ discard block |
||
| 133 | 133 | $filesystem = $this->filesystem($tree); |
| 134 | 134 | $certificate_paths = collect($filesystem |
| 135 | 135 | ->listContents($city) |
| 136 | - ->filter(function (StorageAttributes $attributes) use ($filesystem, $contains): bool { |
|
| 136 | + ->filter(function(StorageAttributes $attributes) use ($filesystem, $contains): bool { |
|
| 137 | 137 | return $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()) |
| 138 | 138 | && mb_stripos($attributes->path(), $contains) !== false; |
| 139 | - })->map(function (StorageAttributes $attributes): string { |
|
| 139 | + })->map(function(StorageAttributes $attributes): string { |
|
| 140 | 140 | return $attributes->path(); |
| 141 | 141 | })->toArray()); |
| 142 | 142 | |
| 143 | - return $certificate_paths->map(function (string $path) use ($tree): Certificate { |
|
| 143 | + return $certificate_paths->map(function(string $path) use ($tree): Certificate { |
|
| 144 | 144 | return new Certificate($tree, $path); |
| 145 | 145 | }); |
| 146 | 146 | } |
@@ -157,8 +157,8 @@ discard block |
||
| 157 | 157 | try { |
| 158 | 158 | $mime = $filesystem->mimeType($path); |
| 159 | 159 | return Registry::cache()->array()->remember( |
| 160 | - 'maj-certif-supportedfiles-' . $mime, |
|
| 161 | - function () use ($mime): bool { |
|
| 160 | + 'maj-certif-supportedfiles-'.$mime, |
|
| 161 | + function() use ($mime): bool { |
|
| 162 | 162 | return app(CertificateImageFactory::class)->isMimeTypeSupported($mime); |
| 163 | 163 | } |
| 164 | 164 | ); |
@@ -23,121 +23,121 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | class UrlObfuscatorService |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var string|null $encryption_key |
|
| 28 | - */ |
|
| 29 | - private $encryption_key; |
|
| 30 | - |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Return (and generate) the key to be used for the encryption step |
|
| 34 | - * |
|
| 35 | - * @return string Encryption key |
|
| 36 | - */ |
|
| 37 | - protected function encryptionKey(): string |
|
| 38 | - { |
|
| 39 | - if ($this->encryption_key === null) { |
|
| 40 | - /** @var ServerRequestInterface $request **/ |
|
| 41 | - $request = app(ServerRequestInterface::class); |
|
| 42 | - $server_name = $request->getServerParams()['SERVER_NAME'] ?? ''; |
|
| 43 | - $server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? ''; |
|
| 44 | - $this->encryption_key = str_pad(md5( |
|
| 45 | - $server_name !== '' && $server_software !== '' ? |
|
| 46 | - $server_name . $server_software : |
|
| 47 | - 'STANDARDKEYIFNOSERVER' |
|
| 48 | - ), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF"); |
|
| 49 | - } |
|
| 50 | - return $this->encryption_key; |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Obfuscate a clear text, with a combination of encryption and base64 encoding. |
|
| 55 | - * The return string is URL-safe. |
|
| 56 | - * |
|
| 57 | - * @param string $cleartext Text to obfuscate |
|
| 58 | - * @param string $key |
|
| 59 | - * @param string $nonce |
|
| 60 | - * @return string |
|
| 61 | - */ |
|
| 62 | - public function obfuscate(string $cleartext, string $key = '', string $nonce = ''): string |
|
| 63 | - { |
|
| 64 | - if ($nonce === '') { |
|
| 65 | - $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES); |
|
| 66 | - } |
|
| 67 | - if ($key === '') { |
|
| 68 | - $key = $this->encryptionKey(); |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - if (strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) { |
|
| 72 | - throw new InvalidArgumentException('The nonce needs to be SODIUM_CRYPTO_SECRETBOX_NONCEBYTES long'); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) { |
|
| 76 | - throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long'); |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - \Fisharebest\Webtrees\DebugBar::addMessage($key); |
|
| 80 | - $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key); |
|
| 81 | - return strtr(base64_encode($nonce . $encryted), '+/=', '._-'); |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Deobfuscate a string from an URL to a clear text. |
|
| 86 | - * |
|
| 87 | - * @param string $obfuscated Text to deobfuscate |
|
| 88 | - * @param string $key |
|
| 89 | - * @throws InvalidArgumentException |
|
| 90 | - * @return string |
|
| 91 | - */ |
|
| 92 | - public function deobfuscate(string $obfuscated, string $key = ''): string |
|
| 93 | - { |
|
| 94 | - $obfuscated = strtr($obfuscated, '._-', '+/='); |
|
| 95 | - if ($key === '') { |
|
| 96 | - $key = $this->encryptionKey(); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) { |
|
| 100 | - throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long'); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - $encrypted = base64_decode($obfuscated, true); |
|
| 104 | - if ($encrypted === false) { |
|
| 105 | - throw new InvalidArgumentException('The encrypted value is not in correct base64 format.'); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) { |
|
| 109 | - throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.'); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - $nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit'); |
|
| 113 | - $ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit'); |
|
| 114 | - |
|
| 115 | - $decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key); |
|
| 116 | - |
|
| 117 | - if ($decrypted === false) { |
|
| 118 | - throw new InvalidArgumentException('The message has been tampered with in transit.'); |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - //sodium_memzero($ciphertext); // sodium_compat cannot handle it, only through libsodium |
|
| 122 | - |
|
| 123 | - /** @var string $decrypted - Psalm detect as string|true otherwise */ |
|
| 124 | - return $decrypted; |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success. |
|
| 129 | - * |
|
| 130 | - * @param string $obfuscated Text to deobfuscate |
|
| 131 | - * @param string $key |
|
| 132 | - * @return bool |
|
| 133 | - */ |
|
| 134 | - public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool |
|
| 135 | - { |
|
| 136 | - try { |
|
| 137 | - $obfuscated = $this->deobfuscate($obfuscated, $key); |
|
| 138 | - return true; |
|
| 139 | - } catch (InvalidArgumentException $ex) { |
|
| 140 | - } |
|
| 141 | - return false; |
|
| 142 | - } |
|
| 26 | + /** |
|
| 27 | + * @var string|null $encryption_key |
|
| 28 | + */ |
|
| 29 | + private $encryption_key; |
|
| 30 | + |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Return (and generate) the key to be used for the encryption step |
|
| 34 | + * |
|
| 35 | + * @return string Encryption key |
|
| 36 | + */ |
|
| 37 | + protected function encryptionKey(): string |
|
| 38 | + { |
|
| 39 | + if ($this->encryption_key === null) { |
|
| 40 | + /** @var ServerRequestInterface $request **/ |
|
| 41 | + $request = app(ServerRequestInterface::class); |
|
| 42 | + $server_name = $request->getServerParams()['SERVER_NAME'] ?? ''; |
|
| 43 | + $server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? ''; |
|
| 44 | + $this->encryption_key = str_pad(md5( |
|
| 45 | + $server_name !== '' && $server_software !== '' ? |
|
| 46 | + $server_name . $server_software : |
|
| 47 | + 'STANDARDKEYIFNOSERVER' |
|
| 48 | + ), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF"); |
|
| 49 | + } |
|
| 50 | + return $this->encryption_key; |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * Obfuscate a clear text, with a combination of encryption and base64 encoding. |
|
| 55 | + * The return string is URL-safe. |
|
| 56 | + * |
|
| 57 | + * @param string $cleartext Text to obfuscate |
|
| 58 | + * @param string $key |
|
| 59 | + * @param string $nonce |
|
| 60 | + * @return string |
|
| 61 | + */ |
|
| 62 | + public function obfuscate(string $cleartext, string $key = '', string $nonce = ''): string |
|
| 63 | + { |
|
| 64 | + if ($nonce === '') { |
|
| 65 | + $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES); |
|
| 66 | + } |
|
| 67 | + if ($key === '') { |
|
| 68 | + $key = $this->encryptionKey(); |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + if (strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) { |
|
| 72 | + throw new InvalidArgumentException('The nonce needs to be SODIUM_CRYPTO_SECRETBOX_NONCEBYTES long'); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) { |
|
| 76 | + throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long'); |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + \Fisharebest\Webtrees\DebugBar::addMessage($key); |
|
| 80 | + $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key); |
|
| 81 | + return strtr(base64_encode($nonce . $encryted), '+/=', '._-'); |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Deobfuscate a string from an URL to a clear text. |
|
| 86 | + * |
|
| 87 | + * @param string $obfuscated Text to deobfuscate |
|
| 88 | + * @param string $key |
|
| 89 | + * @throws InvalidArgumentException |
|
| 90 | + * @return string |
|
| 91 | + */ |
|
| 92 | + public function deobfuscate(string $obfuscated, string $key = ''): string |
|
| 93 | + { |
|
| 94 | + $obfuscated = strtr($obfuscated, '._-', '+/='); |
|
| 95 | + if ($key === '') { |
|
| 96 | + $key = $this->encryptionKey(); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) { |
|
| 100 | + throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long'); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + $encrypted = base64_decode($obfuscated, true); |
|
| 104 | + if ($encrypted === false) { |
|
| 105 | + throw new InvalidArgumentException('The encrypted value is not in correct base64 format.'); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) { |
|
| 109 | + throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.'); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + $nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit'); |
|
| 113 | + $ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit'); |
|
| 114 | + |
|
| 115 | + $decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key); |
|
| 116 | + |
|
| 117 | + if ($decrypted === false) { |
|
| 118 | + throw new InvalidArgumentException('The message has been tampered with in transit.'); |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + //sodium_memzero($ciphertext); // sodium_compat cannot handle it, only through libsodium |
|
| 122 | + |
|
| 123 | + /** @var string $decrypted - Psalm detect as string|true otherwise */ |
|
| 124 | + return $decrypted; |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success. |
|
| 129 | + * |
|
| 130 | + * @param string $obfuscated Text to deobfuscate |
|
| 131 | + * @param string $key |
|
| 132 | + * @return bool |
|
| 133 | + */ |
|
| 134 | + public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool |
|
| 135 | + { |
|
| 136 | + try { |
|
| 137 | + $obfuscated = $this->deobfuscate($obfuscated, $key); |
|
| 138 | + return true; |
|
| 139 | + } catch (InvalidArgumentException $ex) { |
|
| 140 | + } |
|
| 141 | + return false; |
|
| 142 | + } |
|
| 143 | 143 | } |
@@ -43,8 +43,7 @@ discard block |
||
| 43 | 43 | $server_software = $request->getServerParams()['SERVER_SOFTWARE'] ?? ''; |
| 44 | 44 | $this->encryption_key = str_pad(md5( |
| 45 | 45 | $server_name !== '' && $server_software !== '' ? |
| 46 | - $server_name . $server_software : |
|
| 47 | - 'STANDARDKEYIFNOSERVER' |
|
| 46 | + $server_name.$server_software : 'STANDARDKEYIFNOSERVER' |
|
| 48 | 47 | ), SODIUM_CRYPTO_SECRETBOX_KEYBYTES, "1234567890ABCDEF"); |
| 49 | 48 | } |
| 50 | 49 | return $this->encryption_key; |
@@ -78,7 +77,7 @@ discard block |
||
| 78 | 77 | |
| 79 | 78 | \Fisharebest\Webtrees\DebugBar::addMessage($key); |
| 80 | 79 | $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key); |
| 81 | - return strtr(base64_encode($nonce . $encryted), '+/=', '._-'); |
|
| 80 | + return strtr(base64_encode($nonce.$encryted), '+/=', '._-'); |
|
| 82 | 81 | } |
| 83 | 82 | |
| 84 | 83 | /** |
@@ -39,163 +39,163 @@ |
||
| 39 | 39 | */ |
| 40 | 40 | class CertificateImageFactory extends ImageFactory implements ImageFactoryInterface |
| 41 | 41 | { |
| 42 | - /** |
|
| 43 | - * @var CertificateFilesystemService $filesystem_service |
|
| 44 | - */ |
|
| 45 | - private $filesystem_service; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Constructor for the Certificate Image Factory |
|
| 49 | - * |
|
| 50 | - * @param CertificateFilesystemService $filesystem_service |
|
| 51 | - */ |
|
| 52 | - public function __construct(CertificateFilesystemService $filesystem_service) |
|
| 53 | - { |
|
| 54 | - $this->filesystem_service = $filesystem_service; |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Check is a file MIME type is supported by the system. |
|
| 59 | - * |
|
| 60 | - * @param string $mime |
|
| 61 | - * @return bool |
|
| 62 | - */ |
|
| 63 | - public function isMimeTypeSupported(string $mime): bool |
|
| 64 | - { |
|
| 65 | - return array_key_exists($mime, self::INTERVENTION_FORMATS); |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Create a full-size version of a certificate. |
|
| 70 | - * |
|
| 71 | - * @param Certificate $certificate |
|
| 72 | - * @param bool $add_watermark |
|
| 73 | - * @param Watermark $watermark |
|
| 74 | - * @throws InvalidArgumentException |
|
| 75 | - * @return ResponseInterface |
|
| 76 | - */ |
|
| 77 | - public function certificateFileResponse( |
|
| 78 | - Certificate $certificate, |
|
| 79 | - bool $add_watermark = false, |
|
| 80 | - Watermark $watermark = null |
|
| 81 | - ): ResponseInterface { |
|
| 82 | - $filesystem = $this->filesystem_service->filesystem($certificate->tree()); |
|
| 83 | - $filename = $certificate->path(); |
|
| 84 | - |
|
| 85 | - if (!$add_watermark) { |
|
| 86 | - return $this->fileResponse($filesystem, $filename, false); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - try { |
|
| 90 | - $image = $this->imageManager()->make($filesystem->readStream($filename)); |
|
| 91 | - $image = $this->autorotateImage($image); |
|
| 92 | - |
|
| 93 | - if ($watermark == null) { |
|
| 94 | - throw new InvalidArgumentException('Watermark data not defined'); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - $width = $image->width(); |
|
| 98 | - $height = $image->height(); |
|
| 99 | - |
|
| 100 | - $watermark->adjustSize($width); |
|
| 101 | - $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5); |
|
| 102 | - $watermark_y = $watermark->size() * 12 + 1; |
|
| 103 | - |
|
| 104 | - $font_definition = function (AbstractFont $font) use ($watermark): void { |
|
| 105 | - $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf'); |
|
| 106 | - $font->color($watermark->color()); |
|
| 107 | - $font->size($watermark->size()); |
|
| 108 | - $font->valign('top'); |
|
| 109 | - }; |
|
| 110 | - |
|
| 111 | - for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) { |
|
| 112 | - for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) { |
|
| 113 | - $image = $image->text($watermark->text(), $i, $j, $font_definition); |
|
| 114 | - } |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - $format = static::INTERVENTION_FORMATS[$image->mime()] ?? 'jpg'; |
|
| 118 | - $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY); |
|
| 119 | - $data = (string) $image->encode($format, $quality); |
|
| 120 | - |
|
| 121 | - return $this->imageResponse($data, $image->mime(), ''); |
|
| 122 | - } catch (NotReadableException $ex) { |
|
| 123 | - return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION)) |
|
| 124 | - ->withHeader('X-Image-Exception', $ex->getMessage()); |
|
| 125 | - } catch (FilesystemException | UnableToReadFile $ex) { |
|
| 126 | - return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND); |
|
| 127 | - } catch (Throwable $ex) { |
|
| 128 | - return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR) |
|
| 129 | - ->withHeader('X-Image-Exception', $ex->getMessage()); |
|
| 130 | - } |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Does a full-sized certificate need a watermark? |
|
| 135 | - * |
|
| 136 | - * @param Certificate $certificate |
|
| 137 | - * @param UserInterface $user |
|
| 138 | - * @return bool |
|
| 139 | - */ |
|
| 140 | - public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool |
|
| 141 | - { |
|
| 142 | - $tree = $certificate->tree(); |
|
| 143 | - |
|
| 144 | - return Auth::accessLevel($tree, $user) > $tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK'); |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * Neutralise the methods associated with MediaFile. |
|
| 149 | - */ |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * {@inheritDoc} |
|
| 153 | - * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileResponse() |
|
| 154 | - */ |
|
| 155 | - public function mediaFileResponse(MediaFile $media_file, bool $add_watermark, bool $download): ResponseInterface |
|
| 156 | - { |
|
| 157 | - throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * {@inheritDoc} |
|
| 162 | - * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileThumbnailResponse() |
|
| 163 | - */ |
|
| 164 | - public function mediaFileThumbnailResponse( |
|
| 165 | - MediaFile $media_file, |
|
| 166 | - int $width, |
|
| 167 | - int $height, |
|
| 168 | - string $fit, |
|
| 169 | - bool $add_watermark |
|
| 170 | - ): ResponseInterface { |
|
| 171 | - throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * {@inheritDoc} |
|
| 176 | - * @see \Fisharebest\Webtrees\Factories\ImageFactory::createWatermark() |
|
| 177 | - */ |
|
| 178 | - public function createWatermark(int $width, int $height, MediaFile $media_file): Image |
|
| 179 | - { |
|
| 180 | - |
|
| 181 | - throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - /** |
|
| 185 | - * {@inheritDoc} |
|
| 186 | - * @see \Fisharebest\Webtrees\Factories\ImageFactory::fileNeedsWatermark() |
|
| 187 | - */ |
|
| 188 | - public function fileNeedsWatermark(MediaFile $media_file, UserInterface $user): bool |
|
| 189 | - { |
|
| 190 | - throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * {@inheritDoc} |
|
| 195 | - * @see \Fisharebest\Webtrees\Factories\ImageFactory::thumbnailNeedsWatermark() |
|
| 196 | - */ |
|
| 197 | - public function thumbnailNeedsWatermark(MediaFile $media_file, UserInterface $user): bool |
|
| 198 | - { |
|
| 199 | - throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 200 | - } |
|
| 42 | + /** |
|
| 43 | + * @var CertificateFilesystemService $filesystem_service |
|
| 44 | + */ |
|
| 45 | + private $filesystem_service; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Constructor for the Certificate Image Factory |
|
| 49 | + * |
|
| 50 | + * @param CertificateFilesystemService $filesystem_service |
|
| 51 | + */ |
|
| 52 | + public function __construct(CertificateFilesystemService $filesystem_service) |
|
| 53 | + { |
|
| 54 | + $this->filesystem_service = $filesystem_service; |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Check is a file MIME type is supported by the system. |
|
| 59 | + * |
|
| 60 | + * @param string $mime |
|
| 61 | + * @return bool |
|
| 62 | + */ |
|
| 63 | + public function isMimeTypeSupported(string $mime): bool |
|
| 64 | + { |
|
| 65 | + return array_key_exists($mime, self::INTERVENTION_FORMATS); |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Create a full-size version of a certificate. |
|
| 70 | + * |
|
| 71 | + * @param Certificate $certificate |
|
| 72 | + * @param bool $add_watermark |
|
| 73 | + * @param Watermark $watermark |
|
| 74 | + * @throws InvalidArgumentException |
|
| 75 | + * @return ResponseInterface |
|
| 76 | + */ |
|
| 77 | + public function certificateFileResponse( |
|
| 78 | + Certificate $certificate, |
|
| 79 | + bool $add_watermark = false, |
|
| 80 | + Watermark $watermark = null |
|
| 81 | + ): ResponseInterface { |
|
| 82 | + $filesystem = $this->filesystem_service->filesystem($certificate->tree()); |
|
| 83 | + $filename = $certificate->path(); |
|
| 84 | + |
|
| 85 | + if (!$add_watermark) { |
|
| 86 | + return $this->fileResponse($filesystem, $filename, false); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + try { |
|
| 90 | + $image = $this->imageManager()->make($filesystem->readStream($filename)); |
|
| 91 | + $image = $this->autorotateImage($image); |
|
| 92 | + |
|
| 93 | + if ($watermark == null) { |
|
| 94 | + throw new InvalidArgumentException('Watermark data not defined'); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + $width = $image->width(); |
|
| 98 | + $height = $image->height(); |
|
| 99 | + |
|
| 100 | + $watermark->adjustSize($width); |
|
| 101 | + $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5); |
|
| 102 | + $watermark_y = $watermark->size() * 12 + 1; |
|
| 103 | + |
|
| 104 | + $font_definition = function (AbstractFont $font) use ($watermark): void { |
|
| 105 | + $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf'); |
|
| 106 | + $font->color($watermark->color()); |
|
| 107 | + $font->size($watermark->size()); |
|
| 108 | + $font->valign('top'); |
|
| 109 | + }; |
|
| 110 | + |
|
| 111 | + for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) { |
|
| 112 | + for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) { |
|
| 113 | + $image = $image->text($watermark->text(), $i, $j, $font_definition); |
|
| 114 | + } |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + $format = static::INTERVENTION_FORMATS[$image->mime()] ?? 'jpg'; |
|
| 118 | + $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY); |
|
| 119 | + $data = (string) $image->encode($format, $quality); |
|
| 120 | + |
|
| 121 | + return $this->imageResponse($data, $image->mime(), ''); |
|
| 122 | + } catch (NotReadableException $ex) { |
|
| 123 | + return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION)) |
|
| 124 | + ->withHeader('X-Image-Exception', $ex->getMessage()); |
|
| 125 | + } catch (FilesystemException | UnableToReadFile $ex) { |
|
| 126 | + return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND); |
|
| 127 | + } catch (Throwable $ex) { |
|
| 128 | + return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR) |
|
| 129 | + ->withHeader('X-Image-Exception', $ex->getMessage()); |
|
| 130 | + } |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Does a full-sized certificate need a watermark? |
|
| 135 | + * |
|
| 136 | + * @param Certificate $certificate |
|
| 137 | + * @param UserInterface $user |
|
| 138 | + * @return bool |
|
| 139 | + */ |
|
| 140 | + public function certificateNeedsWatermark(Certificate $certificate, UserInterface $user): bool |
|
| 141 | + { |
|
| 142 | + $tree = $certificate->tree(); |
|
| 143 | + |
|
| 144 | + return Auth::accessLevel($tree, $user) > $tree->getPreference('MAJ_CERTIF_SHOW_NO_WATERMARK'); |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * Neutralise the methods associated with MediaFile. |
|
| 149 | + */ |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * {@inheritDoc} |
|
| 153 | + * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileResponse() |
|
| 154 | + */ |
|
| 155 | + public function mediaFileResponse(MediaFile $media_file, bool $add_watermark, bool $download): ResponseInterface |
|
| 156 | + { |
|
| 157 | + throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * {@inheritDoc} |
|
| 162 | + * @see \Fisharebest\Webtrees\Factories\ImageFactory::mediaFileThumbnailResponse() |
|
| 163 | + */ |
|
| 164 | + public function mediaFileThumbnailResponse( |
|
| 165 | + MediaFile $media_file, |
|
| 166 | + int $width, |
|
| 167 | + int $height, |
|
| 168 | + string $fit, |
|
| 169 | + bool $add_watermark |
|
| 170 | + ): ResponseInterface { |
|
| 171 | + throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * {@inheritDoc} |
|
| 176 | + * @see \Fisharebest\Webtrees\Factories\ImageFactory::createWatermark() |
|
| 177 | + */ |
|
| 178 | + public function createWatermark(int $width, int $height, MediaFile $media_file): Image |
|
| 179 | + { |
|
| 180 | + |
|
| 181 | + throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + /** |
|
| 185 | + * {@inheritDoc} |
|
| 186 | + * @see \Fisharebest\Webtrees\Factories\ImageFactory::fileNeedsWatermark() |
|
| 187 | + */ |
|
| 188 | + public function fileNeedsWatermark(MediaFile $media_file, UserInterface $user): bool |
|
| 189 | + { |
|
| 190 | + throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * {@inheritDoc} |
|
| 195 | + * @see \Fisharebest\Webtrees\Factories\ImageFactory::thumbnailNeedsWatermark() |
|
| 196 | + */ |
|
| 197 | + public function thumbnailNeedsWatermark(MediaFile $media_file, UserInterface $user): bool |
|
| 198 | + { |
|
| 199 | + throw new BadMethodCallException("Invalid method for Certificates"); |
|
| 200 | + } |
|
| 201 | 201 | } |
@@ -79,7 +79,7 @@ discard block |
||
| 79 | 79 | bool $add_watermark = false, |
| 80 | 80 | Watermark $watermark = null |
| 81 | 81 | ): ResponseInterface { |
| 82 | - $filesystem = $this->filesystem_service->filesystem($certificate->tree()); |
|
| 82 | + $filesystem = $this->filesystem_service->filesystem($certificate->tree()); |
|
| 83 | 83 | $filename = $certificate->path(); |
| 84 | 84 | |
| 85 | 85 | if (!$add_watermark) { |
@@ -98,34 +98,34 @@ discard block |
||
| 98 | 98 | $height = $image->height(); |
| 99 | 99 | |
| 100 | 100 | $watermark->adjustSize($width); |
| 101 | - $watermark_x = (int) ceil($watermark->textLengthEstimate() * 1.5); |
|
| 101 | + $watermark_x = (int)ceil($watermark->textLengthEstimate() * 1.5); |
|
| 102 | 102 | $watermark_y = $watermark->size() * 12 + 1; |
| 103 | 103 | |
| 104 | - $font_definition = function (AbstractFont $font) use ($watermark): void { |
|
| 105 | - $font->file(Webtrees::ROOT_DIR . 'resources/fonts/DejaVuSans.ttf'); |
|
| 104 | + $font_definition = function(AbstractFont $font) use ($watermark): void { |
|
| 105 | + $font->file(Webtrees::ROOT_DIR.'resources/fonts/DejaVuSans.ttf'); |
|
| 106 | 106 | $font->color($watermark->color()); |
| 107 | 107 | $font->size($watermark->size()); |
| 108 | 108 | $font->valign('top'); |
| 109 | 109 | }; |
| 110 | 110 | |
| 111 | - for ($i = min((int) ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) { |
|
| 112 | - for ($j = min((int) ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) { |
|
| 111 | + for ($i = min((int)ceil($width * 0.1), $watermark_x); $i < $width; $i += $watermark_x) { |
|
| 112 | + for ($j = min((int)ceil($height * 0.1), $watermark_y); $j < $height; $j += $watermark_y) { |
|
| 113 | 113 | $image = $image->text($watermark->text(), $i, $j, $font_definition); |
| 114 | 114 | } |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | 117 | $format = static::INTERVENTION_FORMATS[$image->mime()] ?? 'jpg'; |
| 118 | 118 | $quality = $this->extractImageQuality($image, static::GD_DEFAULT_IMAGE_QUALITY); |
| 119 | - $data = (string) $image->encode($format, $quality); |
|
| 119 | + $data = (string)$image->encode($format, $quality); |
|
| 120 | 120 | |
| 121 | 121 | return $this->imageResponse($data, $image->mime(), ''); |
| 122 | 122 | } catch (NotReadableException $ex) { |
| 123 | 123 | return $this->replacementImageResponse(pathinfo($filename, PATHINFO_EXTENSION)) |
| 124 | 124 | ->withHeader('X-Image-Exception', $ex->getMessage()); |
| 125 | 125 | } catch (FilesystemException | UnableToReadFile $ex) { |
| 126 | - return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_NOT_FOUND); |
|
| 126 | + return $this->replacementImageResponse((string)StatusCodeInterface::STATUS_NOT_FOUND); |
|
| 127 | 127 | } catch (Throwable $ex) { |
| 128 | - return $this->replacementImageResponse((string) StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR) |
|
| 128 | + return $this->replacementImageResponse((string)StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR) |
|
| 129 | 129 | ->withHeader('X-Image-Exception', $ex->getMessage()); |
| 130 | 130 | } |
| 131 | 131 | } |