[MDL-8407] Replace four language strings that will be used by 'mod/data/export_form...
[moodle.git] / admin / cron.php
CommitLineData
fce3ef94 1<?php // $Id$
f9903ed0 2
540bab47 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
168df8f3 13 set_time_limit(0);
498d4032 14 $starttime = microtime();
f9f4d999 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');
9152fc99 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
d5f286f1 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 }
498d4032 32
331ca297 33 require_once(dirname(__FILE__) . '/../config.php');
6e4dc10f 34 require_once($CFG->libdir.'/adminlib.php');
2650c51e 35 require_once($CFG->libdir.'/gradelib.php');
f9903ed0 36
63a11f3c 37/// Extra debugging (set in config.php)
38 if (!empty($CFG->showcronsql)) {
f33e1ed4 39 $DB->set_debug(true);
63a11f3c 40 }
41 if (!empty($CFG->showcrondebugging)) {
42 $CFG->debug = DEBUG_DEVELOPER;
43 $CFG->displaydebug = true;
44 }
45
9152fc99 46/// extra safety
47 @session_write_close();
48
49/// check if execution allowed
e08df351 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
afabdb14 67
9152fc99 68/// emulate normal session
69 $SESSION = new object();
70 $USER = get_admin(); /// Temporarily, to provide environment for this script
00de82df 71
9152fc99 72/// ignore admins timezone, language and locale - use site deafult instead!
73 $USER->timezone = $CFG->timezone;
5e601222 74 $USER->lang = '';
9152fc99 75 $USER->theme = '';
76 course_setup(SITEID);
5e601222 77
78/// send mime type and encoding
58e8f85b 79 if (check_browser_version('MSIE')) {
80 //ugly IE hack to work around downloading instead of viewing
810944af 81 @header('Content-Type: text/html; charset=utf-8');
58e8f85b 82 echo "<xmp>"; //<pre> is not good enough for us here
83 } else {
84 //send proper plaintext header
810944af 85 @header('Content-Type: text/plain; charset=utf-8');
58e8f85b 86 }
5e601222 87
9152fc99 88/// no more headers and buffers
89 while(@ob_end_flush());
90
4eefee97 91/// increase memory limit (PHP 5.2 does different calculation, we need more memory now)
92 @raise_memory_limit('128M');
93
428b6fec 94/// Start output log
f9903ed0 95
f9903ed0 96 $timenow = time();
428b6fec 97
defaac4c 98 mtrace("Server Time: ".date('r',$timenow)."\n\n");
f9903ed0 99
b2ce450a 100/// Run all cron jobs for each module
c88f014a 101
defaac4c 102 mtrace("Starting activity modules");
c2f6fe2f 103 get_mailer('buffer');
0f0a5c28 104 if ($mods = get_records_select("modules", "cron > 0 AND (($timenow - lastcron) > cron) AND visible = 1 ")) {
f9903ed0 105 foreach ($mods as $mod) {
673de292 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)) {
defaac4c 111 mtrace("Processing module function $cron_function ...", '');
d9b06327 112 $pre_dbqueries = null;
ff991c05 113 if (!empty($PERF->dbqueries)) {
114 $pre_dbqueries = $PERF->dbqueries;
115 $pre_time = microtime(1);
116 }
673de292 117 if ($cron_function()) {
118 if (! set_field("modules", "lastcron", $timenow, "id", $mod->id)) {
defaac4c 119 mtrace("Error: could not update timestamp for $mod->fullname");
673de292 120 }
121 }
ff991c05 122 if (isset($pre_dbqueries)) {
123 mtrace("... used " . ($PERF->dbqueries - $pre_dbqueries) . " dbqueries");
124 mtrace("... used " . (microtime(1) - $pre_time) . " seconds");
125 }
5e867b23 126 /// Reset possible changes by modules to time_limit. MDL-11597
127 @set_time_limit(0);
defaac4c 128 mtrace("done.");
f9903ed0 129 }
130 }
131 }
132 }
c2f6fe2f 133 get_mailer('close');
defaac4c 134 mtrace("Finished activity modules");
c88f014a 135
f9648e77 136 mtrace("Starting blocks");
0f0a5c28 137 if ($blocks = get_records_select("block", "cron > 0 AND (($timenow - lastcron) > cron) AND visible = 1")) {
f9648e77 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 }
44853b81 153 /// Reset possible changes by blocks to time_limit. MDL-11597
154 @set_time_limit(0);
f9648e77 155 mtrace('done.');
156 }
157 }
158
159 }
160 }
0616d3e8 161 mtrace('Finished blocks');
f9648e77 162
d9b06327 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
d6ead3a2 190 if (!empty($CFG->langcache)) {
191 mtrace('Updating languages cache');
0a5ce9dd 192 get_list_of_languages(true);
d6ead3a2 193 }
194
0616d3e8 195 mtrace('Removing expired enrolments ...', ''); // See MDL-8785
196 $timenow = time();
cf057534 197 $somefound = false;
c5898fad 198 // The preferred way saves memory, dmllib.php
cf057534 199 // find courses where limited enrolment is enabled
c5898fad 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;
cf057534 213 }
c5898fad 214 rs_close($rs_enrol);
cf057534 215 if($somefound) {
0616d3e8 216 mtrace('Done');
217 } else {
218 mtrace('none found');
219 }
220
d6ead3a2 221
d9b06327 222
1ee0df06 223 mtrace('Starting main gradebook job ...');
2650c51e 224 grade_cron();
1ee0df06 225 mtrace('done.');
2650c51e 226
227
b2ce450a 228/// Run all core cron jobs, but not every time since they aren't too important.
229/// These don't have a timer to reduce load, so we'll use a random number
230/// to randomly choose the percentage of times we should run these jobs.
c88f014a 231
b2ce450a 232 srand ((double) microtime() * 10000000);
233 $random100 = rand(0,100);
c88f014a 234
b2ce450a 235 if ($random100 < 20) { // Approximately 20% of the time.
defaac4c 236 mtrace("Running clean-up tasks...");
b2ce450a 237
238 /// Unenrol users who haven't logged in for $CFG->longtimenosee
239
240 if ($CFG->longtimenosee) { // value in days
fce3ef94 241 $cuttime = $timenow - ($CFG->longtimenosee * 3600 * 24);
242 $rs = get_recordset_sql ("SELECT id, userid, courseid
243 FROM {$CFG->prefix}user_lastaccess
244 WHERE courseid != ".SITEID."
245 AND timeaccess < $cuttime ");
246 while ($assign = rs_fetch_next_record($rs)) {
247 if ($context = get_context_instance(CONTEXT_COURSE, $assign->courseid)) {
248 if (role_unassign(0, $assign->userid, 0, $context->id)) {
249 mtrace("Deleted assignment for user $assign->userid from course $assign->courseid");
b2ce450a 250 }
251 }
252 }
fce3ef94 253 rs_close($rs);
d9420631 254 /// Execute the same query again, looking for remaining records and deleting them
255 /// if the user hasn't moodle/course:view in the CONTEXT_COURSE context (orphan records)
256 $rs = get_recordset_sql ("SELECT id, userid, courseid
257 FROM {$CFG->prefix}user_lastaccess
258 WHERE courseid != ".SITEID."
259 AND timeaccess < $cuttime ");
260 while ($assign = rs_fetch_next_record($rs)) {
261 if ($context = get_context_instance(CONTEXT_COURSE, $assign->courseid)) {
262 if (!has_capability('moodle/course:view', $context, $assign->userid)) {
263 delete_records('user_lastaccess', 'userid', $assign->userid, 'courseid', $assign->courseid);
264 mtrace("Deleted orphan user_lastaccess for user $assign->userid from course $assign->courseid");
265 }
266 }
267 }
268 rs_close($rs);
b2ce450a 269 }
fce3ef94 270 flush();
271
272
6c61fd04 273 /// Delete users who haven't confirmed within required period
c6c43ae9 274
8c182006 275 if (!empty($CFG->deleteunconfirmed)) {
fce3ef94 276 $cuttime = $timenow - ($CFG->deleteunconfirmed * 3600);
277 $rs = get_recordset_sql ("SELECT id, firstname, lastname
278 FROM {$CFG->prefix}user
279 WHERE confirmed = 0
280 AND firstaccess > 0
281 AND firstaccess < $cuttime");
282 while ($user = rs_fetch_next_record($rs)) {
283 if (delete_records('user', 'id', $user->id)) {
284 mtrace("Deleted unconfirmed user for ".fullname($user, true)." ($user->id)");
f282e631 285 }
6cb86b39 286 }
fce3ef94 287 rs_close($rs);
6cb86b39 288 }
69f78bcb 289 flush();
7b8cc339 290
291
7b8cc339 292 /// Delete users who haven't completed profile within required period
293
8c182006 294 if (!empty($CFG->deleteunconfirmed)) {
fce3ef94 295 $cuttime = $timenow - ($CFG->deleteunconfirmed * 3600);
296 $rs = get_recordset_sql ("SELECT id, username
297 FROM {$CFG->prefix}user
298 WHERE confirmed = 1
299 AND lastaccess > 0
300 AND lastaccess < $cuttime
301 AND deleted = 0
302 AND (lastname = '' OR firstname = '' OR email = '')");
303 while ($user = rs_fetch_next_record($rs)) {
304 if (delete_records('user', 'id', $user->id)) {
305 mtrace("Deleted not fully setup user $user->username ($user->id)");
7b8cc339 306 }
307 }
fce3ef94 308 rs_close($rs);
7b8cc339 309 }
310 flush();
311
312
b2ce450a 313 /// Delete old logs to save space (this might need a timer to slow it down...)
fce3ef94 314
b2ce450a 315 if (!empty($CFG->loglifetime)) { // value in days
316 $loglifetime = $timenow - ($CFG->loglifetime * 3600 * 24);
fce3ef94 317 if (delete_records_select("log", "time < '$loglifetime'")) {
318 mtrace("Deleted old log records");
319 }
b2ce450a 320 }
69f78bcb 321 flush();
cb3a4484 322
fce3ef94 323
cb3a4484 324 /// Delete old cached texts
325
326 if (!empty($CFG->cachetext)) { // Defined in config.php
a9743837 327 $cachelifetime = time() - $CFG->cachetext - 60; // Add an extra minute to allow for really heavy sites
fce3ef94 328 if (delete_records_select('cache_text', "timemodified < '$cachelifetime'")) {
329 mtrace("Deleted old cache_text records");
330 }
cb3a4484 331 }
69f78bcb 332 flush();
d846e50a 333
334 if (!empty($CFG->notifyloginfailures)) {
335 notify_login_failures();
f1dc7614 336 mtrace('Notified login failured');
d846e50a 337 }
69f78bcb 338 flush();
d846e50a 339
b61efafb 340 sync_metacourses();
f1dc7614 341 mtrace('Synchronised metacourses');
b61efafb 342
e3b6b2b0 343 //
344 // generate new password emails for users
345 //
346 mtrace('checking for create_password');
347 if (count_records('user_preferences', 'name', 'create_password', 'value', '1')) {
348 mtrace('creating passwords for new users');
349 $newusers = get_records_sql("SELECT u.id as id, u.email, u.firstname,
350 u.lastname, u.username,
351 p.id as prefid
352 FROM {$CFG->prefix}user u
353 JOIN {$CFG->prefix}user_preferences p ON u.id=p.userid
354 WHERE p.name='create_password' AND p.value=1 AND u.email !='' ");
355
356 foreach ($newusers as $newuserid => $newuser) {
357 $newuser->emailstop = 0; // send email regardless
358 // email user
359 if (setnew_password_and_mail($newuser)) {
360 // remove user pref
361 delete_records('user_preferences', 'id', $newuser->prefid);
362 } else {
363 trigger_error("Could not create and mail new user password!");
364 }
365 }
366 }
7ea9b095 367
2cb5f03a 368 if (!empty($CFG->usetags)) {
19e41f75 369 require_once($CFG->dirroot.'/tag/lib.php');
370 tag_cron();
f1dc7614 371 mtrace ('Executed tag cron');
19e41f75 372 }
373
ad72d0d7 374 // Accesslib stuff
375 cleanup_contexts();
f1dc7614 376 mtrace ('Cleaned up contexts');
fce3ef94 377 gc_cache_flags();
f1dc7614 378 mtrace ('Cleaned cache flags');
ad72d0d7 379 // If you suspect that the context paths are somehow corrupt
380 // replace the line below with: build_context_path(true);
381 build_context_path();
f1dc7614 382 mtrace ('Built context paths');
383
384 mtrace("Finished clean-up tasks...");
ad72d0d7 385
d846e50a 386 } // End of occasional clean-up tasks
540bab47 387
750eeaeb 388
50999a0b 389 if (empty($CFG->disablescheduledbackups)) { // Defined in config.php
74736e49 390 //Execute backup's cron
391 //Perhaps a long time and memory could help in large sites
a71bfa1c 392 @set_time_limit(0);
8891e81c 393 @raise_memory_limit("192M");
a2ce7344 394 if (function_exists('apache_child_terminate')) {
395 // if we are running from Apache, give httpd a hint that
396 // it can recycle the process after it's done. Apache's
397 // memory management is truly awful but we can help it.
398 @apache_child_terminate();
399 }
74736e49 400 if (file_exists("$CFG->dirroot/backup/backup_scheduled.php") and
401 file_exists("$CFG->dirroot/backup/backuplib.php") and
e91e2b6a 402 file_exists("$CFG->dirroot/backup/lib.php") and
403 file_exists("$CFG->libdir/blocklib.php")) {
74736e49 404 include_once("$CFG->dirroot/backup/backup_scheduled.php");
405 include_once("$CFG->dirroot/backup/backuplib.php");
406 include_once("$CFG->dirroot/backup/lib.php");
e91e2b6a 407 require_once ("$CFG->libdir/blocklib.php");
defaac4c 408 mtrace("Running backups if required...");
74736e49 409
410 if (! schedule_backup_cron()) {
04ddd06c 411 mtrace("ERROR: Something went wrong while performing backup tasks!!!");
74736e49 412 } else {
defaac4c 413 mtrace("Backup tasks finished.");
74736e49 414 }
e6d273eb 415 }
d3159192 416 }
417
8adcb49f 418 if (!empty($CFG->enablerssfeeds)) { //Defined in admin/variables page
3c02d134 419 include_once("$CFG->libdir/rsslib.php");
420 mtrace("Running rssfeeds if required...");
8adcb49f 421
3c02d134 422 if ( ! cron_rss_feeds()) {
423 mtrace("Something went wrong while generating rssfeeds!!!");
424 } else {
425 mtrace("Rssfeeds finished");
8adcb49f 426 }
427 }
428
04e44325 429/// Run the enrolment cron, if any
f9667a5a 430 if (!($plugins = explode(',', $CFG->enrol_plugins_enabled))) {
431 $plugins = array($CFG->enrol);
432 }
433 require_once($CFG->dirroot .'/enrol/enrol.class.php');
434 foreach ($plugins as $p) {
435 $enrol = enrolment_factory::factory($p);
436 if (method_exists($enrol, 'cron')) {
437 $enrol->cron();
438 }
439 if (!empty($enrol->log)) {
440 mtrace($enrol->log);
441 }
442 unset($enrol);
7e192c78 443 }
04e44325 444
d14383e0 445/// Run the auth cron, if any
c7b10b5f 446 $auths = get_enabled_auth_plugins();
447
d14383e0 448 mtrace("Running auth crons if required...");
449 foreach ($auths as $auth) {
450 $authplugin = get_auth_plugin($auth);
451 if (method_exists($authplugin, 'cron')) {
452 mtrace("Running cron for auth/$auth...");
453 $authplugin->cron();
454 if (!empty($authplugin->log)) {
455 mtrace($authplugin->log);
456 }
457 }
458 unset($authplugin);
459 }
460
72df7e1e 461 if (!empty($CFG->enablestats) and empty($CFG->disablestatsprocessing)) {
61460dd6 462 require_once($CFG->dirroot.'/lib/statslib.php');
4900433c 463 // check we're not before our runtime
61460dd6 464 $timetocheck = stats_get_base_daily() + $CFG->statsruntimestarthour*60*60 + $CFG->statsruntimestartminute*60;
4900433c 465
466 if (time() > $timetocheck) {
61460dd6 467 // process max 31 days per cron execution
468 if (stats_cron_daily(31)) {
469 if (stats_cron_weekly()) {
470 if (stats_cron_monthly()) {
471 stats_clean_old();
472 }
4900433c 473 }
f3221af9 474 }
61460dd6 475 @set_time_limit(0);
6fdde1d2 476 } else {
5a4b2e8e 477 mtrace('Next stats run after:'. userdate($timetocheck));
f3221af9 478 }
479 }
1ee0df06 480
ce34ed3a 481 // run gradebook import/export/report cron
482 if ($gradeimports = get_list_of_plugins('grade/import')) {
483 foreach ($gradeimports as $gradeimport) {
1ee0df06 484 if (file_exists($CFG->dirroot.'/grade/import/'.$gradeimport.'/lib.php')) {
485 require_once($CFG->dirroot.'/grade/import/'.$gradeimport.'/lib.php');
486 $cron_function = 'grade_import_'.$gradeimport.'_cron';
ce34ed3a 487 if (function_exists($cron_function)) {
488 mtrace("Processing gradebook import function $cron_function ...", '');
489 $cron_function;
490 }
491 }
492 }
493 }
494
495 if ($gradeexports = get_list_of_plugins('grade/export')) {
496 foreach ($gradeexports as $gradeexport) {
1ee0df06 497 if (file_exists($CFG->dirroot.'/grade/export/'.$gradeexport.'/lib.php')) {
498 require_once($CFG->dirroot.'/grade/export/'.$gradeexport.'/lib.php');
499 $cron_function = 'grade_export_'.$gradeexport.'_cron';
ce34ed3a 500 if (function_exists($cron_function)) {
501 mtrace("Processing gradebook export function $cron_function ...", '');
502 $cron_function;
503 }
504 }
505 }
506 }
1ee0df06 507
ce34ed3a 508 if ($gradereports = get_list_of_plugins('grade/report')) {
509 foreach ($gradereports as $gradereport) {
1ee0df06 510 if (file_exists($CFG->dirroot.'/grade/report/'.$gradereport.'/lib.php')) {
511 require_once($CFG->dirroot.'/grade/report/'.$gradereport.'/lib.php');
512 $cron_function = 'grade_report_'.$gradereport.'_cron';
ce34ed3a 513 if (function_exists($cron_function)) {
514 mtrace("Processing gradebook report function $cron_function ...", '');
515 $cron_function;
516 }
517 }
518 }
519 }
ba9b44f9 520
521 // run any customized cronjobs, if any
522 // looking for functions in lib/local/cron.php
40e473bf 523 if (file_exists($CFG->dirroot.'/local/cron.php')) {
ba9b44f9 524 mtrace('Processing customized cron script ...', '');
40e473bf 525 include_once($CFG->dirroot.'/local/cron.php');
ba9b44f9 526 mtrace('done.');
527 }
528
f3221af9 529
db6b033d 530 //Unset session variables and destroy it
531 @session_unset();
532 @session_destroy();
533
defaac4c 534 mtrace("Cron script completed correctly");
f9903ed0 535
498d4032 536 $difftime = microtime_diff($starttime, microtime());
defaac4c 537 mtrace("Execution took ".$difftime." seconds");
498d4032 538
28a082f1 539/// finish the IE hack
58e8f85b 540 if (check_browser_version('MSIE')) {
541 echo "</xmp>";
542 }
543
1afb11e7 544?>