14a3d0175c84d34391a424777b1dc56df84af983
[moodle.git] / 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/>.
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  */
38 defined('MOODLE_INTERNAL') || die();
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;
59     /**
60      * @var moodle_page The Moodle page the renderer has been created to assist with.
61      */
62     protected $page;
64     /**
65      * @var string The requested rendering target.
66      */
67     protected $target;
69     /**
70      * @var Mustache_Engine $mustache The mustache template compiler
71      */
72     private $mustache;
74     /**
75      * Return an instance of the mustache class.
76      *
77      * @since 2.9
78      * @return Mustache_Engine
79      */
80     protected function get_mustache() {
81         global $CFG;
83         if ($this->mustache === null) {
84             $themename = $this->page->theme->name;
85             $themerev = theme_get_revision();
87             $cachedir = make_localcache_directory("mustache/$themerev/$themename");
89             $loader = new \core\output\mustache_filesystem_loader();
90             $stringhelper = new \core\output\mustache_string_helper();
91             $quotehelper = new \core\output\mustache_quote_helper();
92             $jshelper = new \core\output\mustache_javascript_helper($this->page->requires);
93             $pixhelper = new \core\output\mustache_pix_helper($this);
95             // We only expose the variables that are exposed to JS templates.
96             $safeconfig = $this->page->requires->get_config_for_javascript($this->page, $this);
98             $helpers = array('config' => $safeconfig,
99                              'str' => array($stringhelper, 'str'),
100                              'quote' => array($quotehelper, 'quote'),
101                              'js' => array($jshelper, 'help'),
102                              'pix' => array($pixhelper, 'pix'));
104             $this->mustache = new Mustache_Engine(array(
105                 'cache' => $cachedir,
106                 'escape' => 's',
107                 'loader' => $loader,
108                 'helpers' => $helpers,
109                 'pragmas' => [Mustache_Engine::PRAGMA_BLOCKS]));
111         }
113         return $this->mustache;
114     }
117     /**
118      * Constructor
119      *
120      * The constructor takes two arguments. The first is the page that the renderer
121      * has been created to assist with, and the second is the target.
122      * The target is an additional identifier that can be used to load different
123      * renderers for different options.
124      *
125      * @param moodle_page $page the page we are doing output for.
126      * @param string $target one of rendering target constants
127      */
128     public function __construct(moodle_page $page, $target) {
129         $this->opencontainers = $page->opencontainers;
130         $this->page = $page;
131         $this->target = $target;
132     }
134     /**
135      * Renders a template by name with the given context.
136      *
137      * The provided data needs to be array/stdClass made up of only simple types.
138      * Simple types are array,stdClass,bool,int,float,string
139      *
140      * @since 2.9
141      * @param array|stdClass $context Context containing data for the template.
142      * @return string|boolean
143      */
144     public function render_from_template($templatename, $context) {
145         static $templatecache = array();
146         $mustache = $this->get_mustache();
148         try {
149             // Grab a copy of the existing helper to be restored later.
150             $uniqidhelper = $mustache->getHelper('uniqid');
151         } catch (Mustache_Exception_UnknownHelperException $e) {
152             // Helper doesn't exist.
153             $uniqidhelper = null;
154         }
156         // Provide 1 random value that will not change within a template
157         // but will be different from template to template. This is useful for
158         // e.g. aria attributes that only work with id attributes and must be
159         // unique in a page.
160         $mustache->addHelper('uniqid', new \core\output\mustache_uniqid_helper());
161         if (isset($templatecache[$templatename])) {
162             $template = $templatecache[$templatename];
163         } else {
164             try {
165                 $template = $mustache->loadTemplate($templatename);
166                 $templatecache[$templatename] = $template;
167             } catch (Mustache_Exception_UnknownTemplateException $e) {
168                 throw new moodle_exception('Unknown template: ' . $templatename);
169             }
170         }
172         $renderedtemplate = trim($template->render($context));
174         // If we had an existing uniqid helper then we need to restore it to allow
175         // handle nested calls of render_from_template.
176         if ($uniqidhelper) {
177             $mustache->addHelper('uniqid', $uniqidhelper);
178         }
180         return $renderedtemplate;
181     }
184     /**
185      * Returns rendered widget.
186      *
187      * The provided widget needs to be an object that extends the renderable
188      * interface.
189      * If will then be rendered by a method based upon the classname for the widget.
190      * For instance a widget of class `crazywidget` will be rendered by a protected
191      * render_crazywidget method of this renderer.
192      *
193      * @param renderable $widget instance with renderable interface
194      * @return string
195      */
196     public function render(renderable $widget) {
197         $classname = get_class($widget);
198         // Strip namespaces.
199         $classname = preg_replace('/^.*\\\/', '', $classname);
200         // Remove _renderable suffixes
201         $classname = preg_replace('/_renderable$/', '', $classname);
203         $rendermethod = 'render_'.$classname;
204         if (method_exists($this, $rendermethod)) {
205             return $this->$rendermethod($widget);
206         }
207         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
208     }
210     /**
211      * Adds a JS action for the element with the provided id.
212      *
213      * This method adds a JS event for the provided component action to the page
214      * and then returns the id that the event has been attached to.
215      * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
216      *
217      * @param component_action $action
218      * @param string $id
219      * @return string id of element, either original submitted or random new if not supplied
220      */
221     public function add_action_handler(component_action $action, $id = null) {
222         if (!$id) {
223             $id = html_writer::random_id($action->event);
224         }
225         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
226         return $id;
227     }
229     /**
230      * Returns true is output has already started, and false if not.
231      *
232      * @return boolean true if the header has been printed.
233      */
234     public function has_started() {
235         return $this->page->state >= moodle_page::STATE_IN_BODY;
236     }
238     /**
239      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
240      *
241      * @param mixed $classes Space-separated string or array of classes
242      * @return string HTML class attribute value
243      */
244     public static function prepare_classes($classes) {
245         if (is_array($classes)) {
246             return implode(' ', array_unique($classes));
247         }
248         return $classes;
249     }
251     /**
252      * Return the moodle_url for an image.
253      *
254      * The exact image location and extension is determined
255      * automatically by searching for gif|png|jpg|jpeg, please
256      * note there can not be diferent images with the different
257      * extension. The imagename is for historical reasons
258      * a relative path name, it may be changed later for core
259      * images. It is recommended to not use subdirectories
260      * in plugin and theme pix directories.
261      *
262      * There are three types of images:
263      * 1/ theme images  - stored in theme/mytheme/pix/,
264      *                    use component 'theme'
265      * 2/ core images   - stored in /pix/,
266      *                    overridden via theme/mytheme/pix_core/
267      * 3/ plugin images - stored in mod/mymodule/pix,
268      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
269      *                    example: pix_url('comment', 'mod_glossary')
270      *
271      * @param string $imagename the pathname of the image
272      * @param string $component full plugin name (aka component) or 'theme'
273      * @return moodle_url
274      */
275     public function pix_url($imagename, $component = 'moodle') {
276         return $this->page->theme->pix_url($imagename, $component);
277     }
279     /**
280      * Return the site's logo URL, if any.
281      *
282      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
283      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
284      * @return moodle_url|false
285      */
286     public function get_logo_url($maxwidth = null, $maxheight = 100) {
287         global $CFG;
288         $logo = get_config('core_admin', 'logo');
289         if (empty($logo)) {
290             return false;
291         }
293         // Hide the requested size in the file path.
294         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
296         // Use $CFG->themerev to prevent browser caching when the file changes.
297         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logo', $filepath,
298             theme_get_revision(), $logo);
299     }
301     /**
302      * Return the site's compact logo URL, if any.
303      *
304      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
305      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
306      * @return moodle_url|false
307      */
308     public function get_compact_logo_url($maxwidth = 100, $maxheight = 100) {
309         global $CFG;
310         $logo = get_config('core_admin', 'logocompact');
311         if (empty($logo)) {
312             return false;
313         }
315         // Hide the requested size in the file path.
316         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
318         // Use $CFG->themerev to prevent browser caching when the file changes.
319         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logocompact', $filepath,
320             theme_get_revision(), $logo);
321     }
326 /**
327  * Basis for all plugin renderers.
328  *
329  * @copyright Petr Skoda (skodak)
330  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
331  * @since Moodle 2.0
332  * @package core
333  * @category output
334  */
335 class plugin_renderer_base extends renderer_base {
337     /**
338      * @var renderer_base|core_renderer A reference to the current renderer.
339      * The renderer provided here will be determined by the page but will in 90%
340      * of cases by the {@link core_renderer}
341      */
342     protected $output;
344     /**
345      * Constructor method, calls the parent constructor
346      *
347      * @param moodle_page $page
348      * @param string $target one of rendering target constants
349      */
350     public function __construct(moodle_page $page, $target) {
351         if (empty($target) && $page->pagelayout === 'maintenance') {
352             // If the page is using the maintenance layout then we're going to force the target to maintenance.
353             // This way we'll get a special maintenance renderer that is designed to block access to API's that are likely
354             // unavailable for this page layout.
355             $target = RENDERER_TARGET_MAINTENANCE;
356         }
357         $this->output = $page->get_renderer('core', null, $target);
358         parent::__construct($page, $target);
359     }
361     /**
362      * Renders the provided widget and returns the HTML to display it.
363      *
364      * @param renderable $widget instance with renderable interface
365      * @return string
366      */
367     public function render(renderable $widget) {
368         $classname = get_class($widget);
369         // Strip namespaces.
370         $classname = preg_replace('/^.*\\\/', '', $classname);
371         // Keep a copy at this point, we may need to look for a deprecated method.
372         $deprecatedmethod = 'render_'.$classname;
373         // Remove _renderable suffixes
374         $classname = preg_replace('/_renderable$/', '', $classname);
376         $rendermethod = 'render_'.$classname;
377         if (method_exists($this, $rendermethod)) {
378             return $this->$rendermethod($widget);
379         }
380         if ($rendermethod !== $deprecatedmethod && method_exists($this, $deprecatedmethod)) {
381             // This is exactly where we don't want to be.
382             // If you have arrived here you have a renderable component within your plugin that has the name
383             // blah_renderable, and you have a render method render_blah_renderable on your plugin.
384             // In 2.8 we revamped output, as part of this change we changed slightly how renderables got rendered
385             // and the _renderable suffix now gets removed when looking for a render method.
386             // You need to change your renderers render_blah_renderable to render_blah.
387             // Until you do this it will not be possible for a theme to override the renderer to override your method.
388             // Please do it ASAP.
389             static $debugged = array();
390             if (!isset($debugged[$deprecatedmethod])) {
391                 debugging(sprintf('Deprecated call. Please rename your renderables render method from %s to %s.',
392                     $deprecatedmethod, $rendermethod), DEBUG_DEVELOPER);
393                 $debugged[$deprecatedmethod] = true;
394             }
395             return $this->$deprecatedmethod($widget);
396         }
397         // pass to core renderer if method not found here
398         return $this->output->render($widget);
399     }
401     /**
402      * Magic method used to pass calls otherwise meant for the standard renderer
403      * to it to ensure we don't go causing unnecessary grief.
404      *
405      * @param string $method
406      * @param array $arguments
407      * @return mixed
408      */
409     public function __call($method, $arguments) {
410         if (method_exists('renderer_base', $method)) {
411             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
412         }
413         if (method_exists($this->output, $method)) {
414             return call_user_func_array(array($this->output, $method), $arguments);
415         } else {
416             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
417         }
418     }
422 /**
423  * The standard implementation of the core_renderer interface.
424  *
425  * @copyright 2009 Tim Hunt
426  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
427  * @since Moodle 2.0
428  * @package core
429  * @category output
430  */
431 class core_renderer extends renderer_base {
432     /**
433      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
434      * in layout files instead.
435      * @deprecated
436      * @var string used in {@link core_renderer::header()}.
437      */
438     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
440     /**
441      * @var string Used to pass information from {@link core_renderer::doctype()} to
442      * {@link core_renderer::standard_head_html()}.
443      */
444     protected $contenttype;
446     /**
447      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
448      * with {@link core_renderer::header()}.
449      */
450     protected $metarefreshtag = '';
452     /**
453      * @var string Unique token for the closing HTML
454      */
455     protected $unique_end_html_token;
457     /**
458      * @var string Unique token for performance information
459      */
460     protected $unique_performance_info_token;
462     /**
463      * @var string Unique token for the main content.
464      */
465     protected $unique_main_content_token;
467     /**
468      * Constructor
469      *
470      * @param moodle_page $page the page we are doing output for.
471      * @param string $target one of rendering target constants
472      */
473     public function __construct(moodle_page $page, $target) {
474         $this->opencontainers = $page->opencontainers;
475         $this->page = $page;
476         $this->target = $target;
478         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
479         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
480         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
481     }
483     /**
484      * Get the DOCTYPE declaration that should be used with this page. Designed to
485      * be called in theme layout.php files.
486      *
487      * @return string the DOCTYPE declaration that should be used.
488      */
489     public function doctype() {
490         if ($this->page->theme->doctype === 'html5') {
491             $this->contenttype = 'text/html; charset=utf-8';
492             return "<!DOCTYPE html>\n";
494         } else if ($this->page->theme->doctype === 'xhtml5') {
495             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
496             return "<!DOCTYPE html>\n";
498         } else {
499             // legacy xhtml 1.0
500             $this->contenttype = 'text/html; charset=utf-8';
501             return ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n");
502         }
503     }
505     /**
506      * The attributes that should be added to the <html> tag. Designed to
507      * be called in theme layout.php files.
508      *
509      * @return string HTML fragment.
510      */
511     public function htmlattributes() {
512         $return = get_html_lang(true);
513         if ($this->page->theme->doctype !== 'html5') {
514             $return .= ' xmlns="http://www.w3.org/1999/xhtml"';
515         }
516         return $return;
517     }
519     /**
520      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
521      * that should be included in the <head> tag. Designed to be called in theme
522      * layout.php files.
523      *
524      * @return string HTML fragment.
525      */
526     public function standard_head_html() {
527         global $CFG, $SESSION;
529         // Before we output any content, we need to ensure that certain
530         // page components are set up.
532         // Blocks must be set up early as they may require javascript which
533         // has to be included in the page header before output is created.
534         foreach ($this->page->blocks->get_regions() as $region) {
535             $this->page->blocks->ensure_content_created($region, $this);
536         }
538         $output = '';
540         // Allow a url_rewrite plugin to setup any dynamic head content.
541         if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
542             $class = $CFG->urlrewriteclass;
543             $output .= $class::html_head_setup();
544         }
546         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
547         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
548         // This is only set by the {@link redirect()} method
549         $output .= $this->metarefreshtag;
551         // Check if a periodic refresh delay has been set and make sure we arn't
552         // already meta refreshing
553         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
554             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
555         }
557         // Smart App Banners meta tag is only displayed if mobile services are enabled and configured.
558         if (!empty($CFG->enablemobilewebservice)) {
559             $mobilesettings = get_config('tool_mobile');
560             if (!empty($mobilesettings->enablesmartappbanners) and !empty($mobilesettings->iosappid)) {
561                 $output .= '<meta name="apple-itunes-app" content="app-id=' . s($mobilesettings->iosappid) . ', ';
562                 $output .= 'app-argument=' . $this->page->url->out() . '"/>';
563             }
564         }
566         // flow player embedding support
567         $this->page->requires->js_function_call('M.util.load_flowplayer');
569         // Set up help link popups for all links with the helptooltip class
570         $this->page->requires->js_init_call('M.util.help_popups.setup');
572         // Setup help icon overlays.
573         $this->page->requires->yui_module('moodle-core-popuphelp', 'M.core.init_popuphelp');
574         $this->page->requires->strings_for_js(array(
575             'morehelp',
576             'loadinghelp',
577         ), 'moodle');
579         $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
581         $focus = $this->page->focuscontrol;
582         if (!empty($focus)) {
583             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
584                 // This is a horrifically bad way to handle focus but it is passed in
585                 // through messy formslib::moodleform
586                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
587             } else if (strpos($focus, '.')!==false) {
588                 // Old style of focus, bad way to do it
589                 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);
590                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
591             } else {
592                 // Focus element with given id
593                 $this->page->requires->js_function_call('focuscontrol', array($focus));
594             }
595         }
597         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
598         // any other custom CSS can not be overridden via themes and is highly discouraged
599         $urls = $this->page->theme->css_urls($this->page);
600         foreach ($urls as $url) {
601             $this->page->requires->css_theme($url);
602         }
604         // Get the theme javascript head and footer
605         if ($jsurl = $this->page->theme->javascript_url(true)) {
606             $this->page->requires->js($jsurl, true);
607         }
608         if ($jsurl = $this->page->theme->javascript_url(false)) {
609             $this->page->requires->js($jsurl);
610         }
612         // Get any HTML from the page_requirements_manager.
613         $output .= $this->page->requires->get_head_code($this->page, $this);
615         // List alternate versions.
616         foreach ($this->page->alternateversions as $type => $alt) {
617             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
618                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
619         }
621         if (!empty($CFG->additionalhtmlhead)) {
622             $output .= "\n".$CFG->additionalhtmlhead;
623         }
625         return $output;
626     }
628     /**
629      * The standard tags (typically skip links) that should be output just inside
630      * the start of the <body> tag. Designed to be called in theme layout.php files.
631      *
632      * @return string HTML fragment.
633      */
634     public function standard_top_of_body_html() {
635         global $CFG;
636         $output = $this->page->requires->get_top_of_body_code($this);
637         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
638             $output .= "\n".$CFG->additionalhtmltopofbody;
639         }
640         $output .= $this->maintenance_warning();
641         return $output;
642     }
644     /**
645      * Scheduled maintenance warning message.
646      *
647      * Note: This is a nasty hack to display maintenance notice, this should be moved
648      *       to some general notification area once we have it.
649      *
650      * @return string
651      */
652     public function maintenance_warning() {
653         global $CFG;
655         $output = '';
656         if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
657             $timeleft = $CFG->maintenance_later - time();
658             // If timeleft less than 30 sec, set the class on block to error to highlight.
659             $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
660             $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-a-1 alert');
661             $a = new stdClass();
662             $a->hour = (int)($timeleft / 3600);
663             $a->min = (int)(($timeleft / 60) % 60);
664             $a->sec = (int)($timeleft % 60);
665             if ($a->hour > 0) {
666                 $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
667             } else {
668                 $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
669             }
671             $output .= $this->box_end();
672             $this->page->requires->yui_module('moodle-core-maintenancemodetimer', 'M.core.maintenancemodetimer',
673                     array(array('timeleftinsec' => $timeleft)));
674             $this->page->requires->strings_for_js(
675                     array('maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'),
676                     'admin');
677         }
678         return $output;
679     }
681     /**
682      * The standard tags (typically performance information and validation links,
683      * if we are in developer debug mode) that should be output in the footer area
684      * of the page. Designed to be called in theme layout.php files.
685      *
686      * @return string HTML fragment.
687      */
688     public function standard_footer_html() {
689         global $CFG, $SCRIPT;
691         if (during_initial_install()) {
692             // Debugging info can not work before install is finished,
693             // in any case we do not want any links during installation!
694             return '';
695         }
697         // This function is normally called from a layout.php file in {@link core_renderer::header()}
698         // but some of the content won't be known until later, so we return a placeholder
699         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
700         $output = $this->unique_performance_info_token;
701         if ($this->page->devicetypeinuse == 'legacy') {
702             // The legacy theme is in use print the notification
703             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
704         }
706         // Get links to switch device types (only shown for users not on a default device)
707         $output .= $this->theme_switch_links();
709         if (!empty($CFG->debugpageinfo)) {
710             $output .= '<div class="performanceinfo pageinfo">This page is: ' . $this->page->debug_summary() . '</div>';
711         }
712         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) {  // Only in developer mode
713             // Add link to profiling report if necessary
714             if (function_exists('profiling_is_running') && profiling_is_running()) {
715                 $txt = get_string('profiledscript', 'admin');
716                 $title = get_string('profiledscriptview', 'admin');
717                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
718                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
719                 $output .= '<div class="profilingfooter">' . $link . '</div>';
720             }
721             $purgeurl = new moodle_url('/admin/purgecaches.php', array('confirm' => 1,
722                 'sesskey' => sesskey(), 'returnurl' => $this->page->url->out_as_local_url(false)));
723             $output .= '<div class="purgecaches">' .
724                     html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '</div>';
725         }
726         if (!empty($CFG->debugvalidators)) {
727             // 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
728             $output .= '<div class="validators"><ul>
729               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
730               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
731               <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>
732             </ul></div>';
733         }
734         return $output;
735     }
737     /**
738      * Returns standard main content placeholder.
739      * Designed to be called in theme layout.php files.
740      *
741      * @return string HTML fragment.
742      */
743     public function main_content() {
744         // This is here because it is the only place we can inject the "main" role over the entire main content area
745         // without requiring all theme's to manually do it, and without creating yet another thing people need to
746         // remember in the theme.
747         // This is an unfortunate hack. DO NO EVER add anything more here.
748         // DO NOT add classes.
749         // DO NOT add an id.
750         return '<div role="main">'.$this->unique_main_content_token.'</div>';
751     }
753     /**
754      * The standard tags (typically script tags that are not needed earlier) that
755      * should be output after everything else. Designed to be called in theme layout.php files.
756      *
757      * @return string HTML fragment.
758      */
759     public function standard_end_of_body_html() {
760         global $CFG;
762         // This function is normally called from a layout.php file in {@link core_renderer::header()}
763         // but some of the content won't be known until later, so we return a placeholder
764         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
765         $output = '';
766         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
767             $output .= "\n".$CFG->additionalhtmlfooter;
768         }
769         $output .= $this->unique_end_html_token;
770         return $output;
771     }
773     /**
774      * Return the standard string that says whether you are logged in (and switched
775      * roles/logged in as another user).
776      * @param bool $withlinks if false, then don't include any links in the HTML produced.
777      * If not set, the default is the nologinlinks option from the theme config.php file,
778      * and if that is not set, then links are included.
779      * @return string HTML fragment.
780      */
781     public function login_info($withlinks = null) {
782         global $USER, $CFG, $DB, $SESSION;
784         if (during_initial_install()) {
785             return '';
786         }
788         if (is_null($withlinks)) {
789             $withlinks = empty($this->page->layout_options['nologinlinks']);
790         }
792         $course = $this->page->course;
793         if (\core\session\manager::is_loggedinas()) {
794             $realuser = \core\session\manager::get_realuser();
795             $fullname = fullname($realuser, true);
796             if ($withlinks) {
797                 $loginastitle = get_string('loginas');
798                 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\"";
799                 $realuserinfo .= "title =\"".$loginastitle."\">$fullname</a>] ";
800             } else {
801                 $realuserinfo = " [$fullname] ";
802             }
803         } else {
804             $realuserinfo = '';
805         }
807         $loginpage = $this->is_login_page();
808         $loginurl = get_login_url();
810         if (empty($course->id)) {
811             // $course->id is not defined during installation
812             return '';
813         } else if (isloggedin()) {
814             $context = context_course::instance($course->id);
816             $fullname = fullname($USER, true);
817             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
818             if ($withlinks) {
819                 $linktitle = get_string('viewprofile');
820                 $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\" title=\"$linktitle\">$fullname</a>";
821             } else {
822                 $username = $fullname;
823             }
824             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
825                 if ($withlinks) {
826                     $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
827                 } else {
828                     $username .= " from {$idprovider->name}";
829                 }
830             }
831             if (isguestuser()) {
832                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
833                 if (!$loginpage && $withlinks) {
834                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
835                 }
836             } else if (is_role_switched($course->id)) { // Has switched roles
837                 $rolename = '';
838                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
839                     $rolename = ': '.role_get_name($role, $context);
840                 }
841                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename;
842                 if ($withlinks) {
843                     $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>0, 'returnurl'=>$this->page->url->out_as_local_url(false)));
844                     $loggedinas .= ' ('.html_writer::tag('a', get_string('switchrolereturn'), array('href' => $url)).')';
845                 }
846             } else {
847                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username);
848                 if ($withlinks) {
849                     $loggedinas .= " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
850                 }
851             }
852         } else {
853             $loggedinas = get_string('loggedinnot', 'moodle');
854             if (!$loginpage && $withlinks) {
855                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
856             }
857         }
859         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
861         if (isset($SESSION->justloggedin)) {
862             unset($SESSION->justloggedin);
863             if (!empty($CFG->displayloginfailures)) {
864                 if (!isguestuser()) {
865                     // Include this file only when required.
866                     require_once($CFG->dirroot . '/user/lib.php');
867                     if ($count = user_count_login_failures($USER)) {
868                         $loggedinas .= '<div class="loginfailures">';
869                         $a = new stdClass();
870                         $a->attempts = $count;
871                         $loggedinas .= get_string('failedloginattempts', '', $a);
872                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', context_system::instance())) {
873                             $loggedinas .= ' ('.html_writer::link(new moodle_url('/report/log/index.php', array('chooselog' => 1,
874                                     'id' => 0 , 'modid' => 'site_errors')), get_string('logs')).')';
875                         }
876                         $loggedinas .= '</div>';
877                     }
878                 }
879             }
880         }
882         return $loggedinas;
883     }
885     /**
886      * Check whether the current page is a login page.
887      *
888      * @since Moodle 2.9
889      * @return bool
890      */
891     protected function is_login_page() {
892         // This is a real bit of a hack, but its a rarety that we need to do something like this.
893         // In fact the login pages should be only these two pages and as exposing this as an option for all pages
894         // could lead to abuse (or at least unneedingly complex code) the hack is the way to go.
895         return in_array(
896             $this->page->url->out_as_local_url(false, array()),
897             array(
898                 '/login/index.php',
899                 '/login/forgot_password.php',
900             )
901         );
902     }
904     /**
905      * Return the 'back' link that normally appears in the footer.
906      *
907      * @return string HTML fragment.
908      */
909     public function home_link() {
910         global $CFG, $SITE;
912         if ($this->page->pagetype == 'site-index') {
913             // Special case for site home page - please do not remove
914             return '<div class="sitelink">' .
915                    '<a title="Moodle" href="http://moodle.org/">' .
916                    '<img src="' . $this->pix_url('moodlelogo') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
918         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
919             // Special case for during install/upgrade.
920             return '<div class="sitelink">'.
921                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
922                    '<img src="' . $this->pix_url('moodlelogo') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
924         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
925             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
926                     get_string('home') . '</a></div>';
928         } else {
929             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
930                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
931         }
932     }
934     /**
935      * Redirects the user by any means possible given the current state
936      *
937      * This function should not be called directly, it should always be called using
938      * the redirect function in lib/weblib.php
939      *
940      * The redirect function should really only be called before page output has started
941      * however it will allow itself to be called during the state STATE_IN_BODY
942      *
943      * @param string $encodedurl The URL to send to encoded if required
944      * @param string $message The message to display to the user if any
945      * @param int $delay The delay before redirecting a user, if $message has been
946      *         set this is a requirement and defaults to 3, set to 0 no delay
947      * @param boolean $debugdisableredirect this redirect has been disabled for
948      *         debugging purposes. Display a message that explains, and don't
949      *         trigger the redirect.
950      * @param string $messagetype The type of notification to show the message in.
951      *         See constants on \core\output\notification.
952      * @return string The HTML to display to the user before dying, may contain
953      *         meta refresh, javascript refresh, and may have set header redirects
954      */
955     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect,
956                                      $messagetype = \core\output\notification::NOTIFY_INFO) {
957         global $CFG;
958         $url = str_replace('&amp;', '&', $encodedurl);
960         switch ($this->page->state) {
961             case moodle_page::STATE_BEFORE_HEADER :
962                 // No output yet it is safe to delivery the full arsenal of redirect methods
963                 if (!$debugdisableredirect) {
964                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
965                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
966                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
967                 }
968                 $output = $this->header();
969                 break;
970             case moodle_page::STATE_PRINTING_HEADER :
971                 // We should hopefully never get here
972                 throw new coding_exception('You cannot redirect while printing the page header');
973                 break;
974             case moodle_page::STATE_IN_BODY :
975                 // We really shouldn't be here but we can deal with this
976                 debugging("You should really redirect before you start page output");
977                 if (!$debugdisableredirect) {
978                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
979                 }
980                 $output = $this->opencontainers->pop_all_but_last();
981                 break;
982             case moodle_page::STATE_DONE :
983                 // Too late to be calling redirect now
984                 throw new coding_exception('You cannot redirect after the entire page has been generated');
985                 break;
986         }
987         $output .= $this->notification($message, $messagetype);
988         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
989         if ($debugdisableredirect) {
990             $output .= '<p><strong>'.get_string('erroroutput', 'error').'</strong></p>';
991         }
992         $output .= $this->footer();
993         return $output;
994     }
996     /**
997      * Start output by sending the HTTP headers, and printing the HTML <head>
998      * and the start of the <body>.
999      *
1000      * To control what is printed, you should set properties on $PAGE. If you
1001      * are familiar with the old {@link print_header()} function from Moodle 1.9
1002      * you will find that there are properties on $PAGE that correspond to most
1003      * of the old parameters to could be passed to print_header.
1004      *
1005      * Not that, in due course, the remaining $navigation, $menu parameters here
1006      * will be replaced by more properties of $PAGE, but that is still to do.
1007      *
1008      * @return string HTML that you must output this, preferably immediately.
1009      */
1010     public function header() {
1011         global $USER, $CFG;
1013         if (\core\session\manager::is_loggedinas()) {
1014             $this->page->add_body_class('userloggedinas');
1015         }
1017         // If the user is logged in, and we're not in initial install,
1018         // check to see if the user is role-switched and add the appropriate
1019         // CSS class to the body element.
1020         if (!during_initial_install() && isloggedin() && is_role_switched($this->page->course->id)) {
1021             $this->page->add_body_class('userswitchedrole');
1022         }
1024         // Give themes a chance to init/alter the page object.
1025         $this->page->theme->init_page($this->page);
1027         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
1029         // Find the appropriate page layout file, based on $this->page->pagelayout.
1030         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
1031         // Render the layout using the layout file.
1032         $rendered = $this->render_page_layout($layoutfile);
1034         // Slice the rendered output into header and footer.
1035         $cutpos = strpos($rendered, $this->unique_main_content_token);
1036         if ($cutpos === false) {
1037             $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
1038             $token = self::MAIN_CONTENT_TOKEN;
1039         } else {
1040             $token = $this->unique_main_content_token;
1041         }
1043         if ($cutpos === false) {
1044             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.');
1045         }
1046         $header = substr($rendered, 0, $cutpos);
1047         $footer = substr($rendered, $cutpos + strlen($token));
1049         if (empty($this->contenttype)) {
1050             debugging('The page layout file did not call $OUTPUT->doctype()');
1051             $header = $this->doctype() . $header;
1052         }
1054         // If this theme version is below 2.4 release and this is a course view page
1055         if ((!isset($this->page->theme->settings->version) || $this->page->theme->settings->version < 2012101500) &&
1056                 $this->page->pagelayout === 'course' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
1057             // check if course content header/footer have not been output during render of theme layout
1058             $coursecontentheader = $this->course_content_header(true);
1059             $coursecontentfooter = $this->course_content_footer(true);
1060             if (!empty($coursecontentheader)) {
1061                 // display debug message and add header and footer right above and below main content
1062                 // Please note that course header and footer (to be displayed above and below the whole page)
1063                 // are not displayed in this case at all.
1064                 // Besides the content header and footer are not displayed on any other course page
1065                 debugging('The current theme is not optimised for 2.4, the course-specific header and footer defined in course format will not be output', DEBUG_DEVELOPER);
1066                 $header .= $coursecontentheader;
1067                 $footer = $coursecontentfooter. $footer;
1068             }
1069         }
1071         send_headers($this->contenttype, $this->page->cacheable);
1073         $this->opencontainers->push('header/footer', $footer);
1074         $this->page->set_state(moodle_page::STATE_IN_BODY);
1076         return $header . $this->skip_link_target('maincontent');
1077     }
1079     /**
1080      * Renders and outputs the page layout file.
1081      *
1082      * This is done by preparing the normal globals available to a script, and
1083      * then including the layout file provided by the current theme for the
1084      * requested layout.
1085      *
1086      * @param string $layoutfile The name of the layout file
1087      * @return string HTML code
1088      */
1089     protected function render_page_layout($layoutfile) {
1090         global $CFG, $SITE, $USER;
1091         // The next lines are a bit tricky. The point is, here we are in a method
1092         // of a renderer class, and this object may, or may not, be the same as
1093         // the global $OUTPUT object. When rendering the page layout file, we want to use
1094         // this object. However, people writing Moodle code expect the current
1095         // renderer to be called $OUTPUT, not $this, so define a variable called
1096         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
1097         $OUTPUT = $this;
1098         $PAGE = $this->page;
1099         $COURSE = $this->page->course;
1101         ob_start();
1102         include($layoutfile);
1103         $rendered = ob_get_contents();
1104         ob_end_clean();
1105         return $rendered;
1106     }
1108     /**
1109      * Outputs the page's footer
1110      *
1111      * @return string HTML fragment
1112      */
1113     public function footer() {
1114         global $CFG, $DB, $PAGE;
1116         $output = $this->container_end_all(true);
1118         $footer = $this->opencontainers->pop('header/footer');
1120         if (debugging() and $DB and $DB->is_transaction_started()) {
1121             // TODO: MDL-20625 print warning - transaction will be rolled back
1122         }
1124         // Provide some performance info if required
1125         $performanceinfo = '';
1126         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
1127             $perf = get_performance_info();
1128             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
1129                 $performanceinfo = $perf['html'];
1130             }
1131         }
1133         // We always want performance data when running a performance test, even if the user is redirected to another page.
1134         if (MDL_PERF_TEST && strpos($footer, $this->unique_performance_info_token) === false) {
1135             $footer = $this->unique_performance_info_token . $footer;
1136         }
1137         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
1139         // Only show notifications when we have a $PAGE context id.
1140         if (!empty($PAGE->context->id)) {
1141             $this->page->requires->js_call_amd('core/notification', 'init', array(
1142                 $PAGE->context->id,
1143                 \core\notification::fetch_as_array($this)
1144             ));
1145         }
1146         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
1148         $this->page->set_state(moodle_page::STATE_DONE);
1150         return $output . $footer;
1151     }
1153     /**
1154      * Close all but the last open container. This is useful in places like error
1155      * handling, where you want to close all the open containers (apart from <body>)
1156      * before outputting the error message.
1157      *
1158      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1159      *      developer debug warning if it isn't.
1160      * @return string the HTML required to close any open containers inside <body>.
1161      */
1162     public function container_end_all($shouldbenone = false) {
1163         return $this->opencontainers->pop_all_but_last($shouldbenone);
1164     }
1166     /**
1167      * Returns course-specific information to be output immediately above content on any course page
1168      * (for the current course)
1169      *
1170      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1171      * @return string
1172      */
1173     public function course_content_header($onlyifnotcalledbefore = false) {
1174         global $CFG;
1175         static $functioncalled = false;
1176         if ($functioncalled && $onlyifnotcalledbefore) {
1177             // we have already output the content header
1178             return '';
1179         }
1181         // Output any session notification.
1182         $notifications = \core\notification::fetch();
1184         $bodynotifications = '';
1185         foreach ($notifications as $notification) {
1186             $bodynotifications .= $this->render_from_template(
1187                     $notification->get_template_name(),
1188                     $notification->export_for_template($this)
1189                 );
1190         }
1192         $output = html_writer::span($bodynotifications, 'notifications', array('id' => 'user-notifications'));
1194         if ($this->page->course->id == SITEID) {
1195             // return immediately and do not include /course/lib.php if not necessary
1196             return $output;
1197         }
1199         require_once($CFG->dirroot.'/course/lib.php');
1200         $functioncalled = true;
1201         $courseformat = course_get_format($this->page->course);
1202         if (($obj = $courseformat->course_content_header()) !== null) {
1203             $output .= html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-header');
1204         }
1205         return $output;
1206     }
1208     /**
1209      * Returns course-specific information to be output immediately below content on any course page
1210      * (for the current course)
1211      *
1212      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1213      * @return string
1214      */
1215     public function course_content_footer($onlyifnotcalledbefore = false) {
1216         global $CFG;
1217         if ($this->page->course->id == SITEID) {
1218             // return immediately and do not include /course/lib.php if not necessary
1219             return '';
1220         }
1221         static $functioncalled = false;
1222         if ($functioncalled && $onlyifnotcalledbefore) {
1223             // we have already output the content footer
1224             return '';
1225         }
1226         $functioncalled = true;
1227         require_once($CFG->dirroot.'/course/lib.php');
1228         $courseformat = course_get_format($this->page->course);
1229         if (($obj = $courseformat->course_content_footer()) !== null) {
1230             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-footer');
1231         }
1232         return '';
1233     }
1235     /**
1236      * Returns course-specific information to be output on any course page in the header area
1237      * (for the current course)
1238      *
1239      * @return string
1240      */
1241     public function course_header() {
1242         global $CFG;
1243         if ($this->page->course->id == SITEID) {
1244             // return immediately and do not include /course/lib.php if not necessary
1245             return '';
1246         }
1247         require_once($CFG->dirroot.'/course/lib.php');
1248         $courseformat = course_get_format($this->page->course);
1249         if (($obj = $courseformat->course_header()) !== null) {
1250             return $courseformat->get_renderer($this->page)->render($obj);
1251         }
1252         return '';
1253     }
1255     /**
1256      * Returns course-specific information to be output on any course page in the footer area
1257      * (for the current course)
1258      *
1259      * @return string
1260      */
1261     public function course_footer() {
1262         global $CFG;
1263         if ($this->page->course->id == SITEID) {
1264             // return immediately and do not include /course/lib.php if not necessary
1265             return '';
1266         }
1267         require_once($CFG->dirroot.'/course/lib.php');
1268         $courseformat = course_get_format($this->page->course);
1269         if (($obj = $courseformat->course_footer()) !== null) {
1270             return $courseformat->get_renderer($this->page)->render($obj);
1271         }
1272         return '';
1273     }
1275     /**
1276      * Returns lang menu or '', this method also checks forcing of languages in courses.
1277      *
1278      * This function calls {@link core_renderer::render_single_select()} to actually display the language menu.
1279      *
1280      * @return string The lang menu HTML or empty string
1281      */
1282     public function lang_menu() {
1283         global $CFG;
1285         if (empty($CFG->langmenu)) {
1286             return '';
1287         }
1289         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
1290             // do not show lang menu if language forced
1291             return '';
1292         }
1294         $currlang = current_language();
1295         $langs = get_string_manager()->get_list_of_translations();
1297         if (count($langs) < 2) {
1298             return '';
1299         }
1301         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
1302         $s->label = get_accesshide(get_string('language'));
1303         $s->class = 'langmenu';
1304         return $this->render($s);
1305     }
1307     /**
1308      * Output the row of editing icons for a block, as defined by the controls array.
1309      *
1310      * @param array $controls an array like {@link block_contents::$controls}.
1311      * @param string $blockid The ID given to the block.
1312      * @return string HTML fragment.
1313      */
1314     public function block_controls($actions, $blockid = null) {
1315         global $CFG;
1316         if (empty($actions)) {
1317             return '';
1318         }
1319         $menu = new action_menu($actions);
1320         if ($blockid !== null) {
1321             $menu->set_owner_selector('#'.$blockid);
1322         }
1323         $menu->set_constraint('.block-region');
1324         $menu->attributes['class'] .= ' block-control-actions commands';
1325         return $this->render($menu);
1326     }
1328     /**
1329      * Renders an action menu component.
1330      *
1331      * ARIA references:
1332      *   - http://www.w3.org/WAI/GL/wiki/Using_ARIA_menus
1333      *   - http://stackoverflow.com/questions/12279113/recommended-wai-aria-implementation-for-navigation-bar-menu
1334      *
1335      * @param action_menu $menu
1336      * @return string HTML
1337      */
1338     public function render_action_menu(action_menu $menu) {
1339         $context = $menu->export_for_template($this);
1340         return $this->render_from_template('core/action_menu', $context);
1341     }
1343     /**
1344      * Renders an action_menu_link item.
1345      *
1346      * @param action_menu_link $action
1347      * @return string HTML fragment
1348      */
1349     protected function render_action_menu_link(action_menu_link $action) {
1350         return $this->render_from_template('core/action_menu_link', $action->export_for_template($this));
1351     }
1353     /**
1354      * Renders a primary action_menu_filler item.
1355      *
1356      * @param action_menu_link_filler $action
1357      * @return string HTML fragment
1358      */
1359     protected function render_action_menu_filler(action_menu_filler $action) {
1360         return html_writer::span('&nbsp;', 'filler');
1361     }
1363     /**
1364      * Renders a primary action_menu_link item.
1365      *
1366      * @param action_menu_link_primary $action
1367      * @return string HTML fragment
1368      */
1369     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1370         return $this->render_action_menu_link($action);
1371     }
1373     /**
1374      * Renders a secondary action_menu_link item.
1375      *
1376      * @param action_menu_link_secondary $action
1377      * @return string HTML fragment
1378      */
1379     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1380         return $this->render_action_menu_link($action);
1381     }
1383     /**
1384      * Prints a nice side block with an optional header.
1385      *
1386      * The content is described
1387      * by a {@link core_renderer::block_contents} object.
1388      *
1389      * <div id="inst{$instanceid}" class="block_{$blockname} block">
1390      *      <div class="header"></div>
1391      *      <div class="content">
1392      *          ...CONTENT...
1393      *          <div class="footer">
1394      *          </div>
1395      *      </div>
1396      *      <div class="annotation">
1397      *      </div>
1398      * </div>
1399      *
1400      * @param block_contents $bc HTML for the content
1401      * @param string $region the region the block is appearing in.
1402      * @return string the HTML to be output.
1403      */
1404     public function block(block_contents $bc, $region) {
1405         $bc = clone($bc); // Avoid messing up the object passed in.
1406         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1407             $bc->collapsible = block_contents::NOT_HIDEABLE;
1408         }
1409         if (!empty($bc->blockinstanceid)) {
1410             $bc->attributes['data-instanceid'] = $bc->blockinstanceid;
1411         }
1412         $skiptitle = strip_tags($bc->title);
1413         if ($bc->blockinstanceid && !empty($skiptitle)) {
1414             $bc->attributes['aria-labelledby'] = 'instance-'.$bc->blockinstanceid.'-header';
1415         } else if (!empty($bc->arialabel)) {
1416             $bc->attributes['aria-label'] = $bc->arialabel;
1417         }
1418         if ($bc->dockable) {
1419             $bc->attributes['data-dockable'] = 1;
1420         }
1421         if ($bc->collapsible == block_contents::HIDDEN) {
1422             $bc->add_class('hidden');
1423         }
1424         if (!empty($bc->controls)) {
1425             $bc->add_class('block_with_controls');
1426         }
1429         if (empty($skiptitle)) {
1430             $output = '';
1431             $skipdest = '';
1432         } else {
1433             $output = html_writer::link('#sb-'.$bc->skipid, get_string('skipa', 'access', $skiptitle),
1434                       array('class' => 'skip skip-block', 'id' => 'fsb-' . $bc->skipid));
1435             $skipdest = html_writer::span('', 'skip-block-to',
1436                       array('id' => 'sb-' . $bc->skipid));
1437         }
1439         $output .= html_writer::start_tag('div', $bc->attributes);
1441         $output .= $this->block_header($bc);
1442         $output .= $this->block_content($bc);
1444         $output .= html_writer::end_tag('div');
1446         $output .= $this->block_annotation($bc);
1448         $output .= $skipdest;
1450         $this->init_block_hider_js($bc);
1451         return $output;
1452     }
1454     /**
1455      * Produces a header for a block
1456      *
1457      * @param block_contents $bc
1458      * @return string
1459      */
1460     protected function block_header(block_contents $bc) {
1462         $title = '';
1463         if ($bc->title) {
1464             $attributes = array();
1465             if ($bc->blockinstanceid) {
1466                 $attributes['id'] = 'instance-'.$bc->blockinstanceid.'-header';
1467             }
1468             $title = html_writer::tag('h2', $bc->title, $attributes);
1469         }
1471         $blockid = null;
1472         if (isset($bc->attributes['id'])) {
1473             $blockid = $bc->attributes['id'];
1474         }
1475         $controlshtml = $this->block_controls($bc->controls, $blockid);
1477         $output = '';
1478         if ($title || $controlshtml) {
1479             $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'));
1480         }
1481         return $output;
1482     }
1484     /**
1485      * Produces the content area for a block
1486      *
1487      * @param block_contents $bc
1488      * @return string
1489      */
1490     protected function block_content(block_contents $bc) {
1491         $output = html_writer::start_tag('div', array('class' => 'content'));
1492         if (!$bc->title && !$this->block_controls($bc->controls)) {
1493             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
1494         }
1495         $output .= $bc->content;
1496         $output .= $this->block_footer($bc);
1497         $output .= html_writer::end_tag('div');
1499         return $output;
1500     }
1502     /**
1503      * Produces the footer for a block
1504      *
1505      * @param block_contents $bc
1506      * @return string
1507      */
1508     protected function block_footer(block_contents $bc) {
1509         $output = '';
1510         if ($bc->footer) {
1511             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
1512         }
1513         return $output;
1514     }
1516     /**
1517      * Produces the annotation for a block
1518      *
1519      * @param block_contents $bc
1520      * @return string
1521      */
1522     protected function block_annotation(block_contents $bc) {
1523         $output = '';
1524         if ($bc->annotation) {
1525             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
1526         }
1527         return $output;
1528     }
1530     /**
1531      * Calls the JS require function to hide a block.
1532      *
1533      * @param block_contents $bc A block_contents object
1534      */
1535     protected function init_block_hider_js(block_contents $bc) {
1536         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
1537             $config = new stdClass;
1538             $config->id = $bc->attributes['id'];
1539             $config->title = strip_tags($bc->title);
1540             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1541             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1542             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1544             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1545             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1546         }
1547     }
1549     /**
1550      * Render the contents of a block_list.
1551      *
1552      * @param array $icons the icon for each item.
1553      * @param array $items the content of each item.
1554      * @return string HTML
1555      */
1556     public function list_block_contents($icons, $items) {
1557         $row = 0;
1558         $lis = array();
1559         foreach ($items as $key => $string) {
1560             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1561             if (!empty($icons[$key])) { //test if the content has an assigned icon
1562                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1563             }
1564             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1565             $item .= html_writer::end_tag('li');
1566             $lis[] = $item;
1567             $row = 1 - $row; // Flip even/odd.
1568         }
1569         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1570     }
1572     /**
1573      * Output all the blocks in a particular region.
1574      *
1575      * @param string $region the name of a region on this page.
1576      * @return string the HTML to be output.
1577      */
1578     public function blocks_for_region($region) {
1579         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1580         $blocks = $this->page->blocks->get_blocks_for_region($region);
1581         $lastblock = null;
1582         $zones = array();
1583         foreach ($blocks as $block) {
1584             $zones[] = $block->title;
1585         }
1586         $output = '';
1588         foreach ($blockcontents as $bc) {
1589             if ($bc instanceof block_contents) {
1590                 $output .= $this->block($bc, $region);
1591                 $lastblock = $bc->title;
1592             } else if ($bc instanceof block_move_target) {
1593                 $output .= $this->block_move_target($bc, $zones, $lastblock, $region);
1594             } else {
1595                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1596             }
1597         }
1598         return $output;
1599     }
1601     /**
1602      * Output a place where the block that is currently being moved can be dropped.
1603      *
1604      * @param block_move_target $target with the necessary details.
1605      * @param array $zones array of areas where the block can be moved to
1606      * @param string $previous the block located before the area currently being rendered.
1607      * @param string $region the name of the region
1608      * @return string the HTML to be output.
1609      */
1610     public function block_move_target($target, $zones, $previous, $region) {
1611         if ($previous == null) {
1612             if (empty($zones)) {
1613                 // There are no zones, probably because there are no blocks.
1614                 $regions = $this->page->theme->get_all_block_regions();
1615                 $position = get_string('moveblockinregion', 'block', $regions[$region]);
1616             } else {
1617                 $position = get_string('moveblockbefore', 'block', $zones[0]);
1618             }
1619         } else {
1620             $position = get_string('moveblockafter', 'block', $previous);
1621         }
1622         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1623     }
1625     /**
1626      * Renders a special html link with attached action
1627      *
1628      * Theme developers: DO NOT OVERRIDE! Please override function
1629      * {@link core_renderer::render_action_link()} instead.
1630      *
1631      * @param string|moodle_url $url
1632      * @param string $text HTML fragment
1633      * @param component_action $action
1634      * @param array $attributes associative array of html link attributes + disabled
1635      * @param pix_icon optional pix icon to render with the link
1636      * @return string HTML fragment
1637      */
1638     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1639         if (!($url instanceof moodle_url)) {
1640             $url = new moodle_url($url);
1641         }
1642         $link = new action_link($url, $text, $action, $attributes, $icon);
1644         return $this->render($link);
1645     }
1647     /**
1648      * Renders an action_link object.
1649      *
1650      * The provided link is renderer and the HTML returned. At the same time the
1651      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1652      *
1653      * @param action_link $link
1654      * @return string HTML fragment
1655      */
1656     protected function render_action_link(action_link $link) {
1657         return $this->render_from_template('core/action_link', $link->export_for_template($this));
1658     }
1660     /**
1661      * Renders an action_icon.
1662      *
1663      * This function uses the {@link core_renderer::action_link()} method for the
1664      * most part. What it does different is prepare the icon as HTML and use it
1665      * as the link text.
1666      *
1667      * Theme developers: If you want to change how action links and/or icons are rendered,
1668      * consider overriding function {@link core_renderer::render_action_link()} and
1669      * {@link core_renderer::render_pix_icon()}.
1670      *
1671      * @param string|moodle_url $url A string URL or moodel_url
1672      * @param pix_icon $pixicon
1673      * @param component_action $action
1674      * @param array $attributes associative array of html link attributes + disabled
1675      * @param bool $linktext show title next to image in link
1676      * @return string HTML fragment
1677      */
1678     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1679         if (!($url instanceof moodle_url)) {
1680             $url = new moodle_url($url);
1681         }
1682         $attributes = (array)$attributes;
1684         if (empty($attributes['class'])) {
1685             // let ppl override the class via $options
1686             $attributes['class'] = 'action-icon';
1687         }
1689         $icon = $this->render($pixicon);
1691         if ($linktext) {
1692             $text = $pixicon->attributes['alt'];
1693         } else {
1694             $text = '';
1695         }
1697         return $this->action_link($url, $text.$icon, $action, $attributes);
1698     }
1700    /**
1701     * Print a message along with button choices for Continue/Cancel
1702     *
1703     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1704     *
1705     * @param string $message The question to ask the user
1706     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1707     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1708     * @return string HTML fragment
1709     */
1710     public function confirm($message, $continue, $cancel) {
1711         if ($continue instanceof single_button) {
1712             // ok
1713         } else if (is_string($continue)) {
1714             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1715         } else if ($continue instanceof moodle_url) {
1716             $continue = new single_button($continue, get_string('continue'), 'post');
1717         } else {
1718             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1719         }
1721         if ($cancel instanceof single_button) {
1722             // ok
1723         } else if (is_string($cancel)) {
1724             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1725         } else if ($cancel instanceof moodle_url) {
1726             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1727         } else {
1728             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1729         }
1731         $output = $this->box_start('generalbox', 'notice');
1732         $output .= html_writer::tag('p', $message);
1733         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1734         $output .= $this->box_end();
1735         return $output;
1736     }
1738     /**
1739      * Returns a form with a single button.
1740      *
1741      * Theme developers: DO NOT OVERRIDE! Please override function
1742      * {@link core_renderer::render_single_button()} instead.
1743      *
1744      * @param string|moodle_url $url
1745      * @param string $label button text
1746      * @param string $method get or post submit method
1747      * @param array $options associative array {disabled, title, etc.}
1748      * @return string HTML fragment
1749      */
1750     public function single_button($url, $label, $method='post', array $options=null) {
1751         if (!($url instanceof moodle_url)) {
1752             $url = new moodle_url($url);
1753         }
1754         $button = new single_button($url, $label, $method);
1756         foreach ((array)$options as $key=>$value) {
1757             if (array_key_exists($key, $button)) {
1758                 $button->$key = $value;
1759             }
1760         }
1762         return $this->render($button);
1763     }
1765     /**
1766      * Renders a single button widget.
1767      *
1768      * This will return HTML to display a form containing a single button.
1769      *
1770      * @param single_button $button
1771      * @return string HTML fragment
1772      */
1773     protected function render_single_button(single_button $button) {
1774         $attributes = array('type'     => 'submit',
1775                             'value'    => $button->label,
1776                             'disabled' => $button->disabled ? 'disabled' : null,
1777                             'title'    => $button->tooltip);
1779         if ($button->actions) {
1780             $id = html_writer::random_id('single_button');
1781             $attributes['id'] = $id;
1782             foreach ($button->actions as $action) {
1783                 $this->add_action_handler($action, $id);
1784             }
1785         }
1787         // first the input element
1788         $output = html_writer::empty_tag('input', $attributes);
1790         // then hidden fields
1791         $params = $button->url->params();
1792         if ($button->method === 'post') {
1793             $params['sesskey'] = sesskey();
1794         }
1795         foreach ($params as $var => $val) {
1796             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1797         }
1799         // then div wrapper for xhtml strictness
1800         $output = html_writer::tag('div', $output);
1802         // now the form itself around it
1803         if ($button->method === 'get') {
1804             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
1805         } else {
1806             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
1807         }
1808         if ($url === '') {
1809             $url = '#'; // there has to be always some action
1810         }
1811         $attributes = array('method' => $button->method,
1812                             'action' => $url,
1813                             'id'     => $button->formid);
1814         $output = html_writer::tag('form', $output, $attributes);
1816         // and finally one more wrapper with class
1817         return html_writer::tag('div', $output, array('class' => $button->class));
1818     }
1820     /**
1821      * Returns a form with a single select widget.
1822      *
1823      * Theme developers: DO NOT OVERRIDE! Please override function
1824      * {@link core_renderer::render_single_select()} instead.
1825      *
1826      * @param moodle_url $url form action target, includes hidden fields
1827      * @param string $name name of selection field - the changing parameter in url
1828      * @param array $options list of options
1829      * @param string $selected selected element
1830      * @param array $nothing
1831      * @param string $formid
1832      * @param array $attributes other attributes for the single select
1833      * @return string HTML fragment
1834      */
1835     public function single_select($url, $name, array $options, $selected = '',
1836                                 $nothing = array('' => 'choosedots'), $formid = null, $attributes = array()) {
1837         if (!($url instanceof moodle_url)) {
1838             $url = new moodle_url($url);
1839         }
1840         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1842         if (array_key_exists('label', $attributes)) {
1843             $select->set_label($attributes['label']);
1844             unset($attributes['label']);
1845         }
1846         $select->attributes = $attributes;
1848         return $this->render($select);
1849     }
1851     /**
1852      * Returns a dataformat selection and download form
1853      *
1854      * @param string $label A text label
1855      * @param moodle_url|string $base The download page url
1856      * @param string $name The query param which will hold the type of the download
1857      * @param array $params Extra params sent to the download page
1858      * @return string HTML fragment
1859      */
1860     public function download_dataformat_selector($label, $base, $name = 'dataformat', $params = array()) {
1862         $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
1863         $options = array();
1864         foreach ($formats as $format) {
1865             if ($format->is_enabled()) {
1866                 $options[] = array(
1867                     'value' => $format->name,
1868                     'label' => get_string('dataformat', $format->component),
1869                 );
1870             }
1871         }
1872         $hiddenparams = array();
1873         foreach ($params as $key => $value) {
1874             $hiddenparams[] = array(
1875                 'name' => $key,
1876                 'value' => $value,
1877             );
1878         }
1879         $data = array(
1880             'label' => $label,
1881             'base' => $base,
1882             'name' => $name,
1883             'params' => $hiddenparams,
1884             'options' => $options,
1885             'sesskey' => sesskey(),
1886             'submit' => get_string('download'),
1887         );
1889         return $this->render_from_template('core/dataformat_selector', $data);
1890     }
1893     /**
1894      * Internal implementation of single_select rendering
1895      *
1896      * @param single_select $select
1897      * @return string HTML fragment
1898      */
1899     protected function render_single_select(single_select $select) {
1900         $select = clone($select);
1901         if (empty($select->formid)) {
1902             $select->formid = html_writer::random_id('single_select_f');
1903         }
1905         $output = '';
1906         $params = $select->url->params();
1907         if ($select->method === 'post') {
1908             $params['sesskey'] = sesskey();
1909         }
1910         foreach ($params as $name=>$value) {
1911             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1912         }
1914         if (empty($select->attributes['id'])) {
1915             $select->attributes['id'] = html_writer::random_id('single_select');
1916         }
1918         if ($select->disabled) {
1919             $select->attributes['disabled'] = 'disabled';
1920         }
1922         if ($select->tooltip) {
1923             $select->attributes['title'] = $select->tooltip;
1924         }
1926         $select->attributes['class'] = 'autosubmit';
1927         if ($select->class) {
1928             $select->attributes['class'] .= ' ' . $select->class;
1929         }
1931         if ($select->label) {
1932             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1933         }
1935         if ($select->helpicon instanceof help_icon) {
1936             $output .= $this->render($select->helpicon);
1937         }
1938         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1940         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1941         $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('class' => 'inline'));
1943         $nothing = empty($select->nothing) ? false : key($select->nothing);
1944         $this->page->requires->yui_module('moodle-core-formautosubmit',
1945             'M.core.init_formautosubmit',
1946             array(array('selectid' => $select->attributes['id'], 'nothing' => $nothing))
1947         );
1949         // then div wrapper for xhtml strictness
1950         $output = html_writer::tag('div', $output);
1952         // now the form itself around it
1953         if ($select->method === 'get') {
1954             $url = $select->url->out_omit_querystring(true); // url without params, the anchor part allowed
1955         } else {
1956             $url = $select->url->out_omit_querystring();     // url without params, the anchor part not allowed
1957         }
1958         $formattributes = array('method' => $select->method,
1959                                 'action' => $url,
1960                                 'id'     => $select->formid);
1961         $output = html_writer::tag('form', $output, $formattributes);
1963         // and finally one more wrapper with class
1964         return html_writer::tag('div', $output, array('class' => $select->class));
1965     }
1967     /**
1968      * Returns a form with a url select widget.
1969      *
1970      * Theme developers: DO NOT OVERRIDE! Please override function
1971      * {@link core_renderer::render_url_select()} instead.
1972      *
1973      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1974      * @param string $selected selected element
1975      * @param array $nothing
1976      * @param string $formid
1977      * @return string HTML fragment
1978      */
1979     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
1980         $select = new url_select($urls, $selected, $nothing, $formid);
1981         return $this->render($select);
1982     }
1984     /**
1985      * Internal implementation of url_select rendering
1986      *
1987      * @param url_select $select
1988      * @return string HTML fragment
1989      */
1990     protected function render_url_select(url_select $select) {
1991         global $CFG;
1993         $select = clone($select);
1994         if (empty($select->formid)) {
1995             $select->formid = html_writer::random_id('url_select_f');
1996         }
1998         if (empty($select->attributes['id'])) {
1999             $select->attributes['id'] = html_writer::random_id('url_select');
2000         }
2002         if ($select->disabled) {
2003             $select->attributes['disabled'] = 'disabled';
2004         }
2006         if ($select->tooltip) {
2007             $select->attributes['title'] = $select->tooltip;
2008         }
2010         $output = '';
2012         if ($select->label) {
2013             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
2014         }
2016         $classes = array();
2017         if (!$select->showbutton) {
2018             $classes[] = 'autosubmit';
2019         }
2020         if ($select->class) {
2021             $classes[] = $select->class;
2022         }
2023         if (count($classes)) {
2024             $select->attributes['class'] = implode(' ', $classes);
2025         }
2027         if ($select->helpicon instanceof help_icon) {
2028             $output .= $this->render($select->helpicon);
2029         }
2031         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
2032         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
2033         $urls = array();
2034         foreach ($select->urls as $k=>$v) {
2035             if (is_array($v)) {
2036                 // optgroup structure
2037                 foreach ($v as $optgrouptitle => $optgroupoptions) {
2038                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
2039                         if (empty($optionurl)) {
2040                             $safeoptionurl = '';
2041                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
2042                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
2043                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
2044                         } else if (strpos($optionurl, '/') !== 0) {
2045                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
2046                             continue;
2047                         } else {
2048                             $safeoptionurl = $optionurl;
2049                         }
2050                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
2051                     }
2052                 }
2053             } else {
2054                 // plain list structure
2055                 if (empty($k)) {
2056                     // nothing selected option
2057                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
2058                     $k = str_replace($CFG->wwwroot, '', $k);
2059                 } else if (strpos($k, '/') !== 0) {
2060                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
2061                     continue;
2062                 }
2063                 $urls[$k] = $v;
2064             }
2065         }
2066         $selected = $select->selected;
2067         if (!empty($selected)) {
2068             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
2069                 $selected = str_replace($CFG->wwwroot, '', $selected);
2070             } else if (strpos($selected, '/') !== 0) {
2071                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
2072             }
2073         }
2075         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
2076         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
2078         if (!$select->showbutton) {
2079             $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
2080             $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('class' => 'inline'));
2081             $nothing = empty($select->nothing) ? false : key($select->nothing);
2082             $this->page->requires->yui_module('moodle-core-formautosubmit',
2083                 'M.core.init_formautosubmit',
2084                 array(array('selectid' => $select->attributes['id'], 'nothing' => $nothing))
2085             );
2086         } else {
2087             $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>$select->showbutton));
2088         }
2090         // then div wrapper for xhtml strictness
2091         $output = html_writer::tag('div', $output);
2093         // now the form itself around it
2094         $formattributes = array('method' => 'post',
2095                                 'action' => new moodle_url('/course/jumpto.php'),
2096                                 'id'     => $select->formid);
2097         $output = html_writer::tag('form', $output, $formattributes);
2099         // and finally one more wrapper with class
2100         return html_writer::tag('div', $output, array('class' => $select->class));
2101     }
2103     /**
2104      * Returns a string containing a link to the user documentation.
2105      * Also contains an icon by default. Shown to teachers and admin only.
2106      *
2107      * @param string $path The page link after doc root and language, no leading slash.
2108      * @param string $text The text to be displayed for the link
2109      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
2110      * @return string
2111      */
2112     public function doc_link($path, $text = '', $forcepopup = false) {
2113         global $CFG;
2115         $icon = $this->pix_icon('docs', '', 'moodle', array('class'=>'iconhelp icon-pre', 'role'=>'presentation'));
2117         $url = new moodle_url(get_docs_url($path));
2119         $attributes = array('href'=>$url);
2120         if (!empty($CFG->doctonewwindow) || $forcepopup) {
2121             $attributes['class'] = 'helplinkpopup';
2122         }
2124         return html_writer::tag('a', $icon.$text, $attributes);
2125     }
2127     /**
2128      * Return HTML for a pix_icon.
2129      *
2130      * Theme developers: DO NOT OVERRIDE! Please override function
2131      * {@link core_renderer::render_pix_icon()} instead.
2132      *
2133      * @param string $pix short pix name
2134      * @param string $alt mandatory alt attribute
2135      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2136      * @param array $attributes htm lattributes
2137      * @return string HTML fragment
2138      */
2139     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
2140         $icon = new pix_icon($pix, $alt, $component, $attributes);
2141         return $this->render($icon);
2142     }
2144     /**
2145      * Renders a pix_icon widget and returns the HTML to display it.
2146      *
2147      * @param pix_icon $icon
2148      * @return string HTML fragment
2149      */
2150     protected function render_pix_icon(pix_icon $icon) {
2151         $data = $icon->export_for_template($this);
2152         return $this->render_from_template('core/pix_icon', $data);
2153     }
2155     /**
2156      * Return HTML to display an emoticon icon.
2157      *
2158      * @param pix_emoticon $emoticon
2159      * @return string HTML fragment
2160      */
2161     protected function render_pix_emoticon(pix_emoticon $emoticon) {
2162         $attributes = $emoticon->attributes;
2163         $attributes['src'] = $this->pix_url($emoticon->pix, $emoticon->component);
2164         return html_writer::empty_tag('img', $attributes);
2165     }
2167     /**
2168      * Produces the html that represents this rating in the UI
2169      *
2170      * @param rating $rating the page object on which this rating will appear
2171      * @return string
2172      */
2173     function render_rating(rating $rating) {
2174         global $CFG, $USER;
2176         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
2177             return null;//ratings are turned off
2178         }
2180         $ratingmanager = new rating_manager();
2181         // Initialise the JavaScript so ratings can be done by AJAX.
2182         $ratingmanager->initialise_rating_javascript($this->page);
2184         $strrate = get_string("rate", "rating");
2185         $ratinghtml = ''; //the string we'll return
2187         // permissions check - can they view the aggregate?
2188         if ($rating->user_can_view_aggregate()) {
2190             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
2191             $aggregatestr   = $rating->get_aggregate_string();
2193             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
2194             if ($rating->count > 0) {
2195                 $countstr = "({$rating->count})";
2196             } else {
2197                 $countstr = '-';
2198             }
2199             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
2201             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
2202             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
2204                 $nonpopuplink = $rating->get_view_ratings_url();
2205                 $popuplink = $rating->get_view_ratings_url(true);
2207                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
2208                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
2209             } else {
2210                 $ratinghtml .= $aggregatehtml;
2211             }
2212         }
2214         $formstart = null;
2215         // if the item doesn't belong to the current user, the user has permission to rate
2216         // and we're within the assessable period
2217         if ($rating->user_can_rate()) {
2219             $rateurl = $rating->get_rate_url();
2220             $inputs = $rateurl->params();
2222             //start the rating form
2223             $formattrs = array(
2224                 'id'     => "postrating{$rating->itemid}",
2225                 'class'  => 'postratingform',
2226                 'method' => 'post',
2227                 'action' => $rateurl->out_omit_querystring()
2228             );
2229             $formstart  = html_writer::start_tag('form', $formattrs);
2230             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2232             // add the hidden inputs
2233             foreach ($inputs as $name => $value) {
2234                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2235                 $formstart .= html_writer::empty_tag('input', $attributes);
2236             }
2238             if (empty($ratinghtml)) {
2239                 $ratinghtml .= $strrate.': ';
2240             }
2241             $ratinghtml = $formstart.$ratinghtml;
2243             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2244             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2245             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2246             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2248             //output submit button
2249             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2251             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2252             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2254             if (!$rating->settings->scale->isnumeric) {
2255                 // If a global scale, try to find current course ID from the context
2256                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2257                     $courseid = $coursecontext->instanceid;
2258                 } else {
2259                     $courseid = $rating->settings->scale->courseid;
2260                 }
2261                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2262             }
2263             $ratinghtml .= html_writer::end_tag('span');
2264             $ratinghtml .= html_writer::end_tag('div');
2265             $ratinghtml .= html_writer::end_tag('form');
2266         }
2268         return $ratinghtml;
2269     }
2271     /**
2272      * Centered heading with attached help button (same title text)
2273      * and optional icon attached.
2274      *
2275      * @param string $text A heading text
2276      * @param string $helpidentifier The keyword that defines a help page
2277      * @param string $component component name
2278      * @param string|moodle_url $icon
2279      * @param string $iconalt icon alt text
2280      * @param int $level The level of importance of the heading. Defaulting to 2
2281      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2282      * @return string HTML fragment
2283      */
2284     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2285         $image = '';
2286         if ($icon) {
2287             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon iconlarge'));
2288         }
2290         $help = '';
2291         if ($helpidentifier) {
2292             $help = $this->help_icon($helpidentifier, $component);
2293         }
2295         return $this->heading($image.$text.$help, $level, $classnames);
2296     }
2298     /**
2299      * Returns HTML to display a help icon.
2300      *
2301      * @deprecated since Moodle 2.0
2302      */
2303     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2304         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2305     }
2307     /**
2308      * Returns HTML to display a help icon.
2309      *
2310      * Theme developers: DO NOT OVERRIDE! Please override function
2311      * {@link core_renderer::render_help_icon()} instead.
2312      *
2313      * @param string $identifier The keyword that defines a help page
2314      * @param string $component component name
2315      * @param string|bool $linktext true means use $title as link text, string means link text value
2316      * @return string HTML fragment
2317      */
2318     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2319         $icon = new help_icon($identifier, $component);
2320         $icon->diag_strings();
2321         if ($linktext === true) {
2322             $icon->linktext = get_string($icon->identifier, $icon->component);
2323         } else if (!empty($linktext)) {
2324             $icon->linktext = $linktext;
2325         }
2326         return $this->render($icon);
2327     }
2329     /**
2330      * Implementation of user image rendering.
2331      *
2332      * @param help_icon $helpicon A help icon instance
2333      * @return string HTML fragment
2334      */
2335     protected function render_help_icon(help_icon $helpicon) {
2336         return $this->render_from_template('core/help_icon', $helpicon->export_for_template($this));
2337     }
2339     /**
2340      * Returns HTML to display a scale help icon.
2341      *
2342      * @param int $courseid
2343      * @param stdClass $scale instance
2344      * @return string HTML fragment
2345      */
2346     public function help_icon_scale($courseid, stdClass $scale) {
2347         global $CFG;
2349         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2351         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2353         $scaleid = abs($scale->id);
2355         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2356         $action = new popup_action('click', $link, 'ratingscale');
2358         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2359     }
2361     /**
2362      * Creates and returns a spacer image with optional line break.
2363      *
2364      * @param array $attributes Any HTML attributes to add to the spaced.
2365      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2366      *     laxy do it with CSS which is a much better solution.
2367      * @return string HTML fragment
2368      */
2369     public function spacer(array $attributes = null, $br = false) {
2370         $attributes = (array)$attributes;
2371         if (empty($attributes['width'])) {
2372             $attributes['width'] = 1;
2373         }
2374         if (empty($attributes['height'])) {
2375             $attributes['height'] = 1;
2376         }
2377         $attributes['class'] = 'spacer';
2379         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2381         if (!empty($br)) {
2382             $output .= '<br />';
2383         }
2385         return $output;
2386     }
2388     /**
2389      * Returns HTML to display the specified user's avatar.
2390      *
2391      * User avatar may be obtained in two ways:
2392      * <pre>
2393      * // Option 1: (shortcut for simple cases, preferred way)
2394      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2395      * $OUTPUT->user_picture($user, array('popup'=>true));
2396      *
2397      * // Option 2:
2398      * $userpic = new user_picture($user);
2399      * // Set properties of $userpic
2400      * $userpic->popup = true;
2401      * $OUTPUT->render($userpic);
2402      * </pre>
2403      *
2404      * Theme developers: DO NOT OVERRIDE! Please override function
2405      * {@link core_renderer::render_user_picture()} instead.
2406      *
2407      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2408      *     If any of these are missing, the database is queried. Avoid this
2409      *     if at all possible, particularly for reports. It is very bad for performance.
2410      * @param array $options associative array with user picture options, used only if not a user_picture object,
2411      *     options are:
2412      *     - courseid=$this->page->course->id (course id of user profile in link)
2413      *     - size=35 (size of image)
2414      *     - link=true (make image clickable - the link leads to user profile)
2415      *     - popup=false (open in popup)
2416      *     - alttext=true (add image alt attribute)
2417      *     - class = image class attribute (default 'userpicture')
2418      *     - visibletoscreenreaders=true (whether to be visible to screen readers)
2419      * @return string HTML fragment
2420      */
2421     public function user_picture(stdClass $user, array $options = null) {
2422         $userpicture = new user_picture($user);
2423         foreach ((array)$options as $key=>$value) {
2424             if (array_key_exists($key, $userpicture)) {
2425                 $userpicture->$key = $value;
2426             }
2427         }
2428         return $this->render($userpicture);
2429     }
2431     /**
2432      * Internal implementation of user image rendering.
2433      *
2434      * @param user_picture $userpicture
2435      * @return string
2436      */
2437     protected function render_user_picture(user_picture $userpicture) {
2438         global $CFG, $DB;
2440         $user = $userpicture->user;
2442         if ($userpicture->alttext) {
2443             if (!empty($user->imagealt)) {
2444                 $alt = $user->imagealt;
2445             } else {
2446                 $alt = get_string('pictureof', '', fullname($user));
2447             }
2448         } else {
2449             $alt = '';
2450         }
2452         if (empty($userpicture->size)) {
2453             $size = 35;
2454         } else if ($userpicture->size === true or $userpicture->size == 1) {
2455             $size = 100;
2456         } else {
2457             $size = $userpicture->size;
2458         }
2460         $class = $userpicture->class;
2462         if ($user->picture == 0) {
2463             $class .= ' defaultuserpic';
2464         }
2466         $src = $userpicture->get_url($this->page, $this);
2468         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
2469         if (!$userpicture->visibletoscreenreaders) {
2470             $attributes['role'] = 'presentation';
2471         }
2473         // get the image html output fisrt
2474         $output = html_writer::empty_tag('img', $attributes);
2476         // then wrap it in link if needed
2477         if (!$userpicture->link) {
2478             return $output;
2479         }
2481         if (empty($userpicture->courseid)) {
2482             $courseid = $this->page->course->id;
2483         } else {
2484             $courseid = $userpicture->courseid;
2485         }
2487         if ($courseid == SITEID) {
2488             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2489         } else {
2490             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2491         }
2493         $attributes = array('href'=>$url);
2494         if (!$userpicture->visibletoscreenreaders) {
2495             $attributes['tabindex'] = '-1';
2496             $attributes['aria-hidden'] = 'true';
2497         }
2499         if ($userpicture->popup) {
2500             $id = html_writer::random_id('userpicture');
2501             $attributes['id'] = $id;
2502             $this->add_action_handler(new popup_action('click', $url), $id);
2503         }
2505         return html_writer::tag('a', $output, $attributes);
2506     }
2508     /**
2509      * Internal implementation of file tree viewer items rendering.
2510      *
2511      * @param array $dir
2512      * @return string
2513      */
2514     public function htmllize_file_tree($dir) {
2515         if (empty($dir['subdirs']) and empty($dir['files'])) {
2516             return '';
2517         }
2518         $result = '<ul>';
2519         foreach ($dir['subdirs'] as $subdir) {
2520             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2521         }
2522         foreach ($dir['files'] as $file) {
2523             $filename = $file->get_filename();
2524             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2525         }
2526         $result .= '</ul>';
2528         return $result;
2529     }
2531     /**
2532      * Returns HTML to display the file picker
2533      *
2534      * <pre>
2535      * $OUTPUT->file_picker($options);
2536      * </pre>
2537      *
2538      * Theme developers: DO NOT OVERRIDE! Please override function
2539      * {@link core_renderer::render_file_picker()} instead.
2540      *
2541      * @param array $options associative array with file manager options
2542      *   options are:
2543      *       maxbytes=>-1,
2544      *       itemid=>0,
2545      *       client_id=>uniqid(),
2546      *       acepted_types=>'*',
2547      *       return_types=>FILE_INTERNAL,
2548      *       context=>$PAGE->context
2549      * @return string HTML fragment
2550      */
2551     public function file_picker($options) {
2552         $fp = new file_picker($options);
2553         return $this->render($fp);
2554     }
2556     /**
2557      * Internal implementation of file picker rendering.
2558      *
2559      * @param file_picker $fp
2560      * @return string
2561      */
2562     public function render_file_picker(file_picker $fp) {
2563         global $CFG, $OUTPUT, $USER;
2564         $options = $fp->options;
2565         $client_id = $options->client_id;
2566         $strsaved = get_string('filesaved', 'repository');
2567         $straddfile = get_string('openpicker', 'repository');
2568         $strloading  = get_string('loading', 'repository');
2569         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2570         $strdroptoupload = get_string('droptoupload', 'moodle');
2571         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2573         $currentfile = $options->currentfile;
2574         if (empty($currentfile)) {
2575             $currentfile = '';
2576         } else {
2577             $currentfile .= ' - ';
2578         }
2579         if ($options->maxbytes) {
2580             $size = $options->maxbytes;
2581         } else {
2582             $size = get_max_upload_file_size();
2583         }
2584         if ($size == -1) {
2585             $maxsize = '';
2586         } else {
2587             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2588         }
2589         if ($options->buttonname) {
2590             $buttonname = ' name="' . $options->buttonname . '"';
2591         } else {
2592             $buttonname = '';
2593         }
2594         $html = <<<EOD
2595 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2596 $icon_progress
2597 </div>
2598 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
2599     <div>
2600         <input type="button" class="fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2601         <span> $maxsize </span>
2602     </div>
2603 EOD;
2604         if ($options->env != 'url') {
2605             $html .= <<<EOD
2606     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2607     <div class="filepicker-filename">
2608         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2609         <div class="dndupload-progressbars"></div>
2610     </div>
2611     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2612     </div>
2613 EOD;
2614         }
2615         $html .= '</div>';
2616         return $html;
2617     }
2619     /**
2620      * Returns HTML to display the 'Update this Modulename' button that appears on module pages.
2621      *
2622      * @deprecated since Moodle 3.2
2623      *
2624      * @param string $cmid the course_module id.
2625      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
2626      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
2627      */
2628     public function update_module_button($cmid, $modulename) {
2629         global $CFG;
2631         debugging('core_renderer::update_module_button() has been deprecated and should not be used anymore. Activity modules ' .
2632             'should not add the edit module button, the link is already available in the Administration block. Themes can choose ' .
2633             'to display the link in the buttons row consistently for all module types.', DEBUG_DEVELOPER);
2635         if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
2636             $modulename = get_string('modulename', $modulename);
2637             $string = get_string('updatethis', '', $modulename);
2638             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
2639             return $this->single_button($url, $string);
2640         } else {
2641             return '';
2642         }
2643     }
2645     /**
2646      * Returns HTML to display a "Turn editing on/off" button in a form.
2647      *
2648      * @param moodle_url $url The URL + params to send through when clicking the button
2649      * @return string HTML the button
2650      */
2651     public function edit_button(moodle_url $url) {
2653         $url->param('sesskey', sesskey());
2654         if ($this->page->user_is_editing()) {
2655             $url->param('edit', 'off');
2656             $editstring = get_string('turneditingoff');
2657         } else {
2658             $url->param('edit', 'on');
2659             $editstring = get_string('turneditingon');
2660         }
2662         return $this->single_button($url, $editstring);
2663     }
2665     /**
2666      * Returns HTML to display a simple button to close a window
2667      *
2668      * @param string $text The lang string for the button's label (already output from get_string())
2669      * @return string html fragment
2670      */
2671     public function close_window_button($text='') {
2672         if (empty($text)) {
2673             $text = get_string('closewindow');
2674         }
2675         $button = new single_button(new moodle_url('#'), $text, 'get');
2676         $button->add_action(new component_action('click', 'close_window'));
2678         return $this->container($this->render($button), 'closewindow');
2679     }
2681     /**
2682      * Output an error message. By default wraps the error message in <span class="error">.
2683      * If the error message is blank, nothing is output.
2684      *
2685      * @param string $message the error message.
2686      * @return string the HTML to output.
2687      */
2688     public function error_text($message) {
2689         if (empty($message)) {
2690             return '';
2691         }
2692         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2693         return html_writer::tag('span', $message, array('class' => 'error'));
2694     }
2696     /**
2697      * Do not call this function directly.
2698      *
2699      * To terminate the current script with a fatal error, call the {@link print_error}
2700      * function, or throw an exception. Doing either of those things will then call this
2701      * function to display the error, before terminating the execution.
2702      *
2703      * @param string $message The message to output
2704      * @param string $moreinfourl URL where more info can be found about the error
2705      * @param string $link Link for the Continue button
2706      * @param array $backtrace The execution backtrace
2707      * @param string $debuginfo Debugging information
2708      * @return string the HTML to output.
2709      */
2710     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
2711         global $CFG;
2713         $output = '';
2714         $obbuffer = '';
2716         if ($this->has_started()) {
2717             // we can not always recover properly here, we have problems with output buffering,
2718             // html tables, etc.
2719             $output .= $this->opencontainers->pop_all_but_last();
2721         } else {
2722             // It is really bad if library code throws exception when output buffering is on,
2723             // because the buffered text would be printed before our start of page.
2724             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2725             error_reporting(0); // disable notices from gzip compression, etc.
2726             while (ob_get_level() > 0) {
2727                 $buff = ob_get_clean();
2728                 if ($buff === false) {
2729                     break;
2730                 }
2731                 $obbuffer .= $buff;
2732             }
2733             error_reporting($CFG->debug);
2735             // Output not yet started.
2736             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2737             if (empty($_SERVER['HTTP_RANGE'])) {
2738                 @header($protocol . ' 404 Not Found');
2739             } else {
2740                 // Must stop byteserving attempts somehow,
2741                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2742                 @header($protocol . ' 407 Proxy Authentication Required');
2743             }
2745             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2746             $this->page->set_url('/'); // no url
2747             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2748             $this->page->set_title(get_string('error'));
2749             $this->page->set_heading($this->page->course->fullname);
2750             $output .= $this->header();
2751         }
2753         $message = '<p class="errormessage">' . $message . '</p>'.
2754                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2755                 get_string('moreinformation') . '</a></p>';
2756         if (empty($CFG->rolesactive)) {
2757             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2758             //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.
2759         }
2760         $output .= $this->box($message, 'errorbox', null, array('data-rel' => 'fatalerror'));
2762         if ($CFG->debugdeveloper) {
2763             if (!empty($debuginfo)) {
2764                 $debuginfo = s($debuginfo); // removes all nasty JS
2765                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2766                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2767             }
2768             if (!empty($backtrace)) {
2769                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2770             }
2771             if ($obbuffer !== '' ) {
2772                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2773             }
2774         }
2776         if (empty($CFG->rolesactive)) {
2777             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2778         } else if (!empty($link)) {
2779             $output .= $this->continue_button($link);
2780         }
2782         $output .= $this->footer();
2784         // Padding to encourage IE to display our error page, rather than its own.
2785         $output .= str_repeat(' ', 512);
2787         return $output;
2788     }
2790     /**
2791      * Output a notification (that is, a status message about something that has just happened).
2792      *
2793      * Note: \core\notification::add() may be more suitable for your usage.
2794      *
2795      * @param string $message The message to print out.
2796      * @param string $type    The type of notification. See constants on \core\output\notification.
2797      * @return string the HTML to output.
2798      */
2799     public function notification($message, $type = null) {
2800         $typemappings = [
2801             // Valid types.
2802             'success'           => \core\output\notification::NOTIFY_SUCCESS,
2803             'info'              => \core\output\notification::NOTIFY_INFO,
2804             'warning'           => \core\output\notification::NOTIFY_WARNING,
2805             'error'             => \core\output\notification::NOTIFY_ERROR,
2807             // Legacy types mapped to current types.
2808             'notifyproblem'     => \core\output\notification::NOTIFY_ERROR,
2809             'notifytiny'        => \core\output\notification::NOTIFY_ERROR,
2810             'notifyerror'       => \core\output\notification::NOTIFY_ERROR,
2811             'notifysuccess'     => \core\output\notification::NOTIFY_SUCCESS,
2812             'notifymessage'     => \core\output\notification::NOTIFY_INFO,
2813             'notifyredirect'    => \core\output\notification::NOTIFY_INFO,
2814             'redirectmessage'   => \core\output\notification::NOTIFY_INFO,
2815         ];
2817         $extraclasses = [];
2819         if ($type) {
2820             if (strpos($type, ' ') === false) {
2821                 // No spaces in the list of classes, therefore no need to loop over and determine the class.
2822                 if (isset($typemappings[$type])) {
2823                     $type = $typemappings[$type];
2824                 } else {
2825                     // The value provided did not match a known type. It must be an extra class.
2826                     $extraclasses = [$type];
2827                 }
2828             } else {
2829                 // Identify what type of notification this is.
2830                 $classarray = explode(' ', self::prepare_classes($type));
2832                 // Separate out the type of notification from the extra classes.
2833                 foreach ($classarray as $class) {
2834                     if (isset($typemappings[$class])) {
2835                         $type = $typemappings[$class];
2836                     } else {
2837                         $extraclasses[] = $class;
2838                     }
2839                 }
2840             }
2841         }
2843         $notification = new \core\output\notification($message, $type);
2844         if (count($extraclasses)) {
2845             $notification->set_extra_classes($extraclasses);
2846         }
2848         // Return the rendered template.
2849         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2850     }
2852     /**
2853      * Output a notification at a particular level - in this case, NOTIFY_PROBLEM.
2854      *
2855      * @param string $message the message to print out
2856      * @return string HTML fragment.
2857      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2858      * @todo MDL-53113 This will be removed in Moodle 3.5.
2859      * @see \core\output\notification
2860      */
2861     public function notify_problem($message) {
2862         debugging(__FUNCTION__ . ' is deprecated.' .
2863             'Please use \core\notification::add, or \core\output\notification as required',
2864             DEBUG_DEVELOPER);
2865         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_ERROR);
2866         return $this->render($n);
2867     }
2869     /**
2870      * Output a notification at a particular level - in this case, NOTIFY_SUCCESS.
2871      *
2872      * @param string $message the message to print out
2873      * @return string HTML fragment.
2874      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2875      * @todo MDL-53113 This will be removed in Moodle 3.5.
2876      * @see \core\output\notification
2877      */
2878     public function notify_success($message) {
2879         debugging(__FUNCTION__ . ' is deprecated.' .
2880             'Please use \core\notification::add, or \core\output\notification as required',
2881             DEBUG_DEVELOPER);
2882         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_SUCCESS);
2883         return $this->render($n);
2884     }
2886     /**
2887      * Output a notification at a particular level - in this case, NOTIFY_MESSAGE.
2888      *
2889      * @param string $message the message to print out
2890      * @return string HTML fragment.
2891      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2892      * @todo MDL-53113 This will be removed in Moodle 3.5.
2893      * @see \core\output\notification
2894      */
2895     public function notify_message($message) {
2896         debugging(__FUNCTION__ . ' is deprecated.' .
2897             'Please use \core\notification::add, or \core\output\notification as required',
2898             DEBUG_DEVELOPER);
2899         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_INFO);
2900         return $this->render($n);
2901     }
2903     /**
2904      * Output a notification at a particular level - in this case, NOTIFY_REDIRECT.
2905      *
2906      * @param string $message the message to print out
2907      * @return string HTML fragment.
2908      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2909      * @todo MDL-53113 This will be removed in Moodle 3.5.
2910      * @see \core\output\notification
2911      */
2912     public function notify_redirect($message) {
2913         debugging(__FUNCTION__ . ' is deprecated.' .
2914             'Please use \core\notification::add, or \core\output\notification as required',
2915             DEBUG_DEVELOPER);
2916         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_INFO);
2917         return $this->render($n);
2918     }
2920     /**
2921      * Render a notification (that is, a status message about something that has
2922      * just happened).
2923      *
2924      * @param \core\output\notification $notification the notification to print out
2925      * @return string the HTML to output.
2926      */
2927     protected function render_notification(\core\output\notification $notification) {
2928         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2929     }
2931     /**
2932      * Returns HTML to display a continue button that goes to a particular URL.
2933      *
2934      * @param string|moodle_url $url The url the button goes to.
2935      * @return string the HTML to output.
2936      */
2937     public function continue_button($url) {
2938         if (!($url instanceof moodle_url)) {
2939             $url = new moodle_url($url);
2940         }
2941         $button = new single_button($url, get_string('continue'), 'get');
2942         $button->class = 'continuebutton';
2944         return $this->render($button);
2945     }
2947     /**
2948      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2949      *
2950      * Theme developers: DO NOT OVERRIDE! Please override function
2951      * {@link core_renderer::render_paging_bar()} instead.
2952      *
2953      * @param int $totalcount The total number of entries available to be paged through
2954      * @param int $page The page you are currently viewing
2955      * @param int $perpage The number of entries that should be shown per page
2956      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2957      * @param string $pagevar name of page parameter that holds the page number
2958      * @return string the HTML to output.
2959      */
2960     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2961         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2962         return $this->render($pb);
2963     }
2965     /**
2966      * Internal implementation of paging bar rendering.
2967      *
2968      * @param paging_bar $pagingbar
2969      * @return string
2970      */
2971     protected function render_paging_bar(paging_bar $pagingbar) {
2972         $output = '';
2973         $pagingbar = clone($pagingbar);
2974         $pagingbar->prepare($this, $this->page, $this->target);
2976         if ($pagingbar->totalcount > $pagingbar->perpage) {
2977             $output .= get_string('page') . ':';
2979             if (!empty($pagingbar->previouslink)) {
2980                 $output .= ' (' . $pagingbar->previouslink . ') ';
2981             }
2983             if (!empty($pagingbar->firstlink)) {
2984                 $output .= ' ' . $pagingbar->firstlink . ' ...';
2985             }
2987             foreach ($pagingbar->pagelinks as $link) {
2988                 $output .= "  $link";
2989             }
2991             if (!empty($pagingbar->lastlink)) {
2992                 $output .= ' ... ' . $pagingbar->lastlink . ' ';
2993             }
2995             if (!empty($pagingbar->nextlink)) {
2996                 $output .= '  (' . $pagingbar->nextlink . ')';
2997             }
2998         }
3000         return html_writer::tag('div', $output, array('class' => 'paging'));
3001     }
3003     /**
3004      * Output the place a skip link goes to.
3005      *
3006      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
3007      * @return string the HTML to output.
3008      */
3009     public function skip_link_target($id = null) {
3010         return html_writer::span('', '', array('id' => $id));
3011     }
3013     /**
3014      * Outputs a heading
3015      *
3016      * @param string $text The text of the heading
3017      * @param int $level The level of importance of the heading. Defaulting to 2
3018      * @param string $classes A space-separated list of CSS classes. Defaulting to null
3019      * @param string $id An optional ID
3020      * @return string the HTML to output.
3021      */
3022     public function heading($text, $level = 2, $classes = null, $id = null) {
3023         $level = (integer) $level;
3024         if ($level < 1 or $level > 6) {
3025             throw new coding_exception('Heading level must be an integer between 1 and 6.');
3026         }
3027         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
3028     }
3030     /**
3031      * Outputs a box.
3032      *
3033      * @param string $contents The contents of the box
3034      * @param string $classes A space-separated list of CSS classes
3035      * @param string $id An optional ID
3036      * @param array $attributes An array of other attributes to give the box.
3037      * @return string the HTML to output.
3038      */
3039     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
3040         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
3041     }
3043     /**
3044      * Outputs the opening section of a box.
3045      *
3046      * @param string $classes A space-separated list of CSS classes
3047      * @param string $id An optional ID
3048      * @param array $attributes An array of other attributes to give the box.
3049      * @return string the HTML to output.
3050      */
3051     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
3052         $this->opencontainers->push('box', html_writer::end_tag('div'));
3053         $attributes['id'] = $id;
3054         $attributes['class'] = 'box ' . renderer_base::prepare_classes($classes);
3055         return html_writer::start_tag('div', $attributes);
3056     }
3058     /**
3059      * Outputs the closing section of a box.
3060      *
3061      * @return string the HTML to output.
3062      */
3063     public function box_end() {
3064         return $this->opencontainers->pop('box');
3065     }
3067     /**
3068      * Outputs a container.
3069      *
3070      * @param string $contents The contents of the box
3071      * @param string $classes A space-separated list of CSS classes
3072      * @param string $id An optional ID
3073      * @return string the HTML to output.
3074      */
3075     public function container($contents, $classes = null, $id = null) {
3076         return $this->container_start($classes, $id) . $contents . $this->container_end();
3077     }
3079     /**
3080      * Outputs the opening section of a container.
3081      *
3082      * @param string $classes A space-separated list of CSS classes
3083      * @param string $id An optional ID
3084      * @return string the HTML to output.
3085      */
3086     public function container_start($classes = null, $id = null) {
3087         $this->opencontainers->push('container', html_writer::end_tag('div'));
3088         return html_writer::start_tag('div', array('id' => $id,
3089                 'class' => renderer_base::prepare_classes($classes)));
3090     }
3092     /**
3093      * Outputs the closing section of a container.
3094      *
3095      * @return string the HTML to output.
3096      */
3097     public function container_end() {
3098         return $this->opencontainers->pop('container');
3099     }
3101     /**
3102      * Make nested HTML lists out of the items
3103      *
3104      * The resulting list will look something like this:
3105      *
3106      * <pre>
3107      * <<ul>>
3108      * <<li>><div class='tree_item parent'>(item contents)</div>
3109      *      <<ul>
3110      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
3111      *      <</ul>>
3112      * <</li>>
3113      * <</ul>>
3114      * </pre>
3115      *
3116      * @param array $items
3117      * @param array $attrs html attributes passed to the top ofs the list
3118      * @return string HTML
3119      */
3120     public function tree_block_contents($items, $attrs = array()) {
3121         // exit if empty, we don't want an empty ul element
3122         if (empty($items)) {
3123             return '';
3124         }
3125         // array of nested li elements
3126         $lis = array();
3127         foreach ($items as $item) {
3128             // this applies to the li item which contains all child lists too
3129             $content = $item->content($this);
3130             $liclasses = array($item->get_css_type());
3131             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
3132                 $liclasses[] = 'collapsed';
3133             }
3134             if ($item->isactive === true) {
3135                 $liclasses[] = 'current_branch';
3136             }
3137             $liattr = array('class'=>join(' ',$liclasses));
3138             // class attribute on the div item which only contains the item content
3139             $divclasses = array('tree_item');
3140             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
3141                 $divclasses[] = 'branch';
3142             } else {
3143                 $divclasses[] = 'leaf';
3144             }
3145             if (!empty($item->classes) && count($item->classes)>0) {
3146                 $divclasses[] = join(' ', $item->classes);
3147             }
3148             $divattr = array('class'=>join(' ', $divclasses));
3149             if (!empty($item->id)) {
3150                 $divattr['id'] = $item->id;
3151             }
3152             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
3153             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
3154                 $content = html_writer::empty_tag('hr') . $content;
3155             }
3156             $content = html_writer::tag('li', $content, $liattr);
3157             $lis[] = $content;
3158         }
3159         return html_writer::tag('ul', implode("\n", $lis), $attrs);
3160     }
3162     /**
3163      * Returns a search box.
3164      *
3165      * @param  string $id     The search box wrapper div id, defaults to an autogenerated one.
3166      * @return string         HTML with the search form hidden by default.
3167      */
3168     public function search_box($id = false) {
3169         global $CFG;
3171         // Accessing $CFG directly as using \core_search::is_global_search_enabled would
3172         // result in an extra included file for each site, even the ones where global search
3173         // is disabled.
3174         if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
3175             return '';
3176         }
3178         if ($id == false) {
3179             $id = uniqid();
3180         } else {
3181             // Needs to be cleaned, we use it for the input id.
3182             $id = clean_param($id, PARAM_ALPHANUMEXT);
3183         }
3185         // JS to animate the form.
3186         $this->page->requires->js_call_amd('core/search-input', 'init', array($id));
3188         $searchicon = html_writer::tag('div', $this->pix_icon('a/search', get_string('search', 'search'), 'moodle'),
3189             array('role' => 'button', 'tabindex' => 0));
3190         $formattrs = array('class' => 'search-input-form', 'action' => $CFG->wwwroot . '/search/index.php');
3191         $inputattrs = array('type' => 'text', 'name' => 'q', 'placeholder' => get_string('search', 'search'),
3192             'size' => 13, 'tabindex' => -1, 'id' => 'id_q_' . $id);
3194         $contents = html_writer::tag('label', get_string('enteryoursearchquery', 'search'),
3195             array('for' => 'id_q_' . $id, 'class' => 'accesshide')) . html_writer::tag('input', '', $inputattrs);
3196         $searchinput = html_writer::tag('form', $contents, $formattrs);
3198         return html_writer::tag('div', $searchicon . $searchinput, array('class' => 'search-input-wrapper nav-link', 'id' => $id));
3199     }
3201     /**
3202      * Allow plugins to provide some content to be rendered in the navbar.
3203      * The plugin must define a PLUGIN_render_navbar_output function that returns
3204      * the HTML they wish to add to the navbar.
3205      *
3206      * @return string HTML for the navbar
3207      */
3208     public function navbar_plugin_output() {
3209         $output = '';
3211         if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
3212             foreach ($pluginsfunction as $plugintype => $plugins) {
3213                 foreach ($plugins as $pluginfunction) {
3214                     $output .= $pluginfunction($this);
3215                 }
3216             }
3217         }
3219         return $output;
3220     }
3222     /**
3223      * Construct a user menu, returning HTML that can be echoed out by a
3224      * layout file.
3225      *
3226      * @param stdClass $user A user object, usually $USER.
3227      * @param bool $withlinks true if a dropdown should be built.
3228      * @return string HTML fragment.
3229      */
3230     public function user_menu($user = null, $withlinks = null) {
3231         global $USER, $CFG;
3232         require_once($CFG->dirroot . '/user/lib.php');
3234         if (is_null($user)) {
3235             $user = $USER;
3236         }
3238         // Note: this behaviour is intended to match that of core_renderer::login_info,
3239         // but should not be considered to be good practice; layout options are
3240         // intended to be theme-specific. Please don't copy this snippet anywhere else.
3241         if (is_null($withlinks)) {
3242             $withlinks = empty($this->page->layout_options['nologinlinks']);
3243         }
3245         // Add a class for when $withlinks is false.
3246         $usermenuclasses = 'usermenu';
3247         if (!$withlinks) {
3248             $usermenuclasses .= ' withoutlinks';
3249         }
3251         $returnstr = "";
3253         // If during initial install, return the empty return string.
3254         if (during_initial_install()) {
3255             return $returnstr;
3256         }
3258         $loginpage = $this->is_login_page();
3259         $loginurl = get_login_url();
3260         // If not logged in, show the typical not-logged-in string.
3261         if (!isloggedin()) {
3262             $returnstr = get_string('loggedinnot', 'moodle');
3263             if (!$loginpage) {
3264                 $returnstr .= " (<a href=\"$loginurl\">" . get_string('login') . '</a>)';
3265             }
3266             return html_writer::div(
3267                 html_writer::span(
3268                     $returnstr,
3269                     'login'
3270                 ),
3271                 $usermenuclasses
3272             );
3274         }
3276         // If logged in as a guest user, show a string to that effect.
3277         if (isguestuser()) {
3278             $returnstr = get_string('loggedinasguest');
3279             if (!$loginpage && $withlinks) {
3280                 $returnstr .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
3281             }
3283             return html_writer::div(
3284                 html_writer::span(
3285                     $returnstr,
3286                     'login'
3287                 ),
3288                 $usermenuclasses
3289             );
3290         }
3292         // Get some navigation opts.
3293         $opts = user_get_user_navigation_info($user, $this->page);
3295         $avatarclasses = "avatars";
3296         $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
3297         $usertextcontents = $opts->metadata['userfullname'];
3299         // Other user.
3300         if (!empty($opts->metadata['asotheruser'])) {
3301             $avatarcontents .= html_writer::span(
3302                 $opts->metadata['realuseravatar'],
3303                 'avatar realuser'
3304             );
3305             $usertextcontents = $opts->metadata['realuserfullname'];
3306             $usertextcontents .= html_writer::tag(
3307                 'span',
3308                 get_string(
3309                     'loggedinas',
3310                     'moodle',
3311                     html_writer::span(
3312                         $opts->metadata['userfullname'],
3313                         'value'
3314                     )
3315                 ),
3316                 array('class' => 'meta viewingas')
3317             );
3318         }
3320         // Role.
3321         if (!empty($opts->metadata['asotherrole'])) {
3322             $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
3323             $usertextcontents .= html_writer::span(
3324                 $opts->metadata['rolename'],
3325                 'meta role role-' . $role
3326             );
3327         }
3329         // User login failures.
3330         if (!empty($opts->metadata['userloginfail'])) {
3331             $usertextcontents .= html_writer::span(
3332                 $opts->metadata['userloginfail'],
3333                 'meta loginfailures'
3334             );
3335         }
3337         // MNet.
3338         if (!empty($opts->metadata['asmnetuser'])) {
3339             $mnet = strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['mnetidprovidername'])));
3340             $usertextcontents .= html_writer::span(
3341                 $opts->metadata['mnetidprovidername'],
3342                 'meta mnet mnet-' . $mnet
3343             );
3344         }
3346         $returnstr .= html_writer::span(
3347             html_writer::span($usertextcontents, 'usertext') .
3348             html_writer::span($avatarcontents, $avatarclasses),
3349             'userbutton'
3350         );
3352         // Create a divider (well, a filler).
3353         $divider = new action_menu_filler();
3354         $divider->primary = false;
3356         $am = new action_menu();
3357         $am->set_menu_trigger(
3358             $returnstr
3359         );
3360         $am->set_alignment(action_menu::TR, action_menu::BR);
3361         $am->set_nowrap_on_items();
3362         if ($withlinks) {
3363             $navitemcount = count($opts->navitems);
3364             $idx = 0;
3365             foreach ($opts->navitems as $key => $value) {
3367                 switch ($value->itemtype) {
3368                     case 'divider':
3369                         // If the nav item is a divider, add one and skip link processing.
3370                         $am->add($divider);
3371                         break;
3373                     case 'invalid':
3374                         // Silently skip invalid entries (should we post a notification?).
3375                         break;
3377                     case 'link':
3378                         // Process this as a link item.
3379                         $pix = null;
3380                         if (isset($value->pix) && !empty($value->pix)) {
3381                             $pix = new pix_icon($value->pix, $value->title, null, array('class' => 'iconsmall'));
3382                         } else if (isset($value->imgsrc) && !empty($value->imgsrc)) {
3383                             $value->title = html_writer::img(
3384                                 $value->imgsrc,
3385                                 $value->title,
3386                                 array('class' => 'iconsmall')
3387                             ) . $value->title;
3388                         }
3390                         $al = new action_menu_link_secondary(
3391                             $value->url,
3392                             $pix,
3393                             $value->title,
3394                             array('class' => 'icon')
3395                         );
3396                         if (!empty($value->titleidentifier)) {
3397                             $al->attributes['data-title'] = $value->titleidentifier;
3398                         }
3399                         $am->add($al);
3400                         break;
3401                 }
3403                 $idx++;
3405                 // Add dividers after the first item and before the last item.
3406                 if ($idx == 1 || $idx == $navitemcount - 1) {
3407                     $am->add($divider);
3408                 }
3409             }
3410         }
3412         return html_writer::div(
3413             $this->render($am),
3414             $usermenuclasses
3415         );
3416     }
3418     /**
3419      * Return the navbar content so that it can be echoed out by the layout
3420      *
3421      * @return string XHTML navbar
3422      */
3423     public function navbar() {
3424         $items = $this->page->navbar->get_items();
3425         $itemcount = count($items);
3426         if ($itemcount === 0) {
3427             return '';
3428         }
3430         $htmlblocks = array();
3431         // Iterate the navarray and display each node
3432         $separator = get_separator();
3433         for ($i=0;$i < $itemcount;$i++) {
3434             $item = $items[$i];
3435             $item->hideicon = true;
3436             if ($i===0) {
3437                 $content = html_writer::tag('li', $this->render($item));
3438             } else {
3439                 $content = html_writer::tag('li', $separator.$this->render($item));
3440             }
3441             $htmlblocks[] = $content;
3442         }
3444         //accessibility: heading for navbar list  (MDL-20446)
3445         $navbarcontent = html_writer::tag('span', get_string('pagepath'),
3446                 array('class' => 'accesshide', 'id' => 'navbar-label'));
3447         $navbarcontent .= html_writer::tag('nav',
3448                 html_writer::tag('ul', join('', $htmlblocks)),
3449                 array('aria-labelledby' => 'navbar-label'));
3450         // XHTML
3451         return $navbarcontent;
3452     }
3454     /**
3455      * Renders a breadcrumb navigation node object.
3456      *
3457      * @param breadcrumb_navigation_node $item The navigation node to render.
3458      * @return string HTML fragment
3459      */
3460     protected function render_breadcrumb_navigation_node(breadcrumb_navigation_node $item) {
3462         if ($item->action instanceof moodle_url) {
3463             $content = $item->get_content();
3464             $title = $item->get_title();
3465             $attributes = array();
3466             $attributes['itemprop'] = 'url';
3467             if ($title !== '') {
3468                 $attributes['title'] = $title;
3469             }
3470             if ($item->hidden) {
3471                 $attributes['class'] = 'dimmed_text';
3472             }
3473             $content = html_writer::tag('span', $content, array('itemprop' => 'title'));
3474             $content = html_writer::link($item->action, $content, $attributes);
3476             $attributes = array();
3477             $attributes['itemscope'] = '';
3478             $attributes['itemtype'] = 'http://data-vocabulary.org/Breadcrumb';
3479             $content = html_writer::tag('span', $content, $attributes);
3481         } else {
3482             $content = $this->render_navigation_node($item);
3483         }
3484         return $content;
3485     }
3487     /**
3488      * Renders a navigation node object.
3489      *
3490      * @param navigation_node $item The navigation node to render.
3491      * @return string HTML fragment
3492      */
3493     protected function render_navigation_node(navigation_node $item) {
3494         $content = $item->get_content();
3495         $title = $item->get_title();
3496         if ($item->icon instanceof renderable && !$item->hideicon) {
3497             $icon = $this->render($item->icon);
3498             $content = $icon.$content; // use CSS for spacing of icons
3499         }
3500         if ($item->helpbutton !== null) {
3501             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton', 'tabindex'=>'0'));
3502         }
3503         if ($content === '') {
3504             return '';
3505         }
3506         if ($item->action instanceof action_link) {
3507             $link = $item->action;
3508             if ($item->hidden) {
3509                 $link->add_class('dimmed');
3510             }
3511             if (!empty($content)) {
3512                 // Providing there is content we will use that for the link content.
3513                 $link->text = $content;
3514             }
3515             $content = $this->render($link);
3516         } else if ($item->action instanceof moodle_url) {
3517             $attributes = array();
3518             if ($title !== '') {
3519                 $attributes['title'] = $title;
3520             }
3521             if ($item->hidden) {
3522                 $attributes['class'] = 'dimmed_text';
3523             }
3524             $content = html_writer::link($item->action, $content, $attributes);
3526         } else if (is_string($item->action) || empty($item->action)) {
3527             $attributes = array('tabindex'=>'0'); //add tab support to span but still maintain character stream sequence.
3528             if ($title !== '') {
3529                 $attributes['title'] = $title;
3530             }
3531             if ($item->hidden) {
3532                 $attributes['class'] = 'dimmed_text';
3533             }
3534             $content = html_writer::tag('span', $content, $attributes);
3535         }
3536         return $content;
3537     }
3539     /**
3540      * Accessibility: Right arrow-like character is
3541      * used in the breadcrumb trail, course navigation menu
3542      * (previous/next activity), calendar, and search forum block.
3543      * If the theme does not set characters, appropriate defaults
3544      * are set automatically. Please DO NOT
3545      * use &lt; &gt; &raquo; - these are confusing for blind users.
3546      *
3547      * @return string
3548      */
3549     public function rarrow() {
3550         return $this->page->theme->rarrow;
3551     }
3553     /**
3554      * Accessibility: Left arrow-like character is
3555      * used in the breadcrumb trail, course navigation menu
3556      * (previous/next activity), calendar, and search forum block.
3557      * If the theme does not set characters, appropriate defaults
3558      * are set automatically. Please DO NOT
3559      * use &lt; &gt; &raquo; - these are confusing for blind users.
3560      *
3561      * @return string
3562      */
3563     public function larrow() {
3564         return $this->page->theme->larrow;
3565     }
3567     /**
3568      * Accessibility: Up arrow-like character is used in
3569      * the book heirarchical navigation.
3570      * If the theme does not set characters, appropriate defaults
3571      * are set automatically. Please DO NOT
3572      * use ^ - this is confusing for blind users.
3573      *
3574      * @return string
3575      */
3576     public function uarrow() {
3577         return $this->page->theme->uarrow;
3578     }
3580     /**
3581      * Accessibility: Down arrow-like character.
3582      * If the theme does not set characters, appropriate defaults
3583      * are set automatically.
3584      *
3585      * @return string
3586      */
3587     public function darrow() {
3588         return $this->page->theme->darrow;
3589     }
3591     /**
3592      * Returns the custom menu if one has been set
3593      *
3594      * A custom menu can be configured by browsing to
3595      *    Settings: Administration > Appearance > Themes > Theme settings
3596      * and then configuring the custommenu config setting as described.
3597      *
3598      * Theme developers: DO NOT OVERRIDE! Please override function
3599      * {@link core_renderer::render_custom_menu()} instead.
3600      *
3601      * @param string $custommenuitems - custom menuitems set by theme instead of global theme settings
3602      * @return string
3603      */
3604     public function custom_menu($custommenuitems = '') {
3605         global $CFG;
3606         if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
3607             $custommenuitems = $CFG->custommenuitems;
3608         }
3609         if (empty($custommenuitems)) {
3610             return '';
3611         }
3612         $custommenu = new custom_menu($custommenuitems, current_language());
3613         return $this->render($custommenu);
3614     }
3616     /**
3617      * Renders a custom menu object (located in outputcomponents.php)
3618      *
3619      * The custom menu this method produces makes use of the YUI3 menunav widget
3620      * and requires very specific html elements and classes.
3621      *
3622      * @staticvar int $menucount
3623      * @param custom_menu $menu
3624      * @return string
3625      */
3626     protected function render_custom_menu(custom_menu $menu) {
3627         static $menucount = 0;
3628         // If the menu has no children return an empty string
3629         if (!$menu->has_children()) {
3630             return '';
3631         }
3632         // Increment the menu count. This is used for ID's that get worked with
3633         // in JavaScript as is essential
3634         $menucount++;
3635         // Initialise this custom menu (the custom menu object is contained in javascript-static
3636         $jscode = js_writer::function_call_with_Y('M.core_custom_menu.init', array('custom_menu_'.$menucount));
3637         $jscode = "(function(){{$jscode}})";
3638         $this->page->requires->yui_module('node-menunav', $jscode);
3639         // Build the root nodes as required by YUI
3640         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled custom-menu'));
3641         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
3642         $content .= html_writer::start_tag('ul');
3643         // Render each child
3644         foreach ($menu->get_children() as $item) {
3645             $content .= $this->render_custom_menu_item($item);
3646         }
3647         // Close the open tags
3648         $content .= html_writer::end_tag('ul');
3649         $content .= html_writer::end_tag('div');
3650         $content .= html_writer::end_tag('div');
3651         // Return the custom menu
3652         return $content;
3653     }
3655     /**
3656      * Renders a custom menu node as part of a submenu
3657      *
3658      * The custom menu this method produces makes use of the YUI3 menunav widget
3659      * and requires very specific html elements and classes.
3660      *
3661      * @see core:renderer::render_custom_menu()
3662      *
3663      * @staticvar int $submenucount
3664      * @param custom_menu_item $menunode
3665      * @return string
3666      */
3667     protected function render_custom_menu_item(custom_menu_item $menunode) {
3668         // Required to ensure we get unique trackable id's
3669         static $submenucount = 0;
3670         if ($menunode->has_children()) {
3671             // If the child has menus render it as a sub menu
3672             $submenucount++;
3673             $content = html_writer::start_tag('li');
3674             if ($menunode->get_url() !== null) {
3675                 $url = $menunode->get_url();
3676             } else {
3677                 $url = '#cm_submenu_'.$submenucount;
3678             }
3679             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
3680             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
3681             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
3682             $content .= html_writer::start_tag('ul');
3683             foreach ($menunode->get_children() as $menunode) {
3684                 $content .= $this->render_custom_menu_item($menunode);
3685             }
3686             $content .= html_writer::end_tag('ul');
3687             $content .= html_writer::end_tag('div');
3688             $content .= html_writer::end_tag('div');
3689             $content .= html_writer::end_tag('li');
3690         } else {
3691             // The node doesn't have children so produce a final menuitem.
3692             // Also, if the node's text matches '####', add a class so we can treat it as a divider.
3693             $content = '';
3694             if (preg_match("/^#+$/", $menunode->get_text())) {
3696                 // This is a divider.
3697                 $content = html_writer::start_tag('li', array('class' => 'yui3-menuitem divider'));
3698             } else {
3699                 $content = html_writer::start_tag(
3700                     'li',
3701                     array(
3702                         'class' => 'yui3-menuitem'
3703                     )
3704                 );
3705                 if ($menunode->get_url() !== null) {
3706                     $url = $menunode->get_url();
3707                 } else {
3708                     $url = '#';
3709                 }
3710                 $content .= html_writer::link(
3711                     $url,
3712                     $menunode->get_text(),
3713                     array('class' => 'yui3-menuitem-content', 'title' => $menunode->get_title())
3714                 );
3715             }
3716             $content .= html_writer::end_tag('li');
3717         }
3718         // Return the sub menu
3719         return $content;
3720     }
3722     /**
3723      * Renders theme links for switching between default and other themes.
3724      *
3725      * @return string
3726      */
3727     protected function theme_switch_links() {
3729         $actualdevice = core_useragent::get_device_type();
3730         $currentdevice = $this->page->devicetypeinuse;
3731         $switched = ($actualdevice != $currentdevice);
3733         if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
3734             // The user is using the a default device and hasn't switched so don't shown the switch
3735             // device links.
3736             return '';
3737         }
3739         if ($switched) {
3740             $linktext = get_string('switchdevicerecommended');
3741             $devicetype = $actualdevice;
3742         } else {
3743             $linktext = get_string('switchdevicedefault');
3744             $devicetype = 'default';
3745         }
3746         $linkurl = new moodle_url('/theme/switchdevice.php', array('url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()));
3748         $content  = html_writer::start_tag('div', array('id' => 'theme_switch_link'));
3749         $content .= html_writer::link($linkurl, $linktext, array('rel' => 'nofollow'));
3750         $content .= html_writer::end_tag('div');
3752         return $content;
3753     }
3755     /**
3756      * Renders tabs
3757      *
3758      * This function replaces print_tabs() used before Moodle 2.5 but with slightly different arguments
3759      *
3760      * Theme developers: In order to change how tabs are displayed please override functions
3761      * {@link core_renderer::render_tabtree()} and/or {@link core_renderer::render_tabobject()}
3762      *
3763      * @param array $tabs array of tabs, each of them may have it's own ->subtree
3764      * @param string|null $selected which tab to mark as selected, all parent tabs will
3765      *     automatically be marked as activated
3766      * @param array|string|null $inactive list of ids of inactive tabs, regardless of
3767      *     their level. Note that you can as weel specify tabobject::$inactive for separate instances
3768      * @return string
3769      */
3770     public final function tabtree($tabs, $selected = null, $inactive = null) {
3771         return $this->render(new tabtree($tabs, $selected, $inactive));
3772     }
3774     /**
3775      * Renders tabtree
3776      *
3777      * @param tabtree $tabtree
3778      * @return string
3779      */
3780     protected function render_tabtree(tabtree $tabtree) {
3781         if (empty($tabtree->subtree)) {
3782             return '';
3783         }
3784         $str = '';
3785         $str .= html_writer::start_tag('div', array('class' => 'tabtree'));
3786         $str .= $this->render_tabobject($tabtree);
3787         $str .= html_writer::end_tag('div').
3788                 html_writer::tag('div', ' ', array('class' => 'clearer'));
3789         return $str;
3790     }
3792     /**
3793      * Renders tabobject (part of tabtree)
3794      *
3795      * This function is called from {@link core_renderer::render_tabtree()}
3796      * and also it calls itself when printing the $tabobject subtree recursively.
3797      *
3798      * Property $tabobject->level indicates the number of row of tabs.
3799      *
3800      * @param tabobject $tabobject
3801      * @return string HTML fragment
3802      */
3803     protected function render_tabobject(tabobject $tabobject) {
3804         $str = '';
3806         // Print name of the current tab.
3807         if ($tabobject instanceof tabtree) {
3808             // No name for tabtree root.
3809         } else if ($tabobject->inactive || $tabobject->activated || ($tabobject->selected && !$tabobject->linkedwhenselected)) {
3810             // Tab name without a link. The <a> tag is used for styling.
3811             $str .= html_writer::tag('a', html_writer::span($tabobject->text), array('class' => 'nolink moodle-has-zindex'));
3812         } else {
3813             // Tab name with a link.
3814             if (!($tabobject->link instanceof moodle_url)) {
3815                 // backward compartibility when link was passed as quoted string
3816                 $str .= "<a href=\"$tabobject->link\" title=\"$tabobject->title\"><span>$tabobject->text</span></a>";
3817             } else {
3818                 $str .= html_writer::link($tabobject->link, html_writer::span($tabobject->text), array('title' => $tabobject->title));
3819             }
3820         }
3822         if (empty($tabobject->subtree)) {
3823             if ($tabobject->selected) {
3824                 $str .= html_writer::tag('div', '&nbsp;', array('class' => 'tabrow'. ($tabobject->level + 1). ' empty'));
3825             }
3826             return $str;
3827         }
3829         // Print subtree.
3830         if ($tabobject->level == 0 || $tabobject->selected || $tabobject->activated) {
3831             $str .= html_writer::start_tag('ul', array('class' => 'tabrow'. $tabobject->level));
3832             $cnt = 0;
3833             foreach ($tabobject->subtree as $tab) {
3834                 $liclass = '';
3835                 if (!$cnt) {
3836                     $liclass .= ' first';
3837                 }
3838                 if ($cnt == count($tabobject->subtree) - 1) {
3839                     $liclass .= ' last';
3840                 }
3841                 if ((empty($tab->subtree)) && (!empty($tab->selected))) {
3842                     $liclass .= ' onerow';
3843                 }
3845                 if ($tab->selected) {
3846                     $liclass .= ' here selected';
3847                 } else if ($tab->activated) {
3848                     $liclass .= ' here active';
3849                 }
3851                 // This will recursively call function render_tabobject() for each item in subtree.
3852                 $str .= html_writer::tag('li', $this->render($tab), array('class' => trim($liclass)));
3853                 $cnt++;
3854             }
3855             $str .= html_writer::end_tag('ul');
3856         }
3858         return $str;
3859     }
3861     /**
3862      * Get the HTML for blocks in the given region.
3863      *
3864      * @since Moodle 2.5.1 2.6
3865      * @param string $region The region to get HTML for.
3866      * @return string HTML.
3867      */
3868     public function blocks($region, $classes = array(), $tag = 'aside') {
3869         $displayregion = $this->page->apply_theme_region_manipulations($region);
3870         $classes = (array)$classes;
3871         $classes[] = 'block-region';
3872         $attributes = array(
3873             'id' => 'block-region-'.preg_replace('#[^a-zA-Z0-9_\-]+#', '-', $displayregion),
3874             'class' => join(' ', $classes),
3875             'data-blockregion' => $displayregion,
3876             'data-droptarget' => '1'
3877         );
3878         if ($this->page->blocks->region_has_content($displayregion, $this)) {
3879             $content = $this->blocks_for_region($displayregion);
3880         } else {
3881             $content = '';
3882         }
3883         return html_writer::tag($tag, $content, $attributes);
3884     }
3886     /**
3887      * Renders a custom block region.
3888      *
3889      * Use this method if you want to add an additional block region to the content of the page.
3890      * Please note this should only be used in special situations.
3891      * We want to leave the theme is control where ever possible!
3892      *
3893      * This method must use the same method that the theme uses within its layout file.
3894      * As such it asks the theme what method it is using.
3895      * It can be one of two values, blocks or blocks_for_region (deprecated).
3896      *
3897      * @param string $regionname The name of the custom region to add.
3898      * @return string HTML for the block region.
3899      */
3900     public function custom_block_region($regionname) {
3901         if ($this->page->theme->get_block_render_method() === 'blocks') {
3902             return $this->blocks($regionname);
3903         } else {
3904             return $this->blocks_for_region($regionname);
3905         }
3906     }
3908     /**
3909      * Returns the CSS classes to apply to the body tag.
3910      *
3911      * @since Moodle 2.5.1 2.6
3912      * @param array $additionalclasses Any additional classes to apply.
3913      * @return string
3914      */
3915     public function body_css_classes(array $additionalclasses = array()) {
3916         // Add a class for each block region on the page.
3917         // We use the block manager here because the theme object makes get_string calls.
3918         $usedregions = array();
3919         foreach ($this->page->blocks->get_regions() as $region) {
3920             $additionalclasses[] = 'has-region-'.$region;
3921             if ($this->page->blocks->region_has_content($region, $this)) {
3922                 $additionalclasses[] = 'used-region-'.$region;
3923                 $usedregions[] = $region;
3924             } else {
3925                 $additionalclasses[] = 'empty-region-'.$region;
3926             }
3927             if ($this->page->blocks->region_completely_docked($region, $this)) {
3928                 $additionalclasses[] = 'docked-region-'.$region;
3929             }
3930         }
3931         if (!$usedregions) {
3932             // No regions means there is only content, add 'content-only' class.
3933             $additionalclasses[] = 'content-only';
3934         } else if (count($usedregions) === 1) {