Moodle release 3.0beta
[moodle.git] / auth / ldap / cli / sync_users.php
CommitLineData
28bd3d9a 1<?php
28bd3d9a
PS
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/>.
16
17/**
18 * CAS user sync script.
19 *
20 * This script is meant to be called from a cronjob to sync moodle with the LDAP
21 * backend in those setups where the LDAP 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/ldap/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 * - If you have a large number of users, you may want to raise the memory limits
36 * by passing -d momory_limit=256M
37 * - For debugging & better logging, you are encouraged to use in the command line:
38 * -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
39 *
40 * Performance notes:
41 * We have optimized it as best as we could for PostgreSQL and MySQL, with 27K students
42 * we have seen this take 10 minutes.
43 *
a2f10958 44 * @package auth_ldap
28bd3d9a
PS
45 * @copyright 2004 Martin Langhoff
46 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47 */
48
49define('CLI_SCRIPT', true);
50
51require(dirname(dirname(dirname(dirname(__FILE__)))).'/config.php'); // global moodle config file.
52require_once($CFG->dirroot.'/course/lib.php');
53
54// Ensure errors are well explained
96f81ea3 55set_debugging(DEBUG_DEVELOPER, true);
28bd3d9a
PS
56
57if (!is_enabled_auth('ldap')) {
58 error_log('[AUTH LDAP] '.get_string('pluginnotenabled', 'auth_ldap'));
59 die;
60}
61
62$ldapauth = get_auth_plugin('ldap');
63$ldapauth->sync_users(true);
64