Files
FreshRSS/cli/update-user.php
Kasimir Cash 4b29e666b0 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 <alexandre@alapetite.fr>
2024-02-28 13:23:28 +01:00

93 lines
2.7 KiB
PHP
Executable File

#!/usr/bin/env php
<?php
declare(strict_types=1);
require(__DIR__ . '/_cli.php');
$cliOptions = new class extends CliOptionsParser {
public string $user;
public string $password;
public string $apiPassword;
public string $language;
public string $email;
public string $token;
public int $purgeAfterMonths;
public int $feedMinArticles;
public int $feedTtl;
public int $sinceHoursPostsPerRss;
public int $maxPostsPerRss;
public function __construct() {
$this->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')
);
parent::__construct();
}
};
if (!empty($cliOptions->errors)) {
fail('FreshRSS error: ' . array_shift($cliOptions->errors) . "\n" . $cliOptions->usage);
}
$username = cliInitUser($cliOptions->user);
echo 'FreshRSS updating 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::updateUser(
$username,
isset($cliOptions->email) ? $cliOptions->email : null,
$cliOptions->password ?? '',
$values);
if (!$ok) {
fail('FreshRSS could not update user!');
}
if (isset($cliOptions->apiPassword)) {
$error = FreshRSS_api_Controller::updatePassword($cliOptions->apiPassword);
if ($error) {
fail($error);
}
}
invalidateHttpCache($username);
accessRights();
done($ok);