a00f66b928e4980d0fbfc36c1f7608b3bbadf9a1
[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             require_once("{$CFG->libdir}/filelib.php");
86             $themename = $this->page->theme->name;
87             $themerev = theme_get_revision();
89             // Create new localcache directory.
90             $cachedir = make_localcache_directory("mustache/$themerev/$themename");
92             // Remove old localcache directories.
93             $mustachecachedirs = glob("{$CFG->localcachedir}/mustache/*", GLOB_ONLYDIR);
94             foreach ($mustachecachedirs as $localcachedir) {
95                 $cachedrev = [];
96                 preg_match("/\/mustache\/([0-9]+)$/", $localcachedir, $cachedrev);
97                 $cachedrev = isset($cachedrev[1]) ? intval($cachedrev[1]) : 0;
98                 if ($cachedrev > 0 && $cachedrev < $themerev) {
99                     fulldelete($localcachedir);
100                 }
101             }
103             $loader = new \core\output\mustache_filesystem_loader();
104             $stringhelper = new \core\output\mustache_string_helper();
105             $quotehelper = new \core\output\mustache_quote_helper();
106             $jshelper = new \core\output\mustache_javascript_helper($this->page);
107             $pixhelper = new \core\output\mustache_pix_helper($this);
108             $shortentexthelper = new \core\output\mustache_shorten_text_helper();
109             $userdatehelper = new \core\output\mustache_user_date_helper();
111             // We only expose the variables that are exposed to JS templates.
112             $safeconfig = $this->page->requires->get_config_for_javascript($this->page, $this);
114             $helpers = array('config' => $safeconfig,
115                              'str' => array($stringhelper, 'str'),
116                              'quote' => array($quotehelper, 'quote'),
117                              'js' => array($jshelper, 'help'),
118                              'pix' => array($pixhelper, 'pix'),
119                              'shortentext' => array($shortentexthelper, 'shorten'),
120                              'userdate' => array($userdatehelper, 'transform'),
121                          );
123             $this->mustache = new Mustache_Engine(array(
124                 'cache' => $cachedir,
125                 'escape' => 's',
126                 'loader' => $loader,
127                 'helpers' => $helpers,
128                 'pragmas' => [Mustache_Engine::PRAGMA_BLOCKS]));
130         }
132         return $this->mustache;
133     }
136     /**
137      * Constructor
138      *
139      * The constructor takes two arguments. The first is the page that the renderer
140      * has been created to assist with, and the second is the target.
141      * The target is an additional identifier that can be used to load different
142      * renderers for different options.
143      *
144      * @param moodle_page $page the page we are doing output for.
145      * @param string $target one of rendering target constants
146      */
147     public function __construct(moodle_page $page, $target) {
148         $this->opencontainers = $page->opencontainers;
149         $this->page = $page;
150         $this->target = $target;
151     }
153     /**
154      * Renders a template by name with the given context.
155      *
156      * The provided data needs to be array/stdClass made up of only simple types.
157      * Simple types are array,stdClass,bool,int,float,string
158      *
159      * @since 2.9
160      * @param array|stdClass $context Context containing data for the template.
161      * @return string|boolean
162      */
163     public function render_from_template($templatename, $context) {
164         static $templatecache = array();
165         $mustache = $this->get_mustache();
167         try {
168             // Grab a copy of the existing helper to be restored later.
169             $uniqidhelper = $mustache->getHelper('uniqid');
170         } catch (Mustache_Exception_UnknownHelperException $e) {
171             // Helper doesn't exist.
172             $uniqidhelper = null;
173         }
175         // Provide 1 random value that will not change within a template
176         // but will be different from template to template. This is useful for
177         // e.g. aria attributes that only work with id attributes and must be
178         // unique in a page.
179         $mustache->addHelper('uniqid', new \core\output\mustache_uniqid_helper());
180         if (isset($templatecache[$templatename])) {
181             $template = $templatecache[$templatename];
182         } else {
183             try {
184                 $template = $mustache->loadTemplate($templatename);
185                 $templatecache[$templatename] = $template;
186             } catch (Mustache_Exception_UnknownTemplateException $e) {
187                 throw new moodle_exception('Unknown template: ' . $templatename);
188             }
189         }
191         $renderedtemplate = trim($template->render($context));
193         // If we had an existing uniqid helper then we need to restore it to allow
194         // handle nested calls of render_from_template.
195         if ($uniqidhelper) {
196             $mustache->addHelper('uniqid', $uniqidhelper);
197         }
199         return $renderedtemplate;
200     }
203     /**
204      * Returns rendered widget.
205      *
206      * The provided widget needs to be an object that extends the renderable
207      * interface.
208      * If will then be rendered by a method based upon the classname for the widget.
209      * For instance a widget of class `crazywidget` will be rendered by a protected
210      * render_crazywidget method of this renderer.
211      * If no render_crazywidget method exists and crazywidget implements templatable,
212      * look for the 'crazywidget' template in the same component and render that.
213      *
214      * @param renderable $widget instance with renderable interface
215      * @return string
216      */
217     public function render(renderable $widget) {
218         $classparts = explode('\\', get_class($widget));
219         // Strip namespaces.
220         $classname = array_pop($classparts);
221         // Remove _renderable suffixes
222         $classname = preg_replace('/_renderable$/', '', $classname);
224         $rendermethod = 'render_'.$classname;
225         if (method_exists($this, $rendermethod)) {
226             return $this->$rendermethod($widget);
227         }
228         if ($widget instanceof templatable) {
229             $component = array_shift($classparts);
230             if (!$component) {
231                 $component = 'core';
232             }
233             $template = $component . '/' . $classname;
234             $context = $widget->export_for_template($this);
235             return $this->render_from_template($template, $context);
236         }
237         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
238     }
240     /**
241      * Adds a JS action for the element with the provided id.
242      *
243      * This method adds a JS event for the provided component action to the page
244      * and then returns the id that the event has been attached to.
245      * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
246      *
247      * @param component_action $action
248      * @param string $id
249      * @return string id of element, either original submitted or random new if not supplied
250      */
251     public function add_action_handler(component_action $action, $id = null) {
252         if (!$id) {
253             $id = html_writer::random_id($action->event);
254         }
255         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
256         return $id;
257     }
259     /**
260      * Returns true is output has already started, and false if not.
261      *
262      * @return boolean true if the header has been printed.
263      */
264     public function has_started() {
265         return $this->page->state >= moodle_page::STATE_IN_BODY;
266     }
268     /**
269      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
270      *
271      * @param mixed $classes Space-separated string or array of classes
272      * @return string HTML class attribute value
273      */
274     public static function prepare_classes($classes) {
275         if (is_array($classes)) {
276             return implode(' ', array_unique($classes));
277         }
278         return $classes;
279     }
281     /**
282      * Return the direct URL for an image from the pix folder.
283      *
284      * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
285      *
286      * @deprecated since Moodle 3.3
287      * @param string $imagename the name of the icon.
288      * @param string $component specification of one plugin like in get_string()
289      * @return moodle_url
290      */
291     public function pix_url($imagename, $component = 'moodle') {
292         debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
293         return $this->page->theme->image_url($imagename, $component);
294     }
296     /**
297      * Return the moodle_url for an image.
298      *
299      * The exact image location and extension is determined
300      * automatically by searching for gif|png|jpg|jpeg, please
301      * note there can not be diferent images with the different
302      * extension. The imagename is for historical reasons
303      * a relative path name, it may be changed later for core
304      * images. It is recommended to not use subdirectories
305      * in plugin and theme pix directories.
306      *
307      * There are three types of images:
308      * 1/ theme images  - stored in theme/mytheme/pix/,
309      *                    use component 'theme'
310      * 2/ core images   - stored in /pix/,
311      *                    overridden via theme/mytheme/pix_core/
312      * 3/ plugin images - stored in mod/mymodule/pix,
313      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
314      *                    example: image_url('comment', 'mod_glossary')
315      *
316      * @param string $imagename the pathname of the image
317      * @param string $component full plugin name (aka component) or 'theme'
318      * @return moodle_url
319      */
320     public function image_url($imagename, $component = 'moodle') {
321         return $this->page->theme->image_url($imagename, $component);
322     }
324     /**
325      * Return the site's logo URL, if any.
326      *
327      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
328      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
329      * @return moodle_url|false
330      */
331     public function get_logo_url($maxwidth = null, $maxheight = 200) {
332         global $CFG;
333         $logo = get_config('core_admin', 'logo');
334         if (empty($logo)) {
335             return false;
336         }
338         // 200px high is the default image size which should be displayed at 100px in the page to account for retina displays.
339         // It's not worth the overhead of detecting and serving 2 different images based on the device.
341         // Hide the requested size in the file path.
342         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
344         // Use $CFG->themerev to prevent browser caching when the file changes.
345         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logo', $filepath,
346             theme_get_revision(), $logo);
347     }
349     /**
350      * Return the site's compact logo URL, if any.
351      *
352      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
353      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
354      * @return moodle_url|false
355      */
356     public function get_compact_logo_url($maxwidth = 100, $maxheight = 100) {
357         global $CFG;
358         $logo = get_config('core_admin', 'logocompact');
359         if (empty($logo)) {
360             return false;
361         }
363         // Hide the requested size in the file path.
364         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
366         // Use $CFG->themerev to prevent browser caching when the file changes.
367         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logocompact', $filepath,
368             theme_get_revision(), $logo);
369     }
371     /**
372      * Whether we should display the logo in the navbar.
373      *
374      * We will when there are no main logos, and we have compact logo.
375      *
376      * @return bool
377      */
378     public function should_display_navbar_logo() {
379         $logo = $this->get_compact_logo_url();
380         return !empty($logo) && !$this->should_display_main_logo();
381     }
383     /**
384      * Whether we should display the main logo.
385      *
386      * @param int $headinglevel The heading level we want to check against.
387      * @return bool
388      */
389     public function should_display_main_logo($headinglevel = 1) {
390         global $PAGE;
392         // Only render the logo if we're on the front page or login page and the we have a logo.
393         $logo = $this->get_logo_url();
394         if ($headinglevel == 1 && !empty($logo)) {
395             if ($PAGE->pagelayout == 'frontpage' || $PAGE->pagelayout == 'login') {
396                 return true;
397             }
398         }
400         return false;
401     }
406 /**
407  * Basis for all plugin renderers.
408  *
409  * @copyright Petr Skoda (skodak)
410  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
411  * @since Moodle 2.0
412  * @package core
413  * @category output
414  */
415 class plugin_renderer_base extends renderer_base {
417     /**
418      * @var renderer_base|core_renderer A reference to the current renderer.
419      * The renderer provided here will be determined by the page but will in 90%
420      * of cases by the {@link core_renderer}
421      */
422     protected $output;
424     /**
425      * Constructor method, calls the parent constructor
426      *
427      * @param moodle_page $page
428      * @param string $target one of rendering target constants
429      */
430     public function __construct(moodle_page $page, $target) {
431         if (empty($target) && $page->pagelayout === 'maintenance') {
432             // If the page is using the maintenance layout then we're going to force the target to maintenance.
433             // This way we'll get a special maintenance renderer that is designed to block access to API's that are likely
434             // unavailable for this page layout.
435             $target = RENDERER_TARGET_MAINTENANCE;
436         }
437         $this->output = $page->get_renderer('core', null, $target);
438         parent::__construct($page, $target);
439     }
441     /**
442      * Renders the provided widget and returns the HTML to display it.
443      *
444      * @param renderable $widget instance with renderable interface
445      * @return string
446      */
447     public function render(renderable $widget) {
448         $classname = get_class($widget);
449         // Strip namespaces.
450         $classname = preg_replace('/^.*\\\/', '', $classname);
451         // Keep a copy at this point, we may need to look for a deprecated method.
452         $deprecatedmethod = 'render_'.$classname;
453         // Remove _renderable suffixes
454         $classname = preg_replace('/_renderable$/', '', $classname);
456         $rendermethod = 'render_'.$classname;
457         if (method_exists($this, $rendermethod)) {
458             return $this->$rendermethod($widget);
459         }
460         if ($rendermethod !== $deprecatedmethod && method_exists($this, $deprecatedmethod)) {
461             // This is exactly where we don't want to be.
462             // If you have arrived here you have a renderable component within your plugin that has the name
463             // blah_renderable, and you have a render method render_blah_renderable on your plugin.
464             // In 2.8 we revamped output, as part of this change we changed slightly how renderables got rendered
465             // and the _renderable suffix now gets removed when looking for a render method.
466             // You need to change your renderers render_blah_renderable to render_blah.
467             // Until you do this it will not be possible for a theme to override the renderer to override your method.
468             // Please do it ASAP.
469             static $debugged = array();
470             if (!isset($debugged[$deprecatedmethod])) {
471                 debugging(sprintf('Deprecated call. Please rename your renderables render method from %s to %s.',
472                     $deprecatedmethod, $rendermethod), DEBUG_DEVELOPER);
473                 $debugged[$deprecatedmethod] = true;
474             }
475             return $this->$deprecatedmethod($widget);
476         }
477         // pass to core renderer if method not found here
478         return $this->output->render($widget);
479     }
481     /**
482      * Magic method used to pass calls otherwise meant for the standard renderer
483      * to it to ensure we don't go causing unnecessary grief.
484      *
485      * @param string $method
486      * @param array $arguments
487      * @return mixed
488      */
489     public function __call($method, $arguments) {
490         if (method_exists('renderer_base', $method)) {
491             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
492         }
493         if (method_exists($this->output, $method)) {
494             return call_user_func_array(array($this->output, $method), $arguments);
495         } else {
496             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
497         }
498     }
502 /**
503  * The standard implementation of the core_renderer interface.
504  *
505  * @copyright 2009 Tim Hunt
506  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
507  * @since Moodle 2.0
508  * @package core
509  * @category output
510  */
511 class core_renderer extends renderer_base {
512     /**
513      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
514      * in layout files instead.
515      * @deprecated
516      * @var string used in {@link core_renderer::header()}.
517      */
518     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
520     /**
521      * @var string Used to pass information from {@link core_renderer::doctype()} to
522      * {@link core_renderer::standard_head_html()}.
523      */
524     protected $contenttype;
526     /**
527      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
528      * with {@link core_renderer::header()}.
529      */
530     protected $metarefreshtag = '';
532     /**
533      * @var string Unique token for the closing HTML
534      */
535     protected $unique_end_html_token;
537     /**
538      * @var string Unique token for performance information
539      */
540     protected $unique_performance_info_token;
542     /**
543      * @var string Unique token for the main content.
544      */
545     protected $unique_main_content_token;
547     /** @var custom_menu_item language The language menu if created */
548     protected $language = null;
550     /**
551      * Constructor
552      *
553      * @param moodle_page $page the page we are doing output for.
554      * @param string $target one of rendering target constants
555      */
556     public function __construct(moodle_page $page, $target) {
557         $this->opencontainers = $page->opencontainers;
558         $this->page = $page;
559         $this->target = $target;
561         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
562         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
563         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
564     }
566     /**
567      * Get the DOCTYPE declaration that should be used with this page. Designed to
568      * be called in theme layout.php files.
569      *
570      * @return string the DOCTYPE declaration that should be used.
571      */
572     public function doctype() {
573         if ($this->page->theme->doctype === 'html5') {
574             $this->contenttype = 'text/html; charset=utf-8';
575             return "<!DOCTYPE html>\n";
577         } else if ($this->page->theme->doctype === 'xhtml5') {
578             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
579             return "<!DOCTYPE html>\n";
581         } else {
582             // legacy xhtml 1.0
583             $this->contenttype = 'text/html; charset=utf-8';
584             return ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n");
585         }
586     }
588     /**
589      * The attributes that should be added to the <html> tag. Designed to
590      * be called in theme layout.php files.
591      *
592      * @return string HTML fragment.
593      */
594     public function htmlattributes() {
595         $return = get_html_lang(true);
596         $attributes = array();
597         if ($this->page->theme->doctype !== 'html5') {
598             $attributes['xmlns'] = 'http://www.w3.org/1999/xhtml';
599         }
601         // Give plugins an opportunity to add things like xml namespaces to the html element.
602         // This function should return an array of html attribute names => values.
603         $pluginswithfunction = get_plugins_with_function('add_htmlattributes', 'lib.php');
604         foreach ($pluginswithfunction as $plugins) {
605             foreach ($plugins as $function) {
606                 $newattrs = $function();
607                 unset($newattrs['dir']);
608                 unset($newattrs['lang']);
609                 unset($newattrs['xmlns']);
610                 unset($newattrs['xml:lang']);
611                 $attributes += $newattrs;
612             }
613         }
615         foreach ($attributes as $key => $val) {
616             $val = s($val);
617             $return .= " $key=\"$val\"";
618         }
620         return $return;
621     }
623     /**
624      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
625      * that should be included in the <head> tag. Designed to be called in theme
626      * layout.php files.
627      *
628      * @return string HTML fragment.
629      */
630     public function standard_head_html() {
631         global $CFG, $SESSION, $SITE, $PAGE;
633         // Before we output any content, we need to ensure that certain
634         // page components are set up.
636         // Blocks must be set up early as they may require javascript which
637         // has to be included in the page header before output is created.
638         foreach ($this->page->blocks->get_regions() as $region) {
639             $this->page->blocks->ensure_content_created($region, $this);
640         }
642         $output = '';
644         // Give plugins an opportunity to add any head elements. The callback
645         // must always return a string containing valid html head content.
646         $pluginswithfunction = get_plugins_with_function('before_standard_html_head', 'lib.php');
647         foreach ($pluginswithfunction as $plugins) {
648             foreach ($plugins as $function) {
649                 $output .= $function();
650             }
651         }
653         // Allow a url_rewrite plugin to setup any dynamic head content.
654         if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
655             $class = $CFG->urlrewriteclass;
656             $output .= $class::html_head_setup();
657         }
659         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
660         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
661         // This is only set by the {@link redirect()} method
662         $output .= $this->metarefreshtag;
664         // Check if a periodic refresh delay has been set and make sure we arn't
665         // already meta refreshing
666         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
667             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
668         }
670         // Set up help link popups for all links with the helptooltip class
671         $this->page->requires->js_init_call('M.util.help_popups.setup');
673         $focus = $this->page->focuscontrol;
674         if (!empty($focus)) {
675             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
676                 // This is a horrifically bad way to handle focus but it is passed in
677                 // through messy formslib::moodleform
678                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
679             } else if (strpos($focus, '.')!==false) {
680                 // Old style of focus, bad way to do it
681                 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);
682                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
683             } else {
684                 // Focus element with given id
685                 $this->page->requires->js_function_call('focuscontrol', array($focus));
686             }
687         }
689         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
690         // any other custom CSS can not be overridden via themes and is highly discouraged
691         $urls = $this->page->theme->css_urls($this->page);
692         foreach ($urls as $url) {
693             $this->page->requires->css_theme($url);
694         }
696         // Get the theme javascript head and footer
697         if ($jsurl = $this->page->theme->javascript_url(true)) {
698             $this->page->requires->js($jsurl, true);
699         }
700         if ($jsurl = $this->page->theme->javascript_url(false)) {
701             $this->page->requires->js($jsurl);
702         }
704         // Get any HTML from the page_requirements_manager.
705         $output .= $this->page->requires->get_head_code($this->page, $this);
707         // List alternate versions.
708         foreach ($this->page->alternateversions as $type => $alt) {
709             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
710                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
711         }
713         // Add noindex tag if relevant page and setting applied.
714         $allowindexing = isset($CFG->allowindexing) ? $CFG->allowindexing : 0;
715         $loginpages = array('login-index', 'login-signup');
716         if ($allowindexing == 2 || ($allowindexing == 0 && in_array($this->page->pagetype, $loginpages))) {
717             if (!isset($CFG->additionalhtmlhead)) {
718                 $CFG->additionalhtmlhead = '';
719             }
720             $CFG->additionalhtmlhead .= '<meta name="robots" content="noindex" />';
721         }
723         if (!empty($CFG->additionalhtmlhead)) {
724             $output .= "\n".$CFG->additionalhtmlhead;
725         }
727         if ($PAGE->pagelayout == 'frontpage') {
728             $summary = s(strip_tags(format_text($SITE->summary, FORMAT_HTML)));
729             if (!empty($summary)) {
730                 $output .= "<meta name=\"description\" content=\"$summary\" />\n";
731             }
732         }
734         return $output;
735     }
737     /**
738      * The standard tags (typically skip links) that should be output just inside
739      * the start of the <body> tag. Designed to be called in theme layout.php files.
740      *
741      * @return string HTML fragment.
742      */
743     public function standard_top_of_body_html() {
744         global $CFG;
745         $output = $this->page->requires->get_top_of_body_code($this);
746         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
747             $output .= "\n".$CFG->additionalhtmltopofbody;
748         }
750         // Give subsystems an opportunity to inject extra html content. The callback
751         // must always return a string containing valid html.
752         foreach (\core_component::get_core_subsystems() as $name => $path) {
753             if ($path) {
754                 $output .= component_callback($name, 'before_standard_top_of_body_html', [], '');
755             }
756         }
758         // Give plugins an opportunity to inject extra html content. The callback
759         // must always return a string containing valid html.
760         $pluginswithfunction = get_plugins_with_function('before_standard_top_of_body_html', 'lib.php');
761         foreach ($pluginswithfunction as $plugins) {
762             foreach ($plugins as $function) {
763                 $output .= $function();
764             }
765         }
767         $output .= $this->maintenance_warning();
769         return $output;
770     }
772     /**
773      * Scheduled maintenance warning message.
774      *
775      * Note: This is a nasty hack to display maintenance notice, this should be moved
776      *       to some general notification area once we have it.
777      *
778      * @return string
779      */
780     public function maintenance_warning() {
781         global $CFG;
783         $output = '';
784         if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
785             $timeleft = $CFG->maintenance_later - time();
786             // If timeleft less than 30 sec, set the class on block to error to highlight.
787             $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
788             $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-a-1 alert');
789             $a = new stdClass();
790             $a->hour = (int)($timeleft / 3600);
791             $a->min = (int)(($timeleft / 60) % 60);
792             $a->sec = (int)($timeleft % 60);
793             if ($a->hour > 0) {
794                 $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
795             } else {
796                 $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
797             }
799             $output .= $this->box_end();
800             $this->page->requires->yui_module('moodle-core-maintenancemodetimer', 'M.core.maintenancemodetimer',
801                     array(array('timeleftinsec' => $timeleft)));
802             $this->page->requires->strings_for_js(
803                     array('maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'),
804                     'admin');
805         }
806         return $output;
807     }
809     /**
810      * The standard tags (typically performance information and validation links,
811      * if we are in developer debug mode) that should be output in the footer area
812      * of the page. Designed to be called in theme layout.php files.
813      *
814      * @return string HTML fragment.
815      */
816     public function standard_footer_html() {
817         global $CFG, $SCRIPT;
819         $output = '';
820         if (during_initial_install()) {
821             // Debugging info can not work before install is finished,
822             // in any case we do not want any links during installation!
823             return $output;
824         }
826         // Give plugins an opportunity to add any footer elements.
827         // The callback must always return a string containing valid html footer content.
828         $pluginswithfunction = get_plugins_with_function('standard_footer_html', 'lib.php');
829         foreach ($pluginswithfunction as $plugins) {
830             foreach ($plugins as $function) {
831                 $output .= $function();
832             }
833         }
835         // This function is normally called from a layout.php file in {@link core_renderer::header()}
836         // but some of the content won't be known until later, so we return a placeholder
837         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
838         $output .= $this->unique_performance_info_token;
839         if ($this->page->devicetypeinuse == 'legacy') {
840             // The legacy theme is in use print the notification
841             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
842         }
844         // Get links to switch device types (only shown for users not on a default device)
845         $output .= $this->theme_switch_links();
847         if (!empty($CFG->debugpageinfo)) {
848             $output .= '<div class="performanceinfo pageinfo">' . get_string('pageinfodebugsummary', 'core_admin',
849                 $this->page->debug_summary()) . '</div>';
850         }
851         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) {  // Only in developer mode
852             // Add link to profiling report if necessary
853             if (function_exists('profiling_is_running') && profiling_is_running()) {
854                 $txt = get_string('profiledscript', 'admin');
855                 $title = get_string('profiledscriptview', 'admin');
856                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
857                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
858                 $output .= '<div class="profilingfooter">' . $link . '</div>';
859             }
860             $purgeurl = new moodle_url('/admin/purgecaches.php', array('confirm' => 1,
861                 'sesskey' => sesskey(), 'returnurl' => $this->page->url->out_as_local_url(false)));
862             $output .= '<div class="purgecaches">' .
863                     html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '</div>';
864         }
865         if (!empty($CFG->debugvalidators)) {
866             // 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
867             $output .= '<div class="validators"><ul class="list-unstyled ml-1">
868               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
869               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
870               <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>
871             </ul></div>';
872         }
873         return $output;
874     }
876     /**
877      * Returns standard main content placeholder.
878      * Designed to be called in theme layout.php files.
879      *
880      * @return string HTML fragment.
881      */
882     public function main_content() {
883         // This is here because it is the only place we can inject the "main" role over the entire main content area
884         // without requiring all theme's to manually do it, and without creating yet another thing people need to
885         // remember in the theme.
886         // This is an unfortunate hack. DO NO EVER add anything more here.
887         // DO NOT add classes.
888         // DO NOT add an id.
889         return '<div role="main">'.$this->unique_main_content_token.'</div>';
890     }
892     /**
893      * Returns standard navigation between activities in a course.
894      *
895      * @return string the navigation HTML.
896      */
897     public function activity_navigation() {
898         // First we should check if we want to add navigation.
899         $context = $this->page->context;
900         if (($this->page->pagelayout !== 'incourse' && $this->page->pagelayout !== 'frametop')
901             || $context->contextlevel != CONTEXT_MODULE) {
902             return '';
903         }
905         // If the activity is in stealth mode, show no links.
906         if ($this->page->cm->is_stealth()) {
907             return '';
908         }
910         // Get a list of all the activities in the course.
911         $course = $this->page->cm->get_course();
912         $modules = get_fast_modinfo($course->id)->get_cms();
914         // Put the modules into an array in order by the position they are shown in the course.
915         $mods = [];
916         $activitylist = [];
917         foreach ($modules as $module) {
918             // Only add activities the user can access, aren't in stealth mode and have a url (eg. mod_label does not).
919             if (!$module->uservisible || $module->is_stealth() || empty($module->url)) {
920                 continue;
921             }
922             $mods[$module->id] = $module;
924             // No need to add the current module to the list for the activity dropdown menu.
925             if ($module->id == $this->page->cm->id) {
926                 continue;
927             }
928             // Module name.
929             $modname = $module->get_formatted_name();
930             // Display the hidden text if necessary.
931             if (!$module->visible) {
932                 $modname .= ' ' . get_string('hiddenwithbrackets');
933             }
934             // Module URL.
935             $linkurl = new moodle_url($module->url, array('forceview' => 1));
936             // Add module URL (as key) and name (as value) to the activity list array.
937             $activitylist[$linkurl->out(false)] = $modname;
938         }
940         $nummods = count($mods);
942         // If there is only one mod then do nothing.
943         if ($nummods == 1) {
944             return '';
945         }
947         // Get an array of just the course module ids used to get the cmid value based on their position in the course.
948         $modids = array_keys($mods);
950         // Get the position in the array of the course module we are viewing.
951         $position = array_search($this->page->cm->id, $modids);
953         $prevmod = null;
954         $nextmod = null;
956         // Check if we have a previous mod to show.
957         if ($position > 0) {
958             $prevmod = $mods[$modids[$position - 1]];
959         }
961         // Check if we have a next mod to show.
962         if ($position < ($nummods - 1)) {
963             $nextmod = $mods[$modids[$position + 1]];
964         }
966         $activitynav = new \core_course\output\activity_navigation($prevmod, $nextmod, $activitylist);
967         $renderer = $this->page->get_renderer('core', 'course');
968         return $renderer->render($activitynav);
969     }
971     /**
972      * The standard tags (typically script tags that are not needed earlier) that
973      * should be output after everything else. Designed to be called in theme layout.php files.
974      *
975      * @return string HTML fragment.
976      */
977     public function standard_end_of_body_html() {
978         global $CFG;
980         // This function is normally called from a layout.php file in {@link core_renderer::header()}
981         // but some of the content won't be known until later, so we return a placeholder
982         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
983         $output = '';
984         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
985             $output .= "\n".$CFG->additionalhtmlfooter;
986         }
987         $output .= $this->unique_end_html_token;
988         return $output;
989     }
991     /**
992      * The standard HTML that should be output just before the <footer> tag.
993      * Designed to be called in theme layout.php files.
994      *
995      * @return string HTML fragment.
996      */
997     public function standard_after_main_region_html() {
998         global $CFG;
999         $output = '';
1000         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlbottomofbody)) {
1001             $output .= "\n".$CFG->additionalhtmlbottomofbody;
1002         }
1004         // Give subsystems an opportunity to inject extra html content. The callback
1005         // must always return a string containing valid html.
1006         foreach (\core_component::get_core_subsystems() as $name => $path) {
1007             if ($path) {
1008                 $output .= component_callback($name, 'standard_after_main_region_html', [], '');
1009             }
1010         }
1012         // Give plugins an opportunity to inject extra html content. The callback
1013         // must always return a string containing valid html.
1014         $pluginswithfunction = get_plugins_with_function('standard_after_main_region_html', 'lib.php');
1015         foreach ($pluginswithfunction as $plugins) {
1016             foreach ($plugins as $function) {
1017                 $output .= $function();
1018             }
1019         }
1021         return $output;
1022     }
1024     /**
1025      * Return the standard string that says whether you are logged in (and switched
1026      * roles/logged in as another user).
1027      * @param bool $withlinks if false, then don't include any links in the HTML produced.
1028      * If not set, the default is the nologinlinks option from the theme config.php file,
1029      * and if that is not set, then links are included.
1030      * @return string HTML fragment.
1031      */
1032     public function login_info($withlinks = null) {
1033         global $USER, $CFG, $DB, $SESSION;
1035         if (during_initial_install()) {
1036             return '';
1037         }
1039         if (is_null($withlinks)) {
1040             $withlinks = empty($this->page->layout_options['nologinlinks']);
1041         }
1043         $course = $this->page->course;
1044         if (\core\session\manager::is_loggedinas()) {
1045             $realuser = \core\session\manager::get_realuser();
1046             $fullname = fullname($realuser, true);
1047             if ($withlinks) {
1048                 $loginastitle = get_string('loginas');
1049                 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\"";
1050                 $realuserinfo .= "title =\"".$loginastitle."\">$fullname</a>] ";
1051             } else {
1052                 $realuserinfo = " [$fullname] ";
1053             }
1054         } else {
1055             $realuserinfo = '';
1056         }
1058         $loginpage = $this->is_login_page();
1059         $loginurl = get_login_url();
1061         if (empty($course->id)) {
1062             // $course->id is not defined during installation
1063             return '';
1064         } else if (isloggedin()) {
1065             $context = context_course::instance($course->id);
1067             $fullname = fullname($USER, true);
1068             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
1069             if ($withlinks) {
1070                 $linktitle = get_string('viewprofile');
1071                 $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\" title=\"$linktitle\">$fullname</a>";
1072             } else {
1073                 $username = $fullname;
1074             }
1075             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
1076                 if ($withlinks) {
1077                     $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
1078                 } else {
1079                     $username .= " from {$idprovider->name}";
1080                 }
1081             }
1082             if (isguestuser()) {
1083                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
1084                 if (!$loginpage && $withlinks) {
1085                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
1086                 }
1087             } else if (is_role_switched($course->id)) { // Has switched roles
1088                 $rolename = '';
1089                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
1090                     $rolename = ': '.role_get_name($role, $context);
1091                 }
1092                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename;
1093                 if ($withlinks) {
1094                     $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>0, 'returnurl'=>$this->page->url->out_as_local_url(false)));
1095                     $loggedinas .= ' ('.html_writer::tag('a', get_string('switchrolereturn'), array('href' => $url)).')';
1096                 }
1097             } else {
1098                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username);
1099                 if ($withlinks) {
1100                     $loggedinas .= " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
1101                 }
1102             }
1103         } else {
1104             $loggedinas = get_string('loggedinnot', 'moodle');
1105             if (!$loginpage && $withlinks) {
1106                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
1107             }
1108         }
1110         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
1112         if (isset($SESSION->justloggedin)) {
1113             unset($SESSION->justloggedin);
1114             if (!empty($CFG->displayloginfailures)) {
1115                 if (!isguestuser()) {
1116                     // Include this file only when required.
1117                     require_once($CFG->dirroot . '/user/lib.php');
1118                     if ($count = user_count_login_failures($USER)) {
1119                         $loggedinas .= '<div class="loginfailures">';
1120                         $a = new stdClass();
1121                         $a->attempts = $count;
1122                         $loggedinas .= get_string('failedloginattempts', '', $a);
1123                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', context_system::instance())) {
1124                             $loggedinas .= ' ('.html_writer::link(new moodle_url('/report/log/index.php', array('chooselog' => 1,
1125                                     'id' => 0 , 'modid' => 'site_errors')), get_string('logs')).')';
1126                         }
1127                         $loggedinas .= '</div>';
1128                     }
1129                 }
1130             }
1131         }
1133         return $loggedinas;
1134     }
1136     /**
1137      * Check whether the current page is a login page.
1138      *
1139      * @since Moodle 2.9
1140      * @return bool
1141      */
1142     protected function is_login_page() {
1143         // This is a real bit of a hack, but its a rarety that we need to do something like this.
1144         // In fact the login pages should be only these two pages and as exposing this as an option for all pages
1145         // could lead to abuse (or at least unneedingly complex code) the hack is the way to go.
1146         return in_array(
1147             $this->page->url->out_as_local_url(false, array()),
1148             array(
1149                 '/login/index.php',
1150                 '/login/forgot_password.php',
1151             )
1152         );
1153     }
1155     /**
1156      * Return the 'back' link that normally appears in the footer.
1157      *
1158      * @return string HTML fragment.
1159      */
1160     public function home_link() {
1161         global $CFG, $SITE;
1163         if ($this->page->pagetype == 'site-index') {
1164             // Special case for site home page - please do not remove
1165             return '<div class="sitelink">' .
1166                    '<a title="Moodle" href="http://moodle.org/">' .
1167                    '<img src="' . $this->image_url('moodlelogo_grayhat') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
1169         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
1170             // Special case for during install/upgrade.
1171             return '<div class="sitelink">'.
1172                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
1173                    '<img src="' . $this->image_url('moodlelogo_grayhat') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
1175         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
1176             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
1177                     get_string('home') . '</a></div>';
1179         } else {
1180             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
1181                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
1182         }
1183     }
1185     /**
1186      * Redirects the user by any means possible given the current state
1187      *
1188      * This function should not be called directly, it should always be called using
1189      * the redirect function in lib/weblib.php
1190      *
1191      * The redirect function should really only be called before page output has started
1192      * however it will allow itself to be called during the state STATE_IN_BODY
1193      *
1194      * @param string $encodedurl The URL to send to encoded if required
1195      * @param string $message The message to display to the user if any
1196      * @param int $delay The delay before redirecting a user, if $message has been
1197      *         set this is a requirement and defaults to 3, set to 0 no delay
1198      * @param boolean $debugdisableredirect this redirect has been disabled for
1199      *         debugging purposes. Display a message that explains, and don't
1200      *         trigger the redirect.
1201      * @param string $messagetype The type of notification to show the message in.
1202      *         See constants on \core\output\notification.
1203      * @return string The HTML to display to the user before dying, may contain
1204      *         meta refresh, javascript refresh, and may have set header redirects
1205      */
1206     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect,
1207                                      $messagetype = \core\output\notification::NOTIFY_INFO) {
1208         global $CFG;
1209         $url = str_replace('&amp;', '&', $encodedurl);
1211         switch ($this->page->state) {
1212             case moodle_page::STATE_BEFORE_HEADER :
1213                 // No output yet it is safe to delivery the full arsenal of redirect methods
1214                 if (!$debugdisableredirect) {
1215                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
1216                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
1217                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
1218                 }
1219                 $output = $this->header();
1220                 break;
1221             case moodle_page::STATE_PRINTING_HEADER :
1222                 // We should hopefully never get here
1223                 throw new coding_exception('You cannot redirect while printing the page header');
1224                 break;
1225             case moodle_page::STATE_IN_BODY :
1226                 // We really shouldn't be here but we can deal with this
1227                 debugging("You should really redirect before you start page output");
1228                 if (!$debugdisableredirect) {
1229                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
1230                 }
1231                 $output = $this->opencontainers->pop_all_but_last();
1232                 break;
1233             case moodle_page::STATE_DONE :
1234                 // Too late to be calling redirect now
1235                 throw new coding_exception('You cannot redirect after the entire page has been generated');
1236                 break;
1237         }
1238         $output .= $this->notification($message, $messagetype);
1239         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
1240         if ($debugdisableredirect) {
1241             $output .= '<p><strong>'.get_string('erroroutput', 'error').'</strong></p>';
1242         }
1243         $output .= $this->footer();
1244         return $output;
1245     }
1247     /**
1248      * Start output by sending the HTTP headers, and printing the HTML <head>
1249      * and the start of the <body>.
1250      *
1251      * To control what is printed, you should set properties on $PAGE. If you
1252      * are familiar with the old {@link print_header()} function from Moodle 1.9
1253      * you will find that there are properties on $PAGE that correspond to most
1254      * of the old parameters to could be passed to print_header.
1255      *
1256      * Not that, in due course, the remaining $navigation, $menu parameters here
1257      * will be replaced by more properties of $PAGE, but that is still to do.
1258      *
1259      * @return string HTML that you must output this, preferably immediately.
1260      */
1261     public function header() {
1262         global $USER, $CFG, $SESSION;
1264         // Give plugins an opportunity touch things before the http headers are sent
1265         // such as adding additional headers. The return value is ignored.
1266         $pluginswithfunction = get_plugins_with_function('before_http_headers', 'lib.php');
1267         foreach ($pluginswithfunction as $plugins) {
1268             foreach ($plugins as $function) {
1269                 $function();
1270             }
1271         }
1273         if (\core\session\manager::is_loggedinas()) {
1274             $this->page->add_body_class('userloggedinas');
1275         }
1277         if (isset($SESSION->justloggedin) && !empty($CFG->displayloginfailures)) {
1278             require_once($CFG->dirroot . '/user/lib.php');
1279             // Set second parameter to false as we do not want reset the counter, the same message appears on footer.
1280             if ($count = user_count_login_failures($USER, false)) {
1281                 $this->page->add_body_class('loginfailures');
1282             }
1283         }
1285         // If the user is logged in, and we're not in initial install,
1286         // check to see if the user is role-switched and add the appropriate
1287         // CSS class to the body element.
1288         if (!during_initial_install() && isloggedin() && is_role_switched($this->page->course->id)) {
1289             $this->page->add_body_class('userswitchedrole');
1290         }
1292         // Give themes a chance to init/alter the page object.
1293         $this->page->theme->init_page($this->page);
1295         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
1297         // Find the appropriate page layout file, based on $this->page->pagelayout.
1298         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
1299         // Render the layout using the layout file.
1300         $rendered = $this->render_page_layout($layoutfile);
1302         // Slice the rendered output into header and footer.
1303         $cutpos = strpos($rendered, $this->unique_main_content_token);
1304         if ($cutpos === false) {
1305             $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
1306             $token = self::MAIN_CONTENT_TOKEN;
1307         } else {
1308             $token = $this->unique_main_content_token;
1309         }
1311         if ($cutpos === false) {
1312             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.');
1313         }
1314         $header = substr($rendered, 0, $cutpos);
1315         $footer = substr($rendered, $cutpos + strlen($token));
1317         if (empty($this->contenttype)) {
1318             debugging('The page layout file did not call $OUTPUT->doctype()');
1319             $header = $this->doctype() . $header;
1320         }
1322         // If this theme version is below 2.4 release and this is a course view page
1323         if ((!isset($this->page->theme->settings->version) || $this->page->theme->settings->version < 2012101500) &&
1324                 $this->page->pagelayout === 'course' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
1325             // check if course content header/footer have not been output during render of theme layout
1326             $coursecontentheader = $this->course_content_header(true);
1327             $coursecontentfooter = $this->course_content_footer(true);
1328             if (!empty($coursecontentheader)) {
1329                 // display debug message and add header and footer right above and below main content
1330                 // Please note that course header and footer (to be displayed above and below the whole page)
1331                 // are not displayed in this case at all.
1332                 // Besides the content header and footer are not displayed on any other course page
1333                 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);
1334                 $header .= $coursecontentheader;
1335                 $footer = $coursecontentfooter. $footer;
1336             }
1337         }
1339         send_headers($this->contenttype, $this->page->cacheable);
1341         $this->opencontainers->push('header/footer', $footer);
1342         $this->page->set_state(moodle_page::STATE_IN_BODY);
1344         return $header . $this->skip_link_target('maincontent');
1345     }
1347     /**
1348      * Renders and outputs the page layout file.
1349      *
1350      * This is done by preparing the normal globals available to a script, and
1351      * then including the layout file provided by the current theme for the
1352      * requested layout.
1353      *
1354      * @param string $layoutfile The name of the layout file
1355      * @return string HTML code
1356      */
1357     protected function render_page_layout($layoutfile) {
1358         global $CFG, $SITE, $USER;
1359         // The next lines are a bit tricky. The point is, here we are in a method
1360         // of a renderer class, and this object may, or may not, be the same as
1361         // the global $OUTPUT object. When rendering the page layout file, we want to use
1362         // this object. However, people writing Moodle code expect the current
1363         // renderer to be called $OUTPUT, not $this, so define a variable called
1364         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
1365         $OUTPUT = $this;
1366         $PAGE = $this->page;
1367         $COURSE = $this->page->course;
1369         ob_start();
1370         include($layoutfile);
1371         $rendered = ob_get_contents();
1372         ob_end_clean();
1373         return $rendered;
1374     }
1376     /**
1377      * Outputs the page's footer
1378      *
1379      * @return string HTML fragment
1380      */
1381     public function footer() {
1382         global $CFG, $DB, $PAGE;
1384         // Give plugins an opportunity to touch the page before JS is finalized.
1385         $pluginswithfunction = get_plugins_with_function('before_footer', 'lib.php');
1386         foreach ($pluginswithfunction as $plugins) {
1387             foreach ($plugins as $function) {
1388                 $function();
1389             }
1390         }
1392         $output = $this->container_end_all(true);
1394         $footer = $this->opencontainers->pop('header/footer');
1396         if (debugging() and $DB and $DB->is_transaction_started()) {
1397             // TODO: MDL-20625 print warning - transaction will be rolled back
1398         }
1400         // Provide some performance info if required
1401         $performanceinfo = '';
1402         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
1403             $perf = get_performance_info();
1404             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
1405                 $performanceinfo = $perf['html'];
1406             }
1407         }
1409         // We always want performance data when running a performance test, even if the user is redirected to another page.
1410         if (MDL_PERF_TEST && strpos($footer, $this->unique_performance_info_token) === false) {
1411             $footer = $this->unique_performance_info_token . $footer;
1412         }
1413         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
1415         // Only show notifications when we have a $PAGE context id.
1416         if (!empty($PAGE->context->id)) {
1417             $this->page->requires->js_call_amd('core/notification', 'init', array(
1418                 $PAGE->context->id,
1419                 \core\notification::fetch_as_array($this)
1420             ));
1421         }
1422         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
1424         $this->page->set_state(moodle_page::STATE_DONE);
1426         return $output . $footer;
1427     }
1429     /**
1430      * Close all but the last open container. This is useful in places like error
1431      * handling, where you want to close all the open containers (apart from <body>)
1432      * before outputting the error message.
1433      *
1434      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1435      *      developer debug warning if it isn't.
1436      * @return string the HTML required to close any open containers inside <body>.
1437      */
1438     public function container_end_all($shouldbenone = false) {
1439         return $this->opencontainers->pop_all_but_last($shouldbenone);
1440     }
1442     /**
1443      * Returns course-specific information to be output immediately above content on any course page
1444      * (for the current course)
1445      *
1446      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1447      * @return string
1448      */
1449     public function course_content_header($onlyifnotcalledbefore = false) {
1450         global $CFG;
1451         static $functioncalled = false;
1452         if ($functioncalled && $onlyifnotcalledbefore) {
1453             // we have already output the content header
1454             return '';
1455         }
1457         // Output any session notification.
1458         $notifications = \core\notification::fetch();
1460         $bodynotifications = '';
1461         foreach ($notifications as $notification) {
1462             $bodynotifications .= $this->render_from_template(
1463                     $notification->get_template_name(),
1464                     $notification->export_for_template($this)
1465                 );
1466         }
1468         $output = html_writer::span($bodynotifications, 'notifications', array('id' => 'user-notifications'));
1470         if ($this->page->course->id == SITEID) {
1471             // return immediately and do not include /course/lib.php if not necessary
1472             return $output;
1473         }
1475         require_once($CFG->dirroot.'/course/lib.php');
1476         $functioncalled = true;
1477         $courseformat = course_get_format($this->page->course);
1478         if (($obj = $courseformat->course_content_header()) !== null) {
1479             $output .= html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-header');
1480         }
1481         return $output;
1482     }
1484     /**
1485      * Returns course-specific information to be output immediately below content on any course page
1486      * (for the current course)
1487      *
1488      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1489      * @return string
1490      */
1491     public function course_content_footer($onlyifnotcalledbefore = false) {
1492         global $CFG;
1493         if ($this->page->course->id == SITEID) {
1494             // return immediately and do not include /course/lib.php if not necessary
1495             return '';
1496         }
1497         static $functioncalled = false;
1498         if ($functioncalled && $onlyifnotcalledbefore) {
1499             // we have already output the content footer
1500             return '';
1501         }
1502         $functioncalled = true;
1503         require_once($CFG->dirroot.'/course/lib.php');
1504         $courseformat = course_get_format($this->page->course);
1505         if (($obj = $courseformat->course_content_footer()) !== null) {
1506             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-footer');
1507         }
1508         return '';
1509     }
1511     /**
1512      * Returns course-specific information to be output on any course page in the header area
1513      * (for the current course)
1514      *
1515      * @return string
1516      */
1517     public function course_header() {
1518         global $CFG;
1519         if ($this->page->course->id == SITEID) {
1520             // return immediately and do not include /course/lib.php if not necessary
1521             return '';
1522         }
1523         require_once($CFG->dirroot.'/course/lib.php');
1524         $courseformat = course_get_format($this->page->course);
1525         if (($obj = $courseformat->course_header()) !== null) {
1526             return $courseformat->get_renderer($this->page)->render($obj);
1527         }
1528         return '';
1529     }
1531     /**
1532      * Returns course-specific information to be output on any course page in the footer area
1533      * (for the current course)
1534      *
1535      * @return string
1536      */
1537     public function course_footer() {
1538         global $CFG;
1539         if ($this->page->course->id == SITEID) {
1540             // return immediately and do not include /course/lib.php if not necessary
1541             return '';
1542         }
1543         require_once($CFG->dirroot.'/course/lib.php');
1544         $courseformat = course_get_format($this->page->course);
1545         if (($obj = $courseformat->course_footer()) !== null) {
1546             return $courseformat->get_renderer($this->page)->render($obj);
1547         }
1548         return '';
1549     }
1551     /**
1552      * Get the course pattern datauri to show on a course card.
1553      *
1554      * The datauri is an encoded svg that can be passed as a url.
1555      * @param int $id Id to use when generating the pattern
1556      * @return string datauri
1557      */
1558     public function get_generated_image_for_id($id) {
1559         $color = $this->get_generated_color_for_id($id);
1560         $pattern = new \core_geopattern();
1561         $pattern->setColor($color);
1562         $pattern->patternbyid($id);
1563         return $pattern->datauri();
1564     }
1566     /**
1567      * Get the course color to show on a course card.
1568      *
1569      * @param int $id Id to use when generating the color.
1570      * @return string hex color code.
1571      */
1572     public function get_generated_color_for_id($id) {
1573         $colornumbers = range(1, 10);
1574         $basecolors = [];
1575         foreach ($colornumbers as $number) {
1576             $basecolors[] = get_config('core_admin', 'coursecolor' . $number);
1577         }
1579         $color = $basecolors[$id % 10];
1580         return $color;
1581     }
1583     /**
1584      * Returns lang menu or '', this method also checks forcing of languages in courses.
1585      *
1586      * This function calls {@link core_renderer::render_single_select()} to actually display the language menu.
1587      *
1588      * @return string The lang menu HTML or empty string
1589      */
1590     public function lang_menu() {
1591         global $CFG;
1593         if (empty($CFG->langmenu)) {
1594             return '';
1595         }
1597         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
1598             // do not show lang menu if language forced
1599             return '';
1600         }
1602         $currlang = current_language();
1603         $langs = get_string_manager()->get_list_of_translations();
1605         if (count($langs) < 2) {
1606             return '';
1607         }
1609         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
1610         $s->label = get_accesshide(get_string('language'));
1611         $s->class = 'langmenu';
1612         return $this->render($s);
1613     }
1615     /**
1616      * Output the row of editing icons for a block, as defined by the controls array.
1617      *
1618      * @param array $controls an array like {@link block_contents::$controls}.
1619      * @param string $blockid The ID given to the block.
1620      * @return string HTML fragment.
1621      */
1622     public function block_controls($actions, $blockid = null) {
1623         global $CFG;
1624         if (empty($actions)) {
1625             return '';
1626         }
1627         $menu = new action_menu($actions);
1628         if ($blockid !== null) {
1629             $menu->set_owner_selector('#'.$blockid);
1630         }
1631         $menu->set_constraint('.block-region');
1632         $menu->attributes['class'] .= ' block-control-actions commands';
1633         return $this->render($menu);
1634     }
1636     /**
1637      * Returns the HTML for a basic textarea field.
1638      *
1639      * @param string $name Name to use for the textarea element
1640      * @param string $id The id to use fort he textarea element
1641      * @param string $value Initial content to display in the textarea
1642      * @param int $rows Number of rows to display
1643      * @param int $cols Number of columns to display
1644      * @return string the HTML to display
1645      */
1646     public function print_textarea($name, $id, $value, $rows, $cols) {
1647         global $OUTPUT;
1649         editors_head_setup();
1650         $editor = editors_get_preferred_editor(FORMAT_HTML);
1651         $editor->set_text($value);
1652         $editor->use_editor($id, []);
1654         $context = [
1655             'id' => $id,
1656             'name' => $name,
1657             'value' => $value,
1658             'rows' => $rows,
1659             'cols' => $cols
1660         ];
1662         return $OUTPUT->render_from_template('core_form/editor_textarea', $context);
1663     }
1665     /**
1666      * Renders an action menu component.
1667      *
1668      * @param action_menu $menu
1669      * @return string HTML
1670      */
1671     public function render_action_menu(action_menu $menu) {
1673         // We don't want the class icon there!
1674         foreach ($menu->get_secondary_actions() as $action) {
1675             if ($action instanceof \action_menu_link && $action->has_class('icon')) {
1676                 $action->attributes['class'] = preg_replace('/(^|\s+)icon(\s+|$)/i', '', $action->attributes['class']);
1677             }
1678         }
1680         if ($menu->is_empty()) {
1681             return '';
1682         }
1683         $context = $menu->export_for_template($this);
1685         return $this->render_from_template('core/action_menu', $context);
1686     }
1688     /**
1689      * Renders an action_menu_link item.
1690      *
1691      * @param action_menu_link $action
1692      * @return string HTML fragment
1693      */
1694     protected function render_action_menu_link(action_menu_link $action) {
1695         return $this->render_from_template('core/action_menu_link', $action->export_for_template($this));
1696     }
1698     /**
1699      * Renders a primary action_menu_filler item.
1700      *
1701      * @param action_menu_link_filler $action
1702      * @return string HTML fragment
1703      */
1704     protected function render_action_menu_filler(action_menu_filler $action) {
1705         return html_writer::span('&nbsp;', 'filler');
1706     }
1708     /**
1709      * Renders a primary action_menu_link item.
1710      *
1711      * @param action_menu_link_primary $action
1712      * @return string HTML fragment
1713      */
1714     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1715         return $this->render_action_menu_link($action);
1716     }
1718     /**
1719      * Renders a secondary action_menu_link item.
1720      *
1721      * @param action_menu_link_secondary $action
1722      * @return string HTML fragment
1723      */
1724     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1725         return $this->render_action_menu_link($action);
1726     }
1728     /**
1729      * Prints a nice side block with an optional header.
1730      *
1731      * @param block_contents $bc HTML for the content
1732      * @param string $region the region the block is appearing in.
1733      * @return string the HTML to be output.
1734      */
1735     public function block(block_contents $bc, $region) {
1736         $bc = clone($bc); // Avoid messing up the object passed in.
1737         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1738             $bc->collapsible = block_contents::NOT_HIDEABLE;
1739         }
1741         $id = !empty($bc->attributes['id']) ? $bc->attributes['id'] : uniqid('block-');
1742         $context = new stdClass();
1743         $context->skipid = $bc->skipid;
1744         $context->blockinstanceid = $bc->blockinstanceid;
1745         $context->dockable = $bc->dockable;
1746         $context->id = $id;
1747         $context->hidden = $bc->collapsible == block_contents::HIDDEN;
1748         $context->skiptitle = strip_tags($bc->title);
1749         $context->showskiplink = !empty($context->skiptitle);
1750         $context->arialabel = $bc->arialabel;
1751         $context->ariarole = !empty($bc->attributes['role']) ? $bc->attributes['role'] : 'complementary';
1752         $context->class = $bc->attributes['class'];
1753         $context->type = $bc->attributes['data-block'];
1754         $context->title = $bc->title;
1755         $context->content = $bc->content;
1756         $context->annotation = $bc->annotation;
1757         $context->footer = $bc->footer;
1758         $context->hascontrols = !empty($bc->controls);
1759         if ($context->hascontrols) {
1760             $context->controls = $this->block_controls($bc->controls, $id);
1761         }
1763         return $this->render_from_template('core/block', $context);
1764     }
1766     /**
1767      * Render the contents of a block_list.
1768      *
1769      * @param array $icons the icon for each item.
1770      * @param array $items the content of each item.
1771      * @return string HTML
1772      */
1773     public function list_block_contents($icons, $items) {
1774         $row = 0;
1775         $lis = array();
1776         foreach ($items as $key => $string) {
1777             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1778             if (!empty($icons[$key])) { //test if the content has an assigned icon
1779                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1780             }
1781             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1782             $item .= html_writer::end_tag('li');
1783             $lis[] = $item;
1784             $row = 1 - $row; // Flip even/odd.
1785         }
1786         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1787     }
1789     /**
1790      * Output all the blocks in a particular region.
1791      *
1792      * @param string $region the name of a region on this page.
1793      * @return string the HTML to be output.
1794      */
1795     public function blocks_for_region($region) {
1796         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1797         $blocks = $this->page->blocks->get_blocks_for_region($region);
1798         $lastblock = null;
1799         $zones = array();
1800         foreach ($blocks as $block) {
1801             $zones[] = $block->title;
1802         }
1803         $output = '';
1805         foreach ($blockcontents as $bc) {
1806             if ($bc instanceof block_contents) {
1807                 $output .= $this->block($bc, $region);
1808                 $lastblock = $bc->title;
1809             } else if ($bc instanceof block_move_target) {
1810                 $output .= $this->block_move_target($bc, $zones, $lastblock, $region);
1811             } else {
1812                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1813             }
1814         }
1815         return $output;
1816     }
1818     /**
1819      * Output a place where the block that is currently being moved can be dropped.
1820      *
1821      * @param block_move_target $target with the necessary details.
1822      * @param array $zones array of areas where the block can be moved to
1823      * @param string $previous the block located before the area currently being rendered.
1824      * @param string $region the name of the region
1825      * @return string the HTML to be output.
1826      */
1827     public function block_move_target($target, $zones, $previous, $region) {
1828         if ($previous == null) {
1829             if (empty($zones)) {
1830                 // There are no zones, probably because there are no blocks.
1831                 $regions = $this->page->theme->get_all_block_regions();
1832                 $position = get_string('moveblockinregion', 'block', $regions[$region]);
1833             } else {
1834                 $position = get_string('moveblockbefore', 'block', $zones[0]);
1835             }
1836         } else {
1837             $position = get_string('moveblockafter', 'block', $previous);
1838         }
1839         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1840     }
1842     /**
1843      * Renders a special html link with attached action
1844      *
1845      * Theme developers: DO NOT OVERRIDE! Please override function
1846      * {@link core_renderer::render_action_link()} instead.
1847      *
1848      * @param string|moodle_url $url
1849      * @param string $text HTML fragment
1850      * @param component_action $action
1851      * @param array $attributes associative array of html link attributes + disabled
1852      * @param pix_icon optional pix icon to render with the link
1853      * @return string HTML fragment
1854      */
1855     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1856         if (!($url instanceof moodle_url)) {
1857             $url = new moodle_url($url);
1858         }
1859         $link = new action_link($url, $text, $action, $attributes, $icon);
1861         return $this->render($link);
1862     }
1864     /**
1865      * Renders an action_link object.
1866      *
1867      * The provided link is renderer and the HTML returned. At the same time the
1868      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1869      *
1870      * @param action_link $link
1871      * @return string HTML fragment
1872      */
1873     protected function render_action_link(action_link $link) {
1874         return $this->render_from_template('core/action_link', $link->export_for_template($this));
1875     }
1877     /**
1878      * Renders an action_icon.
1879      *
1880      * This function uses the {@link core_renderer::action_link()} method for the
1881      * most part. What it does different is prepare the icon as HTML and use it
1882      * as the link text.
1883      *
1884      * Theme developers: If you want to change how action links and/or icons are rendered,
1885      * consider overriding function {@link core_renderer::render_action_link()} and
1886      * {@link core_renderer::render_pix_icon()}.
1887      *
1888      * @param string|moodle_url $url A string URL or moodel_url
1889      * @param pix_icon $pixicon
1890      * @param component_action $action
1891      * @param array $attributes associative array of html link attributes + disabled
1892      * @param bool $linktext show title next to image in link
1893      * @return string HTML fragment
1894      */
1895     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1896         if (!($url instanceof moodle_url)) {
1897             $url = new moodle_url($url);
1898         }
1899         $attributes = (array)$attributes;
1901         if (empty($attributes['class'])) {
1902             // let ppl override the class via $options
1903             $attributes['class'] = 'action-icon';
1904         }
1906         $icon = $this->render($pixicon);
1908         if ($linktext) {
1909             $text = $pixicon->attributes['alt'];
1910         } else {
1911             $text = '';
1912         }
1914         return $this->action_link($url, $text.$icon, $action, $attributes);
1915     }
1917    /**
1918     * Print a message along with button choices for Continue/Cancel
1919     *
1920     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1921     *
1922     * @param string $message The question to ask the user
1923     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1924     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1925     * @return string HTML fragment
1926     */
1927     public function confirm($message, $continue, $cancel) {
1928         if ($continue instanceof single_button) {
1929             // ok
1930             $continue->primary = true;
1931         } else if (is_string($continue)) {
1932             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post', true);
1933         } else if ($continue instanceof moodle_url) {
1934             $continue = new single_button($continue, get_string('continue'), 'post', true);
1935         } else {
1936             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1937         }
1939         if ($cancel instanceof single_button) {
1940             // ok
1941         } else if (is_string($cancel)) {
1942             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1943         } else if ($cancel instanceof moodle_url) {
1944             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1945         } else {
1946             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1947         }
1949         $attributes = [
1950             'role'=>'alertdialog',
1951             'aria-labelledby'=>'modal-header',
1952             'aria-describedby'=>'modal-body',
1953             'aria-modal'=>'true'
1954         ];
1956         $output = $this->box_start('generalbox modal modal-dialog modal-in-page show', 'notice', $attributes);
1957         $output .= $this->box_start('modal-content', 'modal-content');
1958         $output .= $this->box_start('modal-header p-x-1', 'modal-header');
1959         $output .= html_writer::tag('h4', get_string('confirm'));
1960         $output .= $this->box_end();
1961         $attributes = [
1962             'role'=>'alert',
1963             'data-aria-autofocus'=>'true'
1964         ];
1965         $output .= $this->box_start('modal-body', 'modal-body', $attributes);
1966         $output .= html_writer::tag('p', $message);
1967         $output .= $this->box_end();
1968         $output .= $this->box_start('modal-footer', 'modal-footer');
1969         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1970         $output .= $this->box_end();
1971         $output .= $this->box_end();
1972         $output .= $this->box_end();
1973         return $output;
1974     }
1976     /**
1977      * Returns a form with a single button.
1978      *
1979      * Theme developers: DO NOT OVERRIDE! Please override function
1980      * {@link core_renderer::render_single_button()} instead.
1981      *
1982      * @param string|moodle_url $url
1983      * @param string $label button text
1984      * @param string $method get or post submit method
1985      * @param array $options associative array {disabled, title, etc.}
1986      * @return string HTML fragment
1987      */
1988     public function single_button($url, $label, $method='post', array $options=null) {
1989         if (!($url instanceof moodle_url)) {
1990             $url = new moodle_url($url);
1991         }
1992         $button = new single_button($url, $label, $method);
1994         foreach ((array)$options as $key=>$value) {
1995             if (array_key_exists($key, $button)) {
1996                 $button->$key = $value;
1997             }
1998         }
2000         return $this->render($button);
2001     }
2003     /**
2004      * Renders a single button widget.
2005      *
2006      * This will return HTML to display a form containing a single button.
2007      *
2008      * @param single_button $button
2009      * @return string HTML fragment
2010      */
2011     protected function render_single_button(single_button $button) {
2012         return $this->render_from_template('core/single_button', $button->export_for_template($this));
2013     }
2015     /**
2016      * Returns a form with a single select widget.
2017      *
2018      * Theme developers: DO NOT OVERRIDE! Please override function
2019      * {@link core_renderer::render_single_select()} instead.
2020      *
2021      * @param moodle_url $url form action target, includes hidden fields
2022      * @param string $name name of selection field - the changing parameter in url
2023      * @param array $options list of options
2024      * @param string $selected selected element
2025      * @param array $nothing
2026      * @param string $formid
2027      * @param array $attributes other attributes for the single select
2028      * @return string HTML fragment
2029      */
2030     public function single_select($url, $name, array $options, $selected = '',
2031                                 $nothing = array('' => 'choosedots'), $formid = null, $attributes = array()) {
2032         if (!($url instanceof moodle_url)) {
2033             $url = new moodle_url($url);
2034         }
2035         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
2037         if (array_key_exists('label', $attributes)) {
2038             $select->set_label($attributes['label']);
2039             unset($attributes['label']);
2040         }
2041         $select->attributes = $attributes;
2043         return $this->render($select);
2044     }
2046     /**
2047      * Returns a dataformat selection and download form
2048      *
2049      * @param string $label A text label
2050      * @param moodle_url|string $base The download page url
2051      * @param string $name The query param which will hold the type of the download
2052      * @param array $params Extra params sent to the download page
2053      * @return string HTML fragment
2054      */
2055     public function download_dataformat_selector($label, $base, $name = 'dataformat', $params = array()) {
2057         $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
2058         $options = array();
2059         foreach ($formats as $format) {
2060             if ($format->is_enabled()) {
2061                 $options[] = array(
2062                     'value' => $format->name,
2063                     'label' => get_string('dataformat', $format->component),
2064                 );
2065             }
2066         }
2067         $hiddenparams = array();
2068         foreach ($params as $key => $value) {
2069             $hiddenparams[] = array(
2070                 'name' => $key,
2071                 'value' => $value,
2072             );
2073         }
2074         $data = array(
2075             'label' => $label,
2076             'base' => $base,
2077             'name' => $name,
2078             'params' => $hiddenparams,
2079             'options' => $options,
2080             'sesskey' => sesskey(),
2081             'submit' => get_string('download'),
2082         );
2084         return $this->render_from_template('core/dataformat_selector', $data);
2085     }
2088     /**
2089      * Internal implementation of single_select rendering
2090      *
2091      * @param single_select $select
2092      * @return string HTML fragment
2093      */
2094     protected function render_single_select(single_select $select) {
2095         return $this->render_from_template('core/single_select', $select->export_for_template($this));
2096     }
2098     /**
2099      * Returns a form with a url select widget.
2100      *
2101      * Theme developers: DO NOT OVERRIDE! Please override function
2102      * {@link core_renderer::render_url_select()} instead.
2103      *
2104      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
2105      * @param string $selected selected element
2106      * @param array $nothing
2107      * @param string $formid
2108      * @return string HTML fragment
2109      */
2110     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
2111         $select = new url_select($urls, $selected, $nothing, $formid);
2112         return $this->render($select);
2113     }
2115     /**
2116      * Internal implementation of url_select rendering
2117      *
2118      * @param url_select $select
2119      * @return string HTML fragment
2120      */
2121     protected function render_url_select(url_select $select) {
2122         return $this->render_from_template('core/url_select', $select->export_for_template($this));
2123     }
2125     /**
2126      * Returns a string containing a link to the user documentation.
2127      * Also contains an icon by default. Shown to teachers and admin only.
2128      *
2129      * @param string $path The page link after doc root and language, no leading slash.
2130      * @param string $text The text to be displayed for the link
2131      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
2132      * @return string
2133      */
2134     public function doc_link($path, $text = '', $forcepopup = false) {
2135         global $CFG;
2137         $icon = $this->pix_icon('docs', '', 'moodle', array('class'=>'iconhelp icon-pre', 'role'=>'presentation'));
2139         $url = new moodle_url(get_docs_url($path));
2141         $attributes = array('href'=>$url);
2142         if (!empty($CFG->doctonewwindow) || $forcepopup) {
2143             $attributes['class'] = 'helplinkpopup';
2144         }
2146         return html_writer::tag('a', $icon.$text, $attributes);
2147     }
2149     /**
2150      * Return HTML for an image_icon.
2151      *
2152      * Theme developers: DO NOT OVERRIDE! Please override function
2153      * {@link core_renderer::render_image_icon()} instead.
2154      *
2155      * @param string $pix short pix name
2156      * @param string $alt mandatory alt attribute
2157      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2158      * @param array $attributes htm lattributes
2159      * @return string HTML fragment
2160      */
2161     public function image_icon($pix, $alt, $component='moodle', array $attributes = null) {
2162         $icon = new image_icon($pix, $alt, $component, $attributes);
2163         return $this->render($icon);
2164     }
2166     /**
2167      * Renders a pix_icon widget and returns the HTML to display it.
2168      *
2169      * @param image_icon $icon
2170      * @return string HTML fragment
2171      */
2172     protected function render_image_icon(image_icon $icon) {
2173         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2174         return $system->render_pix_icon($this, $icon);
2175     }
2177     /**
2178      * Return HTML for a pix_icon.
2179      *
2180      * Theme developers: DO NOT OVERRIDE! Please override function
2181      * {@link core_renderer::render_pix_icon()} instead.
2182      *
2183      * @param string $pix short pix name
2184      * @param string $alt mandatory alt attribute
2185      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2186      * @param array $attributes htm lattributes
2187      * @return string HTML fragment
2188      */
2189     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
2190         $icon = new pix_icon($pix, $alt, $component, $attributes);
2191         return $this->render($icon);
2192     }
2194     /**
2195      * Renders a pix_icon widget and returns the HTML to display it.
2196      *
2197      * @param pix_icon $icon
2198      * @return string HTML fragment
2199      */
2200     protected function render_pix_icon(pix_icon $icon) {
2201         $system = \core\output\icon_system::instance();
2202         return $system->render_pix_icon($this, $icon);
2203     }
2205     /**
2206      * Return HTML to display an emoticon icon.
2207      *
2208      * @param pix_emoticon $emoticon
2209      * @return string HTML fragment
2210      */
2211     protected function render_pix_emoticon(pix_emoticon $emoticon) {
2212         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2213         return $system->render_pix_icon($this, $emoticon);
2214     }
2216     /**
2217      * Produces the html that represents this rating in the UI
2218      *
2219      * @param rating $rating the page object on which this rating will appear
2220      * @return string
2221      */
2222     function render_rating(rating $rating) {
2223         global $CFG, $USER;
2225         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
2226             return null;//ratings are turned off
2227         }
2229         $ratingmanager = new rating_manager();
2230         // Initialise the JavaScript so ratings can be done by AJAX.
2231         $ratingmanager->initialise_rating_javascript($this->page);
2233         $strrate = get_string("rate", "rating");
2234         $ratinghtml = ''; //the string we'll return
2236         // permissions check - can they view the aggregate?
2237         if ($rating->user_can_view_aggregate()) {
2239             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
2240             $aggregatestr   = $rating->get_aggregate_string();
2242             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
2243             if ($rating->count > 0) {
2244                 $countstr = "({$rating->count})";
2245             } else {
2246                 $countstr = '-';
2247             }
2248             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
2250             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
2251             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
2253                 $nonpopuplink = $rating->get_view_ratings_url();
2254                 $popuplink = $rating->get_view_ratings_url(true);
2256                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
2257                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
2258             } else {
2259                 $ratinghtml .= $aggregatehtml;
2260             }
2261         }
2263         $formstart = null;
2264         // if the item doesn't belong to the current user, the user has permission to rate
2265         // and we're within the assessable period
2266         if ($rating->user_can_rate()) {
2268             $rateurl = $rating->get_rate_url();
2269             $inputs = $rateurl->params();
2271             //start the rating form
2272             $formattrs = array(
2273                 'id'     => "postrating{$rating->itemid}",
2274                 'class'  => 'postratingform',
2275                 'method' => 'post',
2276                 'action' => $rateurl->out_omit_querystring()
2277             );
2278             $formstart  = html_writer::start_tag('form', $formattrs);
2279             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2281             // add the hidden inputs
2282             foreach ($inputs as $name => $value) {
2283                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2284                 $formstart .= html_writer::empty_tag('input', $attributes);
2285             }
2287             if (empty($ratinghtml)) {
2288                 $ratinghtml .= $strrate.': ';
2289             }
2290             $ratinghtml = $formstart.$ratinghtml;
2292             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2293             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2294             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2295             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2297             //output submit button
2298             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2300             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2301             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2303             if (!$rating->settings->scale->isnumeric) {
2304                 // If a global scale, try to find current course ID from the context
2305                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2306                     $courseid = $coursecontext->instanceid;
2307                 } else {
2308                     $courseid = $rating->settings->scale->courseid;
2309                 }
2310                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2311             }
2312             $ratinghtml .= html_writer::end_tag('span');
2313             $ratinghtml .= html_writer::end_tag('div');
2314             $ratinghtml .= html_writer::end_tag('form');
2315         }
2317         return $ratinghtml;
2318     }
2320     /**
2321      * Centered heading with attached help button (same title text)
2322      * and optional icon attached.
2323      *
2324      * @param string $text A heading text
2325      * @param string $helpidentifier The keyword that defines a help page
2326      * @param string $component component name
2327      * @param string|moodle_url $icon
2328      * @param string $iconalt icon alt text
2329      * @param int $level The level of importance of the heading. Defaulting to 2
2330      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2331      * @return string HTML fragment
2332      */
2333     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2334         $image = '';
2335         if ($icon) {
2336             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon iconlarge'));
2337         }
2339         $help = '';
2340         if ($helpidentifier) {
2341             $help = $this->help_icon($helpidentifier, $component);
2342         }
2344         return $this->heading($image.$text.$help, $level, $classnames);
2345     }
2347     /**
2348      * Returns HTML to display a help icon.
2349      *
2350      * @deprecated since Moodle 2.0
2351      */
2352     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2353         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2354     }
2356     /**
2357      * Returns HTML to display a help icon.
2358      *
2359      * Theme developers: DO NOT OVERRIDE! Please override function
2360      * {@link core_renderer::render_help_icon()} instead.
2361      *
2362      * @param string $identifier The keyword that defines a help page
2363      * @param string $component component name
2364      * @param string|bool $linktext true means use $title as link text, string means link text value
2365      * @return string HTML fragment
2366      */
2367     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2368         $icon = new help_icon($identifier, $component);
2369         $icon->diag_strings();
2370         if ($linktext === true) {
2371             $icon->linktext = get_string($icon->identifier, $icon->component);
2372         } else if (!empty($linktext)) {
2373             $icon->linktext = $linktext;
2374         }
2375         return $this->render($icon);
2376     }
2378     /**
2379      * Implementation of user image rendering.
2380      *
2381      * @param help_icon $helpicon A help icon instance
2382      * @return string HTML fragment
2383      */
2384     protected function render_help_icon(help_icon $helpicon) {
2385         $context = $helpicon->export_for_template($this);
2386         return $this->render_from_template('core/help_icon', $context);
2387     }
2389     /**
2390      * Returns HTML to display a scale help icon.
2391      *
2392      * @param int $courseid
2393      * @param stdClass $scale instance
2394      * @return string HTML fragment
2395      */
2396     public function help_icon_scale($courseid, stdClass $scale) {
2397         global $CFG;
2399         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2401         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2403         $scaleid = abs($scale->id);
2405         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2406         $action = new popup_action('click', $link, 'ratingscale');
2408         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2409     }
2411     /**
2412      * Creates and returns a spacer image with optional line break.
2413      *
2414      * @param array $attributes Any HTML attributes to add to the spaced.
2415      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2416      *     laxy do it with CSS which is a much better solution.
2417      * @return string HTML fragment
2418      */
2419     public function spacer(array $attributes = null, $br = false) {
2420         $attributes = (array)$attributes;
2421         if (empty($attributes['width'])) {
2422             $attributes['width'] = 1;
2423         }
2424         if (empty($attributes['height'])) {
2425             $attributes['height'] = 1;
2426         }
2427         $attributes['class'] = 'spacer';
2429         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2431         if (!empty($br)) {
2432             $output .= '<br />';
2433         }
2435         return $output;
2436     }
2438     /**
2439      * Returns HTML to display the specified user's avatar.
2440      *
2441      * User avatar may be obtained in two ways:
2442      * <pre>
2443      * // Option 1: (shortcut for simple cases, preferred way)
2444      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2445      * $OUTPUT->user_picture($user, array('popup'=>true));
2446      *
2447      * // Option 2:
2448      * $userpic = new user_picture($user);
2449      * // Set properties of $userpic
2450      * $userpic->popup = true;
2451      * $OUTPUT->render($userpic);
2452      * </pre>
2453      *
2454      * Theme developers: DO NOT OVERRIDE! Please override function
2455      * {@link core_renderer::render_user_picture()} instead.
2456      *
2457      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2458      *     If any of these are missing, the database is queried. Avoid this
2459      *     if at all possible, particularly for reports. It is very bad for performance.
2460      * @param array $options associative array with user picture options, used only if not a user_picture object,
2461      *     options are:
2462      *     - courseid=$this->page->course->id (course id of user profile in link)
2463      *     - size=35 (size of image)
2464      *     - link=true (make image clickable - the link leads to user profile)
2465      *     - popup=false (open in popup)
2466      *     - alttext=true (add image alt attribute)
2467      *     - class = image class attribute (default 'userpicture')
2468      *     - visibletoscreenreaders=true (whether to be visible to screen readers)
2469      *     - includefullname=false (whether to include the user's full name together with the user picture)
2470      *     - includetoken = false (whether to use a token for authentication. True for current user, int value for other user id)
2471      * @return string HTML fragment
2472      */
2473     public function user_picture(stdClass $user, array $options = null) {
2474         $userpicture = new user_picture($user);
2475         foreach ((array)$options as $key=>$value) {
2476             if (array_key_exists($key, $userpicture)) {
2477                 $userpicture->$key = $value;
2478             }
2479         }
2480         return $this->render($userpicture);
2481     }
2483     /**
2484      * Internal implementation of user image rendering.
2485      *
2486      * @param user_picture $userpicture
2487      * @return string
2488      */
2489     protected function render_user_picture(user_picture $userpicture) {
2490         global $CFG, $DB;
2492         $user = $userpicture->user;
2493         $canviewfullnames = has_capability('moodle/site:viewfullnames', $this->page->context);
2495         if ($userpicture->alttext) {
2496             if (!empty($user->imagealt)) {
2497                 $alt = $user->imagealt;
2498             } else {
2499                 $alt = get_string('pictureof', '', fullname($user, $canviewfullnames));
2500             }
2501         } else {
2502             $alt = '';
2503         }
2505         if (empty($userpicture->size)) {
2506             $size = 35;
2507         } else if ($userpicture->size === true or $userpicture->size == 1) {
2508             $size = 100;
2509         } else {
2510             $size = $userpicture->size;
2511         }
2513         $class = $userpicture->class;
2515         if ($user->picture == 0) {
2516             $class .= ' defaultuserpic';
2517         }
2519         $src = $userpicture->get_url($this->page, $this);
2521         $attributes = array('src' => $src, 'class' => $class, 'width' => $size, 'height' => $size);
2522         if (!$userpicture->visibletoscreenreaders) {
2523             $attributes['role'] = 'presentation';
2524             $alt = '';
2525             $attributes['aria-hidden'] = 'true';
2526         }
2528         if (!empty($alt)) {
2529             $attributes['alt'] = $alt;
2530             $attributes['title'] = $alt;
2531         }
2533         // get the image html output fisrt
2534         $output = html_writer::empty_tag('img', $attributes);
2536         // Show fullname together with the picture when desired.
2537         if ($userpicture->includefullname) {
2538             $output .= fullname($userpicture->user, $canviewfullnames);
2539         }
2541         // then wrap it in link if needed
2542         if (!$userpicture->link) {
2543             return $output;
2544         }
2546         if (empty($userpicture->courseid)) {
2547             $courseid = $this->page->course->id;
2548         } else {
2549             $courseid = $userpicture->courseid;
2550         }
2552         if ($courseid == SITEID) {
2553             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2554         } else {
2555             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2556         }
2558         $attributes = array('href'=>$url);
2559         if (!$userpicture->visibletoscreenreaders) {
2560             $attributes['tabindex'] = '-1';
2561             $attributes['aria-hidden'] = 'true';
2562         }
2564         if ($userpicture->popup) {
2565             $id = html_writer::random_id('userpicture');
2566             $attributes['id'] = $id;
2567             $this->add_action_handler(new popup_action('click', $url), $id);
2568         }
2570         return html_writer::tag('a', $output, $attributes);
2571     }
2573     /**
2574      * Internal implementation of file tree viewer items rendering.
2575      *
2576      * @param array $dir
2577      * @return string
2578      */
2579     public function htmllize_file_tree($dir) {
2580         if (empty($dir['subdirs']) and empty($dir['files'])) {
2581             return '';
2582         }
2583         $result = '<ul>';
2584         foreach ($dir['subdirs'] as $subdir) {
2585             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2586         }
2587         foreach ($dir['files'] as $file) {
2588             $filename = $file->get_filename();
2589             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2590         }
2591         $result .= '</ul>';
2593         return $result;
2594     }
2596     /**
2597      * Returns HTML to display the file picker
2598      *
2599      * <pre>
2600      * $OUTPUT->file_picker($options);
2601      * </pre>
2602      *
2603      * Theme developers: DO NOT OVERRIDE! Please override function
2604      * {@link core_renderer::render_file_picker()} instead.
2605      *
2606      * @param array $options associative array with file manager options
2607      *   options are:
2608      *       maxbytes=>-1,
2609      *       itemid=>0,
2610      *       client_id=>uniqid(),
2611      *       acepted_types=>'*',
2612      *       return_types=>FILE_INTERNAL,
2613      *       context=>$PAGE->context
2614      * @return string HTML fragment
2615      */
2616     public function file_picker($options) {
2617         $fp = new file_picker($options);
2618         return $this->render($fp);
2619     }
2621     /**
2622      * Internal implementation of file picker rendering.
2623      *
2624      * @param file_picker $fp
2625      * @return string
2626      */
2627     public function render_file_picker(file_picker $fp) {
2628         global $CFG, $OUTPUT, $USER;
2629         $options = $fp->options;
2630         $client_id = $options->client_id;
2631         $strsaved = get_string('filesaved', 'repository');
2632         $straddfile = get_string('openpicker', 'repository');
2633         $strloading  = get_string('loading', 'repository');
2634         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2635         $strdroptoupload = get_string('droptoupload', 'moodle');
2636         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2638         $currentfile = $options->currentfile;
2639         if (empty($currentfile)) {
2640             $currentfile = '';
2641         } else {
2642             $currentfile .= ' - ';
2643         }
2644         if ($options->maxbytes) {
2645             $size = $options->maxbytes;
2646         } else {
2647             $size = get_max_upload_file_size();
2648         }
2649         if ($size == -1) {
2650             $maxsize = '';
2651         } else {
2652             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2653         }
2654         if ($options->buttonname) {
2655             $buttonname = ' name="' . $options->buttonname . '"';
2656         } else {
2657             $buttonname = '';
2658         }
2659         $html = <<<EOD
2660 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2661 $icon_progress
2662 </div>
2663 <div id="filepicker-wrapper-{$client_id}" class="mdl-left w-100" style="display:none">
2664     <div>
2665         <input type="button" class="btn btn-secondary fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2666         <span> $maxsize </span>
2667     </div>
2668 EOD;
2669         if ($options->env != 'url') {
2670             $html .= <<<EOD
2671     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2672     <div class="filepicker-filename">
2673         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2674         <div class="dndupload-progressbars"></div>
2675     </div>
2676     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2677     </div>
2678 EOD;
2679         }
2680         $html .= '</div>';
2681         return $html;
2682     }
2684     /**
2685      * @deprecated since Moodle 3.2
2686      */
2687     public function update_module_button() {
2688         throw new coding_exception('core_renderer::update_module_button() can not be used anymore. Activity ' .
2689             'modules should not add the edit module button, the link is already available in the Administration block. ' .
2690             'Themes can choose to display the link in the buttons row consistently for all module types.');
2691     }
2693     /**
2694      * Returns HTML to display a "Turn editing on/off" button in a form.
2695      *
2696      * @param moodle_url $url The URL + params to send through when clicking the button
2697      * @return string HTML the button
2698      */
2699     public function edit_button(moodle_url $url) {
2701         $url->param('sesskey', sesskey());
2702         if ($this->page->user_is_editing()) {
2703             $url->param('edit', 'off');
2704             $editstring = get_string('turneditingoff');
2705         } else {
2706             $url->param('edit', 'on');
2707             $editstring = get_string('turneditingon');
2708         }
2710         return $this->single_button($url, $editstring);
2711     }
2713     /**
2714      * Returns HTML to display a simple button to close a window
2715      *
2716      * @param string $text The lang string for the button's label (already output from get_string())
2717      * @return string html fragment
2718      */
2719     public function close_window_button($text='') {
2720         if (empty($text)) {
2721             $text = get_string('closewindow');
2722         }
2723         $button = new single_button(new moodle_url('#'), $text, 'get');
2724         $button->add_action(new component_action('click', 'close_window'));
2726         return $this->container($this->render($button), 'closewindow');
2727     }
2729     /**
2730      * Output an error message. By default wraps the error message in <span class="error">.
2731      * If the error message is blank, nothing is output.
2732      *
2733      * @param string $message the error message.
2734      * @return string the HTML to output.
2735      */
2736     public function error_text($message) {
2737         if (empty($message)) {
2738             return '';
2739         }
2740         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2741         return html_writer::tag('span', $message, array('class' => 'error'));
2742     }
2744     /**
2745      * Do not call this function directly.
2746      *
2747      * To terminate the current script with a fatal error, call the {@link print_error}
2748      * function, or throw an exception. Doing either of those things will then call this
2749      * function to display the error, before terminating the execution.
2750      *
2751      * @param string $message The message to output
2752      * @param string $moreinfourl URL where more info can be found about the error
2753      * @param string $link Link for the Continue button
2754      * @param array $backtrace The execution backtrace
2755      * @param string $debuginfo Debugging information
2756      * @return string the HTML to output.
2757      */
2758     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
2759         global $CFG;
2761         $output = '';
2762         $obbuffer = '';
2764         if ($this->has_started()) {
2765             // we can not always recover properly here, we have problems with output buffering,
2766             // html tables, etc.
2767             $output .= $this->opencontainers->pop_all_but_last();
2769         } else {
2770             // It is really bad if library code throws exception when output buffering is on,
2771             // because the buffered text would be printed before our start of page.
2772             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2773             error_reporting(0); // disable notices from gzip compression, etc.
2774             while (ob_get_level() > 0) {
2775                 $buff = ob_get_clean();
2776                 if ($buff === false) {
2777                     break;
2778                 }
2779                 $obbuffer .= $buff;
2780             }
2781             error_reporting($CFG->debug);
2783             // Output not yet started.
2784             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2785             if (empty($_SERVER['HTTP_RANGE'])) {
2786                 @header($protocol . ' 404 Not Found');
2787             } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
2788                 // Coax iOS 10 into sending the session cookie.
2789                 @header($protocol . ' 403 Forbidden');
2790             } else {
2791                 // Must stop byteserving attempts somehow,
2792                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2793                 @header($protocol . ' 407 Proxy Authentication Required');
2794             }
2796             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2797             $this->page->set_url('/'); // no url
2798             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2799             $this->page->set_title(get_string('error'));
2800             $this->page->set_heading($this->page->course->fullname);
2801             $output .= $this->header();
2802         }
2804         $message = '<p class="errormessage">' . $message . '</p>'.
2805                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2806                 get_string('moreinformation') . '</a></p>';
2807         if (empty($CFG->rolesactive)) {
2808             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2809             //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.
2810         }
2811         $output .= $this->box($message, 'errorbox alert alert-danger', null, array('data-rel' => 'fatalerror'));
2813         if ($CFG->debugdeveloper) {
2814             $labelsep = get_string('labelsep', 'langconfig');
2815             if (!empty($debuginfo)) {
2816                 $debuginfo = s($debuginfo); // removes all nasty JS
2817                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2818                 $label = get_string('debuginfo', 'debug') . $labelsep;
2819                 $output .= $this->notification("<strong>$label</strong> " . $debuginfo, 'notifytiny');
2820             }
2821             if (!empty($backtrace)) {
2822                 $label = get_string('stacktrace', 'debug') . $labelsep;
2823                 $output .= $this->notification("<strong>$label</strong> " . format_backtrace($backtrace), 'notifytiny');
2824             }
2825             if ($obbuffer !== '' ) {
2826                 $label = get_string('outputbuffer', 'debug') . $labelsep;
2827                 $output .= $this->notification("<strong>$label</strong> " . s($obbuffer), 'notifytiny');
2828             }
2829         }
2831         if (empty($CFG->rolesactive)) {
2832             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2833         } else if (!empty($link)) {
2834             $output .= $this->continue_button($link);
2835         }
2837         $output .= $this->footer();
2839         // Padding to encourage IE to display our error page, rather than its own.
2840         $output .= str_repeat(' ', 512);
2842         return $output;
2843     }
2845     /**
2846      * Output a notification (that is, a status message about something that has just happened).
2847      *
2848      * Note: \core\notification::add() may be more suitable for your usage.
2849      *
2850      * @param string $message The message to print out.
2851      * @param string $type    The type of notification. See constants on \core\output\notification.
2852      * @return string the HTML to output.
2853      */
2854     public function notification($message, $type = null) {
2855         $typemappings = [
2856             // Valid types.
2857             'success'           => \core\output\notification::NOTIFY_SUCCESS,
2858             'info'              => \core\output\notification::NOTIFY_INFO,
2859             'warning'           => \core\output\notification::NOTIFY_WARNING,
2860             'error'             => \core\output\notification::NOTIFY_ERROR,
2862             // Legacy types mapped to current types.
2863             'notifyproblem'     => \core\output\notification::NOTIFY_ERROR,
2864             'notifytiny'        => \core\output\notification::NOTIFY_ERROR,
2865             'notifyerror'       => \core\output\notification::NOTIFY_ERROR,
2866             'notifysuccess'     => \core\output\notification::NOTIFY_SUCCESS,
2867             'notifymessage'     => \core\output\notification::NOTIFY_INFO,
2868             'notifyredirect'    => \core\output\notification::NOTIFY_INFO,
2869             'redirectmessage'   => \core\output\notification::NOTIFY_INFO,
2870         ];
2872         $extraclasses = [];
2874         if ($type) {
2875             if (strpos($type, ' ') === false) {
2876                 // No spaces in the list of classes, therefore no need to loop over and determine the class.
2877                 if (isset($typemappings[$type])) {
2878                     $type = $typemappings[$type];
2879                 } else {
2880                     // The value provided did not match a known type. It must be an extra class.
2881                     $extraclasses = [$type];
2882                 }
2883             } else {
2884                 // Identify what type of notification this is.
2885                 $classarray = explode(' ', self::prepare_classes($type));
2887                 // Separate out the type of notification from the extra classes.
2888                 foreach ($classarray as $class) {
2889                     if (isset($typemappings[$class])) {
2890                         $type = $typemappings[$class];
2891                     } else {
2892                         $extraclasses[] = $class;
2893                     }
2894                 }
2895             }
2896         }
2898         $notification = new \core\output\notification($message, $type);
2899         if (count($extraclasses)) {
2900             $notification->set_extra_classes($extraclasses);
2901         }
2903         // Return the rendered template.
2904         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2905     }
2907     /**
2908      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2909      */
2910     public function notify_problem() {
2911         throw new coding_exception('core_renderer::notify_problem() can not be used any more, '.
2912             'please use \core\notification::add(), or \core\output\notification as required.');
2913     }
2915     /**
2916      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2917      */
2918     public function notify_success() {
2919         throw new coding_exception('core_renderer::notify_success() can not be used any more, '.
2920             'please use \core\notification::add(), or \core\output\notification as required.');
2921     }
2923     /**
2924      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2925      */
2926     public function notify_message() {
2927         throw new coding_exception('core_renderer::notify_message() can not be used any more, '.
2928             'please use \core\notification::add(), or \core\output\notification as required.');
2929     }
2931     /**
2932      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2933      */
2934     public function notify_redirect() {
2935         throw new coding_exception('core_renderer::notify_redirect() can not be used any more, '.
2936             'please use \core\notification::add(), or \core\output\notification as required.');
2937     }
2939     /**
2940      * Render a notification (that is, a status message about something that has
2941      * just happened).
2942      *
2943      * @param \core\output\notification $notification the notification to print out
2944      * @return string the HTML to output.
2945      */
2946     protected function render_notification(\core\output\notification $notification) {
2947         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2948     }
2950     /**
2951      * Returns HTML to display a continue button that goes to a particular URL.
2952      *
2953      * @param string|moodle_url $url The url the button goes to.
2954      * @return string the HTML to output.
2955      */
2956     public function continue_button($url) {
2957         if (!($url instanceof moodle_url)) {
2958             $url = new moodle_url($url);
2959         }
2960         $button = new single_button($url, get_string('continue'), 'get', true);
2961         $button->class = 'continuebutton';
2963         return $this->render($button);
2964     }
2966     /**
2967      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2968      *
2969      * Theme developers: DO NOT OVERRIDE! Please override function
2970      * {@link core_renderer::render_paging_bar()} instead.
2971      *
2972      * @param int $totalcount The total number of entries available to be paged through
2973      * @param int $page The page you are currently viewing
2974      * @param int $perpage The number of entries that should be shown per page
2975      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2976      * @param string $pagevar name of page parameter that holds the page number
2977      * @return string the HTML to output.
2978      */
2979     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2980         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2981         return $this->render($pb);
2982     }
2984     /**
2985      * Returns HTML to display the paging bar.
2986      *
2987      * @param paging_bar $pagingbar
2988      * @return string the HTML to output.
2989      */
2990     protected function render_paging_bar(paging_bar $pagingbar) {
2991         // Any more than 10 is not usable and causes weird wrapping of the pagination.
2992         $pagingbar->maxdisplay = 10;
2993         return $this->render_from_template('core/paging_bar', $pagingbar->export_for_template($this));
2994     }
2996     /**
2997      * Returns HTML to display initials bar to provide access to other pages  (usually in a search)
2998      *
2999      * @param string $current the currently selected letter.
3000      * @param string $class class name to add to this initial bar.
3001      * @param string $title the name to put in front of this initial bar.
3002      * @param string $urlvar URL parameter name for this initial.
3003      * @param string $url URL object.
3004      * @param array $alpha of letters in the alphabet.
3005      * @return string the HTML to output.
3006      */
3007     public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null) {
3008         $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha);
3009         return $this->render($ib);
3010     }
3012     /**
3013      * Internal implementation of initials bar rendering.
3014      *
3015      * @param initials_bar $initialsbar
3016      * @return string
3017      */
3018     protected function render_initials_bar(initials_bar $initialsbar) {
3019         return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
3020     }
3022     /**
3023      * Output the place a skip link goes to.
3024      *
3025      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
3026      * @return string the HTML to output.
3027      */
3028     public function skip_link_target($id = null) {
3029         return html_writer::span('', '', array('id' => $id));
3030     }
3032     /**
3033      * Outputs a heading
3034      *
3035      * @param string $text The text of the heading
3036      * @param int $level The level of importance of the heading. Defaulting to 2
3037      * @param string $classes A space-separated list of CSS classes. Defaulting to null
3038      * @param string $id An optional ID
3039      * @return string the HTML to output.
3040      */
3041     public function heading($text, $level = 2, $classes = null, $id = null) {
3042         $level = (integer) $level;
3043         if ($level < 1 or $level > 6) {
3044             throw new coding_exception('Heading level must be an integer between 1 and 6.');
3045         }
3046         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
3047     }
3049     /**
3050      * Outputs a box.
3051      *
3052      * @param string $contents The contents of the box
3053      * @param string $classes A space-separated list of CSS classes
3054      * @param string $id An optional ID
3055      * @param array $attributes An array of other attributes to give the box.
3056      * @return string the HTML to output.
3057      */
3058     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
3059         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
3060     }
3062     /**
3063      * Outputs the opening section of a box.
3064      *
3065      * @param string $classes A space-separated list of CSS classes
3066      * @param string $id An optional ID
3067      * @param array $attributes An array of other attributes to give the box.
3068      * @return string the HTML to output.
3069      */
3070     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
3071         $this->opencontainers->push('box', html_writer::end_tag('div'));
3072         $attributes['id'] = $id;
3073         $attributes['class'] = 'box py-3 ' . renderer_base::prepare_classes($classes);
3074         return html_writer::start_tag('div', $attributes);
3075     }
3077     /**
3078      * Outputs the closing section of a box.
3079      *
3080      * @return string the HTML to output.
3081      */
3082     public function box_end() {
3083         return $this->opencontainers->pop('box');
3084     }
3086     /**
3087      * Outputs a container.
3088      *
3089      * @param string $contents The contents of the box
3090      * @param string $classes A space-separated list of CSS classes
3091      * @param string $id An optional ID
3092      * @return string the HTML to output.
3093      */
3094     public function container($contents, $classes = null, $id = null) {
3095         return $this->container_start($classes, $id) . $contents . $this->container_end();
3096     }
3098     /**
3099      * Outputs the opening section of a container.
3100      *
3101      * @param string $classes A space-separated list of CSS classes
3102      * @param string $id An optional ID
3103      * @return string the HTML to output.
3104      */
3105     public function container_start($classes = null, $id = null) {
3106         $this->opencontainers->push('container', html_writer::end_tag('div'));
3107         return html_writer::start_tag('div', array('id' => $id,
3108                 'class' => renderer_base::prepare_classes($classes)));
3109     }
3111     /**
3112      * Outputs the closing section of a container.
3113      *
3114      * @return string the HTML to output.
3115      */
3116     public function container_end() {
3117         return $this->opencontainers->pop('container');
3118     }
3120     /**
3121      * Make nested HTML lists out of the items
3122      *
3123      * The resulting list will look something like this:
3124      *
3125      * <pre>
3126      * <<ul>>
3127      * <<li>><div class='tree_item parent'>(item contents)</div>
3128      *      <<ul>
3129      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
3130      *      <</ul>>
3131      * <</li>>
3132      * <</ul>>
3133      * </pre>
3134      *
3135      * @param array $items
3136      * @param array $attrs html attributes passed to the top ofs the list
3137      * @return string HTML
3138      */
3139     public function tree_block_contents($items, $attrs = array()) {
3140         // exit if empty, we don't want an empty ul element
3141         if (empty($items)) {
3142             return '';
3143         }
3144         // array of nested li elements
3145         $lis = array();
3146         foreach ($items as $item) {
3147             // this applies to the li item which contains all child lists too
3148             $content = $item->content($this);
3149             $liclasses = array($item->get_css_type());
3150             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
3151                 $liclasses[] = 'collapsed';
3152             }
3153             if ($item->isactive === true) {
3154                 $liclasses[] = 'current_branch';
3155             }
3156             $liattr = array('class'=>join(' ',$liclasses));
3157             // class attribute on the div item which only contains the item content
3158             $divclasses = array('tree_item');
3159             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
3160                 $divclasses[] = 'branch';
3161             } else {
3162                 $divclasses[] = 'leaf';
3163             }
3164             if (!empty($item->classes) && count($item->classes)>0) {
3165                 $divclasses[] = join(' ', $item->classes);
3166             }
3167             $divattr = array('class'=>join(' ', $divclasses));
3168             if (!empty($item->id)) {
3169                 $divattr['id'] = $item->id;
3170             }
3171             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
3172             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
3173                 $content = html_writer::empty_tag('hr') . $content;
3174             }
3175             $content = html_writer::tag('li', $content, $liattr);
3176             $lis[] = $content;
3177         }
3178         return html_writer::tag('ul', implode("\n", $lis), $attrs);
3179     }
3181     /**
3182      * Returns a search box.
3183      *
3184      * @param  string $id     The search box wrapper div id, defaults to an autogenerated one.
3185      * @return string         HTML with the search form hidden by default.
3186      */
3187     public function search_box($id = false) {
3188         global $CFG;
3190         // Accessing $CFG directly as using \core_search::is_global_search_enabled would
3191         // result in an extra included file for each site, even the ones where global search
3192         // is disabled.
3193         if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
3194             return '';
3195         }
3197         if ($id == false) {
3198             $id = uniqid();
3199         } else {
3200             // Needs to be cleaned, we use it for the input id.
3201             $id = clean_param($id, PARAM_ALPHANUMEXT);
3202         }
3204         // JS to animate the form.
3205         $this->page->requires->js_call_amd('core/search-input', 'init', array($id));
3207         $searchicon = html_writer::tag('div', $this->pix_icon('a/search', get_string('search', 'search'), 'moodle'),
3208             array('role' => 'button', 'tabindex' => 0));
3209         $formattrs = array('class' => 'search-input-form', 'action' => $CFG->wwwroot . '/search/index.php');
3210         $inputattrs = array('type' => 'text', 'name' => 'q', 'placeholder' => get_string('search', 'search'),
3211             'size' => 13, 'tabindex' => -1, 'id' => 'id_q_' . $id, 'class' => 'form-control');
3213         $contents = html_writer::tag('label', get_string('enteryoursearchquery', 'search'),
3214             array('for' => 'id_q_' . $id, 'class' => 'accesshide')) . html_writer::tag('input', '', $inputattrs);
3215         if ($this->page->context && $this->page->context->contextlevel !== CONTEXT_SYSTEM) {
3216             $contents .= html_writer::empty_tag('input', ['type' => 'hidden',
3217                     'name' => 'context', 'value' => $this->page->context->id]);
3218         }
3219         $searchinput = html_writer::tag('form', $contents, $formattrs);
3221         return html_writer::tag('div', $searchicon . $searchinput, array('class' => 'search-input-wrapper nav-link', 'id' => $id));
3222     }
3224     /**
3225      * Allow plugins to provide some content to be rendered in the navbar.
3226      * The plugin must define a PLUGIN_render_navbar_output function that returns
3227      * the HTML they wish to add to the navbar.
3228      *
3229      * @return string HTML for the navbar
3230      */
3231     public function navbar_plugin_output() {
3232         $output = '';
3234         // Give subsystems an opportunity to inject extra html content. The callback
3235         // must always return a string containing valid html.
3236         foreach (\core_component::get_core_subsystems() as $name => $path) {
3237             if ($path) {
3238                 $output .= component_callback($name, 'render_navbar_output', [$this], '');
3239             }
3240         }
3242         if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
3243             foreach ($pluginsfunction as $plugintype => $plugins) {
3244                 foreach ($plugins as $pluginfunction) {
3245                     $output .= $pluginfunction($this);
3246                 }
3247             }
3248         }
3250         return $output;
3251     }
3253     /**
3254      * Construct a user menu, returning HTML that can be echoed out by a
3255      * layout file.
3256      *
3257      * @param stdClass $user A user object, usually $USER.
3258      * @param bool $withlinks true if a dropdown should be built.
3259      * @return string HTML fragment.
3260      */
3261     public function user_menu($user = null, $withlinks = null) {
3262         global $USER, $CFG;
3263         require_once($CFG->dirroot . '/user/lib.php');
3265         if (is_null($user)) {
3266             $user = $USER;
3267         }
3269         // Note: this behaviour is intended to match that of core_renderer::login_info,
3270         // but should not be considered to be good practice; layout options are
3271         // intended to be theme-specific. Please don't copy this snippet anywhere else.
3272         if (is_null($withlinks)) {
3273             $withlinks = empty($this->page->layout_options['nologinlinks']);
3274         }
3276         // Add a class for when $withlinks is false.
3277         $usermenuclasses = 'usermenu';
3278         if (!$withlinks) {
3279             $usermenuclasses .= ' withoutlinks';
3280         }
3282         $returnstr = "";
3284         // If during initial install, return the empty return string.
3285         if (during_initial_install()) {
3286             return $returnstr;
3287         }
3289         $loginpage = $this->is_login_page();
3290         $loginurl = get_login_url();
3291         // If not logged in, show the typical not-logged-in string.
3292         if (!isloggedin()) {
3293             $returnstr = get_string('loggedinnot', 'moodle');
3294             if (!$loginpage) {
3295                 $returnstr .= " (<a href=\"$loginurl\">" . get_string('login') . '</a>)';
3296             }
3297             return html_writer::div(
3298                 html_writer::span(
3299                     $returnstr,
3300                     'login'
3301                 ),
3302                 $usermenuclasses
3303             );
3305         }
3307         // If logged in as a guest user, show a string to that effect.
3308         if (isguestuser()) {
3309             $returnstr = get_string('loggedinasguest');
3310             if (!$loginpage && $withlinks) {
3311                 $returnstr .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
3312             }
3314             return html_writer::div(
3315                 html_writer::span(
3316                     $returnstr,
3317                     'login'
3318                 ),
3319                 $usermenuclasses
3320             );
3321         }
3323         // Get some navigation opts.
3324         $opts = user_get_user_navigation_info($user, $this->page);
3326         $avatarclasses = "avatars";
3327         $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
3328         $usertextcontents = $opts->metadata['userfullname'];
3330         // Other user.
3331         if (!empty($opts->metadata['asotheruser'])) {
3332             $avatarcontents .= html_writer::span(
3333                 $opts->metadata['realuseravatar'],
3334                 'avatar realuser'
3335             );
3336             $usertextcontents = $opts->metadata['realuserfullname'];
3337             $usertextcontents .= html_writer::tag(
3338                 'span',
3339                 get_string(
3340                     'loggedinas',
3341                     'moodle',
3342                     html_writer::span(
3343                         $opts->metadata['userfullname'],
3344                         'value'
3345                     )
3346                 ),
3347                 array('class' => 'meta viewingas')
3348             );
3349         }
3351         // Role.
3352         if (!empty($opts->metadata['asotherrole'])) {
3353             $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
3354             $usertextcontents .= html_writer::span(
3355                 $opts->metadata['rolename'],
3356                 'meta role role-' . $role
3357             );
3358         }
3360         // User login failures.
3361         if (!empty($opts->metadata['userloginfail'])) {
3362             $usertextcontents .= html_writer::span(
3363                 $opts->metadata['userloginfail'],
3364                 'meta loginfailures'
3365             );
3366         }
3368         // MNet.
3369         if (!empty($opts->metadata['asmnetuser'])) {
3370             $mnet = strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['mnetidprovidername'])));
3371             $usertextcontents .= html_writer::span(
3372                 $opts->metadata['mnetidprovidername'],
3373                 'meta mnet mnet-' . $mnet
3374             );
3375         }
3377         $returnstr .= html_writer::span(
3378             html_writer::span($usertextcontents, 'usertext mr-1') .
3379             html_writer::span($avatarcontents, $avatarclasses),
3380             'userbutton'
3381         );
3383         // Create a divider (well, a filler).
3384         $divider = new action_menu_filler();
3385         $divider->primary = false;
3387         $am = new a