Merge branch 'MDL-41147-master' of git://github.com/sammarshallou/moodle
[moodle.git] / lib / cronlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Cron functions.
19  *
20  * @package    core
21  * @subpackage admin
22  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 /**
27  * Execute cron tasks
28  */
29 function cron_run() {
30     global $DB, $CFG, $OUTPUT;
32     if (CLI_MAINTENANCE) {
33         echo "CLI maintenance mode active, cron execution suspended.\n";
34         exit(1);
35     }
37     if (moodle_needs_upgrading()) {
38         echo "Moodle upgrade pending, cron execution suspended.\n";
39         exit(1);
40     }
42     require_once($CFG->libdir.'/adminlib.php');
43     require_once($CFG->libdir.'/gradelib.php');
45     if (!empty($CFG->showcronsql)) {
46         $DB->set_debug(true);
47     }
48     if (!empty($CFG->showcrondebugging)) {
49         set_debugging(DEBUG_DEVELOPER, true);
50     }
52     set_time_limit(0);
53     $starttime = microtime();
55     // Increase memory limit
56     raise_memory_limit(MEMORY_EXTRA);
58     // Emulate normal session - we use admin accoutn by default
59     cron_setup_user();
61     // Start output log
62     $timenow  = time();
63     mtrace("Server Time: ".date('r', $timenow)."\n\n");
66     // Run cleanup core cron jobs, but not every time since they aren't too important.
67     // These don't have a timer to reduce load, so we'll use a random number
68     // to randomly choose the percentage of times we should run these jobs.
69     srand ((double) microtime() * 10000000);
70     $random100 = rand(0,100);
71     if ($random100 < 20) {     // Approximately 20% of the time.
72         mtrace("Running clean-up tasks...");
73         cron_trace_time_and_memory();
75         // Delete users who haven't confirmed within required period
76         if (!empty($CFG->deleteunconfirmed)) {
77             $cuttime = $timenow - ($CFG->deleteunconfirmed * 3600);
78             $rs = $DB->get_recordset_sql ("SELECT *
79                                              FROM {user}
80                                             WHERE confirmed = 0 AND firstaccess > 0
81                                                   AND firstaccess < ?", array($cuttime));
82             foreach ($rs as $user) {
83                 delete_user($user); // we MUST delete user properly first
84                 $DB->delete_records('user', array('id'=>$user->id)); // this is a bloody hack, but it might work
85                 mtrace(" Deleted unconfirmed user for ".fullname($user, true)." ($user->id)");
86             }
87             $rs->close();
88         }
91         // Delete users who haven't completed profile within required period
92         if (!empty($CFG->deleteincompleteusers)) {
93             $cuttime = $timenow - ($CFG->deleteincompleteusers * 3600);
94             $rs = $DB->get_recordset_sql ("SELECT *
95                                              FROM {user}
96                                             WHERE confirmed = 1 AND lastaccess > 0
97                                                   AND lastaccess < ? AND deleted = 0
98                                                   AND (lastname = '' OR firstname = '' OR email = '')",
99                                           array($cuttime));
100             foreach ($rs as $user) {
101                 if (isguestuser($user) or is_siteadmin($user)) {
102                     continue;
103                 }
104                 delete_user($user);
105                 mtrace(" Deleted not fully setup user $user->username ($user->id)");
106             }
107             $rs->close();
108         }
111         // Delete old logs to save space (this might need a timer to slow it down...)
112         if (!empty($CFG->loglifetime)) {  // value in days
113             $loglifetime = $timenow - ($CFG->loglifetime * 3600 * 24);
114             $DB->delete_records_select("log", "time < ?", array($loglifetime));
115             mtrace(" Deleted old log records");
116         }
119         // Delete old backup_controllers and logs.
120         $loglifetime = get_config('backup', 'loglifetime');
121         if (!empty($loglifetime)) {  // Value in days.
122             $loglifetime = $timenow - ($loglifetime * 3600 * 24);
123             // Delete child records from backup_logs.
124             $DB->execute("DELETE FROM {backup_logs}
125                            WHERE EXISTS (
126                                SELECT 'x'
127                                  FROM {backup_controllers} bc
128                                 WHERE bc.backupid = {backup_logs}.backupid
129                                   AND bc.timecreated < ?)", array($loglifetime));
130             // Delete records from backup_controllers.
131             $DB->execute("DELETE FROM {backup_controllers}
132                           WHERE timecreated < ?", array($loglifetime));
133             mtrace(" Deleted old backup records");
134         }
137         // Delete old cached texts
138         if (!empty($CFG->cachetext)) {   // Defined in config.php
139             $cachelifetime = time() - $CFG->cachetext - 60;  // Add an extra minute to allow for really heavy sites
140             $DB->delete_records_select('cache_text', "timemodified < ?", array($cachelifetime));
141             mtrace(" Deleted old cache_text records");
142         }
145         if (!empty($CFG->usetags)) {
146             require_once($CFG->dirroot.'/tag/lib.php');
147             tag_cron();
148             mtrace(' Executed tag cron');
149         }
152         // Context maintenance stuff
153         context_helper::cleanup_instances();
154         mtrace(' Cleaned up context instances');
155         context_helper::build_all_paths(false);
156         // If you suspect that the context paths are somehow corrupt
157         // replace the line below with: context_helper::build_all_paths(true);
158         mtrace(' Built context paths');
161         // Remove expired cache flags
162         gc_cache_flags();
163         mtrace(' Cleaned cache flags');
166         // Cleanup messaging
167         if (!empty($CFG->messagingdeletereadnotificationsdelay)) {
168             $notificationdeletetime = time() - $CFG->messagingdeletereadnotificationsdelay;
169             $DB->delete_records_select('message_read', 'notification=1 AND timeread<:notificationdeletetime', array('notificationdeletetime'=>$notificationdeletetime));
170             mtrace(' Cleaned up read notifications');
171         }
173         mtrace("...finished clean-up tasks");
175     } // End of occasional clean-up tasks
178     // Send login failures notification - brute force protection in moodle is weak,
179     // we should at least send notices early in each cron execution
180     if (notify_login_failures()) {
181         mtrace(' Notified login failures');
182     }
185     // Make sure all context instances are properly created - they may be required in auth, enrol, etc.
186     context_helper::create_instances();
187     mtrace(' Created missing context instances');
190     // Session gc
191     session_gc();
192     mtrace("Cleaned up stale user sessions");
195     // Run the auth cron, if any before enrolments
196     // because it might add users that will be needed in enrol plugins
197     $auths = get_enabled_auth_plugins();
198     mtrace("Running auth crons if required...");
199     cron_trace_time_and_memory();
200     foreach ($auths as $auth) {
201         $authplugin = get_auth_plugin($auth);
202         if (method_exists($authplugin, 'cron')) {
203             mtrace("Running cron for auth/$auth...");
204             $authplugin->cron();
205             if (!empty($authplugin->log)) {
206                 mtrace($authplugin->log);
207             }
208         }
209         unset($authplugin);
210     }
211     // Generate new password emails for users - ppl expect these generated asap
212     if ($DB->count_records('user_preferences', array('name'=>'create_password', 'value'=>'1'))) {
213         mtrace('Creating passwords for new users...');
214         $newusers = $DB->get_recordset_sql("SELECT u.id as id, u.email, u.firstname,
215                                                  u.lastname, u.username, u.lang,
216                                                  p.id as prefid
217                                             FROM {user} u
218                                             JOIN {user_preferences} p ON u.id=p.userid
219                                            WHERE p.name='create_password' AND p.value='1' AND u.email !='' AND u.suspended = 0 AND u.auth != 'nologin' AND u.deleted = 0");
221         // note: we can not send emails to suspended accounts
222         foreach ($newusers as $newuser) {
223             // Use a low cost factor when generating bcrypt hash otherwise
224             // hashing would be slow when emailing lots of users. Hashes
225             // will be automatically updated to a higher cost factor the first
226             // time the user logs in.
227             if (setnew_password_and_mail($newuser, true)) {
228                 unset_user_preference('create_password', $newuser);
229                 set_user_preference('auth_forcepasswordchange', 1, $newuser);
230             } else {
231                 trigger_error("Could not create and mail new user password!");
232             }
233         }
234         $newusers->close();
235     }
238     // It is very important to run enrol early
239     // because other plugins depend on correct enrolment info.
240     mtrace("Running enrol crons if required...");
241     $enrols = enrol_get_plugins(true);
242     foreach($enrols as $ename=>$enrol) {
243         // do this for all plugins, disabled plugins might want to cleanup stuff such as roles
244         if (!$enrol->is_cron_required()) {
245             continue;
246         }
247         mtrace("Running cron for enrol_$ename...");
248         cron_trace_time_and_memory();
249         $enrol->cron();
250         $enrol->set_config('lastcron', time());
251     }
254     // Run all cron jobs for each module
255     mtrace("Starting activity modules");
256     get_mailer('buffer');
257     if ($mods = $DB->get_records_select("modules", "cron > 0 AND ((? - lastcron) > cron) AND visible = 1", array($timenow))) {
258         foreach ($mods as $mod) {
259             $libfile = "$CFG->dirroot/mod/$mod->name/lib.php";
260             if (file_exists($libfile)) {
261                 include_once($libfile);
262                 $cron_function = $mod->name."_cron";
263                 if (function_exists($cron_function)) {
264                     mtrace("Processing module function $cron_function ...", '');
265                     cron_trace_time_and_memory();
266                     $pre_dbqueries = null;
267                     $pre_dbqueries = $DB->perf_get_queries();
268                     $pre_time      = microtime(1);
269                     if ($cron_function()) {
270                         $DB->set_field("modules", "lastcron", $timenow, array("id"=>$mod->id));
271                     }
272                     if (isset($pre_dbqueries)) {
273                         mtrace("... used " . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries");
274                         mtrace("... used " . (microtime(1) - $pre_time) . " seconds");
275                     }
276                     // Reset possible changes by modules to time_limit. MDL-11597
277                     @set_time_limit(0);
278                     mtrace("done.");
279                 }
280             }
281         }
282     }
283     get_mailer('close');
284     mtrace("Finished activity modules");
287     mtrace("Starting blocks");
288     if ($blocks = $DB->get_records_select("block", "cron > 0 AND ((? - lastcron) > cron) AND visible = 1", array($timenow))) {
289         // We will need the base class.
290         require_once($CFG->dirroot.'/blocks/moodleblock.class.php');
291         foreach ($blocks as $block) {
292             $blockfile = $CFG->dirroot.'/blocks/'.$block->name.'/block_'.$block->name.'.php';
293             if (file_exists($blockfile)) {
294                 require_once($blockfile);
295                 $classname = 'block_'.$block->name;
296                 $blockobj = new $classname;
297                 if (method_exists($blockobj,'cron')) {
298                     mtrace("Processing cron function for ".$block->name.'....','');
299                     cron_trace_time_and_memory();
300                     if ($blockobj->cron()) {
301                         $DB->set_field('block', 'lastcron', $timenow, array('id'=>$block->id));
302                     }
303                     // Reset possible changes by blocks to time_limit. MDL-11597
304                     @set_time_limit(0);
305                     mtrace('done.');
306                 }
307             }
309         }
310     }
311     mtrace('Finished blocks');
314     mtrace('Starting admin reports');
315     cron_execute_plugin_type('report');
316     mtrace('Finished admin reports');
319     mtrace('Starting main gradebook job...');
320     cron_trace_time_and_memory();
321     grade_cron();
322     mtrace('done.');
325     mtrace('Starting processing the event queue...');
326     cron_trace_time_and_memory();
327     events_cron();
328     mtrace('done.');
331     if ($CFG->enablecompletion) {
332         // Completion cron
333         mtrace('Starting the completion cron...');
334         cron_trace_time_and_memory();
335         require_once($CFG->dirroot.'/completion/cron.php');
336         completion_cron();
337         mtrace('done');
338     }
341     if ($CFG->enableportfolios) {
342         // Portfolio cron
343         mtrace('Starting the portfolio cron...');
344         cron_trace_time_and_memory();
345         require_once($CFG->libdir . '/portfoliolib.php');
346         portfolio_cron();
347         mtrace('done');
348     }
351     //now do plagiarism checks
352     require_once($CFG->libdir.'/plagiarismlib.php');
353     plagiarism_cron();
356     mtrace('Starting course reports');
357     cron_execute_plugin_type('coursereport');
358     mtrace('Finished course reports');
361     // run gradebook import/export/report cron
362     mtrace('Starting gradebook plugins');
363     cron_execute_plugin_type('gradeimport');
364     cron_execute_plugin_type('gradeexport');
365     cron_execute_plugin_type('gradereport');
366     mtrace('Finished gradebook plugins');
368     // run calendar cron
369     require_once "{$CFG->dirroot}/calendar/lib.php";
370     calendar_cron();
372     // Run external blog cron if needed
373     if (!empty($CFG->enableblogs) && $CFG->useexternalblogs) {
374         require_once($CFG->dirroot . '/blog/lib.php');
375         mtrace("Fetching external blog entries...", '');
376         cron_trace_time_and_memory();
377         $sql = "timefetched < ? OR timefetched = 0";
378         $externalblogs = $DB->get_records_select('blog_external', $sql, array(time() - $CFG->externalblogcrontime));
380         foreach ($externalblogs as $eb) {
381             blog_sync_external_entries($eb);
382         }
383         mtrace('done.');
384     }
385     // Run blog associations cleanup
386     if (!empty($CFG->enableblogs) && $CFG->useblogassociations) {
387         require_once($CFG->dirroot . '/blog/lib.php');
388         // delete entries whose contextids no longer exists
389         mtrace("Deleting blog associations linked to non-existent contexts...", '');
390         cron_trace_time_and_memory();
391         $DB->delete_records_select('blog_association', 'contextid NOT IN (SELECT id FROM {context})');
392         mtrace('done.');
393     }
396     // Run question bank clean-up.
397     mtrace("Starting the question bank cron...", '');
398     cron_trace_time_and_memory();
399     require_once($CFG->libdir . '/questionlib.php');
400     question_bank::cron();
401     mtrace('done.');
404     //Run registration updated cron
405     mtrace(get_string('siteupdatesstart', 'hub'));
406     cron_trace_time_and_memory();
407     require_once($CFG->dirroot . '/' . $CFG->admin . '/registration/lib.php');
408     $registrationmanager = new registration_manager();
409     $registrationmanager->cron();
410     mtrace(get_string('siteupdatesend', 'hub'));
412     // If enabled, fetch information about available updates and eventually notify site admins
413     if (empty($CFG->disableupdatenotifications)) {
414         require_once($CFG->libdir.'/pluginlib.php');
415         $updateschecker = available_update_checker::instance();
416         $updateschecker->cron();
417     }
419     //cleanup old session linked tokens
420     //deletes the session linked tokens that are over a day old.
421     mtrace("Deleting session linked tokens more than one day old...", '');
422     cron_trace_time_and_memory();
423     $DB->delete_records_select('external_tokens', 'lastaccess < :onedayago AND tokentype = :tokentype',
424                     array('onedayago' => time() - DAYSECS, 'tokentype' => EXTERNAL_TOKEN_EMBEDDED));
425     mtrace('done.');
428     // all other plugins
429     cron_execute_plugin_type('message', 'message plugins');
430     cron_execute_plugin_type('filter', 'filters');
431     cron_execute_plugin_type('editor', 'editors');
432     cron_execute_plugin_type('format', 'course formats');
433     cron_execute_plugin_type('profilefield', 'profile fields');
434     cron_execute_plugin_type('webservice', 'webservices');
435     cron_execute_plugin_type('repository', 'repository plugins');
436     cron_execute_plugin_type('qbehaviour', 'question behaviours');
437     cron_execute_plugin_type('qformat', 'question import/export formats');
438     cron_execute_plugin_type('qtype', 'question types');
439     cron_execute_plugin_type('plagiarism', 'plagiarism plugins');
440     cron_execute_plugin_type('theme', 'themes');
441     cron_execute_plugin_type('tool', 'admin tools');
444     // and finally run any local cronjobs, if any
445     if ($locals = core_component::get_plugin_list('local')) {
446         mtrace('Processing customized cron scripts ...', '');
447         // new cron functions in lib.php first
448         cron_execute_plugin_type('local');
449         // legacy cron files are executed directly
450         foreach ($locals as $local => $localdir) {
451             if (file_exists("$localdir/cron.php")) {
452                 include("$localdir/cron.php");
453             }
454         }
455         mtrace('done.');
456     }
458     mtrace('Running cache cron routines');
459     cache_helper::cron();
460     mtrace('done.');
462     // Run automated backups if required - these may take a long time to execute
463     require_once($CFG->dirroot.'/backup/util/includes/backup_includes.php');
464     require_once($CFG->dirroot.'/backup/util/helper/backup_cron_helper.class.php');
465     backup_cron_automated_helper::run_automated_backup();
468     // Run stats as at the end because they are known to take very long time on large sites
469     if (!empty($CFG->enablestats) and empty($CFG->disablestatsprocessing)) {
470         require_once($CFG->dirroot.'/lib/statslib.php');
471         // check we're not before our runtime
472         $timetocheck = stats_get_base_daily() + $CFG->statsruntimestarthour*60*60 + $CFG->statsruntimestartminute*60;
474         if (time() > $timetocheck) {
475             // process configured number of days as max (defaulting to 31)
476             $maxdays = empty($CFG->statsruntimedays) ? 31 : abs($CFG->statsruntimedays);
477             if (stats_cron_daily($maxdays)) {
478                 if (stats_cron_weekly()) {
479                     if (stats_cron_monthly()) {
480                         stats_clean_old();
481                     }
482                 }
483             }
484             @set_time_limit(0);
485         } else {
486             mtrace('Next stats run after:'. userdate($timetocheck));
487         }
488     }
490     // Run badges review cron.
491     mtrace("Starting badges cron...");
492     require_once($CFG->dirroot . '/badges/cron.php');
493     badge_cron();
494     mtrace('done.');
496     // cleanup file trash - not very important
497     $fs = get_file_storage();
498     $fs->cron();
500     mtrace("Cron script completed correctly");
502     gc_collect_cycles();
503     mtrace('Cron completed at ' . date('H:i:s') . '. Memory used ' . display_size(memory_get_usage()) . '.');
504     $difftime = microtime_diff($starttime, microtime());
505     mtrace("Execution took ".$difftime." seconds");
508 /**
509  * Executes cron functions for a specific type of plugin.
510  *
511  * @param string $plugintype Plugin type (e.g. 'report')
512  * @param string $description If specified, will display 'Starting (whatever)'
513  *   and 'Finished (whatever)' lines, otherwise does not display
514  */
515 function cron_execute_plugin_type($plugintype, $description = null) {
516     global $DB;
518     // Get list from plugin => function for all plugins
519     $plugins = get_plugin_list_with_function($plugintype, 'cron');
521     // Modify list for backward compatibility (different files/names)
522     $plugins = cron_bc_hack_plugin_functions($plugintype, $plugins);
524     // Return if no plugins with cron function to process
525     if (!$plugins) {
526         return;
527     }
529     if ($description) {
530         mtrace('Starting '.$description);
531     }
533     foreach ($plugins as $component=>$cronfunction) {
534         $dir = core_component::get_component_directory($component);
536         // Get cron period if specified in version.php, otherwise assume every cron
537         $cronperiod = 0;
538         if (file_exists("$dir/version.php")) {
539             $plugin = new stdClass();
540             include("$dir/version.php");
541             if (isset($plugin->cron)) {
542                 $cronperiod = $plugin->cron;
543             }
544         }
546         // Using last cron and cron period, don't run if it already ran recently
547         $lastcron = get_config($component, 'lastcron');
548         if ($cronperiod && $lastcron) {
549             if ($lastcron + $cronperiod > time()) {
550                 // do not execute cron yet
551                 continue;
552             }
553         }
555         mtrace('Processing cron function for ' . $component . '...');
556         cron_trace_time_and_memory();
557         $pre_dbqueries = $DB->perf_get_queries();
558         $pre_time = microtime(true);
560         $cronfunction();
562         mtrace("done. (" . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries, " .
563                 round(microtime(true) - $pre_time, 2) . " seconds)");
565         set_config('lastcron', time(), $component);
566         @set_time_limit(0);
567     }
569     if ($description) {
570         mtrace('Finished ' . $description);
571     }
574 /**
575  * Used to add in old-style cron functions within plugins that have not been converted to the
576  * new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
577  * cron.php and some used a different name.)
578  *
579  * @param string $plugintype Plugin type e.g. 'report'
580  * @param array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
581  *   'report_frog_cron') for plugin cron functions that were already found using the new API
582  * @return array Revised version of $plugins that adds in any extra plugin functions found by
583  *   looking in the older location
584  */
585 function cron_bc_hack_plugin_functions($plugintype, $plugins) {
586     global $CFG; // mandatory in case it is referenced by include()d PHP script
588     if ($plugintype === 'report') {
589         // Admin reports only - not course report because course report was
590         // never implemented before, so doesn't need BC
591         foreach (core_component::get_plugin_list($plugintype) as $pluginname=>$dir) {
592             $component = $plugintype . '_' . $pluginname;
593             if (isset($plugins[$component])) {
594                 // We already have detected the function using the new API
595                 continue;
596             }
597             if (!file_exists("$dir/cron.php")) {
598                 // No old style cron file present
599                 continue;
600             }
601             include_once("$dir/cron.php");
602             $cronfunction = $component . '_cron';
603             if (function_exists($cronfunction)) {
604                 $plugins[$component] = $cronfunction;
605             } else {
606                 debugging("Invalid legacy cron.php detected in $component, " .
607                         "please use lib.php instead");
608             }
609         }
610     } else if (strpos($plugintype, 'grade') === 0) {
611         // Detect old style cron function names
612         // Plugin gradeexport_frog used to use grade_export_frog_cron() instead of
613         // new standard API gradeexport_frog_cron(). Also applies to gradeimport, gradereport
614         foreach(core_component::get_plugin_list($plugintype) as $pluginname=>$dir) {
615             $component = $plugintype.'_'.$pluginname;
616             if (isset($plugins[$component])) {
617                 // We already have detected the function using the new API
618                 continue;
619             }
620             if (!file_exists("$dir/lib.php")) {
621                 continue;
622             }
623             include_once("$dir/lib.php");
624             $cronfunction = str_replace('grade', 'grade_', $plugintype) . '_' .
625                     $pluginname . '_cron';
626             if (function_exists($cronfunction)) {
627                 $plugins[$component] = $cronfunction;
628             }
629         }
630     }
632     return $plugins;
635 /**
636  * Output some standard information during cron runs. Specifically current time
637  * and memory usage. This method also does gc_collect_cycles() (before displaying
638  * memory usage) to try to help PHP manage memory better.
639  */
640 function cron_trace_time_and_memory() {
641     gc_collect_cycles();
642     mtrace('... started ' . date('H:i:s') . '. Current memory use ' . display_size(memory_get_usage()) . '.');
645 /**
646  * Notify admin users or admin user of any failed logins (since last notification).
647  *
648  * Note that this function must be only executed from the cron script
649  * It uses the cache_flags system to store temporary records, deleting them
650  * by name before finishing
651  *
652  * @return bool True if executed, false if not
653  */
654 function notify_login_failures() {
655     global $CFG, $DB, $OUTPUT;
657     if (empty($CFG->notifyloginfailures)) {
658         return false;
659     }
661     $recip = get_users_from_config($CFG->notifyloginfailures, 'moodle/site:config');
663     if (empty($CFG->lastnotifyfailure)) {
664         $CFG->lastnotifyfailure=0;
665     }
667     // If it has been less than an hour, or if there are no recipients, don't execute.
668     if (((time() - HOURSECS) < $CFG->lastnotifyfailure) || !is_array($recip) || count($recip) <= 0) {
669         return false;
670     }
672     // we need to deal with the threshold stuff first.
673     if (empty($CFG->notifyloginthreshold)) {
674         $CFG->notifyloginthreshold = 10; // default to something sensible.
675     }
677     // Get all the IPs with more than notifyloginthreshold failures since lastnotifyfailure
678     // and insert them into the cache_flags temp table
679     $sql = "SELECT ip, COUNT(*)
680               FROM {log}
681              WHERE module = 'login' AND action = 'error'
682                    AND time > ?
683           GROUP BY ip
684             HAVING COUNT(*) >= ?";
685     $params = array($CFG->lastnotifyfailure, $CFG->notifyloginthreshold);
686     $rs = $DB->get_recordset_sql($sql, $params);
687     foreach ($rs as $iprec) {
688         if (!empty($iprec->ip)) {
689             set_cache_flag('login_failure_by_ip', $iprec->ip, '1', 0);
690         }
691     }
692     $rs->close();
694     // Get all the INFOs with more than notifyloginthreshold failures since lastnotifyfailure
695     // and insert them into the cache_flags temp table
696     $sql = "SELECT info, count(*)
697               FROM {log}
698              WHERE module = 'login' AND action = 'error'
699                    AND time > ?
700           GROUP BY info
701             HAVING count(*) >= ?";
702     $params = array($CFG->lastnotifyfailure, $CFG->notifyloginthreshold);
703     $rs = $DB->get_recordset_sql($sql, $params);
704     foreach ($rs as $inforec) {
705         if (!empty($inforec->info)) {
706             set_cache_flag('login_failure_by_info', $inforec->info, '1', 0);
707         }
708     }
709     $rs->close();
711     // Now, select all the login error logged records belonging to the ips and infos
712     // since lastnotifyfailure, that we have stored in the cache_flags table
713     $sql = "SELECT * FROM (
714         SELECT l.*, u.firstname, u.lastname
715               FROM {log} l
716               JOIN {cache_flags} cf ON l.ip = cf.name
717          LEFT JOIN {user} u         ON l.userid = u.id
718              WHERE l.module = 'login' AND l.action = 'error'
719                    AND l.time > ?
720                    AND cf.flagtype = 'login_failure_by_ip'
721         UNION ALL
722             SELECT l.*, u.firstname, u.lastname
723               FROM {log} l
724               JOIN {cache_flags} cf ON l.info = cf.name
725          LEFT JOIN {user} u         ON l.userid = u.id
726              WHERE l.module = 'login' AND l.action = 'error'
727                    AND l.time > ?
728                    AND cf.flagtype = 'login_failure_by_info') t
729         ORDER BY t.time DESC";
730     $params = array($CFG->lastnotifyfailure, $CFG->lastnotifyfailure);
732     // Init some variables
733     $count = 0;
734     $messages = '';
735     // Iterate over the logs recordset
736     $rs = $DB->get_recordset_sql($sql, $params);
737     foreach ($rs as $log) {
738         $log->time = userdate($log->time);
739         $messages .= get_string('notifyloginfailuresmessage','',$log)."\n";
740         $count++;
741     }
742     $rs->close();
744     // If we have something useful to report.
745     if ($count > 0) {
746         $site = get_site();
747         $subject = get_string('notifyloginfailuressubject', '', format_string($site->fullname));
748         // Calculate the complete body of notification (start + messages + end)
749         $body = get_string('notifyloginfailuresmessagestart', '', $CFG->wwwroot) .
750                 (($CFG->lastnotifyfailure != 0) ? '('.userdate($CFG->lastnotifyfailure).')' : '')."\n\n" .
751                 $messages .
752                 "\n\n".get_string('notifyloginfailuresmessageend','',$CFG->wwwroot)."\n\n";
754         // For each destination, send mail
755         mtrace('Emailing admins about '. $count .' failed login attempts');
756         foreach ($recip as $admin) {
757             //emailing the admins directly rather than putting these through the messaging system
758             email_to_user($admin, generate_email_supportuser(), $subject, $body);
759         }
760     }
762     // Update lastnotifyfailure with current time
763     set_config('lastnotifyfailure', time());
765     // Finally, delete all the temp records we have created in cache_flags
766     $DB->delete_records_select('cache_flags', "flagtype IN ('login_failure_by_ip', 'login_failure_by_info')");
768     return true;