lib/deprecatedlib.php

   1 <?php
   2
   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/>.
  17
  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  */
  30
  31 defined('MOODLE_INTERNAL') || die();
  32
  33 /* === Functions that needs to be kept longer in deprecated lib than normal time period === */
  34
  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);
  51
  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 }
  59
  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 }
  73
  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;
  93
  94     // NOTE: do not add any other debugging here, keep forever.
  95
  96     $subsystems = core_component::get_core_subsystems();
  97
  98     if ($fullpaths) {
  99         return $subsystems;
 100     }
 101
 102     debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
 103
 104     $dlength = strlen($CFG->dirroot);
 105
 106     foreach ($subsystems as $k => $v) {
 107         if ($v === null) {
 108             continue;
 109         }
 110         $subsystems[$k] = substr($v, $dlength+1);
 111     }
 112
 113     return $subsystems;
 114 }
 115
 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;
 126
 127     // NOTE: do not add any other debugging here, keep forever.
 128
 129     $types = core_component::get_plugin_types();
 130
 131     if ($fullpaths) {
 132         return $types;
 133     }
 134
 135     debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
 136
 137     $dlength = strlen($CFG->dirroot);
 138
 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     }
 146
 147     return $types;
 148 }
 149
 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) {
 159
 160     // NOTE: do not add any other debugging here, keep forever.
 161
 162     if ($plugintype === '') {
 163         $plugintype = 'mod';
 164     }
 165
 166     return core_component::get_plugin_list($plugintype);
 167 }
 168
 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) {
 185
 186     // NOTE: do not add any other debugging here, keep forever.
 187
 188     return core_component::get_plugin_list_with_class($plugintype, $class, $file);
 189 }
 190
 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) {
 201
 202     // NOTE: do not add any other debugging here, keep forever.
 203
 204     if ($plugintype === '') {
 205         $plugintype = 'mod';
 206     }
 207
 208     return core_component::get_plugin_directory($plugintype, $name);
 209 }
 210
 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 as (string)$type => (string)$plugin
 218  */
 219 function normalize_component($component) {
 220
 221     // NOTE: do not add any other debugging here, keep forever.
 222
 223     return core_component::normalize_component($component);
 224 }
 225
 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) {
 235
 236     // NOTE: do not add any other debugging here, keep forever.
 237
 238     return core_component::get_component_directory($component);
 239 }
 240
 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) {
 255
 256     debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
 257
 258     $instances = (array)$instance;
 259     $contexts = array();
 260
 261     $classname = context_helper::get_class_for_level($contextlevel);
 262
 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     }
 267
 268     if (is_array($instance)) {
 269         return $contexts;
 270     } else {
 271         return $contexts[$instance];
 272     }
 273 }
 274 /* === End of long term deprecated api list === */
 275
 276 /**
 277  * Adds a file upload to the log table so that clam can resolve the filename to the user later if necessary
 278  *
 279  * @deprecated since 2.7 - use new file picker instead
 280  *
 281  */
 282 function clam_log_upload($newfilepath, $course=null, $nourl=false) {
 283     throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
 284 }
 285
 286 /**
 287  * This function logs to error_log and to the log table that an infected file has been found and what's happened to it.
 288  *
 289  * @deprecated since 2.7 - use new file picker instead
 290  *
 291  */
 292 function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
 293     throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
 294 }
 295
 296 /**
 297  * Some of the modules allow moving attachments (glossary), in which case we need to hunt down an original log and change the path.
 298  *
 299  * @deprecated since 2.7 - use new file picker instead
 300  *
 301  */
 302 function clam_change_log($oldpath, $newpath, $update=true) {
 303     throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
 304 }
 305
 306 /**
 307  * Replaces the given file with a string.
 308  *
 309  * @deprecated since 2.7 - infected files are now deleted in file picker
 310  *
 311  */
 312 function clam_replace_infected_file($file) {
 313     throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
 314 }
 315
 316 /**
 317  * Deals with an infected file - either moves it to a quarantinedir
 318  * (specified in CFG->quarantinedir) or deletes it.
 319  *
 320  * If moving it fails, it deletes it.
 321  *
 322  * @deprecated since 2.7
 323  */
 324 function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
 325     throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
 326 }
 327
 328 /**
 329  * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
 330  *
 331  * @deprecated since 2.7
 332  */
 333 function clam_scan_moodle_file(&$file, $course) {
 334     throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
 335 }
 336
 337
 338 /**
 339  * Checks whether the password compatibility library will work with the current
 340  * version of PHP. This cannot be done using PHP version numbers since the fix
 341  * has been backported to earlier versions in some distributions.
 342  *
 343  * See https://github.com/ircmaxell/password_compat/issues/10 for more details.
 344  *
 345  * @deprecated since 2.7 PHP 5.4.x should be always compatible.
 346  *
 347  */
 348 function password_compat_not_supported() {
 349     throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
 350 }
 351
 352 /**
 353  * Factory method that was returning moodle_session object.
 354  *
 355  * @deprecated since 2.6
 356  */
 357 function session_get_instance() {
 358     throw new coding_exception('session_get_instance() is removed, use \core\session\manager instead');
 359 }
 360
 361 /**
 362  * Returns true if legacy session used.
 363  *
 364  * @deprecated since 2.6
 365  */
 366 function session_is_legacy() {
 367     throw new coding_exception('session_is_legacy() is removed, do not use any more');
 368 }
 369
 370 /**
 371  * Terminates all sessions, auth hooks are not executed.
 372  *
 373  * @deprecated since 2.6
 374  */
 375 function session_kill_all() {
 376     throw new coding_exception('session_kill_all() is removed, use \core\session\manager::kill_all_sessions() instead');
 377 }
 378
 379 /**
 380  * Mark session as accessed, prevents timeouts.
 381  *
 382  * @deprecated since 2.6
 383  */
 384 function session_touch($sid) {
 385     throw new coding_exception('session_touch() is removed, use \core\session\manager::touch_session() instead');
 386 }
 387
 388 /**
 389  * Terminates one sessions, auth hooks are not executed.
 390  *
 391  * @deprecated since 2.6
 392  */
 393 function session_kill($sid) {
 394     throw new coding_exception('session_kill() is removed, use \core\session\manager::kill_session() instead');
 395 }
 396
 397 /**
 398  * Terminates all sessions of one user, auth hooks are not executed.
 399  *
 400  * @deprecated since 2.6
 401  */
 402 function session_kill_user($userid) {
 403     throw new coding_exception('session_kill_user() is removed, use \core\session\manager::kill_user_sessions() instead');
 404 }
 405
 406 /**
 407  * Setup $USER object - called during login, loginas, etc.
 408  *
 409  * Call sync_user_enrolments() manually after log-in, or log-in-as.
 410  *
 411  * @deprecated since 2.6
 412  */
 413 function session_set_user($user) {
 414     throw new coding_exception('session_set_user() is removed, use \core\session\manager::set_user() instead');
 415 }
 416
 417 /**
 418  * Is current $USER logged-in-as somebody else?
 419  * @deprecated since 2.6
 420  */
 421 function session_is_loggedinas() {
 422     throw new coding_exception('session_is_loggedinas() is removed, use \core\session\manager::is_loggedinas() instead');
 423 }
 424
 425 /**
 426  * Returns the $USER object ignoring current login-as session
 427  * @deprecated since 2.6
 428  */
 429 function session_get_realuser() {
 430     throw new coding_exception('session_get_realuser() is removed, use \core\session\manager::get_realuser() instead');
 431 }
 432
 433 /**
 434  * Login as another user - no security checks here.
 435  * @deprecated since 2.6
 436  */
 437 function session_loginas($userid, $context) {
 438     throw new coding_exception('session_loginas() is removed, use \core\session\manager::loginas() instead');
 439 }
 440
 441 /**
 442  * Minify JavaScript files.
 443  *
 444  * @deprecated since 2.6
 445  */
 446 function js_minify($files) {
 447     throw new coding_exception('js_minify() is removed, use core_minify::js_files() or core_minify::js() instead.');
 448 }
 449
 450 /**
 451  * Minify CSS files.
 452  *
 453  * @deprecated since 2.6
 454  */
 455 function css_minify_css($files) {
 456     throw new coding_exception('css_minify_css() is removed, use core_minify::css_files() or core_minify::css() instead.');
 457 }
 458
 459 // === Deprecated before 2.6.0 ===
 460
 461 /**
 462  * Hack to find out the GD version by parsing phpinfo output
 463  */
 464 function check_gd_version() {
 465     throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
 466 }
 467
 468 /**
 469  * Not used any more, the account lockout handling is now
 470  * part of authenticate_user_login().
 471  * @deprecated
 472  */
 473 function update_login_count() {
 474     throw new coding_exception('update_login_count() is removed, all calls need to be removed');
 475 }
 476
 477 /**
 478  * Not used any more, replaced by proper account lockout.
 479  * @deprecated
 480  */
 481 function reset_login_count() {
 482     throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
 483 }
 484
 485 /**
 486  * @deprecated
 487  */
 488 function update_log_display_entry($module, $action, $mtable, $field) {
 489
 490     throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
 491 }
 492
 493 /**
 494  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
 495  *             this was abused mostly for embedding of attachments
 496  */
 497 function filter_text($text, $courseid = NULL) {
 498     throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
 499 }
 500
 501 /**
 502  * @deprecated use $PAGE->https_required() instead
 503  */
 504 function httpsrequired() {
 505     throw new coding_exception('httpsrequired() can not be used any more use $PAGE->https_required() instead.');
 506 }
 507
 508 /**
 509  * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
 510  *
 511  * @deprecated use moodle_url factory methods instead
 512  *
 513  * @param string $path Physical path to a file
 514  * @param array $options associative array of GET variables to append to the URL
 515  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
 516  * @return string URL to file
 517  */
 518 function get_file_url($path, $options=null, $type='coursefile') {
 519     global $CFG;
 520
 521     $path = str_replace('//', '/', $path);
 522     $path = trim($path, '/'); // no leading and trailing slashes
 523
 524     // type of file
 525     switch ($type) {
 526        case 'questionfile':
 527             $url = $CFG->wwwroot."/question/exportfile.php";
 528             break;
 529        case 'rssfile':
 530             $url = $CFG->wwwroot."/rss/file.php";
 531             break;
 532         case 'httpscoursefile':
 533             $url = $CFG->httpswwwroot."/file.php";
 534             break;
 535          case 'coursefile':
 536         default:
 537             $url = $CFG->wwwroot."/file.php";
 538     }
 539
 540     if ($CFG->slasharguments) {
 541         $parts = explode('/', $path);
 542         foreach ($parts as $key => $part) {
 543         /// anchor dash character should not be encoded
 544             $subparts = explode('#', $part);
 545             $subparts = array_map('rawurlencode', $subparts);
 546             $parts[$key] = implode('#', $subparts);
 547         }
 548         $path  = implode('/', $parts);
 549         $ffurl = $url.'/'.$path;
 550         $separator = '?';
 551     } else {
 552         $path = rawurlencode('/'.$path);
 553         $ffurl = $url.'?file='.$path;
 554         $separator = '&amp;';
 555     }
 556
 557     if ($options) {
 558         foreach ($options as $name=>$value) {
 559             $ffurl = $ffurl.$separator.$name.'='.$value;
 560             $separator = '&amp;';
 561         }
 562     }
 563
 564     return $ffurl;
 565 }
 566
 567 /**
 568  * @deprecated use get_enrolled_users($context) instead.
 569  */
 570 function get_course_participants($courseid) {
 571     throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
 572 }
 573
 574 /**
 575  * @deprecated use is_enrolled($context, $userid) instead.
 576  */
 577 function is_course_participant($userid, $courseid) {
 578     throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
 579 }
 580
 581 /**
 582  * @deprecated
 583  */
 584 function get_recent_enrolments($courseid, $timestart) {
 585     throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
 586 }
 587
 588 /**
 589  * @deprecated use clean_param($string, PARAM_FILE) instead.
 590  */
 591 function detect_munged_arguments($string, $allowdots=1) {
 592     throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
 593 }
 594
 595
 596 /**
 597  * Unzip one zip file to a destination dir
 598  * Both parameters must be FULL paths
 599  * If destination isn't specified, it will be the
 600  * SAME directory where the zip file resides.
 601  *
 602  * @global object
 603  * @param string $zipfile The zip file to unzip
 604  * @param string $destination The location to unzip to
 605  * @param bool $showstatus_ignored Unused
 606  */
 607 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
 608     global $CFG;
 609
 610     //Extract everything from zipfile
 611     $path_parts = pathinfo(cleardoubleslashes($zipfile));
 612     $zippath = $path_parts["dirname"];       //The path of the zip file
 613     $zipfilename = $path_parts["basename"];  //The name of the zip file
 614     $extension = $path_parts["extension"];    //The extension of the file
 615
 616     //If no file, error
 617     if (empty($zipfilename)) {
 618         return false;
 619     }
 620
 621     //If no extension, error
 622     if (empty($extension)) {
 623         return false;
 624     }
 625
 626     //Clear $zipfile
 627     $zipfile = cleardoubleslashes($zipfile);
 628
 629     //Check zipfile exists
 630     if (!file_exists($zipfile)) {
 631         return false;
 632     }
 633
 634     //If no destination, passed let's go with the same directory
 635     if (empty($destination)) {
 636         $destination = $zippath;
 637     }
 638
 639     //Clear $destination
 640     $destpath = rtrim(cleardoubleslashes($destination), "/");
 641
 642     //Check destination path exists
 643     if (!is_dir($destpath)) {
 644         return false;
 645     }
 646
 647     $packer = get_file_packer('application/zip');
 648
 649     $result = $packer->extract_to_pathname($zipfile, $destpath);
 650
 651     if ($result === false) {
 652         return false;
 653     }
 654
 655     foreach ($result as $status) {
 656         if ($status !== true) {
 657             return false;
 658         }
 659     }
 660
 661     return true;
 662 }
 663
 664 /**
 665  * Zip an array of files/dirs to a destination zip file
 666  * Both parameters must be FULL paths to the files/dirs
 667  *
 668  * @global object
 669  * @param array $originalfiles Files to zip
 670  * @param string $destination The destination path
 671  * @return bool Outcome
 672  */
 673 function zip_files ($originalfiles, $destination) {
 674     global $CFG;
 675
 676     //Extract everything from destination
 677     $path_parts = pathinfo(cleardoubleslashes($destination));
 678     $destpath = $path_parts["dirname"];       //The path of the zip file
 679     $destfilename = $path_parts["basename"];  //The name of the zip file
 680     $extension = $path_parts["extension"];    //The extension of the file
 681
 682     //If no file, error
 683     if (empty($destfilename)) {
 684         return false;
 685     }
 686
 687     //If no extension, add it
 688     if (empty($extension)) {
 689         $extension = 'zip';
 690         $destfilename = $destfilename.'.'.$extension;
 691     }
 692
 693     //Check destination path exists
 694     if (!is_dir($destpath)) {
 695         return false;
 696     }
 697
 698     //Check destination path is writable. TODO!!
 699
 700     //Clean destination filename
 701     $destfilename = clean_filename($destfilename);
 702
 703     //Now check and prepare every file
 704     $files = array();
 705     $origpath = NULL;
 706
 707     foreach ($originalfiles as $file) {  //Iterate over each file
 708         //Check for every file
 709         $tempfile = cleardoubleslashes($file); // no doubleslashes!
 710         //Calculate the base path for all files if it isn't set
 711         if ($origpath === NULL) {
 712             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
 713         }
 714         //See if the file is readable
 715         if (!is_readable($tempfile)) {  //Is readable
 716             continue;
 717         }
 718         //See if the file/dir is in the same directory than the rest
 719         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
 720             continue;
 721         }
 722         //Add the file to the array
 723         $files[] = $tempfile;
 724     }
 725
 726     $zipfiles = array();
 727     $start = strlen($origpath)+1;
 728     foreach($files as $file) {
 729         $zipfiles[substr($file, $start)] = $file;
 730     }
 731
 732     $packer = get_file_packer('application/zip');
 733
 734     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
 735 }
 736
 737 /**
 738  * @deprecated use groups_get_all_groups() instead.
 739  */
 740 function mygroupid($courseid) {
 741     throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
 742 }
 743
 744
 745 /**
 746  * Returns the current group mode for a given course or activity module
 747  *
 748  * Could be false, SEPARATEGROUPS or VISIBLEGROUPS    (<-- Martin)
 749  *
 750  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
 751  * @todo MDL-50273 This will be deleted in Moodle 3.2.
 752  *
 753  * @param object $course Course Object
 754  * @param object $cm Course Manager Object
 755  * @return mixed $course->groupmode
 756  */
 757 function groupmode($course, $cm=null) {
 758
 759     debugging('groupmode() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
 760     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
 761         return $cm->groupmode;
 762     }
 763     return $course->groupmode;
 764 }
 765
 766 /**
 767  * Sets the current group in the session variable
 768  * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
 769  * Sets currentgroup[$courseid] in the session variable appropriately.
 770  * Does not do any permission checking.
 771  *
 772  * @deprecated Since year 2006 - please do not use this function any more.
 773  * @todo MDL-50273 This will be deleted in Moodle 3.2.
 774  *
 775  * @global object
 776  * @global object
 777  * @param int $courseid The course being examined - relates to id field in
 778  * 'course' table.
 779  * @param int $groupid The group being examined.
 780  * @return int Current group id which was set by this function
 781  */
 782 function set_current_group($courseid, $groupid) {
 783     global $SESSION;
 784
 785     debugging('set_current_group() is deprecated, please use $SESSION->currentgroup[$courseid] instead', DEBUG_DEVELOPER);
 786     return $SESSION->currentgroup[$courseid] = $groupid;
 787 }
 788
 789 /**
 790  * Gets the current group - either from the session variable or from the database.
 791  *
 792  * @deprecated Since year 2006 - please do not use this function any more.
 793  * @todo MDL-50273 This will be deleted in Moodle 3.2.
 794  *
 795  * @global object
 796  * @param int $courseid The course being examined - relates to id field in
 797  * 'course' table.
 798  * @param bool $full If true, the return value is a full record object.
 799  * If false, just the id of the record.
 800  * @return int|bool
 801  */
 802 function get_current_group($courseid, $full = false) {
 803     global $SESSION;
 804
 805     debugging('get_current_group() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
 806     if (isset($SESSION->currentgroup[$courseid])) {
 807         if ($full) {
 808             return groups_get_group($SESSION->currentgroup[$courseid]);
 809         } else {
 810             return $SESSION->currentgroup[$courseid];
 811         }
 812     }
 813
 814     $mygroupid = mygroupid($courseid);
 815     if (is_array($mygroupid)) {
 816         $mygroupid = array_shift($mygroupid);
 817         set_current_group($courseid, $mygroupid);
 818         if ($full) {
 819             return groups_get_group($mygroupid);
 820         } else {
 821             return $mygroupid;
 822         }
 823     }
 824
 825     if ($full) {
 826         return false;
 827     } else {
 828         return 0;
 829     }
 830 }
 831
 832 /**
 833  * @deprecated Since Moodle 2.8
 834  */
 835 function groups_filter_users_by_course_module_visible($cm, $users) {
 836     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
 837             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
 838             'which does basically the same thing but includes other restrictions such ' .
 839             'as profile restrictions.');
 840 }
 841
 842 /**
 843  * @deprecated Since Moodle 2.8
 844  */
 845 function groups_course_module_visible($cm, $userid=null) {
 846     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
 847         user can ' . 'access an activity.', DEBUG_DEVELOPER);
 848 }
 849
 850 /**
 851  * @deprecated since 2.0
 852  */
 853 function error($message, $link='') {
 854     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
 855             print_error() instead of error()');
 856 }
 857
 858
 859 /**
 860  * @deprecated use $PAGE->theme->name instead.
 861  */
 862 function current_theme() {
 863     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
 864 }
 865
 866 /**
 867  * @deprecated
 868  */
 869 function formerr($error) {
 870     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
 871 }
 872
 873 /**
 874  * @deprecated use $OUTPUT->skip_link_target() in instead.
 875  */
 876 function skip_main_destination() {
 877     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
 878 }
 879
 880 /**
 881  * @deprecated use $OUTPUT->container() instead.
 882  */
 883 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
 884     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
 885 }
 886
 887 /**
 888  * @deprecated use $OUTPUT->container_start() instead.
 889  */
 890 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
 891     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
 892 }
 893
 894 /**
 895  * @deprecated use $OUTPUT->container_end() instead.
 896  */
 897 function print_container_end($return=false) {
 898     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
 899 }
 900
 901 /**
 902  * Print a bold message in an optional color.
 903  *
 904  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
 905  * @todo MDL-50469 This will be deleted in Moodle 3.3.
 906  * @param string $message The message to print out
 907  * @param string $classes Optional style to display message text in
 908  * @param string $align Alignment option
 909  * @param bool $return whether to return an output string or echo now
 910  * @return string|bool Depending on $result
 911  */
 912 function notify($message, $classes = 'notifyproblem', $align = 'center', $return = false) {
 913     global $OUTPUT;
 914
 915     debugging('notify() is deprecated, please use $OUTPUT->notification() instead', DEBUG_DEVELOPER);
 916
 917     if ($classes == 'green') {
 918         debugging('Use of deprecated class name "green" in notify. Please change to "notifysuccess".', DEBUG_DEVELOPER);
 919         $classes = 'notifysuccess'; // Backward compatible with old color system
 920     }
 921
 922     $output = $OUTPUT->notification($message, $classes);
 923     if ($return) {
 924         return $output;
 925     } else {
 926         echo $output;
 927     }
 928 }
 929
 930 /**
 931  * @deprecated use $OUTPUT->continue_button() instead.
 932  */
 933 function print_continue($link, $return = false) {
 934     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
 935 }
 936
 937 /**
 938  * @deprecated use $PAGE methods instead.
 939  */
 940 function print_header($title='', $heading='', $navigation='', $focus='',
 941                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
 942                       $usexml=false, $bodytags='', $return=false) {
 943
 944     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
 945 }
 946
 947 /**
 948  * @deprecated use $PAGE methods instead.
 949  */
 950 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
 951                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
 952
 953     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
 954 }
 955
 956 /**
 957  * @deprecated use $OUTPUT->block() instead.
 958  */
 959 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
 960     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
 961 }
 962
 963 /**
 964  * Prints a basic textarea field.
 965  *
 966  * @deprecated since Moodle 2.0
 967  *
 968  * When using this function, you should
 969  *
 970  * @global object
 971  * @param bool $unused No longer used.
 972  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
 973  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
 974  * @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.
 975  * @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.
 976  * @param string $name Name to use for the textarea element.
 977  * @param string $value Initial content to display in the textarea.
 978  * @param int $obsolete deprecated
 979  * @param bool $return If false, will output string. If true, will return string value.
 980  * @param string $id CSS ID to add to the textarea element.
 981  * @return string|void depending on the value of $return
 982  */
 983 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
 984     /// $width and height are legacy fields and no longer used as pixels like they used to be.
 985     /// However, you can set them to zero to override the mincols and minrows values below.
 986
 987     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
 988     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
 989
 990     global $CFG;
 991
 992     $mincols = 65;
 993     $minrows = 10;
 994     $str = '';
 995
 996     if ($id === '') {
 997         $id = 'edit-'.$name;
 998     }
 999
