source: moodle/trunk/fuentes/auth/ldap/cli/sync_users.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 3.0 KB
Line 
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/>.
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 * Notes:
24 *   - it is required to use the web server account when executing PHP CLI scripts
25 *   - you need to change the "www-data" to match the apache user account
26 *   - use "su" if "sudo" not available
27 *   - If you have a large number of users, you may want to raise the memory limits
28 *     by passing -d momory_limit=256M
29 *   - For debugging & better logging, you are encouraged to use in the command line:
30 *     -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
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_ldap
41 * @copyright  2004 Martin Langhoff
42 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43 * @deprecated since Moodle 3.0 MDL-51824 - please do not use this CLI script any more, use scheduled task instead.
44 * @todo MDL-50264 This will be deleted in Moodle 3.2.
45 */
46
47define('CLI_SCRIPT', true);
48
49require(dirname(dirname(dirname(dirname(__FILE__)))).'/config.php'); // global moodle config file.
50require_once($CFG->dirroot.'/course/lib.php');
51require_once($CFG->libdir.'/clilib.php');
52
53// Ensure errors are well explained
54set_debugging(DEBUG_DEVELOPER, true);
55
56if (!is_enabled_auth('ldap')) {
57    error_log('[AUTH LDAP] '.get_string('pluginnotenabled', 'auth_ldap'));
58    die;
59}
60
61cli_problem('[AUTH LDAP] The users sync cron has been deprecated. Please use the scheduled task instead.');
62
63// Abort execution of the CLI script if the auth_ldap\task\sync_task is enabled.
64$taskdisabled = \core\task\manager::get_scheduled_task('auth_ldap\task\sync_task');
65if (!$taskdisabled->get_disabled()) {
66    cli_error('[AUTH LDAP] The scheduled task sync_task is enabled, the cron execution has been aborted.');
67}
68
69$ldapauth = get_auth_plugin('ldap');
70$ldapauth->sync_users(true);
71
Note: See TracBrowser for help on using the repository browser.