weekly release 3.8dev
[moodle.git] / enrol / ldap / cli / sync.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  * CLI sync for full LDAP synchronisation.
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' for enrolment.
22  *
23  * Sample cron entry:
24  * # 5 minutes past 4am
25  * 5 4 * * * $sudo -u www-data /usr/bin/php /var/www/moodle/enrol/ldap/cli/sync.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  * @deprecated since Moodle 3.3 MDL-57631 - please do not use this CLI script any more, use scheduled task instead.
37  * @todo       MDL-58268 This will be deleted in Moodle 3.7.
38  * @package    enrol_ldap
39  * @author     Iñaki Arenaza - based on code by Martin Dougiamas, Martin Langhoff and others
40  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
41  * @copyright  2010 Iñaki Arenaza <iarenaza@eps.mondragon.edu>
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
45 define('CLI_SCRIPT', true);
47 require(__DIR__.'/../../../config.php');
48 require_once("$CFG->libdir/clilib.php");
50 // Ensure errors are well explained.
51 set_debugging(DEBUG_DEVELOPER, true);
53 cli_problem('[ENROL LDAP] The sync enrolments cron script has been deprecated. Please use the scheduled task instead.');
55 // Abort execution of the CLI script if the enrol_ldap\task\sync_enrolments is enabled.
56 $task = \core\task\manager::get_scheduled_task('enrol_ldap\task\sync_enrolments');
57 if (!$task->get_disabled()) {
58     cli_error('[ENROL LDAP] The scheduled task sync_enrolments is enabled, the cron execution has been aborted.');
59 }
61 if (!enrol_is_enabled('ldap')) {
62     cli_error(get_string('pluginnotenabled', 'enrol_ldap'), 2);
63 }
65 /** @var enrol_ldap_plugin $enrol */
66 $enrol = enrol_get_plugin('ldap');
68 $trace = new text_progress_trace();
70 // Update enrolments -- these handlers should autocreate courses if required.
71 $enrol->sync_enrolments($trace);
73 exit(0);