MDL-29025 standardise cli verbose output and general cleanup
[moodle.git] / auth / db / cli / sync_users.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Extdb user sync script.
19  *
20  * This script is meant to be called from a system cronjob to
21  * sync moodle user accounts with external database.
22  * It is required when using internal passwords (== passwords not defined in external database).
23  *
24  * Sample cron entry:
25  * # 5 minutes past 4am
26  * 5 4 * * * $sudo -u www-data /usr/bin/php /var/www/moodle/auth/db/cli/sync_users.php
27  *
28  * Notes:
29  *   - it is required to use the web server account when executing PHP CLI scripts
30  *   - you need to change the "www-data" to match the apache user account
31  *   - use "su" if "sudo" not available
32  *   - If you have a large number of users, you may want to raise the memory limits
33  *     by passing -d memory_limit=256M
34  *   - For debugging & better logging, you are encouraged to use in the command line:
35  *     -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
36  *
37  * Performance notes:
38  * + The code is simpler, but not as optimized as its LDAP counterpart.
39  *
40  * @package    auth
41  * @subpackage db
42  * @copyright  2006 Martin Langhoff
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
46 define('CLI_SCRIPT', true);
48 require(dirname(dirname(dirname(dirname(__FILE__)))).'/config.php');
49 require_once($CFG->dirroot.'/course/lib.php');
50 require_once($CFG->libdir.'/clilib.php');
52 // now get cli options
53 list($options, $unrecognized) = cli_get_params(array('noupdate'=>false, 'verbose'=>false, 'help'=>false), array('n'=>'noupdate', 'v'=>'verbose', 'h'=>'help'));
55 if ($unrecognized) {
56     $unrecognized = implode("\n  ", $unrecognized);
57     cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
58 }
60 if ($options['help']) {
61     $help =
62 "Execute user account sync with external database.
63 The auth_db plugin must be enabled and properly configured.
65 Options:
66 -n, --noupdate        Skip update of existing users
67 -v, --verbose         Print verbose progess information
68 -h, --help            Print out this help
70 Example:
71 \$sudo -u www-data /usr/bin/php auth/db/cli/sync_users.php
73 Sample cron entry:
74 # 5 minutes past 4am
75 5 4 * * * $sudo -u www-data /usr/bin/php /var/www/moodle/auth/db/cli/sync_users.php
76 ";
78     echo $help;
79     die;
80 }
82 if (!is_enabled_auth('db')) {
83     echo "Plugin not enabled!";
84     exit(1);
85 }
87 $verbose = !empty($options['verbose']);
88 $update = empty($options['noupdate']);
90 $dbauth = get_auth_plugin('db');
91 return $dbauth->sync_users($update, $verbose);