1000     if ($height && ($rows < $minrows)) {
1001         $rows = $minrows;
1002     }
1003     if ($width && ($cols < $mincols)) {
1004         $cols = $mincols;
1005     }
1006
1007     editors_head_setup();
1008     $editor = editors_get_preferred_editor(FORMAT_HTML);
1009     $editor->set_text($value);
1010     $editor->use_editor($id, array('legacy'=>true));
1011
1012     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
1013     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
1014     $str .= '</textarea>'."\n";
1015
1016     if ($return) {
1017         return $str;
1018     }
1019     echo $str;
1020 }
1021
1022 /**
1023  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
1024  * provide this function with the language strings for sortasc and sortdesc.
1025  *
1026  * @deprecated use $OUTPUT->arrow() instead.
1027  * @todo final deprecation of this function once MDL-45448 is resolved
1028  *
1029  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
1030  *
1031  * @global object
1032  * @param string $direction 'up' or 'down'
1033  * @param string $strsort The language string used for the alt attribute of this image
1034  * @param bool $return Whether to print directly or return the html string
1035  * @return string|void depending on $return
1036  *
1037  */
1038 function print_arrow($direction='up', $strsort=null, $return=false) {
1039     global $OUTPUT;
1040
1041     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
1042
1043     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
1044         return null;
1045     }
1046
1047     $return = null;
1048
1049     switch ($direction) {
1050         case 'up':
1051             $sortdir = 'asc';
1052             break;
1053         case 'down':
1054             $sortdir = 'desc';
1055             break;
1056         case 'move':
1057             $sortdir = 'asc';
1058             break;
1059         default:
1060             $sortdir = null;
1061             break;
1062     }
1063
1064     // Prepare language string
1065     $strsort = '';
1066     if (empty($strsort) && !empty($sortdir)) {
1067         $strsort  = get_string('sort' . $sortdir, 'grades');
1068     }
1069
1070     $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
1071
1072     if ($return) {
1073         return $return;
1074     } else {
1075         echo $return;
1076     }
1077 }
1078
1079 /**
1080  * @deprecated since Moodle 2.0
1081  */
1082 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1083                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1084                            $id='', $listbox=false, $multiple=false, $class='') {
1085     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
1086
1087 }
1088
1089 /**
1090  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1091  */
1092 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1093     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1094         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1095 }
1096
1097 /**
1098  * @deprecated use html_writer::checkbox() instead.
1099  */
1100 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1101     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1102 }
1103
1104 /**
1105  * Prints the 'update this xxx' button that appears on module pages.
1106  *
1107  * @deprecated since Moodle 2.0
1108  *
1109  * @param string $cmid the course_module id.
1110  * @param string $ignored not used any more. (Used to be courseid.)
1111  * @param string $string the module name - get_string('modulename', 'xxx')
1112  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1113  */
1114 function update_module_button($cmid, $ignored, $string) {
1115     global $CFG, $OUTPUT;
1116
1117     // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
1118
1119     //NOTE: DO NOT call new output method because it needs the module name we do not have here!
1120
1121     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1122         $string = get_string('updatethis', '', $string);
1123
1124         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1125         return $OUTPUT->single_button($url, $string);
1126     } else {
1127         return '';
1128     }
1129 }
1130
1131 /**
1132  * @deprecated use $OUTPUT->navbar() instead
1133  */
1134 function print_navigation ($navigation, $separator=0, $return=false) {
1135     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1136 }
1137
1138 /**
1139  * @deprecated Please use $PAGE->navabar methods instead.
1140  */
1141 function build_navigation($extranavlinks, $cm = null) {
1142     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1143 }
1144
1145 /**
1146  * @deprecated not relevant with global navigation in Moodle 2.x+
1147  */
1148 function navmenu($course, $cm=NULL, $targetwindow='self') {
1149     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1150 }
1151
1152 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1153
1154
1155 /**
1156  * @deprecated please use calendar_event::create() instead.
1157  */
1158 function add_event($event) {
1159     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1160 }
1161
1162 /**
1163  * @deprecated please calendar_event->update() instead.
1164  */
1165 function update_event($event) {
1166     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
1167 }
1168
1169 /**
1170  * @deprecated please use calendar_event->delete() instead.
1171  */
1172 function delete_event($id) {
1173     throw new coding_exception('delete_event() can not be used any more, please use '.
1174         'calendar_event->delete() instead.');
1175 }
1176
1177 /**
1178  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1179  */
1180 function hide_event($event) {
1181     throw new coding_exception('hide_event() can not be used any more, please use '.
1182         'calendar_event->toggle_visibility(false) instead.');
1183 }
1184
1185 /**
1186  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1187  */
1188 function show_event($event) {
1189     throw new coding_exception('show_event() can not be used any more, please use '.
1190         'calendar_event->toggle_visibility(true) instead.');
1191 }
1192
1193 /**
1194  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1195  * @see core_text
1196  */
1197 function textlib_get_instance() {
1198     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1199         'core_text::functioname() instead.');
1200 }
1201
1202 /**
1203  * @deprecated since 2.4
1204  * @see get_section_name()
1205  * @see format_base::get_section_name()
1206
1207  */
1208 function get_generic_section_name($format, stdClass $section) {
1209     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1210 }
1211
1212 /**
1213  * Returns an array of sections for the requested course id
1214  *
1215  * It is usually not recommended to display the list of sections used
1216  * in course because the course format may have it's own way to do it.
1217  *
1218  * If you need to just display the name of the section please call:
1219  * get_section_name($course, $section)
1220  * {@link get_section_name()}
1221  * from 2.4 $section may also be just the field course_sections.section
1222  *
1223  * If you need the list of all sections it is more efficient to get this data by calling
1224  * $modinfo = get_fast_modinfo($courseorid);
1225  * $sections = $modinfo->get_section_info_all()
1226  * {@link get_fast_modinfo()}
1227  * {@link course_modinfo::get_section_info_all()}
1228  *
1229  * Information about one section (instance of section_info):
1230  * get_fast_modinfo($courseorid)->get_sections_info($section)
1231  * {@link course_modinfo::get_section_info()}
1232  *
1233  * @deprecated since 2.4
1234  */
1235 function get_all_sections($courseid) {
1236
1237     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1238 }
1239
1240 /**
1241  * This function is deprecated, please use {@link course_add_cm_to_section()}
1242  * Note that course_add_cm_to_section() also updates field course_modules.section and
1243  * calls rebuild_course_cache()
1244  *
1245  * @deprecated since 2.4
1246  */
1247 function add_mod_to_section($mod, $beforemod = null) {
1248     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1249 }
1250
1251 /**
1252  * Returns a number of useful structures for course displays
1253  *
1254  * Function get_all_mods() is deprecated in 2.4
1255  * Instead of:
1256  * <code>
1257  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1258  * </code>
1259  * please use:
1260  * <code>
1261  * $mods = get_fast_modinfo($courseorid)->get_cms();
1262  * $modnames = get_module_types_names();
1263  * $modnamesplural = get_module_types_names(true);
1264  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1265  * </code>
1266  *
1267  * @deprecated since 2.4
1268  */
1269 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1270     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1271 }
1272
1273 /**
1274  * Returns course section - creates new if does not exist yet
1275  *
1276  * This function is deprecated. To create a course section call:
1277  * course_create_sections_if_missing($courseorid, $sections);
1278  * to get the section call:
1279  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1280  *
1281  * @see course_create_sections_if_missing()
1282  * @see get_fast_modinfo()
1283  * @deprecated since 2.4
1284  */
1285 function get_course_section($section, $courseid) {
1286     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1287 }
1288
1289 /**
1290  * @deprecated since 2.4
1291  * @see format_weeks::get_section_dates()
1292  */
1293 function format_weeks_get_section_dates($section, $course) {
1294     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1295             ' use it outside of format_weeks plugin');
1296 }
1297
1298 /**
1299  * Deprecated. Instead of:
1300  * list($content, $name) = get_print_section_cm_text($cm, $course);
1301  * use:
1302  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1303  * $name = $cm->get_formatted_name();
1304  *
1305  * @deprecated since 2.5
1306  * @see cm_info::get_formatted_content()
1307  * @see cm_info::get_formatted_name()
1308  */
1309 function get_print_section_cm_text(cm_info $cm, $course) {
1310     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1311             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1312 }
1313
1314 /**
1315  * Deprecated. Please use:
1316  * $courserenderer = $PAGE->get_renderer('core', 'course');
1317  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1318  *    array('inblock' => $vertical));
1319  * echo $output;
1320  *
1321  * @deprecated since 2.5
1322  * @see core_course_renderer::course_section_add_cm_control()
1323  */
1324 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1325     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1326             'function course_section_add_cm_control()');
1327 }
1328
1329 /**
1330  * Deprecated. Please use:
1331  * $courserenderer = $PAGE->get_renderer('core', 'course');
1332  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1333  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1334  *
1335  * @deprecated since 2.5
1336  * @see course_get_cm_edit_actions()
1337  * @see core_course_renderer->course_section_cm_edit_actions()
1338  */
1339 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1340     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1341             'lib/deprecatedlib.php on how to replace it');
1342 }
1343
1344 /**
1345  * Deprecated. Please use:
1346  * $courserenderer = $PAGE->get_renderer('core', 'course');
1347  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1348  *     array('hidecompletion' => $hidecompletion));
1349  *
1350  * @deprecated since 2.5
1351  * @see core_course_renderer::course_section_cm_list()
1352  */
1353 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1354     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1355             'course_section_cm_list() instead.');
1356 }
1357
1358 /**
1359  * @deprecated since 2.5
1360  */
1361 function print_overview($courses, array $remote_courses=array()) {
1362     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1363 }
1364
1365 /**
1366  * @deprecated since 2.5
1367  */
1368 function print_recent_activity($course) {
1369     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1370             ' use it outside of block_recent_activity');
1371 }
1372
1373 /**
1374  * @deprecated since 2.5
1375  */
1376 function delete_course_module($id) {
1377     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1378 }
1379
1380 /**
1381  * @deprecated since 2.5
1382  */
1383 function update_category_button($categoryid = 0) {
1384     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1385             'and edit courses are now separate and no longer depend on editing mode.');
1386 }
1387
1388 /**
1389  * This function is deprecated! For list of categories use
1390  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1391  * For parents of one particular category use
1392  * coursecat::get($id)->get_parents()
1393  *
1394  * @deprecated since 2.5
1395  */
1396 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1397         $excludeid = 0, $category = NULL, $path = "") {
1398     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1399             'coursecat::make_categories_list() and coursecat::get_parents()');
1400 }
1401
1402 /**
1403  * @deprecated since 2.5
1404  */
1405 function category_delete_move($category, $newparentid, $showfeedback=true) {
1406     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1407 }
1408
1409 /**
1410  * @deprecated since 2.5
1411  */
1412 function category_delete_full($category, $showfeedback=true) {
1413     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1414 }
1415
1416 /**
1417  * This function is deprecated. Please use
1418  * $coursecat = coursecat::get($category->id);
1419  * if ($coursecat->can_change_parent($newparentcat->id)) {
1420  *     $coursecat->change_parent($newparentcat->id);
1421  * }
1422  *
1423  * Alternatively you can use
1424  * $coursecat->update(array('parent' => $newparentcat->id));
1425  *
1426  * @see coursecat::change_parent()
1427  * @see coursecat::update()
1428  * @deprecated since 2.5
1429  */
1430 function move_category($category, $newparentcat) {
1431     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1432 }
1433
1434 /**
1435  * This function is deprecated. Please use
1436  * coursecat::get($category->id)->hide();
1437  *
1438  * @see coursecat::hide()
1439  * @deprecated since 2.5
1440  */
1441 function course_category_hide($category) {
1442     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1443 }
1444
1445 /**
1446  * This function is deprecated. Please use
1447  * coursecat::get($category->id)->show();
1448  *
1449  * @see coursecat::show()
1450  * @deprecated since 2.5
1451  */
1452 function course_category_show($category) {
1453     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1454 }
1455
1456 /**
1457  * This function is deprecated.
1458  * To get the category with the specified it please use:
1459  * coursecat::get($catid, IGNORE_MISSING);
1460  * or
1461  * coursecat::get($catid, MUST_EXIST);
1462  *
1463  * To get the first available category please use
1464  * coursecat::get_default();
1465  *
1466  * @deprecated since 2.5
1467  */
1468 function get_course_category($catid=0) {
1469     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1470 }
1471
1472 /**
1473  * This function is deprecated. It is replaced with the method create() in class coursecat.
1474  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1475  *
1476  * @deprecated since 2.5
1477  */
1478 function create_course_category($category) {
1479     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
1480 }
1481
1482 /**
1483  * This function is deprecated.
1484  *
1485  * To get visible children categories of the given category use:
1486  * coursecat::get($categoryid)->get_children();
1487  * This function will return the array or coursecat objects, on each of them
1488  * you can call get_children() again
1489  *
1490  * @see coursecat::get()
1491  * @see coursecat::get_children()
1492  *
1493  * @deprecated since 2.5
1494  */
1495 function get_all_subcategories($catid) {
1496     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1497             class. See phpdocs for more details');
1498 }
1499
1500 /**
1501  * This function is deprecated. Please use functions in class coursecat:
1502  * - coursecat::get($parentid)->has_children()
1503  * tells if the category has children (visible or not to the current user)
1504  *
1505  * - coursecat::get($parentid)->get_children()
1506  * returns an array of coursecat objects, each of them represents a children category visible
1507  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1508  *
1509  * - coursecat::get($parentid)->get_children_count()
1510  * returns number of children categories visible to the current user
1511  *
1512  * - coursecat::count_all()
1513  * returns total count of all categories in the system (both visible and not)
1514  *
1515  * - coursecat::get_default()
1516  * returns the first category (usually to be used if count_all() == 1)
1517  *
1518  * @deprecated since 2.5
1519  */
1520 function get_child_categories($parentid) {
1521     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1522             more details.');
1523 }
1524
1525 /**
1526  *
1527  * @deprecated since 2.5
1528  *
1529  * This function is deprecated. Use appropriate functions from class coursecat.
1530  * Examples:
1531  *
1532  * coursecat::get($categoryid)->get_children()
1533  * - returns all children of the specified category as instances of class
1534  * coursecat, which means on each of them method get_children() can be called again.
1535  * Only categories visible to the current user are returned.
1536  *
1537  * coursecat::get(0)->get_children()
1538  * - returns all top-level categories visible to the current user.
1539  *
1540  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1541  *
1542  * coursecat::make_categories_list()
1543  * - returns an array of all categories id/names in the system.
1544  * Also only returns categories visible to current user and can additionally be
1545  * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1546  *
1547  * make_categories_options()
1548  * - Returns full course categories tree to be used in html_writer::select()
1549  *
1550  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1551  * {@link coursecat::get_default()}
1552  */
1553 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1554     throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
1555 }
1556
1557 /**
1558 * This function is deprecated, please use course renderer:
1559 * $renderer = $PAGE->get_renderer('core', 'course');
1560 * echo $renderer->course_search_form($value, $format);
1561 *
1562 * @deprecated since 2.5
1563 */
1564 function print_course_search($value="", $return=false, $format="plain") {
1565     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1566 }
1567
1568 /**
1569  * This function is deprecated, please use:
1570  * $renderer = $PAGE->get_renderer('core', 'course');
1571  * echo $renderer->frontpage_my_courses()
1572  *
1573  * @deprecated since 2.5
1574  */
1575 function print_my_moodle() {
1576     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
1577 }
1578
1579 /**
1580  * This function is deprecated, it is replaced with protected function
1581  * {@link core_course_renderer::frontpage_remote_course()}
1582  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1583  *
1584  * @deprecated since 2.5
1585  */
1586 function print_remote_course($course, $width="100%") {
1587     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1588 }
1589
1590 /**
1591  * This function is deprecated, it is replaced with protected function
1592  * {@link core_course_renderer::frontpage_remote_host()}
1593  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1594  *
1595  * @deprecated since 2.5
1596  */
1597 function print_remote_host($host, $width="100%") {
1598     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1599 }
1600
1601 /**
1602  * @deprecated since 2.5
1603  *
1604  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1605  */
1606 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1607     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1608 }
1609
1610 /**
1611  * @deprecated since 2.5
1612  */
1613 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1614     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1615 }
1616
1617 /**
1618  * @deprecated since 2.5
1619  *
1620  * This function is not used any more in moodle core and course renderer does not have render function for it.
1621  * Combo list on the front page is displayed as:
1622  * $renderer = $PAGE->get_renderer('core', 'course');
1623  * echo $renderer->frontpage_combo_list()
1624  *
1625  * The new class {@link coursecat} stores the information about course category tree
1626  * To get children categories use:
1627  * coursecat::get($id)->get_children()
1628  * To get list of courses use:
1629  * coursecat::get($id)->get_courses()
1630  *
1631  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1632  */
1633 function get_course_category_tree($id = 0, $depth = 0) {
1634     throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1635             see function phpdocs for more info');
1636 }
1637
1638 /**
1639  * @deprecated since 2.5
1640  *
1641  * To print a generic list of courses use:
1642  * $renderer = $PAGE->get_renderer('core', 'course');
1643  * echo $renderer->courses_list($courses);
1644  *
1645  * To print list of all courses:
1646  * $renderer = $PAGE->get_renderer('core', 'course');
1647  * echo $renderer->frontpage_available_courses();
1648  *
1649  * To print list of courses inside category:
1650  * $renderer = $PAGE->get_renderer('core', 'course');
1651  * echo $renderer->course_category($category); // this will also print subcategories
1652  */
1653 function print_courses($category) {
1654     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1655 }
1656
1657 /**
1658  * @deprecated since 2.5
1659  *
1660  * Please use course renderer to display a course information box.
1661  * $renderer = $PAGE->get_renderer('core', 'course');
1662  * echo $renderer->courses_list($courses); // will print list of courses
1663  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1664  */
1665 function print_course($course, $highlightterms = '') {
1666     throw new coding_exception('Function print_course() is removed, please use course renderer');
1667 }
1668
1669 /**
1670  * @deprecated since 2.5
1671  *
1672  * This function is not used any more in moodle core and course renderer does not have render function for it.
1673  * Combo list on the front page is displayed as:
1674  * $renderer = $PAGE->get_renderer('core', 'course');
1675  * echo $renderer->frontpage_combo_list()
1676  *
1677  * The new class {@link coursecat} stores the information about course category tree
1678  * To get children categories use:
1679  * coursecat::get($id)->get_children()
1680  * To get list of courses use:
1681  * coursecat::get($id)->get_courses()
1682  */
1683 function get_category_courses_array($categoryid = 0) {
1684     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1685 }
1686
1687 /**
1688  * @deprecated since 2.5
1689  */
1690 function get_category_courses_array_recursively(array &$flattened, $category) {
1691     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1692 }
1693
1694 /**
1695  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1696  */
1697 function blog_get_context_url($context=null) {
1698     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1699 }
1700
1701 /**
1702  * @deprecated since 2.5
1703  *
1704  * To get list of all courses with course contacts ('managers') use
1705  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1706  *
1707  * To get list of courses inside particular category use
1708  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1709  *
1710  * Additionally you can specify sort order, offset and maximum number of courses,
1711  * see {@link coursecat::get_courses()}
1712  */
1713 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1714     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1715 }
1716
1717 /**
1718  * @deprecated since 2.5
1719  */
1720 function convert_tree_to_html($tree, $row=0) {
1721     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1722 }
1723
1724 /**
1725  * @deprecated since 2.5
1726  */
1727 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1728     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1729 }
1730
1731 /**
1732  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1733  */
1734 function can_use_rotated_text() {
1735     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1736 }
1737
1738 /**
1739  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1740  * @see context::instance_by_id($id)
1741  */
1742 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1743     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1744 }
1745
1746 /**
1747  * Returns system context or null if can not be created yet.
1748  *
1749  * @see context_system::instance()
1750  * @deprecated since 2.2
1751  * @param bool $cache use caching
1752  * @return context system context (null if context table not created yet)
1753  */
1754 function get_system_context($cache = true) {
1755     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1756     return context_system::instance(0, IGNORE_MISSING, $cache);
1757 }
1758
1759 /**
1760  * @see context::get_parent_context_ids()
1761  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1762  */
1763 function get_parent_contexts(context $context, $includeself = false) {
1764     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1765 }
1766
1767 /**
1768  * @deprecated since Moodle 2.2
1769  * @see context::get_parent_context()
1770  */
1771 function get_parent_contextid(context $context) {
1772     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1773 }
1774
1775 /**
1776  * @see context::get_child_contexts()
1777  * @deprecated since 2.2
1778  */
1779 function get_child_contexts(context $context) {
1780     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1781 }
1782
1783 /**
1784  * @see context_helper::create_instances()
1785  * @deprecated since 2.2
1786  */
1787 function create_contexts($contextlevel = null, $buildpaths = true) {
1788     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1789 }
1790
1791 /**
1792  * @see context_helper::cleanup_instances()
1793  * @deprecated since 2.2
1794  */
1795 function cleanup_contexts() {
1796     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1797 }
1798
1799 /**
1800  * Populate context.path and context.depth where missing.
1801  *
1802  * @deprecated since 2.2
1803  */
1804 function build_context_path($force = false) {
1805     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1806 }
1807
1808 /**
1809  * @deprecated since 2.2
1810  */
1811 function rebuild_contexts(array $fixcontexts) {
1812     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1813 }
1814
1815 /**
1816  * @deprecated since Moodle 2.2
1817  * @see context_helper::preload_course()
1818  */
1819 function preload_course_contexts($courseid) {
1820     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1821 }
1822
1823 /**
1824  * @deprecated since Moodle 2.2
1825  * @see context::update_moved()
1826  */
1827 function context_moved(context $context, context $newparent) {
1828     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1829 }
1830
1831 /**
1832  * @see context::get_capabilities()
1833  * @deprecated since 2.2
1834  */
1835 function fetch_context_capabilities(context $context) {
1836     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1837 }
1838
1839 /**
1840  * @deprecated since 2.2
1841  * @see context_helper::preload_from_record()
1842  */
1843 function context_instance_preload(stdClass $rec) {
1844     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1845 }
1846
1847 /**
1848  * Returns context level name
1849  *
1850  * @deprecated since 2.2
1851  * @see context_helper::get_level_name()
1852  */
1853 function get_contextlevel_name($contextlevel) {
1854     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1855 }
1856
1857 /**
1858  * @deprecated since 2.2
1859  * @see context::get_context_name()
1860  */
1861 function print_context_name(context $context, $withprefix = true, $short = false) {
1862     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1863 }
1864
1865 /**
1866  * @deprecated since 2.2, use $context->mark_dirty() instead
1867  * @see context::mark_dirty()
1868  */
1869 function mark_context_dirty($path) {
1870     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1871 }
1872
1873 /**
1874  * @deprecated since Moodle 2.2
1875  * @see context_helper::delete_instance() or context::delete_content()
1876  */
1877 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1878     if ($deleterecord) {
1879         throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
1880     } else {
1881         throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
1882     }
1883 }
1884
1885 /**
1886  * @deprecated since 2.2
1887  * @see context::get_url()
1888  */
1889 function get_context_url(context $context) {
1890     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1891 }
1892
1893 /**
1894  * @deprecated since 2.2
1895  * @see context::get_course_context()
1896  */
1897 function get_course_context(context $context) {
1898     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1899 }
1900
1901 /**
1902  * @deprecated since 2.2
1903  * @see enrol_get_users_courses()
1904  */
1905 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1906
1907     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1908 }
1909
1910 /**
1911  * @deprecated since Moodle 2.2
1912  */
1913 function get_role_context_caps($roleid, context $context) {
1914     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1915 }
1916
1917 /**
1918  * @see context::get_course_context()
1919  * @deprecated since 2.2
1920  */
1921 function get_courseid_from_context(context $context) {
1922     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1923 }
1924
1925 /**
1926  * If you are using this methid, you should have something like this:
1927  *
1928  *    list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1929  *
1930  * To prevent the use of this deprecated function, replace the line above with something similar to this:
1931  *
1932  *    $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1933  *                                                                        ^
1934  *    $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1935  *                                    ^       ^                ^        ^
1936  *    $params = array('contextlevel' => CONTEXT_COURSE);
1937  *                                      ^
1938  * @see context_helper:;get_preload_record_columns_sql()
1939  * @deprecated since 2.2
1940  */
1941 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1942     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1943 }
1944
1945 /**
1946  * @deprecated since 2.2
1947  * @see context::get_parent_context_ids()
1948  */
1949 function get_related_contexts_string(context $context) {
1950     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1951 }
1952
1953 /**
1954  * @deprecated since 2.6
1955  * @see core_component::get_plugin_list_with_file()
1956  */
1957 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1958     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1959 }
1960
1961 /**
1962  * @deprecated since 2.6
1963  */
1964 function check_browser_operating_system($brand) {
1965     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1966 }
1967
1968 /**
1969  * @deprecated since 2.6
1970  */
1971 function check_browser_version($brand, $version = null) {
1972     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1973 }
1974
1975 /**
1976  * @deprecated since 2.6
1977  */
1978 function get_device_type() {
1979     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1980 }
1981
1982 /**
1983  * @deprecated since 2.6
1984  */
1985 function get_device_type_list($incusertypes = true) {
1986     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1987 }
1988
1989 /**
1990  * @deprecated since 2.6
1991  */
1992 function get_selected_theme_for_device_type($devicetype = null) {
1993     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1994 }
1995
1996 /**
1997  * @deprecated since 2.6
1998  */
1999 function get_device_cfg_var_name($devicetype = null) {
2000     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
2001 }
2002
2003 /**
2004  * @deprecated since 2.6
2005  */
2006 function set_user_device_type($newdevice) {
2007     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
2008 }
2009
2010 /**
2011  * @deprecated since 2.6
2012  */
2013 function get_user_device_type() {
2014     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
2015 }
2016
2017 /**
2018  * @deprecated since 2.6
2019  */
2020 function get_browser_version_classes() {
2021     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
2022 }
2023
2024 /**
2025  * @deprecated since Moodle 2.6
2026  * @see core_user::get_support_user()
2027  */
2028 function generate_email_supportuser() {
2029     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
2030 }
2031
2032 /**
2033  * @deprecated since Moodle 2.6
2034  */
2035 function badges_get_issued_badge_info($hash) {
2036     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
2037 }
2038
2039 /**
2040  * @deprecated since 2.6
2041  */
2042 function can_use_html_editor() {
2043     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
2044 }
2045
2046
2047 /**
2048  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
2049  */
2050 function count_login_failures($mode, $username, $lastlogin) {
2051     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
2052 }
2053
2054 /**
2055  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
2056  */
2057 function ajaxenabled(array $browsers = null) {
2058     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
2059 }
2060
2061 /**
2062  * @deprecated Since Moodle 2.7 MDL-44070
2063  */
2064 function coursemodule_visible_for_user($cm, $userid=0) {
2065     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
2066             please use \core_availability\info_module::is_user_visible()');
2067 }
2068
2069 /**
2070  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
2071  */
2072 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
2073     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
2074         'cohort_get_available_cohorts() instead');
2075 }
2076
2077 /**
2078  * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
2079  * takes into account current context
2080  *
2081  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
2082  */
2083 function enrol_cohort_can_view_cohort($cohortid) {
2084     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
2085 }
2086
2087 /**
2088  * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2089  *
2090  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2091  */
2092 function cohort_get_visible_list($course, $onlyenrolled=true) {
2093     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
2094         "that correctly checks capabilities.');
2095 }
2096
2097 /**
2098  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2099  */
2100 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2101     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
2102 }
2103
2104 /**
2105  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2106  */
2107 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2108     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
2109 }
2110
2111 /* === Apis deprecated in since Moodle 2.9 === */
2112
2113 /**
2114  * Is $USER one of the supplied users?
2115  *
2116  * $user2 will be null if viewing a user's recent conversations
2117  *
2118  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2119  * @todo MDL-49290 This will be deleted in Moodle 3.1.
2120  * @param stdClass the first user
2121  * @param stdClass the second user or null
2122  * @return bool True if the current user is one of either $user1 or $user2
2123  */
2124 function message_current_user_is_involved($user1, $user2) {
2125     global $USER;
2126
2127     debugging('message_current_user_is_involved() is deprecated, please do not use this function.', DEBUG_DEVELOPER);
2128
2129     if (empty($user1->id) || (!empty($user2) && empty($user2->id))) {
2130         throw new coding_exception('Invalid user object detected. Missing id.');
2131     }
2132
2133     if ($user1->id != $USER->id && (empty($user2) || $user2->id != $USER->id)) {
2134         return false;
2135     }
2136     return true;
2137 }
2138
2139 /**
2140  * Print badges on user profile page.
2141  *
2142  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2143  * @param int $userid User ID.
2144  * @param int $courseid Course if we need to filter badges (optional).
2145  */
2146 function profile_display_badges($userid, $courseid = 0) {
2147     global $CFG, $PAGE, $USER, $SITE;
2148     require_once($CFG->dirroot . '/badges/renderer.php');
2149
2150     debugging('profile_display_badges() is deprecated.', DEBUG_DEVELOPER);
2151
2152     // Determine context.
2153     if (isloggedin()) {
2154         $context = context_user::instance($USER->id);
2155     } else {
2156         $context = context_system::instance();
2157     }
2158
2159     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
2160         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
2161         $renderer = new core_badges_renderer($PAGE, '');
2162
2163         // Print local badges.
2164         if ($records) {
2165             $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
2166             $right = $renderer->print_badges_list($records, $userid, true);
2167             echo html_writer::tag('dt', $left);
2168             echo html_writer::tag('dd', $right);
2169         }
2170
2171         // Print external badges.
2172         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
2173             $backpack = get_backpack_settings($userid);
2174             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
2175                 $left = get_string('externalbadgesp', 'badges');
2176                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
2177                 echo html_writer::tag('dt', $left);
2178                 echo html_writer::tag('dd', $right);
2179             }
2180         }
2181     }
2182 }
2183
2184 /**
2185  * Adds user preferences elements to user edit form.
2186  *
2187  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2188  * @todo MDL-49784 Remove this function in Moodle 3.1
2189  * @param stdClass $user
2190  * @param moodleform $mform
2191  * @param array|null $editoroptions
2192  * @param array|null $filemanageroptions
2193  */
2194 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2195     global $CFG;
2196
2197     debugging('useredit_shared_definition_preferences() is deprecated.', DEBUG_DEVELOPER, backtrace);
2198
2199     $choices = array();
2200     $choices['0'] = get_string('emaildisplayno');
2201     $choices['1'] = get_string('emaildisplayyes');
2202     $choices['2'] = get_string('emaildisplaycourse');
2203     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
2204     $mform->setDefault('maildisplay', $CFG->defaultpreference_maildisplay);
2205
2206     $choices = array();
2207     $choices['0'] = get_string('textformat');
2208     $choices['1'] = get_string('htmlformat');
2209     $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
2210     $mform->setDefault('mailformat', $CFG->defaultpreference_mailformat);
2211
2212     if (!empty($CFG->allowusermailcharset)) {
2213         $choices = array();
2214         $charsets = get_list_of_charsets();
2215         if (!empty($CFG->sitemailcharset)) {
2216             $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
2217         } else {
2218             $choices['0'] = get_string('site').' (UTF-8)';
2219         }
2220         $choices = array_merge($choices, $charsets);
2221         $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
2222     }
2223
2224     $choices = array();
2225     $choices['0'] = get_string('emaildigestoff');
2226     $choices['1'] = get_string('emaildigestcomplete');
2227     $choices['2'] = get_string('emaildigestsubjects');
2228     $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
2229     $mform->setDefault('maildigest', $CFG->defaultpreference_maildigest);
2230     $mform->addHelpButton('maildigest', 'emaildigest');
2231
2232     $choices = array();
2233     $choices['1'] = get_string('autosubscribeyes');
2234     $choices['0'] = get_string('autosubscribeno');
2235     $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
2236     $mform->setDefault('autosubscribe', $CFG->defaultpreference_autosubscribe);
2237
2238     if (!empty($CFG->forum_trackreadposts)) {
2239         $choices = array();
2240         $choices['0'] = get_string('trackforumsno');
2241         $choices['1'] = get_string('trackforumsyes');
2242         $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
2243         $mform->setDefault('trackforums', $CFG->defaultpreference_trackforums);
2244     }
2245
2246     $editors = editors_get_enabled();
2247     if (count($editors) > 1) {
2248         $choices = array('' => get_string('defaulteditor'));
2249         $firsteditor = '';
2250         foreach (array_keys($editors) as $editor) {
2251             if (!$firsteditor) {
2252                 $firsteditor = $editor;
2253             }
2254             $choices[$editor] = get_string('pluginname', 'editor_' . $editor);
2255         }
2256         $mform->addElement('select', 'preference_htmleditor', get_string('textediting'), $choices);
2257         $mform->setDefault('preference_htmleditor', '');
2258     } else {
2259         // Empty string means use the first chosen text editor.
2260         $mform->addElement('hidden', 'preference_htmleditor');
2261         $mform->setDefault('preference_htmleditor', '');
2262         $mform->setType('preference_htmleditor', PARAM_PLUGIN);
2263     }
2264
2265     $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
2266     $mform->setDefault('lang', $CFG->lang);
2267
2268 }
2269
2270
2271 /**
2272  * Convert region timezone to php supported timezone
2273  *
2274  * @deprecated since Moodle 2.9
2275  * @param string $tz value from ical file
2276  * @return string $tz php supported timezone
2277  */
2278 function calendar_normalize_tz($tz) {
2279     debugging('calendar_normalize_tz() is deprecated, use core_date::normalise_timezone() instead', DEBUG_DEVELOPER);
2280     return core_date::normalise_timezone($tz);
2281 }
2282
2283 /**
2284  * Returns a float which represents the user's timezone difference from GMT in hours
2285  * Checks various settings and picks the most dominant of those which have a value
2286  * @deprecated since Moodle 2.9
2287  * @param float|int|string $tz timezone user timezone
2288  * @return float
2289  */
2290 function get_user_timezone_offset($tz = 99) {
2291     debugging('get_user_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2292     $tz = core_date::get_user_timezone($tz);
2293     $date = new DateTime('now', new DateTimeZone($tz));
2294     return ($date->getOffset() - dst_offset_on(time(), $tz)) / (3600.0);
2295 }
2296
2297 /**
2298  * Returns an int which represents the systems's timezone difference from GMT in seconds
2299  * @deprecated since Moodle 2.9
2300  * @param float|int|string $tz timezone for which offset is required.
2301  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2302  * @return int|bool if found, false is timezone 99 or error
2303  */
2304 function get_timezone_offset($tz) {
2305     debugging('get_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2306     $date = new DateTime('now', new DateTimeZone(core_date::normalise_timezone($tz)));
2307     return $date->getOffset() - dst_offset_on(time(), $tz);
2308 }
2309
2310 /**
2311  * Returns a list of timezones in the current language.
2312  * @deprecated since Moodle 2.9
2313  * @return array
2314  */
2315 function get_list_of_timezones() {
2316     debugging('get_list_of_timezones() is deprecated, use core_date::get_list_of_timezones() instead', DEBUG_DEVELOPER);
2317     return core_date::get_list_of_timezones();
2318 }
2319
2320 /**
2321  * Previous internal API, it was not supposed to be used anywhere.
2322  * @deprecated since Moodle 2.9
2323  * @param array $timezones
2324  */
2325 function update_timezone_records($timezones) {
2326     debugging('update_timezone_records() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2327 }
2328
2329 /**
2330  * Previous internal API, it was not supposed to be used anywhere.
2331  * @deprecated since Moodle 2.9
2332  * @param int $fromyear
2333  * @param int $toyear
2334  * @param mixed $strtimezone
2335  * @return bool
2336  */
2337 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2338     debugging('calculate_user_dst_table() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2339     return false;
2340 }
2341
2342 /**
2343  * Previous internal API, it was not supposed to be used anywhere.
2344  * @deprecated since Moodle 2.9
2345  * @param int|string $year
2346  * @param mixed $timezone
2347  * @return null
2348  */
2349 function dst_changes_for_year($year, $timezone) {
2350     debugging('dst_changes_for_year() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2351     return null;
2352 }
2353
2354 /**
2355  * Previous internal API, it was not supposed to be used anywhere.
2356  * @deprecated since Moodle 2.9
2357  * @param string $timezonename
2358  * @return array
2359  */
2360 function get_timezone_record($timezonename) {
2361     debugging('get_timezone_record() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2362     return array();
2363 }
2364
2365 /* === Apis deprecated since Moodle 3.0 === */
2366 /**
2367  * Returns the URL of the HTTP_REFERER, less the querystring portion if required.
2368  *
2369  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2370  * @todo Remove this function in Moodle 3.2
2371  * @param boolean $stripquery if true, also removes the query part of the url.
2372  * @return string The resulting referer or empty string.
2373  */
2374 function get_referer($stripquery = true) {
2375     debugging('get_referer() is deprecated. Please use get_local_referer() instead.', DEBUG_DEVELOPER);
2376     if (isset($_SERVER['HTTP_REFERER'])) {
2377         if ($stripquery) {
2378             return strip_querystring($_SERVER['HTTP_REFERER']);
2379         } else {
2380             return $_SERVER['HTTP_REFERER'];
2381         }
2382     } else {
2383         return '';
2384     }
2385 }
2386
2387 /**
2388  * Checks if current user is a web crawler.
2389  *
2390  * This list can not be made complete, this is not a security
2391  * restriction, we make the list only to help these sites
2392  * especially when automatic guest login is disabled.
2393  *
2394  * If admin needs security they should enable forcelogin
2395  * and disable guest access!!
2396  *
2397  * @return bool
2398  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2399  */
2400 function is_web_crawler() {
2401     debugging('is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.', DEBUG_DEVELOPER);
2402     return core_useragent::is_web_crawler();
2403 }
2404
2405 /**
2406  * Update user's course completion statuses
2407  *
2408  * First update all criteria completions, then aggregate all criteria completions
2409  * and update overall course completions.
2410  *
2411  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2412  * @todo Remove this function in Moodle 3.2 MDL-51226.
2413  */
2414 function completion_cron() {
2415     global $CFG;
2416     require_once($CFG->dirroot.'/completion/cron.php');
2417
2418     debugging('completion_cron() is deprecated. Functionality has been moved to scheduled tasks.', DEBUG_DEVELOPER);
2419     completion_cron_mark_started();
2420
2421     completion_cron_criteria();
2422
2423     completion_cron_completions();
2424 }
2425
2426 /**
2427  * Returns an ordered array of tags associated with visible courses
2428  * (boosted replacement of get_all_tags() allowing association with user and tagtype).
2429  *
2430  * @deprecated since 3.0
2431  * @package  core_tag
2432  * @category tag
2433  * @param    int      $courseid A course id. Passing 0 will return all distinct tags for all visible courses
2434  * @param    int      $userid   (optional) the user id, a default of 0 will return all users tags for the course
2435  * @param    string   $tagtype  (optional) The type of tag, empty string returns all types. Currently (Moodle 2.2) there are two
2436  *                              types of tags which are used within Moodle, they are 'official' and 'default'.
2437  * @param    int      $numtags  (optional) number of tags to display, default of 80 is set in the block, 0 returns all
2438  * @param    string   $unused   (optional) was selected sorting, moved to tag_print_cloud()
2439  * @return   array
2440  */
2441 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2442     debugging('Function coursetag_get_tags() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2443
2444     global $CFG, $DB;
2445
2446     // get visible course ids
2447     $courselist = array();
2448     if ($courseid === 0) {
2449         if ($courses = $DB->get_records_select('course', 'visible=1 AND category>0', null, '', 'id')) {
2450             foreach ($courses as $key => $value) {
2451                 $courselist[] = $key;
2452             }
2453         }
2454     }
2455
2456     // get tags from the db ordered by highest count first
2457     $params = array();
2458     $sql = "SELECT id as tkey, name, id, tagtype, rawname, f.timemodified, flag, count
2459               FROM {tag} t,
2460                  (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2461                     FROM {tag_instance}
2462                    WHERE itemtype = 'course' ";
2463
2464     if ($courseid > 0) {
2465         $sql .= "    AND itemid = :courseid ";
2466         $params['courseid'] = $courseid;
2467     } else {
2468         if (!empty($courselist)) {
2469             list($usql, $uparams) = $DB->get_in_or_equal($courselist, SQL_PARAMS_NAMED);
2470             $sql .= "AND itemid $usql ";
2471             $params = $params + $uparams;
2472         }
2473     }
2474
2475     if ($userid > 0) {
2476         $sql .= "    AND tiuserid = :userid ";
2477         $params['userid'] = $userid;
2478     }
2479
2480     $sql .= "   GROUP BY tagid) f
2481              WHERE t.id = f.tagid ";
2482     if ($tagtype != '') {
2483         $sql .= "AND tagtype = :tagtype ";
2484         $params['tagtype'] = $tagtype;
2485     }
2486     $sql .= "ORDER BY count DESC, name ASC";
2487
2488     // limit the number of tags for output
2489     if ($numtags == 0) {
2490         $tags = $DB->get_records_sql($sql, $params);
2491     } else {
2492         $tags = $DB->get_records_sql($sql, $params, 0, $numtags);
2493     }
2494
2495     // prepare the return
2496     $return = array();
2497     if ($tags) {
2498         // avoid print_tag_cloud()'s ksort upsetting ordering by setting the key here
2499         foreach ($tags as $value) {
2500             $return[] = $value;
2501         }
2502     }
2503
2504     return $return;
2505
2506 }
2507
2508 /**
2509  * Returns an ordered array of tags
2510  * (replaces popular_tags_count() allowing sorting).
2511  *
2512  * @deprecated since 3.0
2513  * @package  core_tag
2514  * @category tag
2515  * @param    string $unused (optional) was selected sorting - moved to tag_print_cloud()
2516  * @param    int    $numtags (optional) number of tags to display, default of 20 is set in the block, 0 returns all
2517  * @return   array
2518  */
2519 function coursetag_get_all_tags($unused='', $numtags=0) {
2520     debugging('Function coursetag_get_all_tag() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2521
2522     global $CFG, $DB;
2523
2524     // note that this selects all tags except for courses that are not visible
2525     $sql = "SELECT id, name, tagtype, rawname, f.timemodified, flag, count
2526         FROM {tag} t,
2527         (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2528             FROM {tag_instance} WHERE tagid NOT IN
2529                 (SELECT tagid FROM {tag_instance} ti, {course} c
2530                 WHERE c.visible = 0
2531                 AND ti.itemtype = 'course'
2532                 AND ti.itemid = c.id)
2533         GROUP BY tagid) f
2534         WHERE t.id = f.tagid
2535         ORDER BY count DESC, name ASC";
2536     if ($numtags == 0) {
2537         $tags = $DB->get_records_sql($sql);
2538     } else {
2539         $tags = $DB->get_records_sql($sql, null, 0, $numtags);
2540     }
2541
2542     $return = array();
2543     if ($tags) {
2544         foreach ($tags as $value) {
2545             $return[] = $value;
2546         }
2547     }
2548
2549     return $return;
2550 }
2551
2552 /**
2553  * Returns javascript for use in tags block and supporting pages
2554  *
2555  * @deprecated since 3.0
2556  * @package  core_tag
2557  * @category tag
2558  * @return   null
2559  */
2560 function coursetag_get_jscript() {
2561     debugging('Function coursetag_get_jscript() is deprecated and obsolete.', DEBUG_DEVELOPER);
2562     return '';
2563 }
2564
2565 /**
2566  * Returns javascript to create the links in the tag block footer.
2567  *
2568  * @deprecated since 3.0
2569  * @package  core_tag
2570  * @category tag
2571  * @param    string   $elementid       the element to attach the footer to
2572  * @param    array    $coursetagslinks links arrays each consisting of 'title', 'onclick' and 'text' elements
2573  * @return   string   always returns a blank string
2574  */
2575 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2576     debugging('Function coursetag_get_jscript_links() is deprecated and obsolete.', DEBUG_DEVELOPER);
2577     return '';
2578 }
2579
2580 /**
2581  * Returns all tags created by a user for a course
2582  *
2583  * @deprecated since 3.0
2584  * @package  core_tag
2585  * @category tag
2586  * @param    int      $courseid tags are returned for the course that has this courseid
2587  * @param    int      $userid   return tags which were created by this user
2588  */
2589 function coursetag_get_records($courseid, $userid) {
2590     debugging('Function coursetag_get_records() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2591
2592     global $CFG, $DB;
2593
2594     $sql = "SELECT t.id, name, rawname
2595               FROM {tag} t, {tag_instance} ti
2596              WHERE t.id = ti.tagid
2597                  AND ti.tiuserid = :userid
2598                  AND ti.itemid = :courseid
2599           ORDER BY name ASC";
2600
2601     return $DB->get_records_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid));
2602 }
2603
2604 /**
2605  * Stores a tag for a course for a user
2606  *
2607  * @deprecated since 3.0
2608  * @package  core_tag
2609  * @category tag
2610  * @param    array  $tags     simple array of keywords to be stored
2611  * @param    int    $courseid the id of the course we wish to store a tag for
2612  * @param    int    $userid   the id of the user we wish to store a tag for
2613  * @param    string $tagtype  official or default only
2614  * @param    string $myurl    (optional) for logging creation of course tags
2615  */
2616 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2617     debugging('Function coursetag_store_keywords() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2618
2619     global $CFG;
2620     require_once $CFG->dirroot.'/tag/lib.php';
2621
2622     if (is_array($tags) and !empty($tags)) {
2623         foreach ($tags as $tag) {
2624             $tag = trim($tag);
2625             if (strlen($tag) > 0) {
2626                 //tag_set_add('course', $courseid, $tag, $userid); //deletes official tags
2627
2628                 //add tag if does not exist
2629                 if (!$tagid = tag_get_id($tag)) {
2630                     $tag_id_array = tag_add(array($tag), $tagtype);
2631                     $tagid = $tag_id_array[core_text::strtolower($tag)];
2632                 }
2633                 //ordering
2634                 $ordering = 0;
2635                 if ($current_ids = tag_get_tags_ids('course', $courseid)) {
2636                     end($current_ids);
2637                     $ordering = key($current_ids) + 1;
2638                 }
2639                 //set type
2640                 tag_type_set($tagid, $tagtype);
2641
2642                 //tag_instance entry
2643                 tag_assign('course', $courseid, $tagid, $ordering, $userid, 'core', context_course::instance($courseid)->id);
2644             }
2645         }
2646     }
2647
2648 }
2649
2650 /**
2651  * Deletes a personal tag for a user for a course.
2652  *
2653  * @deprecated since 3.0
2654  * @package  core_tag
2655  * @category tag
2656  * @param    int      $tagid    the tag we wish to delete
2657  * @param    int      $userid   the user that the tag is associated with
2658  * @param    int      $courseid the course that the tag is associated with
2659  */
2660 function coursetag_delete_keyword($tagid, $userid, $courseid) {
2661     debugging('Function coursetag_delete_keyword() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2662
2663     tag_delete_instance('course', $courseid, $tagid, $userid);
2664 }
2665
2666 /**
2667  * Get courses tagged with a tag
2668  *
2669  * @deprecated since 3.0
2670  * @package  core_tag
2671  * @category tag
2672  * @param int $tagid
2673  * @return array of course objects
2674  */
2675 function coursetag_get_tagged_courses($tagid) {
2676     debugging('Function coursetag_get_tagged_courses() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2677
2678     global $DB;
2679
2680     $courses = array();
2681
2682     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2683
2684     $sql = "SELECT c.*, $ctxselect
2685             FROM {course} c
2686             JOIN {tag_instance} t ON t.itemid = c.id
2687             JOIN {context} ctx ON ctx.instanceid = c.id
2688             WHERE t.tagid = :tagid AND
2689             t.itemtype = 'course' AND
2690             ctx.contextlevel = :contextlevel
2691             ORDER BY c.sortorder ASC";
2692     $params = array('tagid' => $tagid, 'contextlevel' => CONTEXT_COURSE);
2693     $rs = $DB->get_recordset_sql($sql, $params);
2694     foreach ($rs as $course) {
2695         context_helper::preload_from_record($course);
2696         if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2697             $courses[$course->id] = $course;
2698         }
2699     }
2700     return $courses;
2701 }
2702
2703 /**
2704  * Course tagging function used only during the deletion of a course (called by lib/moodlelib.php) to clean up associated tags
2705  *
2706  * @package core_tag
2707  * @deprecated since 3.0
2708  * @param   int      $courseid     the course we wish to delete tag instances from
2709  * @param   bool     $showfeedback if we should output a notification of the delete to the end user
2710  */
2711 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
2712     debugging('Function coursetag_delete_course_tags() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2713
2714     global $DB, $OUTPUT;
2715
2716     if ($taginstances = $DB->get_recordset_select('tag_instance', "itemtype = 'course' AND itemid = :courseid",
2717         array('courseid' => $courseid), '', 'tagid, tiuserid')) {
2718
2719         foreach ($taginstances as $record) {
2720             tag_delete_instance('course', $courseid, $record->tagid, $record->tiuserid);
2721         }
2722         $taginstances->close();
2723     }
2724
2725     if ($showfeedback) {
2726         echo $OUTPUT->notification(get_string('deletedcoursetags', 'tag'), 'notifysuccess');
2727     }
2728 }
2729
2730 /**
2731  * Function that returns tags that start with some text, for use by the autocomplete feature
2732  *
2733  * @package core_tag
2734  * @deprecated since 3.0
2735  * @access  private
2736  * @param   string   $text string that the tag names will be matched against
2737  * @return  mixed    an array of objects, or false if no records were found or an error occured.
2738  */
2739 function tag_autocomplete($text) {
2740     debugging('Function tag_autocomplete() is deprecated without replacement. ' .
2741             'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
2742     global $DB;
2743     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
2744                                    FROM {tag} tg
2745                                   WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
2746 }