From 4b29e666b06762b4b36438c9370c38bc43121f78 Mon Sep 17 00:00:00 2001 From: Kasimir Cash Date: Wed, 28 Feb 2024 12:23:28 +0000 Subject: Command Line Parser Concept (#6099) * Adds logic for validation * Adds validation to do-install * Adds help to do-install * Adds validation & help to reconfigure * Adds validation to check.translation * Adds validation to manipulate.translation * Small fixes to help texts * Refactors language option validation * Adds default options to validation * Fixes validation with regex * Refactors readAs functions * Updates to new regex validation format * Fixes typing around default values * Adds file extension validation * Restandardises validation & parsing typing around array of strings * Adds NotOneOf validation * Adds ArrayOfString read as * Refactors existing validation * Adds validation throughout cli * Removes unused file * Adds new CL parser with goal of wrapping CLI behaviour * Hides parsing and validation * Rewites CL parser to make better use of classes * Rolls out new parser across CL * Fixes error during unknown option check * Fixes misnamed property calls * Seperates validations into more appropriate locations * Adds common boolean forms to validation * Moves CommandLineParser and Option classes into their own files * Fixes error when validating Int type * Rewrites appendTypedValues -> appendTypedValidValues now filters invalid values from output * Renames -> for clarity * Adds some docs clarifying option defaults and value taking behaviour * Refactors getUsageMessage for readability * Minor formatting changes * Adds tests for CommandLineParser * Adds more tests * Adds minor fixs * Reconfigure now correctly updates config * More fixes to reconfigure * Fixes required files for CommandLineParserTest * Use .php extension for PHP file * PHPStan ignore instead of wrong typing * Refactors to support php 7.4 * Moves away from dynamic properties by adding 'Definintions' to all commands * Renames target to definition for clarity * Stops null from being returned as a valid value in a certain edge case * Adds PHPStan ignore instead of incorrect typing * Refactors tests to take account of new typing solution * Marks file as executable * Draft CLI rework * Finish rewrite as object-oriented * Fix PHPStan ignore and make more strongly typed * Rename class Option to CliOption * Light renaming + anonymous classes --------- Co-authored-by: Alexandre Alapetite --- cli/create-user.php | 87 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 71 insertions(+), 16 deletions(-) (limited to 'cli/create-user.php') diff --git a/cli/create-user.php b/cli/create-user.php index 53e0335bc..61bbc3563 100755 --- a/cli/create-user.php +++ b/cli/create-user.php @@ -1,38 +1,93 @@ #!/usr/bin/env php addRequiredOption('user', (new CliOption('user'))); + $this->addOption('password', (new CliOption('password'))); + $this->addOption('apiPassword', (new CliOption('api-password'))->deprecatedAs('api_password')); + $this->addOption('language', (new CliOption('language'))); + $this->addOption('email', (new CliOption('email'))); + $this->addOption('token', (new CliOption('token'))); + $this->addOption( + 'purgeAfterMonths', + (new CliOption('purge-after-months'))->typeOfInt()->deprecatedAs('purge_after_months') + ); + $this->addOption( + 'feedMinArticles', + (new CliOption('feed-min-articles-default'))->typeOfInt()->deprecatedAs('feed_min_articles_default') + ); + $this->addOption( + 'feedTtl', + (new CliOption('feed-ttl-default'))->typeOfInt()->deprecatedAs('feed_ttl_default') + ); + $this->addOption( + 'sinceHoursPostsPerRss', + (new CliOption('since-hours-posts-per-rss'))->typeOfInt()->deprecatedAs('since_hours_posts_per_rss') + ); + $this->addOption( + 'maxPostsPerRss', + (new CliOption('max-posts-per-rss'))->typeOfInt()->deprecatedAs('max_posts_per_rss') + ); + $this->addOption( + 'noDefaultFeeds', + (new CliOption('no-default-feeds'))->withValueNone()->deprecatedAs('no_default_feeds') + ); + parent::__construct(); + } +}; -$usernames = listUsers(); -if (preg_grep("/^$username$/i", $usernames)) { - fail('FreshRSS warning: username already exists “' . $username . '”', EXIT_CODE_ALREADY_EXISTS); +if (!empty($cliOptions->errors)) { + fail('FreshRSS error: ' . array_shift($cliOptions->errors) . "\n" . $cliOptions->usage); } +$username = $cliOptions->user; + echo 'FreshRSS creating user “', $username, "”…\n"; +$values = [ + 'language' => $cliOptions->language ?? null, + 'mail_login' => $cliOptions->email ?? null, + 'token' => $cliOptions->token ?? null, + 'old_entries' => $cliOptions->purgeAfterMonths ?? null, + 'keep_history_default' => $cliOptions->feedMinArticles ?? null, + 'ttl_default' => $cliOptions->feedTtl ?? null, + 'since_hours_posts_per_rss' => $cliOptions->sinceHoursPostsPerRss ?? null, + 'max_posts_per_rss' => $cliOptions->maxPostsPerRss ?? null, +]; + +$values = array_filter($values); + $ok = FreshRSS_user_Controller::createUser( $username, - empty($options['valid']['email']) ? '' : $options['valid']['email'], - empty($options['valid']['password']) ? '' : $options['valid']['password'], - $GLOBALS['values'], - !isset($options['valid']['no-default-feeds']) + isset($cliOptions->email) ? $cliOptions->email : null, + $cliOptions->password ?? '', + $values, + !isset($cliOptions->noDefaultFeeds) ); if (!$ok) { fail('FreshRSS could not create user!'); } -if (!empty($options['valid']['api-password'])) { +if (isset($cliOptions->apiPassword)) { $username = cliInitUser($username); - $error = FreshRSS_api_Controller::updatePassword($options['valid']['api-password']); + $error = FreshRSS_api_Controller::updatePassword($cliOptions->apiPassword); if ($error !== false) { fail($error); } -- cgit v1.2.3