admin/cron.php

   1 <?php // $Id$
   2
   3 /// This script looks through all the module directories for cron.php files
   4 /// and runs them.  These files can contain cleanup functions, email functions
   5 /// or anything that needs to be run on a regular basis.
   6 ///
   7 /// This file is best run from cron on the host system (ie outside PHP).
   8 /// The script can either be invoked via the web server or via a standalone
   9 /// version of PHP compiled for CGI.
  10 ///
  11 /// eg   wget -q -O /dev/null 'http://moodle.somewhere.edu/admin/cron.php'
  12 /// or   php /web/moodle/admin/cron.php
  13     set_time_limit(0);
  14     $starttime = microtime();
  15
  16 /// The following is a hack necessary to allow this script to work well
  17 /// from the command line.
  18
  19     define('FULLME', 'cron');
  20
  21
  22 /// Do not set moodle cookie because we do not need it here, it is better to emulate session
  23     $nomoodlecookie = true;
  24
  25 /// The current directory in PHP version 4.3.0 and above isn't necessarily the
  26 /// directory of the script when run from the command line. The require_once()
  27 /// would fail, so we'll have to chdir()
  28
  29     if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
  30         chdir(dirname($_SERVER['argv'][0]));
  31     }
  32
  33     require_once(dirname(__FILE__) . '/../config.php');
  34     require_once($CFG->libdir.'/adminlib.php');
  35     require_once($CFG->libdir.'/gradelib.php');
  36
  37 /// Extra debugging (set in config.php)
  38     if (!empty($CFG->showcronsql)) {
  39         $db->debug = true;
  40     }
  41     if (!empty($CFG->showcrondebugging)) {
  42         $CFG->debug = DEBUG_DEVELOPER;
  43         $CFG->debugdisplay = true;
  44     }
  45
  46 /// extra safety
  47     @session_write_close();
  48
  49 /// check if execution allowed
  50     if (isset($_SERVER['REMOTE_ADDR'])) { // if the script is accessed via the web.
  51         if (!empty($CFG->cronclionly)) {
  52             // This script can only be run via the cli.
  53             print_error('cronerrorclionly', 'admin');
  54             exit;
  55         }
  56         // This script is being called via the web, so check the password if there is one.
  57         if (!empty($CFG->cronremotepassword)) {
  58             $pass = optional_param('password', '', PARAM_RAW);
  59             if($pass != $CFG->cronremotepassword) {
  60                 // wrong password.
  61                 print_error('cronerrorpassword', 'admin');
  62                 exit;
  63             }
  64         }
  65     }
  66
  67
  68 /// emulate normal session
  69     $SESSION = new object();
  70     $USER = get_admin();      /// Temporarily, to provide environment for this script
  71
  72 /// ignore admins timezone, language and locale - use site deafult instead!
  73     $USER->timezone = $CFG->timezone;
  74     $USER->lang = '';
  75     $USER->theme = '';
  76     course_setup(SITEID);
  77
  78 /// send mime type and encoding
  79     if (check_browser_version('MSIE')) {
  80         //ugly IE hack to work around downloading instead of viewing
  81         @header('Content-Type: text/html; charset=utf-8');
  82         echo "<xmp>"; //<pre> is not good enough for us here
  83     } else {
  84         //send proper plaintext header
  85         @header('Content-Type: text/plain; charset=utf-8');
  86     }
  87
  88 /// no more headers and buffers
  89     while(@ob_end_flush());
  90
  91 /// increase memory limit (PHP 5.2 does different calculation, we need more memory now)
  92     @raise_memory_limit('128M');
  93
  94 /// Start output log
  95
  96     $timenow  = time();
  97
  98     mtrace("Server Time: ".date('r',$timenow)."\n\n");
  99
 100 /// Run all cron jobs for each module
 101
 102     mtrace("Starting activity modules");
 103     get_mailer('buffer');
 104     if ($mods = get_records_select("modules", "cron > 0 AND (($timenow - lastcron) > cron) AND visible = 1 ")) {
 105         foreach ($mods as $mod) {
 106             $libfile = "$CFG->dirroot/mod/$mod->name/lib.php";
 107             if (file_exists($libfile)) {
 108                 include_once($libfile);
 109                 $cron_function = $mod->name."_cron";
 110                 if (function_exists($cron_function)) {
 111                     mtrace("Processing module function $cron_function ...", '');
 112                     $pre_dbqueries = null;
 113                     if (!empty($PERF->dbqueries)) {
 114                         $pre_dbqueries = $PERF->dbqueries;
 115                         $pre_time      = microtime(1);
 116                     }
 117                     if ($cron_function()) {
 118                         if (! set_field("modules", "lastcron", $timenow, "id", $mod->id)) {
 119                             mtrace("Error: could not update timestamp for $mod->fullname");
 120                         }
 121                     }
 122                     if (isset($pre_dbqueries)) {
 123                         mtrace("... used " . ($PERF->dbqueries - $pre_dbqueries) . " dbqueries");
 124                         mtrace("... used " . (microtime(1) - $pre_time) . " seconds");
 125                     }
 126                 /// Reset possible changes by modules to time_limit. MDL-11597
 127                     @set_time_limit(0);
 128                     mtrace("done.");
 129                 }
 130             }
 131         }
 132     }
 133     get_mailer('close');
 134     mtrace("Finished activity modules");
 135
 136     mtrace("Starting blocks");
 137     if ($blocks = get_records_select("block", "cron > 0 AND (($timenow - lastcron) > cron) AND visible = 1")) {
 138         // we will need the base class.
 139         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
 140         foreach ($blocks as $block) {
 141             $blockfile = $CFG->dirroot.'/blocks/'.$block->name.'/block_'.$block->name.'.php';
 142             if (file_exists($blockfile)) {
 143                 require_once($blockfile);
 144                 $classname = 'block_'.$block->name;
 145                 $blockobj = new $classname;
 146                 if (method_exists($blockobj,'cron')) {
 147                     mtrace("Processing cron function for ".$block->name.'....','');
 148                     if ($blockobj->cron()) {
 149                         if (!set_field('block','lastcron',$timenow,'id',$block->id)) {
 150                             mtrace('Error: could not update timestamp for '.$block->name);
 151                         }
 152                     }
 153                 /// Reset possible changes by blocks to time_limit. MDL-11597
 154                     @set_time_limit(0);
 155                     mtrace('done.');
 156                 }
 157             }
 158
 159         }
 160     }
 161     mtrace('Finished blocks');
 162
 163     mtrace('Starting admin reports');
 164     // Admin reports do not have a database table that lists them. Instead a
 165     // report includes cron.php with function report_reportname_cron() if it wishes
 166     // to be cronned. It is up to cron.php to handle e.g. if it only needs to
 167     // actually do anything occasionally.
 168     $reports = get_list_of_plugins($CFG->admin.'/report');
 169     foreach($reports as $report) {
 170         $cronfile = $CFG->dirroot.'/'.$CFG->admin.'/report/'.$report.'/cron.php';
 171         if (file_exists($cronfile)) {
 172             require_once($cronfile);
 173             $cronfunction = 'report_'.$report.'_cron';
 174             mtrace('Processing cron function for '.$report.'...', '');
 175             $pre_dbqueries = null;
 176             if (!empty($PERF->dbqueries)) {
 177                 $pre_dbqueries = $PERF->dbqueries;
 178                 $pre_time      = microtime(true);
 179             }
 180             $cronfunction();
 181             if (isset($pre_dbqueries)) {
 182                 mtrace("... used " . ($PERF->dbqueries - $pre_dbqueries) . " dbqueries");
 183                 mtrace("... used " . round(microtime(true) - $pre_time, 2) . " seconds");
 184             }
 185             mtrace('done.');
 186         }
 187     }
 188     mtrace('Finished admin reports');
 189
 190     if (!empty($CFG->langcache)) {
 191         mtrace('Updating languages cache');
 192         get_list_of_languages(true);
 193     }
 194
 195     mtrace('Removing expired enrolments ...', '');     // See MDL-8785
 196     $timenow = time();
 197     $somefound = false;
 198     // The preferred way saves memory, dmllib.php
 199     // find courses where limited enrolment is enabled
 200     global $CFG;
 201     $rs_enrol = get_recordset_sql("SELECT ra.roleid, ra.userid, ra.contextid
 202         FROM {$CFG->prefix}course c
 203         INNER JOIN {$CFG->prefix}context cx ON cx.instanceid = c.id
 204         INNER JOIN {$CFG->prefix}role_assignments ra ON ra.contextid = cx.id
 205         WHERE cx.contextlevel = '".CONTEXT_COURSE."'
 206         AND ra.timeend > 0
 207         AND ra.timeend < '$timenow'
 208         AND c.enrolperiod > 0
 209         ");
 210     while ($oldenrolment = rs_fetch_next_record($rs_enrol)) {
 211         role_unassign($oldenrolment->roleid, $oldenrolment->userid, 0, $oldenrolment->contextid);
 212         $somefound = true;
 213     }
 214     rs_close($rs_enrol);
 215     if($somefound) {
 216         mtrace('Done');
 217     } else {
 218         mtrace('none found');
 219     }
 220
 221
 222     mtrace('Starting main gradebook job ...');
 223     grade_cron();
 224     mtrace('done.');
 225
 226     mtrace('Starting processing the event queue...');
 227     events_cron();
 228     mtrace('done.');
 229
 230 /// Run all core cron jobs, but not every time since they aren't too important.
 231 /// These don't have a timer to reduce load, so we'll use a random number
 232 /// to randomly choose the percentage of times we should run these jobs.
 233
 234     srand ((double) microtime() * 10000000);
 235     $random100 = rand(0,100);
 236
 237     if ($random100 < 20) {     // Approximately 20% of the time.
 238         mtrace("Running clean-up tasks...");
 239
 240         /// Unenrol users who haven't logged in for $CFG->longtimenosee
 241
 242         if ($CFG->longtimenosee) { // value in days
 243             $cuttime = $timenow - ($CFG->longtimenosee * 3600 * 24);
 244             $rs = get_recordset_sql ("SELECT id, userid, courseid
 245                                         FROM {$CFG->prefix}user_lastaccess
 246                                        WHERE courseid != ".SITEID."
 247                                          AND timeaccess < $cuttime ");
 248             while ($assign = rs_fetch_next_record($rs)) {
 249                 if ($context = get_context_instance(CONTEXT_COURSE, $assign->courseid)) {
 250                     if (role_unassign(0, $assign->userid, 0, $context->id)) {
 251                         mtrace("removing user $assign->userid from course $assign->courseid as they have not accessed the course for over $CFG->longtimenosee days");
 252                     }
 253                 }
 254             }
 255             rs_close($rs);
 256         /// Execute the same query again, looking for remaining records and deleting them
 257         /// if the user hasn't moodle/course:view in the CONTEXT_COURSE context (orphan records)
 258             $rs = get_recordset_sql ("SELECT id, userid, courseid
 259                                         FROM {$CFG->prefix}user_lastaccess
 260                                        WHERE courseid != ".SITEID."
 261                                          AND timeaccess < $cuttime ");
 262             while ($assign = rs_fetch_next_record($rs)) {
 263                 if ($context = get_context_instance(CONTEXT_COURSE, $assign->courseid)) {
 264                     if (!has_capability('moodle/course:view', $context, $assign->userid)) {
 265                         delete_records('user_lastaccess', 'userid', $assign->userid, 'courseid', $assign->courseid);
 266                         mtrace("Deleted orphan user_lastaccess for user $assign->userid from course $assign->courseid");
 267                     }
 268                 }
 269             }
 270             rs_close($rs);
 271         }
 272         flush();
 273
 274
 275         /// Delete users who haven't confirmed within required period
 276
 277         if (!empty($CFG->deleteunconfirmed)) {
 278             $cuttime = $timenow - ($CFG->deleteunconfirmed * 3600);
 279             $rs = get_recordset_sql ("SELECT id, firstname, lastname
 280                                         FROM {$CFG->prefix}user
 281                                        WHERE confirmed = 0
 282                                          AND firstaccess > 0
 283                                          AND firstaccess < $cuttime");
 284             while ($user = rs_fetch_next_record($rs)) {
 285                 if (delete_records('user', 'id', $user->id)) {
 286                     mtrace("Deleted unconfirmed user for ".fullname($user, true)." ($user->id)");
 287                 }
 288             }
 289             rs_close($rs);
 290         }
 291         flush();
 292
 293
 294         /// Delete users who haven't completed profile within required period
 295
 296         if (!empty($CFG->deleteincompleteusers)) {
 297             $cuttime = $timenow - ($CFG->deleteincompleteusers * 3600);
 298             $rs = get_recordset_sql ("SELECT id, username
 299                                         FROM {$CFG->prefix}user
 300                                        WHERE confirmed = 1
 301                                          AND lastaccess > 0
 302                                          AND lastaccess < $cuttime
 303                                          AND deleted = 0
 304                                          AND (lastname = '' OR firstname = '' OR email = '')");
 305             while ($user = rs_fetch_next_record($rs)) {
 306                 if (delete_user($user)) {
 307                     mtrace("Deleted not fully setup user $user->username ($user->id)");
 308                 }
 309             }
 310             rs_close($rs);
 311         }
 312         flush();
 313
 314
 315         /// Delete old logs to save space (this might need a timer to slow it down...)
 316
 317         if (!empty($CFG->loglifetime)) {  // value in days
 318             $loglifetime = $timenow - ($CFG->loglifetime * 3600 * 24);
 319             if (delete_records_select("log", "time < '$loglifetime'")) {
 320                 mtrace("Deleted old log records");
 321             }
 322         }
 323         flush();
 324
 325
 326         /// Delete old cached texts
 327
 328         if (!empty($CFG->cachetext)) {   // Defined in config.php
 329             $cachelifetime = time() - $CFG->cachetext - 60;  // Add an extra minute to allow for really heavy sites
 330             if (delete_records_select('cache_text', "timemodified < '$cachelifetime'")) {
 331                 mtrace("Deleted old cache_text records");
 332             }
 333         }
 334         flush();
 335
 336         if (!empty($CFG->notifyloginfailures)) {
 337             notify_login_failures();
 338             mtrace('Notified login failured');
 339         }
 340         flush();
 341
 342         sync_metacourses();
 343         mtrace('Synchronised metacourses');
 344
 345         //
 346         // generate new password emails for users
 347         //
 348         mtrace('checking for create_password');
 349         if (count_records('user_preferences', 'name', 'create_password', 'value', '1')) {
 350             mtrace('creating passwords for new users');
 351             $newusers = get_records_sql("SELECT  u.id as id, u.email, u.firstname,
 352                                                 u.lastname, u.username,
 353                                                 p.id as prefid
 354                                         FROM {$CFG->prefix}user u
 355                                              JOIN {$CFG->prefix}user_preferences p ON u.id=p.userid
 356                                         WHERE p.name='create_password' AND p.value='1' AND u.email !='' ");
 357
 358             foreach ($newusers as $newuserid => $newuser) {
 359                 $newuser->emailstop = 0; // send email regardless
 360                 // email user
 361                 if (setnew_password_and_mail($newuser)) {
 362                     // remove user pref
 363                     delete_records('user_preferences', 'id', $newuser->prefid);
 364                 } else {
 365                     trigger_error("Could not create and mail new user password!");
 366                 }
 367             }
 368         }
 369
 370         if (!empty($CFG->usetags)) {
 371             require_once($CFG->dirroot.'/tag/lib.php');
 372             tag_cron();
 373             mtrace ('Executed tag cron');
 374         }
 375
 376         // Accesslib stuff
 377         cleanup_contexts();
 378         mtrace ('Cleaned up contexts');
 379         gc_cache_flags();
 380         mtrace ('Cleaned cache flags');
 381         // If you suspect that the context paths are somehow corrupt
 382         // replace the line below with: build_context_path(true);
 383         build_context_path();
 384         mtrace ('Built context paths');
 385
 386         mtrace("Finished clean-up tasks...");
 387
 388     } // End of occasional clean-up tasks
 389
 390
 391     if (empty($CFG->disablescheduledbackups)) {   // Defined in config.php
 392         //Execute backup's cron
 393         //Perhaps a long time and memory could help in large sites
 394         @set_time_limit(0);
 395         @raise_memory_limit("192M");
 396         if (function_exists('apache_child_terminate')) {
 397             // if we are running from Apache, give httpd a hint that
 398             // it can recycle the process after it's done. Apache's
 399             // memory management is truly awful but we can help it.
 400             @apache_child_terminate();
 401         }
 402         if (file_exists("$CFG->dirroot/backup/backup_scheduled.php") and
 403             file_exists("$CFG->dirroot/backup/backuplib.php") and
 404             file_exists("$CFG->dirroot/backup/lib.php") and
 405             file_exists("$CFG->libdir/blocklib.php")) {
 406             include_once("$CFG->dirroot/backup/backup_scheduled.php");
 407             include_once("$CFG->dirroot/backup/backuplib.php");
 408             include_once("$CFG->dirroot/backup/lib.php");
 409             require_once ("$CFG->libdir/blocklib.php");
 410             mtrace("Running backups if required...");
 411
 412             if (! schedule_backup_cron()) {
 413                 mtrace("ERROR: Something went wrong while performing backup tasks!!!");
 414             } else {
 415                 mtrace("Backup tasks finished.");
 416             }
 417         }
 418     }
 419
 420     if (!empty($CFG->enablerssfeeds)) {  //Defined in admin/variables page
 421         include_once("$CFG->libdir/rsslib.php");
 422         mtrace("Running rssfeeds if required...");
 423
 424         if ( ! cron_rss_feeds()) {
 425             mtrace("Something went wrong while generating rssfeeds!!!");
 426         } else {
 427             mtrace("Rssfeeds finished");
 428         }
 429     }
 430
 431 /// Run the auth cron, if any
 432 /// before enrolments because it might add users that will be needed in enrol plugins
 433     $auths = get_enabled_auth_plugins();
 434
 435     mtrace("Running auth crons if required...");
 436     foreach ($auths as $auth) {
 437         $authplugin = get_auth_plugin($auth);
 438         if (method_exists($authplugin, 'cron')) {
 439             mtrace("Running cron for auth/$auth...");
 440             $authplugin->cron();
 441             if (!empty($authplugin->log)) {
 442                 mtrace($authplugin->log);
 443             }
 444         }
 445         unset($authplugin);
 446     }
 447
 448 /// Run the enrolment cron, if any
 449     if (!($plugins = explode(',', $CFG->enrol_plugins_enabled))) {
 450         $plugins = array($CFG->enrol);
 451     }
 452     require_once($CFG->dirroot .'/enrol/enrol.class.php');
 453     foreach ($plugins as $p) {
 454         $enrol = enrolment_factory::factory($p);
 455         if (method_exists($enrol, 'cron')) {
 456             $enrol->cron();
 457         }
 458         if (!empty($enrol->log)) {
 459             mtrace($enrol->log);
 460         }
 461         unset($enrol);
 462     }
 463
 464     if (!empty($CFG->enablestats) and empty($CFG->disablestatsprocessing)) {
 465         require_once($CFG->dirroot.'/lib/statslib.php');
 466         // check we're not before our runtime
 467         $timetocheck = stats_get_base_daily() + $CFG->statsruntimestarthour*60*60 + $CFG->statsruntimestartminute*60;
 468
 469         if (time() > $timetocheck) {
 470             // process configured number of days as max (defaulting to 31)
 471             $maxdays = empty($CFG->statsruntimedays) ? 31 : abs($CFG->statsruntimedays);
 472             if (stats_cron_daily($maxdays)) {
 473                 if (stats_cron_weekly()) {
 474                     if (stats_cron_monthly()) {
 475                         stats_clean_old();
 476                     }
 477                 }
 478             }
 479             @set_time_limit(0);
 480         } else {
 481             mtrace('Next stats run after:'. userdate($timetocheck));
 482         }
 483     }
 484
 485     // run gradebook import/export/report cron
 486     if ($gradeimports = get_list_of_plugins('grade/import')) {
 487         foreach ($gradeimports as $gradeimport) {
 488             if (file_exists($CFG->dirroot.'/grade/import/'.$gradeimport.'/lib.php')) {
 489                 require_once($CFG->dirroot.'/grade/import/'.$gradeimport.'/lib.php');
 490                 $cron_function = 'grade_import_'.$gradeimport.'_cron';
 491                 if (function_exists($cron_function)) {
 492                     mtrace("Processing gradebook import function $cron_function ...", '');
 493                     $cron_function();
 494                 }
 495             }
 496         }
 497     }
 498
 499     if ($gradeexports = get_list_of_plugins('grade/export')) {
 500         foreach ($gradeexports as $gradeexport) {
 501             if (file_exists($CFG->dirroot.'/grade/export/'.$gradeexport.'/lib.php')) {
 502                 require_once($CFG->dirroot.'/grade/export/'.$gradeexport.'/lib.php');
 503                 $cron_function = 'grade_export_'.$gradeexport.'_cron';
 504                 if (function_exists($cron_function)) {
 505                     mtrace("Processing gradebook export function $cron_function ...", '');
 506                     $cron_function();
 507                 }
 508             }
 509         }
 510     }
 511
 512     if ($gradereports = get_list_of_plugins('grade/report')) {
 513         foreach ($gradereports as $gradereport) {
 514             if (file_exists($CFG->dirroot.'/grade/report/'.$gradereport.'/lib.php')) {
 515                 require_once($CFG->dirroot.'/grade/report/'.$gradereport.'/lib.php');
 516                 $cron_function = 'grade_report_'.$gradereport.'_cron';
 517                 if (function_exists($cron_function)) {
 518                     mtrace("Processing gradebook report function $cron_function ...", '');
 519                     $cron_function();
 520                 }
 521             }
 522         }
 523     }
 524
 525     // run any customized cronjobs, if any
 526     // looking for functions in lib/local/cron.php
 527     if (file_exists($CFG->dirroot.'/local/cron.php')) {
 528         mtrace('Processing customized cron script ...', '');
 529         include_once($CFG->dirroot.'/local/cron.php');
 530         mtrace('done.');
 531     }
 532
 533
 534     //Unset session variables and destroy it
 535     @session_unset();
 536     @session_destroy();
 537
 538     mtrace("Cron script completed correctly");
 539
 540     $difftime = microtime_diff($starttime, microtime());
 541     mtrace("Execution took ".$difftime." seconds");
 542
 543 /// finish the IE hack
 544     if (check_browser_version('MSIE')) {
 545         echo "</xmp>";
 546     }
 547
 548 ?>