extensions_enabled; Minz_ExtensionManager::enableByList($ext_list, 'user'); return $username; } function accessRights(): void { echo 'ℹ️ Remember to re-apply the appropriate access rights, such as:', "\t", 'sudo cli/access-permissions.sh', "\n"; } /** @return never */ function done(bool $ok = true) { if (!$ok) { fwrite(STDERR, (empty($_SERVER['argv'][0]) ? 'Process' : basename($_SERVER['argv'][0])) . ' failed!' . "\n"); } exit($ok ? 0 : 1); } function performRequirementCheck(string $databaseType): void { $requirements = checkRequirements($databaseType); if ($requirements['all'] !== 'ok') { $message = 'FreshRSS failed requirements:' . "\n"; foreach ($requirements as $requirement => $check) { if ($check !== 'ok' && !in_array($requirement, ['all', 'pdo', 'message'], true)) { $message .= '• ' . $requirement . "\n"; } } if (!empty($requirements['message']) && $requirements['message'] !== 'ok') { $message .= '• ' . $requirements['message'] . "\n"; } fail($message); } } /** * Parses parameters used with FreshRSS' CLI commands. * @param array{'valid':array,'deprecated':array} $parameters An array of 'valid': An * array of parameters as keys and their respective getopt() notations as values. 'deprecated' An array with * replacement parameters as keys and their respective deprecated parameters as values. * @return array{'valid':array,'invalid':array} An array of 'valid': an array of all * known parameters used and their respective options and 'invalid': an array of all unknown parameters used. */ function parseCliParams(array $parameters): array { global $argv; $cliParams = []; foreach ($parameters['valid'] as $param => $getopt_val) { $cliParams[] = $param . $getopt_val; } foreach ($parameters['deprecated'] as $param => $deprecatedParam) { $cliParams[] = $deprecatedParam . $parameters['valid'][$param]; } $opts = getopt('', $cliParams); /** @var array $valid */ $valid = is_array($opts) ? $opts : []; array_walk($valid, static fn(&$option) => $option = $option === false ? true : $option); if (checkforDeprecatedParameterUse(array_keys($valid), $parameters['deprecated'])) { $valid = updateDeprecatedParameters($valid, $parameters['deprecated']); } $invalid = findInvalidOptions( $argv, array_merge(array_keys($parameters['valid']), array_values($parameters['deprecated'])) ); return [ 'valid' => $valid, 'invalid' => $invalid ]; } /** * @param array $options * @return array */ function getLongOptions(array $options, string $regex): array { $longOptions = array_filter($options, static function (string $a) use ($regex) { return preg_match($regex, $a) === 1; }); return array_map(static function (string $a) use ($regex) { return preg_replace($regex, '', $a) ?? ''; }, $longOptions); } /** * @param array $input * @param array $params */ function validateOptions(array $input, array $params): bool { $sanitizeInput = getLongOptions($input, REGEX_INPUT_OPTIONS); $sanitizeParams = getLongOptions($params, REGEX_PARAM_OPTIONS); $unknownOptions = array_diff($sanitizeInput, $sanitizeParams); if (0 === count($unknownOptions)) { return true; } fwrite(STDERR, sprintf("FreshRSS error: unknown options: %s\n", implode (', ', $unknownOptions))); return false; } /** * Checks for use of unknown parameters with FreshRSS' CLI commands. * @param array $input An array of parameters to check for validity. * @param array $params An array of valid parameters to check against. * @return array Returns an array of all unknown parameters found. */ function findInvalidOptions(array $input, array $params): array { $sanitizeInput = getLongOptions($input, REGEX_INPUT_OPTIONS); $unknownOptions = array_diff($sanitizeInput, $params); if (0 === count($unknownOptions)) { return []; } fwrite(STDERR, sprintf("FreshRSS error: unknown options: %s\n", implode (', ', $unknownOptions))); return $unknownOptions; } /** * Checks for use of deprecated parameters with FreshRSS' CLI commands. * @param array $options User inputs to check for deprecated parameter use. * @param array $params An array with replacement parameters as keys and their respective deprecated * parameters as values. * @return bool Returns TRUE and generates a deprecation warning if deprecated parameters * have been used, FALSE otherwise. */ function checkforDeprecatedParameterUse(array $options, array $params): bool { $deprecatedOptions = array_intersect($options, $params); $replacements = array_map(static fn($option) => array_search($option, $params, true), $deprecatedOptions); if (0 === count($deprecatedOptions)) { return false; } fwrite(STDERR, "FreshRSS deprecation warning: the CLI option(s): " . implode(', ', $deprecatedOptions) . " are deprecated and will be removed in a future release. Use: " . implode(', ', $replacements) . " instead\n"); return true; } /** * Switches all used deprecated parameters to their replacements if they have one. * * @template T * * @param array $options User inputs. * @param array $params An array with replacement parameters as keys and their respective deprecated * parameters as values. * @return array Returns $options with deprications replaced. */ function updateDeprecatedParameters(array $options, array $params): array { $updatedOptions = []; foreach ($options as $param => $option) { $replacement = array_search($param, $params, true); if (is_string($replacement)) { $updatedOptions[$replacement] = $option; } else { $updatedOptions[$param] = $option; } } return $updatedOptions; }