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