lib/outputrenderers.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Classes for rendering HTML output for Moodle.
  19  *
  20  * Please see {@link http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML}
  21  * for an overview.
  22  *
  23  * Included in this file are the primary renderer classes:
  24  *     - renderer_base:         The renderer outline class that all renderers
  25  *                              should inherit from.
  26  *     - core_renderer:         The standard HTML renderer.
  27  *     - core_renderer_cli:     An adaption of the standard renderer for CLI scripts.
  28  *     - core_renderer_ajax:    An adaption of the standard renderer for AJAX scripts.
  29  *     - plugin_renderer_base:  A renderer class that should be extended by all
  30  *                              plugin renderers.
  31  *
  32  * @package core
  33  * @category output
  34  * @copyright  2009 Tim Hunt
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37
  38 defined('MOODLE_INTERNAL') || die();
  39
  40 /**
  41  * Simple base class for Moodle renderers.
  42  *
  43  * Tracks the xhtml_container_stack to use, which is passed in in the constructor.
  44  *
  45  * Also has methods to facilitate generating HTML output.
  46  *
  47  * @copyright 2009 Tim Hunt
  48  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  49  * @since Moodle 2.0
  50  * @package core
  51  * @category output
  52  */
  53 class renderer_base {
  54     /**
  55      * @var xhtml_container_stack The xhtml_container_stack to use.
  56      */
  57     protected $opencontainers;
  58
  59     /**
  60      * @var moodle_page The Moodle page the renderer has been created to assist with.
  61      */
  62     protected $page;
  63
  64     /**
  65      * @var string The requested rendering target.
  66      */
  67     protected $target;
  68
  69     /**
  70      * Constructor
  71      *
  72      * The constructor takes two arguments. The first is the page that the renderer
  73      * has been created to assist with, and the second is the target.
  74      * The target is an additional identifier that can be used to load different
  75      * renderers for different options.
  76      *
  77      * @param moodle_page $page the page we are doing output for.
  78      * @param string $target one of rendering target constants
  79      */
  80     public function __construct(moodle_page $page, $target) {
  81         $this->opencontainers = $page->opencontainers;
  82         $this->page = $page;
  83         $this->target = $target;
  84     }
  85
  86     /**
  87      * Returns rendered widget.
  88      *
  89      * The provided widget needs to be an object that extends the renderable
  90      * interface.
  91      * If will then be rendered by a method based upon the classname for the widget.
  92      * For instance a widget of class `crazywidget` will be rendered by a protected
  93      * render_crazywidget method of this renderer.
  94      *
  95      * @param renderable $widget instance with renderable interface
  96      * @return string
  97      */
  98     public function render(renderable $widget) {
  99         $rendermethod = 'render_'.get_class($widget);
 100         if (method_exists($this, $rendermethod)) {
 101             return $this->$rendermethod($widget);
 102         }
 103         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
 104     }
 105
 106     /**
 107      * Adds a JS action for the element with the provided id.
 108      *
 109      * This method adds a JS event for the provided component action to the page
 110      * and then returns the id that the event has been attached to.
 111      * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
 112      *
 113      * @param component_action $action
 114      * @param string $id
 115      * @return string id of element, either original submitted or random new if not supplied
 116      */
 117     public function add_action_handler(component_action $action, $id = null) {
 118         if (!$id) {
 119             $id = html_writer::random_id($action->event);
 120         }
 121         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
 122         return $id;
 123     }
 124
 125     /**
 126      * Returns true is output has already started, and false if not.
 127      *
 128      * @return boolean true if the header has been printed.
 129      */
 130     public function has_started() {
 131         return $this->page->state >= moodle_page::STATE_IN_BODY;
 132     }
 133
 134     /**
 135      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
 136      *
 137      * @param mixed $classes Space-separated string or array of classes
 138      * @return string HTML class attribute value
 139      */
 140     public static function prepare_classes($classes) {
 141         if (is_array($classes)) {
 142             return implode(' ', array_unique($classes));
 143         }
 144         return $classes;
 145     }
 146
 147     /**
 148      * Return the moodle_url for an image.
 149      *
 150      * The exact image location and extension is determined
 151      * automatically by searching for gif|png|jpg|jpeg, please
 152      * note there can not be diferent images with the different
 153      * extension. The imagename is for historical reasons
 154      * a relative path name, it may be changed later for core
 155      * images. It is recommended to not use subdirectories
 156      * in plugin and theme pix directories.
 157      *
 158      * There are three types of images:
 159      * 1/ theme images  - stored in theme/mytheme/pix/,
 160      *                    use component 'theme'
 161      * 2/ core images   - stored in /pix/,
 162      *                    overridden via theme/mytheme/pix_core/
 163      * 3/ plugin images - stored in mod/mymodule/pix,
 164      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
 165      *                    example: pix_url('comment', 'mod_glossary')
 166      *
 167      * @param string $imagename the pathname of the image
 168      * @param string $component full plugin name (aka component) or 'theme'
 169      * @return moodle_url
 170      */
 171     public function pix_url($imagename, $component = 'moodle') {
 172         return $this->page->theme->pix_url($imagename, $component);
 173     }
 174 }
 175
 176
 177 /**
 178  * Basis for all plugin renderers.
 179  *
 180  * @copyright Petr Skoda (skodak)
 181  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 182  * @since Moodle 2.0
 183  * @package core
 184  * @category output
 185  */
 186 class plugin_renderer_base extends renderer_base {
 187
 188     /**
 189      * @var renderer_base|core_renderer A reference to the current renderer.
 190      * The renderer provided here will be determined by the page but will in 90%
 191      * of cases by the {@link core_renderer}
 192      */
 193     protected $output;
 194
 195     /**
 196      * Constructor method, calls the parent constructor
 197      *
 198      * @param moodle_page $page
 199      * @param string $target one of rendering target constants
 200      */
 201     public function __construct(moodle_page $page, $target) {
 202         $this->output = $page->get_renderer('core', null, $target);
 203         parent::__construct($page, $target);
 204     }
 205
 206     /**
 207      * Renders the provided widget and returns the HTML to display it.
 208      *
 209      * @param renderable $widget instance with renderable interface
 210      * @return string
 211      */
 212     public function render(renderable $widget) {
 213         $rendermethod = 'render_'.get_class($widget);
 214         if (method_exists($this, $rendermethod)) {
 215             return $this->$rendermethod($widget);
 216         }
 217         // pass to core renderer if method not found here
 218         return $this->output->render($widget);
 219     }
 220
 221     /**
 222      * Magic method used to pass calls otherwise meant for the standard renderer
 223      * to it to ensure we don't go causing unnecessary grief.
 224      *
 225      * @param string $method
 226      * @param array $arguments
 227      * @return mixed
 228      */
 229     public function __call($method, $arguments) {
 230         if (method_exists('renderer_base', $method)) {
 231             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
 232         }
 233         if (method_exists($this->output, $method)) {
 234             return call_user_func_array(array($this->output, $method), $arguments);
 235         } else {
 236             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
 237         }
 238     }
 239 }
 240
 241
 242 /**
 243  * The standard implementation of the core_renderer interface.
 244  *
 245  * @copyright 2009 Tim Hunt
 246  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 247  * @since Moodle 2.0
 248  * @package core
 249  * @category output
 250  */
 251 class core_renderer extends renderer_base {
 252     /**
 253      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
 254      * in layout files instead.
 255      * @deprecated
 256      * @var string used in {@link core_renderer::header()}.
 257      */
 258     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
 259
 260     /**
 261      * @var string Used to pass information from {@link core_renderer::doctype()} to
 262      * {@link core_renderer::standard_head_html()}.
 263      */
 264     protected $contenttype;
 265
 266     /**
 267      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
 268      * with {@link core_renderer::header()}.
 269      */
 270     protected $metarefreshtag = '';
 271
 272     /**
 273      * @var string Unique token for the closing HTML
 274      */
 275     protected $unique_end_html_token;
 276
 277     /**
 278      * @var string Unique token for performance information
 279      */
 280     protected $unique_performance_info_token;
 281
 282     /**
 283      * @var string Unique token for the main content.
 284      */
 285     protected $unique_main_content_token;
 286
 287     /**
 288      * Constructor
 289      *
 290      * @param moodle_page $page the page we are doing output for.
 291      * @param string $target one of rendering target constants
 292      */
 293     public function __construct(moodle_page $page, $target) {
 294         $this->opencontainers = $page->opencontainers;
 295         $this->page = $page;
 296         $this->target = $target;
 297
 298         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
 299         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
 300         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
 301     }
 302
 303     /**
 304      * Get the DOCTYPE declaration that should be used with this page. Designed to
 305      * be called in theme layout.php files.
 306      *
 307      * @return string the DOCTYPE declaration (and any XML prologue) that should be used.
 308      */
 309     public function doctype() {
 310         global $CFG;
 311
 312         $doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
 313         $this->contenttype = 'text/html; charset=utf-8';
 314
 315         if (empty($CFG->xmlstrictheaders)) {
 316             return $doctype;
 317         }
 318
 319         // We want to serve the page with an XML content type, to force well-formedness errors to be reported.
 320         $prolog = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
 321         if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') !== false) {
 322             // Firefox and other browsers that can cope natively with XHTML.
 323             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
 324
 325         } else if (preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
 326             // IE can't cope with application/xhtml+xml, but it will cope if we send application/xml with an XSL stylesheet.
 327             $this->contenttype = 'application/xml; charset=utf-8';
 328             $prolog .= '<?xml-stylesheet type="text/xsl" href="' . $CFG->httpswwwroot . '/lib/xhtml.xsl"?>' . "\n";
 329
 330         } else {
 331             $prolog = '';
 332         }
 333
 334         return $prolog . $doctype;
 335     }
 336
 337     /**
 338      * The attributes that should be added to the <html> tag. Designed to
 339      * be called in theme layout.php files.
 340      *
 341      * @return string HTML fragment.
 342      */
 343     public function htmlattributes() {
 344         return get_html_lang(true) . ' xmlns="http://www.w3.org/1999/xhtml"';
 345     }
 346
 347     /**
 348      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
 349      * that should be included in the <head> tag. Designed to be called in theme
 350      * layout.php files.
 351      *
 352      * @return string HTML fragment.
 353      */
 354     public function standard_head_html() {
 355         global $CFG, $SESSION;
 356         $output = '';
 357         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
 358         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
 359         if (!$this->page->cacheable) {
 360             $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
 361             $output .= '<meta http-equiv="expires" content="0" />' . "\n";
 362         }
 363         // This is only set by the {@link redirect()} method
 364         $output .= $this->metarefreshtag;
 365
 366         // Check if a periodic refresh delay has been set and make sure we arn't
 367         // already meta refreshing
 368         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
 369             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
 370         }
 371
 372         // flow player embedding support
 373         $this->page->requires->js_function_call('M.util.load_flowplayer');
 374
 375         // Set up help link popups for all links with the helplinkpopup class
 376         $this->page->requires->js_init_call('M.util.help_popups.setup');
 377
 378         $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
 379
 380         $focus = $this->page->focuscontrol;
 381         if (!empty($focus)) {
 382             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
 383                 // This is a horrifically bad way to handle focus but it is passed in
 384                 // through messy formslib::moodleform
 385                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
 386             } else if (strpos($focus, '.')!==false) {
 387                 // Old style of focus, bad way to do it
 388                 debugging('This code is using the old style focus event, Please update this code to focus on an element id or the moodleform focus method.', DEBUG_DEVELOPER);
 389                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
 390             } else {
 391                 // Focus element with given id
 392                 $this->page->requires->js_function_call('focuscontrol', array($focus));
 393             }
 394         }
 395
 396         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
 397         // any other custom CSS can not be overridden via themes and is highly discouraged
 398         $urls = $this->page->theme->css_urls($this->page);
 399         foreach ($urls as $url) {
 400             $this->page->requires->css_theme($url);
 401         }
 402
 403         // Get the theme javascript head and footer
 404         $jsurl = $this->page->theme->javascript_url(true);
 405         $this->page->requires->js($jsurl, true);
 406         $jsurl = $this->page->theme->javascript_url(false);
 407         $this->page->requires->js($jsurl);
 408
 409         // Get any HTML from the page_requirements_manager.
 410         $output .= $this->page->requires->get_head_code($this->page, $this);
 411
 412         // List alternate versions.
 413         foreach ($this->page->alternateversions as $type => $alt) {
 414             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
 415                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
 416         }
 417
 418         if (!empty($CFG->additionalhtmlhead)) {
 419             $output .= "\n".$CFG->additionalhtmlhead;
 420         }
 421
 422         return $output;
 423     }
 424
 425     /**
 426      * The standard tags (typically skip links) that should be output just inside
 427      * the start of the <body> tag. Designed to be called in theme layout.php files.
 428      *
 429      * @return string HTML fragment.
 430      */
 431     public function standard_top_of_body_html() {
 432         global $CFG;
 433         $output = $this->page->requires->get_top_of_body_code();
 434         if (!empty($CFG->additionalhtmltopofbody)) {
 435             $output .= "\n".$CFG->additionalhtmltopofbody;
 436         }
 437         return $output;
 438     }
 439
 440     /**
 441      * The standard tags (typically performance information and validation links,
 442      * if we are in developer debug mode) that should be output in the footer area
 443      * of the page. Designed to be called in theme layout.php files.
 444      *
 445      * @return string HTML fragment.
 446      */
 447     public function standard_footer_html() {
 448         global $CFG, $SCRIPT;
 449
 450         // This function is normally called from a layout.php file in {@link core_renderer::header()}
 451         // but some of the content won't be known until later, so we return a placeholder
 452         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
 453         $output = $this->unique_performance_info_token;
 454         if ($this->page->devicetypeinuse == 'legacy') {
 455             // The legacy theme is in use print the notification
 456             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
 457         }
 458
 459         // Get links to switch device types (only shown for users not on a default device)
 460         $output .= $this->theme_switch_links();
 461
 462         if (!empty($CFG->debugpageinfo)) {
 463             $output .= '<div class="performanceinfo pageinfo">This page is: ' . $this->page->debug_summary() . '</div>';
 464         }
 465         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {  // Only in developer mode
 466             // Add link to profiling report if necessary
 467             if (function_exists('profiling_is_running') && profiling_is_running()) {
 468                 $txt = get_string('profiledscript', 'admin');
 469                 $title = get_string('profiledscriptview', 'admin');
 470                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
 471                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
 472                 $output .= '<div class="profilingfooter">' . $link . '</div>';
 473             }
 474             $output .= '<div class="purgecaches"><a href="'.$CFG->wwwroot.'/'.$CFG->admin.'/purgecaches.php?confirm=1&amp;sesskey='.sesskey().'">'.get_string('purgecaches', 'admin').'</a></div>';
 475         }
 476         if (!empty($CFG->debugvalidators)) {
 477             // NOTE: this is not a nice hack, $PAGE->url is not always accurate and $FULLME neither, it is not a bug if it fails. --skodak
 478             $output .= '<div class="validators"><ul>
 479               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
 480               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
 481               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=0&amp;warnp2n3e=1&amp;url1=' . urlencode(qualified_me()) . '">WCAG 1 (2,3) Check</a></li>
 482             </ul></div>';
 483         }
 484         if (!empty($CFG->additionalhtmlfooter)) {
 485             $output .= "\n".$CFG->additionalhtmlfooter;
 486         }
 487         return $output;
 488     }
 489
 490     /**
 491      * Returns standard main content placeholder.
 492      * Designed to be called in theme layout.php files.
 493      *
 494      * @return string HTML fragment.
 495      */
 496     public function main_content() {
 497         return $this->unique_main_content_token;
 498     }
 499
 500     /**
 501      * The standard tags (typically script tags that are not needed earlier) that
 502      * should be output after everything else, . Designed to be called in theme layout.php files.
 503      *
 504      * @return string HTML fragment.
 505      */
 506     public function standard_end_of_body_html() {
 507         // This function is normally called from a layout.php file in {@link core_renderer::header()}
 508         // but some of the content won't be known until later, so we return a placeholder
 509         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
 510         return $this->unique_end_html_token;
 511     }
 512
 513     /**
 514      * Return the standard string that says whether you are logged in (and switched
 515      * roles/logged in as another user).
 516      *
 517      * @return string HTML fragment.
 518      */
 519     public function login_info() {
 520         global $USER, $CFG, $DB, $SESSION;
 521
 522         if (during_initial_install()) {
 523             return '';
 524         }
 525
 526         $loginpage = ((string)$this->page->url === get_login_url());
 527         $course = $this->page->course;
 528
 529         if (session_is_loggedinas()) {
 530             $realuser = session_get_realuser();
 531             $fullname = fullname($realuser, true);
 532             $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\">$fullname</a>] ";
 533         } else {
 534             $realuserinfo = '';
 535         }
 536
 537         $loginurl = get_login_url();
 538
 539         if (empty($course->id)) {
 540             // $course->id is not defined during installation
 541             return '';
 542         } else if (isloggedin()) {
 543             $context = get_context_instance(CONTEXT_COURSE, $course->id);
 544
 545             $fullname = fullname($USER, true);
 546             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
 547             $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\">$fullname</a>";
 548             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
 549                 $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
 550             }
 551             if (isguestuser()) {
 552                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
 553                 if (!$loginpage) {
 554                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
 555                 }
 556             } else if (is_role_switched($course->id)) { // Has switched roles
 557                 $rolename = '';
 558                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
 559                     $rolename = ': '.format_string($role->name);
 560                 }
 561                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
 562                           " (<a href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
 563             } else {
 564                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
 565                           " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
 566             }
 567         } else {
 568             $loggedinas = get_string('loggedinnot', 'moodle');
 569             if (!$loginpage) {
 570                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
 571             }
 572         }
 573
 574         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
 575
 576         if (isset($SESSION->justloggedin)) {
 577             unset($SESSION->justloggedin);
 578             if (!empty($CFG->displayloginfailures)) {
 579                 if (!isguestuser()) {
 580                     if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
 581                         $loggedinas .= '&nbsp;<div class="loginfailures">';
 582                         if (empty($count->accounts)) {
 583                             $loggedinas .= get_string('failedloginattempts', '', $count);
 584                         } else {
 585                             $loggedinas .= get_string('failedloginattemptsall', '', $count);
 586                         }
 587                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', get_context_instance(CONTEXT_SYSTEM))) {
 588                             $loggedinas .= ' (<a href="'.$CFG->wwwroot.'/report/log/index.php'.
 589                                                  '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
 590                         }
 591                         $loggedinas .= '</div>';
 592                     }
 593                 }
 594             }
 595         }
 596
 597         return $loggedinas;
 598     }
 599
 600     /**
 601      * Return the 'back' link that normally appears in the footer.
 602      *
 603      * @return string HTML fragment.
 604      */
 605     public function home_link() {
 606         global $CFG, $SITE;
 607
 608         if ($this->page->pagetype == 'site-index') {
 609             // Special case for site home page - please do not remove
 610             return '<div class="sitelink">' .
 611                    '<a title="Moodle" href="http://moodle.org/">' .
 612                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
 613
 614         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
 615             // Special case for during install/upgrade.
 616             return '<div class="sitelink">'.
 617                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
 618                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
 619
 620         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
 621             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
 622                     get_string('home') . '</a></div>';
 623
 624         } else {
 625             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
 626                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
 627         }
 628     }
 629
 630     /**
 631      * Redirects the user by any means possible given the current state
 632      *
 633      * This function should not be called directly, it should always be called using
 634      * the redirect function in lib/weblib.php
 635      *
 636      * The redirect function should really only be called before page output has started
 637      * however it will allow itself to be called during the state STATE_IN_BODY
 638      *
 639      * @param string $encodedurl The URL to send to encoded if required
 640      * @param string $message The message to display to the user if any
 641      * @param int $delay The delay before redirecting a user, if $message has been
 642      *         set this is a requirement and defaults to 3, set to 0 no delay
 643      * @param boolean $debugdisableredirect this redirect has been disabled for
 644      *         debugging purposes. Display a message that explains, and don't
 645      *         trigger the redirect.
 646      * @return string The HTML to display to the user before dying, may contain
 647      *         meta refresh, javascript refresh, and may have set header redirects
 648      */
 649     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
 650         global $CFG;
 651         $url = str_replace('&amp;', '&', $encodedurl);
 652
 653         switch ($this->page->state) {
 654             case moodle_page::STATE_BEFORE_HEADER :
 655                 // No output yet it is safe to delivery the full arsenal of redirect methods
 656                 if (!$debugdisableredirect) {
 657                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
 658                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
 659                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
 660                 }
 661                 $output = $this->header();
 662                 break;
 663             case moodle_page::STATE_PRINTING_HEADER :
 664                 // We should hopefully never get here
 665                 throw new coding_exception('You cannot redirect while printing the page header');
 666                 break;
 667             case moodle_page::STATE_IN_BODY :
 668                 // We really shouldn't be here but we can deal with this
 669                 debugging("You should really redirect before you start page output");
 670                 if (!$debugdisableredirect) {
 671                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
 672                 }
 673                 $output = $this->opencontainers->pop_all_but_last();
 674                 break;
 675             case moodle_page::STATE_DONE :
 676                 // Too late to be calling redirect now
 677                 throw new coding_exception('You cannot redirect after the entire page has been generated');
 678                 break;
 679         }
 680         $output .= $this->notification($message, 'redirectmessage');
 681         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
 682         if ($debugdisableredirect) {
 683             $output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
 684         }
 685         $output .= $this->footer();
 686         return $output;
 687     }
 688
 689     /**
 690      * Start output by sending the HTTP headers, and printing the HTML <head>
 691      * and the start of the <body>.
 692      *
 693      * To control what is printed, you should set properties on $PAGE. If you
 694      * are familiar with the old {@link print_header()} function from Moodle 1.9
 695      * you will find that there are properties on $PAGE that correspond to most
 696      * of the old parameters to could be passed to print_header.
 697      *
 698      * Not that, in due course, the remaining $navigation, $menu parameters here
 699      * will be replaced by more properties of $PAGE, but that is still to do.
 700      *
 701      * @return string HTML that you must output this, preferably immediately.
 702      */
 703     public function header() {
 704         global $USER, $CFG;
 705
 706         if (session_is_loggedinas()) {
 707             $this->page->add_body_class('userloggedinas');
 708         }
 709
 710         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
 711
 712         // Find the appropriate page layout file, based on $this->page->pagelayout.
 713         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
 714         // Render the layout using the layout file.
 715         $rendered = $this->render_page_layout($layoutfile);
 716
 717         // Slice the rendered output into header and footer.
 718         $cutpos = strpos($rendered, $this->unique_main_content_token);
 719         if ($cutpos === false) {
 720             $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
 721             $token = self::MAIN_CONTENT_TOKEN;
 722         } else {
 723             $token = $this->unique_main_content_token;
 724         }
 725
 726         if ($cutpos === false) {
 727             throw new coding_exception('page layout file ' . $layoutfile . ' does not contain the main content placeholder, please include "<?php echo $OUTPUT->main_content() ?>" in theme layout file.');
 728         }
 729         $header = substr($rendered, 0, $cutpos);
 730         $footer = substr($rendered, $cutpos + strlen($token));
 731
 732         if (empty($this->contenttype)) {
 733             debugging('The page layout file did not call $OUTPUT->doctype()');
 734             $header = $this->doctype() . $header;
 735         }
 736
 737         send_headers($this->contenttype, $this->page->cacheable);
 738
 739         $this->opencontainers->push('header/footer', $footer);
 740         $this->page->set_state(moodle_page::STATE_IN_BODY);
 741
 742         return $header . $this->skip_link_target('maincontent');
 743     }
 744
 745     /**
 746      * Renders and outputs the page layout file.
 747      *
 748      * This is done by preparing the normal globals available to a script, and
 749      * then including the layout file provided by the current theme for the
 750      * requested layout.
 751      *
 752      * @param string $layoutfile The name of the layout file
 753      * @return string HTML code
 754      */
 755     protected function render_page_layout($layoutfile) {
 756         global $CFG, $SITE, $USER;
 757         // The next lines are a bit tricky. The point is, here we are in a method
 758         // of a renderer class, and this object may, or may not, be the same as
 759         // the global $OUTPUT object. When rendering the page layout file, we want to use
 760         // this object. However, people writing Moodle code expect the current
 761         // renderer to be called $OUTPUT, not $this, so define a variable called
 762         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
 763         $OUTPUT = $this;
 764         $PAGE = $this->page;
 765         $COURSE = $this->page->course;
 766
 767         ob_start();
 768         include($layoutfile);
 769         $rendered = ob_get_contents();
 770         ob_end_clean();
 771         return $rendered;
 772     }
 773
 774     /**
 775      * Outputs the page's footer
 776      *
 777      * @return string HTML fragment
 778      */
 779     public function footer() {
 780         global $CFG, $DB;
 781
 782         $output = $this->container_end_all(true);
 783
 784         $footer = $this->opencontainers->pop('header/footer');
 785
 786         if (debugging() and $DB and $DB->is_transaction_started()) {
 787             // TODO: MDL-20625 print warning - transaction will be rolled back
 788         }
 789
 790         // Provide some performance info if required
 791         $performanceinfo = '';
 792         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
 793             $perf = get_performance_info();
 794             if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
 795                 error_log("PERF: " . $perf['txt']);
 796             }
 797             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
 798                 $performanceinfo = $perf['html'];
 799             }
 800         }
 801         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
 802
 803         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
 804
 805         $this->page->set_state(moodle_page::STATE_DONE);
 806
 807         return $output . $footer;
 808     }
 809
 810     /**
 811      * Close all but the last open container. This is useful in places like error
 812      * handling, where you want to close all the open containers (apart from <body>)
 813      * before outputting the error message.
 814      *
 815      * @param bool $shouldbenone assert that the stack should be empty now - causes a
 816      *      developer debug warning if it isn't.
 817      * @return string the HTML required to close any open containers inside <body>.
 818      */
 819     public function container_end_all($shouldbenone = false) {
 820         return $this->opencontainers->pop_all_but_last($shouldbenone);
 821     }
 822
 823     /**
 824      * Returns lang menu or '', this method also checks forcing of languages in courses.
 825      *
 826      * @return string The lang menu HTML or empty string
 827      */
 828     public function lang_menu() {
 829         global $CFG;
 830
 831         if (empty($CFG->langmenu)) {
 832             return '';
 833         }
 834
 835         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
 836             // do not show lang menu if language forced
 837             return '';
 838         }
 839
 840         $currlang = current_language();
 841         $langs = get_string_manager()->get_list_of_translations();
 842
 843         if (count($langs) < 2) {
 844             return '';
 845         }
 846
 847         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
 848         $s->label = get_accesshide(get_string('language'));
 849         $s->class = 'langmenu';
 850         return $this->render($s);
 851     }
 852
 853     /**
 854      * Output the row of editing icons for a block, as defined by the controls array.
 855      *
 856      * @param array $controls an array like {@link block_contents::$controls}.
 857      * @return string HTML fragment.
 858      */
 859     public function block_controls($controls) {
 860         if (empty($controls)) {
 861             return '';
 862         }
 863         $controlshtml = array();
 864         foreach ($controls as $control) {
 865             $controlshtml[] = html_writer::tag('a',
 866                     html_writer::empty_tag('img',  array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
 867                     array('class' => 'icon ' . $control['class'],'title' => $control['caption'], 'href' => $control['url']));
 868         }
 869         return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
 870     }
 871
 872     /**
 873      * Prints a nice side block with an optional header.
 874      *
 875      * The content is described
 876      * by a {@link core_renderer::block_contents} object.
 877      *
 878      * <div id="inst{$instanceid}" class="block_{$blockname} block">
 879      *      <div class="header"></div>
 880      *      <div class="content">
 881      *          ...CONTENT...
 882      *          <div class="footer">
 883      *          </div>
 884      *      </div>
 885      *      <div class="annotation">
 886      *      </div>
 887      * </div>
 888      *
 889      * @param block_contents $bc HTML for the content
 890      * @param string $region the region the block is appearing in.
 891      * @return string the HTML to be output.
 892      */
 893     public function block(block_contents $bc, $region) {
 894         $bc = clone($bc); // Avoid messing up the object passed in.
 895         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
 896             $bc->collapsible = block_contents::NOT_HIDEABLE;
 897         }
 898         if ($bc->collapsible == block_contents::HIDDEN) {
 899             $bc->add_class('hidden');
 900         }
 901         if (!empty($bc->controls)) {
 902             $bc->add_class('block_with_controls');
 903         }
 904
 905         $skiptitle = strip_tags($bc->title);
 906         if (empty($skiptitle)) {
 907             $output = '';
 908             $skipdest = '';
 909         } else {
 910             $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
 911             $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
 912         }
 913
 914         $output .= html_writer::start_tag('div', $bc->attributes);
 915
 916         $output .= $this->block_header($bc);
 917         $output .= $this->block_content($bc);
 918
 919         $output .= html_writer::end_tag('div');
 920
 921         $output .= $this->block_annotation($bc);
 922
 923         $output .= $skipdest;
 924
 925         $this->init_block_hider_js($bc);
 926         return $output;
 927     }
 928
 929     /**
 930      * Produces a header for a block
 931      *
 932      * @param block_contents $bc
 933      * @return string
 934      */
 935     protected function block_header(block_contents $bc) {
 936
 937         $title = '';
 938         if ($bc->title) {
 939             $title = html_writer::tag('h2', $bc->title, null);
 940         }
 941
 942         $controlshtml = $this->block_controls($bc->controls);
 943
 944         $output = '';
 945         if ($title || $controlshtml) {
 946             $output .= html_writer::tag('div', html_writer::tag('div', html_writer::tag('div', '', array('class'=>'block_action')). $title . $controlshtml, array('class' => 'title')), array('class' => 'header'));
 947         }
 948         return $output;
 949     }
 950
 951     /**
 952      * Produces the content area for a block
 953      *
 954      * @param block_contents $bc
 955      * @return string
 956      */
 957     protected function block_content(block_contents $bc) {
 958         $output = html_writer::start_tag('div', array('class' => 'content'));
 959         if (!$bc->title && !$this->block_controls($bc->controls)) {
 960             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
 961         }
 962         $output .= $bc->content;
 963         $output .= $this->block_footer($bc);
 964         $output .= html_writer::end_tag('div');
 965
 966         return $output;
 967     }
 968
 969     /**
 970      * Produces the footer for a block
 971      *
 972      * @param block_contents $bc
 973      * @return string
 974      */
 975     protected function block_footer(block_contents $bc) {
 976         $output = '';
 977         if ($bc->footer) {
 978             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
 979         }
 980         return $output;
 981     }
 982
 983     /**
 984      * Produces the annotation for a block
 985      *
 986      * @param block_contents $bc
 987      * @return string
 988      */
 989     protected function block_annotation(block_contents $bc) {
 990         $output = '';
 991         if ($bc->annotation) {
 992             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
 993         }
 994         return $output;
 995     }
 996
 997     /**
 998      * Calls the JS require function to hide a block.
 999      *
1000      * @param block_contents $bc A block_contents object
1001      */
1002     protected function init_block_hider_js(block_contents $bc) {
1003         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
1004             $config = new stdClass;
1005             $config->id = $bc->attributes['id'];
1006             $config->title = strip_tags($bc->title);
1007             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1008             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1009             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1010
1011             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1012             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1013         }
1014     }
1015
1016     /**
1017      * Render the contents of a block_list.
1018      *
1019      * @param array $icons the icon for each item.
1020      * @param array $items the content of each item.
1021      * @return string HTML
1022      */
1023     public function list_block_contents($icons, $items) {
1024         $row = 0;
1025         $lis = array();
1026         foreach ($items as $key => $string) {
1027             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1028             if (!empty($icons[$key])) { //test if the content has an assigned icon
1029                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1030             }
1031             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1032             $item .= html_writer::end_tag('li');
1033             $lis[] = $item;
1034             $row = 1 - $row; // Flip even/odd.
1035         }
1036         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1037     }
1038
1039     /**
1040      * Output all the blocks in a particular region.
1041      *
1042      * @param string $region the name of a region on this page.
1043      * @return string the HTML to be output.
1044      */
1045     public function blocks_for_region($region) {
1046         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1047
1048         $output = '';
1049         foreach ($blockcontents as $bc) {
1050             if ($bc instanceof block_contents) {
1051                 $output .= $this->block($bc, $region);
1052             } else if ($bc instanceof block_move_target) {
1053                 $output .= $this->block_move_target($bc);
1054             } else {
1055                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1056             }
1057         }
1058         return $output;
1059     }
1060
1061     /**
1062      * Output a place where the block that is currently being moved can be dropped.
1063      *
1064      * @param block_move_target $target with the necessary details.
1065      * @return string the HTML to be output.
1066      */
1067     public function block_move_target($target) {
1068         return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1069     }
1070
1071     /**
1072      * Renders a special html link with attached action
1073      *
1074      * @param string|moodle_url $url
1075      * @param string $text HTML fragment
1076      * @param component_action $action
1077      * @param array $attributes associative array of html link attributes + disabled
1078      * @return string HTML fragment
1079      */
1080     public function action_link($url, $text, component_action $action = null, array $attributes=null) {
1081         if (!($url instanceof moodle_url)) {
1082             $url = new moodle_url($url);
1083         }
1084         $link = new action_link($url, $text, $action, $attributes);
1085
1086         return $this->render($link);
1087     }
1088
1089     /**
1090      * Renders an action_link object.
1091      *
1092      * The provided link is renderer and the HTML returned. At the same time the
1093      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1094      *
1095      * @param action_link $link
1096      * @return string HTML fragment
1097      */
1098     protected function render_action_link(action_link $link) {
1099         global $CFG;
1100
1101         if ($link->text instanceof renderable) {
1102             $text = $this->render($link->text);
1103         } else {
1104             $text = $link->text;
1105         }
1106
1107         // A disabled link is rendered as formatted text
1108         if (!empty($link->attributes['disabled'])) {
1109             // do not use div here due to nesting restriction in xhtml strict
1110             return html_writer::tag('span', $text, array('class'=>'currentlink'));
1111         }
1112
1113         $attributes = $link->attributes;
1114         unset($link->attributes['disabled']);
1115         $attributes['href'] = $link->url;
1116
1117         if ($link->actions) {
1118             if (empty($attributes['id'])) {
1119                 $id = html_writer::random_id('action_link');
1120                 $attributes['id'] = $id;
1121             } else {
1122                 $id = $attributes['id'];
1123             }
1124             foreach ($link->actions as $action) {
1125                 $this->add_action_handler($action, $id);
1126             }
1127         }
1128
1129         return html_writer::tag('a', $text, $attributes);
1130     }
1131
1132
1133     /**
1134      * Renders an action_icon.
1135      *
1136      * This function uses the {@link core_renderer::action_link()} method for the
1137      * most part. What it does different is prepare the icon as HTML and use it
1138      * as the link text.
1139      *
1140      * @param string|moodle_url $url A string URL or moodel_url
1141      * @param pix_icon $pixicon
1142      * @param component_action $action
1143      * @param array $attributes associative array of html link attributes + disabled
1144      * @param bool $linktext show title next to image in link
1145      * @return string HTML fragment
1146      */
1147     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1148         if (!($url instanceof moodle_url)) {
1149             $url = new moodle_url($url);
1150         }
1151         $attributes = (array)$attributes;
1152
1153         if (empty($attributes['class'])) {
1154             // let ppl override the class via $options
1155             $attributes['class'] = 'action-icon';
1156         }
1157
1158         $icon = $this->render($pixicon);
1159
1160         if ($linktext) {
1161             $text = $pixicon->attributes['alt'];
1162         } else {
1163             $text = '';
1164         }
1165
1166         return $this->action_link($url, $text.$icon, $action, $attributes);
1167     }
1168
1169    /**
1170     * Print a message along with button choices for Continue/Cancel
1171     *
1172     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1173     *
1174     * @param string $message The question to ask the user
1175     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1176     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1177     * @return string HTML fragment
1178     */
1179     public function confirm($message, $continue, $cancel) {
1180         if ($continue instanceof single_button) {
1181             // ok
1182         } else if (is_string($continue)) {
1183             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1184         } else if ($continue instanceof moodle_url) {
1185             $continue = new single_button($continue, get_string('continue'), 'post');
1186         } else {
1187             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1188         }
1189
1190         if ($cancel instanceof single_button) {
1191             // ok
1192         } else if (is_string($cancel)) {
1193             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1194         } else if ($cancel instanceof moodle_url) {
1195             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1196         } else {
1197             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1198         }
1199
1200         $output = $this->box_start('generalbox', 'notice');
1201         $output .= html_writer::tag('p', $message);
1202         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1203         $output .= $this->box_end();
1204         return $output;
1205     }
1206
1207     /**
1208      * Returns a form with a single button.
1209      *
1210      * @param string|moodle_url $url
1211      * @param string $label button text
1212      * @param string $method get or post submit method
1213      * @param array $options associative array {disabled, title, etc.}
1214      * @return string HTML fragment
1215      */
1216     public function single_button($url, $label, $method='post', array $options=null) {
1217         if (!($url instanceof moodle_url)) {
1218             $url = new moodle_url($url);
1219         }
1220         $button = new single_button($url, $label, $method);
1221
1222         foreach ((array)$options as $key=>$value) {
1223             if (array_key_exists($key, $button)) {
1224                 $button->$key = $value;
1225             }
1226         }
1227
1228         return $this->render($button);
1229     }
1230
1231     /**
1232      * Renders a single button widget.
1233      *
1234      * This will return HTML to display a form containing a single button.
1235      *
1236      * @param single_button $button
1237      * @return string HTML fragment
1238      */
1239     protected function render_single_button(single_button $button) {
1240         $attributes = array('type'     => 'submit',
1241                             'value'    => $button->label,
1242                             'disabled' => $button->disabled ? 'disabled' : null,
1243                             'title'    => $button->tooltip);
1244
1245         if ($button->actions) {
1246             $id = html_writer::random_id('single_button');
1247             $attributes['id'] = $id;
1248             foreach ($button->actions as $action) {
1249                 $this->add_action_handler($action, $id);
1250             }
1251         }
1252
1253         // first the input element
1254         $output = html_writer::empty_tag('input', $attributes);
1255
1256         // then hidden fields
1257         $params = $button->url->params();
1258         if ($button->method === 'post') {
1259             $params['sesskey'] = sesskey();
1260         }
1261         foreach ($params as $var => $val) {
1262             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1263         }
1264
1265         // then div wrapper for xhtml strictness
1266         $output = html_writer::tag('div', $output);
1267
1268         // now the form itself around it
1269         if ($button->method === 'get') {
1270             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
1271         } else {
1272             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
1273         }
1274         if ($url === '') {
1275             $url = '#'; // there has to be always some action
1276         }
1277         $attributes = array('method' => $button->method,
1278                             'action' => $url,
1279                             'id'     => $button->formid);
1280         $output = html_writer::tag('form', $output, $attributes);
1281
1282         // and finally one more wrapper with class
1283         return html_writer::tag('div', $output, array('class' => $button->class));
1284     }
1285
1286     /**
1287      * Returns a form with a single select widget.
1288      *
1289      * @param moodle_url $url form action target, includes hidden fields
1290      * @param string $name name of selection field - the changing parameter in url
1291      * @param array $options list of options
1292      * @param string $selected selected element
1293      * @param array $nothing
1294      * @param string $formid
1295      * @return string HTML fragment
1296      */
1297     public function single_select($url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
1298         if (!($url instanceof moodle_url)) {
1299             $url = new moodle_url($url);
1300         }
1301         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1302
1303         return $this->render($select);
1304     }
1305
1306     /**
1307      * Internal implementation of single_select rendering
1308      *
1309      * @param single_select $select
1310      * @return string HTML fragment
1311      */
1312     protected function render_single_select(single_select $select) {
1313         $select = clone($select);
1314         if (empty($select->formid)) {
1315             $select->formid = html_writer::random_id('single_select_f');
1316         }
1317
1318         $output = '';
1319         $params = $select->url->params();
1320         if ($select->method === 'post') {
1321             $params['sesskey'] = sesskey();
1322         }
1323         foreach ($params as $name=>$value) {
1324             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1325         }
1326
1327         if (empty($select->attributes['id'])) {
1328             $select->attributes['id'] = html_writer::random_id('single_select');
1329         }
1330
1331         if ($select->disabled) {
1332             $select->attributes['disabled'] = 'disabled';
1333         }
1334
1335         if ($select->tooltip) {
1336             $select->attributes['title'] = $select->tooltip;
1337         }
1338
1339         if ($select->label) {
1340             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1341         }
1342
1343         if ($select->helpicon instanceof help_icon) {
1344             $output .= $this->render($select->helpicon);
1345         } else if ($select->helpicon instanceof old_help_icon) {
1346             $output .= $this->render($select->helpicon);
1347         }
1348         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1349
1350         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1351         $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
1352
1353         $nothing = empty($select->nothing) ? false : key($select->nothing);
1354         $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
1355
1356         // then div wrapper for xhtml strictness
1357         $output = html_writer::tag('div', $output);
1358
1359         // now the form itself around it
1360         if ($select->method === 'get') {
1361             $url = $select->url->out_omit_querystring(true); // url without params, the anchor part allowed
1362         } else {
1363             $url = $select->url->out_omit_querystring();     // url without params, the anchor part not allowed
1364         }
1365         $formattributes = array('method' => $select->method,
1366                                 'action' => $url,
1367                                 'id'     => $select->formid);
1368         $output = html_writer::tag('form', $output, $formattributes);
1369
1370         // and finally one more wrapper with class
1371         return html_writer::tag('div', $output, array('class' => $select->class));
1372     }
1373
1374     /**
1375      * Returns a form with a url select widget.
1376      *
1377      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1378      * @param string $selected selected element
1379      * @param array $nothing
1380      * @param string $formid
1381      * @return string HTML fragment
1382      */
1383     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
1384         $select = new url_select($urls, $selected, $nothing, $formid);
1385         return $this->render($select);
1386     }
1387
1388     /**
1389      * Internal implementation of url_select rendering
1390      *
1391      * @param url_select $select
1392      * @return string HTML fragment
1393      */
1394     protected function render_url_select(url_select $select) {
1395         global $CFG;
1396
1397         $select = clone($select);
1398         if (empty($select->formid)) {
1399             $select->formid = html_writer::random_id('url_select_f');
1400         }
1401
1402         if (empty($select->attributes['id'])) {
1403             $select->attributes['id'] = html_writer::random_id('url_select');
1404         }
1405
1406         if ($select->disabled) {
1407             $select->attributes['disabled'] = 'disabled';
1408         }
1409
1410         if ($select->tooltip) {
1411             $select->attributes['title'] = $select->tooltip;
1412         }
1413
1414         $output = '';
1415
1416         if ($select->label) {
1417             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1418         }
1419
1420         if ($select->helpicon instanceof help_icon) {
1421             $output .= $this->render($select->helpicon);
1422         } else if ($select->helpicon instanceof old_help_icon) {
1423             $output .= $this->render($select->helpicon);
1424         }
1425
1426         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1427         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
1428         $urls = array();
1429         foreach ($select->urls as $k=>$v) {
1430             if (is_array($v)) {
1431                 // optgroup structure
1432                 foreach ($v as $optgrouptitle => $optgroupoptions) {
1433                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
1434                         if (empty($optionurl)) {
1435                             $safeoptionurl = '';
1436                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1437                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1438                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1439                         } else if (strpos($optionurl, '/') !== 0) {
1440                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1441                             continue;
1442                         } else {
1443                             $safeoptionurl = $optionurl;
1444                         }
1445                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1446                     }
1447                 }
1448             } else {
1449                 // plain list structure
1450                 if (empty($k)) {
1451                     // nothing selected option
1452                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1453                     $k = str_replace($CFG->wwwroot, '', $k);
1454                 } else if (strpos($k, '/') !== 0) {
1455                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1456                     continue;
1457                 }
1458                 $urls[$k] = $v;
1459             }
1460         }
1461         $selected = $select->selected;
1462         if (!empty($selected)) {
1463             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1464                 $selected = str_replace($CFG->wwwroot, '', $selected);
1465             } else if (strpos($selected, '/') !== 0) {
1466                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
1467             }
1468         }
1469
1470         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1471         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
1472
1473         if (!$select->showbutton) {
1474             $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1475             $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
1476             $nothing = empty($select->nothing) ? false : key($select->nothing);
1477             $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1478         } else {
1479             $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>$select->showbutton));
1480         }
1481
1482         // then div wrapper for xhtml strictness
1483         $output = html_writer::tag('div', $output);
1484
1485         // now the form itself around it
1486         $formattributes = array('method' => 'post',
1487                                 'action' => new moodle_url('/course/jumpto.php'),
1488                                 'id'     => $select->formid);
1489         $output = html_writer::tag('form', $output, $formattributes);
1490
1491         // and finally one more wrapper with class
1492         return html_writer::tag('div', $output, array('class' => $select->class));
1493     }
1494
1495     /**
1496      * Returns a string containing a link to the user documentation.
1497      * Also contains an icon by default. Shown to teachers and admin only.
1498      *
1499      * @param string $path The page link after doc root and language, no leading slash.
1500      * @param string $text The text to be displayed for the link
1501      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
1502      * @return string
1503      */
1504     public function doc_link($path, $text = '', $forcepopup = false) {
1505         global $CFG;
1506
1507         $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
1508
1509         $url = new moodle_url(get_docs_url($path));
1510
1511         $attributes = array('href'=>$url);
1512         if (!empty($CFG->doctonewwindow) || $forcepopup) {
1513             $attributes['class'] = 'helplinkpopup';
1514         }
1515
1516         return html_writer::tag('a', $icon.$text, $attributes);
1517     }
1518
1519     /**
1520      * Return HTML for a pix_icon.
1521      *
1522      * @param string $pix short pix name
1523      * @param string $alt mandatory alt attribute
1524      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
1525      * @param array $attributes htm lattributes
1526      * @return string HTML fragment
1527      */
1528     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1529         $icon = new pix_icon($pix, $alt, $component, $attributes);
1530         return $this->render($icon);
1531     }
1532
1533     /**
1534      * Renders a pix_icon widget and returns the HTML to display it.
1535      *
1536      * @param pix_icon $icon
1537      * @return string HTML fragment
1538      */
1539     protected function render_pix_icon(pix_icon $icon) {
1540         $attributes = $icon->attributes;
1541         $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
1542         return html_writer::empty_tag('img', $attributes);
1543     }
1544
1545     /**
1546      * Return HTML to display an emoticon icon.
1547      *
1548      * @param pix_emoticon $emoticon
1549      * @return string HTML fragment
1550      */
1551     protected function render_pix_emoticon(pix_emoticon $emoticon) {
1552         $attributes = $emoticon->attributes;
1553         $attributes['src'] = $this->pix_url($emoticon->pix, $emoticon->component);
1554         return html_writer::empty_tag('img', $attributes);
1555     }
1556
1557     /**
1558      * Produces the html that represents this rating in the UI
1559      *
1560      * @param rating $rating the page object on which this rating will appear
1561      * @return string
1562      */
1563     function render_rating(rating $rating) {
1564         global $CFG, $USER;
1565
1566         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
1567             return null;//ratings are turned off
1568         }
1569
1570         $ratingmanager = new rating_manager();
1571         // Initialise the JavaScript so ratings can be done by AJAX.
1572         $ratingmanager->initialise_rating_javascript($this->page);
1573
1574         $strrate = get_string("rate", "rating");
1575         $ratinghtml = ''; //the string we'll return
1576
1577         // permissions check - can they view the aggregate?
1578         if ($rating->user_can_view_aggregate()) {
1579
1580             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
1581             $aggregatestr   = $rating->get_aggregate_string();
1582
1583             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
1584             if ($rating->count > 0) {
1585                 $countstr = "({$rating->count})";
1586             } else {
1587                 $countstr = '-';
1588             }
1589             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
1590
1591             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
1592             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1593
1594                 $nonpopuplink = $rating->get_view_ratings_url();
1595                 $popuplink = $rating->get_view_ratings_url(true);
1596
1597                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
1598                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
1599             } else {
1600                 $ratinghtml .= $aggregatehtml;
1601             }
1602         }
1603
1604         $formstart = null;
1605         // if the item doesn't belong to the current user, the user has permission to rate
1606         // and we're within the assessable period
1607         if ($rating->user_can_rate()) {
1608
1609             $rateurl = $rating->get_rate_url();
1610             $inputs = $rateurl->params();
1611
1612             //start the rating form
1613             $formattrs = array(
1614                 'id'     => "postrating{$rating->itemid}",
1615                 'class'  => 'postratingform',
1616                 'method' => 'post',
1617                 'action' => $rateurl->out_omit_querystring()
1618             );
1619             $formstart  = html_writer::start_tag('form', $formattrs);
1620             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
1621
1622             // add the hidden inputs
1623             foreach ($inputs as $name => $value) {
1624                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
1625                 $formstart .= html_writer::empty_tag('input', $attributes);
1626             }
1627
1628             if (empty($ratinghtml)) {
1629                 $ratinghtml .= $strrate.': ';
1630             }
1631             $ratinghtml = $formstart.$ratinghtml;
1632
1633             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
1634             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
1635             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
1636             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
1637
1638             //output submit button
1639             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
1640
1641             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
1642             $ratinghtml .= html_writer::empty_tag('input', $attributes);
1643
1644             if (!$rating->settings->scale->isnumeric) {
1645                 // If a global scale, try to find current course ID from the context
1646                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
1647                     $courseid = $coursecontext->instanceid;
1648                 } else {
1649                     $courseid = $rating->settings->scale->courseid;
1650                 }
1651                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
1652             }
1653             $ratinghtml .= html_writer::end_tag('span');
1654             $ratinghtml .= html_writer::end_tag('div');
1655             $ratinghtml .= html_writer::end_tag('form');
1656         }
1657
1658         return $ratinghtml;
1659     }
1660
1661     /**
1662      * Centered heading with attached help button (same title text)
1663      * and optional icon attached.
1664      *
1665      * @param string $text A heading text
1666      * @param string $helpidentifier The keyword that defines a help page
1667      * @param string $component component name
1668      * @param string|moodle_url $icon
1669      * @param string $iconalt icon alt text
1670      * @return string HTML fragment
1671      */
1672     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '') {
1673         $image = '';
1674         if ($icon) {
1675             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
1676         }
1677
1678         $help = '';
1679         if ($helpidentifier) {
1680             $help = $this->help_icon($helpidentifier, $component);
1681         }
1682
1683         return $this->heading($image.$text.$help, 2, 'main help');
1684     }
1685
1686     /**
1687      * Returns HTML to display a help icon.
1688      *
1689      * @deprecated since Moodle 2.0
1690      * @param string $helpidentifier The keyword that defines a help page
1691      * @param string $title A descriptive text for accessibility only
1692      * @param string $component component name
1693      * @param string|bool $linktext true means use $title as link text, string means link text value
1694      * @return string HTML fragment
1695      */
1696     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
1697         debugging('The method old_help_icon() is deprecated, please fix the code and use help_icon() method instead', DEBUG_DEVELOPER);
1698         $icon = new old_help_icon($helpidentifier, $title, $component);
1699         if ($linktext === true) {
1700             $icon->linktext = $title;
1701         } else if (!empty($linktext)) {
1702             $icon->linktext = $linktext;
1703         }
1704         return $this->render($icon);
1705     }
1706
1707     /**
1708      * Implementation of user image rendering.
1709      *
1710      * @param old_help_icon $helpicon A help icon instance
1711      * @return string HTML fragment
1712      */
1713     protected function render_old_help_icon(old_help_icon $helpicon) {
1714         global $CFG;
1715
1716         // first get the help image icon
1717         $src = $this->pix_url('help');
1718
1719         if (empty($helpicon->linktext)) {
1720             $alt = $helpicon->title;
1721         } else {
1722             $alt = get_string('helpwiththis');
1723         }
1724
1725         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1726         $output = html_writer::empty_tag('img', $attributes);
1727
1728         // add the link text if given
1729         if (!empty($helpicon->linktext)) {
1730             // the spacing has to be done through CSS
1731             $output .= $helpicon->linktext;
1732         }
1733
1734         // now create the link around it - we need https on loginhttps pages
1735         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
1736
1737         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1738         $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1739
1740         $attributes = array('href'=>$url, 'title'=>$title, 'aria-haspopup' => 'true');
1741         $id = html_writer::random_id('helpicon');
1742         $attributes['id'] = $id;
1743         $output = html_writer::tag('a', $output, $attributes);
1744
1745         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1746         $this->page->requires->string_for_js('close', 'form');
1747
1748         // and finally span
1749         return html_writer::tag('span', $output, array('class' => 'helplink'));
1750     }
1751
1752     /**
1753      * Returns HTML to display a help icon.
1754      *
1755      * @param string $identifier The keyword that defines a help page
1756      * @param string $component component name
1757      * @param string|bool $linktext true means use $title as link text, string means link text value
1758      * @return string HTML fragment
1759      */
1760     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
1761         $icon = new help_icon($identifier, $component);
1762         $icon->diag_strings();
1763         if ($linktext === true) {
1764             $icon->linktext = get_string($icon->identifier, $icon->component);
1765         } else if (!empty($linktext)) {
1766             $icon->linktext = $linktext;
1767         }
1768         return $this->render($icon);
1769     }
1770
1771     /**
1772      * Implementation of user image rendering.
1773      *
1774      * @param help_icon $helpicon A help icon instance
1775      * @return string HTML fragment
1776      */
1777     protected function render_help_icon(help_icon $helpicon) {
1778         global $CFG;
1779
1780         // first get the help image icon
1781         $src = $this->pix_url('help');
1782
1783         $title = get_string($helpicon->identifier, $helpicon->component);
1784
1785         if (empty($helpicon->linktext)) {
1786             $alt = get_string('helpprefix2', '', trim($title, ". \t"));
1787         } else {
1788             $alt = get_string('helpwiththis');
1789         }
1790
1791         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1792         $output = html_writer::empty_tag('img', $attributes);
1793
1794         // add the link text if given
1795         if (!empty($helpicon->linktext)) {
1796             // the spacing has to be done through CSS
1797             $output .= $helpicon->linktext;
1798         }
1799
1800         // now create the link around it - we need https on loginhttps pages
1801         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
1802
1803         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1804         $title = get_string('helpprefix2', '', trim($title, ". \t"));
1805
1806         $attributes = array('href'=>$url, 'title'=>$title, 'aria-haspopup' => 'true');
1807         $id = html_writer::random_id('helpicon');
1808         $attributes['id'] = $id;
1809         $output = html_writer::tag('a', $output, $attributes);
1810
1811         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1812         $this->page->requires->string_for_js('close', 'form');
1813
1814         // and finally span
1815         return html_writer::tag('span', $output, array('class' => 'helplink'));
1816     }
1817
1818     /**
1819      * Returns HTML to display a scale help icon.
1820      *
1821      * @param int $courseid
1822      * @param stdClass $scale instance
1823      * @return string HTML fragment
1824      */
1825     public function help_icon_scale($courseid, stdClass $scale) {
1826         global $CFG;
1827
1828         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
1829
1830         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
1831
1832         $scaleid = abs($scale->id);
1833
1834         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
1835         $action = new popup_action('click', $link, 'ratingscale');
1836
1837         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
1838     }
1839
1840     /**
1841      * Creates and returns a spacer image with optional line break.
1842      *
1843      * @param array $attributes Any HTML attributes to add to the spaced.
1844      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
1845      *     laxy do it with CSS which is a much better solution.
1846      * @return string HTML fragment
1847      */
1848     public function spacer(array $attributes = null, $br = false) {
1849         $attributes = (array)$attributes;
1850         if (empty($attributes['width'])) {
1851             $attributes['width'] = 1;
1852         }
1853         if (empty($attributes['height'])) {
1854             $attributes['height'] = 1;
1855         }
1856         $attributes['class'] = 'spacer';
1857
1858         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
1859
1860         if (!empty($br)) {
1861             $output .= '<br />';
1862         }
1863
1864         return $output;
1865     }
1866
1867     /**
1868      * Returns HTML to display the specified user's avatar.
1869      *
1870      * User avatar may be obtained in two ways:
1871      * <pre>
1872      * // Option 1: (shortcut for simple cases, preferred way)
1873      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1874      * $OUTPUT->user_picture($user, array('popup'=>true));
1875      *
1876      * // Option 2:
1877      * $userpic = new user_picture($user);
1878      * // Set properties of $userpic
1879      * $userpic->popup = true;
1880      * $OUTPUT->render($userpic);
1881      * </pre>
1882      *
1883      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
1884      *     If any of these are missing, the database is queried. Avoid this
1885      *     if at all possible, particularly for reports. It is very bad for performance.
1886      * @param array $options associative array with user picture options, used only if not a user_picture object,
1887      *     options are:
1888      *     - courseid=$this->page->course->id (course id of user profile in link)
1889      *     - size=35 (size of image)
1890      *     - link=true (make image clickable - the link leads to user profile)
1891      *     - popup=false (open in popup)
1892      *     - alttext=true (add image alt attribute)
1893      *     - class = image class attribute (default 'userpicture')
1894      * @return string HTML fragment
1895      */
1896     public function user_picture(stdClass $user, array $options = null) {
1897         $userpicture = new user_picture($user);
1898         foreach ((array)$options as $key=>$value) {
1899             if (array_key_exists($key, $userpicture)) {
1900                 $userpicture->$key = $value;
1901             }
1902         }
1903         return $this->render($userpicture);
1904     }
1905
1906     /**
1907      * Internal implementation of user image rendering.
1908      *
1909      * @param user_picture $userpicture
1910      * @return string
1911      */
1912     protected function render_user_picture(user_picture $userpicture) {
1913         global $CFG, $DB;
1914
1915         $user = $userpicture->user;
1916
1917         if ($userpicture->alttext) {
1918             if (!empty($user->imagealt)) {
1919                 $alt = $user->imagealt;
1920             } else {
1921                 $alt = get_string('pictureof', '', fullname($user));
1922             }
1923         } else {
1924             $alt = '';
1925         }
1926
1927         if (empty($userpicture->size)) {
1928             $size = 35;
1929         } else if ($userpicture->size === true or $userpicture->size == 1) {
1930             $size = 100;
1931         } else {
1932             $size = $userpicture->size;
1933         }
1934
1935         $class = $userpicture->class;
1936
1937         if ($user->picture == 0) {
1938             $class .= ' defaultuserpic';
1939         }
1940
1941         $src = $userpicture->get_url($this->page, $this);
1942
1943         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1944
1945         // get the image html output fisrt
1946         $output = html_writer::empty_tag('img', $attributes);;
1947
1948         // then wrap it in link if needed
1949         if (!$userpicture->link) {
1950             return $output;
1951         }
1952
1953         if (empty($userpicture->courseid)) {
1954             $courseid = $this->page->course->id;
1955         } else {
1956             $courseid = $userpicture->courseid;
1957         }
1958
1959         if ($courseid == SITEID) {
1960             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
1961         } else {
1962             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
1963         }
1964
1965         $attributes = array('href'=>$url);
1966
1967         if ($userpicture->popup) {
1968             $id = html_writer::random_id('userpicture');
1969             $attributes['id'] = $id;
1970             $this->add_action_handler(new popup_action('click', $url), $id);
1971         }
1972
1973         return html_writer::tag('a', $output, $attributes);
1974     }
1975
1976     /**
1977      * Internal implementation of file tree viewer items rendering.
1978      *
1979      * @param array $dir
1980      * @return string
1981      */
1982     public function htmllize_file_tree($dir) {
1983         if (empty($dir['subdirs']) and empty($dir['files'])) {
1984             return '';
1985         }
1986         $result = '<ul>';
1987         foreach ($dir['subdirs'] as $subdir) {
1988             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
1989         }
1990         foreach ($dir['files'] as $file) {
1991             $filename = $file->get_filename();
1992             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
1993         }
1994         $result .= '</ul>';
1995
1996         return $result;
1997     }
1998
1999     /**
2000      * Returns HTML to display the file picker
2001      *
2002      * <pre>
2003      * $OUTPUT->file_picker($options);
2004      * </pre>
2005      *
2006      * @param array $options associative array with file manager options
2007      *   options are:
2008      *       maxbytes=>-1,
2009      *       itemid=>0,
2010      *       client_id=>uniqid(),
2011      *       acepted_types=>'*',
2012      *       return_types=>FILE_INTERNAL,
2013      *       context=>$PAGE->context
2014      * @return string HTML fragment
2015      */
2016     public function file_picker($options) {
2017         $fp = new file_picker($options);
2018         return $this->render($fp);
2019     }
2020
2021     /**
2022      * Internal implementation of file picker rendering.
2023      *
2024      * @param file_picker $fp
2025      * @return string
2026      */
2027     public function render_file_picker(file_picker $fp) {
2028         global $CFG, $OUTPUT, $USER;
2029         $options = $fp->options;
2030         $client_id = $options->client_id;
2031         $strsaved = get_string('filesaved', 'repository');
2032         $straddfile = get_string('openpicker', 'repository');
2033         $strloading  = get_string('loading', 'repository');
2034         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2035         $strdroptoupload = get_string('droptoupload', 'moodle');
2036         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2037
2038         $currentfile = $options->currentfile;
2039         if (empty($currentfile)) {
2040             $currentfile = '';
2041         } else {
2042             $currentfile .= ' - ';
2043         }
2044         if ($options->maxbytes) {
2045             $size = $options->maxbytes;
2046         } else {
2047             $size = get_max_upload_file_size();
2048         }
2049         if ($size == -1) {
2050             $maxsize = '';
2051         } else {
2052             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2053         }
2054         if ($options->buttonname) {
2055             $buttonname = ' name="' . $options->buttonname . '"';
2056         } else {
2057             $buttonname = '';
2058         }
2059         $html = <<<EOD
2060 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2061 $icon_progress
2062 </div>
2063 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
2064     <div>
2065         <input type="button" class="fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2066         <span> $maxsize </span>
2067     </div>
2068 EOD;
2069         if ($options->env != 'url') {
2070             $html .= <<<EOD
2071     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2072     <div class="filepicker-filename">
2073         <div class="filepicker-container">$currentfile<span class="dndupload-message">$strdndenabled <br/><span class="dndupload-arrow"></span></span></div>
2074     </div>
2075     <div><div class="dndupload-target">{$strdroptoupload}<br/><span class="dndupload-arrow"></span></div></div>
2076     </div>
2077 EOD;
2078         }
2079         $html .= '</div>';
2080         return $html;
2081     }
2082
2083     /**
2084      * Returns HTML to display the 'Update this Modulename' button that appears on module pages.
2085      *
2086      * @param string $cmid the course_module id.
2087      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
2088      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
2089      */
2090     public function update_module_button($cmid, $modulename) {
2091         global $CFG;
2092         if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
2093             $modulename = get_string('modulename', $modulename);
2094             $string = get_string('updatethis', '', $modulename);
2095             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
2096             return $this->single_button($url, $string);
2097         } else {
2098             return '';
2099         }
2100     }
2101
2102     /**
2103      * Returns HTML to display a "Turn editing on/off" button in a form.
2104      *
2105      * @param moodle_url $url The URL + params to send through when clicking the button
2106      * @return string HTML the button
2107      */
2108     public function edit_button(moodle_url $url) {
2109
2110         $url->param('sesskey', sesskey());
2111         if ($this->page->user_is_editing()) {
2112             $url->param('edit', 'off');
2113             $editstring = get_string('turneditingoff');
2114         } else {
2115             $url->param('edit', 'on');
2116             $editstring = get_string('turneditingon');
2117         }
2118
2119         return $this->single_button($url, $editstring);
2120     }
2121
2122     /**
2123      * Returns HTML to display a simple button to close a window
2124      *
2125      * @param string $text The lang string for the button's label (already output from get_string())
2126      * @return string html fragment
2127      */
2128     public function close_window_button($text='') {
2129         if (empty($text)) {
2130             $text = get_string('closewindow');
2131         }
2132         $button = new single_button(new moodle_url('#'), $text, 'get');
2133         $button->add_action(new component_action('click', 'close_window'));
2134
2135         return $this->container($this->render($button), 'closewindow');
2136     }
2137
2138     /**
2139      * Output an error message. By default wraps the error message in <span class="error">.
2140      * If the error message is blank, nothing is output.
2141      *
2142      * @param string $message the error message.
2143      * @return string the HTML to output.
2144      */
2145     public function error_text($message) {
2146         if (empty($message)) {
2147             return '';
2148         }
2149         return html_writer::tag('span', $message, array('class' => 'error'));
2150     }
2151
2152     /**
2153      * Do not call this function directly.
2154      *
2155      * To terminate the current script with a fatal error, call the {@link print_error}
2156      * function, or throw an exception. Doing either of those things will then call this
2157      * function to display the error, before terminating the execution.
2158      *
2159      * @param string $message The message to output
2160      * @param string $moreinfourl URL where more info can be found about the error
2161      * @param string $link Link for the Continue button
2162      * @param array $backtrace The execution backtrace
2163      * @param string $debuginfo Debugging information
2164      * @return string the HTML to output.
2165      */
2166     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2167         global $CFG;
2168
2169         $output = '';
2170         $obbuffer = '';
2171
2172         if ($this->has_started()) {
2173             // we can not always recover properly here, we have problems with output buffering,
2174             // html tables, etc.
2175             $output .= $this->opencontainers->pop_all_but_last();
2176
2177         } else {
2178             // It is really bad if library code throws exception when output buffering is on,
2179             // because the buffered text would be printed before our start of page.
2180             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2181             error_reporting(0); // disable notices from gzip compression, etc.
2182             while (ob_get_level() > 0) {
2183                 $buff = ob_get_clean();
2184                 if ($buff === false) {
2185                     break;
2186                 }
2187                 $obbuffer .= $buff;
2188             }
2189             error_reporting($CFG->debug);
2190
2191             // Header not yet printed
2192             if (isset($_SERVER['SERVER_PROTOCOL'])) {
2193                 // server protocol should be always present, because this render
2194                 // can not be used from command line or when outputting custom XML
2195                 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
2196             }
2197             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2198             $this->page->set_url('/'); // no url
2199             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2200             $this->page->set_title(get_string('error'));
2201             $this->page->set_heading($this->page->course->fullname);
2202             $output .= $this->header();
2203         }
2204
2205         $message = '<p class="errormessage">' . $message . '</p>'.
2206                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2207                 get_string('moreinformation') . '</a></p>';
2208         if (empty($CFG->rolesactive)) {
2209             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2210             //It is usually not possible to recover from errors triggered during installation, you may need to create a new database or use a different database prefix for new installation.
2211         }
2212         $output .= $this->box($message, 'errorbox');
2213
2214         if (debugging('', DEBUG_DEVELOPER)) {
2215             if (!empty($debuginfo)) {
2216                 $debuginfo = s($debuginfo); // removes all nasty JS
2217                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2218                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2219             }
2220             if (!empty($backtrace)) {
2221                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2222             }
2223             if ($obbuffer !== '' ) {
2224                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2225             }
2226         }
2227
2228         if (empty($CFG->rolesactive)) {
2229             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2230         } else if (!empty($link)) {
2231             $output .= $this->continue_button($link);
2232         }
2233
2234         $output .= $this->footer();
2235
2236         // Padding to encourage IE to display our error page, rather than its own.
2237         $output .= str_repeat(' ', 512);
2238
2239         return $output;
2240     }
2241
2242     /**
2243      * Output a notification (that is, a status message about something that has
2244      * just happened).
2245      *
2246      * @param string $message the message to print out
2247      * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2248      * @return string the HTML to output.
2249      */
2250     public function notification($message, $classes = 'notifyproblem') {
2251         return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
2252     }
2253
2254     /**
2255      * Returns HTML to display a continue button that goes to a particular URL.
2256      *
2257      * @param string|moodle_url $url The url the button goes to.
2258      * @return string the HTML to output.
2259      */
2260     public function continue_button($url) {
2261         if (!($url instanceof moodle_url)) {
2262             $url = new moodle_url($url);
2263         }
2264         $button = new single_button($url, get_string('continue'), 'get');
2265         $button->class = 'continuebutton';
2266
2267         return $this->render($button);
2268     }
2269
2270     /**
2271      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2272      *
2273      * @param int $totalcount The total number of entries available to be paged through
2274      * @param int $page The page you are currently viewing
2275      * @param int $perpage The number of entries that should be shown per page
2276      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2277      * @param string $pagevar name of page parameter that holds the page number
2278      * @return string the HTML to output.
2279      */
2280     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2281         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2282         return $this->render($pb);
2283     }
2284
2285     /**
2286      * Internal implementation of paging bar rendering.
2287      *
2288      * @param paging_bar $pagingbar
2289      * @return string
2290      */
2291     protected function render_paging_bar(paging_bar $pagingbar) {
2292         $output = '';
2293         $pagingbar = clone($pagingbar);
2294         $pagingbar->prepare($this, $this->page, $this->target);
2295
2296         if ($pagingbar->totalcount > $pagingbar->perpage) {
2297             $output .= get_string('page') . ':';
2298
2299             if (!empty($pagingbar->previouslink)) {
2300                 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
2301             }
2302
2303             if (!empty($pagingbar->firstlink)) {
2304                 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
2305             }
2306
2307             foreach ($pagingbar->pagelinks as $link) {
2308                 $output .= "&#160;&#160;$link";
2309             }
2310
2311             if (!empty($pagingbar->lastlink)) {
2312                 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
2313             }
2314
2315             if (!empty($pagingbar->nextlink)) {
2316                 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
2317             }
2318         }
2319
2320         return html_writer::tag('div', $output, array('class' => 'paging'));
2321     }
2322
2323     /**
2324      * Output the place a skip link goes to.
2325      *
2326      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2327      * @return string the HTML to output.
2328      */
2329     public function skip_link_target($id = null) {
2330         return html_writer::tag('span', '', array('id' => $id));
2331     }
2332
2333     /**
2334      * Outputs a heading
2335      *
2336      * @param string $text The text of the heading
2337      * @param int $level The level of importance of the heading. Defaulting to 2
2338      * @param string $classes A space-separated list of CSS classes
2339      * @param string $id An optional ID
2340      * @return string the HTML to output.
2341      */
2342     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2343         $level = (integer) $level;
2344         if ($level < 1 or $level > 6) {
2345             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2346         }
2347         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2348     }
2349
2350     /**
2351      * Outputs a box.
2352      *
2353      * @param string $contents The contents of the box
2354      * @param string $classes A space-separated list of CSS classes
2355      * @param string $id An optional ID
2356      * @return string the HTML to output.
2357      */
2358     public function box($contents, $classes = 'generalbox', $id = null) {
2359         return $this->box_start($classes, $id) . $contents . $this->box_end();
2360     }
2361
2362     /**
2363      * Outputs the opening section of a box.
2364      *
2365      * @param string $classes A space-separated list of CSS classes
2366      * @param string $id An optional ID
2367      * @return string the HTML to output.
2368      */
2369     public function box_start($classes = 'generalbox', $id = null) {
2370         $this->opencontainers->push('box', html_writer::end_tag('div'));
2371         return html_writer::start_tag('div', array('id' => $id,
2372                 'class' => 'box ' . renderer_base::prepare_classes($classes)));
2373     }
2374
2375     /**
2376      * Outputs the closing section of a box.
2377      *
2378      * @return string the HTML to output.
2379      */
2380     public function box_end() {
2381         return $this->opencontainers->pop('box');
2382     }
2383
2384     /**
2385      * Outputs a container.
2386      *
2387      * @param string $contents The contents of the box
2388      * @param string $classes A space-separated list of CSS classes
2389      * @param string $id An optional ID
2390      * @return string the HTML to output.
2391      */
2392     public function container($contents, $classes = null, $id = null) {
2393         return $this->container_start($classes, $id) . $contents . $this->container_end();
2394     }
2395
2396     /**
2397      * Outputs the opening section of a container.
2398      *
2399      * @param string $classes A space-separated list of CSS classes
2400      * @param string $id An optional ID
2401      * @return string the HTML to output.
2402      */
2403     public function container_start($classes = null, $id = null) {
2404         $this->opencontainers->push('container', html_writer::end_tag('div'));
2405         return html_writer::start_tag('div', array('id' => $id,
2406                 'class' => renderer_base::prepare_classes($classes)));
2407     }
2408
2409     /**
2410      * Outputs the closing section of a container.
2411      *
2412      * @return string the HTML to output.
2413      */
2414     public function container_end() {
2415         return $this->opencontainers->pop('container');
2416     }
2417
2418     /**
2419      * Make nested HTML lists out of the items
2420      *
2421      * The resulting list will look something like this:
2422      *
2423      * <pre>
2424      * <<ul>>
2425      * <<li>><div class='tree_item parent'>(item contents)</div>
2426      *      <<ul>
2427      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
2428      *      <</ul>>
2429      * <</li>>
2430      * <</ul>>
2431      * </pre>
2432      *
2433      * @param array $items
2434      * @param array $attrs html attributes passed to the top ofs the list
2435      * @return string HTML
2436      */
2437     public function tree_block_contents($items, $attrs = array()) {
2438         // exit if empty, we don't want an empty ul element
2439         if (empty($items)) {
2440             return '';
2441         }
2442         // array of nested li elements
2443         $lis = array();
2444         foreach ($items as $item) {
2445             // this applies to the li item which contains all child lists too
2446             $content = $item->content($this);
2447             $liclasses = array($item->get_css_type());
2448             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
2449                 $liclasses[] = 'collapsed';
2450             }
2451             if ($item->isactive === true) {
2452                 $liclasses[] = 'current_branch';
2453             }
2454             $liattr = array('class'=>join(' ',$liclasses));
2455             // class attribute on the div item which only contains the item content
2456             $divclasses = array('tree_item');
2457             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
2458                 $divclasses[] = 'branch';
2459             } else {
2460                 $divclasses[] = 'leaf';
2461             }
2462             if (!empty($item->classes) && count($item->classes)>0) {
2463                 $divclasses[] = join(' ', $item->classes);
2464             }
2465             $divattr = array('class'=>join(' ', $divclasses));
2466             if (!empty($item->id)) {
2467                 $divattr['id'] = $item->id;
2468             }
2469             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
2470             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
2471                 $content = html_writer::empty_tag('hr') . $content;
2472             }
2473             $content = html_writer::tag('li', $content, $liattr);
2474             $lis[] = $content;
2475         }
2476         return html_writer::tag('ul', implode("\n", $lis), $attrs);
2477     }
2478
2479     /**
2480      * Return the navbar content so that it can be echoed out by the layout
2481      *
2482      * @return string XHTML navbar
2483      */
2484     public function navbar() {
2485         $items = $this->page->navbar->get_items();
2486
2487         $htmlblocks = array();
2488         // Iterate the navarray and display each node
2489         $itemcount = count($items);
2490         $separator = get_separator();
2491         for ($i=0;$i < $itemcount;$i++) {
2492             $item = $items[$i];
2493             $item->hideicon = true;
2494             if ($i===0) {
2495                 $content = html_writer::tag('li', $this->render($item));
2496             } else {
2497                 $content = html_writer::tag('li', $separator.$this->render($item));
2498             }
2499             $htmlblocks[] = $content;
2500         }
2501
2502         //accessibility: heading for navbar list  (MDL-20446)
2503         $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2504         $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks));
2505         // XHTML
2506         return $navbarcontent;
2507     }
2508
2509     /**
2510      * Renders a navigation node object.
2511      *
2512      * @param navigation_node $item The navigation node to render.
2513      * @return string HTML fragment
2514      */
2515     protected function render_navigation_node(navigation_node $item) {
2516         $content = $item->get_content();
2517         $title = $item->get_title();
2518         if ($item->icon instanceof renderable && !$item->hideicon) {
2519             $icon = $this->render($item->icon);
2520             $content = $icon.$content; // use CSS for spacing of icons
2521         }
2522         if ($item->helpbutton !== null) {
2523             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton', 'tabindex'=>'0'));
2524         }
2525         if ($content === '') {
2526             return '';
2527         }
2528         if ($item->action instanceof action_link) {
2529             $link = $item->action;
2530             if ($item->hidden) {
2531                 $link->add_class('dimmed');
2532             }
2533             if (!empty($content)) {
2534                 // Providing there is content we will use that for the link content.
2535                 $link->text = $content;
2536             }
2537             $content = $this->render($link);
2538         } else if ($item->action instanceof moodle_url) {
2539             $attributes = array();
2540             if ($title !== '') {
2541                 $attributes['title'] = $title;
2542             }
2543             if ($item->hidden) {
2544                 $attributes['class'] = 'dimmed_text';
2545             }
2546             $content = html_writer::link($item->action, $content, $attributes);
2547
2548         } else if (is_string($item->action) || empty($item->action)) {
2549             $attributes = array('tabindex'=>'0'); //add tab support to span but still maintain character stream sequence.
2550             if ($title !== '') {
2551                 $attributes['title'] = $title;
2552             }
2553             if ($item->hidden) {
2554                 $attributes['class'] = 'dimmed_text';
2555             }
2556             $content = html_writer::tag('span', $content, $attributes);
2557         }
2558         return $content;
2559     }
2560
2561     /**
2562      * Accessibility: Right arrow-like character is
2563      * used in the breadcrumb trail, course navigation menu
2564      * (previous/next activity), calendar, and search forum block.
2565      * If the theme does not set characters, appropriate defaults
2566      * are set automatically. Please DO NOT
2567      * use &lt; &gt; &raquo; - these are confusing for blind users.
2568      *
2569      * @return string
2570      */
2571     public function rarrow() {
2572         return $this->page->theme->rarrow;
2573     }
2574
2575     /**
2576      * Accessibility: Right arrow-like character is
2577      * used in the breadcrumb trail, course navigation menu
2578      * (previous/next activity), calendar, and search forum block.
2579      * If the theme does not set characters, appropriate defaults
2580      * are set automatically. Please DO NOT
2581      * use &lt; &gt; &raquo; - these are confusing for blind users.
2582      *
2583      * @return string
2584      */
2585     public function larrow() {
2586         return $this->page->theme->larrow;
2587     }
2588
2589     /**
2590      * Returns the custom menu if one has been set
2591      *
2592      * A custom menu can be configured by browsing to
2593      *    Settings: Administration > Appearance > Themes > Theme settings
2594      * and then configuring the custommenu config setting as described.
2595      *
2596      * @param string $custommenuitems - custom menuitems set by theme instead of global theme settings
2597      * @return string
2598      */
2599     public function custom_menu($custommenuitems = '') {
2600         global $CFG;
2601         if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
2602             $custommenuitems = $CFG->custommenuitems;
2603         }
2604         if (empty($custommenuitems)) {
2605             return '';
2606         }
2607         $custommenu = new custom_menu($custommenuitems, current_language());
2608         return $this->render_custom_menu($custommenu);
2609     }
2610
2611     /**
2612      * Renders a custom menu object (located in outputcomponents.php)
2613      *
2614      * The custom menu this method produces makes use of the YUI3 menunav widget
2615      * and requires very specific html elements and classes.
2616      *
2617      * @staticvar int $menucount
2618      * @param custom_menu $menu
2619      * @return string
2620      */
2621     protected function render_custom_menu(custom_menu $menu) {
2622         static $menucount = 0;
2623         // If the menu has no children return an empty string
2624         if (!$menu->has_children()) {
2625             return '';
2626         }
2627         // Increment the menu count. This is used for ID's that get worked with
2628         // in JavaScript as is essential
2629         $menucount++;
2630         // Initialise this custom menu (the custom menu object is contained in javascript-static
2631         $jscode = js_writer::function_call_with_Y('M.core_custom_menu.init', array('custom_menu_'.$menucount));
2632         $jscode = "(function(){{$jscode}})";
2633         $this->page->requires->yui_module('node-menunav', $jscode);
2634         // Build the root nodes as required by YUI
2635         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled'));
2636         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2637         $content .= html_writer::start_tag('ul');
2638         // Render each child
2639         foreach ($menu->get_children() as $item) {
2640             $content .= $this->render_custom_menu_item($item);
2641         }
2642         // Close the open tags
2643         $content .= html_writer::end_tag('ul');
2644         $content .= html_writer::end_tag('div');
2645         $content .= html_writer::end_tag('div');
2646         // Return the custom menu
2647         return $content;
2648     }
2649
2650     /**
2651      * Renders a custom menu node as part of a submenu
2652      *
2653      * The custom menu this method produces makes use of the YUI3 menunav widget
2654      * and requires very specific html elements and classes.
2655      *
2656      * @see core:renderer::render_custom_menu()
2657      *
2658      * @staticvar int $submenucount
2659      * @param custom_menu_item $menunode
2660      * @return string
2661      */
2662     protected function render_custom_menu_item(custom_menu_item $menunode) {
2663         // Required to ensure we get unique trackable id's
2664         static $submenucount = 0;
2665         if ($menunode->has_children()) {
2666             // If the child has menus render it as a sub menu
2667             $submenucount++;
2668             $content = html_writer::start_tag('li');
2669             if ($menunode->get_url() !== null) {
2670                 $url = $menunode->get_url();
2671             } else {
2672                 $url = '#cm_submenu_'.$submenucount;
2673             }
2674             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
2675             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
2676             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2677             $content .= html_writer::start_tag('ul');
2678             foreach ($menunode->get_children() as $menunode) {
2679                 $content .= $this->render_custom_menu_item($menunode);
2680             }
2681             $content .= html_writer::end_tag('ul');
2682             $content .= html_writer::end_tag('div');
2683             $content .= html_writer::end_tag('div');
2684             $content .= html_writer::end_tag('li');
2685         } else {
2686             // The node doesn't have children so produce a final menuitem
2687             $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
2688             if ($menunode->get_url() !== null) {
2689                 $url = $menunode->get_url();
2690             } else {
2691                 $url = '#';
2692             }
2693             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
2694             $content .= html_writer::end_tag('li');
2695         }
2696         // Return the sub menu
2697         return $content;
2698     }
2699
2700     /**
2701      * Renders theme links for switching between default and other themes.
2702      *
2703      * @return string
2704      */
2705     protected function theme_switch_links() {
2706
2707         $actualdevice = get_device_type();
2708         $currentdevice = $this->page->devicetypeinuse;
2709         $switched = ($actualdevice != $currentdevice);
2710
2711         if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
2712             // The user is using the a default device and hasn't switched so don't shown the switch
2713             // device links.
2714             return '';
2715         }
2716
2717         if ($switched) {
2718             $linktext = get_string('switchdevicerecommended');
2719             $devicetype = $actualdevice;
2720         } else {
2721             $linktext = get_string('switchdevicedefault');
2722             $devicetype = 'default';
2723         }
2724         $linkurl = new moodle_url('/theme/switchdevice.php', array('url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()));
2725
2726         $content  = html_writer::start_tag('div', array('id' => 'theme_switch_link'));
2727         $content .= html_writer::link($linkurl, $linktext);
2728         $content .= html_writer::end_tag('div');
2729
2730         return $content;
2731     }
2732 }
2733
2734 /**
2735  * A renderer that generates output for command-line scripts.
2736  *
2737  * The implementation of this renderer is probably incomplete.
2738  *
2739  * @copyright 2009 Tim Hunt
2740  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2741  * @since Moodle 2.0
2742  * @package core
2743  * @category output
2744  */
2745 class core_renderer_cli extends core_renderer {
2746
2747     /**
2748      * Returns the page header.
2749      *
2750      * @return string HTML fragment
2751      */
2752     public function header() {
2753         return $this->page->heading . "\n";
2754     }
2755
2756     /**
2757      * Returns a template fragment representing a Heading.
2758      *
2759      * @param string $text The text of the heading
2760      * @param int $level The level of importance of the heading
2761      * @param string $classes A space-separated list of CSS classes
2762      * @param string $id An optional ID
2763      * @return string A template fragment for a heading
2764      */
2765     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2766         $text .= "\n";
2767         switch ($level) {
2768             case 1:
2769                 return '=>' . $text;
2770             case 2:
2771                 return '-->' . $text;
2772             default:
2773                 return $text;
2774         }
2775     }
2776
2777     /**
2778      * Returns a template fragment representing a fatal error.
2779      *
2780      * @param string $message The message to output
2781      * @param string $moreinfourl URL where more info can be found about the error
2782      * @param string $link Link for the Continue button
2783      * @param array $backtrace The execution backtrace
2784      * @param string $debuginfo Debugging information
2785      * @return string A template fragment for a fatal error
2786      */
2787     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2788         $output = "!!! $message !!!\n";
2789
2790         if (debugging('', DEBUG_DEVELOPER)) {
2791             if (!empty($debuginfo)) {
2792                 $output .= $this->notification($debuginfo, 'notifytiny');
2793             }
2794             if (!empty($backtrace)) {
2795                 $output .= $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2796             }
2797         }
2798
2799         return $output;
2800     }
2801
2802     /**
2803      * Returns a template fragment representing a notification.
2804      *
2805      * @param string $message The message to include
2806      * @param string $classes A space-separated list of CSS classes
2807      * @return string A template fragment for a notification
2808      */
2809     public function notification($message, $classes = 'notifyproblem') {
2810         $message = clean_text($message);
2811         if ($classes === 'notifysuccess') {
2812             return "++ $message ++\n";
2813         }
2814         return "!! $message !!\n";
2815     }
2816 }
2817
2818
2819 /**
2820  * A renderer that generates output for ajax scripts.
2821  *
2822  * This renderer prevents accidental sends back only json
2823  * encoded error messages, all other output is ignored.
2824  *
2825  * @copyright 2010 Petr Skoda
2826  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2827  * @since Moodle 2.0
2828  * @package core
2829  * @category output
2830  */
2831 class core_renderer_ajax extends core_renderer {
2832
2833     /**
2834      * Returns a template fragment representing a fatal error.
2835      *
2836      * @param string $message The message to output
2837      * @param string $moreinfourl URL where more info can be found about the error
2838      * @param string $link Link for the Continue button
2839      * @param array $backtrace The execution backtrace
2840      * @param string $debuginfo Debugging information
2841      * @return string A template fragment for a fatal error
2842      */
2843     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2844         global $CFG;
2845
2846         $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2847
2848         $e = new stdClass();
2849         $e->error      = $message;
2850         $e->stacktrace = NULL;
2851         $e->debuginfo  = NULL;
2852         $e->reproductionlink = NULL;
2853         if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
2854             $e->reproductionlink = $link;
2855             if (!empty($debuginfo)) {
2856                 $e->debuginfo = $debuginfo;
2857             }
2858             if (!empty($backtrace)) {
2859                 $e->stacktrace = format_backtrace($backtrace, true);
2860             }
2861         }
2862         $this->header();
2863         return json_encode($e);
2864     }
2865
2866     /**
2867      * Used to display a notification.
2868      * For the AJAX notifications are discarded.
2869      *
2870      * @param string $message
2871      * @param string $classes
2872      */
2873     public function notification($message, $classes = 'notifyproblem') {}
2874
2875     /**
2876      * Used to display a redirection message.
2877      * AJAX redirections should not occur and as such redirection messages
2878      * are discarded.
2879      *
2880      * @param moodle_url|string $encodedurl
2881      * @param string $message
2882      * @param int $delay
2883      * @param bool $debugdisableredirect
2884      */
2885     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {}
2886
2887     /**
2888      * Prepares the start of an AJAX output.
2889      */
2890     public function header() {
2891         // unfortunately YUI iframe upload does not support application/json
2892         if (!empty($_FILES)) {
2893             @header('Content-type: text/plain; charset=utf-8');
2894         } else {
2895             @header('Content-type: application/json; charset=utf-8');
2896         }
2897
2898         // Headers to make it not cacheable and json
2899         @header('Cache-Control: no-store, no-cache, must-revalidate');
2900         @header('Cache-Control: post-check=0, pre-check=0', false);
2901         @header('Pragma: no-cache');
2902         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2903         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2904         @header('Accept-Ranges: none');
2905     }
2906
2907     /**
2908      * There is no footer for an AJAX request, however we must override the
2909      * footer method to prevent the default footer.
2910      */
2911     public function footer() {}
2912
2913     /**
2914      * No need for headers in an AJAX request... this should never happen.
2915      * @param string $text
2916      * @param int $level
2917      * @param string $classes
2918      * @param string $id
2919      */
2920     public function heading($text, $level = 2, $classes = 'main', $id = null) {}
2921 }
2922
2923
2924 /**
2925  * Renderer for media files.
2926  *
2927  * Used in file resources, media filter, and any other places that need to
2928  * output embedded media.
2929  *
2930  * @copyright 2011 The Open University
2931  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2932  */
2933 class core_media_renderer extends plugin_renderer_base {
2934     /** @var array Array of available 'player' objects */
2935     private $players;
2936     /** @var string Regex pattern for links which may contain embeddable content */
2937     private $embeddablemarkers;
2938
2939     /**
2940      * Constructor requires medialib.php.
2941      *
2942      * This is needed in the constructor (not later) so that you can use the
2943      * constants and static functions that are defined in core_media class
2944      * before you call renderer functions.
2945      */
2946     public function __construct() {
2947         global $CFG;
2948         require_once($CFG->libdir . '/medialib.php');
2949     }
2950
2951     /**
2952      * Obtains the list of core_media_player objects currently in use to render
2953      * items.
2954      *
2955      * The list is in rank order (highest first) and does not include players
2956      * which are disabled.
2957      *
2958      * @return array Array of core_media_player objects in rank order
2959      */
2960     protected function get_players() {
2961         global $CFG;
2962
2963         // Save time by only building the list once.
2964         if (!$this->players) {
2965             // Get raw list of players.
2966             $players = $this->get_players_raw();
2967
2968             // Chuck all the ones that are disabled.
2969             foreach ($players as $key => $player) {
2970                 if (!$player->is_enabled()) {
2971                     unset($players[$key]);
2972                 }
2973             }
2974
2975             // Sort in rank order (highest first).
2976             usort($players, array('core_media_player', 'compare_by_rank'));
2977             $this->players = $players;
2978         }
2979         return $this->players;
2980     }
2981
2982     /**
2983      * Obtains a raw list of player objects that includes objects regardless
2984      * of whether they are disabled or not, and without sorting.
2985      *
2986      * You can override this in a subclass if you need to add additional
2987      * players.
2988      *
2989      * The return array is be indexed by player name to make it easier to
2990      * remove players in a subclass.
2991      *
2992      * @return array $players Array of core_media_player objects in any order
2993      */
2994     protected function get_players_raw() {
2995         return array(
2996             'vimeo' => new core_media_player_vimeo(),
2997             'youtube' => new core_media_player_youtube(),
2998             'youtube_playlist' => new core_media_player_youtube_playlist(),
2999             'html5video' => new core_media_player_html5video(),
3000             'html5audio' => new core_media_player_html5audio(),
3001             'mp3' => new core_media_player_mp3(),
3002             'flv' => new core_media_player_flv(),
3003             'wmp' => new core_media_player_wmp(),
3004             'qt' => new core_media_player_qt(),
3005             'rm' => new core_media_player_rm(),
3006             'swf' => new core_media_player_swf(),
3007             'link' => new core_media_player_link(),
3008         );
3009     }
3010
3011     /**
3012      * Renders a media file (audio or video) using suitable embedded player.
3013      *
3014      * See embed_alternatives function for full description of parameters.
3015      * This function calls through to that one.
3016      *
3017      * When using this function you can also specify width and height in the
3018      * URL by including ?d=100x100 at the end. If specified in the URL, this
3019      * will override the $width and $height parameters.
3020      *
3021      * @param moodle_url $url Full URL of media file
3022      * @param string $name Optional user-readable name to display in download link
3023      * @param int $width Width in pixels (optional)
3024      * @param int $height Height in pixels (optional)
3025      * @param array $options Array of key/value pairs
3026      * @return string HTML content of embed
3027      */
3028     public function embed_url(moodle_url $url, $name = '', $width = 0, $height = 0,
3029             $options = array()) {
3030
3031         // Get width and height from URL if specified (overrides parameters in
3032         // function call).
3033         $rawurl = $url->out(false);
3034         if (preg_match('/[?#]d=([\d]{1,4}%?)x([\d]{1,4}%?)/', $rawurl, $matches)) {
3035             $width = $matches[1];
3036             $height = $matches[2];
3037             $url = new moodle_url(str_replace($matches[0], '', $rawurl));
3038         }
3039
3040         // Defer to array version of function.
3041         return $this->embed_alternatives(array($url), $name, $width, $height, $options);
3042     }
3043
3044     /**
3045      * Renders media files (audio or video) using suitable embedded player.
3046      * The list of URLs should be alternative versions of the same content in
3047      * multiple formats. If there is only one format it should have a single
3048      * entry.
3049      *
3050      * If the media files are not in a supported format, this will give students
3051      * a download link to each format. The download link uses the filename
3052      * unless you supply the optional name parameter.
3053      *
3054      * Width and height are optional. If specified, these are suggested sizes
3055      * and should be the exact values supplied by the user, if they come from
3056      * user input. These will be treated as relating to the size of the video
3057      * content, not including any player control bar.
3058      *
3059      * For audio files, height will be ignored. For video files, a few formats
3060      * work if you specify only width, but in general if you specify width
3061      * you must specify height as well.
3062      *
3063      * The $options array is passed through to the core_media_player classes
3064      * that render the object tag. The keys can contain values from
3065      * core_media::OPTION_xx.
3066      *
3067      * @param array $alternatives Array of moodle_url to media files
3068      * @param string $name Optional user-readable name to display in download link
3069      * @param int $width Width in pixels (optional)
3070      * @param int $height Height in pixels (optional)
3071      * @param array $options Array of key/value pairs
3072      * @return string HTML content of embed
3073      */
3074     public function embed_alternatives($alternatives, $name = '', $width = 0, $height = 0,
3075             $options = array()) {
3076
3077         // Get list of player plugins (will also require the library).
3078         $players = $this->get_players();
3079
3080         // Set up initial text which will be replaced by first player that
3081         // supports any of the formats.
3082         $out = core_media_player::PLACEHOLDER;
3083
3084         // Loop through all players that support any of these URLs.
3085         foreach ($players as $player) {
3086             // Option: When no other player matched, don't do the default link player.
3087             if (!empty($options[core_media::OPTION_FALLBACK_TO_BLANK]) &&
3088                     $player->get_rank() === 0 && $out === core_media_player::PLACEHOLDER) {
3089                 continue;
3090             }
3091
3092             $supported = $player->list_supported_urls($alternatives, $options);
3093             if ($supported) {
3094                 // Embed.
3095                 $text = $player->embed($supported, $name, $width, $height, $options);
3096
3097                 // Put this in place of the 'fallback' slot in the previous text.
3098                 $out = str_replace(core_media_player::PLACEHOLDER, $text, $out);
3099             }
3100         }
3101
3102         // Remove 'fallback' slot from final version and return it.
3103         $out = str_replace(core_media_player::PLACEHOLDER, '', $out);
3104         if (!empty($options[core_media::OPTION_BLOCK]) && $out !== '') {
3105             $out = html_writer::tag('div', $out, array('class' => 'resourcecontent'));
3106         }
3107         return $out;
3108     }
3109
3110     /**
3111      * Checks whether a file can be embedded. If this returns true you will get
3112      * an embedded player; if this returns false, you will just get a download
3113      * link.
3114      *
3115      * This is a wrapper for can_embed_urls.
3116      *
3117      * @param moodle_url $url URL of media file
3118      * @param array $options Options (same as when embedding)
3119      * @return bool True if file can be embedded
3120      */
3121     public function can_embed_url(moodle_url $url, $options = array()) {
3122         return $this->can_embed_urls(array($url), $options);
3123     }
3124
3125     /**
3126      * Checks whether a file can be embedded. If this returns true you will get
3127      * an embedded player; if this returns false, you will just get a download
3128      * link.
3129      *
3130      * @param array $urls URL of media file and any alternatives (moodle_url)
3131      * @param array $options Options (same as when embedding)
3132      * @return bool True if file can be embedded
3133      */
3134     public function can_embed_urls(array $urls, $options = array()) {
3135         // Check all players to see if any of them support it.
3136         foreach ($this->get_players() as $player) {
3137             // Link player (always last on list) doesn't count!
3138             if ($player->get_rank() <= 0) {
3139                 break;
3140             }
3141             // First player that supports it, return true.
3142             if ($player->list_supported_urls($urls, $options)) {
3143                 return true;
3144             }
3145         }
3146         return false;
3147     }
3148
3149     /**
3150      * Obtains a list of markers that can be used in a regular expression when
3151      * searching for URLs that can be embedded by any player type.
3152      *
3153      * This string is used to improve peformance of regex matching by ensuring
3154      * that the (presumably C) regex code can do a quick keyword check on the
3155      * URL part of a link to see if it matches one of these, rather than having
3156      * to go into PHP code for every single link to see if it can be embedded.
3157      *
3158      * @return string String suitable for use in regex such as '(\.mp4|\.flv)'
3159      */
3160     public function get_embeddable_markers() {
3161         if (empty($this->embeddablemarkers)) {
3162             $markers = '';
3163             foreach ($this->get_players() as $player) {
3164                 foreach ($player->get_embeddable_markers() as $marker) {
3165                     if ($markers !== '') {
3166                         $markers .= '|';
3167                     }
3168                     $markers .= preg_quote($marker);
3169                 }
3170             }
3171             $this->embeddablemarkers = $markers;
3172         }
3173         return $this->embeddablemarkers;
3174     }
3175 }