MDL-14679 fixed remaining old style set_field()s
[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     mtrace("Starting quiz reports");
120     if ($reports = $DB->get_records_select('quiz_report', "cron > 0 AND ((? - lastcron) > cron)", array($timenow))) {
121         foreach ($reports as $report) {
122             $cronfile = "$CFG->dirroot/mod/quiz/report/$report->name/cron.php";
123             if (file_exists($cronfile)) {
124                 include_once($cronfile);
125                 $cron_function = 'quiz_report_'.$report->name."_cron";
126                 if (function_exists($cron_function)) {
127                     mtrace("Processing quiz report cron function $cron_function ...", '');
128                     $pre_dbqueries = null;
129                     $pre_dbqueries = $DB->perf_get_queries();
130                     $pre_time      = microtime(1);
131                     if ($cron_function()) {
132                         $DB->set_field('quiz_report', "lastcron", $timenow, array("id"=>$report->id));
133                     }
134                     if (isset($pre_dbqueries)) {
135                         mtrace("... used " . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries");
136                         mtrace("... used " . (microtime(1) - $pre_time) . " seconds");
137                     }
138                     mtrace("done.");
139                 }
140             }
141         }
142     }
143     mtrace("Finished quiz reports");
145     mtrace('Starting admin reports');
146     // Admin reports do not have a database table that lists them. Instead a
147     // report includes cron.php with function report_reportname_cron() if it wishes
148     // to be cronned. It is up to cron.php to handle e.g. if it only needs to
149     // actually do anything occasionally.
150     $reports = get_plugin_list('report');
151     foreach($reports as $report => $reportdir) {
152         $cronfile = $reportdir.'/cron.php';
153         if (file_exists($cronfile)) {
154             require_once($cronfile);
155             $cronfunction = 'report_'.$report.'_cron';
156             mtrace('Processing cron function for '.$report.'...', '');
157             $pre_dbqueries = null;
158             $pre_dbqueries = $DB->perf_get_queries();
159             $pre_time      = microtime(true);
160             $cronfunction();
161             if (isset($pre_dbqueries)) {
162                 mtrace("... used " . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries");
163                 mtrace("... used " . round(microtime(true) - $pre_time, 2) . " seconds");
164             }
165             mtrace('done.');
166         }
167     }
168     mtrace('Finished admin reports');
170     mtrace('Starting main gradebook job ...');
171     grade_cron();
172     mtrace('done.');
175     mtrace('Starting processing the event queue...');
176     events_cron();
177     mtrace('done.');
180     if ($CFG->enablecompletion) {
181         // Completion cron
182         mtrace('Starting the completion cron...');
183         require_once($CFG->libdir . '/completion/cron.php');
184         completion_cron();
185         mtrace('done');
186     }
189     if ($CFG->enableportfolios) {
190         // Portfolio cron
191         mtrace('Starting the portfolio cron...');
192         require_once($CFG->libdir . '/portfoliolib.php');
193         portfolio_cron();
194         mtrace('done');
195     }
197 /// Run all core cron jobs, but not every time since they aren't too important.
198 /// These don't have a timer to reduce load, so we'll use a random number
199 /// to randomly choose the percentage of times we should run these jobs.
201     srand ((double) microtime() * 10000000);
202     $random100 = rand(0,100);
204     if ($random100 < 20) {     // Approximately 20% of the time.
205         mtrace("Running clean-up tasks...");
207         /// Delete users who haven't confirmed within required period
209         if (!empty($CFG->deleteunconfirmed)) {
210             $cuttime = $timenow - ($CFG->deleteunconfirmed * 3600);
211             $rs = $DB->get_recordset_sql ("SELECT id, firstname, lastname
212                                              FROM {user}
213                                             WHERE confirmed = 0 AND firstaccess > 0
214                                                   AND firstaccess < ?", array($cuttime));
215             foreach ($rs as $user) {
216                 if ($DB->delete_records('user', array('id'=>$user->id))) {
217                     mtrace("Deleted unconfirmed user for ".fullname($user, true)." ($user->id)");
218                 }
219             }
220             $rs->close();
221         }
222         flush();
225         /// Delete users who haven't completed profile within required period
227         if (!empty($CFG->deleteincompleteusers)) {
228             $cuttime = $timenow - ($CFG->deleteincompleteusers * 3600);
229             $rs = $DB->get_recordset_sql ("SELECT id, username
230                                              FROM {user}
231                                             WHERE confirmed = 1 AND lastaccess > 0
232                                                   AND lastaccess < ? AND deleted = 0
233                                                   AND (lastname = '' OR firstname = '' OR email = '')",
234                                           array($cuttime));
235             foreach ($rs as $user) {
236                 if (delete_user($user)) {
237                     mtrace("Deleted not fully setup user $user->username ($user->id)");
238                 }
239             }
240             $rs->close();
241         }
242         flush();
245         /// Delete old logs to save space (this might need a timer to slow it down...)
247         if (!empty($CFG->loglifetime)) {  // value in days
248             $loglifetime = $timenow - ($CFG->loglifetime * 3600 * 24);
249             if ($DB->delete_records_select("log", "time < ?", array($loglifetime))) {
250                 mtrace("Deleted old log records");
251             }
252         }
253         flush();
256         /// Delete old cached texts
258         if (!empty($CFG->cachetext)) {   // Defined in config.php
259             $cachelifetime = time() - $CFG->cachetext - 60;  // Add an extra minute to allow for really heavy sites
260             if ($DB->delete_records_select('cache_text', "timemodified < ?", array($cachelifetime))) {
261                 mtrace("Deleted old cache_text records");
262             }
263         }
264         flush();
266         if (!empty($CFG->notifyloginfailures)) {
267             notify_login_failures();
268             mtrace('Notified login failured');
269         }
270         flush();
272         //
273         // generate new password emails for users
274         //
275         mtrace('checking for create_password');
276         if ($DB->count_records('user_preferences', array('name'=>'create_password', 'value'=>'1'))) {
277             mtrace('creating passwords for new users');
278             $newusers = $DB->get_records_sql("SELECT u.id as id, u.email, u.firstname,
279                                                      u.lastname, u.username,
280                                                      p.id as prefid
281                                                 FROM {user} u
282                                                 JOIN {user_preferences} p ON u.id=p.userid
283                                                WHERE p.name='create_password' AND p.value='1' AND u.email !='' ");
285             foreach ($newusers as $newuserid => $newuser) {
286                 $newuser->emailstop = 0; // send email regardless
287                 // email user
288                 if (setnew_password_and_mail($newuser)) {
289                     // remove user pref
290                     $DB->delete_records('user_preferences', array('id'=>$newuser->prefid));
291                 } else {
292                     trigger_error("Could not create and mail new user password!");
293                 }
294             }
295         }
297         if (!empty($CFG->usetags)) {
298             require_once($CFG->dirroot.'/tag/lib.php');
299             tag_cron();
300             mtrace ('Executed tag cron');
301         }
303         // Accesslib stuff
304         cleanup_contexts();
305         mtrace ('Cleaned up contexts');
306         gc_cache_flags();
307         mtrace ('Cleaned cache flags');
308         // If you suspect that the context paths are somehow corrupt
309         // replace the line below with: build_context_path(true);
310         build_context_path();
311         mtrace ('Built context paths');
313         mtrace("Finished clean-up tasks...");
315     } // End of occasional clean-up tasks
317     // Disabled until implemented. MDL-21432, MDL-22184
318     if (1 == 2 && empty($CFG->disablescheduledbackups)) {   // Defined in config.php
319         //Execute backup's cron
320         //Perhaps a long time and memory could help in large sites
321         @set_time_limit(0);
322         @raise_memory_limit("192M");
323         if (function_exists('apache_child_terminate')) {
324             // if we are running from Apache, give httpd a hint that
325             // it can recycle the process after it's done. Apache's
326             // memory management is truly awful but we can help it.
327             @apache_child_terminate();
328         }
329         if (file_exists("$CFG->dirroot/backup/backup_scheduled.php") and
330             file_exists("$CFG->dirroot/backup/backuplib.php") and
331             file_exists("$CFG->dirroot/backup/lib.php") and
332             file_exists("$CFG->libdir/blocklib.php")) {
333             include_once("$CFG->dirroot/backup/backup_scheduled.php");
334             include_once("$CFG->dirroot/backup/backuplib.php");
335             include_once("$CFG->dirroot/backup/lib.php");
336             mtrace("Running backups if required...");
338             if (! schedule_backup_cron()) {
339                 mtrace("ERROR: Something went wrong while performing backup tasks!!!");
340             } else {
341                 mtrace("Backup tasks finished.");
342             }
343         }
344     }
346 /// Run the auth cron, if any
347 /// before enrolments because it might add users that will be needed in enrol plugins
348     $auths = get_enabled_auth_plugins();
350     mtrace("Running auth crons if required...");
351     foreach ($auths as $auth) {
352         $authplugin = get_auth_plugin($auth);
353         if (method_exists($authplugin, 'cron')) {
354             mtrace("Running cron for auth/$auth...");
355             $authplugin->cron();
356             if (!empty($authplugin->log)) {
357                 mtrace($authplugin->log);
358             }
359         }
360         unset($authplugin);
361     }
363     mtrace("Running enrol crons if required...");
364     $enrols = enrol_get_plugins(true);
365     foreach($enrols as $ename=>$enrol) {
366         // do this for all plugins, disabled plugins might want to cleanup stuff such as roles
367         if (!$enrol->is_cron_required()) {
368             continue;
369         }
370         mtrace("Running cron for enrol_$ename...");
371         $enrol->cron();
372         $enrol->set_config('lastcron', time());
373     }
375     if (!empty($CFG->enablestats) and empty($CFG->disablestatsprocessing)) {
376         require_once($CFG->dirroot.'/lib/statslib.php');
377         // check we're not before our runtime
378         $timetocheck = stats_get_base_daily() + $CFG->statsruntimestarthour*60*60 + $CFG->statsruntimestartminute*60;
380         if (time() > $timetocheck) {
381             // process configured number of days as max (defaulting to 31)
382             $maxdays = empty($CFG->statsruntimedays) ? 31 : abs($CFG->statsruntimedays);
383             if (stats_cron_daily($maxdays)) {
384                 if (stats_cron_weekly()) {
385                     if (stats_cron_monthly()) {
386                         stats_clean_old();
387                     }
388                 }
389             }
390             @set_time_limit(0);
391         } else {
392             mtrace('Next stats run after:'. userdate($timetocheck));
393         }
394     }
396     // run gradebook import/export/report cron
397     if ($gradeimports = get_plugin_list('gradeimport')) {
398         foreach ($gradeimports as $gradeimport => $plugindir) {
399             if (file_exists($plugindir.'/lib.php')) {
400                 require_once($plugindir.'/lib.php');
401                 $cron_function = 'grade_import_'.$gradeimport.'_cron';
402                 if (function_exists($cron_function)) {
403                     mtrace("Processing gradebook import function $cron_function ...", '');
404                     $cron_function();
405                 }
406             }
407         }
408     }
410     if ($gradeexports = get_plugin_list('gradeexport')) {
411         foreach ($gradeexports as $gradeexport => $plugindir) {
412             if (file_exists($plugindir.'/lib.php')) {
413                 require_once($plugindir.'/lib.php');
414                 $cron_function = 'grade_export_'.$gradeexport.'_cron';
415                 if (function_exists($cron_function)) {
416                     mtrace("Processing gradebook export function $cron_function ...", '');
417                     $cron_function();
418                 }
419             }
420         }
421     }
423     if ($gradereports = get_plugin_list('gradereport')) {
424         foreach ($gradereports as $gradereport => $plugindir) {
425             if (file_exists($plugindir.'/lib.php')) {
426                 require_once($plugindir.'/lib.php');
427                 $cron_function = 'grade_report_'.$gradereport.'_cron';
428                 if (function_exists($cron_function)) {
429                     mtrace("Processing gradebook report function $cron_function ...", '');
430                     $cron_function();
431                 }
432             }
433         }
434     }
436     // Run external blog cron if needed
437     if ($CFG->useexternalblogs) {
438         require_once($CFG->dirroot . '/blog/lib.php');
439         mtrace("Fetching external blog entries...", '');
440         $sql = "timefetched < ? OR timefetched = 0";
441         $externalblogs = $DB->get_records_select('blog_external', $sql, array(mktime() - $CFG->externalblogcrontime));
443         foreach ($externalblogs as $eb) {
444             blog_sync_external_entries($eb);
445         }
446     }
448     // Run blog associations cleanup
449     if ($CFG->useblogassociations) {
450         require_once($CFG->dirroot . '/blog/lib.php');
451         // delete entries whose contextids no longer exists
452         mtrace("Deleting blog associations linked to non-existent contexts...", '');
453         $DB->delete_records_select('blog_association', 'contextid NOT IN (SELECT id FROM {context})');
454     }
456     //Run registration updated cron
457     mtrace(get_string('siteupdatesstart', 'hub'));
458     require_once($CFG->dirroot . '/admin/registration/lib.php');
459     $registrationmanager = new registration_manager();
460     $registrationmanager->cron();
461     mtrace(get_string('siteupdatesend', 'hub'));
463     // cleanup file trash
464     $fs = get_file_storage();
465     $fs->cron();
467     //cleanup old session linked tokens
468     //deletes the session linked tokens that are over a day old.
469     mtrace("Deleting session linked tokens more than one day old...", '');
470     $DB->delete_records_select('external_tokens', 'lastaccess < :onedayago AND tokentype = :tokentype',
471                     array('onedayago' => time() - DAYSECS, 'tokentype' => EXTERNAL_TOKEN_EMBEDDED));
472     mtrace('done.');
474     // run any customized cronjobs, if any
475     if ($locals = get_plugin_list('local')) {
476         mtrace('Processing customized cron scripts ...', '');
477         foreach ($locals as $local => $localdir) {
478             if (file_exists("$localdir/cron.php")) {
479                 include("$localdir/cron.php");
480             }
481         }
482         mtrace('done.');
483     }
486     mtrace("Cron script completed correctly");
488     $difftime = microtime_diff($starttime, microtime());
489     mtrace("Execution took ".$difftime." seconds");