You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
104 lines
3.5 KiB
104 lines
3.5 KiB
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Extdb user sync script.
|
|
*
|
|
* This script is meant to be called from a system cronjob to
|
|
* sync moodle user accounts with external database.
|
|
* It is required when using internal passwords (== passwords not defined in external database).
|
|
*
|
|
* Sample cron entry:
|
|
* # 5 minutes past 4am
|
|
* 5 4 * * * sudo -u www-data /usr/bin/php /var/www/moodle/auth/db/cli/sync_users.php
|
|
*
|
|
* Notes:
|
|
* - it is required to use the web server account when executing PHP CLI scripts
|
|
* - you need to change the "www-data" to match the apache user account
|
|
* - use "su" if "sudo" not available
|
|
* - If you have a large number of users, you may want to raise the memory limits
|
|
* by passing -d memory_limit=256M
|
|
* - For debugging & better logging, you are encouraged to use in the command line:
|
|
* -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
|
|
*
|
|
* Performance notes:
|
|
* + The code is simpler, but not as optimized as its LDAP counterpart.
|
|
*
|
|
* @package auth_db
|
|
* @copyright 2006 Martin Langhoff
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
define('CLI_SCRIPT', true);
|
|
|
|
require(__DIR__.'/../../../config.php');
|
|
require_once("$CFG->libdir/clilib.php");
|
|
|
|
// Now get cli options.
|
|
list($options, $unrecognized) = cli_get_params(array('noupdate'=>false, 'verbose'=>false, 'help'=>false), array('n'=>'noupdate', 'v'=>'verbose', 'h'=>'help'));
|
|
|
|
if ($unrecognized) {
|
|
$unrecognized = implode("\n ", $unrecognized);
|
|
cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
|
|
}
|
|
|
|
if ($options['help']) {
|
|
$help =
|
|
"Execute user account sync with external database.
|
|
The auth_db plugin must be enabled and properly configured.
|
|
|
|
Options:
|
|
-n, --noupdate Skip update of existing users
|
|
-v, --verbose Print verbose progress information
|
|
-h, --help Print out this help
|
|
|
|
Example:
|
|
\$ sudo -u www-data /usr/bin/php auth/db/cli/sync_users.php
|
|
|
|
Sample cron entry:
|
|
# 5 minutes past 4am
|
|
5 4 * * * sudo -u www-data /usr/bin/php /var/www/moodle/auth/db/cli/sync_users.php
|
|
";
|
|
|
|
echo $help;
|
|
die;
|
|
}
|
|
|
|
if (!is_enabled_auth('db')) {
|
|
cli_error('auth_db plugin is disabled, synchronisation stopped', 2);
|
|
}
|
|
|
|
cli_problem('[AUTH DB] The sync users cron has been deprecated. Please use the scheduled task instead.');
|
|
|
|
// Abort execution of the CLI script if the \auth_db\task\sync_users is enabled.
|
|
$task = \core\task\manager::get_scheduled_task('auth_db\task\sync_users');
|
|
if (!$task->get_disabled()) {
|
|
cli_error('[AUTH DB] The scheduled task sync_users is enabled, the cron execution has been aborted.');
|
|
}
|
|
|
|
if (empty($options['verbose'])) {
|
|
$trace = new null_progress_trace();
|
|
} else {
|
|
$trace = new text_progress_trace();
|
|
}
|
|
|
|
$update = empty($options['noupdate']);
|
|
|
|
/** @var auth_plugin_db $dbauth */
|
|
$dbauth = get_auth_plugin('db');
|
|
$result = $dbauth->sync_users($trace, $update);
|
|
|
|
exit($result);
|
|
|