[Summary view]

   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 CAS
  21   * backend in those setups where the CAS 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   *
  32   * Performance notes:
  33   * We have optimized it as best as we could for PostgreSQL and MySQL, with 27K students
  34   * we have seen this take 10 minutes.
  35   *
  36   * @package    auth_cas
  37   * @copyright  2007 Jerome Gutierrez - based on code by Martin Langhoff
  38   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   * @deprecated since Moodle 3.0 MDL-51824 - please do not use this CLI script any more, use scheduled task instead.
  40   * @todo MDL-50264 This will be deleted in Moodle 3.2.
  41   */
  42  
  43  define('CLI_SCRIPT', true);
  44  
  45  require(__DIR__.'/../../../config.php');
  46  require_once($CFG->dirroot.'/course/lib.php');
  47  require_once($CFG->libdir.'/clilib.php');
  48  
  49  // Ensure errors are well explained
  50  set_debugging(DEBUG_DEVELOPER, true);
  51  
  52  if (!is_enabled_auth('cas')) {
  53      error_log('[AUTH CAS] '.get_string('pluginnotenabled', 'auth_ldap'));
  54      die;
  55  }
  56  
  57  cli_problem('[AUTH CAS] The sync users cron has been deprecated. Please use the scheduled task instead.');
  58  
  59  // Abort execution of the CLI script if the auth_cas\task\sync_task is enabled.
  60  $task = \core\task\manager::get_scheduled_task('auth_cas\task\sync_task');
  61  if (!$task->get_disabled()) {
  62      cli_error('[AUTH CAS] The scheduled task sync_task is enabled, the cron execution has been aborted.');
  63  }
  64  
  65  $casauth = get_auth_plugin('cas');
  66  $casauth->sync_users(true);
  67