a02c32f16c32bbe92e83eb151233ee60a7fa013c
[moodle.git] / auth / cas / 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  * CAS user sync script.
19  *
20  * This script is meant to be called from a cronjob to sync moodle with the CAS
21  * backend in those setups where the CAS backend acts as 'master'.
22  *
23  * Sample cron entry:
24  * # 5 minutes past 4am
25  * 5 4 * * * $sudo -u www-data /usr/bin/php /var/www/moodle/auth/cas/cli/sync_users.php
26  *
27  * Notes:
28  *   - it is required to use the web server account when executing PHP CLI scripts
29  *   - you need to change the "www-data" to match the apache user account
30  *   - use "su" if "sudo" not available
31  *   - If you have a large number of users, you may want to raise the memory limits
32  *     by passing -d momory_limit=256M
33  *   - For debugging & better logging, you are encouraged to use in the command line:
34  *     -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
35  *
36  * Performance notes:
37  * We have optimized it as best as we could for PostgreSQL and MySQL, with 27K students
38  * we have seen this take 10 minutes.
39  *
40  * @package    auth_cas
41  * @copyright  2007 Jerome Gutierrez - based on code by Martin Langhoff
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
45 define('CLI_SCRIPT', true);
47 require(dirname(dirname(dirname(dirname(__FILE__)))).'/config.php');
48 require_once($CFG->dirroot.'/course/lib.php');
50 // Ensure errors are well explained
51 set_debugging(DEBUG_DEVELOPER, true);
53 if (!is_enabled_auth('cas')) {
54     error_log('[AUTH CAS] '.get_string('pluginnotenabled', 'auth_ldap'));
55     die;
56 }
58 $casauth = get_auth_plugin('cas');
59 $casauth->sync_users(true);