@@ -62,11 +62,11 @@ discard block |
||
| 62 | 62 | |
| 63 | 63 | $tree->setPreference( |
| 64 | 64 | 'MAJ_CERTIF_SHOW_CERT', |
| 65 | - (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE) |
|
| 65 | + (string)Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE) |
|
| 66 | 66 | ); |
| 67 | 67 | $tree->setPreference( |
| 68 | 68 | 'MAJ_CERTIF_SHOW_NO_WATERMARK', |
| 69 | - (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE) |
|
| 69 | + (string)Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE) |
|
| 70 | 70 | ); |
| 71 | 71 | $tree->setPreference( |
| 72 | 72 | 'MAJ_CERTIF_WM_DEFAULT', |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | |
| 76 | 76 | $tree->setPreference( |
| 77 | 77 | 'MAJ_CERTIF_WM_FONT_MAXSIZE', |
| 78 | - (string) ( |
|
| 78 | + (string)( |
|
| 79 | 79 | Validator::parsedBody($request)->isBetween(0, PHP_INT_MAX)->integer('MAJ_CERTIF_WM_FONT_MAXSIZE', 18) |
| 80 | 80 | ) |
| 81 | 81 | ); |
@@ -89,7 +89,7 @@ discard block |
||
| 89 | 89 | // Only accept valid folders for MAJ_CERT_ROOTDIR |
| 90 | 90 | $cert_root_dir = Validator::parsedBody($request)->string('MAJ_CERTIF_ROOTDIR', ''); |
| 91 | 91 | $cert_root_dir = preg_replace('/[:\/\\\\]+/', '/', $cert_root_dir) ?? ''; |
| 92 | - $cert_root_dir = trim($cert_root_dir, '/') . '/'; |
|
| 92 | + $cert_root_dir = trim($cert_root_dir, '/').'/'; |
|
| 93 | 93 | $tree->setPreference('MAJ_CERTIF_ROOTDIR', $cert_root_dir); |
| 94 | 94 | |
| 95 | 95 | FlashMessages::addMessage( |
@@ -30,71 +30,71 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | class AdminConfigAction implements RequestHandlerInterface |
| 32 | 32 | { |
| 33 | - private ?CertificatesModule $module; |
|
| 33 | + private ?CertificatesModule $module; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Constructor for Admin Config Action request handler |
|
| 37 | - * |
|
| 38 | - * @param ModuleService $module_service |
|
| 39 | - */ |
|
| 40 | - public function __construct(ModuleService $module_service) |
|
| 41 | - { |
|
| 42 | - $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 43 | - } |
|
| 35 | + /** |
|
| 36 | + * Constructor for Admin Config Action request handler |
|
| 37 | + * |
|
| 38 | + * @param ModuleService $module_service |
|
| 39 | + */ |
|
| 40 | + public function __construct(ModuleService $module_service) |
|
| 41 | + { |
|
| 42 | + $this->module = $module_service->findByInterface(CertificatesModule::class)->first(); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * {@inheritDoc} |
|
| 47 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 48 | - */ |
|
| 49 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 50 | - { |
|
| 51 | - $tree = Validator::attributes($request)->tree(); |
|
| 45 | + /** |
|
| 46 | + * {@inheritDoc} |
|
| 47 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 48 | + */ |
|
| 49 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 50 | + { |
|
| 51 | + $tree = Validator::attributes($request)->tree(); |
|
| 52 | 52 | |
| 53 | - if ($this->module === null) { |
|
| 54 | - FlashMessages::addMessage( |
|
| 55 | - I18N::translate('The attached module could not be found.'), |
|
| 56 | - 'danger' |
|
| 57 | - ); |
|
| 58 | - return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]); |
|
| 59 | - } |
|
| 53 | + if ($this->module === null) { |
|
| 54 | + FlashMessages::addMessage( |
|
| 55 | + I18N::translate('The attached module could not be found.'), |
|
| 56 | + 'danger' |
|
| 57 | + ); |
|
| 58 | + return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | - $tree->setPreference( |
|
| 62 | - 'MAJ_CERTIF_SHOW_CERT', |
|
| 63 | - (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE) |
|
| 64 | - ); |
|
| 65 | - $tree->setPreference( |
|
| 66 | - 'MAJ_CERTIF_SHOW_NO_WATERMARK', |
|
| 67 | - (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE) |
|
| 68 | - ); |
|
| 69 | - $tree->setPreference( |
|
| 70 | - 'MAJ_CERTIF_WM_DEFAULT', |
|
| 71 | - Validator::parsedBody($request)->string('MAJ_CERTIF_WM_DEFAULT', '') |
|
| 72 | - ); |
|
| 61 | + $tree->setPreference( |
|
| 62 | + 'MAJ_CERTIF_SHOW_CERT', |
|
| 63 | + (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_CERT', Auth::PRIV_HIDE) |
|
| 64 | + ); |
|
| 65 | + $tree->setPreference( |
|
| 66 | + 'MAJ_CERTIF_SHOW_NO_WATERMARK', |
|
| 67 | + (string) Validator::parsedBody($request)->integer('MAJ_CERTIF_SHOW_NO_WATERMARK', Auth::PRIV_HIDE) |
|
| 68 | + ); |
|
| 69 | + $tree->setPreference( |
|
| 70 | + 'MAJ_CERTIF_WM_DEFAULT', |
|
| 71 | + Validator::parsedBody($request)->string('MAJ_CERTIF_WM_DEFAULT', '') |
|
| 72 | + ); |
|
| 73 | 73 | |
| 74 | - $tree->setPreference( |
|
| 75 | - 'MAJ_CERTIF_WM_FONT_MAXSIZE', |
|
| 76 | - (string) ( |
|
| 77 | - Validator::parsedBody($request)->isBetween(0, PHP_INT_MAX)->integer('MAJ_CERTIF_WM_FONT_MAXSIZE', 18) |
|
| 78 | - ) |
|
| 79 | - ); |
|
| 74 | + $tree->setPreference( |
|
| 75 | + 'MAJ_CERTIF_WM_FONT_MAXSIZE', |
|
| 76 | + (string) ( |
|
| 77 | + Validator::parsedBody($request)->isBetween(0, PHP_INT_MAX)->integer('MAJ_CERTIF_WM_FONT_MAXSIZE', 18) |
|
| 78 | + ) |
|
| 79 | + ); |
|
| 80 | 80 | |
| 81 | - // Only accept valid color for MAJ_WM_FONT_COLOR |
|
| 82 | - $watermark_color = Validator::parsedBody($request)->string('MAJ_CERTIF_WM_FONT_COLOR', ''); |
|
| 83 | - if (preg_match('/#([a-fA-F0-9]{3}){1,2}/', $watermark_color) === 1) { |
|
| 84 | - $tree->setPreference('MAJ_CERTIF_WM_FONT_COLOR', $watermark_color); |
|
| 85 | - } |
|
| 81 | + // Only accept valid color for MAJ_WM_FONT_COLOR |
|
| 82 | + $watermark_color = Validator::parsedBody($request)->string('MAJ_CERTIF_WM_FONT_COLOR', ''); |
|
| 83 | + if (preg_match('/#([a-fA-F0-9]{3}){1,2}/', $watermark_color) === 1) { |
|
| 84 | + $tree->setPreference('MAJ_CERTIF_WM_FONT_COLOR', $watermark_color); |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | - // Only accept valid folders for MAJ_CERT_ROOTDIR |
|
| 88 | - $cert_root_dir = Validator::parsedBody($request)->string('MAJ_CERTIF_ROOTDIR', ''); |
|
| 89 | - $cert_root_dir = preg_replace('/[:\/\\\\]+/', '/', $cert_root_dir) ?? ''; |
|
| 90 | - $cert_root_dir = trim($cert_root_dir, '/') . '/'; |
|
| 91 | - $tree->setPreference('MAJ_CERTIF_ROOTDIR', $cert_root_dir); |
|
| 87 | + // Only accept valid folders for MAJ_CERT_ROOTDIR |
|
| 88 | + $cert_root_dir = Validator::parsedBody($request)->string('MAJ_CERTIF_ROOTDIR', ''); |
|
| 89 | + $cert_root_dir = preg_replace('/[:\/\\\\]+/', '/', $cert_root_dir) ?? ''; |
|
| 90 | + $cert_root_dir = trim($cert_root_dir, '/') . '/'; |
|
| 91 | + $tree->setPreference('MAJ_CERTIF_ROOTDIR', $cert_root_dir); |
|
| 92 | 92 | |
| 93 | - FlashMessages::addMessage( |
|
| 94 | - I18N::translate('The preferences for the module “%s” have been updated.', $this->module->title()), |
|
| 95 | - 'success' |
|
| 96 | - ); |
|
| 93 | + FlashMessages::addMessage( |
|
| 94 | + I18N::translate('The preferences for the module “%s” have been updated.', $this->module->title()), |
|
| 95 | + 'success' |
|
| 96 | + ); |
|
| 97 | 97 | |
| 98 | - return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]); |
|
| 99 | - } |
|
| 98 | + return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]); |
|
| 99 | + } |
|
| 100 | 100 | } |
@@ -23,120 +23,120 @@ |
||
| 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 | - $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key); |
|
| 80 | - return strtr(base64_encode($nonce . $encryted), '+/=', '._-'); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * Deobfuscate a string from an URL to a clear text. |
|
| 85 | - * |
|
| 86 | - * @param string $obfuscated Text to deobfuscate |
|
| 87 | - * @param string $key |
|
| 88 | - * @throws InvalidArgumentException |
|
| 89 | - * @return string |
|
| 90 | - */ |
|
| 91 | - public function deobfuscate(string $obfuscated, string $key = ''): string |
|
| 92 | - { |
|
| 93 | - $obfuscated = strtr($obfuscated, '._-', '+/='); |
|
| 94 | - if ($key === '') { |
|
| 95 | - $key = $this->encryptionKey(); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) { |
|
| 99 | - throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long'); |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - $encrypted = base64_decode($obfuscated, true); |
|
| 103 | - if ($encrypted === false) { |
|
| 104 | - throw new InvalidArgumentException('The encrypted value is not in correct base64 format.'); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) { |
|
| 108 | - throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.'); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - $nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit'); |
|
| 112 | - $ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit'); |
|
| 113 | - |
|
| 114 | - $decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key); |
|
| 115 | - |
|
| 116 | - if ($decrypted === false) { |
|
| 117 | - throw new InvalidArgumentException('The message has been tampered with in transit.'); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - //sodium_memzero($ciphertext); // sodium_compat cannot handle it, only through libsodium |
|
| 121 | - |
|
| 122 | - /** @var string $decrypted - Psalm detect as string|true otherwise */ |
|
| 123 | - return $decrypted; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success. |
|
| 128 | - * |
|
| 129 | - * @param string $obfuscated Text to deobfuscate |
|
| 130 | - * @param string $key |
|
| 131 | - * @return bool |
|
| 132 | - */ |
|
| 133 | - public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool |
|
| 134 | - { |
|
| 135 | - try { |
|
| 136 | - $obfuscated = $this->deobfuscate($obfuscated, $key); |
|
| 137 | - return true; |
|
| 138 | - } catch (InvalidArgumentException $ex) { |
|
| 139 | - } |
|
| 140 | - return false; |
|
| 141 | - } |
|
| 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 | + $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key); |
|
| 80 | + return strtr(base64_encode($nonce . $encryted), '+/=', '._-'); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * Deobfuscate a string from an URL to a clear text. |
|
| 85 | + * |
|
| 86 | + * @param string $obfuscated Text to deobfuscate |
|
| 87 | + * @param string $key |
|
| 88 | + * @throws InvalidArgumentException |
|
| 89 | + * @return string |
|
| 90 | + */ |
|
| 91 | + public function deobfuscate(string $obfuscated, string $key = ''): string |
|
| 92 | + { |
|
| 93 | + $obfuscated = strtr($obfuscated, '._-', '+/='); |
|
| 94 | + if ($key === '') { |
|
| 95 | + $key = $this->encryptionKey(); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + if (strlen($key) !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) { |
|
| 99 | + throw new InvalidArgumentException('The key needs to be SODIUM_CRYPTO_SECRETBOX_KEYBYTES long'); |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + $encrypted = base64_decode($obfuscated, true); |
|
| 103 | + if ($encrypted === false) { |
|
| 104 | + throw new InvalidArgumentException('The encrypted value is not in correct base64 format.'); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + if (mb_strlen($encrypted, '8bit') < (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES)) { |
|
| 108 | + throw new InvalidArgumentException('The encrypted value does not contain enough characters for the key.'); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + $nonce = mb_substr($encrypted, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit'); |
|
| 112 | + $ciphertext = mb_substr($encrypted, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit'); |
|
| 113 | + |
|
| 114 | + $decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key); |
|
| 115 | + |
|
| 116 | + if ($decrypted === false) { |
|
| 117 | + throw new InvalidArgumentException('The message has been tampered with in transit.'); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + //sodium_memzero($ciphertext); // sodium_compat cannot handle it, only through libsodium |
|
| 121 | + |
|
| 122 | + /** @var string $decrypted - Psalm detect as string|true otherwise */ |
|
| 123 | + return $decrypted; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Try to deobfuscate a string from an URL to a clear text, returning whether the operation is a success. |
|
| 128 | + * |
|
| 129 | + * @param string $obfuscated Text to deobfuscate |
|
| 130 | + * @param string $key |
|
| 131 | + * @return bool |
|
| 132 | + */ |
|
| 133 | + public function tryDeobfuscate(string &$obfuscated, string $key = ''): bool |
|
| 134 | + { |
|
| 135 | + try { |
|
| 136 | + $obfuscated = $this->deobfuscate($obfuscated, $key); |
|
| 137 | + return true; |
|
| 138 | + } catch (InvalidArgumentException $ex) { |
|
| 139 | + } |
|
| 140 | + return false; |
|
| 141 | + } |
|
| 142 | 142 | } |
@@ -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; |
@@ -77,7 +76,7 @@ discard block |
||
| 77 | 76 | } |
| 78 | 77 | |
| 79 | 78 | $encryted = sodium_crypto_secretbox($cleartext, $nonce, $key); |
| 80 | - return strtr(base64_encode($nonce . $encryted), '+/=', '._-'); |
|
| 79 | + return strtr(base64_encode($nonce.$encryted), '+/=', '._-'); |
|
| 81 | 80 | } |
| 82 | 81 | |
| 83 | 82 | /** |
@@ -28,133 +28,133 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | class GeoAnalysisPlace |
| 30 | 30 | { |
| 31 | - /** |
|
| 32 | - * The default place name for invalid places |
|
| 33 | - * @var string INVALID_PLACE |
|
| 34 | - */ |
|
| 35 | - private const INVALID_PLACE = '##INVALID##'; |
|
| 36 | - |
|
| 37 | - private Place $place; |
|
| 38 | - private bool $is_excluded; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Constructor for GeoAnalysisPlace |
|
| 42 | - * |
|
| 43 | - * @param Tree $tree Default tree |
|
| 44 | - * @param Place|null $place Place resulting from the analysis |
|
| 45 | - * @param int $depth Place hierarchy depth defined by the geographical analysis view |
|
| 46 | - * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid |
|
| 47 | - */ |
|
| 48 | - public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false) |
|
| 49 | - { |
|
| 50 | - $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree); |
|
| 51 | - $this->is_excluded = false; |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Process the provided Place to determine its status for further usage |
|
| 56 | - * |
|
| 57 | - * @param Place|null $place |
|
| 58 | - * @param int $depth |
|
| 59 | - * @param bool $strict_depth |
|
| 60 | - * @return Place|NULL |
|
| 61 | - */ |
|
| 62 | - private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place |
|
| 63 | - { |
|
| 64 | - if ($place === null) { |
|
| 65 | - return null; |
|
| 66 | - } |
|
| 67 | - if (mb_strlen($place->gedcomName()) === 0) { |
|
| 68 | - return null; |
|
| 69 | - } |
|
| 70 | - $parts = $place->lastParts($depth); |
|
| 71 | - if ($strict_depth && $parts->count() !== $depth) { |
|
| 72 | - return new Place(self::INVALID_PLACE, $place->tree()); |
|
| 73 | - } |
|
| 74 | - return new Place($parts->implode(', '), $place->tree()); |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Get the GeoAnalysis Place key |
|
| 79 | - * |
|
| 80 | - * @return string |
|
| 81 | - */ |
|
| 82 | - public function key(): string |
|
| 83 | - { |
|
| 84 | - return $this->place->gedcomName(); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Get the underlying Place object |
|
| 89 | - * |
|
| 90 | - * @return Place |
|
| 91 | - */ |
|
| 92 | - public function place(): Place |
|
| 93 | - { |
|
| 94 | - return $this->place; |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Check if the GeoAnalysis Place is in the Known status |
|
| 99 | - * |
|
| 100 | - * @return bool |
|
| 101 | - */ |
|
| 102 | - public function isKnown(): bool |
|
| 103 | - { |
|
| 104 | - return !$this->isUnknown(); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Check if the GeoAnalysis Place is in the Unknown status |
|
| 109 | - * |
|
| 110 | - * @return bool |
|
| 111 | - */ |
|
| 112 | - public function isUnknown(): bool |
|
| 113 | - { |
|
| 114 | - return mb_strlen($this->place->gedcomName()) === 0; |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Check if the GeoAnalysis Place is in the Invalid status |
|
| 119 | - * |
|
| 120 | - * @return bool |
|
| 121 | - */ |
|
| 122 | - public function isInvalid(): bool |
|
| 123 | - { |
|
| 124 | - return $this->place->gedcomName() === self::INVALID_PLACE; |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * Check if the GeoAnalysis Place is in the Excluded status |
|
| 129 | - * |
|
| 130 | - * @return bool |
|
| 131 | - */ |
|
| 132 | - public function isExcluded(): bool |
|
| 133 | - { |
|
| 134 | - return $this->isUnknown() || $this->isInvalid() || $this->is_excluded; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Set the GeoAnalysis Place status to Found, if the parameter is true |
|
| 139 | - * |
|
| 140 | - * @param bool $include |
|
| 141 | - * @return $this |
|
| 142 | - */ |
|
| 143 | - public function include(bool $include = true): self |
|
| 144 | - { |
|
| 145 | - $this->is_excluded = !$include; |
|
| 146 | - return $this; |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * Set the GeoAnalysis Place status to Excluded, if the parameter is true |
|
| 151 | - * |
|
| 152 | - * @param bool $exclude |
|
| 153 | - * @return $this |
|
| 154 | - */ |
|
| 155 | - public function exclude(bool $exclude = true): self |
|
| 156 | - { |
|
| 157 | - $this->is_excluded = $exclude; |
|
| 158 | - return $this; |
|
| 159 | - } |
|
| 31 | + /** |
|
| 32 | + * The default place name for invalid places |
|
| 33 | + * @var string INVALID_PLACE |
|
| 34 | + */ |
|
| 35 | + private const INVALID_PLACE = '##INVALID##'; |
|
| 36 | + |
|
| 37 | + private Place $place; |
|
| 38 | + private bool $is_excluded; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Constructor for GeoAnalysisPlace |
|
| 42 | + * |
|
| 43 | + * @param Tree $tree Default tree |
|
| 44 | + * @param Place|null $place Place resulting from the analysis |
|
| 45 | + * @param int $depth Place hierarchy depth defined by the geographical analysis view |
|
| 46 | + * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid |
|
| 47 | + */ |
|
| 48 | + public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false) |
|
| 49 | + { |
|
| 50 | + $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree); |
|
| 51 | + $this->is_excluded = false; |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Process the provided Place to determine its status for further usage |
|
| 56 | + * |
|
| 57 | + * @param Place|null $place |
|
| 58 | + * @param int $depth |
|
| 59 | + * @param bool $strict_depth |
|
| 60 | + * @return Place|NULL |
|
| 61 | + */ |
|
| 62 | + private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place |
|
| 63 | + { |
|
| 64 | + if ($place === null) { |
|
| 65 | + return null; |
|
| 66 | + } |
|
| 67 | + if (mb_strlen($place->gedcomName()) === 0) { |
|
| 68 | + return null; |
|
| 69 | + } |
|
| 70 | + $parts = $place->lastParts($depth); |
|
| 71 | + if ($strict_depth && $parts->count() !== $depth) { |
|
| 72 | + return new Place(self::INVALID_PLACE, $place->tree()); |
|
| 73 | + } |
|
| 74 | + return new Place($parts->implode(', '), $place->tree()); |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Get the GeoAnalysis Place key |
|
| 79 | + * |
|
| 80 | + * @return string |
|
| 81 | + */ |
|
| 82 | + public function key(): string |
|
| 83 | + { |
|
| 84 | + return $this->place->gedcomName(); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Get the underlying Place object |
|
| 89 | + * |
|
| 90 | + * @return Place |
|
| 91 | + */ |
|
| 92 | + public function place(): Place |
|
| 93 | + { |
|
| 94 | + return $this->place; |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Check if the GeoAnalysis Place is in the Known status |
|
| 99 | + * |
|
| 100 | + * @return bool |
|
| 101 | + */ |
|
| 102 | + public function isKnown(): bool |
|
| 103 | + { |
|
| 104 | + return !$this->isUnknown(); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Check if the GeoAnalysis Place is in the Unknown status |
|
| 109 | + * |
|
| 110 | + * @return bool |
|
| 111 | + */ |
|
| 112 | + public function isUnknown(): bool |
|
| 113 | + { |
|
| 114 | + return mb_strlen($this->place->gedcomName()) === 0; |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Check if the GeoAnalysis Place is in the Invalid status |
|
| 119 | + * |
|
| 120 | + * @return bool |
|
| 121 | + */ |
|
| 122 | + public function isInvalid(): bool |
|
| 123 | + { |
|
| 124 | + return $this->place->gedcomName() === self::INVALID_PLACE; |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * Check if the GeoAnalysis Place is in the Excluded status |
|
| 129 | + * |
|
| 130 | + * @return bool |
|
| 131 | + */ |
|
| 132 | + public function isExcluded(): bool |
|
| 133 | + { |
|
| 134 | + return $this->isUnknown() || $this->isInvalid() || $this->is_excluded; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Set the GeoAnalysis Place status to Found, if the parameter is true |
|
| 139 | + * |
|
| 140 | + * @param bool $include |
|
| 141 | + * @return $this |
|
| 142 | + */ |
|
| 143 | + public function include(bool $include = true): self |
|
| 144 | + { |
|
| 145 | + $this->is_excluded = !$include; |
|
| 146 | + return $this; |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * Set the GeoAnalysis Place status to Excluded, if the parameter is true |
|
| 151 | + * |
|
| 152 | + * @param bool $exclude |
|
| 153 | + * @return $this |
|
| 154 | + */ |
|
| 155 | + public function exclude(bool $exclude = true): self |
|
| 156 | + { |
|
| 157 | + $this->is_excluded = $exclude; |
|
| 158 | + return $this; |
|
| 159 | + } |
|
| 160 | 160 | } |
@@ -20,67 +20,67 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | class GeoAnalysisResultItem |
| 22 | 22 | { |
| 23 | - private GeoAnalysisPlace $place; |
|
| 24 | - private int $count; |
|
| 23 | + private GeoAnalysisPlace $place; |
|
| 24 | + private int $count; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * Constructor for GeoAnalysisResultItem |
|
| 28 | - * |
|
| 29 | - * @param GeoAnalysisPlace $place |
|
| 30 | - * @param int $count |
|
| 31 | - */ |
|
| 32 | - public function __construct(GeoAnalysisPlace $place, int $count = 0) |
|
| 33 | - { |
|
| 34 | - $this->place = $place; |
|
| 35 | - $this->count = $count; |
|
| 36 | - } |
|
| 26 | + /** |
|
| 27 | + * Constructor for GeoAnalysisResultItem |
|
| 28 | + * |
|
| 29 | + * @param GeoAnalysisPlace $place |
|
| 30 | + * @param int $count |
|
| 31 | + */ |
|
| 32 | + public function __construct(GeoAnalysisPlace $place, int $count = 0) |
|
| 33 | + { |
|
| 34 | + $this->place = $place; |
|
| 35 | + $this->count = $count; |
|
| 36 | + } |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Get the item key. |
|
| 40 | - * |
|
| 41 | - * @return string |
|
| 42 | - */ |
|
| 43 | - public function key(): string |
|
| 44 | - { |
|
| 45 | - return $this->place->key(); |
|
| 46 | - } |
|
| 38 | + /** |
|
| 39 | + * Get the item key. |
|
| 40 | + * |
|
| 41 | + * @return string |
|
| 42 | + */ |
|
| 43 | + public function key(): string |
|
| 44 | + { |
|
| 45 | + return $this->place->key(); |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Get the referenced GeoAnalysis Place |
|
| 50 | - * |
|
| 51 | - * @return GeoAnalysisPlace |
|
| 52 | - */ |
|
| 53 | - public function place(): GeoAnalysisPlace |
|
| 54 | - { |
|
| 55 | - return $this->place; |
|
| 56 | - } |
|
| 48 | + /** |
|
| 49 | + * Get the referenced GeoAnalysis Place |
|
| 50 | + * |
|
| 51 | + * @return GeoAnalysisPlace |
|
| 52 | + */ |
|
| 53 | + public function place(): GeoAnalysisPlace |
|
| 54 | + { |
|
| 55 | + return $this->place; |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Get the count of occurrences of the GeoAnalysis Place in the analysis |
|
| 60 | - * |
|
| 61 | - * @return int |
|
| 62 | - */ |
|
| 63 | - public function count(): int |
|
| 64 | - { |
|
| 65 | - return $this->count; |
|
| 66 | - } |
|
| 58 | + /** |
|
| 59 | + * Get the count of occurrences of the GeoAnalysis Place in the analysis |
|
| 60 | + * |
|
| 61 | + * @return int |
|
| 62 | + */ |
|
| 63 | + public function count(): int |
|
| 64 | + { |
|
| 65 | + return $this->count; |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Increment the count of occurrences of the GeoAnalysis Place in the analysis |
|
| 70 | - * |
|
| 71 | - * @return $this |
|
| 72 | - */ |
|
| 73 | - public function increment(): self |
|
| 74 | - { |
|
| 75 | - $this->count++; |
|
| 76 | - return $this; |
|
| 77 | - } |
|
| 68 | + /** |
|
| 69 | + * Increment the count of occurrences of the GeoAnalysis Place in the analysis |
|
| 70 | + * |
|
| 71 | + * @return $this |
|
| 72 | + */ |
|
| 73 | + public function increment(): self |
|
| 74 | + { |
|
| 75 | + $this->count++; |
|
| 76 | + return $this; |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Clone the item object |
|
| 81 | - */ |
|
| 82 | - public function __clone() |
|
| 83 | - { |
|
| 84 | - $this->place = clone $this->place; |
|
| 85 | - } |
|
| 79 | + /** |
|
| 80 | + * Clone the item object |
|
| 81 | + */ |
|
| 82 | + public function __clone() |
|
| 83 | + { |
|
| 84 | + $this->place = clone $this->place; |
|
| 85 | + } |
|
| 86 | 86 | } |
@@ -31,40 +31,40 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class AuthTreePreference implements MiddlewareInterface |
| 33 | 33 | { |
| 34 | - /** |
|
| 35 | - * {@inheritDoc} |
|
| 36 | - * @see \Psr\Http\Server\MiddlewareInterface::process() |
|
| 37 | - */ |
|
| 38 | - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface |
|
| 39 | - { |
|
| 40 | - $tree = Validator::attributes($request)->tree(); |
|
| 41 | - $route = Validator::attributes($request)->route(); |
|
| 42 | - $user = Validator::attributes($request)->user(); |
|
| 34 | + /** |
|
| 35 | + * {@inheritDoc} |
|
| 36 | + * @see \Psr\Http\Server\MiddlewareInterface::process() |
|
| 37 | + */ |
|
| 38 | + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface |
|
| 39 | + { |
|
| 40 | + $tree = Validator::attributes($request)->tree(); |
|
| 41 | + $route = Validator::attributes($request)->route(); |
|
| 42 | + $user = Validator::attributes($request)->user(); |
|
| 43 | 43 | |
| 44 | - $permission_preference = $route->extras['permission_preference'] ?? ''; |
|
| 45 | - $permission_level = $permission_preference === '' ? '' : $tree->getPreference($permission_preference); |
|
| 44 | + $permission_preference = $route->extras['permission_preference'] ?? ''; |
|
| 45 | + $permission_level = $permission_preference === '' ? '' : $tree->getPreference($permission_preference); |
|
| 46 | 46 | |
| 47 | - // Permissions are configured |
|
| 48 | - if (is_numeric($permission_level)) { |
|
| 49 | - // Logged in with the correct role? |
|
| 50 | - if (Auth::accessLevel($tree, $user) <= (int) $permission_level) { |
|
| 51 | - return $handler->handle($request); |
|
| 52 | - } |
|
| 47 | + // Permissions are configured |
|
| 48 | + if (is_numeric($permission_level)) { |
|
| 49 | + // Logged in with the correct role? |
|
| 50 | + if (Auth::accessLevel($tree, $user) <= (int) $permission_level) { |
|
| 51 | + return $handler->handle($request); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - // Logged in, but without the correct role? |
|
| 55 | - if ($user instanceof User) { |
|
| 56 | - throw new HttpAccessDeniedException(); |
|
| 57 | - } |
|
| 58 | - } |
|
| 54 | + // Logged in, but without the correct role? |
|
| 55 | + if ($user instanceof User) { |
|
| 56 | + throw new HttpAccessDeniedException(); |
|
| 57 | + } |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - // Permissions no configured, or not logged in |
|
| 61 | - if ($request->getMethod() === RequestMethodInterface::METHOD_POST) { |
|
| 62 | - throw new HttpAccessDeniedException(); |
|
| 63 | - } |
|
| 60 | + // Permissions no configured, or not logged in |
|
| 61 | + if ($request->getMethod() === RequestMethodInterface::METHOD_POST) { |
|
| 62 | + throw new HttpAccessDeniedException(); |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - return Registry::responseFactory()->redirect( |
|
| 66 | - LoginPage::class, |
|
| 67 | - ['tree' => $tree->name(), 'url' => (string) $request->getUri()] |
|
| 68 | - ); |
|
| 69 | - } |
|
| 65 | + return Registry::responseFactory()->redirect( |
|
| 66 | + LoginPage::class, |
|
| 67 | + ['tree' => $tree->name(), 'url' => (string) $request->getUri()] |
|
| 68 | + ); |
|
| 69 | + } |
|
| 70 | 70 | } |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | // Permissions are configured |
| 48 | 48 | if (is_numeric($permission_level)) { |
| 49 | 49 | // Logged in with the correct role? |
| 50 | - if (Auth::accessLevel($tree, $user) <= (int) $permission_level) { |
|
| 50 | + if (Auth::accessLevel($tree, $user) <= (int)$permission_level) { |
|
| 51 | 51 | return $handler->handle($request); |
| 52 | 52 | } |
| 53 | 53 | |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | |
| 65 | 65 | return Registry::responseFactory()->redirect( |
| 66 | 66 | LoginPage::class, |
| 67 | - ['tree' => $tree->name(), 'url' => (string) $request->getUri()] |
|
| 67 | + ['tree' => $tree->name(), 'url' => (string)$request->getUri()] |
|
| 68 | 68 | ); |
| 69 | 69 | } |
| 70 | 70 | } |
@@ -23,252 +23,252 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | class TaskSchedule |
| 25 | 25 | { |
| 26 | - private int $id; |
|
| 27 | - private bool $enabled; |
|
| 28 | - private string $task_id; |
|
| 29 | - private CarbonInterface $last_run; |
|
| 30 | - private bool $last_result; |
|
| 31 | - private int $frequency; |
|
| 32 | - private int $nb_occurrences; |
|
| 33 | - private bool $is_running; |
|
| 26 | + private int $id; |
|
| 27 | + private bool $enabled; |
|
| 28 | + private string $task_id; |
|
| 29 | + private CarbonInterface $last_run; |
|
| 30 | + private bool $last_result; |
|
| 31 | + private int $frequency; |
|
| 32 | + private int $nb_occurrences; |
|
| 33 | + private bool $is_running; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Constructor for TaskSchedule |
|
| 37 | - * |
|
| 38 | - * @param int $id Schedule ID |
|
| 39 | - * @param string $task_id Task ID |
|
| 40 | - * @param bool $enabled Is the schedule enabled |
|
| 41 | - * @param CarbonInterface $last_run Last successful run date/time |
|
| 42 | - * @param bool $last_result Result of the last run |
|
| 43 | - * @param int $frequency Schedule frequency in minutes |
|
| 44 | - * @param int $nb_occurrences Number of remaining occurrences to be run |
|
| 45 | - * @param bool $is_running Is the task currently running |
|
| 46 | - */ |
|
| 47 | - public function __construct( |
|
| 48 | - int $id, |
|
| 49 | - string $task_id, |
|
| 50 | - bool $enabled, |
|
| 51 | - CarbonInterface $last_run, |
|
| 52 | - bool $last_result, |
|
| 53 | - int $frequency, |
|
| 54 | - int $nb_occurrences, |
|
| 55 | - bool $is_running |
|
| 56 | - ) { |
|
| 57 | - $this->id = $id; |
|
| 58 | - $this->task_id = $task_id; |
|
| 59 | - $this->enabled = $enabled; |
|
| 60 | - $this->last_run = $last_run; |
|
| 61 | - $this->last_result = $last_result; |
|
| 62 | - $this->frequency = $frequency; |
|
| 63 | - $this->nb_occurrences = $nb_occurrences; |
|
| 64 | - $this->is_running = $is_running; |
|
| 65 | - } |
|
| 35 | + /** |
|
| 36 | + * Constructor for TaskSchedule |
|
| 37 | + * |
|
| 38 | + * @param int $id Schedule ID |
|
| 39 | + * @param string $task_id Task ID |
|
| 40 | + * @param bool $enabled Is the schedule enabled |
|
| 41 | + * @param CarbonInterface $last_run Last successful run date/time |
|
| 42 | + * @param bool $last_result Result of the last run |
|
| 43 | + * @param int $frequency Schedule frequency in minutes |
|
| 44 | + * @param int $nb_occurrences Number of remaining occurrences to be run |
|
| 45 | + * @param bool $is_running Is the task currently running |
|
| 46 | + */ |
|
| 47 | + public function __construct( |
|
| 48 | + int $id, |
|
| 49 | + string $task_id, |
|
| 50 | + bool $enabled, |
|
| 51 | + CarbonInterface $last_run, |
|
| 52 | + bool $last_result, |
|
| 53 | + int $frequency, |
|
| 54 | + int $nb_occurrences, |
|
| 55 | + bool $is_running |
|
| 56 | + ) { |
|
| 57 | + $this->id = $id; |
|
| 58 | + $this->task_id = $task_id; |
|
| 59 | + $this->enabled = $enabled; |
|
| 60 | + $this->last_run = $last_run; |
|
| 61 | + $this->last_result = $last_result; |
|
| 62 | + $this->frequency = $frequency; |
|
| 63 | + $this->nb_occurrences = $nb_occurrences; |
|
| 64 | + $this->is_running = $is_running; |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Get the schedule ID. |
|
| 69 | - * |
|
| 70 | - * @return int |
|
| 71 | - */ |
|
| 72 | - public function id(): int |
|
| 73 | - { |
|
| 74 | - return $this->id; |
|
| 75 | - } |
|
| 67 | + /** |
|
| 68 | + * Get the schedule ID. |
|
| 69 | + * |
|
| 70 | + * @return int |
|
| 71 | + */ |
|
| 72 | + public function id(): int |
|
| 73 | + { |
|
| 74 | + return $this->id; |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Get the task ID. |
|
| 79 | - * |
|
| 80 | - * @return string |
|
| 81 | - */ |
|
| 82 | - public function taskId(): string |
|
| 83 | - { |
|
| 84 | - return $this->task_id; |
|
| 85 | - } |
|
| 77 | + /** |
|
| 78 | + * Get the task ID. |
|
| 79 | + * |
|
| 80 | + * @return string |
|
| 81 | + */ |
|
| 82 | + public function taskId(): string |
|
| 83 | + { |
|
| 84 | + return $this->task_id; |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Returns whether the schedule is enabled |
|
| 89 | - * |
|
| 90 | - * @return bool |
|
| 91 | - */ |
|
| 92 | - public function isEnabled(): bool |
|
| 93 | - { |
|
| 94 | - return $this->enabled; |
|
| 95 | - } |
|
| 87 | + /** |
|
| 88 | + * Returns whether the schedule is enabled |
|
| 89 | + * |
|
| 90 | + * @return bool |
|
| 91 | + */ |
|
| 92 | + public function isEnabled(): bool |
|
| 93 | + { |
|
| 94 | + return $this->enabled; |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Enable the schedule |
|
| 99 | - * |
|
| 100 | - * @return $this |
|
| 101 | - */ |
|
| 102 | - public function enable(): self |
|
| 103 | - { |
|
| 104 | - $this->enabled = true; |
|
| 105 | - return $this; |
|
| 106 | - } |
|
| 97 | + /** |
|
| 98 | + * Enable the schedule |
|
| 99 | + * |
|
| 100 | + * @return $this |
|
| 101 | + */ |
|
| 102 | + public function enable(): self |
|
| 103 | + { |
|
| 104 | + $this->enabled = true; |
|
| 105 | + return $this; |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Disable the schedule |
|
| 110 | - * |
|
| 111 | - * @return $this |
|
| 112 | - */ |
|
| 113 | - public function disable(): self |
|
| 114 | - { |
|
| 115 | - $this->enabled = false; |
|
| 116 | - return $this; |
|
| 117 | - } |
|
| 108 | + /** |
|
| 109 | + * Disable the schedule |
|
| 110 | + * |
|
| 111 | + * @return $this |
|
| 112 | + */ |
|
| 113 | + public function disable(): self |
|
| 114 | + { |
|
| 115 | + $this->enabled = false; |
|
| 116 | + return $this; |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Get the frequency of the schedule |
|
| 121 | - * |
|
| 122 | - * @return int |
|
| 123 | - */ |
|
| 124 | - public function frequency(): int |
|
| 125 | - { |
|
| 126 | - return $this->frequency; |
|
| 127 | - } |
|
| 119 | + /** |
|
| 120 | + * Get the frequency of the schedule |
|
| 121 | + * |
|
| 122 | + * @return int |
|
| 123 | + */ |
|
| 124 | + public function frequency(): int |
|
| 125 | + { |
|
| 126 | + return $this->frequency; |
|
| 127 | + } |
|
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * Set the frequency of the schedule |
|
| 131 | - * |
|
| 132 | - * @param int $frequency |
|
| 133 | - * @return $this |
|
| 134 | - */ |
|
| 135 | - public function setFrequency(int $frequency): self |
|
| 136 | - { |
|
| 137 | - $this->frequency = $frequency; |
|
| 138 | - return $this; |
|
| 139 | - } |
|
| 129 | + /** |
|
| 130 | + * Set the frequency of the schedule |
|
| 131 | + * |
|
| 132 | + * @param int $frequency |
|
| 133 | + * @return $this |
|
| 134 | + */ |
|
| 135 | + public function setFrequency(int $frequency): self |
|
| 136 | + { |
|
| 137 | + $this->frequency = $frequency; |
|
| 138 | + return $this; |
|
| 139 | + } |
|
| 140 | 140 | |
| 141 | - /** |
|
| 142 | - * Get the date/time of the last successful run. |
|
| 143 | - * |
|
| 144 | - * @return CarbonInterface |
|
| 145 | - */ |
|
| 146 | - public function lastRunTime(): CarbonInterface |
|
| 147 | - { |
|
| 148 | - return $this->last_run; |
|
| 149 | - } |
|
| 141 | + /** |
|
| 142 | + * Get the date/time of the last successful run. |
|
| 143 | + * |
|
| 144 | + * @return CarbonInterface |
|
| 145 | + */ |
|
| 146 | + public function lastRunTime(): CarbonInterface |
|
| 147 | + { |
|
| 148 | + return $this->last_run; |
|
| 149 | + } |
|
| 150 | 150 | |
| 151 | - /** |
|
| 152 | - * Set the last successful run date/time |
|
| 153 | - * |
|
| 154 | - * @param CarbonInterface $last_run |
|
| 155 | - * @return $this |
|
| 156 | - */ |
|
| 157 | - public function setLastRunTime(CarbonInterface $last_run): self |
|
| 158 | - { |
|
| 159 | - $this->last_run = $last_run; |
|
| 160 | - return $this; |
|
| 161 | - } |
|
| 151 | + /** |
|
| 152 | + * Set the last successful run date/time |
|
| 153 | + * |
|
| 154 | + * @param CarbonInterface $last_run |
|
| 155 | + * @return $this |
|
| 156 | + */ |
|
| 157 | + public function setLastRunTime(CarbonInterface $last_run): self |
|
| 158 | + { |
|
| 159 | + $this->last_run = $last_run; |
|
| 160 | + return $this; |
|
| 161 | + } |
|
| 162 | 162 | |
| 163 | - /** |
|
| 164 | - * Returns whether the last run was successful |
|
| 165 | - * |
|
| 166 | - * @return bool |
|
| 167 | - */ |
|
| 168 | - public function wasLastRunSuccess(): bool |
|
| 169 | - { |
|
| 170 | - return $this->last_result; |
|
| 171 | - } |
|
| 163 | + /** |
|
| 164 | + * Returns whether the last run was successful |
|
| 165 | + * |
|
| 166 | + * @return bool |
|
| 167 | + */ |
|
| 168 | + public function wasLastRunSuccess(): bool |
|
| 169 | + { |
|
| 170 | + return $this->last_result; |
|
| 171 | + } |
|
| 172 | 172 | |
| 173 | - /** |
|
| 174 | - * Set the last run result |
|
| 175 | - * |
|
| 176 | - * @param bool $last_result |
|
| 177 | - * @return $this |
|
| 178 | - */ |
|
| 179 | - public function setLastResult(bool $last_result): self |
|
| 180 | - { |
|
| 181 | - $this->last_result = $last_result; |
|
| 182 | - return $this; |
|
| 183 | - } |
|
| 173 | + /** |
|
| 174 | + * Set the last run result |
|
| 175 | + * |
|
| 176 | + * @param bool $last_result |
|
| 177 | + * @return $this |
|
| 178 | + */ |
|
| 179 | + public function setLastResult(bool $last_result): self |
|
| 180 | + { |
|
| 181 | + $this->last_result = $last_result; |
|
| 182 | + return $this; |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | - /** |
|
| 186 | - * Get the number of remaining of occurrences of task runs. |
|
| 187 | - * Returns 0 if the tasks must be run indefinitely. |
|
| 188 | - * |
|
| 189 | - * @return int |
|
| 190 | - */ |
|
| 191 | - public function remainingOccurrences(): int |
|
| 192 | - { |
|
| 193 | - return $this->nb_occurrences; |
|
| 194 | - } |
|
| 185 | + /** |
|
| 186 | + * Get the number of remaining of occurrences of task runs. |
|
| 187 | + * Returns 0 if the tasks must be run indefinitely. |
|
| 188 | + * |
|
| 189 | + * @return int |
|
| 190 | + */ |
|
| 191 | + public function remainingOccurrences(): int |
|
| 192 | + { |
|
| 193 | + return $this->nb_occurrences; |
|
| 194 | + } |
|
| 195 | 195 | |
| 196 | - /** |
|
| 197 | - * Decrements the number of remaining occurrences by 1. |
|
| 198 | - * The task will be disabled when the number reaches 0. |
|
| 199 | - * |
|
| 200 | - * @return $this |
|
| 201 | - */ |
|
| 202 | - public function decrementRemainingOccurrences(): self |
|
| 203 | - { |
|
| 204 | - if ($this->nb_occurrences > 0) { |
|
| 205 | - $this->nb_occurrences--; |
|
| 206 | - if ($this->nb_occurrences === 0) { |
|
| 207 | - $this->disable(); |
|
| 208 | - } |
|
| 209 | - } |
|
| 210 | - return $this; |
|
| 211 | - } |
|
| 196 | + /** |
|
| 197 | + * Decrements the number of remaining occurrences by 1. |
|
| 198 | + * The task will be disabled when the number reaches 0. |
|
| 199 | + * |
|
| 200 | + * @return $this |
|
| 201 | + */ |
|
| 202 | + public function decrementRemainingOccurrences(): self |
|
| 203 | + { |
|
| 204 | + if ($this->nb_occurrences > 0) { |
|
| 205 | + $this->nb_occurrences--; |
|
| 206 | + if ($this->nb_occurrences === 0) { |
|
| 207 | + $this->disable(); |
|
| 208 | + } |
|
| 209 | + } |
|
| 210 | + return $this; |
|
| 211 | + } |
|
| 212 | 212 | |
| 213 | - /** |
|
| 214 | - * Set the number of remaining occurrences of task runs. |
|
| 215 | - * |
|
| 216 | - * @param int $nb_occurrences |
|
| 217 | - * @return $this |
|
| 218 | - */ |
|
| 219 | - public function setRemainingOccurrences(int $nb_occurrences): self |
|
| 220 | - { |
|
| 221 | - $this->nb_occurrences = $nb_occurrences; |
|
| 222 | - return $this; |
|
| 223 | - } |
|
| 213 | + /** |
|
| 214 | + * Set the number of remaining occurrences of task runs. |
|
| 215 | + * |
|
| 216 | + * @param int $nb_occurrences |
|
| 217 | + * @return $this |
|
| 218 | + */ |
|
| 219 | + public function setRemainingOccurrences(int $nb_occurrences): self |
|
| 220 | + { |
|
| 221 | + $this->nb_occurrences = $nb_occurrences; |
|
| 222 | + return $this; |
|
| 223 | + } |
|
| 224 | 224 | |
| 225 | - /** |
|
| 226 | - * Returns whether the task is running |
|
| 227 | - * @return bool |
|
| 228 | - */ |
|
| 229 | - public function isRunning(): bool |
|
| 230 | - { |
|
| 231 | - return $this->is_running; |
|
| 232 | - } |
|
| 225 | + /** |
|
| 226 | + * Returns whether the task is running |
|
| 227 | + * @return bool |
|
| 228 | + */ |
|
| 229 | + public function isRunning(): bool |
|
| 230 | + { |
|
| 231 | + return $this->is_running; |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Informs the schedule that the task is going to run |
|
| 236 | - * |
|
| 237 | - * @return $this |
|
| 238 | - */ |
|
| 239 | - public function startRunning(): self |
|
| 240 | - { |
|
| 241 | - $this->is_running = true; |
|
| 242 | - return $this; |
|
| 243 | - } |
|
| 234 | + /** |
|
| 235 | + * Informs the schedule that the task is going to run |
|
| 236 | + * |
|
| 237 | + * @return $this |
|
| 238 | + */ |
|
| 239 | + public function startRunning(): self |
|
| 240 | + { |
|
| 241 | + $this->is_running = true; |
|
| 242 | + return $this; |
|
| 243 | + } |
|
| 244 | 244 | |
| 245 | - /** |
|
| 246 | - * Informs the schedule that the task has stopped running. |
|
| 247 | - * @return $this |
|
| 248 | - */ |
|
| 249 | - public function stopRunning(): self |
|
| 250 | - { |
|
| 251 | - $this->is_running = false; |
|
| 252 | - return $this; |
|
| 253 | - } |
|
| 245 | + /** |
|
| 246 | + * Informs the schedule that the task has stopped running. |
|
| 247 | + * @return $this |
|
| 248 | + */ |
|
| 249 | + public function stopRunning(): self |
|
| 250 | + { |
|
| 251 | + $this->is_running = false; |
|
| 252 | + return $this; |
|
| 253 | + } |
|
| 254 | 254 | |
| 255 | - /** |
|
| 256 | - * Returns the schedule details as an associate array |
|
| 257 | - * |
|
| 258 | - * @phpcs:ignore Generic.Files.LineLength.TooLong |
|
| 259 | - * @return array{id: int, task_id: string, enabled: bool, last_run: CarbonInterface, last_result: bool, frequency: int, nb_occurrences: int, is_running: bool} |
|
| 260 | - */ |
|
| 261 | - public function toArray(): array |
|
| 262 | - { |
|
| 263 | - return [ |
|
| 264 | - 'id' => $this->id, |
|
| 265 | - 'task_id' => $this->task_id, |
|
| 266 | - 'enabled' => $this->enabled, |
|
| 267 | - 'last_run' => $this->last_run, |
|
| 268 | - 'last_result' => $this->last_result, |
|
| 269 | - 'frequency' => $this->frequency, |
|
| 270 | - 'nb_occurrences' => $this->nb_occurrences, |
|
| 271 | - 'is_running' => $this->is_running |
|
| 272 | - ]; |
|
| 273 | - } |
|
| 255 | + /** |
|
| 256 | + * Returns the schedule details as an associate array |
|
| 257 | + * |
|
| 258 | + * @phpcs:ignore Generic.Files.LineLength.TooLong |
|
| 259 | + * @return array{id: int, task_id: string, enabled: bool, last_run: CarbonInterface, last_result: bool, frequency: int, nb_occurrences: int, is_running: bool} |
|
| 260 | + */ |
|
| 261 | + public function toArray(): array |
|
| 262 | + { |
|
| 263 | + return [ |
|
| 264 | + 'id' => $this->id, |
|
| 265 | + 'task_id' => $this->task_id, |
|
| 266 | + 'enabled' => $this->enabled, |
|
| 267 | + 'last_run' => $this->last_run, |
|
| 268 | + 'last_result' => $this->last_result, |
|
| 269 | + 'frequency' => $this->frequency, |
|
| 270 | + 'nb_occurrences' => $this->nb_occurrences, |
|
| 271 | + 'is_running' => $this->is_running |
|
| 272 | + ]; |
|
| 273 | + } |
|
| 274 | 274 | } |
@@ -28,39 +28,39 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | class SosaComputeModal implements RequestHandlerInterface |
| 30 | 30 | { |
| 31 | - /** |
|
| 32 | - * @var SosaModule|null $module |
|
| 33 | - */ |
|
| 34 | - private $module; |
|
| 31 | + /** |
|
| 32 | + * @var SosaModule|null $module |
|
| 33 | + */ |
|
| 34 | + private $module; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Constructor for SosaComputeModal Request Handler |
|
| 38 | - * |
|
| 39 | - * @param ModuleService $module_service |
|
| 40 | - */ |
|
| 41 | - public function __construct(ModuleService $module_service) |
|
| 42 | - { |
|
| 43 | - $this->module = $module_service->findByInterface(SosaModule::class)->first(); |
|
| 44 | - } |
|
| 36 | + /** |
|
| 37 | + * Constructor for SosaComputeModal Request Handler |
|
| 38 | + * |
|
| 39 | + * @param ModuleService $module_service |
|
| 40 | + */ |
|
| 41 | + public function __construct(ModuleService $module_service) |
|
| 42 | + { |
|
| 43 | + $this->module = $module_service->findByInterface(SosaModule::class)->first(); |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * {@inheritDoc} |
|
| 48 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 49 | - */ |
|
| 50 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 51 | - { |
|
| 52 | - if ($this->module === null) { |
|
| 53 | - return Registry::responseFactory()->response(view('modals/error', [ |
|
| 54 | - 'title' => I18N::translate('Error'), |
|
| 55 | - 'error' => I18N::translate('The attached module could not be found.') |
|
| 56 | - ])); |
|
| 57 | - } |
|
| 46 | + /** |
|
| 47 | + * {@inheritDoc} |
|
| 48 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 49 | + */ |
|
| 50 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 51 | + { |
|
| 52 | + if ($this->module === null) { |
|
| 53 | + return Registry::responseFactory()->response(view('modals/error', [ |
|
| 54 | + 'title' => I18N::translate('Error'), |
|
| 55 | + 'error' => I18N::translate('The attached module could not be found.') |
|
| 56 | + ])); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - $tree = Validator::attributes($request)->tree(); |
|
| 59 | + $tree = Validator::attributes($request)->tree(); |
|
| 60 | 60 | |
| 61 | - return Registry::responseFactory()->response(view($this->module->name() . '::modals/sosa-compute', [ |
|
| 62 | - 'tree' => $tree, |
|
| 63 | - 'xref' => Validator::attributes($request)->isXref()->string('xref', '') |
|
| 64 | - ])); |
|
| 65 | - } |
|
| 61 | + return Registry::responseFactory()->response(view($this->module->name() . '::modals/sosa-compute', [ |
|
| 62 | + 'tree' => $tree, |
|
| 63 | + 'xref' => Validator::attributes($request)->isXref()->string('xref', '') |
|
| 64 | + ])); |
|
| 65 | + } |
|
| 66 | 66 | } |
@@ -58,7 +58,7 @@ |
||
| 58 | 58 | |
| 59 | 59 | $tree = Validator::attributes($request)->tree(); |
| 60 | 60 | |
| 61 | - return Registry::responseFactory()->response(view($this->module->name() . '::modals/sosa-compute', [ |
|
| 61 | + return Registry::responseFactory()->response(view($this->module->name().'::modals/sosa-compute', [ |
|
| 62 | 62 | 'tree' => $tree, |
| 63 | 63 | 'xref' => Validator::attributes($request)->isXref()->string('xref', '') |
| 64 | 64 | ])); |
@@ -35,79 +35,79 @@ |
||
| 35 | 35 | */ |
| 36 | 36 | class AncestorsListIndividual implements RequestHandlerInterface |
| 37 | 37 | { |
| 38 | - use ViewResponseTrait; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var SosaModule|null $module |
|
| 42 | - */ |
|
| 43 | - private $module; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var SosaRecordsService $sosa_record_service |
|
| 47 | - */ |
|
| 48 | - private $sosa_record_service; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * Constructor for AncestorsListIndividual Request Handler |
|
| 52 | - * |
|
| 53 | - * @param ModuleService $module_service |
|
| 54 | - * @param SosaRecordsService $sosa_record_service |
|
| 55 | - */ |
|
| 56 | - public function __construct( |
|
| 57 | - ModuleService $module_service, |
|
| 58 | - SosaRecordsService $sosa_record_service |
|
| 59 | - ) { |
|
| 60 | - $this->module = $module_service->findByInterface(SosaModule::class)->first(); |
|
| 61 | - $this->sosa_record_service = $sosa_record_service; |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * {@inheritDoc} |
|
| 66 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 67 | - */ |
|
| 68 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 69 | - { |
|
| 70 | - $this->layout = 'layouts/ajax'; |
|
| 71 | - |
|
| 72 | - if ($this->module === null) { |
|
| 73 | - throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - $tree = Validator::attributes($request)->tree(); |
|
| 77 | - $user = Auth::check() ? Validator::attributes($request)->user() : new DefaultUser(); |
|
| 78 | - $current_gen = Validator::attributes($request)->integer('gen', 0); |
|
| 79 | - |
|
| 80 | - if ($current_gen <= 0) { |
|
| 81 | - return Registry::responseFactory()->response( |
|
| 82 | - 'Invalid generation', |
|
| 83 | - StatusCodeInterface::STATUS_UNPROCESSABLE_ENTITY |
|
| 84 | - ); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - $list_ancestors = $this->sosa_record_service->listAncestorsAtGeneration($tree, $user, $current_gen); |
|
| 88 | - $nb_ancestors_all = $list_ancestors->count(); |
|
| 89 | - |
|
| 90 | - /** @var \Illuminate\Support\Collection<int, \Fisharebest\Webtrees\Individual> $list_ancestors */ |
|
| 91 | - $list_ancestors = $list_ancestors |
|
| 92 | - ->filter(function (stdClass $value) use ($tree): bool { |
|
| 93 | - $indi = Registry::individualFactory()->make($value->majs_i_id, $tree); |
|
| 94 | - return $indi !== null && $indi->canShowName(); |
|
| 95 | - }) |
|
| 96 | - ->mapWithKeys(function (stdClass $value) use ($tree): array { |
|
| 97 | - $indi = Registry::individualFactory()->make($value->majs_i_id, $tree); |
|
| 98 | - return [(int) $value->majs_sosa => $indi]; |
|
| 99 | - }); |
|
| 100 | - |
|
| 101 | - $nb_ancestors_shown = $list_ancestors->count(); |
|
| 102 | - |
|
| 103 | - return $this->viewResponse($this->module->name() . '::list-ancestors-indi-tab', [ |
|
| 104 | - 'module_name' => $this->module->name(), |
|
| 105 | - 'title' => I18N::translate('Sosa Ancestors'), |
|
| 106 | - 'tree' => $tree, |
|
| 107 | - 'list_ancestors' => $list_ancestors, |
|
| 108 | - 'nb_ancestors_all' => $nb_ancestors_all, |
|
| 109 | - 'nb_ancestors_theor' => pow(2, $current_gen - 1), |
|
| 110 | - 'nb_ancestors_shown' => $nb_ancestors_shown |
|
| 111 | - ]); |
|
| 112 | - } |
|
| 38 | + use ViewResponseTrait; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var SosaModule|null $module |
|
| 42 | + */ |
|
| 43 | + private $module; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var SosaRecordsService $sosa_record_service |
|
| 47 | + */ |
|
| 48 | + private $sosa_record_service; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * Constructor for AncestorsListIndividual Request Handler |
|
| 52 | + * |
|
| 53 | + * @param ModuleService $module_service |
|
| 54 | + * @param SosaRecordsService $sosa_record_service |
|
| 55 | + */ |
|
| 56 | + public function __construct( |
|
| 57 | + ModuleService $module_service, |
|
| 58 | + SosaRecordsService $sosa_record_service |
|
| 59 | + ) { |
|
| 60 | + $this->module = $module_service->findByInterface(SosaModule::class)->first(); |
|
| 61 | + $this->sosa_record_service = $sosa_record_service; |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * {@inheritDoc} |
|
| 66 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 67 | + */ |
|
| 68 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 69 | + { |
|
| 70 | + $this->layout = 'layouts/ajax'; |
|
| 71 | + |
|
| 72 | + if ($this->module === null) { |
|
| 73 | + throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + $tree = Validator::attributes($request)->tree(); |
|
| 77 | + $user = Auth::check() ? Validator::attributes($request)->user() : new DefaultUser(); |
|
| 78 | + $current_gen = Validator::attributes($request)->integer('gen', 0); |
|
| 79 | + |
|
| 80 | + if ($current_gen <= 0) { |
|
| 81 | + return Registry::responseFactory()->response( |
|
| 82 | + 'Invalid generation', |
|
| 83 | + StatusCodeInterface::STATUS_UNPROCESSABLE_ENTITY |
|
| 84 | + ); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + $list_ancestors = $this->sosa_record_service->listAncestorsAtGeneration($tree, $user, $current_gen); |
|
| 88 | + $nb_ancestors_all = $list_ancestors->count(); |
|
| 89 | + |
|
| 90 | + /** @var \Illuminate\Support\Collection<int, \Fisharebest\Webtrees\Individual> $list_ancestors */ |
|
| 91 | + $list_ancestors = $list_ancestors |
|
| 92 | + ->filter(function (stdClass $value) use ($tree): bool { |
|
| 93 | + $indi = Registry::individualFactory()->make($value->majs_i_id, $tree); |
|
| 94 | + return $indi !== null && $indi->canShowName(); |
|
| 95 | + }) |
|
| 96 | + ->mapWithKeys(function (stdClass $value) use ($tree): array { |
|
| 97 | + $indi = Registry::individualFactory()->make($value->majs_i_id, $tree); |
|
| 98 | + return [(int) $value->majs_sosa => $indi]; |
|
| 99 | + }); |
|
| 100 | + |
|
| 101 | + $nb_ancestors_shown = $list_ancestors->count(); |
|
| 102 | + |
|
| 103 | + return $this->viewResponse($this->module->name() . '::list-ancestors-indi-tab', [ |
|
| 104 | + 'module_name' => $this->module->name(), |
|
| 105 | + 'title' => I18N::translate('Sosa Ancestors'), |
|
| 106 | + 'tree' => $tree, |
|
| 107 | + 'list_ancestors' => $list_ancestors, |
|
| 108 | + 'nb_ancestors_all' => $nb_ancestors_all, |
|
| 109 | + 'nb_ancestors_theor' => pow(2, $current_gen - 1), |
|
| 110 | + 'nb_ancestors_shown' => $nb_ancestors_shown |
|
| 111 | + ]); |
|
| 112 | + } |
|
| 113 | 113 | } |
@@ -89,18 +89,18 @@ |
||
| 89 | 89 | |
| 90 | 90 | /** @var \Illuminate\Support\Collection<int, \Fisharebest\Webtrees\Individual> $list_ancestors */ |
| 91 | 91 | $list_ancestors = $list_ancestors |
| 92 | - ->filter(function (stdClass $value) use ($tree): bool { |
|
| 92 | + ->filter(function(stdClass $value) use ($tree): bool { |
|
| 93 | 93 | $indi = Registry::individualFactory()->make($value->majs_i_id, $tree); |
| 94 | 94 | return $indi !== null && $indi->canShowName(); |
| 95 | 95 | }) |
| 96 | - ->mapWithKeys(function (stdClass $value) use ($tree): array { |
|
| 96 | + ->mapWithKeys(function(stdClass $value) use ($tree): array { |
|
| 97 | 97 | $indi = Registry::individualFactory()->make($value->majs_i_id, $tree); |
| 98 | - return [(int) $value->majs_sosa => $indi]; |
|
| 98 | + return [(int)$value->majs_sosa => $indi]; |
|
| 99 | 99 | }); |
| 100 | 100 | |
| 101 | 101 | $nb_ancestors_shown = $list_ancestors->count(); |
| 102 | 102 | |
| 103 | - return $this->viewResponse($this->module->name() . '::list-ancestors-indi-tab', [ |
|
| 103 | + return $this->viewResponse($this->module->name().'::list-ancestors-indi-tab', [ |
|
| 104 | 104 | 'module_name' => $this->module->name(), |
| 105 | 105 | 'title' => I18N::translate('Sosa Ancestors'), |
| 106 | 106 | 'tree' => $tree, |
@@ -35,78 +35,78 @@ |
||
| 35 | 35 | */ |
| 36 | 36 | class AncestorsListFamily implements RequestHandlerInterface |
| 37 | 37 | { |
| 38 | - use ViewResponseTrait; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var SosaModule|null $module |
|
| 42 | - */ |
|
| 43 | - private $module; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var SosaRecordsService $sosa_record_service |
|
| 47 | - */ |
|
| 48 | - private $sosa_record_service; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * Constructor for AncestorsListFamily Request Handler |
|
| 52 | - * |
|
| 53 | - * @param ModuleService $module_service |
|
| 54 | - * @param SosaRecordsService $sosa_record_service |
|
| 55 | - */ |
|
| 56 | - public function __construct( |
|
| 57 | - ModuleService $module_service, |
|
| 58 | - SosaRecordsService $sosa_record_service |
|
| 59 | - ) { |
|
| 60 | - $this->module = $module_service->findByInterface(SosaModule::class)->first(); |
|
| 61 | - $this->sosa_record_service = $sosa_record_service; |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * {@inheritDoc} |
|
| 66 | - * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 67 | - */ |
|
| 68 | - public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 69 | - { |
|
| 70 | - $this->layout = 'layouts/ajax'; |
|
| 71 | - |
|
| 72 | - if ($this->module === null) { |
|
| 73 | - throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - $tree = Validator::attributes($request)->tree(); |
|
| 77 | - $user = Auth::check() ? Validator::attributes($request)->user() : new DefaultUser(); |
|
| 78 | - $current_gen = Validator::attributes($request)->integer('gen', 0); |
|
| 79 | - |
|
| 80 | - if ($current_gen <= 0) { |
|
| 81 | - return Registry::responseFactory()->response( |
|
| 82 | - 'Invalid generation', |
|
| 83 | - StatusCodeInterface::STATUS_UNPROCESSABLE_ENTITY |
|
| 84 | - ); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - $list_families = $this->sosa_record_service->listAncestorFamiliesAtGeneration($tree, $user, $current_gen); |
|
| 88 | - $nb_families_all = $list_families->count(); |
|
| 89 | - |
|
| 90 | - /** @var \Illuminate\Support\Collection<int, \Fisharebest\Webtrees\Family> $list_families */ |
|
| 91 | - $list_families = $list_families |
|
| 92 | - ->filter(function (stdClass $value) use ($tree): bool { |
|
| 93 | - $fam = Registry::familyFactory()->make($value->f_id, $tree); |
|
| 94 | - return $fam !== null && $fam->canShow(); |
|
| 95 | - }) |
|
| 96 | - ->mapWithKeys(function (stdClass $value) use ($tree): array { |
|
| 97 | - $fam = Registry::familyFactory()->make($value->f_id, $tree); |
|
| 98 | - return [(int) $value->majs_sosa => $fam]; |
|
| 99 | - }); |
|
| 100 | - |
|
| 101 | - $nb_families_shown = $list_families->count(); |
|
| 102 | - |
|
| 103 | - return $this->viewResponse($this->module->name() . '::list-ancestors-fam-tab', [ |
|
| 104 | - 'module_name' => $this->module->name(), |
|
| 105 | - 'title' => I18N::translate('Sosa Ancestors'), |
|
| 106 | - 'tree' => $tree, |
|
| 107 | - 'list_families' => $list_families, |
|
| 108 | - 'nb_families_all' => $nb_families_all, |
|
| 109 | - 'nb_families_shown' => $nb_families_shown |
|
| 110 | - ]); |
|
| 111 | - } |
|
| 38 | + use ViewResponseTrait; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var SosaModule|null $module |
|
| 42 | + */ |
|
| 43 | + private $module; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var SosaRecordsService $sosa_record_service |
|
| 47 | + */ |
|
| 48 | + private $sosa_record_service; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * Constructor for AncestorsListFamily Request Handler |
|
| 52 | + * |
|
| 53 | + * @param ModuleService $module_service |
|
| 54 | + * @param SosaRecordsService $sosa_record_service |
|
| 55 | + */ |
|
| 56 | + public function __construct( |
|
| 57 | + ModuleService $module_service, |
|
| 58 | + SosaRecordsService $sosa_record_service |
|
| 59 | + ) { |
|
| 60 | + $this->module = $module_service->findByInterface(SosaModule::class)->first(); |
|
| 61 | + $this->sosa_record_service = $sosa_record_service; |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * {@inheritDoc} |
|
| 66 | + * @see \Psr\Http\Server\RequestHandlerInterface::handle() |
|
| 67 | + */ |
|
| 68 | + public function handle(ServerRequestInterface $request): ResponseInterface |
|
| 69 | + { |
|
| 70 | + $this->layout = 'layouts/ajax'; |
|
| 71 | + |
|
| 72 | + if ($this->module === null) { |
|
| 73 | + throw new HttpNotFoundException(I18N::translate('The attached module could not be found.')); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + $tree = Validator::attributes($request)->tree(); |
|
| 77 | + $user = Auth::check() ? Validator::attributes($request)->user() : new DefaultUser(); |
|
| 78 | + $current_gen = Validator::attributes($request)->integer('gen', 0); |
|
| 79 | + |
|
| 80 | + if ($current_gen <= 0) { |
|
| 81 | + return Registry::responseFactory()->response( |
|
| 82 | + 'Invalid generation', |
|
| 83 | + StatusCodeInterface::STATUS_UNPROCESSABLE_ENTITY |
|
| 84 | + ); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + $list_families = $this->sosa_record_service->listAncestorFamiliesAtGeneration($tree, $user, $current_gen); |
|
| 88 | + $nb_families_all = $list_families->count(); |
|
| 89 | + |
|
| 90 | + /** @var \Illuminate\Support\Collection<int, \Fisharebest\Webtrees\Family> $list_families */ |
|
| 91 | + $list_families = $list_families |
|
| 92 | + ->filter(function (stdClass $value) use ($tree): bool { |
|
| 93 | + $fam = Registry::familyFactory()->make($value->f_id, $tree); |
|
| 94 | + return $fam !== null && $fam->canShow(); |
|
| 95 | + }) |
|
| 96 | + ->mapWithKeys(function (stdClass $value) use ($tree): array { |
|
| 97 | + $fam = Registry::familyFactory()->make($value->f_id, $tree); |
|
| 98 | + return [(int) $value->majs_sosa => $fam]; |
|
| 99 | + }); |
|
| 100 | + |
|
| 101 | + $nb_families_shown = $list_families->count(); |
|
| 102 | + |
|
| 103 | + return $this->viewResponse($this->module->name() . '::list-ancestors-fam-tab', [ |
|
| 104 | + 'module_name' => $this->module->name(), |
|
| 105 | + 'title' => I18N::translate('Sosa Ancestors'), |
|
| 106 | + 'tree' => $tree, |
|
| 107 | + 'list_families' => $list_families, |
|
| 108 | + 'nb_families_all' => $nb_families_all, |
|
| 109 | + 'nb_families_shown' => $nb_families_shown |
|
| 110 | + ]); |
|
| 111 | + } |
|
| 112 | 112 | } |
@@ -89,18 +89,18 @@ |
||
| 89 | 89 | |
| 90 | 90 | /** @var \Illuminate\Support\Collection<int, \Fisharebest\Webtrees\Family> $list_families */ |
| 91 | 91 | $list_families = $list_families |
| 92 | - ->filter(function (stdClass $value) use ($tree): bool { |
|
| 92 | + ->filter(function(stdClass $value) use ($tree): bool { |
|
| 93 | 93 | $fam = Registry::familyFactory()->make($value->f_id, $tree); |
| 94 | 94 | return $fam !== null && $fam->canShow(); |
| 95 | 95 | }) |
| 96 | - ->mapWithKeys(function (stdClass $value) use ($tree): array { |
|
| 96 | + ->mapWithKeys(function(stdClass $value) use ($tree): array { |
|
| 97 | 97 | $fam = Registry::familyFactory()->make($value->f_id, $tree); |
| 98 | - return [(int) $value->majs_sosa => $fam]; |
|
| 98 | + return [(int)$value->majs_sosa => $fam]; |
|
| 99 | 99 | }); |
| 100 | 100 | |
| 101 | 101 | $nb_families_shown = $list_families->count(); |
| 102 | 102 | |
| 103 | - return $this->viewResponse($this->module->name() . '::list-ancestors-fam-tab', [ |
|
| 103 | + return $this->viewResponse($this->module->name().'::list-ancestors-fam-tab', [ |
|
| 104 | 104 | 'module_name' => $this->module->name(), |
| 105 | 105 | 'title' => I18N::translate('Sosa Ancestors'), |
| 106 | 106 | 'tree' => $tree, |