_cli.php 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. <?php
  2. if (php_sapi_name() !== 'cli') {
  3. die('FreshRSS error: This PHP script may only be invoked from command line!');
  4. }
  5. const EXIT_CODE_ALREADY_EXISTS = 3;
  6. const REGEX_INPUT_OPTIONS = '/^--/';
  7. const REGEX_PARAM_OPTIONS = '/:*$/';
  8. require(__DIR__ . '/../constants.php');
  9. require(LIB_PATH . '/lib_rss.php'); //Includes class autoloader
  10. require(LIB_PATH . '/lib_install.php');
  11. Minz_Session::init('FreshRSS', true);
  12. FreshRSS_Context::initSystem();
  13. Minz_ExtensionManager::init();
  14. Minz_Translate::init('en');
  15. FreshRSS_Context::$isCli = true;
  16. /** @return never */
  17. function fail(string $message, int $exitCode = 1) {
  18. fwrite(STDERR, $message . "\n");
  19. die($exitCode);
  20. }
  21. function cliInitUser(string $username): string {
  22. if (!FreshRSS_user_Controller::checkUsername($username)) {
  23. fail('FreshRSS error: invalid username: ' . $username . "\n");
  24. }
  25. if (!FreshRSS_user_Controller::userExists($username)) {
  26. fail('FreshRSS error: user not found: ' . $username . "\n");
  27. }
  28. if (!FreshRSS_Context::initUser($username)) {
  29. fail('FreshRSS error: invalid configuration for user: ' . $username . "\n");
  30. }
  31. $ext_list = FreshRSS_Context::$user_conf->extensions_enabled;
  32. Minz_ExtensionManager::enableByList($ext_list, 'user');
  33. return $username;
  34. }
  35. function accessRights(): void {
  36. echo 'ℹ️ Remember to re-apply the appropriate access rights, such as:',
  37. "\t", 'sudo cli/access-permissions.sh', "\n";
  38. }
  39. /** @return never */
  40. function done(bool $ok = true) {
  41. if (!$ok) {
  42. fwrite(STDERR, (empty($_SERVER['argv'][0]) ? 'Process' : basename($_SERVER['argv'][0])) . ' failed!' . "\n");
  43. }
  44. exit($ok ? 0 : 1);
  45. }
  46. function performRequirementCheck(string $databaseType): void {
  47. $requirements = checkRequirements($databaseType);
  48. if ($requirements['all'] !== 'ok') {
  49. $message = 'FreshRSS failed requirements:' . "\n";
  50. foreach ($requirements as $requirement => $check) {
  51. if ($check !== 'ok' && !in_array($requirement, ['all', 'pdo', 'message'], true)) {
  52. $message .= '• ' . $requirement . "\n";
  53. }
  54. }
  55. if (!empty($requirements['message']) && $requirements['message'] !== 'ok') {
  56. $message .= '• ' . $requirements['message'] . "\n";
  57. }
  58. fail($message);
  59. }
  60. }
  61. /**
  62. * @param array<string> $options
  63. * @return array<string>
  64. */
  65. function getLongOptions(array $options, string $regex): array {
  66. $longOptions = array_filter($options, static function (string $a) use ($regex) {
  67. return preg_match($regex, $a);
  68. });
  69. return array_map(static function (string $a) use ($regex) {
  70. return preg_replace($regex, '', $a);
  71. }, $longOptions);
  72. }
  73. /**
  74. * @param array<string> $input
  75. * @param array<string> $params
  76. */
  77. function validateOptions(array $input, array $params): bool {
  78. $sanitizeInput = getLongOptions($input, REGEX_INPUT_OPTIONS);
  79. $sanitizeParams = getLongOptions($params, REGEX_PARAM_OPTIONS);
  80. $unknownOptions = array_diff($sanitizeInput, $sanitizeParams);
  81. if (0 === count($unknownOptions)) {
  82. return true;
  83. }
  84. fwrite(STDERR, sprintf("FreshRSS error: unknown options: %s\n", implode (', ', $unknownOptions)));
  85. return false;
  86. }