mirror of
https://github.com/moodle/moodle.git
synced 2025-02-13 20:36:42 +01:00
93 lines
3.0 KiB
PHP
93 lines
3.0 KiB
PHP
<?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
|
|
* @subpackage db
|
|
* @copyright 2006 Martin Langhoff
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
define('CLI_SCRIPT', true);
|
|
|
|
require(dirname(dirname(dirname(dirname(__FILE__)))).'/config.php');
|
|
require_once($CFG->dirroot.'/course/lib.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 progess 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')) {
|
|
echo "Plugin not enabled!";
|
|
exit(1);
|
|
}
|
|
|
|
$verbose = !empty($options['verbose']);
|
|
$update = empty($options['noupdate']);
|
|
|
|
$dbauth = get_auth_plugin('db');
|
|
return $dbauth->sync_users($update, $verbose);
|
|
|