MDL-24723 prevent cron execution in CLI maintenance mode
[moodle.git] / lib / cronlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Cron functions.
20  *
21  * @package    core
22  * @subpackage admin
23  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 function cron_run() {
28     global $DB, $CFG, $OUTPUT;
30     if (CLI_MAINTENANCE) {
31         echo "CLI maintenance mode active, cron execution suspended.\n";
32         exit(1);
33     }
35     require_once($CFG->libdir.'/adminlib.php');
36     require_once($CFG->libdir.'/gradelib.php');
38     if (!empty($CFG->showcronsql)) {
39         $DB->set_debug(true);
40     }
41     if (!empty($CFG->showcrondebugging)) {
42         $CFG->debug = DEBUG_DEVELOPER;
43         $CFG->debugdisplay = true;
44     }
46     set_time_limit(0);
47     $starttime = microtime();
49 /// increase memory limit (PHP 5.2 does different calculation, we need more memory now)
50     @raise_memory_limit('128M');
52 /// emulate normal session
53     cron_setup_user();
55 /// Start output log
57     $timenow  = time();
59     mtrace("Server Time: ".date('r',$timenow)."\n\n");
62 /// Session gc
64     mtrace("Cleaning up stale sessions");
65     session_gc();
67 /// Run all cron jobs for each module
69     mtrace("Starting activity modules");
70     get_mailer('buffer');
71     if ($mods = $DB->get_records_select("modules", "cron > 0 AND ((? - lastcron) > cron) AND visible = 1", array($timenow))) {
72         foreach ($mods as $mod) {
73             $libfile = "$CFG->dirroot/mod/$mod->name/lib.php";
74             if (file_exists($libfile)) {
75                 include_once($libfile);
76                 $cron_function = $mod->name."_cron";
77                 if (function_exists($cron_function)) {
78                     mtrace("Processing module function $cron_function ...", '');
79                     $pre_dbqueries = null;
80                     $pre_dbqueries = $DB->perf_get_queries();
81                     $pre_time      = microtime(1);
82                     if ($cron_function()) {
83                         $DB->set_field("modules", "lastcron", $timenow, array("id"=>$mod->id));
84                     }
85                     if (isset($pre_dbqueries)) {
86                         mtrace("... used " . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries");
87                         mtrace("... used " . (microtime(1) - $pre_time) . " seconds");
88                     }
89                 /// Reset possible changes by modules to time_limit. MDL-11597
90                     @set_time_limit(0);
91                     mtrace("done.");
92                 }
93             }
94         }
95     }
96     get_mailer('close');
97     mtrace("Finished activity modules");
99     mtrace("Starting blocks");
100     if ($blocks = $DB->get_records_select("block", "cron > 0 AND ((? - lastcron) > cron) AND visible = 1", array($timenow))) {
101         // we will need the base class.
102         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
103         foreach ($blocks as $block) {
104             $blockfile = $CFG->dirroot.'/blocks/'.$block->name.'/block_'.$block->name.'.php';
105             if (file_exists($blockfile)) {
106                 require_once($blockfile);
107                 $classname = 'block_'.$block->name;
108                 $blockobj = new $classname;
109                 if (method_exists($blockobj,'cron')) {
110                     mtrace("Processing cron function for ".$block->name.'....','');
111                     if ($blockobj->cron()) {
112                         $DB->set_field('block', 'lastcron', $timenow, array('id'=>$block->id));
113                     }
114                 /// Reset possible changes by blocks to time_limit. MDL-11597
115                     @set_time_limit(0);
116                     mtrace('done.');
117                 }
118             }
120         }
121     }
122     mtrace('Finished blocks');
124     //now do plagiarism checks
125     require_once($CFG->libdir.'/plagiarismlib.php');
126     plagiarism_cron();
128     mtrace("Starting quiz reports");
129     if ($reports = $DB->get_records_select('quiz_report', "cron > 0 AND ((? - lastcron) > cron)", array($timenow))) {
130         foreach ($reports as $report) {
131             $cronfile = "$CFG->dirroot/mod/quiz/report/$report->name/cron.php";
132             if (file_exists($cronfile)) {
133                 include_once($cronfile);
134                 $cron_function = 'quiz_report_'.$report->name."_cron";
135                 if (function_exists($cron_function)) {
136                     mtrace("Processing quiz report cron function $cron_function ...", '');
137                     $pre_dbqueries = null;
138                     $pre_dbqueries = $DB->perf_get_queries();
139                     $pre_time      = microtime(1);
140                     if ($cron_function()) {
141                         $DB->set_field('quiz_report', "lastcron", $timenow, array("id"=>$report->id));
142                     }
143                     if (isset($pre_dbqueries)) {
144                         mtrace("... used " . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries");
145                         mtrace("... used " . (microtime(1) - $pre_time) . " seconds");
146                     }
147                     mtrace("done.");
148                 }
149             }
150         }
151     }
152     mtrace("Finished quiz reports");
154     mtrace('Starting admin reports');
155     // Admin reports do not have a database table that lists them. Instead a
156     // report includes cron.php with function report_reportname_cron() if it wishes
157     // to be cronned. It is up to cron.php to handle e.g. if it only needs to
158     // actually do anything occasionally.
159     $reports = get_plugin_list('report');
160     foreach($reports as $report => $reportdir) {
161         $cronfile = $reportdir.'/cron.php';
162         if (file_exists($cronfile)) {
163             require_once($cronfile);
164             $cronfunction = 'report_'.$report.'_cron';
165             mtrace('Processing cron function for '.$report.'...', '');
166             $pre_dbqueries = null;
167             $pre_dbqueries = $DB->perf_get_queries();
168             $pre_time      = microtime(true);
169             $cronfunction();
170             if (isset($pre_dbqueries)) {
171                 mtrace("... used " . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries");
172                 mtrace("... used " . round(microtime(true) - $pre_time, 2) . " seconds");
173             }
174             mtrace('done.');
175         }
176     }
177     mtrace('Finished admin reports');
179     mtrace('Starting main gradebook job ...');
180     grade_cron();
181     mtrace('done.');
184     mtrace('Starting processing the event queue...');
185     events_cron();
186     mtrace('done.');
189     if ($CFG->enablecompletion) {
190         // Completion cron
191         mtrace('Starting the completion cron...');
192         require_once($CFG->libdir . '/completion/cron.php');
193         completion_cron();
194         mtrace('done');
195     }
198     if ($CFG->enableportfolios) {
199         // Portfolio cron
200         mtrace('Starting the portfolio cron...');
201         require_once($CFG->libdir . '/portfoliolib.php');
202         portfolio_cron();
203         mtrace('done');
204     }
206 /// Run all core cron jobs, but not every time since they aren't too important.
207 /// These don't have a timer to reduce load, so we'll use a random number
208 /// to randomly choose the percentage of times we should run these jobs.
210     srand ((double) microtime() * 10000000);
211     $random100 = rand(0,100);
213     if ($random100 < 20) {     // Approximately 20% of the time.
214         mtrace("Running clean-up tasks...");
216         /// Delete users who haven't confirmed within required period
218         if (!empty($CFG->deleteunconfirmed)) {
219             $cuttime = $timenow - ($CFG->deleteunconfirmed * 3600);
220             $rs = $DB->get_recordset_sql ("SELECT id, firstname, lastname
221                                              FROM {user}
222                                             WHERE confirmed = 0 AND firstaccess > 0
223                                                   AND firstaccess < ?", array($cuttime));
224             foreach ($rs as $user) {
225                 if ($DB->delete_records('user', array('id'=>$user->id))) {
226                     mtrace("Deleted unconfirmed user for ".fullname($user, true)." ($user->id)");
227                 }
228             }
229             $rs->close();
230         }
231         flush();
234         /// Delete users who haven't completed profile within required period
236         if (!empty($CFG->deleteincompleteusers)) {
237             $cuttime = $timenow - ($CFG->deleteincompleteusers * 3600);
238             $rs = $DB->get_recordset_sql ("SELECT id, username
239                                              FROM {user}
240                                             WHERE confirmed = 1 AND lastaccess > 0
241                                                   AND lastaccess < ? AND deleted = 0
242                                                   AND (lastname = '' OR firstname = '' OR email = '')",
243                                           array($cuttime));
244             foreach ($rs as $user) {
245                 if (delete_user($user)) {
246                     mtrace("Deleted not fully setup user $user->username ($user->id)");
247                 }
248             }
249             $rs->close();
250         }
251         flush();
254         /// Delete old logs to save space (this might need a timer to slow it down...)
256         if (!empty($CFG->loglifetime)) {  // value in days
257             $loglifetime = $timenow - ($CFG->loglifetime * 3600 * 24);
258             if ($DB->delete_records_select("log", "time < ?", array($loglifetime))) {
259                 mtrace("Deleted old log records");
260             }
261         }
262         flush();
265         /// Delete old cached texts
267         if (!empty($CFG->cachetext)) {   // Defined in config.php
268             $cachelifetime = time() - $CFG->cachetext - 60;  // Add an extra minute to allow for really heavy sites
269             if ($DB->delete_records_select('cache_text', "timemodified < ?", array($cachelifetime))) {
270                 mtrace("Deleted old cache_text records");
271             }
272         }
273         flush();
275         if (!empty($CFG->notifyloginfailures)) {
276             notify_login_failures();
277             mtrace('Notified login failured');
278         }
279         flush();
281         //
282         // generate new password emails for users
283         //
284         mtrace('checking for create_password');
285         if ($DB->count_records('user_preferences', array('name'=>'create_password', 'value'=>'1'))) {
286             mtrace('creating passwords for new users');
287             $newusers = $DB->get_records_sql("SELECT u.id as id, u.email, u.firstname,
288                                                      u.lastname, u.username,
289                                                      p.id as prefid
290                                                 FROM {user} u
291                                                 JOIN {user_preferences} p ON u.id=p.userid
292                                                WHERE p.name='create_password' AND p.value='1' AND u.email !='' ");
294             foreach ($newusers as $newuserid => $newuser) {
295                 $newuser->emailstop = 0; // send email regardless
296                 // email user
297                 if (setnew_password_and_mail($newuser)) {
298                     // remove user pref
299                     $DB->delete_records('user_preferences', array('id'=>$newuser->prefid));
300                 } else {
301                     trigger_error("Could not create and mail new user password!");
302                 }
303             }
304         }
306         if (!empty($CFG->usetags)) {
307             require_once($CFG->dirroot.'/tag/lib.php');
308             tag_cron();
309             mtrace ('Executed tag cron');
310         }
312         // Accesslib stuff
313         cleanup_contexts();
314         mtrace ('Cleaned up contexts');
315         gc_cache_flags();
316         mtrace ('Cleaned cache flags');
317         // If you suspect that the context paths are somehow corrupt
318         // replace the line below with: build_context_path(true);
319         build_context_path();
320         mtrace ('Built context paths');
322         mtrace("Finished clean-up tasks...");
324     } // End of occasional clean-up tasks
326     // Disabled until implemented. MDL-21432, MDL-22184
327     if (1 == 2 && empty($CFG->disablescheduledbackups)) {   // Defined in config.php
328         //Execute backup's cron
329         //Perhaps a long time and memory could help in large sites
330         @set_time_limit(0);
331         @raise_memory_limit("192M");
332         if (function_exists('apache_child_terminate')) {
333             // if we are running from Apache, give httpd a hint that
334             // it can recycle the process after it's done. Apache's
335             // memory management is truly awful but we can help it.
336             @apache_child_terminate();
337         }
338         if (file_exists("$CFG->dirroot/backup/backup_scheduled.php") and
339             file_exists("$CFG->dirroot/backup/backuplib.php") and
340             file_exists("$CFG->dirroot/backup/lib.php") and
341             file_exists("$CFG->libdir/blocklib.php")) {
342             include_once("$CFG->dirroot/backup/backup_scheduled.php");
343             include_once("$CFG->dirroot/backup/backuplib.php");
344             include_once("$CFG->dirroot/backup/lib.php");
345             mtrace("Running backups if required...");
347             if (! schedule_backup_cron()) {
348                 mtrace("ERROR: Something went wrong while performing backup tasks!!!");
349             } else {
350                 mtrace("Backup tasks finished.");
351             }
352         }
353     }
355 /// Run the auth cron, if any
356 /// before enrolments because it might add users that will be needed in enrol plugins
357     $auths = get_enabled_auth_plugins();
359     mtrace("Running auth crons if required...");
360     foreach ($auths as $auth) {
361         $authplugin = get_auth_plugin($auth);
362         if (method_exists($authplugin, 'cron')) {
363             mtrace("Running cron for auth/$auth...");
364             $authplugin->cron();
365             if (!empty($authplugin->log)) {
366                 mtrace($authplugin->log);
367             }
368         }
369         unset($authplugin);
370     }
372     mtrace("Running enrol crons if required...");
373     $enrols = enrol_get_plugins(true);
374     foreach($enrols as $ename=>$enrol) {
375         // do this for all plugins, disabled plugins might want to cleanup stuff such as roles
376         if (!$enrol->is_cron_required()) {
377             continue;
378         }
379         mtrace("Running cron for enrol_$ename...");
380         $enrol->cron();
381         $enrol->set_config('lastcron', time());
382     }
384     if (!empty($CFG->enablestats) and empty($CFG->disablestatsprocessing)) {
385         require_once($CFG->dirroot.'/lib/statslib.php');
386         // check we're not before our runtime
387         $timetocheck = stats_get_base_daily() + $CFG->statsruntimestarthour*60*60 + $CFG->statsruntimestartminute*60;
389         if (time() > $timetocheck) {
390             // process configured number of days as max (defaulting to 31)
391             $maxdays = empty($CFG->statsruntimedays) ? 31 : abs($CFG->statsruntimedays);
392             if (stats_cron_daily($maxdays)) {
393                 if (stats_cron_weekly()) {
394                     if (stats_cron_monthly()) {
395                         stats_clean_old();
396                     }
397                 }
398             }
399             @set_time_limit(0);
400         } else {
401             mtrace('Next stats run after:'. userdate($timetocheck));
402         }
403     }
405     // run gradebook import/export/report cron
406     if ($gradeimports = get_plugin_list('gradeimport')) {
407         foreach ($gradeimports as $gradeimport => $plugindir) {
408             if (file_exists($plugindir.'/lib.php')) {
409                 require_once($plugindir.'/lib.php');
410                 $cron_function = 'grade_import_'.$gradeimport.'_cron';
411                 if (function_exists($cron_function)) {
412                     mtrace("Processing gradebook import function $cron_function ...", '');
413                     $cron_function();
414                 }
415             }
416         }
417     }
419     if ($gradeexports = get_plugin_list('gradeexport')) {
420         foreach ($gradeexports as $gradeexport => $plugindir) {
421             if (file_exists($plugindir.'/lib.php')) {
422                 require_once($plugindir.'/lib.php');
423                 $cron_function = 'grade_export_'.$gradeexport.'_cron';
424                 if (function_exists($cron_function)) {
425                     mtrace("Processing gradebook export function $cron_function ...", '');
426                     $cron_function();
427                 }
428             }
429         }
430     }
432     if ($gradereports = get_plugin_list('gradereport')) {
433         foreach ($gradereports as $gradereport => $plugindir) {
434             if (file_exists($plugindir.'/lib.php')) {
435                 require_once($plugindir.'/lib.php');
436                 $cron_function = 'grade_report_'.$gradereport.'_cron';
437                 if (function_exists($cron_function)) {
438                     mtrace("Processing gradebook report function $cron_function ...", '');
439                     $cron_function();
440                 }
441             }
442         }
443     }
445     // Run external blog cron if needed
446     if ($CFG->useexternalblogs) {
447         require_once($CFG->dirroot . '/blog/lib.php');
448         mtrace("Fetching external blog entries...", '');
449         $sql = "timefetched < ? OR timefetched = 0";
450         $externalblogs = $DB->get_records_select('blog_external', $sql, array(mktime() - $CFG->externalblogcrontime));
452         foreach ($externalblogs as $eb) {
453             blog_sync_external_entries($eb);
454         }
455     }
457     // Run blog associations cleanup
458     if ($CFG->useblogassociations) {
459         require_once($CFG->dirroot . '/blog/lib.php');
460         // delete entries whose contextids no longer exists
461         mtrace("Deleting blog associations linked to non-existent contexts...", '');
462         $DB->delete_records_select('blog_association', 'contextid NOT IN (SELECT id FROM {context})');
463     }
465     //Run registration updated cron
466     mtrace(get_string('siteupdatesstart', 'hub'));
467     require_once($CFG->dirroot . '/admin/registration/lib.php');
468     $registrationmanager = new registration_manager();
469     $registrationmanager->cron();
470     mtrace(get_string('siteupdatesend', 'hub'));
472     // cleanup file trash
473     $fs = get_file_storage();
474     $fs->cron();
476     //cleanup old session linked tokens
477     //deletes the session linked tokens that are over a day old.
478     mtrace("Deleting session linked tokens more than one day old...", '');
479     $DB->delete_records_select('external_tokens', 'lastaccess < :onedayago AND tokentype = :tokentype',
480                     array('onedayago' => time() - DAYSECS, 'tokentype' => EXTERNAL_TOKEN_EMBEDDED));
481     mtrace('done.');
483     // run any customized cronjobs, if any
484     if ($locals = get_plugin_list('local')) {
485         mtrace('Processing customized cron scripts ...', '');
486         foreach ($locals as $local => $localdir) {
487             if (file_exists("$localdir/cron.php")) {
488                 include("$localdir/cron.php");
489             }
490         }
491         mtrace('done.');
492     }
495     mtrace("Cron script completed correctly");
497     $difftime = microtime_diff($starttime, microtime());
498     mtrace("Execution took ".$difftime." seconds");