aboutsummaryrefslogtreecommitdiff
path: root/cli
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2017-03-11 10:36:48 +0100
committerGravatar GitHub <noreply@github.com> 2017-03-11 10:36:48 +0100
commitbe0bcfef7e38f27284ec7b377b342ba389515964 (patch)
tree59d2d5a8e34fcb279a53a2b44fde1e36c888672d /cli
parent5f637bd816b7323885bfe1751a1724ee59a822f6 (diff)
parentb34c318f02574b13560731035fd5a4f750aa1e9b (diff)
Merge pull request #1455 from FreshRSS/dev1.6.3
Release 1.6.3
Diffstat (limited to 'cli')
-rw-r--r--cli/README.md17
-rw-r--r--cli/_cli.php2
-rwxr-xr-xcli/create-user.php2
-rwxr-xr-xcli/delete-user.php2
-rwxr-xr-xcli/do-install.php53
-rwxr-xr-xcli/list-users.php2
-rwxr-xr-xcli/reconfigure.php59
-rwxr-xr-xcli/user-info.php16
8 files changed, 123 insertions, 30 deletions
diff --git a/cli/README.md b/cli/README.md
index e4d3409a2..0123e8d6e 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -32,13 +32,17 @@ Options in parenthesis are optional.
```sh
cd /usr/share/FreshRSS
-./cli/do-install.php --default_user admin ( --auth_type form --environment production --base_url https://rss.example.net/ --title FreshRSS --allow_anonymous --api_enabled --db-type mysql --db-host localhost:3306 --db-user freshrss --db-password dbPassword123 --db-base freshrss --db-prefix freshrss )
+./cli/do-install.php --default_user admin ( --auth_type form --environment production --base_url https://rss.example.net/ --language en --title FreshRSS --allow_anonymous --api_enabled --db-type mysql --db-host localhost:3306 --db-user freshrss --db-password dbPassword123 --db-base freshrss --db-prefix freshrss )
# --auth_type can be: 'form' (default), 'http_auth' (using the Web server access control), 'none' (dangerous)
# --db-type can be: 'sqlite' (default), 'mysql' (MySQL or MariaDB), 'pgsql' (PostgreSQL)
# --environment can be: 'production' (default), 'development' (for additional log messages)
+# --language can be: 'en' (default), 'fr', or one of the [supported languages](../app/i18n/)
# --db-prefix is an optional prefix in front of the names of the tables. We suggest using 'freshrss_'
# This command does not create the default user. Do that with ./cli/create-user.php
+./cli/reconfigure.php
+# Same parameters as for do-install.php. Used to update an existing installation.
+
./cli/create-user.php --user username ( --password 'password' --api-password 'api_password' --language en --email user@example.net --token 'longRandomString' --no-default-feeds )
# --language can be: 'en' (default), 'fr', or one of the [supported languages](../app/i18n/)
@@ -59,14 +63,15 @@ cd /usr/share/FreshRSS
./cli/user-info.php -h --user username
# -h is to use a human-readable format
# --user can be a username, or '*' to loop on all users
-# Returns a * if the user is admin, the name of the user, the date/time of last action, and the size occupied
+# Returns: 1) a * iff the user is admin, 2) the name of the user,
+# 3) the date/time of last user action, 4) the size occupied,
+# and the number of: 5) categories, 6) feeds, 7) read articles, 8) unread articles, and 9) favourites
```
## Unix piping
It is possible to invoke a command multiple times, e.g. with different usernames, thanks to the `xargs -n1` command.
-
Example showing user information for all users which username starts with 'a':
```sh
@@ -78,3 +83,9 @@ Example showing all users ranked by date of last activity:
```sh
./cli/user-info.php -h --user '*' | sort -k2 -r
```
+
+Example to get the number of feeds of a given user:
+
+```sh
+./cli/user-info.php --user alex | cut -f6
+```
diff --git a/cli/_cli.php b/cli/_cli.php
index 7d1a7c6b2..f5e36eabc 100644
--- a/cli/_cli.php
+++ b/cli/_cli.php
@@ -20,7 +20,7 @@ function fail($message) {
}
function cliInitUser($username) {
- if (!ctype_alnum($username)) {
+ if (!FreshRSS_user_Controller::checkUsername($username)) {
fail('FreshRSS error: invalid username: ' . $username . "\n");
}
diff --git a/cli/create-user.php b/cli/create-user.php
index 444264cc7..c9e350c14 100755
--- a/cli/create-user.php
+++ b/cli/create-user.php
@@ -17,7 +17,7 @@ if (empty($options['user'])) {
" --language en --email user@example.net --token 'longRandomString --no-default-feeds' )");
}
$username = $options['user'];
-if (!ctype_alnum($username)) {
+if (!FreshRSS_user_Controller::checkUsername($username)) {
fail('FreshRSS error: invalid username “' . $username . '”');
}
diff --git a/cli/delete-user.php b/cli/delete-user.php
index 6f0e86e17..baa81b893 100755
--- a/cli/delete-user.php
+++ b/cli/delete-user.php
@@ -10,7 +10,7 @@ if (empty($options['user'])) {
fail('Usage: ' . basename(__FILE__) . " --user username");
}
$username = $options['user'];
-if (!ctype_alnum($username)) {
+if (!FreshRSS_user_Controller::checkUsername($username)) {
fail('FreshRSS error: invalid username “' . $username . '”');
}
diff --git a/cli/do-install.php b/cli/do-install.php
index 100d4947f..143ca5c3e 100755
--- a/cli/do-install.php
+++ b/cli/do-install.php
@@ -3,9 +3,14 @@
require('_cli.php');
require(LIB_PATH . '/lib_install.php');
+if (!file_exists(DATA_PATH . '/do-install.txt')) {
+ fail('FreshRSS looks to be already installed! Please use `./cli/reconfigure.php` instead.');
+}
+
$params = array(
'environment:',
'base_url:',
+ 'language:',
'title:',
'default_user:',
'allow_anonymous',
@@ -13,6 +18,7 @@ $params = array(
'auth_type:',
'api_enabled',
'allow_robots',
+ 'disable_update',
);
$dBparams = array(
@@ -29,32 +35,13 @@ $options = getopt('', array_merge($params, $dBparams));
if (empty($options['default_user'])) {
fail('Usage: ' . basename(__FILE__) . " --default_user admin ( --auth_type form" .
" --environment production --base_url https://rss.example.net/" .
- " --title FreshRSS --allow_anonymous --api_enabled" .
+ " --language en --title FreshRSS --allow_anonymous --api_enabled" .
" --db-type mysql --db-host localhost:3306 --db-user freshrss --db-password dbPassword123" .
- " --db-base freshrss --db-prefix freshrss_ )");
+ " --db-base freshrss --db-prefix freshrss_ --disable_update )");
}
fwrite(STDERR, 'FreshRSS install…' . "\n");
-$requirements = checkRequirements();
-if ($requirements['all'] !== 'ok') {
- $message = 'FreshRSS install failed requirements:' . "\n";
- foreach ($requirements as $requirement => $check) {
- if ($check !== 'ok' && $requirement !== 'all') {
- $message .= '• ' . $requirement . "\n";
- }
- }
- fail($message);
-}
-
-if (!ctype_alnum($options['default_user'])) {
- fail('FreshRSS invalid default username (must be ASCII alphanumeric): ' . $options['default_user']);
-}
-
-if (isset($options['auth_type']) && !in_array($options['auth_type'], array('form', 'http_auth', 'none'))) {
- fail('FreshRSS invalid authentication method (auth_type must be one of { form, http_auth, none }: ' . $options['auth_type']);
-}
-
$config = array(
'salt' => generateSalt(),
'db' => FreshRSS_Context::$system_conf->db,
@@ -73,12 +60,34 @@ if ((!empty($config['base_url'])) && server_is_public($config['base_url'])) {
foreach ($dBparams as $dBparam) {
$dBparam = rtrim($dBparam, ':');
- if (!empty($options[$dBparam])) {
+ if (isset($options[$dBparam])) {
$param = substr($dBparam, strlen('db-'));
$config['db'][$param] = $options[$dBparam];
}
}
+$requirements = checkRequirements($config['db']['type']);
+if ($requirements['all'] !== 'ok') {
+ $message = 'FreshRSS install failed requirements:' . "\n";
+ foreach ($requirements as $requirement => $check) {
+ if ($check !== 'ok' && !in_array($requirement, array('all', 'pdo', 'message'))) {
+ $message .= '• ' . $requirement . "\n";
+ }
+ }
+ if (!empty($requirements['message'])) {
+ $message .= '• ' . $requirements['message'] . "\n";
+ }
+ fail($message);
+}
+
+if (!FreshRSS_user_Controller::checkUsername($options['default_user'])) {
+ fail('FreshRSS invalid default username (must be ASCII alphanumeric): ' . $options['default_user']);
+}
+
+if (isset($options['auth_type']) && !in_array($options['auth_type'], array('form', 'http_auth', 'none'))) {
+ fail('FreshRSS invalid authentication method (auth_type must be one of { form, http_auth, none }: ' . $options['auth_type']);
+}
+
if (file_put_contents(join_path(DATA_PATH, 'config.php'), "<?php\n return " . var_export($config, true) . ";\n") === false) {
fail('FreshRSS could not write configuration file!: ' . join_path(DATA_PATH, 'config.php'));
}
diff --git a/cli/list-users.php b/cli/list-users.php
index e690ff451..610a9dd7b 100755
--- a/cli/list-users.php
+++ b/cli/list-users.php
@@ -4,7 +4,7 @@ require('_cli.php');
$users = listUsers();
sort($users);
-if (FreshRSS_Context::$system_conf->default_user !== '') {
+if (FreshRSS_Context::$system_conf->default_user !== '' && in_array(FreshRSS_Context::$system_conf->default_user, $users, true)) {
array_unshift($users, FreshRSS_Context::$system_conf->default_user);
$users = array_unique($users);
}
diff --git a/cli/reconfigure.php b/cli/reconfigure.php
new file mode 100755
index 000000000..c6902da67
--- /dev/null
+++ b/cli/reconfigure.php
@@ -0,0 +1,59 @@
+#!/usr/bin/php
+<?php
+require('_cli.php');
+
+$params = array(
+ 'environment:',
+ 'base_url:',
+ 'language:',
+ 'title:',
+ 'default_user:',
+ 'allow_anonymous',
+ 'allow_anonymous_refresh',
+ 'auth_type:',
+ 'api_enabled',
+ 'allow_robots',
+ 'disable_update',
+ );
+
+$dBparams = array(
+ 'db-type:',
+ 'db-host:',
+ 'db-user:',
+ 'db-password:',
+ 'db-base:',
+ 'db-prefix:',
+ );
+
+$options = getopt('', array_merge($params, $dBparams));
+
+fwrite(STDERR, 'Reconfiguring FreshRSS…' . "\n");
+
+$config = Minz_Configuration::get('system');
+foreach ($params as $param) {
+ $param = rtrim($param, ':');
+ if (isset($options[$param])) {
+ $config->$param = $options[$param] === false ? true : $options[$param];
+ }
+}
+$db = $config->db;
+foreach ($dBparams as $dBparam) {
+ $dBparam = rtrim($dBparam, ':');
+ if (isset($options[$dBparam])) {
+ $param = substr($dBparam, strlen('db-'));
+ $db[$param] = $options[$dBparam];
+ }
+}
+$config->db = $db;
+
+if (!FreshRSS_user_Controller::checkUsername($config->default_user)) {
+ fail('FreshRSS invalid default username (must be ASCII alphanumeric): ' . $config->default_user);
+}
+
+if (isset($config->auth_type) && !in_array($config->auth_type, array('form', 'http_auth', 'none'))) {
+ fail('FreshRSS invalid authentication method (auth_type must be one of { form, http_auth, none }: ' . $config->auth_type);
+}
+
+$config->save();
+
+done();
diff --git a/cli/user-info.php b/cli/user-info.php
index dd38e6c7f..aa3e239b8 100755
--- a/cli/user-info.php
+++ b/cli/user-info.php
@@ -14,22 +14,36 @@ $users = $options['user'] === '*' ? listUsers() : array($options['user']);
foreach ($users as $username) {
$username = cliInitUser($username);
+ echo $username === FreshRSS_Context::$system_conf->default_user ? '*' : ' ', "\t";
+ $catDAO = new FreshRSS_CategoryDAO();
+ $feedDAO = FreshRSS_Factory::createFeedDao($username);
$entryDAO = FreshRSS_Factory::createEntryDao($username);
- echo $username === FreshRSS_Context::$system_conf->default_user ? '*' : ' ', "\t";
+ $nbEntries = $entryDAO->countUnreadRead();
+ $nbFavorites = $entryDAO->countUnreadReadFavorites();
if (isset($options['h'])) { //Human format
echo
$username, "\t",
date('c', FreshRSS_UserDAO::mtime($username)), "\t",
format_bytes($entryDAO->size()), "\t",
+ $catDAO->count(), " categories\t",
+ count($feedDAO->listFeedsIds()), " feeds\t",
+ $nbEntries['read'], " reads\t",
+ $nbEntries['unread'], " unreads\t",
+ $nbFavorites['all'], " favourites\t",
"\n";
} else {
echo
$username, "\t",
FreshRSS_UserDAO::mtime($username), "\t",
$entryDAO->size(), "\t",
+ $catDAO->count(), "\t",
+ count($feedDAO->listFeedsIds()), "\t",
+ $nbEntries['read'], "\t",
+ $nbEntries['unread'], "\t",
+ $nbFavorites['all'], "\t",
"\n";
}
}