MDL-58268 enrol_ldap: Remove enrol/ldap/cli/sync deprecated in 3.3
authorcescobedo <carlos.escobedo@gmail.com>
Thu, 23 May 2019 16:20:28 +0000 (18:20 +0200)
committercescobedo <carlos.escobedo@gmail.com>
Fri, 31 May 2019 07:40:47 +0000 (09:40 +0200)
enrol/ldap/cli/sync.php [deleted file]
enrol/ldap/lang/en/enrol_ldap.php
enrol/ldap/upgrade.txt

diff --git a/enrol/ldap/cli/sync.php b/enrol/ldap/cli/sync.php
deleted file mode 100644 (file)
index 8aedc9f..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-<?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/>.
-
-/**
- * CLI sync for full LDAP synchronisation.
- *
- * This script is meant to be called from a cronjob to sync moodle with the LDAP
- * backend in those setups where the LDAP backend acts as 'master' for enrolment.
- *
- * Sample cron entry:
- * # 5 minutes past 4am
- * 5 4 * * * $sudo -u www-data /usr/bin/php /var/www/moodle/enrol/ldap/cli/sync.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 momory_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
- *
- * @deprecated since Moodle 3.3 MDL-57631 - please do not use this CLI script any more, use scheduled task instead.
- * @todo       MDL-58268 This will be deleted in Moodle 3.7.
- * @package    enrol_ldap
- * @author     Iñaki Arenaza - based on code by Martin Dougiamas, Martin Langhoff and others
- * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
- * @copyright  2010 Iñaki Arenaza <iarenaza@eps.mondragon.edu>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../../config.php');
-require_once("$CFG->libdir/clilib.php");
-
-// Ensure errors are well explained.
-set_debugging(DEBUG_DEVELOPER, true);
-
-cli_problem('[ENROL LDAP] The sync enrolments cron script has been deprecated. Please use the scheduled task instead.');
-
-// Abort execution of the CLI script if the enrol_ldap\task\sync_enrolments is enabled.
-$task = \core\task\manager::get_scheduled_task('enrol_ldap\task\sync_enrolments');
-if (!$task->get_disabled()) {
-    cli_error('[ENROL LDAP] The scheduled task sync_enrolments is enabled, the cron execution has been aborted.');
-}
-
-if (!enrol_is_enabled('ldap')) {
-    cli_error(get_string('pluginnotenabled', 'enrol_ldap'), 2);
-}
-
-/** @var enrol_ldap_plugin $enrol */
-$enrol = enrol_get_plugin('ldap');
-
-$trace = new text_progress_trace();
-
-// Update enrolments -- these handlers should autocreate courses if required.
-$enrol->sync_enrolments($trace);
-
-exit(0);
index 2a95489..89841c9 100644 (file)
@@ -29,7 +29,7 @@ $string['autocreate'] = '<p>Courses can be created automatically if there are en
 $string['autocreate_key'] = 'Auto create';
 $string['autocreation_settings'] = 'Automatic course creation settings';
 $string['autoupdate_settings'] = 'Automatic course update settings';
-$string['autoupdate_settings_desc'] = '<p>Select fields to update when synchronisation script is running (enrol/ldap/cli/sync.php).</p><p>When at least one field is selected an update will occur.</p>';
+$string['autoupdate_settings_desc'] = '<p>Select fields to update when synchronisation scheduled task for LDAP Enrolments is running (enrol_ldap\task\sync_enrolments).</p><p>When at least one field is selected an update will occur.</p>';
 $string['bind_dn'] = 'If you want to use a bind user to search users, specify it here. Someting like \'cn=ldapuser,ou=public,o=org\'';
 $string['bind_dn_key'] = 'Bind user distinguished name';
 $string['bind_pw'] = 'Password for the bind user';
index d00991d..4607ec0 100644 (file)
@@ -1,4 +1,8 @@
 This files describes API changes in the enrol_ldap code.
 
+=== 3.8 ===
+
+* enrol/ldap/cli/sync.php script has been removed. You should use enrol_ldap\task\sync_enrolments task instead.
+
 === 3.3 ===
 * enrol/ldap/cli/sync.php script has been deprecated in favour of enrol_ldap\task\sync_enrolments task.