MDL-51883 libraries: 3.1 final deprecation in lib/deprecatedlib.php
[moodle.git] / lib / deprecatedlib.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  * deprecatedlib.php - Old functions retained only for backward compatibility
20  *
21  * Old functions retained only for backward compatibility.  New code should not
22  * use any of these functions.
23  *
24  * @package    core
25  * @subpackage deprecated
26  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  * @deprecated
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /* === Functions that needs to be kept longer in deprecated lib than normal time period === */
35 /**
36  * Add an entry to the legacy log table.
37  *
38  * @deprecated since 2.7 use new events instead
39  *
40  * @param    int     $courseid  The course id
41  * @param    string  $module  The module name  e.g. forum, journal, resource, course, user etc
42  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
43  * @param    string  $url     The file and parameters used to see the results of the action
44  * @param    string  $info    Additional description information
45  * @param    int     $cm      The course_module->id if there is one
46  * @param    int|stdClass $user If log regards $user other than $USER
47  * @return void
48  */
49 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
50     debugging('add_to_log() has been deprecated, please rewrite your code to the new events API', DEBUG_DEVELOPER);
52     // This is a nasty hack that allows us to put all the legacy stuff into legacy storage,
53     // this way we may move all the legacy settings there too.
54     $manager = get_log_manager();
55     if (method_exists($manager, 'legacy_add_to_log')) {
56         $manager->legacy_add_to_log($courseid, $module, $action, $url, $info, $cm, $user);
57     }
58 }
60 /**
61  * Function to call all event handlers when triggering an event
62  *
63  * @deprecated since 2.6
64  *
65  * @param string $eventname name of the event
66  * @param mixed $eventdata event data object
67  * @return int number of failed events
68  */
69 function events_trigger($eventname, $eventdata) {
70     debugging('events_trigger() is deprecated, please use new events instead', DEBUG_DEVELOPER);
71     return events_trigger_legacy($eventname, $eventdata);
72 }
74 /**
75  * List all core subsystems and their location
76  *
77  * This is a whitelist of components that are part of the core and their
78  * language strings are defined in /lang/en/<<subsystem>>.php. If a given
79  * plugin is not listed here and it does not have proper plugintype prefix,
80  * then it is considered as course activity module.
81  *
82  * The location is optionally dirroot relative path. NULL means there is no special
83  * directory for this subsystem. If the location is set, the subsystem's
84  * renderer.php is expected to be there.
85  *
86  * @deprecated since 2.6, use core_component::get_core_subsystems()
87  *
88  * @param bool $fullpaths false means relative paths from dirroot, use true for performance reasons
89  * @return array of (string)name => (string|null)location
90  */
91 function get_core_subsystems($fullpaths = false) {
92     global $CFG;
94     // NOTE: do not add any other debugging here, keep forever.
96     $subsystems = core_component::get_core_subsystems();
98     if ($fullpaths) {
99         return $subsystems;
100     }
102     debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
104     $dlength = strlen($CFG->dirroot);
106     foreach ($subsystems as $k => $v) {
107         if ($v === null) {
108             continue;
109         }
110         $subsystems[$k] = substr($v, $dlength+1);
111     }
113     return $subsystems;
116 /**
117  * Lists all plugin types.
118  *
119  * @deprecated since 2.6, use core_component::get_plugin_types()
120  *
121  * @param bool $fullpaths false means relative paths from dirroot
122  * @return array Array of strings - name=>location
123  */
124 function get_plugin_types($fullpaths = true) {
125     global $CFG;
127     // NOTE: do not add any other debugging here, keep forever.
129     $types = core_component::get_plugin_types();
131     if ($fullpaths) {
132         return $types;
133     }
135     debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
137     $dlength = strlen($CFG->dirroot);
139     foreach ($types as $k => $v) {
140         if ($k === 'theme') {
141             $types[$k] = 'theme';
142             continue;
143         }
144         $types[$k] = substr($v, $dlength+1);
145     }
147     return $types;
150 /**
151  * Use when listing real plugins of one type.
152  *
153  * @deprecated since 2.6, use core_component::get_plugin_list()
154  *
155  * @param string $plugintype type of plugin
156  * @return array name=>fulllocation pairs of plugins of given type
157  */
158 function get_plugin_list($plugintype) {
160     // NOTE: do not add any other debugging here, keep forever.
162     if ($plugintype === '') {
163         $plugintype = 'mod';
164     }
166     return core_component::get_plugin_list($plugintype);
169 /**
170  * Get a list of all the plugins of a given type that define a certain class
171  * in a certain file. The plugin component names and class names are returned.
172  *
173  * @deprecated since 2.6, use core_component::get_plugin_list_with_class()
174  *
175  * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
176  * @param string $class the part of the name of the class after the
177  *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
178  *      names like report_courselist_thing. If you are looking for classes with
179  *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
180  * @param string $file the name of file within the plugin that defines the class.
181  * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
182  *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
183  */
184 function get_plugin_list_with_class($plugintype, $class, $file) {
186     // NOTE: do not add any other debugging here, keep forever.
188     return core_component::get_plugin_list_with_class($plugintype, $class, $file);
191 /**
192  * Returns the exact absolute path to plugin directory.
193  *
194  * @deprecated since 2.6, use core_component::get_plugin_directory()
195  *
196  * @param string $plugintype type of plugin
197  * @param string $name name of the plugin
198  * @return string full path to plugin directory; NULL if not found
199  */
200 function get_plugin_directory($plugintype, $name) {
202     // NOTE: do not add any other debugging here, keep forever.
204     if ($plugintype === '') {
205         $plugintype = 'mod';
206     }
208     return core_component::get_plugin_directory($plugintype, $name);
211 /**
212  * Normalize the component name using the "frankenstyle" names.
213  *
214  * @deprecated since 2.6, use core_component::normalize_component()
215  *
216  * @param string $component
217  * @return array two-items list of [(string)type, (string|null)name]
218  */
219 function normalize_component($component) {
221     // NOTE: do not add any other debugging here, keep forever.
223     return core_component::normalize_component($component);
226 /**
227  * Return exact absolute path to a plugin directory.
228  *
229  * @deprecated since 2.6, use core_component::normalize_component()
230  *
231  * @param string $component name such as 'moodle', 'mod_forum'
232  * @return string full path to component directory; NULL if not found
233  */
234 function get_component_directory($component) {
236     // NOTE: do not add any other debugging here, keep forever.
238     return core_component::get_component_directory($component);
241 /**
242  * Get the context instance as an object. This function will create the
243  * context instance if it does not exist yet.
244  *
245  * @deprecated since 2.2, use context_course::instance() or other relevant class instead
246  * @todo This will be deleted in Moodle 2.8, refer MDL-34472
247  * @param integer $contextlevel The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
248  * @param integer $instance The instance id. For $level = CONTEXT_COURSE, this would be $course->id,
249  *      for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
250  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
251  *      MUST_EXIST means throw exception if no record or multiple records found
252  * @return context The context object.
253  */
254 function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
256     debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
258     $instances = (array)$instance;
259     $contexts = array();
261     $classname = context_helper::get_class_for_level($contextlevel);
263     // we do not load multiple contexts any more, PAGE should be responsible for any preloading
264     foreach ($instances as $inst) {
265         $contexts[$inst] = $classname::instance($inst, $strictness);
266     }
268     if (is_array($instance)) {
269         return $contexts;
270     } else {
271         return $contexts[$instance];
272     }
274 /* === End of long term deprecated api list === */
276 /**
277  * @deprecated since 2.7 - use new file picker instead
278  */
279 function clam_log_upload() {
280     throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
283 /**
284  * @deprecated since 2.7 - use new file picker instead
285  */
286 function clam_log_infected() {
287     throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
290 /**
291  * @deprecated since 2.7 - use new file picker instead
292  */
293 function clam_change_log() {
294     throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
297 /**
298  * @deprecated since 2.7 - infected files are now deleted in file picker
299  */
300 function clam_replace_infected_file() {
301     throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
304 /**
305  * @deprecated since 2.7
306  */
307 function clam_handle_infected_file() {
308     throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
311 /**
312  * @deprecated since 2.7
313  */
314 function clam_scan_moodle_file() {
315     throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
319 /**
320  * @deprecated since 2.7 PHP 5.4.x should be always compatible.
321  */
322 function password_compat_not_supported() {
323     throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
326 /**
327  * @deprecated since 2.6
328  */
329 function session_get_instance() {
330     throw new coding_exception('session_get_instance() is removed, use \core\session\manager instead');
333 /**
334  * @deprecated since 2.6
335  */
336 function session_is_legacy() {
337     throw new coding_exception('session_is_legacy() is removed, do not use any more');
340 /**
341  * @deprecated since 2.6
342  */
343 function session_kill_all() {
344     throw new coding_exception('session_kill_all() is removed, use \core\session\manager::kill_all_sessions() instead');
347 /**
348  * @deprecated since 2.6
349  */
350 function session_touch() {
351     throw new coding_exception('session_touch() is removed, use \core\session\manager::touch_session() instead');
354 /**
355  * @deprecated since 2.6
356  */
357 function session_kill() {
358     throw new coding_exception('session_kill() is removed, use \core\session\manager::kill_session() instead');
361 /**
362  * @deprecated since 2.6
363  */
364 function session_kill_user() {
365     throw new coding_exception('session_kill_user() is removed, use \core\session\manager::kill_user_sessions() instead');
368 /**
369  * @deprecated since 2.6
370  */
371 function session_set_user() {
372     throw new coding_exception('session_set_user() is removed, use \core\session\manager::set_user() instead');
375 /**
376  * @deprecated since 2.6
377  */
378 function session_is_loggedinas() {
379     throw new coding_exception('session_is_loggedinas() is removed, use \core\session\manager::is_loggedinas() instead');
382 /**
383  * @deprecated since 2.6
384  */
385 function session_get_realuser() {
386     throw new coding_exception('session_get_realuser() is removed, use \core\session\manager::get_realuser() instead');
389 /**
390  * @deprecated since 2.6
391  */
392 function session_loginas() {
393     throw new coding_exception('session_loginas() is removed, use \core\session\manager::loginas() instead');
396 /**
397  * @deprecated since 2.6
398  */
399 function js_minify() {
400     throw new coding_exception('js_minify() is removed, use core_minify::js_files() or core_minify::js() instead.');
403 /**
404  * @deprecated since 2.6
405  */
406 function css_minify_css() {
407     throw new coding_exception('css_minify_css() is removed, use core_minify::css_files() or core_minify::css() instead.');
410 // === Deprecated before 2.6.0 ===
412 /**
413  * @deprecated
414  */
415 function check_gd_version() {
416     throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
419 /**
420  * @deprecated
421  */
422 function update_login_count() {
423     throw new coding_exception('update_login_count() is removed, all calls need to be removed');
426 /**
427  * @deprecated
428  */
429 function reset_login_count() {
430     throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
433 /**
434  * @deprecated
435  */
436 function update_log_display_entry() {
438     throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
441 /**
442  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
443  *             this was abused mostly for embedding of attachments
444  */
445 function filter_text() {
446     throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
449 /**
450  * @deprecated Loginhttps is no longer supported
451  */
452 function httpsrequired() {
453     throw new coding_exception('httpsrequired() can not be used any more. Loginhttps is no longer supported.');
456 /**
457  * @deprecated since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example:
458  * The moodle_url::make_legacyfile_url() method can be used to generate a legacy course file url. To generate
459  * course module file.php url the moodle_url::make_file_url() should be used.
460  */
461 function get_file_url() {
462     throw new coding_exception('get_file_url() can not be used anymore. Please use ' .
463         'moodle_url factory methods instead.');
466 /**
467  * @deprecated use get_enrolled_users($context) instead.
468  */
469 function get_course_participants() {
470     throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
473 /**
474  * @deprecated use is_enrolled($context, $userid) instead.
475  */
476 function is_course_participant() {
477     throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
480 /**
481  * @deprecated
482  */
483 function get_recent_enrolments() {
484     throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
487 /**
488  * @deprecated use clean_param($string, PARAM_FILE) instead.
489  */
490 function detect_munged_arguments() {
491     throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
495 /**
496  * Unzip one zip file to a destination dir
497  * Both parameters must be FULL paths
498  * If destination isn't specified, it will be the
499  * SAME directory where the zip file resides.
500  *
501  * @global object
502  * @param string $zipfile The zip file to unzip
503  * @param string $destination The location to unzip to
504  * @param bool $showstatus_ignored Unused
505  * @deprecated since 2.0 MDL-15919
506  */
507 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
508     debugging(__FUNCTION__ . '() is deprecated. '
509             . 'Please use the application/zip file_packer implementation instead.', DEBUG_DEVELOPER);
511     // Extract everything from zipfile.
512     $path_parts = pathinfo(cleardoubleslashes($zipfile));
513     $zippath = $path_parts["dirname"];       //The path of the zip file
514     $zipfilename = $path_parts["basename"];  //The name of the zip file
515     $extension = $path_parts["extension"];    //The extension of the file
517     //If no file, error
518     if (empty($zipfilename)) {
519         return false;
520     }
522     //If no extension, error
523     if (empty($extension)) {
524         return false;
525     }
527     //Clear $zipfile
528     $zipfile = cleardoubleslashes($zipfile);
530     //Check zipfile exists
531     if (!file_exists($zipfile)) {
532         return false;
533     }
535     //If no destination, passed let's go with the same directory
536     if (empty($destination)) {
537         $destination = $zippath;
538     }
540     //Clear $destination
541     $destpath = rtrim(cleardoubleslashes($destination), "/");
543     //Check destination path exists
544     if (!is_dir($destpath)) {
545         return false;
546     }
548     $packer = get_file_packer('application/zip');
550     $result = $packer->extract_to_pathname($zipfile, $destpath);
552     if ($result === false) {
553         return false;
554     }
556     foreach ($result as $status) {
557         if ($status !== true) {
558             return false;
559         }
560     }
562     return true;
565 /**
566  * Zip an array of files/dirs to a destination zip file
567  * Both parameters must be FULL paths to the files/dirs
568  *
569  * @global object
570  * @param array $originalfiles Files to zip
571  * @param string $destination The destination path
572  * @return bool Outcome
573  *
574  * @deprecated since 2.0 MDL-15919
575  */
576 function zip_files($originalfiles, $destination) {
577     debugging(__FUNCTION__ . '() is deprecated. '
578             . 'Please use the application/zip file_packer implementation instead.', DEBUG_DEVELOPER);
580     // Extract everything from destination.
581     $path_parts = pathinfo(cleardoubleslashes($destination));
582     $destpath = $path_parts["dirname"];       //The path of the zip file
583     $destfilename = $path_parts["basename"];  //The name of the zip file
584     $extension = $path_parts["extension"];    //The extension of the file
586     //If no file, error
587     if (empty($destfilename)) {
588         return false;
589     }
591     //If no extension, add it
592     if (empty($extension)) {
593         $extension = 'zip';
594         $destfilename = $destfilename.'.'.$extension;
595     }
597     //Check destination path exists
598     if (!is_dir($destpath)) {
599         return false;
600     }
602     //Check destination path is writable. TODO!!
604     //Clean destination filename
605     $destfilename = clean_filename($destfilename);
607     //Now check and prepare every file
608     $files = array();
609     $origpath = NULL;
611     foreach ($originalfiles as $file) {  //Iterate over each file
612         //Check for every file
613         $tempfile = cleardoubleslashes($file); // no doubleslashes!
614         //Calculate the base path for all files if it isn't set
615         if ($origpath === NULL) {
616             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
617         }
618         //See if the file is readable
619         if (!is_readable($tempfile)) {  //Is readable
620             continue;
621         }
622         //See if the file/dir is in the same directory than the rest
623         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
624             continue;
625         }
626         //Add the file to the array
627         $files[] = $tempfile;
628     }
630     $zipfiles = array();
631     $start = strlen($origpath)+1;
632     foreach($files as $file) {
633         $zipfiles[substr($file, $start)] = $file;
634     }
636     $packer = get_file_packer('application/zip');
638     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
641 /**
642  * @deprecated use groups_get_all_groups() instead.
643  */
644 function mygroupid() {
645     throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
648 /**
649  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
650  */
651 function groupmode() {
652     throw new coding_exception('groupmode() can not be used any more, please use groups_get_* instead.');
655 /**
656  * @deprecated Since year 2006 - please do not use this function any more.
657  */
658 function set_current_group() {
659     throw new coding_exception('set_current_group() can not be used anymore, please use $SESSION->currentgroup[$courseid] instead');
662 /**
663  * @deprecated Since year 2006 - please do not use this function any more.
664  */
665 function get_current_group() {
666     throw new coding_exception('get_current_group() can not be used any more, please use groups_get_* instead');
669 /**
670  * @deprecated Since Moodle 2.8
671  */
672 function groups_filter_users_by_course_module_visible() {
673     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
674             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
675             'which does basically the same thing but includes other restrictions such ' .
676             'as profile restrictions.');
679 /**
680  * @deprecated Since Moodle 2.8
681  */
682 function groups_course_module_visible() {
683     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
684         user can ' . 'access an activity.', DEBUG_DEVELOPER);
687 /**
688  * @deprecated since 2.0
689  */
690 function error() {
691     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
692             print_error() instead of error()');
696 /**
697  * @deprecated use $PAGE->theme->name instead.
698  */
699 function current_theme() {
700     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
703 /**
704  * @deprecated
705  */
706 function formerr() {
707     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
710 /**
711  * @deprecated use $OUTPUT->skip_link_target() in instead.
712  */
713 function skip_main_destination() {
714     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
717 /**
718  * @deprecated use $OUTPUT->container() instead.
719  */
720 function print_container() {
721     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
724 /**
725  * @deprecated use $OUTPUT->container_start() instead.
726  */
727 function print_container_start() {
728     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
731 /**
732  * @deprecated use $OUTPUT->container_end() instead.
733  */
734 function print_container_end() {
735     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
738 /**
739  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
740  */
741 function notify() {
742     throw new coding_exception('notify() is removed, please use $OUTPUT->notification() instead');
745 /**
746  * @deprecated use $OUTPUT->continue_button() instead.
747  */
748 function print_continue() {
749     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
752 /**
753  * @deprecated use $PAGE methods instead.
754  */
755 function print_header() {
757     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
760 /**
761  * @deprecated use $PAGE methods instead.
762  */
763 function print_header_simple() {
765     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
768 /**
769  * @deprecated use $OUTPUT->block() instead.
770  */
771 function print_side_block() {
772     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
775 /**
776  * Prints a basic textarea field.
777  *
778  * @deprecated since Moodle 2.0
779  *
780  * When using this function, you should
781  *
782  * @global object
783  * @param bool $unused No longer used.
784  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
785  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
786  * @param null $width (Deprecated) Width of the element; if a value is passed, the minimum value for $cols will be 65. Value is otherwise ignored.
787  * @param null $height (Deprecated) Height of the element; if a value is passe, the minimum value for $rows will be 10. Value is otherwise ignored.
788  * @param string $name Name to use for the textarea element.
789  * @param string $value Initial content to display in the textarea.
790  * @param int $obsolete deprecated
791  * @param bool $return If false, will output string. If true, will return string value.
792  * @param string $id CSS ID to add to the textarea element.
793  * @return string|void depending on the value of $return
794  */
795 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
796     /// $width and height are legacy fields and no longer used as pixels like they used to be.
797     /// However, you can set them to zero to override the mincols and minrows values below.
799     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
800     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
802     global $CFG;
804     $mincols = 65;
805     $minrows = 10;
806     $str = '';
808     if ($id === '') {
809         $id = 'edit-'.$name;
810     }
812     if ($height && ($rows < $minrows)) {
813         $rows = $minrows;
814     }
815     if ($width && ($cols < $mincols)) {
816         $cols = $mincols;
817     }
819     editors_head_setup();
820     $editor = editors_get_preferred_editor(FORMAT_HTML);
821     $editor->set_text($value);
822     $editor->use_editor($id, array('legacy'=>true));
824     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
825     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
826     $str .= '</textarea>'."\n";
828     if ($return) {
829         return $str;
830     }
831     echo $str;
834 /**
835  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
836  * provide this function with the language strings for sortasc and sortdesc.
837  *
838  * @deprecated use $OUTPUT->arrow() instead.
839  * @todo final deprecation of this function once MDL-45448 is resolved
840  *
841  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
842  *
843  * @global object
844  * @param string $direction 'up' or 'down'
845  * @param string $strsort The language string used for the alt attribute of this image
846  * @param bool $return Whether to print directly or return the html string
847  * @return string|void depending on $return
848  *
849  */
850 function print_arrow($direction='up', $strsort=null, $return=false) {
851     global $OUTPUT;
853     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
855     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
856         return null;
857     }
859     $return = null;
861     switch ($direction) {
862         case 'up':
863             $sortdir = 'asc';
864             break;
865         case 'down':
866             $sortdir = 'desc';
867             break;
868         case 'move':
869             $sortdir = 'asc';
870             break;
871         default:
872             $sortdir = null;
873             break;
874     }
876     // Prepare language string
877     $strsort = '';
878     if (empty($strsort) && !empty($sortdir)) {
879         $strsort  = get_string('sort' . $sortdir, 'grades');
880     }
882     $return = ' ' . $OUTPUT->pix_icon('t/' . $direction, $strsort) . ' ';
884     if ($return) {
885         return $return;
886     } else {
887         echo $return;
888     }
891 /**
892  * @deprecated since Moodle 2.0
893  */
894 function choose_from_menu() {
895     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
898 /**
899  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
900  */
901 function print_scale_menu_helpbutton() {
902     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
903         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
906 /**
907  * @deprecated use html_writer::checkbox() instead.
908  */
909 function print_checkbox() {
910     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
913 /**
914  * Prints the 'update this xxx' button that appears on module pages.
915  *
916  * @deprecated since Moodle 3.2
917  *
918  * @param string $cmid the course_module id.
919  * @param string $ignored not used any more. (Used to be courseid.)
920  * @param string $string the module name - get_string('modulename', 'xxx')
921  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
922  */
923 function update_module_button($cmid, $ignored, $string) {
924     global $CFG, $OUTPUT;
926     debugging('update_module_button() has been deprecated and should not be used anymore. Activity modules should not add the ' .
927         'edit module button, the link is already available in the Administration block. Themes can choose to display the link ' .
928         'in the buttons row consistently for all module types.', DEBUG_DEVELOPER);
930     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
931         $string = get_string('updatethis', '', $string);
933         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
934         return $OUTPUT->single_button($url, $string);
935     } else {
936         return '';
937     }
940 /**
941  * @deprecated use $OUTPUT->navbar() instead
942  */
943 function print_navigation () {
944     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
947 /**
948  * @deprecated Please use $PAGE->navabar methods instead.
949  */
950 function build_navigation() {
951     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
954 /**
955  * @deprecated not relevant with global navigation in Moodle 2.x+
956  */
957 function navmenu() {
958     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
961 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
964 /**
965  * @deprecated please use calendar_event::create() instead.
966  */
967 function add_event() {
968     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
971 /**
972  * @deprecated please calendar_event->update() instead.
973  */
974 function update_event() {
975     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
978 /**
979  * @deprecated please use calendar_event->delete() instead.
980  */
981 function delete_event() {
982     throw new coding_exception('delete_event() can not be used any more, please use '.
983         'calendar_event->delete() instead.');
986 /**
987  * @deprecated please use calendar_event->toggle_visibility(false) instead.
988  */
989 function hide_event() {
990     throw new coding_exception('hide_event() can not be used any more, please use '.
991         'calendar_event->toggle_visibility(false) instead.');
994 /**
995  * @deprecated please use calendar_event->toggle_visibility(true) instead.
996  */
997 function show_event() {
998     throw new coding_exception('show_event() can not be used any more, please use '.
999         'calendar_event->toggle_visibility(true) instead.');
1002 /**
1003  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1004  */
1005 function textlib_get_instance() {
1006     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1007         'core_text::functioname() instead.');
1010 /**
1011  * @deprecated since 2.4
1012  */
1013 function get_generic_section_name() {
1014     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1017 /**
1018  * @deprecated since 2.4
1019  */
1020 function get_all_sections() {
1021     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1024 /**
1025  * @deprecated since 2.4
1026  */
1027 function add_mod_to_section() {
1028     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1031 /**
1032  * @deprecated since 2.4
1033  */
1034 function get_all_mods() {
1035     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1038 /**
1039  * @deprecated since 2.4
1040  */
1041 function get_course_section() {
1042     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1045 /**
1046  * @deprecated since 2.4
1047  */
1048 function format_weeks_get_section_dates() {
1049     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1050             ' use it outside of format_weeks plugin');
1053 /**
1054  * @deprecated since 2.5
1055  */
1056 function get_print_section_cm_text() {
1057     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1058             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1061 /**
1062  * @deprecated since 2.5
1063  */
1064 function print_section_add_menus() {
1065     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1066             'function course_section_add_cm_control()');
1069 /**
1070  * @deprecated since 2.5. Please use:
1071  * $courserenderer = $PAGE->get_renderer('core', 'course');
1072  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1073  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1074  */
1075 function make_editing_buttons() {
1076     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1077             'lib/deprecatedlib.php on how to replace it');
1080 /**
1081  * @deprecated since 2.5
1082  */
1083 function print_section() {
1084     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1085             'course_section_cm_list() instead.');
1088 /**
1089  * @deprecated since 2.5
1090  */
1091 function print_overview() {
1092     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1095 /**
1096  * @deprecated since 2.5
1097  */
1098 function print_recent_activity() {
1099     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1100             ' use it outside of block_recent_activity');
1103 /**
1104  * @deprecated since 2.5
1105  */
1106 function delete_course_module() {
1107     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1110 /**
1111  * @deprecated since 2.5
1112  */
1113 function update_category_button() {
1114     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1115             'and edit courses are now separate and no longer depend on editing mode.');
1118 /**
1119  * @deprecated since 2.5
1120  */
1121 function make_categories_list() {
1122     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1123             'coursecat::make_categories_list() and coursecat::get_parents()');
1126 /**
1127  * @deprecated since 2.5
1128  */
1129 function category_delete_move() {
1130     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1133 /**
1134  * @deprecated since 2.5
1135  */
1136 function category_delete_full() {
1137     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1140 /**
1141  * @deprecated since 2.5
1142  */
1143 function move_category() {
1144     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1147 /**
1148  * @deprecated since 2.5
1149  */
1150 function course_category_hide() {
1151     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1154 /**
1155  * @deprecated since 2.5
1156  */
1157 function course_category_show() {
1158     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1161 /**
1162  * @deprecated since 2.5. Please use coursecat::get($catid, IGNORE_MISSING) or coursecat::get($catid, MUST_EXIST).
1163  */
1164 function get_course_category() {
1165     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1168 /**
1169  * @deprecated since 2.5
1170  */
1171 function create_course_category() {
1172     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create()');
1175 /**
1176  * @deprecated since 2.5. Please use coursecat::get() and coursecat::get_children()
1177  */
1178 function get_all_subcategories() {
1179     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() ' .
1180             'of coursecat class.');
1183 /**
1184  * @deprecated since 2.5. Please use coursecat::get($parentid)->get_children().
1185  */
1186 function get_child_categories() {
1187     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children().');
1190 /**
1191  * @deprecated since 2.5
1192  */
1193 function get_categories() {
1194     throw new coding_exception('Function get_categories() is removed. Please use ' .
1195             'appropriate functions from class coursecat');
1198 /**
1199 * @deprecated since 2.5
1200 */
1201 function print_course_search() {
1202     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1205 /**
1206  * @deprecated since 2.5
1207  */
1208 function print_my_moodle() {
1209     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer ' .
1210             'function frontpage_my_courses()');
1213 /**
1214  * @deprecated since 2.5
1215  */
1216 function print_remote_course() {
1217     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1220 /**
1221  * @deprecated since 2.5
1222  */
1223 function print_remote_host() {
1224     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1227 /**
1228  * @deprecated since 2.5
1229  */
1230 function print_whole_category_list() {
1231     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1234 /**
1235  * @deprecated since 2.5
1236  */
1237 function print_category_info() {
1238     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1241 /**
1242  * @deprecated since 2.5
1243  */
1244 function get_course_category_tree() {
1245     throw new coding_exception('Function get_course_category_tree() is removed, please use course ' .
1246             'renderer or coursecat class, see function phpdocs for more info');
1249 /**
1250  * @deprecated since 2.5
1251  */
1252 function print_courses() {
1253     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1256 /**
1257  * @deprecated since 2.5
1258  */
1259 function print_course() {
1260     throw new coding_exception('Function print_course() is removed, please use course renderer');
1263 /**
1264  * @deprecated since 2.5
1265  */
1266 function get_category_courses_array() {
1267     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1270 /**
1271  * @deprecated since 2.5
1272  */
1273 function get_category_courses_array_recursively() {
1274     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1277 /**
1278  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1279  */
1280 function blog_get_context_url() {
1281     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1284 /**
1285  * @deprecated since 2.5
1286  */
1287 function get_courses_wmanagers() {
1288     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1291 /**
1292  * @deprecated since 2.5
1293  */
1294 function convert_tree_to_html() {
1295     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1298 /**
1299  * @deprecated since 2.5
1300  */
1301 function convert_tabrows_to_tree() {
1302     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1305 /**
1306  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1307  */
1308 function can_use_rotated_text() {
1309     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1312 /**
1313  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1314  */
1315 function get_context_instance_by_id() {
1316     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1319 /**
1320  * Returns system context or null if can not be created yet.
1321  *
1322  * @see context_system::instance()
1323  * @deprecated since 2.2
1324  * @param bool $cache use caching
1325  * @return context system context (null if context table not created yet)
1326  */
1327 function get_system_context($cache = true) {
1328     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1329     return context_system::instance(0, IGNORE_MISSING, $cache);
1332 /**
1333  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1334  */
1335 function get_parent_contexts() {
1336     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1339 /**
1340  * @deprecated since Moodle 2.2
1341  */
1342 function get_parent_contextid() {
1343     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1346 /**
1347  * @deprecated since 2.2
1348  */
1349 function get_child_contexts() {
1350     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1353 /**
1354  * @deprecated since 2.2
1355  */
1356 function create_contexts() {
1357     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1360 /**
1361  * @deprecated since 2.2
1362  */
1363 function cleanup_contexts() {
1364     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1367 /**
1368  * @deprecated since 2.2
1369  */
1370 function build_context_path() {
1371     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1374 /**
1375  * @deprecated since 2.2
1376  */
1377 function rebuild_contexts() {
1378     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1381 /**
1382  * @deprecated since Moodle 2.2
1383  */
1384 function preload_course_contexts() {
1385     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1388 /**
1389  * @deprecated since Moodle 2.2
1390  */
1391 function context_moved() {
1392     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1395 /**
1396  * @deprecated since 2.2
1397  */
1398 function fetch_context_capabilities() {
1399     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1402 /**
1403  * @deprecated since 2.2
1404  */
1405 function context_instance_preload() {
1406     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1409 /**
1410  * @deprecated since 2.2
1411  */
1412 function get_contextlevel_name() {
1413     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1416 /**
1417  * @deprecated since 2.2
1418  */
1419 function print_context_name() {
1420     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1423 /**
1424  * @deprecated since 2.2, use $context->mark_dirty() instead
1425  */
1426 function mark_context_dirty() {
1427     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1430 /**
1431  * @deprecated since Moodle 2.2
1432  */
1433 function delete_context() {
1434     throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() ' .
1435             'or $context->delete_content() instead.');
1438 /**
1439  * @deprecated since 2.2
1440  */
1441 function get_context_url() {
1442     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1445 /**
1446  * @deprecated since 2.2
1447  */
1448 function get_course_context() {
1449     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1452 /**
1453  * @deprecated since 2.2
1454  */
1455 function get_user_courses_bycap() {
1456     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1459 /**
1460  * @deprecated since Moodle 2.2
1461  */
1462 function get_role_context_caps() {
1463     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1466 /**
1467  * @deprecated since 2.2
1468  */
1469 function get_courseid_from_context() {
1470     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1473 /**
1474  * @deprecated since 2.2
1475  */
1476 function context_instance_preload_sql() {
1477     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1480 /**
1481  * @deprecated since 2.2
1482  */
1483 function get_related_contexts_string() {
1484     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1487 /**
1488  * @deprecated since 2.6
1489  */
1490 function get_plugin_list_with_file() {
1491     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1494 /**
1495  * @deprecated since 2.6
1496  */
1497 function check_browser_operating_system() {
1498     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1501 /**
1502  * @deprecated since 2.6
1503  */
1504 function check_browser_version() {
1505     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1508 /**
1509  * @deprecated since 2.6
1510  */
1511 function get_device_type() {
1512     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1515 /**
1516  * @deprecated since 2.6
1517  */
1518 function get_device_type_list() {
1519     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1522 /**
1523  * @deprecated since 2.6
1524  */
1525 function get_selected_theme_for_device_type() {
1526     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1529 /**
1530  * @deprecated since 2.6
1531  */
1532 function get_device_cfg_var_name() {
1533     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
1536 /**
1537  * @deprecated since 2.6
1538  */
1539 function set_user_device_type() {
1540     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
1543 /**
1544  * @deprecated since 2.6
1545  */
1546 function get_user_device_type() {
1547     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
1550 /**
1551  * @deprecated since 2.6
1552  */
1553 function get_browser_version_classes() {
1554     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
1557 /**
1558  * @deprecated since Moodle 2.6
1559  */
1560 function generate_email_supportuser() {
1561     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
1564 /**
1565  * @deprecated since Moodle 2.6
1566  */
1567 function badges_get_issued_badge_info() {
1568     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
1571 /**
1572  * @deprecated since 2.6
1573  */
1574 function can_use_html_editor() {
1575     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
1579 /**
1580  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
1581  */
1582 function count_login_failures() {
1583     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
1586 /**
1587  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
1588  */
1589 function ajaxenabled() {
1590     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
1593 /**
1594  * @deprecated Since Moodle 2.7 MDL-44070
1595  */
1596 function coursemodule_visible_for_user() {
1597     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
1598             please use \core_availability\info_module::is_user_visible()');
1601 /**
1602  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
1603  */
1604 function enrol_cohort_get_cohorts() {
1605     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use '.
1606         'cohort_get_available_cohorts() instead');
1609 /**
1610  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
1611  */
1612 function enrol_cohort_can_view_cohort() {
1613     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
1616 /**
1617  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
1618  */
1619 function cohort_get_visible_list() {
1620     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
1621         "that correctly checks capabilities.');
1624 /**
1625  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
1626  */
1627 function enrol_cohort_enrol_all_users() {
1628     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
1631 /**
1632  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
1633  */
1634 function enrol_cohort_search_cohorts() {
1635     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
1638 /* === Apis deprecated in since Moodle 2.9 === */
1640 /**
1641  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
1642  */
1643 function message_current_user_is_involved() {
1644     throw new coding_exception('message_current_user_is_involved() can not be used any more.');
1647 /**
1648  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
1649  */
1650 function profile_display_badges() {
1651     throw new coding_exception('profile_display_badges() can not be used any more.');
1654 /**
1655  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
1656  */
1657 function useredit_shared_definition_preferences() {
1658     throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
1662 /**
1663  * @deprecated since Moodle 2.9
1664  */
1665 function calendar_normalize_tz() {
1666     throw new coding_exception('calendar_normalize_tz() can not be used any more, please use core_date::normalise_timezone() instead.');
1669 /**
1670  * @deprecated since Moodle 2.9
1671  */
1672 function get_user_timezone_offset() {
1673     throw new coding_exception('get_user_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
1677 /**
1678  * @deprecated since Moodle 2.9
1679  */
1680 function get_timezone_offset() {
1681     throw new coding_exception('get_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
1684 /**
1685  * @deprecated since Moodle 2.9
1686  */
1687 function get_list_of_timezones() {
1688     throw new coding_exception('get_list_of_timezones() can not be used any more, please use core_date::get_list_of_timezones() instead');
1691 /**
1692  * @deprecated since Moodle 2.9
1693  */
1694 function update_timezone_records() {
1695     throw new coding_exception('update_timezone_records() can not be used any more, please use standard PHP DateTime class instead');
1698 /**
1699  * @deprecated since Moodle 2.9
1700  */
1701 function calculate_user_dst_table() {
1702     throw new coding_exception('calculate_user_dst_table() can not be used any more, please use standard PHP DateTime class instead');
1705 /**
1706  * @deprecated since Moodle 2.9
1707  */
1708 function dst_changes_for_year() {
1709     throw new coding_exception('dst_changes_for_year() can not be used any more, please use standard DateTime class instead');
1712 /**
1713  * @deprecated since Moodle 2.9
1714  */
1715 function get_timezone_record() {
1716     throw new coding_exception('get_timezone_record() can not be used any more, please use standard PHP DateTime class instead');
1719 /* === Apis deprecated since Moodle 3.0 === */
1720 /**
1721  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
1722  */
1723 function get_referer() {
1724     throw new coding_exception('get_referer() can not be used any more. Please use get_local_referer() instead.');
1727 /**
1728  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
1729  */
1730 function is_web_crawler() {
1731     throw new coding_exception('is_web_crawler() can not be used any more. Please use core_useragent::is_web_crawler() instead.');
1734 /**
1735  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
1736  */
1737 function completion_cron() {
1738     throw new coding_exception('completion_cron() can not be used any more. Functionality has been moved to scheduled tasks.');
1741 /**
1742  * @deprecated since 3.0
1743  */
1744 function coursetag_get_tags() {
1745     throw new coding_exception('Function coursetag_get_tags() can not be used any more. ' .
1746             'Userid is no longer used for tagging courses.');
1749 /**
1750  * @deprecated since 3.0
1751  */
1752 function coursetag_get_all_tags() {
1753     throw new coding_exception('Function coursetag_get_all_tags() can not be used any more. Userid is no ' .
1754         'longer used for tagging courses.');
1757 /**
1758  * @deprecated since 3.0
1759  */
1760 function coursetag_get_jscript() {
1761     throw new coding_exception('Function coursetag_get_jscript() can not be used any more and is obsolete.');
1764 /**
1765  * @deprecated since 3.0
1766  */
1767 function coursetag_get_jscript_links() {
1768     throw new coding_exception('Function coursetag_get_jscript_links() can not be used any more and is obsolete.');
1771 /**
1772  * @deprecated since 3.0
1773  */
1774 function coursetag_get_records() {
1775     throw new coding_exception('Function coursetag_get_records() can not be used any more. ' .
1776             'Userid is no longer used for tagging courses.');
1779 /**
1780  * @deprecated since 3.0
1781  */
1782 function coursetag_store_keywords() {
1783     throw new coding_exception('Function coursetag_store_keywords() can not be used any more. ' .
1784             'Userid is no longer used for tagging courses.');
1787 /**
1788  * @deprecated since 3.0
1789  */
1790 function coursetag_delete_keyword() {
1791     throw new coding_exception('Function coursetag_delete_keyword() can not be used any more. ' .
1792             'Userid is no longer used for tagging courses.');
1795 /**
1796  * @deprecated since 3.0
1797  */
1798 function coursetag_get_tagged_courses() {
1799     throw new coding_exception('Function coursetag_get_tagged_courses() can not be used any more. ' .
1800             'Userid is no longer used for tagging courses.');
1803 /**
1804  * @deprecated since 3.0
1805  */
1806 function coursetag_delete_course_tags() {
1807     throw new coding_exception('Function coursetag_delete_course_tags() is deprecated. ' .
1808             'Use core_tag_tag::remove_all_item_tags().');
1811 /**
1812  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->update() instead
1813  */
1814 function tag_type_set() {
1815     throw new coding_exception('tag_type_set() can not be used anymore. Please use ' .
1816         'core_tag_tag::get($tagid)->update().');
1819 /**
1820  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->update() instead
1821  */
1822 function tag_description_set() {
1823     throw new coding_exception('tag_description_set() can not be used anymore. Please use ' .
1824         'core_tag_tag::get($tagid)->update().');
1827 /**
1828  * @deprecated since 3.1. Use core_tag_tag::get_item_tags() instead
1829  */
1830 function tag_get_tags() {
1831     throw new coding_exception('tag_get_tags() can not be used anymore. Please use ' .
1832         'core_tag_tag::get_item_tags().');
1835 /**
1836  * @deprecated since 3.1
1837  */
1838 function tag_get_tags_array() {
1839     throw new coding_exception('tag_get_tags_array() can not be used anymore. Please use ' .
1840         'core_tag_tag::get_item_tags_array().');
1843 /**
1844  * @deprecated since 3.1. Use core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags())
1845  */
1846 function tag_get_tags_csv() {
1847     throw new coding_exception('tag_get_tags_csv() can not be used anymore. Please use ' .
1848         'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()).');
1851 /**
1852  * @deprecated since 3.1. Use core_tag_tag::get_item_tags() instead
1853  */
1854 function tag_get_tags_ids() {
1855     throw new coding_exception('tag_get_tags_ids() can not be used anymore. Please consider using ' .
1856         'core_tag_tag::get_item_tags() or similar methods.');
1859 /**
1860  * @deprecated since 3.1. Use core_tag_tag::get_by_name() or core_tag_tag::get_by_name_bulk()
1861  */
1862 function tag_get_id() {
1863     throw new coding_exception('tag_get_id() can not be used anymore. Please use ' .
1864         'core_tag_tag::get_by_name() or core_tag_tag::get_by_name_bulk()');
1867 /**
1868  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->update() instead
1869  */
1870 function tag_rename() {
1871     throw new coding_exception('tag_rename() can not be used anymore. Please use ' .
1872         'core_tag_tag::get($tagid)->update()');
1875 /**
1876  * @deprecated since 3.1. Use core_tag_tag::remove_item_tag() instead
1877  */
1878 function tag_delete_instance() {
1879     throw new coding_exception('tag_delete_instance() can not be used anymore. Please use ' .
1880         'core_tag_tag::remove_item_tag()');
1883 /**
1884  * @deprecated since 3.1. Use core_tag_tag::get_by_name()->get_tagged_items() instead
1885  */
1886 function tag_find_records() {
1887     throw new coding_exception('tag_find_records() can not be used anymore. Please use ' .
1888         'core_tag_tag::get_by_name()->get_tagged_items()');
1891 /**
1892  * @deprecated since 3.1
1893  */
1894 function tag_add() {
1895     throw new coding_exception('tag_add() can not be used anymore. You can use ' .
1896         'core_tag_tag::create_if_missing(), however it should not be necessary since tags are ' .
1897         'created automatically when assigned to items');
1900 /**
1901  * @deprecated since 3.1. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead
1902  */
1903 function tag_assign() {
1904     throw new coding_exception('tag_assign() can not be used anymore. Please use ' .
1905         'core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. Tag instance ' .
1906         'ordering should not be set manually');
1909 /**
1910  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->count_tagged_items() instead
1911  */
1912 function tag_record_count() {
1913     throw new coding_exception('tag_record_count() can not be used anymore. Please use ' .
1914         'core_tag_tag::get($tagid)->count_tagged_items().');
1917 /**
1918  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->is_item_tagged_with() instead
1919  */
1920 function tag_record_tagged_with() {
1921     throw new coding_exception('tag_record_tagged_with() can not be used anymore. Please use ' .
1922         'core_tag_tag::get($tagid)->is_item_tagged_with().');
1925 /**
1926  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->flag() instead
1927  */
1928 function tag_set_flag() {
1929     throw new coding_exception('tag_set_flag() can not be used anymore. Please use ' .
1930         'core_tag_tag::get($tagid)->flag()');
1933 /**
1934  * @deprecated since 3.1. Use core_tag_tag::get($tagid)->reset_flag() instead
1935  */
1936 function tag_unset_flag() {
1937     throw new coding_exception('tag_unset_flag() can not be used anymore. Please use ' .
1938         'core_tag_tag::get($tagid)->reset_flag()');
1941 /**
1942  * @deprecated since 3.1
1943  */
1944 function tag_print_cloud() {
1945     throw new coding_exception('tag_print_cloud() can not be used anymore. Please use ' .
1946         'core_tag_collection::get_tag_cloud(), templateable core_tag\output\tagcloud and ' .
1947         'template core_tag/tagcloud.');
1950 /**
1951  * @deprecated since 3.0
1952  */
1953 function tag_autocomplete() {
1954     throw new coding_exception('tag_autocomplete() can not be used anymore. New form ' .
1955         'element "tags" does proper autocomplete.');
1958 /**
1959  * @deprecated since 3.1
1960  */
1961 function tag_print_description_box() {
1962     throw new coding_exception('tag_print_description_box() can not be used anymore. ' .
1963         'See core_tag_renderer for similar code');
1966 /**
1967  * @deprecated since 3.1
1968  */
1969 function tag_print_management_box() {
1970     throw new coding_exception('tag_print_management_box() can not be used anymore. ' .
1971         'See core_tag_renderer for similar code');
1974 /**
1975  * @deprecated since 3.1
1976  */
1977 function tag_print_search_box() {
1978     throw new coding_exception('tag_print_search_box() can not be used anymore. ' .
1979         'See core_tag_renderer for similar code');
1982 /**
1983  * @deprecated since 3.1
1984  */
1985 function tag_print_search_results() {
1986     throw new coding_exception('tag_print_search_results() can not be used anymore. ' .
1987         'In /tag/search.php the search results are printed using the core_tag/tagcloud template.');
1990 /**
1991  * @deprecated since 3.1
1992  */
1993 function tag_print_tagged_users_table() {
1994     throw new coding_exception('tag_print_tagged_users_table() can not be used anymore. ' .
1995         'See core_user_renderer for similar code');
1998 /**
1999  * @deprecated since 3.1
2000  */
2001 function tag_print_user_box() {
2002     throw new coding_exception('tag_print_user_box() can not be used anymore. ' .
2003         'See core_user_renderer for similar code');
2006 /**
2007  * @deprecated since 3.1
2008  */
2009 function tag_print_user_list() {
2010     throw new coding_exception('tag_print_user_list() can not be used anymore. ' .
2011         'See core_user_renderer for similar code');
2014 /**
2015  * @deprecated since 3.1
2016  */
2017 function tag_display_name() {
2018     throw new coding_exception('tag_display_name() can not be used anymore. Please use ' .
2019         'core_tag_tag::make_display_name().');
2023 /**
2024  * @deprecated since 3.1
2025  */
2026 function tag_normalize() {
2027     throw new coding_exception('tag_normalize() can not be used anymore. Please use ' .
2028         'core_tag_tag::normalize().');
2031 /**
2032  * @deprecated since 3.1
2033  */
2034 function tag_get_related_tags_csv() {
2035     throw new coding_exception('tag_get_related_tags_csv() can not be used anymore. Please ' .
2036         'consider looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags()).');
2039 /**
2040  * @deprecated since 3.1
2041  */
2042 function tag_set() {
2043     throw new coding_exception('tag_set() can not be used anymore. Please use ' .
2044         'core_tag_tag::set_item_tags().');
2047 /**
2048  * @deprecated since 3.1
2049  */
2050 function tag_set_add() {
2051     throw new coding_exception('tag_set_add() can not be used anymore. Please use ' .
2052         'core_tag_tag::add_item_tag().');
2055 /**
2056  * @deprecated since 3.1
2057  */
2058 function tag_set_delete() {
2059     throw new coding_exception('tag_set_delete() can not be used anymore. Please use ' .
2060         'core_tag_tag::remove_item_tag().');
2063 /**
2064  * @deprecated since 3.1
2065  */
2066 function tag_get() {
2067     throw new coding_exception('tag_get() can not be used anymore. Please use ' .
2068         'core_tag_tag::get() or core_tag_tag::get_by_name().');
2071 /**
2072  * @deprecated since 3.1
2073  */
2074 function tag_get_related_tags() {
2075     throw new coding_exception('tag_get_related_tags() can not be used anymore. Please use ' .
2076         'core_tag_tag::get_correlated_tags(), core_tag_tag::get_related_tags() or ' .
2077         'core_tag_tag::get_manual_related_tags().');
2080 /**
2081  * @deprecated since 3.1
2082  */
2083 function tag_delete() {
2084     throw new coding_exception('tag_delete() can not be used anymore. Please use ' .
2085         'core_tag_tag::delete_tags().');
2088 /**
2089  * @deprecated since 3.1
2090  */
2091 function tag_delete_instances() {
2092     throw new coding_exception('tag_delete_instances() can not be used anymore. Please use ' .
2093         'core_tag_tag::delete_instances().');
2096 /**
2097  * @deprecated since 3.1
2098  */
2099 function tag_cleanup() {
2100     throw new coding_exception('tag_cleanup() can not be used anymore. Please use ' .
2101         '\core\task\tag_cron_task::cleanup().');
2104 /**
2105  * @deprecated since 3.1
2106  */
2107 function tag_bulk_delete_instances() {
2108     throw new coding_exception('tag_bulk_delete_instances() can not be used anymore. Please use ' .
2109         '\core\task\tag_cron_task::bulk_delete_instances().');
2113 /**
2114  * @deprecated since 3.1
2115  */
2116 function tag_compute_correlations() {
2117     throw new coding_exception('tag_compute_correlations() can not be used anymore. Please use ' .
2118         'use \core\task\tag_cron_task::compute_correlations().');
2121 /**
2122  * @deprecated since 3.1
2123  */
2124 function tag_process_computed_correlation() {
2125     throw new coding_exception('tag_process_computed_correlation() can not be used anymore. Please use ' .
2126         'use \core\task\tag_cron_task::process_computed_correlation().');
2129 /**
2130  * @deprecated since 3.1
2131  */
2132 function tag_cron() {
2133     throw new coding_exception('tag_cron() can not be used anymore. Please use ' .
2134         'use \core\task\tag_cron_task::execute().');
2137 /**
2138  * @deprecated since 3.1
2139  */
2140 function tag_find_tags() {
2141     throw new coding_exception('tag_find_tags() can not be used anymore.');
2144 /**
2145  * @deprecated since 3.1
2146  */
2147 function tag_get_name() {
2148     throw new coding_exception('tag_get_name() can not be used anymore.');
2151 /**
2152  * @deprecated since 3.1
2153  */
2154 function tag_get_correlated() {
2155     throw new coding_exception('tag_get_correlated() can not be used anymore. Please use ' .
2156         'use core_tag_tag::get_correlated_tags().');
2160 /**
2161  * @deprecated since 3.1
2162  */
2163 function tag_cloud_sort() {
2164     throw new coding_exception('tag_cloud_sort() can not be used anymore. Similar method can ' .
2165         'be found in core_tag_collection::cloud_sort().');
2168 /**
2169  * Loads the events definitions for the component (from file). If no
2170  * events are defined for the component, we simply return an empty array.
2171  *
2172  * @access protected To be used from eventslib only
2173  * @deprecated since Moodle 3.1
2174  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
2175  * @return array Array of capabilities or empty array if not exists
2176  */
2177 function events_load_def($component) {
2178     global $CFG;
2179     if ($component === 'unittest') {
2180         $defpath = $CFG->dirroot.'/lib/tests/fixtures/events.php';
2181     } else {
2182         $defpath = core_component::get_component_directory($component).'/db/events.php';
2183     }
2185     $handlers = array();
2187     if (file_exists($defpath)) {
2188         require($defpath);
2189     }
2191     // make sure the definitions are valid and complete; tell devs what is wrong
2192     foreach ($handlers as $eventname => $handler) {
2193         if ($eventname === 'reset') {
2194             debugging("'reset' can not be used as event name.");
2195             unset($handlers['reset']);
2196             continue;
2197         }
2198         if (!is_array($handler)) {
2199             debugging("Handler of '$eventname' must be specified as array'");
2200             unset($handlers[$eventname]);
2201             continue;
2202         }
2203         if (!isset($handler['handlerfile'])) {
2204             debugging("Handler of '$eventname' must include 'handlerfile' key'");
2205             unset($handlers[$eventname]);
2206             continue;
2207         }
2208         if (!isset($handler['handlerfunction'])) {
2209             debugging("Handler of '$eventname' must include 'handlerfunction' key'");
2210             unset($handlers[$eventname]);
2211             continue;
2212         }
2213         if (!isset($handler['schedule'])) {
2214             $handler['schedule'] = 'instant';
2215         }
2216         if ($handler['schedule'] !== 'instant' and $handler['schedule'] !== 'cron') {
2217             debugging("Handler of '$eventname' must include valid 'schedule' type (instant or cron)'");
2218             unset($handlers[$eventname]);
2219             continue;
2220         }
2221         if (!isset($handler['internal'])) {
2222             $handler['internal'] = 1;
2223         }
2224         $handlers[$eventname] = $handler;
2225     }
2227     return $handlers;
2230 /**
2231  * Puts a handler on queue
2232  *
2233  * @access protected To be used from eventslib only
2234  * @deprecated since Moodle 3.1
2235  * @param stdClass $handler event handler object from db
2236  * @param stdClass $event event data object
2237  * @param string $errormessage The error message indicating the problem
2238  * @return int id number of new queue handler
2239  */
2240 function events_queue_handler($handler, $event, $errormessage) {
2241     global $DB;
2243     if ($qhandler = $DB->get_record('events_queue_handlers', array('queuedeventid'=>$event->id, 'handlerid'=>$handler->id))) {
2244         debugging("Please check code: Event id $event->id is already queued in handler id $qhandler->id");
2245         return $qhandler->id;
2246     }
2248     // make a new queue handler
2249     $qhandler = new stdClass();
2250     $qhandler->queuedeventid  = $event->id;
2251     $qhandler->handlerid      = $handler->id;
2252     $qhandler->errormessage   = $errormessage;
2253     $qhandler->timemodified   = time();
2254     if ($handler->schedule === 'instant' and $handler->status == 1) {
2255         $qhandler->status     = 1; //already one failed attempt to dispatch this event
2256     } else {
2257         $qhandler->status     = 0;
2258     }
2260     return $DB->insert_record('events_queue_handlers', $qhandler);
2263 /**
2264  * trigger a single event with a specified handler
2265  *
2266  * @access protected To be used from eventslib only
2267  * @deprecated since Moodle 3.1
2268  * @param stdClass $handler This shoudl be a row from the events_handlers table.
2269  * @param stdClass $eventdata An object containing information about the event
2270  * @param string $errormessage error message indicating problem
2271  * @return bool|null True means event processed, false means retry event later; may throw exception, NULL means internal error
2272  */
2273 function events_dispatch($handler, $eventdata, &$errormessage) {
2274     global $CFG;
2276     debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
2278     $function = unserialize($handler->handlerfunction);
2280     if (is_callable($function)) {
2281         // oki, no need for includes
2283     } else if (file_exists($CFG->dirroot.$handler->handlerfile)) {
2284         include_once($CFG->dirroot.$handler->handlerfile);
2286     } else {
2287         $errormessage = "Handler file of component $handler->component: $handler->handlerfile can not be found!";
2288         return null;
2289     }
2291     // checks for handler validity
2292     if (is_callable($function)) {
2293         $result = call_user_func($function, $eventdata);
2294         if ($result === false) {
2295             $errormessage = "Handler function of component $handler->component: $handler->handlerfunction requested resending of event!";
2296             return false;
2297         }
2298         return true;
2300     } else {
2301         $errormessage = "Handler function of component $handler->component: $handler->handlerfunction not callable function or class method!";
2302         return null;
2303     }
2306 /**
2307  * given a queued handler, call the respective event handler to process the event
2308  *
2309  * @access protected To be used from eventslib only
2310  * @deprecated since Moodle 3.1
2311  * @param stdClass $qhandler events_queued_handler row from db
2312  * @return boolean true means event processed, false means retry later, NULL means fatal failure
2313  */
2314 function events_process_queued_handler($qhandler) {
2315     global $DB;
2317     // get handler
2318     if (!$handler = $DB->get_record('events_handlers', array('id'=>$qhandler->handlerid))) {
2319         debugging("Error processing queue handler $qhandler->id, missing handler id: $qhandler->handlerid");
2320         //irrecoverable error, remove broken queue handler
2321         events_dequeue($qhandler);
2322         return NULL;
2323     }
2325     // get event object
2326     if (!$event = $DB->get_record('events_queue', array('id'=>$qhandler->queuedeventid))) {
2327         // can't proceed with no event object - might happen when two crons running at the same time
2328         debugging("Error processing queue handler $qhandler->id, missing event id: $qhandler->queuedeventid");
2329         //irrecoverable error, remove broken queue handler
2330         events_dequeue($qhandler);
2331         return NULL;
2332     }
2334     // call the function specified by the handler
2335     try {
2336         $errormessage = 'Unknown error';
2337         if (events_dispatch($handler, unserialize(base64_decode($event->eventdata)), $errormessage)) {
2338             //everything ok
2339             events_dequeue($qhandler);
2340             return true;
2341         }
2342     } catch (Exception $e) {
2343         // the problem here is that we do not want one broken handler to stop all others,
2344         // cron handlers are very tricky because the needed data might have been deleted before the cron execution
2345         $errormessage = "Handler function of component $handler->component: $handler->handlerfunction threw exception :" .
2346                 $e->getMessage() . "\n" . format_backtrace($e->getTrace(), true);
2347         if (!empty($e->debuginfo)) {
2348             $errormessage .= $e->debuginfo;
2349         }
2350     }
2352     //dispatching failed
2353     $qh = new stdClass();
2354     $qh->id           = $qhandler->id;
2355     $qh->errormessage = $errormessage;
2356     $qh->timemodified = time();
2357     $qh->status       = $qhandler->status + 1;
2358     $DB->update_record('events_queue_handlers', $qh);
2360     debugging($errormessage);
2362     return false;
2365 /**
2366  * Updates all of the event definitions within the database.
2367  *
2368  * Unfortunately this isn't as simple as removing them all and then readding
2369  * the updated event definitions. Chances are queued items are referencing the
2370  * existing definitions.
2371  *
2372  * Note that the absence of the db/events.php event definition file
2373  * will cause any queued events for the component to be removed from
2374  * the database.
2375  *
2376  * @category event
2377  * @deprecated since Moodle 3.1
2378  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
2379  * @return boolean always returns true
2380  */
2381 function events_update_definition($component='moodle') {
2382     global $DB;
2384     // load event definition from events.php
2385     $filehandlers = events_load_def($component);
2387     if ($filehandlers) {
2388         debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
2389     }
2391     // load event definitions from db tables
2392     // if we detect an event being already stored, we discard from this array later
2393     // the remaining needs to be removed
2394     $cachedhandlers = events_get_cached($component);
2396     foreach ($filehandlers as $eventname => $filehandler) {
2397         if (!empty($cachedhandlers[$eventname])) {
2398             if ($cachedhandlers[$eventname]['handlerfile'] === $filehandler['handlerfile'] &&
2399                 $cachedhandlers[$eventname]['handlerfunction'] === serialize($filehandler['handlerfunction']) &&
2400                 $cachedhandlers[$eventname]['schedule'] === $filehandler['schedule'] &&
2401                 $cachedhandlers[$eventname]['internal'] == $filehandler['internal']) {
2402                 // exact same event handler already present in db, ignore this entry
2404                 unset($cachedhandlers[$eventname]);
2405                 continue;
2407             } else {
2408                 // same event name matches, this event has been updated, update the datebase
2409                 $handler = new stdClass();
2410                 $handler->id              = $cachedhandlers[$eventname]['id'];
2411                 $handler->handlerfile     = $filehandler['handlerfile'];
2412                 $handler->handlerfunction = serialize($filehandler['handlerfunction']); // static class methods stored as array
2413                 $handler->schedule        = $filehandler['schedule'];
2414                 $handler->internal        = $filehandler['internal'];
2416                 $DB->update_record('events_handlers', $handler);
2418                 unset($cachedhandlers[$eventname]);
2419                 continue;
2420             }
2422         } else {
2423             // if we are here, this event handler is not present in db (new)
2424             // add it
2425             $handler = new stdClass();
2426             $handler->eventname       = $eventname;
2427             $handler->component       = $component;
2428             $handler->handlerfile     = $filehandler['handlerfile'];
2429             $handler->handlerfunction = serialize($filehandler['handlerfunction']); // static class methods stored as array
2430             $handler->schedule        = $filehandler['schedule'];
2431             $handler->status          = 0;
2432             $handler->internal        = $filehandler['internal'];
2434             $DB->insert_record('events_handlers', $handler);
2435         }
2436     }
2438     // clean up the left overs, the entries in cached events array at this points are deprecated event handlers
2439     // and should be removed, delete from db
2440     events_cleanup($component, $cachedhandlers);
2442     events_get_handlers('reset');
2444     return true;
2447 /**
2448  * Events cron will try to empty the events queue by processing all the queued events handlers
2449  *
2450  * @access public Part of the public API
2451  * @deprecated since Moodle 3.1
2452  * @category event
2453  * @param string $eventname empty means all
2454  * @return int number of dispatched events
2455  */
2456 function events_cron($eventname='') {
2457     global $DB;
2459     $failed = array();
2460     $processed = 0;
2462     if ($eventname) {
2463         $sql = "SELECT qh.*
2464                   FROM {events_queue_handlers} qh, {events_handlers} h
2465                  WHERE qh.handlerid = h.id AND h.eventname=?
2466               ORDER BY qh.id";
2467         $params = array($eventname);
2468     } else {
2469         $sql = "SELECT *
2470                   FROM {events_queue_handlers}
2471               ORDER BY id";
2472         $params = array();
2473     }
2475     $rs = $DB->get_recordset_sql($sql, $params);
2476     if ($rs->valid()) {
2477         debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
2478     }
2480     foreach ($rs as $qhandler) {
2481         if (isset($failed[$qhandler->handlerid])) {
2482             // do not try to dispatch any later events when one already asked for retry or ended with exception
2483             continue;
2484         }
2485         $status = events_process_queued_handler($qhandler);
2486         if ($status === false) {
2487             // handler is asking for retry, do not send other events to this handler now
2488             $failed[$qhandler->handlerid] = $qhandler->handlerid;
2489         } else if ($status === NULL) {
2490             // means completely broken handler, event data was purged
2491             $failed[$qhandler->handlerid] = $qhandler->handlerid;
2492         } else {
2493             $processed++;
2494         }
2495     }
2496     $rs->close();
2498     // remove events that do not have any handlers waiting
2499     $sql = "SELECT eq.id
2500               FROM {events_queue} eq
2501               LEFT JOIN {events_queue_handlers} qh ON qh.queuedeventid = eq.id
2502              WHERE qh.id IS NULL";
2503     $rs = $DB->get_recordset_sql($sql);
2504     foreach ($rs as $event) {
2505         //debugging('Purging stale event '.$event->id);
2506         $DB->delete_records('events_queue', array('id'=>$event->id));
2507     }
2508     $rs->close();
2510     return $processed;
2513 /**
2514  * Do not call directly, this is intended to be used from new event base only.
2515  *
2516  * @private
2517  * @deprecated since Moodle 3.1
2518  * @param string $eventname name of the event
2519  * @param mixed $eventdata event data object
2520  * @return int number of failed events
2521  */
2522 function events_trigger_legacy($eventname, $eventdata) {
2523     global $CFG, $USER, $DB;
2525     $failedcount = 0; // number of failed events.
2527     // pull out all registered event handlers
2528     if ($handlers = events_get_handlers($eventname)) {
2529         foreach ($handlers as $handler) {
2530             $errormessage = '';
2532             if ($handler->schedule === 'instant') {
2533                 if ($handler->status) {
2534                     //check if previous pending events processed
2535                     if (!$DB->record_exists('events_queue_handlers', array('handlerid'=>$handler->id))) {
2536                         // ok, queue is empty, lets reset the status back to 0 == ok
2537                         $handler->status = 0;
2538                         $DB->set_field('events_handlers', 'status', 0, array('id'=>$handler->id));
2539                         // reset static handler cache
2540                         events_get_handlers('reset');
2541                     }
2542                 }
2544                 // dispatch the event only if instant schedule and status ok
2545                 if ($handler->status or (!$handler->internal and $DB->is_transaction_started())) {
2546                     // increment the error status counter
2547                     $handler->status++;
2548                     $DB->set_field('events_handlers', 'status', $handler->status, array('id'=>$handler->id));
2549                     // reset static handler cache
2550                     events_get_handlers('reset');
2552                 } else {
2553                     $errormessage = 'Unknown error';
2554                     $result = events_dispatch($handler, $eventdata, $errormessage);
2555                     if ($result === true) {
2556                         // everything is fine - event dispatched
2557                         continue;
2558                     } else if ($result === false) {
2559                         // retry later - set error count to 1 == send next instant into cron queue
2560                         $DB->set_field('events_handlers', 'status', 1, array('id'=>$handler->id));
2561                         // reset static handler cache
2562                         events_get_handlers('reset');
2563                     } else {
2564                         // internal problem - ignore the event completely
2565                         $failedcount ++;
2566                         continue;
2567                     }
2568                 }
2570                 // update the failed counter
2571                 $failedcount ++;
2573             } else if ($handler->schedule === 'cron') {
2574                 //ok - use queueing of events only
2576             } else {
2577                 // unknown schedule - ignore event completely
2578                 debugging("Unknown handler schedule type: $handler->schedule");
2579                 $failedcount ++;
2580                 continue;
2581             }
2583             // if even type is not instant, or dispatch asked for retry, queue it
2584             $event = new stdClass();
2585             $event->userid      = $USER->id;
2586             $event->eventdata   = base64_encode(serialize($eventdata));
2587             $event->timecreated = time();
2588             if (debugging()) {
2589                 $dump = '';
2590                 $callers = debug_backtrace();
2591                 foreach ($callers as $caller) {
2592                     if (!isset($caller['line'])) {
2593                         $caller['line'] = '?';
2594                     }
2595                     if (!isset($caller['file'])) {
2596                         $caller['file'] = '?';
2597                     }
2598                     $dump .= 'line ' . $caller['line'] . ' of ' . substr($caller['file'], strlen($CFG->dirroot) + 1);
2599                     if (isset($caller['function'])) {
2600                         $dump .= ': call to ';
2601                         if (isset($caller['class'])) {
2602                             $dump .= $caller['class'] . $caller['type'];
2603                         }
2604                         $dump .= $caller['function'] . '()';
2605                     }
2606                     $dump .= "\n";
2607                 }
2608                 $event->stackdump = $dump;
2609             } else {
2610                 $event->stackdump = '';
2611             }
2612             $event->id = $DB->insert_record('events_queue', $event);
2613             events_queue_handler($handler, $event, $errormessage);
2614         }
2615     } else {
2616         // No handler found for this event name - this is ok!
2617     }
2619     return $failedcount;
2622 /**
2623  * checks if an event is registered for this component
2624  *
2625  * @access public Part of the public API
2626  * @deprecated since Moodle 3.1
2627  * @param string $eventname name of the event
2628  * @param string $component component name, can be mod/data or moodle
2629  * @return bool
2630  */
2631 function events_is_registered($eventname, $component) {
2632     global $DB;
2634     debugging('events_is_registered() has been deprecated along with all Events 1 API in favour of Events 2 API,' .
2635         ' please use it instead.', DEBUG_DEVELOPER);
2637     return $DB->record_exists('events_handlers', array('component'=>$component, 'eventname'=>$eventname));
2640 /**
2641  * checks if an event is queued for processing - either cron handlers attached or failed instant handlers
2642  *
2643  * @access public Part of the public API
2644  * @deprecated since Moodle 3.1
2645  * @param string $eventname name of the event
2646  * @return int number of queued events
2647  */
2648 function events_pending_count($eventname) {
2649     global $DB;
2651     debugging('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2 API,' .
2652         ' please use it instead.', DEBUG_DEVELOPER);
2654     $sql = "SELECT COUNT('x')
2655               FROM {events_queue_handlers} qh
2656               JOIN {events_handlers} h ON h.id = qh.handlerid
2657              WHERE h.eventname = ?";
2659     return $DB->count_records_sql($sql, array($eventname));
2662 /**
2663  * @deprecated since Moodle 3.0 - this is a part of clamav plugin now.
2664  */
2665 function clam_message_admins() {
2666     throw new coding_exception('clam_message_admins() can not be used anymore. Please use ' .
2667         'message_admins() method of \antivirus_clamav\scanner class.');
2670 /**
2671  * @deprecated since Moodle 3.0 - this is a part of clamav plugin now.
2672  */
2673 function get_clam_error_code() {
2674     throw new coding_exception('get_clam_error_code() can not be used anymore. Please use ' .
2675         'get_clam_error_code() method of \antivirus_clamav\scanner class.');
2678 /**
2679  * @deprecated since 3.1
2680  */
2681 function course_get_cm_rename_action() {
2682     throw new coding_exception('course_get_cm_rename_action() can not be used anymore. Please use ' .
2683         'inplace_editable https://docs.moodle.org/dev/Inplace_editable.');
2687 /**
2688  * @deprecated since Moodle 3.1
2689  */
2690 function course_scale_used() {
2691     throw new coding_exception('course_scale_used() can not be used anymore. Plugins can ' .
2692         'implement <modname>_scale_used_anywhere, all implementations of <modname>_scale_used are now ignored');
2695 /**
2696  * @deprecated since Moodle 3.1
2697  */
2698 function site_scale_used() {
2699     throw new coding_exception('site_scale_used() can not be used anymore. Plugins can implement ' .
2700         '<modname>_scale_used_anywhere, all implementations of <modname>_scale_used are now ignored');
2703 /**
2704  * @deprecated since Moodle 3.1. Use external_api::external_function_info().
2705  */
2706 function external_function_info() {
2707     throw new coding_exception('external_function_info() can not be used any'.
2708         'more. Please use external_api::external_function_info() instead.');
2711 /**
2712  * Retrieves an array of records from a CSV file and places
2713  * them into a given table structure
2714  * This function is deprecated. Please use csv_import_reader() instead.
2715  *
2716  * @deprecated since Moodle 3.2 MDL-55126
2717  * @todo MDL-55195 for final deprecation in Moodle 3.6
2718  * @see csv_import_reader::load_csv_content()
2719  * @global stdClass $CFG
2720  * @global moodle_database $DB
2721  * @param string $file The path to a CSV file
2722  * @param string $table The table to retrieve columns from
2723  * @return bool|array Returns an array of CSV records or false
2724  */
2725 function get_records_csv($file, $table) {
2726     global $CFG, $DB;
2728     debugging('get_records_csv() is deprecated. Please use lib/csvlib.class.php csv_import_reader() instead.');
2730     if (!$metacolumns = $DB->get_columns($table)) {
2731         return false;
2732     }
2734     if(!($handle = @fopen($file, 'r'))) {
2735         print_error('get_records_csv failed to open '.$file);
2736     }
2738     $fieldnames = fgetcsv($handle, 4096);
2739     if(empty($fieldnames)) {
2740         fclose($handle);
2741         return false;
2742     }
2744     $columns = array();
2746     foreach($metacolumns as $metacolumn) {
2747         $ord = array_search($metacolumn->name, $fieldnames);
2748         if(is_int($ord)) {
2749             $columns[$metacolumn->name] = $ord;
2750         }
2751     }
2753     $rows = array();
2755     while (($data = fgetcsv($handle, 4096)) !== false) {
2756         $item = new stdClass;
2757         foreach($columns as $name => $ord) {
2758             $item->$name = $data[$ord];
2759         }
2760         $rows[] = $item;
2761     }
2763     fclose($handle);
2764     return $rows;
2767 /**
2768  * Create a file with CSV contents
2769  * This function is deprecated. Please use download_as_dataformat() instead.
2770  *
2771  * @deprecated since Moodle 3.2 MDL-55126
2772  * @todo MDL-55195 for final deprecation in Moodle 3.6
2773  * @see download_as_dataformat (lib/dataformatlib.php)
2774  * @global stdClass $CFG
2775  * @global moodle_database $DB
2776  * @param string $file The file to put the CSV content into
2777  * @param array $records An array of records to write to a CSV file
2778  * @param string $table The table to get columns from
2779  * @return bool success
2780  */
2781 function put_records_csv($file, $records, $table = NULL) {
2782     global $CFG, $DB;
2784     debugging('put_records_csv() is deprecated. Please use lib/dataformatlib.php download_as_dataformat()');
2786     if (empty($records)) {
2787         return true;
2788     }
2790     $metacolumns = NULL;
2791     if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2792         return false;
2793     }
2795     echo "x";
2797     if(!($fp = @fopen($CFG->tempdir.'/'.$file, 'w'))) {
2798         print_error('put_records_csv failed to open '.$file);
2799     }
2801     $proto = reset($records);
2802     if(is_object($proto)) {
2803         $fields_records = array_keys(get_object_vars($proto));
2804     }
2805     else if(is_array($proto)) {
2806         $fields_records = array_keys($proto);
2807     }
2808     else {
2809         return false;
2810     }
2811     echo "x";
2813     if(!empty($metacolumns)) {
2814         $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2815         $fields = array_intersect($fields_records, $fields_table);
2816     }
2817     else {
2818         $fields = $fields_records;
2819     }
2821     fwrite($fp, implode(',', $fields));
2822     fwrite($fp, "\r\n");
2824     foreach($records as $record) {
2825         $array  = (array)$record;
2826         $values = array();
2827         foreach($fields as $field) {
2828             if(strpos($array[$field], ',')) {
2829                 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2830             }
2831             else {
2832                 $values[] = $array[$field];
2833             }
2834         }
2835         fwrite($fp, implode(',', $values)."\r\n");
2836     }
2838     fclose($fp);
2839     @chmod($CFG->tempdir.'/'.$file, $CFG->filepermissions);
2840     return true;
2843 /**
2844  * Determines if the given value is a valid CSS colour.
2845  *
2846  * A CSS colour can be one of the following:
2847  *    - Hex colour:  #AA66BB
2848  *    - RGB colour:  rgb(0-255, 0-255, 0-255)
2849  *    - RGBA colour: rgba(0-255, 0-255, 0-255, 0-1)
2850  *    - HSL colour:  hsl(0-360, 0-100%, 0-100%)
2851  *    - HSLA colour: hsla(0-360, 0-100%, 0-100%, 0-1)
2852  *
2853  * Or a recognised browser colour mapping {@link css_optimiser::$htmlcolours}
2854  *
2855  * @deprecated since Moodle 3.2
2856  * @todo MDL-56173 for final deprecation in Moodle 3.6
2857  * @param string $value The colour value to check
2858  * @return bool
2859  */
2860 function css_is_colour($value) {
2861     debugging('css_is_colour() is deprecated without a replacement. Please copy the implementation '.
2862         'into your plugin if you need this functionality.', DEBUG_DEVELOPER);
2864     $value = trim($value);
2866     $hex  = '/^#([a-fA-F0-9]{1,3}|[a-fA-F0-9]{6})$/';
2867     $rgb  = '#^rgb\s*\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$#i';
2868     $rgba = '#^rgba\s*\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1}(\.\d+)?)\s*\)$#i';
2869     $hsl  = '#^hsl\s*\(\s*(\d{1,3})\s*,\s*(\d{1,3})\%\s*,\s*(\d{1,3})\%\s*\)$#i';
2870     $hsla = '#^hsla\s*\(\s*(\d{1,3})\s*,\s*(\d{1,3})\%\s*,\s*(\d{1,3})\%\s*,\s*(\d{1}(\.\d+)?)\s*\)$#i';
2872     if (in_array(strtolower($value), array('inherit'))) {
2873         return true;
2874     } else if (preg_match($hex, $value)) {
2875         return true;
2876     } else if (in_array(strtolower($value), array_keys(css_optimiser::$htmlcolours))) {
2877         return true;
2878     } else if (preg_match($rgb, $value, $m) && $m[1] < 256 && $m[2] < 256 && $m[3] < 256) {
2879         // It is an RGB colour.
2880         return true;
2881     } else if (preg_match($rgba, $value, $m) && $m[1] < 256 && $m[2] < 256 && $m[3] < 256) {
2882         // It is an RGBA colour.
2883         return true;
2884     } else if (preg_match($hsl, $value, $m) && $m[1] <= 360 && $m[2] <= 100 && $m[3] <= 100) {
2885         // It is an HSL colour.
2886         return true;
2887     } else if (preg_match($hsla, $value, $m) && $m[1] <= 360 && $m[2] <= 100 && $m[3] <= 100) {
2888         // It is an HSLA colour.
2889         return true;
2890     }
2891     // Doesn't look like a colour.
2892     return false;
2895 /**
2896  * Returns true is the passed value looks like a CSS width.
2897  * In order to pass this test the value must be purely numerical or end with a
2898  * valid CSS unit term.
2899  *
2900  * @param string|int $value
2901  * @return boolean
2902  * @deprecated since Moodle 3.2
2903  * @todo MDL-56173 for final deprecation in Moodle 3.6
2904  */
2905 function css_is_width($value) {
2906     debugging('css_is_width() is deprecated without a replacement. Please copy the implementation '.
2907         'into your plugin if you need this functionality.', DEBUG_DEVELOPER);
2909     $value = trim($value);
2910     if (in_array(strtolower($value), array('auto', 'inherit'))) {
2911         return true;
2912     }
2913     if ((string)$value === '0' || preg_match('#^(\-\s*)?(\d*\.)?(\d+)\s*(em|px|pt|\%|in|cm|mm|ex|pc)$#i', $value)) {
2914         return true;
2915     }
2916     return false;
2919 /**
2920  * A simple sorting function to sort two array values on the number of items they contain
2921  *
2922  * @param array $a
2923  * @param array $b
2924  * @return int
2925  * @deprecated since Moodle 3.2
2926  * @todo MDL-56173 for final deprecation in Moodle 3.6
2927  */
2928 function css_sort_by_count(array $a, array $b) {
2929     debugging('css_sort_by_count() is deprecated without a replacement. Please copy the implementation '.
2930         'into your plugin if you need this functionality.', DEBUG_DEVELOPER);
2932     $a = count($a);
2933     $b = count($b);
2934     if ($a == $b) {
2935         return 0;
2936     }
2937     return ($a > $b) ? -1 : 1;
2940 /**
2941  * A basic CSS optimiser that strips out unwanted things and then processes CSS organising and cleaning styles.
2942  * @deprecated since Moodle 3.2
2943  * @todo MDL-56173 for final deprecation in Moodle 3.6
2944  */
2945 class css_optimiser {
2946     /**
2947      * An array of the common HTML colours that are supported by most browsers.
2948      *
2949      * This reference table is used to allow us to unify colours, and will aid
2950      * us in identifying buggy CSS using unsupported colours.
2951      *
2952      * @var string[]
2953      * @deprecated since Moodle 3.2
2954      * @todo MDL-56173 for final deprecation in Moodle 3.6
2955      */
2956     public static $htmlcolours = array(
2957         'aliceblue' => '#F0F8FF',
2958         'antiquewhite' => '#FAEBD7',
2959         'aqua' => '#00FFFF',
2960         'aquamarine' => '#7FFFD4',
2961         'azure' => '#F0FFFF',
2962         'beige' => '#F5F5DC',
2963         'bisque' => '#FFE4C4',
2964         'black' => '#000000',
2965         'blanchedalmond' => '#FFEBCD',
2966         'blue' => '#0000FF',
2967         'blueviolet' => '#8A2BE2',
2968         'brown' => '#A52A2A',
2969         'burlywood' => '#DEB887',
2970         'cadetblue' => '#5F9EA0',
2971         'chartreuse' => '#7FFF00',
2972         'chocolate' => '#D2691E',
2973         'coral' => '#FF7F50',
2974         'cornflowerblue' => '#6495ED',
2975         'cornsilk' => '#FFF8DC',
2976         'crimson' => '#DC143C',
2977         'cyan' => '#00FFFF',
2978         'darkblue' => '#00008B',
2979         'darkcyan' => '#008B8B',
2980         'darkgoldenrod' => '#B8860B',
2981         'darkgray' => '#A9A9A9',
2982         'darkgrey' => '#A9A9A9',
2983         'darkgreen' => '#006400',
2984         'darkKhaki' => '#BDB76B',
2985         'darkmagenta' => '#8B008B',
2986         'darkolivegreen' => '#556B2F',
2987         'arkorange' => '#FF8C00',
2988         'darkorchid' => '#9932CC',
2989         'darkred' => '#8B0000',
2990         'darksalmon' => '#E9967A',
2991         'darkseagreen' => '#8FBC8F',
2992         'darkslateblue' => '#483D8B',
2993         'darkslategray' => '#2F4F4F',
2994         'darkslategrey' => '#2F4F4F',
2995         'darkturquoise' => '#00CED1',
2996         'darkviolet' => '#9400D3',
2997         'deeppink' => '#FF1493',
2998         'deepskyblue' => '#00BFFF',
2999         'dimgray' => '#696969',
3000         'dimgrey' => '#696969',
3001         'dodgerblue' => '#1E90FF',
3002         'firebrick' => '#B22222',
3003         'floralwhite' => '#FFFAF0',
3004         'forestgreen' => '#228B22',
3005         'fuchsia' => '#FF00FF',
3006         'gainsboro' => '#DCDCDC',
3007         'ghostwhite' => '#F8F8FF',
3008         'gold' => '#FFD700',
3009         'goldenrod' => '#DAA520',
3010         'gray' => '#808080',
3011         'grey' => '#808080',
3012         'green' => '#008000',
3013         'greenyellow' => '#ADFF2F',
3014         'honeydew' => '#F0FFF0',
3015         'hotpink' => '#FF69B4',
3016         'indianred ' => '#CD5C5C',
3017         'indigo ' => '#4B0082',
3018         'ivory' => '#FFFFF0',
3019         'khaki' => '#F0E68C',
3020         'lavender' => '#E6E6FA',
3021         'lavenderblush' => '#FFF0F5',
3022         'lawngreen' => '#7CFC00',
3023         'lemonchiffon' => '#FFFACD',
3024         'lightblue' => '#ADD8E6',
3025         'lightcoral' => '#F08080',
3026         'lightcyan' => '#E0FFFF',
3027         'lightgoldenrodyellow' => '#FAFAD2',
3028         'lightgray' => '#D3D3D3',
3029         'lightgrey' => '#D3D3D3',
3030         'lightgreen' => '#90EE90',
3031         'lightpink' => '#FFB6C1',
3032         'lightsalmon' => '#FFA07A',
3033         'lightseagreen' => '#20B2AA',
3034         'lightskyblue' => '#87CEFA',
3035         'lightslategray' => '#778899',
3036         'lightslategrey' => '#778899',
3037         'lightsteelblue' => '#B0C4DE',
3038         'lightyellow' => '#FFFFE0',
3039         'lime' => '#00FF00',
3040         'limegreen' => '#32CD32',
3041         'linen' => '#FAF0E6',
3042         'magenta' => '#FF00FF',
3043         'maroon' => '#800000',
3044         'mediumaquamarine' => '#66CDAA',
3045         'mediumblue' => '#0000CD',
3046         'mediumorchid' => '#BA55D3',
3047         'mediumpurple' => '#9370D8',
3048         'mediumseagreen' => '#3CB371',
3049         'mediumslateblue' => '#7B68EE',
3050         'mediumspringgreen' => '#00FA9A',
3051         'mediumturquoise' => '#48D1CC',
3052         'mediumvioletred' => '#C71585',
3053         'midnightblue' => '#191970',
3054         'mintcream' => '#F5FFFA',
3055         'mistyrose' => '#FFE4E1',
3056         'moccasin' => '#FFE4B5',
3057         'navajowhite' => '#FFDEAD',
3058         'navy' => '#000080',
3059         'oldlace' => '#FDF5E6',
3060         'olive' => '#808000',
3061         'olivedrab' => '#6B8E23',
3062         'orange' => '#FFA500',
3063         'orangered' => '#FF4500',
3064         'orchid' => '#DA70D6',
3065         'palegoldenrod' => '#EEE8AA',
3066         'palegreen' => '#98FB98',
3067         'paleturquoise' => '#AFEEEE',
3068         'palevioletred' => '#D87093',
3069         'papayawhip' => '#FFEFD5',
3070         'peachpuff' => '#FFDAB9',
3071         'peru' => '#CD853F',
3072         'pink' => '#FFC0CB',
3073         'plum' => '#DDA0DD',
3074         'powderblue' => '#B0E0E6',
3075         'purple' => '#800080',
3076         'red' => '#FF0000',
3077         'rosybrown' => '#BC8F8F',
3078         'royalblue' => '#4169E1',
3079         'saddlebrown' => '#8B4513',
3080         'salmon' => '#FA8072',
3081         'sandybrown' => '#F4A460',
3082         'seagreen' => '#2E8B57',
3083         'seashell' => '#FFF5EE',
3084         'sienna' => '#A0522D',
3085         'silver' => '#C0C0C0',
3086         'skyblue' => '#87CEEB',
3087         'slateblue' => '#6A5ACD',
3088         'slategray' => '#708090',
3089         'slategrey' => '#708090',
3090         'snow' => '#FFFAFA',
3091         'springgreen' => '#00FF7F',
3092         'steelblue' => '#4682B4',
3093         'tan' => '#D2B48C',
3094         'teal' => '#008080',
3095         'thistle' => '#D8BFD8',
3096         'tomato' => '#FF6347',
3097         'transparent' => 'transparent',
3098         'turquoise' => '#40E0D0',
3099         'violet' => '#EE82EE',
3100         'wheat' => '#F5DEB3',
3101         'white' => '#FFFFFF',
3102         'whitesmoke' => '#F5F5F5',
3103         'yellow' => '#FFFF00',
3104         'yellowgreen' => '#9ACD32'
3105     );
3107     /**
3108      * Used to orocesses incoming CSS optimising it and then returning it. Now just returns
3109      * what is sent to it. Do not use.
3110      *
3111      * @param string $css The raw CSS to optimise
3112      * @return string The optimised CSS
3113      * @deprecated since Moodle 3.2
3114      * @todo MDL-56173 for final deprecation in Moodle 3.6
3115      */
3116     public function process($css) {
3117         debugging('class css_optimiser is deprecated and no longer does anything, '.
3118             'please consider using stylelint to optimise your css.', DEBUG_DEVELOPER);
3120         return $css;
3121     }
3124 /**
3125  * Load the course contexts for all of the users courses
3126  *
3127  * @deprecated since Moodle 3.2
3128  * @param array $courses array of course objects. The courses the user is enrolled in.
3129  * @return array of course contexts
3130  */
3131 function message_get_course_contexts($courses) {
3132     debugging('message_get_course_contexts() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3134     $coursecontexts = array();
3136     foreach($courses as $course) {
3137         $coursecontexts[$course->id] = context_course::instance($course->id);
3138     }
3140     return $coursecontexts;
3143 /**
3144  * strip off action parameters like 'removecontact'
3145  *
3146  * @deprecated since Moodle 3.2
3147  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
3148  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
3149  */
3150 function message_remove_url_params($moodleurl) {
3151     debugging('message_remove_url_params() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3153     $newurl = new moodle_url($moodleurl);
3154     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
3155     return $newurl->out();
3158 /**
3159  * Count the number of messages with a field having a specified value.
3160  * if $field is empty then return count of the whole array
3161  * if $field is non-existent then return 0
3162  *
3163  * @deprecated since Moodle 3.2
3164  * @param array $messagearray array of message objects
3165  * @param string $field the field to inspect on the message objects
3166  * @param string $value the value to test the field against
3167  */
3168 function message_count_messages($messagearray, $field='', $value='') {
3169     debugging('message_count_messages() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3171     if (!is_array($messagearray)) return 0;
3172     if ($field == '' or empty($messagearray)) return count($messagearray);
3174     $count = 0;
3175     foreach ($messagearray as $message) {
3176         $count += ($message->$field == $value) ? 1 : 0;
3177     }
3178     return $count;
3181 /**
3182  * Count the number of users blocked by $user1
3183  *
3184  * @deprecated since Moodle 3.2
3185  * @param object $user1 user object
3186  * @return int the number of blocked users
3187  */
3188 function message_count_blocked_users($user1=null) {
3189     debugging('message_count_blocked_users() is deprecated, please use \core_message\api::count_blocked_users() instead.',
3190         DEBUG_DEVELOPER);
3192     return \core_message\api::count_blocked_users($user1);
3195 /**
3196  * Print a message contact link
3197  *
3198  * @deprecated since Moodle 3.2
3199  * @param int $userid the ID of the user to apply to action to
3200  * @param string $linktype can be add, remove, block or unblock
3201  * @param bool $return if true return the link as a string. If false echo the link.
3202  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
3203  * @param bool $text include text next to the icons?
3204  * @param bool $icon include a graphical icon?
3205  * @return string  if $return is true otherwise bool
3206  */
3207 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
3208     debugging('message_contact_link() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3210     global $OUTPUT, $PAGE;
3212     //hold onto the strings as we're probably creating a bunch of links
3213     static $str;
3215     if (empty($script)) {
3216         //strip off previous action params like 'removecontact'
3217         $script = message_remove_url_params($PAGE->url);
3218     }
3220     if (empty($str->blockcontact)) {
3221         $str = new stdClass();
3222         $str->blockcontact   =  get_string('blockcontact', 'message');
3223         $str->unblockcontact =  get_string('unblockcontact', 'message');
3224         $str->removecontact  =  get_string('removecontact', 'message');
3225         $str->addcontact     =  get_string('addcontact', 'message');
3226     }
3228     $command = $linktype.'contact';
3229     $string  = $str->{$command};
3231     $safealttext = s($string);
3233     $safestring = '';
3234     if (!empty($text)) {
3235         $safestring = $safealttext;
3236     }
3238     $img = '';
3239     if ($icon) {
3240         $iconpath = null;
3241         switch ($linktype) {
3242             case 'block':
3243                 $iconpath = 't/block';
3244                 break;
3245             case 'unblock':
3246                 $iconpath = 't/unblock';
3247                 break;
3248             case 'remove':
3249                 $iconpath = 't/removecontact';
3250                 break;
3251             case 'add':
3252             default:
3253                 $iconpath = 't/addcontact';
3254         }
3256         $img = $OUTPUT->pix_icon($iconpath, $safealttext);
3257     }
3259     $output = '<span class="'.$linktype.'contact">'.
3260         '<a href="'.$script.'&amp;'.$command.'='.$userid.
3261         '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
3262         $img.
3263         $safestring.'</a></span>';
3265     if ($return) {
3266         return $output;
3267     } else {
3268         echo $output;
3269         return true;
3270     }
3273 /**
3274  * @deprecated since Moodle 3.2
3275  */
3276 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
3277     throw new coding_exception('message_get_recent_notifications() can not be used any more.', DEBUG_DEVELOPER);
3280 /**
3281  * echo or return a link to take the user to the full message history between themselves and another user
3282  *
3283  * @deprecated since Moodle 3.2
3284  * @param int $userid1 the ID of the user displayed on the left (usually the current user)
3285  * @param int $userid2 the ID of the other user
3286  * @param bool $return true to return the link as a string. False to echo the link.
3287  * @param string $keywords any keywords to highlight in the message history
3288  * @param string $position anchor name to jump to within the message history
3289  * @param string $linktext optionally specify the link text
3290  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
3291  */
3292 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
3293     debugging('message_history_link() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3295     global $OUTPUT, $PAGE;
3296     static $strmessagehistory;
3298     if (empty($strmessagehistory)) {
3299         $strmessagehistory = get_string('messagehistory', 'message');
3300     }
3302     if ($position) {
3303         $position = "#$position";
3304     }
3305     if ($keywords) {
3306         $keywords = "&search=".urlencode($keywords);
3307     }
3309     if ($linktext == 'icon') {  // Icon only
3310         $fulllink = $OUTPUT->pix_icon('t/messages', $strmessagehistory);
3311     } else if ($linktext == 'both') {  // Icon and standard name
3312         $fulllink = $OUTPUT->pix_icon('t/messages', '');
3313         $fulllink .= '&nbsp;'.$strmessagehistory;
3314     } else if ($linktext) {    // Custom name
3315         $fulllink = $linktext;
3316     } else {                   // Standard name only
3317         $fulllink = $strmessagehistory;
3318     }
3320     $popupoptions = array(
3321         'height' => 500,
3322         'width' => 500,
3323         'menubar' => false,
3324         'location' => false,
3325         'status' => true,
3326         'scrollbars' => true,
3327         'resizable' => true);
3329     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user1=$userid1&user2=$userid2$keywords$position");
3330     if ($PAGE->url && $PAGE->url->get_param('viewing')) {
3331         $link->param('viewing', $PAGE->url->get_param('viewing'));
3332     }
3333     $action = null;
3334     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
3336     $str = '<span class="history">'.$str.'</span>';
3338     if ($return) {
3339         return $str;
3340     } else {
3341         echo $str;
3342         return true;
3343     }
3346 /**
3347  * @deprecated since Moodle 3.2
3348  */
3349 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
3350     throw new coding_exception('message_search() can not be used any more.', DEBUG_DEVELOPER);
3353 /**
3354  * Given a message object that we already know has a long message
3355  * this function truncates the message nicely to the first
3356  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
3357  *
3358  * @deprecated since Moodle 3.2
3359  * @param string $message the message
3360  * @param int $minlength the minimum length to trim the message to
3361  * @return string the shortened message
3362  */
3363 function message_shorten_message($message, $minlength = 0) {
3364     debugging('message_shorten_message() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3366     $i = 0;
3367     $tag = false;
3368     $length = strlen($message);
3369     $count = 0;
3370     $stopzone = false;
3371     $truncate = 0;
3372     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
3375     for ($i=0; $i<$length; $i++) {
3376         $char = $message[$i];
3378         switch ($char) {
3379             case "<":
3380                 $tag = true;
3381                 break;
3382             case ">":
3383                 $tag = false;
3384                 break;
3385             default:
3386                 if (!$tag) {
3387                     if ($stopzone) {
3388                         if ($char == '.' or $char == ' ') {
3389                             $truncate = $i+1;
3390                             break 2;
3391                         }
3392                     }
3393                     $count++;
3394                 }
3395                 break;
3396         }
3397         if (!$stopzone) {
3398             if ($count > $minlength) {
3399                 $stopzone = true;
3400             }
3401         }
3402     }
3404     if (!$truncate) {
3405         $truncate = $i;
3406     }
3408     return substr($message, 0, $truncate);
3411 /**
3412  * Given a string and an array of keywords, this function looks
3413  * for the first keyword in the string, and then chops out a
3414  * small section from the text that shows that word in context.
3415  *
3416  * @deprecated since Moodle 3.2
3417  * @param string $message the text to search
3418  * @param array $keywords array of keywords to find
3419  */
3420 function message_get_fragment($message, $keywords) {
3421     debugging('message_get_fragment() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3423     $fullsize = 160;
3424     $halfsize = (int)($fullsize/2);
3426     $message = strip_tags($message);
3428     foreach ($keywords as $keyword) {  // Just get the first one
3429         if ($keyword !== '') {
3430             break;
3431         }
3432     }
3433     if (empty($keyword)) {   // None found, so just return start of message
3434         return message_shorten_message($message, 30);
3435     }
3437     $leadin = $leadout = '';
3439 /// Find the start of the fragment
3440     $start = 0;
3441     $length = strlen($message);
3443     $pos = strpos($message, $keyword);
3444     if ($pos > $halfsize) {
3445         $start = $pos - $halfsize;
3446         $leadin = '...';
3447     }
3448 /// Find the end of the fragment
3449     $end = $start + $fullsize;
3450     if ($end > $length) {
3451         $end = $length;
3452     } else {
3453         $leadout = '...';
3454     }
3456 /// Pull out the fragment and format it
3458     $fragment = substr($message, $start, $end - $start);
3459     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
3460     return $fragment;
3463 /**
3464  * @deprecated since Moodle 3.2
3465  */
3466 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
3467     throw new coding_exception('message_get_history() can not be used any more.', DEBUG_DEVELOPER);
3470 /**
3471  * Constructs the add/remove contact link to display next to other users
3472  *
3473  * @deprecated since Moodle 3.2
3474  * @param bool $incontactlist is the user a contact
3475  * @param bool $isblocked is the user blocked
3476  * @param stdClass $contact contact object
3477  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
3478  * @param bool $text include text next to the icons?
3479  * @param bool $icon include a graphical icon?
3480  * @return string
3481  */
3482 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
3483     debugging('message_get_contact_add_remove_link() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3485     $strcontact = '';
3487     if($incontactlist){
3488         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
3489     } else if ($isblocked) {
3490         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
3491     } else{
3492         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
3493     }
3495     return $strcontact;
3498 /**
3499  * Constructs the block contact link to display next to other users
3500  *
3501  * @deprecated since Moodle 3.2
3502  * @param bool $incontactlist is the user a contact?
3503  * @param bool $isblocked is the user blocked?
3504  * @param stdClass $contact contact object
3505  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
3506  * @param bool $text include text next to the icons?
3507  * @param bool $icon include a graphical icon?
3508  * @return string
3509  */
3510 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
3511     debugging('message_get_contact_block_link() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3513     $strblock   = '';
3515     //commented out to allow the user to block a contact without having to remove them first
3516     /*if ($incontactlist) {
3517         //$strblock = '';
3518     } else*/
3519     if ($isblocked) {
3520         $strblock   = message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
3521     } else{
3522         $strblock   = message_contact_link($contact->id, 'block', true, $script, $text, $icon);
3523     }
3525     return $strblock;
3528 /**
3529  * marks ALL messages being sent from $fromuserid to $touserid as read
3530  *
3531  * @deprecated since Moodle 3.2
3532  * @param int $touserid the id of the message recipient
3533  * @param int $fromuserid the id of the message sender
3534  * @return void
3535  */
3536 function message_mark_messages_read($touserid, $fromuserid) {
3537     debugging('message_mark_messages_read() is deprecated and is no longer used, please use
3538         \core_message\api::mark_all_messages_as_read() instead.', DEBUG_DEVELOPER);
3540     \core_message\api::mark_all_messages_as_read($touserid, $fromuserid);
3543 /**
3544  * Return a list of page types
3545  *
3546  * @deprecated since Moodle 3.2
3547  * @param string $pagetype current page type
3548  * @param stdClass $parentcontext Block's parent context
3549  * @param stdClass $currentcontext Current context of block
3550  */
3551 function message_page_type_list($pagetype, $parentcontext, $currentcontext) {
3552     debugging('message_page_type_list() is deprecated and is no longer used.', DEBUG_DEVELOPER);
3554     return array('messages-*'=>get_string('page-message-x', 'message'));
3557 /**
3558  * Determines if a user is permitted to send another user a private message.
3559  * If no sender is provided then it defaults to the logged in user.
3560  *
3561  * @deprecated since Moodle 3.2
3562  * @param object $recipient User object.
3563  * @param object $sender User object.
3564  * @return bool true if user is permitted, false otherwise.
3565  */
3566 function message_can_post_message($recipient, $sender = null) {
3567     debugging('message_can_post_message() is deprecated and is no longer used, please use
3568         \core_message\api::can_post_message() instead.', DEBUG_DEVELOPER);
3570     return \core_message\api::can_post_message($recipient, $sender);
3573 /**
3574  * Checks if the recipient is allowing messages from users that aren't a
3575  * contact. If not then it checks to make sure the sender is in the
3576  * recipient's contacts.
3577  *
3578  * @deprecated since Moodle 3.2
3579  * @param object $recipient User object.
3580  * @param object $sender User object.
3581  * @return bool true if $sender is blocked, false otherwise.
3582  */
3583 function message_is_user_non_contact_blocked($recipient, $sender = null) {
3584     debugging('message_is_user_non_contact_blocked() is deprecated and is no longer used, please use
3585         \core_message\api::is_user_non_contact_blocked() instead.', DEBUG_DEVELOPER);
3587     return \core_message\api::is_user_non_contact_blocked($recipient, $sender);
3590 /**
3591  * Checks if the recipient has specifically blocked the sending user.
3592  *
3593  * Note: This function will always return false if the sender has the
3594  * readallmessages capability at the system context level.
3595  *
3596  * @deprecated since Moodle 3.2
3597  * @param object $recipient User object.
3598  * @param object $sender User object.
3599  * @return bool true if $sender is blocked, false otherwise.
3600  */
3601 function message_is_user_blocked($recipient, $sender = null) {
3602     debugging('message_is_user_blocked() is deprecated and is no longer used, please use
3603         \core_message\api::is_user_blocked() instead.', DEBUG_DEVELOPER);
3605     $senderid = null;
3606     if ($sender !== null && isset($sender->id)) {
3607         $senderid = $sender->id;
3608     }
3609     return \core_message\api::is_user_blocked($recipient->id, $senderid);
3612 /**
3613  * Display logs.
3614  *
3615  * @deprecated since 3.2
3616  */
3617 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
3618                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
3619     debugging(__FUNCTION__ . '() is deprecated. Please use the report_log framework instead.', DEBUG_DEVELOPER);
3621     global $CFG, $DB, $OUTPUT;
3623     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
3624                        $modname, $modid, $modaction, $groupid)) {
3625         echo $OUTPUT->notification("No logs found!");
3626         echo $OUTPUT->footer();
3627         exit;
3628     }
3630     $courses = array();
3632     if ($course->id == SITEID) {
3633         $courses[0] = '';
3634         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
3635             foreach ($ccc as $cc) {
3636                 $courses[$cc->id] = $cc->shortname;
3637             }
3638         }
3639     } else {
3640         $courses[$course->id] = $course->shortname;
3641     }
3643     $totalcount = $logs['totalcount'];
3644     $ldcache = array();
3646     $strftimedatetime = get_string("strftimedatetime");
3648     echo "<div class=\"info\">\n";
3649     print_string("displayingrecords", "", $totalcount);
3650     echo "</div>\n";
3652     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
3654     $table = new html_table();
3655     $table->classes = array('logtable','generaltable');
3656     $table->align = array('right', 'left', 'left');
3657     $table->head = array(
3658         get_string('time'),
3659         get_string('ip_address'),
3660         get_string('fullnameuser'),
3661         get_string('action'),
3662         get_string('info')
3663     );
3664     $table->data = array();
3666     if ($course->id == SITEID) {
3667         array_unshift($table->align, 'left');
3668         array_unshift($table->head, get_string('course'));
3669     }
3671     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
3672     if (empty($logs['logs'])) {
3673         $logs['logs'] = array();
3674     }
3676     foreach ($logs['logs'] as $log) {
3678         if (isset($ldcache[$log->module][$log->action])) {
3679             $ld = $ldcache[$log->module][$log->action];
3680         } else {
3681             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
3682             $ldcache[$log->module][$log->action] = $ld;
3683         }
3684         if ($ld && is_numeric($log->info)) {
3685             // ugly hack to make sure fullname is shown correctly
3686             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
3687                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
3688             } else {
3689                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
3690             }
3691         }
3693         //Filter log->info
3694         $log->info = format_string($log->info);
3696         // If $log->url has been trimmed short by the db size restriction
3697         // code in add_to_log, keep a note so we don't add a link to a broken url
3698         $brokenurl=(core_text::strlen($log->url)==100 && core_text::substr($log->url,97)=='...');
3700         $row = array();
3701         if ($course->id == SITEID) {
3702             if (empty($log->course)) {
3703                 $row[] = get_string('site');
3704             } else {
3705                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
3706             }
3707         }
3709         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
3711         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
3712         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
3714         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
3716         $displayaction="$log->module $log->action";
3717         if ($brokenurl) {
3718             $row[] = $displayaction;
3719         } else {
3720             $link = make_log_url($log->module,$log->url);
3721             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
3722         }
3723         $row[] = $log->info;
3724         $table->data[] = $row;
3725     }
3727     echo html_writer::table($table);
3728     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
3731 /**
3732  * Display MNET logs.
3733  *
3734  * @deprecated since 3.2
3735  */
3736 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
3737                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
3738     debugging(__FUNCTION__ . '() is deprecated. Please use the report_log framework instead.', DEBUG_DEVELOPER);
3740     global $CFG, $DB, $OUTPUT;
3742     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
3743                        $modname, $modid, $modaction, $groupid)) {
3744         echo $OUTPUT->notification("No logs found!");
3745         echo $OUTPUT->footer();
3746         exit;
3747     }
3749     if ($course->id == SITEID) {
3750         $courses[0] = '';
3751         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
3752             foreach ($ccc as $cc) {
3753                 $courses[$cc->id] = $cc->shortname;
3754             }
3755         }
3756     }
3758     $totalcount = $logs['totalcount'];
3759     $ldcache = array();
3761     $strftimedatetime = get_string("strftimedatetime");
3763     echo "<div class=\"info\">\n";
3764     print_string("displayingrecords", "", $totalcount);
3765     echo "</div>\n";
3767     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
3769     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
3770     echo "<tr>";
3771     if ($course->id == SITEID) {
3772         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
3773     }
3774     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
3775     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
3776     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
3777     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
3778     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
3779     echo "</tr>\n";
3781     if (empty($logs['logs'])) {
3782         echo "</table>\n";
3783         return;
3784     }
3786     $row = 1;
3787     foreach ($logs['logs'] as $log) {
3789         $log->info = $log->coursename;
3790         $row = ($row + 1) % 2;
3792         if (isset($ldcache[$log->module][$log->action])) {
3793             $ld = $ldcache[$log->module][$log->action];
3794         } else {
3795             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
3796             $ldcache[$log->module][$log->action] = $ld;
3797         }
3798