From e094614d7ca0cc4cfa6192cab75b4aabacee7290 Mon Sep 17 00:00:00 2001 From: cescobedo Date: Thu, 23 May 2019 18:20:28 +0200 Subject: [PATCH] MDL-58268 enrol_ldap: Remove enrol/ldap/cli/sync deprecated in 3.3 --- enrol/ldap/cli/sync.php | 73 ------------------------------- enrol/ldap/lang/en/enrol_ldap.php | 2 +- enrol/ldap/upgrade.txt | 4 ++ 3 files changed, 5 insertions(+), 74 deletions(-) delete mode 100644 enrol/ldap/cli/sync.php diff --git a/enrol/ldap/cli/sync.php b/enrol/ldap/cli/sync.php deleted file mode 100644 index 8aedc9f6dc1..00000000000 --- a/enrol/ldap/cli/sync.php +++ /dev/null @@ -1,73 +0,0 @@ -. - -/** - * 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 - * @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); diff --git a/enrol/ldap/lang/en/enrol_ldap.php b/enrol/ldap/lang/en/enrol_ldap.php index 2a95489abb8..89841c99264 100644 --- a/enrol/ldap/lang/en/enrol_ldap.php +++ b/enrol/ldap/lang/en/enrol_ldap.php @@ -29,7 +29,7 @@ $string['autocreate'] = '

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'] = '

Select fields to update when synchronisation script is running (enrol/ldap/cli/sync.php).

When at least one field is selected an update will occur.

'; +$string['autoupdate_settings_desc'] = '

Select fields to update when synchronisation scheduled task for LDAP Enrolments is running (enrol_ldap\task\sync_enrolments).

When at least one field is selected an update will occur.

'; $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'; diff --git a/enrol/ldap/upgrade.txt b/enrol/ldap/upgrade.txt index d00991d3ebb..4607ec012b7 100644 --- a/enrol/ldap/upgrade.txt +++ b/enrol/ldap/upgrade.txt @@ -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. -- 2.43.0