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