Merge branch 'MDL-68068-master' of git://github.com/cescobedo/moodle
[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 = 100, $maxheight = 100) {
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) {
394         global $PAGE;
396         // Only render the logo if we're on the front page or login page and the we have a logo.
397         $logo = $this->get_logo_url();
398         if ($headinglevel == 1 && !empty($logo)) {
399             if ($PAGE->pagelayout == 'frontpage' || $PAGE->pagelayout == 'login') {
400                 return true;
401             }
402         }
404         return false;
405     }
410 /**
411  * Basis for all plugin renderers.
412  *
413  * @copyright Petr Skoda (skodak)
414  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
415  * @since Moodle 2.0
416  * @package core
417  * @category output
418  */
419 class plugin_renderer_base extends renderer_base {
421     /**
422      * @var renderer_base|core_renderer A reference to the current renderer.
423      * The renderer provided here will be determined by the page but will in 90%
424      * of cases by the {@link core_renderer}
425      */
426     protected $output;
428     /**
429      * Constructor method, calls the parent constructor
430      *
431      * @param moodle_page $page
432      * @param string $target one of rendering target constants
433      */
434     public function __construct(moodle_page $page, $target) {
435         if (empty($target) && $page->pagelayout === 'maintenance') {
436             // If the page is using the maintenance layout then we're going to force the target to maintenance.
437             // This way we'll get a special maintenance renderer that is designed to block access to API's that are likely
438             // unavailable for this page layout.
439             $target = RENDERER_TARGET_MAINTENANCE;
440         }
441         $this->output = $page->get_renderer('core', null, $target);
442         parent::__construct($page, $target);
443     }
445     /**
446      * Renders the provided widget and returns the HTML to display it.
447      *
448      * @param renderable $widget instance with renderable interface
449      * @return string
450      */
451     public function render(renderable $widget) {
452         $classname = get_class($widget);
453         // Strip namespaces.
454         $classname = preg_replace('/^.*\\\/', '', $classname);
455         // Keep a copy at this point, we may need to look for a deprecated method.
456         $deprecatedmethod = 'render_'.$classname;
457         // Remove _renderable suffixes
458         $classname = preg_replace('/_renderable$/', '', $classname);
460         $rendermethod = 'render_'.$classname;
461         if (method_exists($this, $rendermethod)) {
462             return $this->$rendermethod($widget);
463         }
464         if ($rendermethod !== $deprecatedmethod && method_exists($this, $deprecatedmethod)) {
465             // This is exactly where we don't want to be.
466             // If you have arrived here you have a renderable component within your plugin that has the name
467             // blah_renderable, and you have a render method render_blah_renderable on your plugin.
468             // In 2.8 we revamped output, as part of this change we changed slightly how renderables got rendered
469             // and the _renderable suffix now gets removed when looking for a render method.
470             // You need to change your renderers render_blah_renderable to render_blah.
471             // Until you do this it will not be possible for a theme to override the renderer to override your method.
472             // Please do it ASAP.
473             static $debugged = array();
474             if (!isset($debugged[$deprecatedmethod])) {
475                 debugging(sprintf('Deprecated call. Please rename your renderables render method from %s to %s.',
476                     $deprecatedmethod, $rendermethod), DEBUG_DEVELOPER);
477                 $debugged[$deprecatedmethod] = true;
478             }
479             return $this->$deprecatedmethod($widget);
480         }
481         // pass to core renderer if method not found here
482         return $this->output->render($widget);
483     }
485     /**
486      * Magic method used to pass calls otherwise meant for the standard renderer
487      * to it to ensure we don't go causing unnecessary grief.
488      *
489      * @param string $method
490      * @param array $arguments
491      * @return mixed
492      */
493     public function __call($method, $arguments) {
494         if (method_exists('renderer_base', $method)) {
495             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
496         }
497         if (method_exists($this->output, $method)) {
498             return call_user_func_array(array($this->output, $method), $arguments);
499         } else {
500             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
501         }
502     }
506 /**
507  * The standard implementation of the core_renderer interface.
508  *
509  * @copyright 2009 Tim Hunt
510  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
511  * @since Moodle 2.0
512  * @package core
513  * @category output
514  */
515 class core_renderer extends renderer_base {
516     /**
517      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
518      * in layout files instead.
519      * @deprecated
520      * @var string used in {@link core_renderer::header()}.
521      */
522     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
524     /**
525      * @var string Used to pass information from {@link core_renderer::doctype()} to
526      * {@link core_renderer::standard_head_html()}.
527      */
528     protected $contenttype;
530     /**
531      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
532      * with {@link core_renderer::header()}.
533      */
534     protected $metarefreshtag = '';
536     /**
537      * @var string Unique token for the closing HTML
538      */
539     protected $unique_end_html_token;
541     /**
542      * @var string Unique token for performance information
543      */
544     protected $unique_performance_info_token;
546     /**
547      * @var string Unique token for the main content.
548      */
549     protected $unique_main_content_token;
551     /** @var custom_menu_item language The language menu if created */
552     protected $language = null;
554     /**
555      * Constructor
556      *
557      * @param moodle_page $page the page we are doing output for.
558      * @param string $target one of rendering target constants
559      */
560     public function __construct(moodle_page $page, $target) {
561         $this->opencontainers = $page->opencontainers;
562         $this->page = $page;
563         $this->target = $target;
565         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
566         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
567         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
568     }
570     /**
571      * Get the DOCTYPE declaration that should be used with this page. Designed to
572      * be called in theme layout.php files.
573      *
574      * @return string the DOCTYPE declaration that should be used.
575      */
576     public function doctype() {
577         if ($this->page->theme->doctype === 'html5') {
578             $this->contenttype = 'text/html; charset=utf-8';
579             return "<!DOCTYPE html>\n";
581         } else if ($this->page->theme->doctype === 'xhtml5') {
582             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
583             return "<!DOCTYPE html>\n";
585         } else {
586             // legacy xhtml 1.0
587             $this->contenttype = 'text/html; charset=utf-8';
588             return ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n");
589         }
590     }
592     /**
593      * The attributes that should be added to the <html> tag. Designed to
594      * be called in theme layout.php files.
595      *
596      * @return string HTML fragment.
597      */
598     public function htmlattributes() {
599         $return = get_html_lang(true);
600         $attributes = array();
601         if ($this->page->theme->doctype !== 'html5') {
602             $attributes['xmlns'] = 'http://www.w3.org/1999/xhtml';
603         }
605         // Give plugins an opportunity to add things like xml namespaces to the html element.
606         // This function should return an array of html attribute names => values.
607         $pluginswithfunction = get_plugins_with_function('add_htmlattributes', 'lib.php');
608         foreach ($pluginswithfunction as $plugins) {
609             foreach ($plugins as $function) {
610                 $newattrs = $function();
611                 unset($newattrs['dir']);
612                 unset($newattrs['lang']);
613                 unset($newattrs['xmlns']);
614                 unset($newattrs['xml:lang']);
615                 $attributes += $newattrs;
616             }
617         }
619         foreach ($attributes as $key => $val) {
620             $val = s($val);
621             $return .= " $key=\"$val\"";
622         }
624         return $return;
625     }
627     /**
628      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
629      * that should be included in the <head> tag. Designed to be called in theme
630      * layout.php files.
631      *
632      * @return string HTML fragment.
633      */
634     public function standard_head_html() {
635         global $CFG, $SESSION, $SITE, $PAGE;
637         // Before we output any content, we need to ensure that certain
638         // page components are set up.
640         // Blocks must be set up early as they may require javascript which
641         // has to be included in the page header before output is created.
642         foreach ($this->page->blocks->get_regions() as $region) {
643             $this->page->blocks->ensure_content_created($region, $this);
644         }
646         $output = '';
648         // Give plugins an opportunity to add any head elements. The callback
649         // must always return a string containing valid html head content.
650         $pluginswithfunction = get_plugins_with_function('before_standard_html_head', 'lib.php');
651         foreach ($pluginswithfunction as $plugins) {
652             foreach ($plugins as $function) {
653                 $output .= $function();
654             }
655         }
657         // Allow a url_rewrite plugin to setup any dynamic head content.
658         if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
659             $class = $CFG->urlrewriteclass;
660             $output .= $class::html_head_setup();
661         }
663         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
664         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
665         // This is only set by the {@link redirect()} method
666         $output .= $this->metarefreshtag;
668         // Check if a periodic refresh delay has been set and make sure we arn't
669         // already meta refreshing
670         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
671             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
672         }
674         // Set up help link popups for all links with the helptooltip class
675         $this->page->requires->js_init_call('M.util.help_popups.setup');
677         $focus = $this->page->focuscontrol;
678         if (!empty($focus)) {
679             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
680                 // This is a horrifically bad way to handle focus but it is passed in
681                 // through messy formslib::moodleform
682                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
683             } else if (strpos($focus, '.')!==false) {
684                 // Old style of focus, bad way to do it
685                 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);
686                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
687             } else {
688                 // Focus element with given id
689                 $this->page->requires->js_function_call('focuscontrol', array($focus));
690             }
691         }
693         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
694         // any other custom CSS can not be overridden via themes and is highly discouraged
695         $urls = $this->page->theme->css_urls($this->page);
696         foreach ($urls as $url) {
697             $this->page->requires->css_theme($url);
698         }
700         // Get the theme javascript head and footer
701         if ($jsurl = $this->page->theme->javascript_url(true)) {
702             $this->page->requires->js($jsurl, true);
703         }
704         if ($jsurl = $this->page->theme->javascript_url(false)) {
705             $this->page->requires->js($jsurl);
706         }
708         // Get any HTML from the page_requirements_manager.
709         $output .= $this->page->requires->get_head_code($this->page, $this);
711         // List alternate versions.
712         foreach ($this->page->alternateversions as $type => $alt) {
713             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
714                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
715         }
717         // Add noindex tag if relevant page and setting applied.
718         $allowindexing = isset($CFG->allowindexing) ? $CFG->allowindexing : 0;
719         $loginpages = array('login-index', 'login-signup');
720         if ($allowindexing == 2 || ($allowindexing == 0 && in_array($this->page->pagetype, $loginpages))) {
721             if (!isset($CFG->additionalhtmlhead)) {
722                 $CFG->additionalhtmlhead = '';
723             }
724             $CFG->additionalhtmlhead .= '<meta name="robots" content="noindex" />';
725         }
727         if (!empty($CFG->additionalhtmlhead)) {
728             $output .= "\n".$CFG->additionalhtmlhead;
729         }
731         if ($PAGE->pagelayout == 'frontpage') {
732             $summary = s(strip_tags(format_text($SITE->summary, FORMAT_HTML)));
733             if (!empty($summary)) {
734                 $output .= "<meta name=\"description\" content=\"$summary\" />\n";
735             }
736         }
738         return $output;
739     }
741     /**
742      * The standard tags (typically skip links) that should be output just inside
743      * the start of the <body> tag. Designed to be called in theme layout.php files.
744      *
745      * @return string HTML fragment.
746      */
747     public function standard_top_of_body_html() {
748         global $CFG;
749         $output = $this->page->requires->get_top_of_body_code($this);
750         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
751             $output .= "\n".$CFG->additionalhtmltopofbody;
752         }
754         // Give subsystems an opportunity to inject extra html content. The callback
755         // must always return a string containing valid html.
756         foreach (\core_component::get_core_subsystems() as $name => $path) {
757             if ($path) {
758                 $output .= component_callback($name, 'before_standard_top_of_body_html', [], '');
759             }
760         }
762         // Give plugins an opportunity to inject extra html content. The callback
763         // must always return a string containing valid html.
764         $pluginswithfunction = get_plugins_with_function('before_standard_top_of_body_html', 'lib.php');
765         foreach ($pluginswithfunction as $plugins) {
766             foreach ($plugins as $function) {
767                 $output .= $function();
768             }
769         }
771         $output .= $this->maintenance_warning();
773         return $output;
774     }
776     /**
777      * Scheduled maintenance warning message.
778      *
779      * Note: This is a nasty hack to display maintenance notice, this should be moved
780      *       to some general notification area once we have it.
781      *
782      * @return string
783      */
784     public function maintenance_warning() {
785         global $CFG;
787         $output = '';
788         if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
789             $timeleft = $CFG->maintenance_later - time();
790             // If timeleft less than 30 sec, set the class on block to error to highlight.
791             $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
792             $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-a-1 alert');
793             $a = new stdClass();
794             $a->hour = (int)($timeleft / 3600);
795             $a->min = (int)(($timeleft / 60) % 60);
796             $a->sec = (int)($timeleft % 60);
797             if ($a->hour > 0) {
798                 $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
799             } else {
800                 $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
801             }
803             $output .= $this->box_end();
804             $this->page->requires->yui_module('moodle-core-maintenancemodetimer', 'M.core.maintenancemodetimer',
805                     array(array('timeleftinsec' => $timeleft)));
806             $this->page->requires->strings_for_js(
807                     array('maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'),
808                     'admin');
809         }
810         return $output;
811     }
813     /**
814      * The standard tags (typically performance information and validation links,
815      * if we are in developer debug mode) that should be output in the footer area
816      * of the page. Designed to be called in theme layout.php files.
817      *
818      * @return string HTML fragment.
819      */
820     public function standard_footer_html() {
821         global $CFG, $SCRIPT;
823         $output = '';
824         if (during_initial_install()) {
825             // Debugging info can not work before install is finished,
826             // in any case we do not want any links during installation!
827             return $output;
828         }
830         // Give plugins an opportunity to add any footer elements.
831         // The callback must always return a string containing valid html footer content.
832         $pluginswithfunction = get_plugins_with_function('standard_footer_html', 'lib.php');
833         foreach ($pluginswithfunction as $plugins) {
834             foreach ($plugins as $function) {
835                 $output .= $function();
836             }
837         }
839         // This function is normally called from a layout.php file in {@link core_renderer::header()}
840         // but some of the content won't be known until later, so we return a placeholder
841         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
842         $output .= $this->unique_performance_info_token;
843         if ($this->page->devicetypeinuse == 'legacy') {
844             // The legacy theme is in use print the notification
845             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
846         }
848         // Get links to switch device types (only shown for users not on a default device)
849         $output .= $this->theme_switch_links();
851         if (!empty($CFG->debugpageinfo)) {
852             $output .= '<div class="performanceinfo pageinfo">' . get_string('pageinfodebugsummary', 'core_admin',
853                 $this->page->debug_summary()) . '</div>';
854         }
855         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) {  // Only in developer mode
856             // Add link to profiling report if necessary
857             if (function_exists('profiling_is_running') && profiling_is_running()) {
858                 $txt = get_string('profiledscript', 'admin');
859                 $title = get_string('profiledscriptview', 'admin');
860                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
861                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
862                 $output .= '<div class="profilingfooter">' . $link . '</div>';
863             }
864             $purgeurl = new moodle_url('/admin/purgecaches.php', array('confirm' => 1,
865                 'sesskey' => sesskey(), 'returnurl' => $this->page->url->out_as_local_url(false)));
866             $output .= '<div class="purgecaches">' .
867                     html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '</div>';
868         }
869         if (!empty($CFG->debugvalidators)) {
870             // NOTE: this is not a nice hack, $PAGE->url is not always accurate and $FULLME neither, it is not a bug if it fails. --skodak
871             $output .= '<div class="validators"><ul class="list-unstyled ml-1">
872               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
873               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
874               <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>
875             </ul></div>';
876         }
877         return $output;
878     }
880     /**
881      * Returns standard main content placeholder.
882      * Designed to be called in theme layout.php files.
883      *
884      * @return string HTML fragment.
885      */
886     public function main_content() {
887         // This is here because it is the only place we can inject the "main" role over the entire main content area
888         // without requiring all theme's to manually do it, and without creating yet another thing people need to
889         // remember in the theme.
890         // This is an unfortunate hack. DO NO EVER add anything more here.
891         // DO NOT add classes.
892         // DO NOT add an id.
893         return '<div role="main">'.$this->unique_main_content_token.'</div>';
894     }
896     /**
897      * Returns standard navigation between activities in a course.
898      *
899      * @return string the navigation HTML.
900      */
901     public function activity_navigation() {
902         // First we should check if we want to add navigation.
903         $context = $this->page->context;
904         if (($this->page->pagelayout !== 'incourse' && $this->page->pagelayout !== 'frametop')
905             || $context->contextlevel != CONTEXT_MODULE) {
906             return '';
907         }
909         // If the activity is in stealth mode, show no links.
910         if ($this->page->cm->is_stealth()) {
911             return '';
912         }
914         // Get a list of all the activities in the course.
915         $course = $this->page->cm->get_course();
916         $modules = get_fast_modinfo($course->id)->get_cms();
918         // Put the modules into an array in order by the position they are shown in the course.
919         $mods = [];
920         $activitylist = [];
921         foreach ($modules as $module) {
922             // Only add activities the user can access, aren't in stealth mode and have a url (eg. mod_label does not).
923             if (!$module->uservisible || $module->is_stealth() || empty($module->url)) {
924                 continue;
925             }
926             $mods[$module->id] = $module;
928             // No need to add the current module to the list for the activity dropdown menu.
929             if ($module->id == $this->page->cm->id) {
930                 continue;
931             }
932             // Module name.
933             $modname = $module->get_formatted_name();
934             // Display the hidden text if necessary.
935             if (!$module->visible) {
936                 $modname .= ' ' . get_string('hiddenwithbrackets');
937             }
938             // Module URL.
939             $linkurl = new moodle_url($module->url, array('forceview' => 1));
940             // Add module URL (as key) and name (as value) to the activity list array.
941             $activitylist[$linkurl->out(false)] = $modname;
942         }
944         $nummods = count($mods);
946         // If there is only one mod then do nothing.
947         if ($nummods == 1) {
948             return '';
949         }
951         // Get an array of just the course module ids used to get the cmid value based on their position in the course.
952         $modids = array_keys($mods);
954         // Get the position in the array of the course module we are viewing.
955         $position = array_search($this->page->cm->id, $modids);
957         $prevmod = null;
958         $nextmod = null;
960         // Check if we have a previous mod to show.
961         if ($position > 0) {
962             $prevmod = $mods[$modids[$position - 1]];
963         }
965         // Check if we have a next mod to show.
966         if ($position < ($nummods - 1)) {
967             $nextmod = $mods[$modids[$position + 1]];
968         }
970         $activitynav = new \core_course\output\activity_navigation($prevmod, $nextmod, $activitylist);
971         $renderer = $this->page->get_renderer('core', 'course');
972         return $renderer->render($activitynav);
973     }
975     /**
976      * The standard tags (typically script tags that are not needed earlier) that
977      * should be output after everything else. Designed to be called in theme layout.php files.
978      *
979      * @return string HTML fragment.
980      */
981     public function standard_end_of_body_html() {
982         global $CFG;
984         // This function is normally called from a layout.php file in {@link core_renderer::header()}
985         // but some of the content won't be known until later, so we return a placeholder
986         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
987         $output = '';
988         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
989             $output .= "\n".$CFG->additionalhtmlfooter;
990         }
991         $output .= $this->unique_end_html_token;
992         return $output;
993     }
995     /**
996      * The standard HTML that should be output just before the <footer> tag.
997      * Designed to be called in theme layout.php files.
998      *
999      * @return string HTML fragment.
1000      */
1001     public function standard_after_main_region_html() {
1002         global $CFG;
1003         $output = '';
1004         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlbottomofbody)) {
1005             $output .= "\n".$CFG->additionalhtmlbottomofbody;
1006         }
1008         // Give subsystems an opportunity to inject extra html content. The callback
1009         // must always return a string containing valid html.
1010         foreach (\core_component::get_core_subsystems() as $name => $path) {
1011             if ($path) {
1012                 $output .= component_callback($name, 'standard_after_main_region_html', [], '');
1013             }
1014         }
1016         // Give plugins an opportunity to inject extra html content. The callback
1017         // must always return a string containing valid html.
1018         $pluginswithfunction = get_plugins_with_function('standard_after_main_region_html', 'lib.php');
1019         foreach ($pluginswithfunction as $plugins) {
1020             foreach ($plugins as $function) {
1021                 $output .= $function();
1022             }
1023         }
1025         return $output;
1026     }
1028     /**
1029      * Return the standard string that says whether you are logged in (and switched
1030      * roles/logged in as another user).
1031      * @param bool $withlinks if false, then don't include any links in the HTML produced.
1032      * If not set, the default is the nologinlinks option from the theme config.php file,
1033      * and if that is not set, then links are included.
1034      * @return string HTML fragment.
1035      */
1036     public function login_info($withlinks = null) {
1037         global $USER, $CFG, $DB, $SESSION;
1039         if (during_initial_install()) {
1040             return '';
1041         }
1043         if (is_null($withlinks)) {
1044             $withlinks = empty($this->page->layout_options['nologinlinks']);
1045         }
1047         $course = $this->page->course;
1048         if (\core\session\manager::is_loggedinas()) {
1049             $realuser = \core\session\manager::get_realuser();
1050             $fullname = fullname($realuser, true);
1051             if ($withlinks) {
1052                 $loginastitle = get_string('loginas');
1053                 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\"";
1054                 $realuserinfo .= "title =\"".$loginastitle."\">$fullname</a>] ";
1055             } else {
1056                 $realuserinfo = " [$fullname] ";
1057             }
1058         } else {
1059             $realuserinfo = '';
1060         }
1062         $loginpage = $this->is_login_page();
1063         $loginurl = get_login_url();
1065         if (empty($course->id)) {
1066             // $course->id is not defined during installation
1067             return '';
1068         } else if (isloggedin()) {
1069             $context = context_course::instance($course->id);
1071             $fullname = fullname($USER, true);
1072             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
1073             if ($withlinks) {
1074                 $linktitle = get_string('viewprofile');
1075                 $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\" title=\"$linktitle\">$fullname</a>";
1076             } else {
1077                 $username = $fullname;
1078             }
1079             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
1080                 if ($withlinks) {
1081                     $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
1082                 } else {
1083                     $username .= " from {$idprovider->name}";
1084                 }
1085             }
1086             if (isguestuser()) {
1087                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
1088                 if (!$loginpage && $withlinks) {
1089                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
1090                 }
1091             } else if (is_role_switched($course->id)) { // Has switched roles
1092                 $rolename = '';
1093                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
1094                     $rolename = ': '.role_get_name($role, $context);
1095                 }
1096                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename;
1097                 if ($withlinks) {
1098                     $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>0, 'returnurl'=>$this->page->url->out_as_local_url(false)));
1099                     $loggedinas .= ' ('.html_writer::tag('a', get_string('switchrolereturn'), array('href' => $url)).')';
1100                 }
1101             } else {
1102                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username);
1103                 if ($withlinks) {
1104                     $loggedinas .= " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
1105                 }
1106             }
1107         } else {
1108             $loggedinas = get_string('loggedinnot', 'moodle');
1109             if (!$loginpage && $withlinks) {
1110                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
1111             }
1112         }
1114         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
1116         if (isset($SESSION->justloggedin)) {
1117             unset($SESSION->justloggedin);
1118             if (!empty($CFG->displayloginfailures)) {
1119                 if (!isguestuser()) {
1120                     // Include this file only when required.
1121                     require_once($CFG->dirroot . '/user/lib.php');
1122                     if ($count = user_count_login_failures($USER)) {
1123                         $loggedinas .= '<div class="loginfailures">';
1124                         $a = new stdClass();
1125                         $a->attempts = $count;
1126                         $loggedinas .= get_string('failedloginattempts', '', $a);
1127                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', context_system::instance())) {
1128                             $loggedinas .= ' ('.html_writer::link(new moodle_url('/report/log/index.php', array('chooselog' => 1,
1129                                     'id' => 0 , 'modid' => 'site_errors')), get_string('logs')).')';
1130                         }
1131                         $loggedinas .= '</div>';
1132                     }
1133                 }
1134             }
1135         }
1137         return $loggedinas;
1138     }
1140     /**
1141      * Check whether the current page is a login page.
1142      *
1143      * @since Moodle 2.9
1144      * @return bool
1145      */
1146     protected function is_login_page() {
1147         // This is a real bit of a hack, but its a rarety that we need to do something like this.
1148         // In fact the login pages should be only these two pages and as exposing this as an option for all pages
1149         // could lead to abuse (or at least unneedingly complex code) the hack is the way to go.
1150         return in_array(
1151             $this->page->url->out_as_local_url(false, array()),
1152             array(
1153                 '/login/index.php',
1154                 '/login/forgot_password.php',
1155             )
1156         );
1157     }
1159     /**
1160      * Return the 'back' link that normally appears in the footer.
1161      *
1162      * @return string HTML fragment.
1163      */
1164     public function home_link() {
1165         global $CFG, $SITE;
1167         if ($this->page->pagetype == 'site-index') {
1168             // Special case for site home page - please do not remove
1169             return '<div class="sitelink">' .
1170                    '<a title="Moodle" href="http://moodle.org/">' .
1171                    '<img src="' . $this->image_url('moodlelogo_grayhat') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
1173         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
1174             // Special case for during install/upgrade.
1175             return '<div class="sitelink">'.
1176                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
1177                    '<img src="' . $this->image_url('moodlelogo_grayhat') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
1179         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
1180             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
1181                     get_string('home') . '</a></div>';
1183         } else {
1184             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
1185                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
1186         }
1187     }
1189     /**
1190      * Redirects the user by any means possible given the current state
1191      *
1192      * This function should not be called directly, it should always be called using
1193      * the redirect function in lib/weblib.php
1194      *
1195      * The redirect function should really only be called before page output has started
1196      * however it will allow itself to be called during the state STATE_IN_BODY
1197      *
1198      * @param string $encodedurl The URL to send to encoded if required
1199      * @param string $message The message to display to the user if any
1200      * @param int $delay The delay before redirecting a user, if $message has been
1201      *         set this is a requirement and defaults to 3, set to 0 no delay
1202      * @param boolean $debugdisableredirect this redirect has been disabled for
1203      *         debugging purposes. Display a message that explains, and don't
1204      *         trigger the redirect.
1205      * @param string $messagetype The type of notification to show the message in.
1206      *         See constants on \core\output\notification.
1207      * @return string The HTML to display to the user before dying, may contain
1208      *         meta refresh, javascript refresh, and may have set header redirects
1209      */
1210     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect,
1211                                      $messagetype = \core\output\notification::NOTIFY_INFO) {
1212         global $CFG;
1213         $url = str_replace('&amp;', '&', $encodedurl);
1215         switch ($this->page->state) {
1216             case moodle_page::STATE_BEFORE_HEADER :
1217                 // No output yet it is safe to delivery the full arsenal of redirect methods
1218                 if (!$debugdisableredirect) {
1219                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
1220                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
1221                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
1222                 }
1223                 $output = $this->header();
1224                 break;
1225             case moodle_page::STATE_PRINTING_HEADER :
1226                 // We should hopefully never get here
1227                 throw new coding_exception('You cannot redirect while printing the page header');
1228                 break;
1229             case moodle_page::STATE_IN_BODY :
1230                 // We really shouldn't be here but we can deal with this
1231                 debugging("You should really redirect before you start page output");
1232                 if (!$debugdisableredirect) {
1233                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
1234                 }
1235                 $output = $this->opencontainers->pop_all_but_last();
1236                 break;
1237             case moodle_page::STATE_DONE :
1238                 // Too late to be calling redirect now
1239                 throw new coding_exception('You cannot redirect after the entire page has been generated');
1240                 break;
1241         }
1242         $output .= $this->notification($message, $messagetype);
1243         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
1244         if ($debugdisableredirect) {
1245             $output .= '<p><strong>'.get_string('erroroutput', 'error').'</strong></p>';
1246         }
1247         $output .= $this->footer();
1248         return $output;
1249     }
1251     /**
1252      * Start output by sending the HTTP headers, and printing the HTML <head>
1253      * and the start of the <body>.
1254      *
1255      * To control what is printed, you should set properties on $PAGE. If you
1256      * are familiar with the old {@link print_header()} function from Moodle 1.9
1257      * you will find that there are properties on $PAGE that correspond to most
1258      * of the old parameters to could be passed to print_header.
1259      *
1260      * Not that, in due course, the remaining $navigation, $menu parameters here
1261      * will be replaced by more properties of $PAGE, but that is still to do.
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, $PAGE;
1388         // Give plugins an opportunity to touch the page before JS is finalized.
1389         $pluginswithfunction = get_plugins_with_function('before_footer', 'lib.php');
1390         foreach ($pluginswithfunction as $plugins) {
1391             foreach ($plugins as $function) {
1392                 $function();
1393             }
1394         }
1396         $output = $this->container_end_all(true);
1398         $footer = $this->opencontainers->pop('header/footer');
1400         if (debugging() and $DB and $DB->is_transaction_started()) {
1401             // TODO: MDL-20625 print warning - transaction will be rolled back
1402         }
1404         // Provide some performance info if required
1405         $performanceinfo = '';
1406         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
1407             $perf = get_performance_info();
1408             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
1409                 $performanceinfo = $perf['html'];
1410             }
1411         }
1413         // We always want performance data when running a performance test, even if the user is redirected to another page.
1414         if (MDL_PERF_TEST && strpos($footer, $this->unique_performance_info_token) === false) {
1415             $footer = $this->unique_performance_info_token . $footer;
1416         }
1417         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
1419         // Only show notifications when we have a $PAGE context id.
1420         if (!empty($PAGE->context->id)) {
1421             $this->page->requires->js_call_amd('core/notification', 'init', array(
1422                 $PAGE->context->id,
1423                 \core\notification::fetch_as_array($this)
1424             ));
1425         }
1426         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
1428         $this->page->set_state(moodle_page::STATE_DONE);
1430         return $output . $footer;
1431     }
1433     /**
1434      * Close all but the last open container. This is useful in places like error
1435      * handling, where you want to close all the open containers (apart from <body>)
1436      * before outputting the error message.
1437      *
1438      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1439      *      developer debug warning if it isn't.
1440      * @return string the HTML required to close any open containers inside <body>.
1441      */
1442     public function container_end_all($shouldbenone = false) {
1443         return $this->opencontainers->pop_all_but_last($shouldbenone);
1444     }
1446     /**
1447      * Returns course-specific information to be output immediately above content on any course page
1448      * (for the current course)
1449      *
1450      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1451      * @return string
1452      */
1453     public function course_content_header($onlyifnotcalledbefore = false) {
1454         global $CFG;
1455         static $functioncalled = false;
1456         if ($functioncalled && $onlyifnotcalledbefore) {
1457             // we have already output the content header
1458             return '';
1459         }
1461         // Output any session notification.
1462         $notifications = \core\notification::fetch();
1464         $bodynotifications = '';
1465         foreach ($notifications as $notification) {
1466             $bodynotifications .= $this->render_from_template(
1467                     $notification->get_template_name(),
1468                     $notification->export_for_template($this)
1469                 );
1470         }
1472         $output = html_writer::span($bodynotifications, 'notifications', array('id' => 'user-notifications'));
1474         if ($this->page->course->id == SITEID) {
1475             // return immediately and do not include /course/lib.php if not necessary
1476             return $output;
1477         }
1479         require_once($CFG->dirroot.'/course/lib.php');
1480         $functioncalled = true;
1481         $courseformat = course_get_format($this->page->course);
1482         if (($obj = $courseformat->course_content_header()) !== null) {
1483             $output .= html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-header');
1484         }
1485         return $output;
1486     }
1488     /**
1489      * Returns course-specific information to be output immediately below content on any course page
1490      * (for the current course)
1491      *
1492      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1493      * @return string
1494      */
1495     public function course_content_footer($onlyifnotcalledbefore = false) {
1496         global $CFG;
1497         if ($this->page->course->id == SITEID) {
1498             // return immediately and do not include /course/lib.php if not necessary
1499             return '';
1500         }
1501         static $functioncalled = false;
1502         if ($functioncalled && $onlyifnotcalledbefore) {
1503             // we have already output the content footer
1504             return '';
1505         }
1506         $functioncalled = true;
1507         require_once($CFG->dirroot.'/course/lib.php');
1508         $courseformat = course_get_format($this->page->course);
1509         if (($obj = $courseformat->course_content_footer()) !== null) {
1510             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-footer');
1511         }
1512         return '';
1513     }
1515     /**
1516      * Returns course-specific information to be output on any course page in the header area
1517      * (for the current course)
1518      *
1519      * @return string
1520      */
1521     public function course_header() {
1522         global $CFG;
1523         if ($this->page->course->id == SITEID) {
1524             // return immediately and do not include /course/lib.php if not necessary
1525             return '';
1526         }
1527         require_once($CFG->dirroot.'/course/lib.php');
1528         $courseformat = course_get_format($this->page->course);
1529         if (($obj = $courseformat->course_header()) !== null) {
1530             return $courseformat->get_renderer($this->page)->render($obj);
1531         }
1532         return '';
1533     }
1535     /**
1536      * Returns course-specific information to be output on any course page in the footer area
1537      * (for the current course)
1538      *
1539      * @return string
1540      */
1541     public function course_footer() {
1542         global $CFG;
1543         if ($this->page->course->id == SITEID) {
1544             // return immediately and do not include /course/lib.php if not necessary
1545             return '';
1546         }
1547         require_once($CFG->dirroot.'/course/lib.php');
1548         $courseformat = course_get_format($this->page->course);
1549         if (($obj = $courseformat->course_footer()) !== null) {
1550             return $courseformat->get_renderer($this->page)->render($obj);
1551         }
1552         return '';
1553     }
1555     /**
1556      * Get the course pattern datauri to show on a course card.
1557      *
1558      * The datauri is an encoded svg that can be passed as a url.
1559      * @param int $id Id to use when generating the pattern
1560      * @return string datauri
1561      */
1562     public function get_generated_image_for_id($id) {
1563         $color = $this->get_generated_color_for_id($id);
1564         $pattern = new \core_geopattern();
1565         $pattern->setColor($color);
1566         $pattern->patternbyid($id);
1567         return $pattern->datauri();
1568     }
1570     /**
1571      * Get the course color to show on a course card.
1572      *
1573      * @param int $id Id to use when generating the color.
1574      * @return string hex color code.
1575      */
1576     public function get_generated_color_for_id($id) {
1577         $colornumbers = range(1, 10);
1578         $basecolors = [];
1579         foreach ($colornumbers as $number) {
1580             $basecolors[] = get_config('core_admin', 'coursecolor' . $number);
1581         }
1583         $color = $basecolors[$id % 10];
1584         return $color;
1585     }
1587     /**
1588      * Returns lang menu or '', this method also checks forcing of languages in courses.
1589      *
1590      * This function calls {@link core_renderer::render_single_select()} to actually display the language menu.
1591      *
1592      * @return string The lang menu HTML or empty string
1593      */
1594     public function lang_menu() {
1595         global $CFG;
1597         if (empty($CFG->langmenu)) {
1598             return '';
1599         }
1601         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
1602             // do not show lang menu if language forced
1603             return '';
1604         }
1606         $currlang = current_language();
1607         $langs = get_string_manager()->get_list_of_translations();
1609         if (count($langs) < 2) {
1610             return '';
1611         }
1613         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
1614         $s->label = get_accesshide(get_string('language'));
1615         $s->class = 'langmenu';
1616         return $this->render($s);
1617     }
1619     /**
1620      * Output the row of editing icons for a block, as defined by the controls array.
1621      *
1622      * @param array $controls an array like {@link block_contents::$controls}.
1623      * @param string $blockid The ID given to the block.
1624      * @return string HTML fragment.
1625      */
1626     public function block_controls($actions, $blockid = null) {
1627         global $CFG;
1628         if (empty($actions)) {
1629             return '';
1630         }
1631         $menu = new action_menu($actions);
1632         if ($blockid !== null) {
1633             $menu->set_owner_selector('#'.$blockid);
1634         }
1635         $menu->set_constraint('.block-region');
1636         $menu->attributes['class'] .= ' block-control-actions commands';
1637         return $this->render($menu);
1638     }
1640     /**
1641      * Returns the HTML for a basic textarea field.
1642      *
1643      * @param string $name Name to use for the textarea element
1644      * @param string $id The id to use fort he textarea element
1645      * @param string $value Initial content to display in the textarea
1646      * @param int $rows Number of rows to display
1647      * @param int $cols Number of columns to display
1648      * @return string the HTML to display
1649      */
1650     public function print_textarea($name, $id, $value, $rows, $cols) {
1651         global $OUTPUT;
1653         editors_head_setup();
1654         $editor = editors_get_preferred_editor(FORMAT_HTML);
1655         $editor->set_text($value);
1656         $editor->use_editor($id, []);
1658         $context = [
1659             'id' => $id,
1660             'name' => $name,
1661             'value' => $value,
1662             'rows' => $rows,
1663             'cols' => $cols
1664         ];
1666         return $OUTPUT->render_from_template('core_form/editor_textarea', $context);
1667     }
1669     /**
1670      * Renders an action menu component.
1671      *
1672      * @param action_menu $menu
1673      * @return string HTML
1674      */
1675     public function render_action_menu(action_menu $menu) {
1677         // We don't want the class icon there!
1678         foreach ($menu->get_secondary_actions() as $action) {
1679             if ($action instanceof \action_menu_link && $action->has_class('icon')) {
1680                 $action->attributes['class'] = preg_replace('/(^|\s+)icon(\s+|$)/i', '', $action->attributes['class']);
1681             }
1682         }
1684         if ($menu->is_empty()) {
1685             return '';
1686         }
1687         $context = $menu->export_for_template($this);
1689         return $this->render_from_template('core/action_menu', $context);
1690     }
1692     /**
1693      * Renders an action_menu_link item.
1694      *
1695      * @param action_menu_link $action
1696      * @return string HTML fragment
1697      */
1698     protected function render_action_menu_link(action_menu_link $action) {
1699         return $this->render_from_template('core/action_menu_link', $action->export_for_template($this));
1700     }
1702     /**
1703      * Renders a primary action_menu_filler item.
1704      *
1705      * @param action_menu_link_filler $action
1706      * @return string HTML fragment
1707      */
1708     protected function render_action_menu_filler(action_menu_filler $action) {
1709         return html_writer::span('&nbsp;', 'filler');
1710     }
1712     /**
1713      * Renders a primary action_menu_link item.
1714      *
1715      * @param action_menu_link_primary $action
1716      * @return string HTML fragment
1717      */
1718     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1719         return $this->render_action_menu_link($action);
1720     }
1722     /**
1723      * Renders a secondary action_menu_link item.
1724      *
1725      * @param action_menu_link_secondary $action
1726      * @return string HTML fragment
1727      */
1728     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1729         return $this->render_action_menu_link($action);
1730     }
1732     /**
1733      * Prints a nice side block with an optional header.
1734      *
1735      * @param block_contents $bc HTML for the content
1736      * @param string $region the region the block is appearing in.
1737      * @return string the HTML to be output.
1738      */
1739     public function block(block_contents $bc, $region) {
1740         $bc = clone($bc); // Avoid messing up the object passed in.
1741         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1742             $bc->collapsible = block_contents::NOT_HIDEABLE;
1743         }
1745         $id = !empty($bc->attributes['id']) ? $bc->attributes['id'] : uniqid('block-');
1746         $context = new stdClass();
1747         $context->skipid = $bc->skipid;
1748         $context->blockinstanceid = $bc->blockinstanceid ?: uniqid('fakeid-');
1749         $context->dockable = $bc->dockable;
1750         $context->id = $id;
1751         $context->hidden = $bc->collapsible == block_contents::HIDDEN;
1752         $context->skiptitle = strip_tags($bc->title);
1753         $context->showskiplink = !empty($context->skiptitle);
1754         $context->arialabel = $bc->arialabel;
1755         $context->ariarole = !empty($bc->attributes['role']) ? $bc->attributes['role'] : 'complementary';
1756         $context->class = $bc->attributes['class'];
1757         $context->type = $bc->attributes['data-block'];
1758         $context->title = $bc->title;
1759         $context->content = $bc->content;
1760         $context->annotation = $bc->annotation;
1761         $context->footer = $bc->footer;
1762         $context->hascontrols = !empty($bc->controls);
1763         if ($context->hascontrols) {
1764             $context->controls = $this->block_controls($bc->controls, $id);
1765         }
1767         return $this->render_from_template('core/block', $context);
1768     }
1770     /**
1771      * Render the contents of a block_list.
1772      *
1773      * @param array $icons the icon for each item.
1774      * @param array $items the content of each item.
1775      * @return string HTML
1776      */
1777     public function list_block_contents($icons, $items) {
1778         $row = 0;
1779         $lis = array();
1780         foreach ($items as $key => $string) {
1781             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1782             if (!empty($icons[$key])) { //test if the content has an assigned icon
1783                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1784             }
1785             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1786             $item .= html_writer::end_tag('li');
1787             $lis[] = $item;
1788             $row = 1 - $row; // Flip even/odd.
1789         }
1790         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1791     }
1793     /**
1794      * Output all the blocks in a particular region.
1795      *
1796      * @param string $region the name of a region on this page.
1797      * @return string the HTML to be output.
1798      */
1799     public function blocks_for_region($region) {
1800         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1801         $blocks = $this->page->blocks->get_blocks_for_region($region);
1802         $lastblock = null;
1803         $zones = array();
1804         foreach ($blocks as $block) {
1805             $zones[] = $block->title;
1806         }
1807         $output = '';
1809         foreach ($blockcontents as $bc) {
1810             if ($bc instanceof block_contents) {
1811                 $output .= $this->block($bc, $region);
1812                 $lastblock = $bc->title;
1813             } else if ($bc instanceof block_move_target) {
1814                 $output .= $this->block_move_target($bc, $zones, $lastblock, $region);
1815             } else {
1816                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1817             }
1818         }
1819         return $output;
1820     }
1822     /**
1823      * Output a place where the block that is currently being moved can be dropped.
1824      *
1825      * @param block_move_target $target with the necessary details.
1826      * @param array $zones array of areas where the block can be moved to
1827      * @param string $previous the block located before the area currently being rendered.
1828      * @param string $region the name of the region
1829      * @return string the HTML to be output.
1830      */
1831     public function block_move_target($target, $zones, $previous, $region) {
1832         if ($previous == null) {
1833             if (empty($zones)) {
1834                 // There are no zones, probably because there are no blocks.
1835                 $regions = $this->page->theme->get_all_block_regions();
1836                 $position = get_string('moveblockinregion', 'block', $regions[$region]);
1837             } else {
1838                 $position = get_string('moveblockbefore', 'block', $zones[0]);
1839             }
1840         } else {
1841             $position = get_string('moveblockafter', 'block', $previous);
1842         }
1843         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1844     }
1846     /**
1847      * Renders a special html link with attached action
1848      *
1849      * Theme developers: DO NOT OVERRIDE! Please override function
1850      * {@link core_renderer::render_action_link()} instead.
1851      *
1852      * @param string|moodle_url $url
1853      * @param string $text HTML fragment
1854      * @param component_action $action
1855      * @param array $attributes associative array of html link attributes + disabled
1856      * @param pix_icon optional pix icon to render with the link
1857      * @return string HTML fragment
1858      */
1859     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1860         if (!($url instanceof moodle_url)) {
1861             $url = new moodle_url($url);
1862         }
1863         $link = new action_link($url, $text, $action, $attributes, $icon);
1865         return $this->render($link);
1866     }
1868     /**
1869      * Renders an action_link object.
1870      *
1871      * The provided link is renderer and the HTML returned. At the same time the
1872      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1873      *
1874      * @param action_link $link
1875      * @return string HTML fragment
1876      */
1877     protected function render_action_link(action_link $link) {
1878         return $this->render_from_template('core/action_link', $link->export_for_template($this));
1879     }
1881     /**
1882      * Renders an action_icon.
1883      *
1884      * This function uses the {@link core_renderer::action_link()} method for the
1885      * most part. What it does different is prepare the icon as HTML and use it
1886      * as the link text.
1887      *
1888      * Theme developers: If you want to change how action links and/or icons are rendered,
1889      * consider overriding function {@link core_renderer::render_action_link()} and
1890      * {@link core_renderer::render_pix_icon()}.
1891      *
1892      * @param string|moodle_url $url A string URL or moodel_url
1893      * @param pix_icon $pixicon
1894      * @param component_action $action
1895      * @param array $attributes associative array of html link attributes + disabled
1896      * @param bool $linktext show title next to image in link
1897      * @return string HTML fragment
1898      */
1899     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1900         if (!($url instanceof moodle_url)) {
1901             $url = new moodle_url($url);
1902         }
1903         $attributes = (array)$attributes;
1905         if (empty($attributes['class'])) {
1906             // let ppl override the class via $options
1907             $attributes['class'] = 'action-icon';
1908         }
1910         $icon = $this->render($pixicon);
1912         if ($linktext) {
1913             $text = $pixicon->attributes['alt'];
1914         } else {
1915             $text = '';
1916         }
1918         return $this->action_link($url, $text.$icon, $action, $attributes);
1919     }
1921    /**
1922     * Print a message along with button choices for Continue/Cancel
1923     *
1924     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1925     *
1926     * @param string $message The question to ask the user
1927     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1928     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1929     * @return string HTML fragment
1930     */
1931     public function confirm($message, $continue, $cancel) {
1932         if ($continue instanceof single_button) {
1933             // ok
1934             $continue->primary = true;
1935         } else if (is_string($continue)) {
1936             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post', true);
1937         } else if ($continue instanceof moodle_url) {
1938             $continue = new single_button($continue, get_string('continue'), 'post', true);
1939         } else {
1940             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1941         }
1943         if ($cancel instanceof single_button) {
1944             // ok
1945         } else if (is_string($cancel)) {
1946             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1947         } else if ($cancel instanceof moodle_url) {
1948             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1949         } else {
1950             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1951         }
1953         $attributes = [
1954             'role'=>'alertdialog',
1955             'aria-labelledby'=>'modal-header',
1956             'aria-describedby'=>'modal-body',
1957             'aria-modal'=>'true'
1958         ];
1960         $output = $this->box_start('generalbox modal modal-dialog modal-in-page show', 'notice', $attributes);
1961         $output .= $this->box_start('modal-content', 'modal-content');
1962         $output .= $this->box_start('modal-header p-x-1', 'modal-header');
1963         $output .= html_writer::tag('h4', get_string('confirm'));
1964         $output .= $this->box_end();
1965         $attributes = [
1966             'role'=>'alert',
1967             'data-aria-autofocus'=>'true'
1968         ];
1969         $output .= $this->box_start('modal-body', 'modal-body', $attributes);
1970         $output .= html_writer::tag('p', $message);
1971         $output .= $this->box_end();
1972         $output .= $this->box_start('modal-footer', 'modal-footer');
1973         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1974         $output .= $this->box_end();
1975         $output .= $this->box_end();
1976         $output .= $this->box_end();
1977         return $output;
1978     }
1980     /**
1981      * Returns a form with a single button.
1982      *
1983      * Theme developers: DO NOT OVERRIDE! Please override function
1984      * {@link core_renderer::render_single_button()} instead.
1985      *
1986      * @param string|moodle_url $url
1987      * @param string $label button text
1988      * @param string $method get or post submit method
1989      * @param array $options associative array {disabled, title, etc.}
1990      * @return string HTML fragment
1991      */
1992     public function single_button($url, $label, $method='post', array $options=null) {
1993         if (!($url instanceof moodle_url)) {
1994             $url = new moodle_url($url);
1995         }
1996         $button = new single_button($url, $label, $method);
1998         foreach ((array)$options as $key=>$value) {
1999             if (property_exists($button, $key)) {
2000                 $button->$key = $value;
2001             } else {
2002                 $button->set_attribute($key, $value);
2003             }
2004         }
2006         return $this->render($button);
2007     }
2009     /**
2010      * Renders a single button widget.
2011      *
2012      * This will return HTML to display a form containing a single button.
2013      *
2014      * @param single_button $button
2015      * @return string HTML fragment
2016      */
2017     protected function render_single_button(single_button $button) {
2018         return $this->render_from_template('core/single_button', $button->export_for_template($this));
2019     }
2021     /**
2022      * Returns a form with a single select widget.
2023      *
2024      * Theme developers: DO NOT OVERRIDE! Please override function
2025      * {@link core_renderer::render_single_select()} instead.
2026      *
2027      * @param moodle_url $url form action target, includes hidden fields
2028      * @param string $name name of selection field - the changing parameter in url
2029      * @param array $options list of options
2030      * @param string $selected selected element
2031      * @param array $nothing
2032      * @param string $formid
2033      * @param array $attributes other attributes for the single select
2034      * @return string HTML fragment
2035      */
2036     public function single_select($url, $name, array $options, $selected = '',
2037                                 $nothing = array('' => 'choosedots'), $formid = null, $attributes = array()) {
2038         if (!($url instanceof moodle_url)) {
2039             $url = new moodle_url($url);
2040         }
2041         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
2043         if (array_key_exists('label', $attributes)) {
2044             $select->set_label($attributes['label']);
2045             unset($attributes['label']);
2046         }
2047         $select->attributes = $attributes;
2049         return $this->render($select);
2050     }
2052     /**
2053      * Returns a dataformat selection and download form
2054      *
2055      * @param string $label A text label
2056      * @param moodle_url|string $base The download page url
2057      * @param string $name The query param which will hold the type of the download
2058      * @param array $params Extra params sent to the download page
2059      * @return string HTML fragment
2060      */
2061     public function download_dataformat_selector($label, $base, $name = 'dataformat', $params = array()) {
2063         $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
2064         $options = array();
2065         foreach ($formats as $format) {
2066             if ($format->is_enabled()) {
2067                 $options[] = array(
2068                     'value' => $format->name,
2069                     'label' => get_string('dataformat', $format->component),
2070                 );
2071             }
2072         }
2073         $hiddenparams = array();
2074         foreach ($params as $key => $value) {
2075             $hiddenparams[] = array(
2076                 'name' => $key,
2077                 'value' => $value,
2078             );
2079         }
2080         $data = array(
2081             'label' => $label,
2082             'base' => $base,
2083             'name' => $name,
2084             'params' => $hiddenparams,
2085             'options' => $options,
2086             'sesskey' => sesskey(),
2087             'submit' => get_string('download'),
2088         );
2090         return $this->render_from_template('core/dataformat_selector', $data);
2091     }
2094     /**
2095      * Internal implementation of single_select rendering
2096      *
2097      * @param single_select $select
2098      * @return string HTML fragment
2099      */
2100     protected function render_single_select(single_select $select) {
2101         return $this->render_from_template('core/single_select', $select->export_for_template($this));
2102     }
2104     /**
2105      * Returns a form with a url select widget.
2106      *
2107      * Theme developers: DO NOT OVERRIDE! Please override function
2108      * {@link core_renderer::render_url_select()} instead.
2109      *
2110      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
2111      * @param string $selected selected element
2112      * @param array $nothing
2113      * @param string $formid
2114      * @return string HTML fragment
2115      */
2116     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
2117         $select = new url_select($urls, $selected, $nothing, $formid);
2118         return $this->render($select);
2119     }
2121     /**
2122      * Internal implementation of url_select rendering
2123      *
2124      * @param url_select $select
2125      * @return string HTML fragment
2126      */
2127     protected function render_url_select(url_select $select) {
2128         return $this->render_from_template('core/url_select', $select->export_for_template($this));
2129     }
2131     /**
2132      * Returns a string containing a link to the user documentation.
2133      * Also contains an icon by default. Shown to teachers and admin only.
2134      *
2135      * @param string $path The page link after doc root and language, no leading slash.
2136      * @param string $text The text to be displayed for the link
2137      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
2138      * @param array $attributes htm attributes
2139      * @return string
2140      */
2141     public function doc_link($path, $text = '', $forcepopup = false, array $attributes = []) {
2142         global $CFG;
2144         $icon = $this->pix_icon('docs', '', 'moodle', array('class'=>'iconhelp icon-pre', 'role'=>'presentation'));
2146         $attributes['href'] = new moodle_url(get_docs_url($path));
2147         if (!empty($CFG->doctonewwindow) || $forcepopup) {
2148             $attributes['class'] = 'helplinkpopup';
2149         }
2151         return html_writer::tag('a', $icon.$text, $attributes);
2152     }
2154     /**
2155      * Return HTML for an image_icon.
2156      *
2157      * Theme developers: DO NOT OVERRIDE! Please override function
2158      * {@link core_renderer::render_image_icon()} instead.
2159      *
2160      * @param string $pix short pix name
2161      * @param string $alt mandatory alt attribute
2162      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2163      * @param array $attributes htm attributes
2164      * @return string HTML fragment
2165      */
2166     public function image_icon($pix, $alt, $component='moodle', array $attributes = null) {
2167         $icon = new image_icon($pix, $alt, $component, $attributes);
2168         return $this->render($icon);
2169     }
2171     /**
2172      * Renders a pix_icon widget and returns the HTML to display it.
2173      *
2174      * @param image_icon $icon
2175      * @return string HTML fragment
2176      */
2177     protected function render_image_icon(image_icon $icon) {
2178         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2179         return $system->render_pix_icon($this, $icon);
2180     }
2182     /**
2183      * Return HTML for a pix_icon.
2184      *
2185      * Theme developers: DO NOT OVERRIDE! Please override function
2186      * {@link core_renderer::render_pix_icon()} instead.
2187      *
2188      * @param string $pix short pix name
2189      * @param string $alt mandatory alt attribute
2190      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2191      * @param array $attributes htm lattributes
2192      * @return string HTML fragment
2193      */
2194     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
2195         $icon = new pix_icon($pix, $alt, $component, $attributes);
2196         return $this->render($icon);
2197     }
2199     /**
2200      * Renders a pix_icon widget and returns the HTML to display it.
2201      *
2202      * @param pix_icon $icon
2203      * @return string HTML fragment
2204      */
2205     protected function render_pix_icon(pix_icon $icon) {
2206         $system = \core\output\icon_system::instance();
2207         return $system->render_pix_icon($this, $icon);
2208     }
2210     /**
2211      * Return HTML to display an emoticon icon.
2212      *
2213      * @param pix_emoticon $emoticon
2214      * @return string HTML fragment
2215      */
2216     protected function render_pix_emoticon(pix_emoticon $emoticon) {
2217         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2218         return $system->render_pix_icon($this, $emoticon);
2219     }
2221     /**
2222      * Produces the html that represents this rating in the UI
2223      *
2224      * @param rating $rating the page object on which this rating will appear
2225      * @return string
2226      */
2227     function render_rating(rating $rating) {
2228         global $CFG, $USER;
2230         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
2231             return null;//ratings are turned off
2232         }
2234         $ratingmanager = new rating_manager();
2235         // Initialise the JavaScript so ratings can be done by AJAX.
2236         $ratingmanager->initialise_rating_javascript($this->page);
2238         $strrate = get_string("rate", "rating");
2239         $ratinghtml = ''; //the string we'll return
2241         // permissions check - can they view the aggregate?
2242         if ($rating->user_can_view_aggregate()) {
2244             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
2245             $aggregatelabel = html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
2246             $aggregatestr   = $rating->get_aggregate_string();
2248             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
2249             if ($rating->count > 0) {
2250                 $countstr = "({$rating->count})";
2251             } else {
2252                 $countstr = '-';
2253             }
2254             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
2256             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
2258                 $nonpopuplink = $rating->get_view_ratings_url();
2259                 $popuplink = $rating->get_view_ratings_url(true);
2261                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
2262                 $aggregatehtml = $this->action_link($nonpopuplink, $aggregatehtml, $action);
2263             }
2265             $ratinghtml .= html_writer::tag('span', $aggregatelabel . $aggregatehtml, array('class' => 'rating-aggregate-container'));
2266         }
2268         $formstart = null;
2269         // if the item doesn't belong to the current user, the user has permission to rate
2270         // and we're within the assessable period
2271         if ($rating->user_can_rate()) {
2273             $rateurl = $rating->get_rate_url();
2274             $inputs = $rateurl->params();
2276             //start the rating form
2277             $formattrs = array(
2278                 'id'     => "postrating{$rating->itemid}",
2279                 'class'  => 'postratingform',
2280                 'method' => 'post',
2281                 'action' => $rateurl->out_omit_querystring()
2282             );
2283             $formstart  = html_writer::start_tag('form', $formattrs);
2284             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2286             // add the hidden inputs
2287             foreach ($inputs as $name => $value) {
2288                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2289                 $formstart .= html_writer::empty_tag('input', $attributes);
2290             }
2292             if (empty($ratinghtml)) {
2293                 $ratinghtml .= $strrate.': ';
2294             }
2295             $ratinghtml = $formstart.$ratinghtml;
2297             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2298             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2299             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2300             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2302             //output submit button
2303             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2305             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2306             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2308             if (!$rating->settings->scale->isnumeric) {
2309                 // If a global scale, try to find current course ID from the context
2310                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2311                     $courseid = $coursecontext->instanceid;
2312                 } else {
2313                     $courseid = $rating->settings->scale->courseid;
2314                 }
2315                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2316             }
2317             $ratinghtml .= html_writer::end_tag('span');
2318             $ratinghtml .= html_writer::end_tag('div');
2319             $ratinghtml .= html_writer::end_tag('form');
2320         }
2322         return $ratinghtml;
2323     }
2325     /**
2326      * Centered heading with attached help button (same title text)
2327      * and optional icon attached.
2328      *
2329      * @param string $text A heading text
2330      * @param string $helpidentifier The keyword that defines a help page
2331      * @param string $component component name
2332      * @param string|moodle_url $icon
2333      * @param string $iconalt icon alt text
2334      * @param int $level The level of importance of the heading. Defaulting to 2
2335      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2336      * @return string HTML fragment
2337      */
2338     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2339         $image = '';
2340         if ($icon) {
2341             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon iconlarge'));
2342         }
2344         $help = '';
2345         if ($helpidentifier) {
2346             $help = $this->help_icon($helpidentifier, $component);
2347         }
2349         return $this->heading($image.$text.$help, $level, $classnames);
2350     }
2352     /**
2353      * Returns HTML to display a help icon.
2354      *
2355      * @deprecated since Moodle 2.0
2356      */
2357     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2358         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2359     }
2361     /**
2362      * Returns HTML to display a help icon.
2363      *
2364      * Theme developers: DO NOT OVERRIDE! Please override function
2365      * {@link core_renderer::render_help_icon()} instead.
2366      *
2367      * @param string $identifier The keyword that defines a help page
2368      * @param string $component component name
2369      * @param string|bool $linktext true means use $title as link text, string means link text value
2370      * @return string HTML fragment
2371      */
2372     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2373         $icon = new help_icon($identifier, $component);
2374         $icon->diag_strings();
2375         if ($linktext === true) {
2376             $icon->linktext = get_string($icon->identifier, $icon->component);
2377         } else if (!empty($linktext)) {
2378             $icon->linktext = $linktext;
2379         }
2380         return $this->render($icon);
2381     }
2383     /**
2384      * Implementation of user image rendering.
2385      *
2386      * @param help_icon $helpicon A help icon instance
2387      * @return string HTML fragment
2388      */
2389     protected function render_help_icon(help_icon $helpicon) {
2390         $context = $helpicon->export_for_template($this);
2391         return $this->render_from_template('core/help_icon', $context);
2392     }
2394     /**
2395      * Returns HTML to display a scale help icon.
2396      *
2397      * @param int $courseid
2398      * @param stdClass $scale instance
2399      * @return string HTML fragment
2400      */
2401     public function help_icon_scale($courseid, stdClass $scale) {
2402         global $CFG;
2404         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2406         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2408         $scaleid = abs($scale->id);
2410         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2411         $action = new popup_action('click', $link, 'ratingscale');
2413         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2414     }
2416     /**
2417      * Creates and returns a spacer image with optional line break.
2418      *
2419      * @param array $attributes Any HTML attributes to add to the spaced.
2420      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2421      *     laxy do it with CSS which is a much better solution.
2422      * @return string HTML fragment
2423      */
2424     public function spacer(array $attributes = null, $br = false) {
2425         $attributes = (array)$attributes;
2426         if (empty($attributes['width'])) {
2427             $attributes['width'] = 1;
2428         }
2429         if (empty($attributes['height'])) {
2430             $attributes['height'] = 1;
2431         }
2432         $attributes['class'] = 'spacer';
2434         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2436         if (!empty($br)) {
2437             $output .= '<br />';
2438         }
2440         return $output;
2441     }
2443     /**
2444      * Returns HTML to display the specified user's avatar.
2445      *
2446      * User avatar may be obtained in two ways:
2447      * <pre>
2448      * // Option 1: (shortcut for simple cases, preferred way)
2449      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2450      * $OUTPUT->user_picture($user, array('popup'=>true));
2451      *
2452      * // Option 2:
2453      * $userpic = new user_picture($user);
2454      * // Set properties of $userpic
2455      * $userpic->popup = true;
2456      * $OUTPUT->render($userpic);
2457      * </pre>
2458      *
2459      * Theme developers: DO NOT OVERRIDE! Please override function
2460      * {@link core_renderer::render_user_picture()} instead.
2461      *
2462      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2463      *     If any of these are missing, the database is queried. Avoid this
2464      *     if at all possible, particularly for reports. It is very bad for performance.
2465      * @param array $options associative array with user picture options, used only if not a user_picture object,
2466      *     options are:
2467      *     - courseid=$this->page->course->id (course id of user profile in link)
2468      *     - size=35 (size of image)
2469      *     - link=true (make image clickable - the link leads to user profile)
2470      *     - popup=false (open in popup)
2471      *     - alttext=true (add image alt attribute)
2472      *     - class = image class attribute (default 'userpicture')
2473      *     - visibletoscreenreaders=true (whether to be visible to screen readers)
2474      *     - includefullname=false (whether to include the user's full name together with the user picture)
2475      *     - includetoken = false (whether to use a token for authentication. True for current user, int value for other user id)
2476      * @return string HTML fragment
2477      */
2478     public function user_picture(stdClass $user, array $options = null) {
2479         $userpicture = new user_picture($user);
2480         foreach ((array)$options as $key=>$value) {
2481             if (property_exists($userpicture, $key)) {
2482                 $userpicture->$key = $value;
2483             }
2484         }
2485         return $this->render($userpicture);
2486     }
2488     /**
2489      * Internal implementation of user image rendering.
2490      *
2491      * @param user_picture $userpicture
2492      * @return string
2493      */
2494     protected function render_user_picture(user_picture $userpicture) {
2495         global $CFG, $DB;
2497         $user = $userpicture->user;
2498         $canviewfullnames = has_capability('moodle/site:viewfullnames', $this->page->context);
2500         if ($userpicture->alttext) {
2501             if (!empty($user->imagealt)) {
2502                 $alt = $user->imagealt;
2503             } else {
2504                 $alt = get_string('pictureof', '', fullname($user, $canviewfullnames));
2505             }
2506         } else {
2507             $alt = '';
2508         }
2510         if (empty($userpicture->size)) {
2511             $size = 35;
2512         } else if ($userpicture->size === true or $userpicture->size == 1) {
2513             $size = 100;
2514         } else {
2515             $size = $userpicture->size;
2516         }
2518         $class = $userpicture->class;
2520         if ($user->picture == 0) {
2521             $class .= ' defaultuserpic';
2522         }
2524         $src = $userpicture->get_url($this->page, $this);
2526         $attributes = array('src' => $src, 'class' => $class, 'width' => $size, 'height' => $size);
2527         if (!$userpicture->visibletoscreenreaders) {
2528             $alt = '';
2529             $attributes['aria-hidden'] = 'true';
2530         }
2532         if (!empty($alt)) {
2533             $attributes['alt'] = $alt;
2534             $attributes['title'] = $alt;
2535         }
2537         // get the image html output fisrt
2538         $output = html_writer::empty_tag('img', $attributes);
2540         // Show fullname together with the picture when desired.
2541         if ($userpicture->includefullname) {
2542             $output .= fullname($userpicture->user, $canviewfullnames);
2543         }
2545         // then wrap it in link if needed
2546         if (!$userpicture->link) {
2547             return $output;
2548         }
2550         if (empty($userpicture->courseid)) {
2551             $courseid = $this->page->course->id;
2552         } else {
2553             $courseid = $userpicture->courseid;
2554         }
2556         if ($courseid == SITEID) {
2557             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2558         } else {
2559             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2560         }
2562         $attributes = array('href'=>$url);
2563         if (!$userpicture->visibletoscreenreaders) {
2564             $attributes['tabindex'] = '-1';
2565             $attributes['aria-hidden'] = 'true';
2566         }
2568         if ($userpicture->popup) {
2569             $id = html_writer::random_id('userpicture');
2570             $attributes['id'] = $id;
2571             $this->add_action_handler(new popup_action('click', $url), $id);
2572         }
2574         return html_writer::tag('a', $output, $attributes);
2575     }
2577     /**
2578      * Internal implementation of file tree viewer items rendering.
2579      *
2580      * @param array $dir
2581      * @return string
2582      */
2583     public function htmllize_file_tree($dir) {
2584         if (empty($dir['subdirs']) and empty($dir['files'])) {
2585             return '';
2586         }
2587         $result = '<ul>';
2588         foreach ($dir['subdirs'] as $subdir) {
2589             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2590         }
2591         foreach ($dir['files'] as $file) {
2592             $filename = $file->get_filename();
2593             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2594         }
2595         $result .= '</ul>';
2597         return $result;
2598     }
2600     /**
2601      * Returns HTML to display the file picker
2602      *
2603      * <pre>
2604      * $OUTPUT->file_picker($options);
2605      * </pre>
2606      *
2607      * Theme developers: DO NOT OVERRIDE! Please override function
2608      * {@link core_renderer::render_file_picker()} instead.
2609      *
2610      * @param array $options associative array with file manager options
2611      *   options are:
2612      *       maxbytes=>-1,
2613      *       itemid=>0,
2614      *       client_id=>uniqid(),
2615      *       acepted_types=>'*',
2616      *       return_types=>FILE_INTERNAL,
2617      *       context=>$PAGE->context
2618      * @return string HTML fragment
2619      */
2620     public function file_picker($options) {
2621         $fp = new file_picker($options);
2622         return $this->render($fp);
2623     }
2625     /**
2626      * Internal implementation of file picker rendering.
2627      *
2628      * @param file_picker $fp
2629      * @return string
2630      */
2631     public function render_file_picker(file_picker $fp) {
2632         global $CFG, $OUTPUT, $USER;
2633         $options = $fp->options;
2634         $client_id = $options->client_id;
2635         $strsaved = get_string('filesaved', 'repository');
2636         $straddfile = get_string('openpicker', 'repository');
2637         $strloading  = get_string('loading', 'repository');
2638         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2639         $strdroptoupload = get_string('droptoupload', 'moodle');
2640         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2642         $currentfile = $options->currentfile;
2643         if (empty($currentfile)) {
2644             $currentfile = '';
2645         } else {
2646             $currentfile .= ' - ';
2647         }
2648         if ($options->maxbytes) {
2649             $size = $options->maxbytes;
2650         } else {
2651             $size = get_max_upload_file_size();
2652         }
2653         if ($size == -1) {
2654             $maxsize = '';
2655         } else {
2656             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2657         }
2658         if ($options->buttonname) {
2659             $buttonname = ' name="' . $options->buttonname . '"';
2660         } else {
2661             $buttonname = '';
2662         }
2663         $html = <<<EOD
2664 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2665 $icon_progress
2666 </div>
2667 <div id="filepicker-wrapper-{$client_id}" class="mdl-left w-100" style="display:none">
2668     <div>
2669         <input type="button" class="btn btn-secondary fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2670         <span> $maxsize </span>
2671     </div>
2672 EOD;
2673         if ($options->env != 'url') {
2674             $html .= <<<EOD
2675     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2676     <div class="filepicker-filename">
2677         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2678         <div class="dndupload-progressbars"></div>
2679     </div>
2680     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2681     </div>
2682 EOD;
2683         }
2684         $html .= '</div>';
2685         return $html;
2686     }
2688     /**
2689      * @deprecated since Moodle 3.2
2690      */
2691     public function update_module_button() {
2692         throw new coding_exception('core_renderer::update_module_button() can not be used anymore. Activity ' .
2693             'modules should not add the edit module button, the link is already available in the Administration block. ' .
2694             'Themes can choose to display the link in the buttons row consistently for all module types.');
2695     }
2697     /**
2698      * Returns HTML to display a "Turn editing on/off" button in a form.
2699      *
2700      * @param moodle_url $url The URL + params to send through when clicking the button
2701      * @return string HTML the button
2702      */
2703     public function edit_button(moodle_url $url) {
2705         $url->param('sesskey', sesskey());
2706         if ($this->page->user_is_editing()) {
2707             $url->param('edit', 'off');
2708             $editstring = get_string('turneditingoff');
2709         } else {
2710             $url->param('edit', 'on');
2711             $editstring = get_string('turneditingon');
2712         }
2714         return $this->single_button($url, $editstring);
2715     }
2717     /**
2718      * Returns HTML to display a simple button to close a window
2719      *
2720      * @param string $text The lang string for the button's label (already output from get_string())
2721      * @return string html fragment
2722      */
2723     public function close_window_button($text='') {
2724         if (empty($text)) {
2725             $text = get_string('closewindow');
2726         }
2727         $button = new single_button(new moodle_url('#'), $text, 'get');
2728         $button->add_action(new component_action('click', 'close_window'));
2730         return $this->container($this->render($button), 'closewindow');
2731     }
2733     /**
2734      * Output an error message. By default wraps the error message in <span class="error">.
2735      * If the error message is blank, nothing is output.
2736      *
2737      * @param string $message the error message.
2738      * @return string the HTML to output.
2739      */
2740     public function error_text($message) {
2741         if (empty($message)) {
2742             return '';
2743         }
2744         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2745         return html_writer::tag('span', $message, array('class' => 'error'));
2746     }
2748     /**
2749      * Do not call this function directly.
2750      *
2751      * To terminate the current script with a fatal error, call the {@link print_error}
2752      * function, or throw an exception. Doing either of those things will then call this
2753      * function to display the error, before terminating the execution.
2754      *
2755      * @param string $message The message to output
2756      * @param string $moreinfourl URL where more info can be found about the error
2757      * @param string $link Link for the Continue button
2758      * @param array $backtrace The execution backtrace
2759      * @param string $debuginfo Debugging information
2760      * @return string the HTML to output.
2761      */
2762     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
2763         global $CFG;
2765         $output = '';
2766         $obbuffer = '';
2768         if ($this->has_started()) {
2769             // we can not always recover properly here, we have problems with output buffering,
2770             // html tables, etc.
2771             $output .= $this->opencontainers->pop_all_but_last();
2773         } else {
2774             // It is really bad if library code throws exception when output buffering is on,
2775             // because the buffered text would be printed before our start of page.
2776             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2777             error_reporting(0); // disable notices from gzip compression, etc.
2778             while (ob_get_level() > 0) {
2779                 $buff = ob_get_clean();
2780                 if ($buff === false) {
2781                     break;
2782                 }
2783                 $obbuffer .= $buff;
2784             }
2785             error_reporting($CFG->debug);
2787             // Output not yet started.
2788             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2789             if (empty($_SERVER['HTTP_RANGE'])) {
2790                 @header($protocol . ' 404 Not Found');
2791             } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
2792                 // Coax iOS 10 into sending the session cookie.
2793                 @header($protocol . ' 403 Forbidden');
2794             } else {
2795                 // Must stop byteserving attempts somehow,
2796                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2797                 @header($protocol . ' 407 Proxy Authentication Required');
2798             }
2800             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2801             $this->page->set_url('/'); // no url
2802             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2803             $this->page->set_title(get_string('error'));
2804             $this->page->set_heading($this->page->course->fullname);
2805             $output .= $this->header();
2806         }
2808         $message = '<p class="errormessage">' . s($message) . '</p>'.
2809                 '<p class="errorcode"><a href="' . s($moreinfourl) . '">' .
2810                 get_string('moreinformation') . '</a></p>';
2811         if (empty($CFG->rolesactive)) {
2812             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2813             //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.
2814         }
2815         $output .= $this->box($message, 'errorbox alert alert-danger', null, array('data-rel' => 'fatalerror'));
2817         if ($CFG->debugdeveloper) {
2818             $labelsep = get_string('labelsep', 'langconfig');
2819             if (!empty($debuginfo)) {
2820                 $debuginfo = s($debuginfo); // removes all nasty JS
2821                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2822                 $label = get_string('debuginfo', 'debug') . $labelsep;
2823                 $output .= $this->notification("<strong>$label</strong> " . $debuginfo, 'notifytiny');
2824             }
2825             if (!empty($backtrace)) {
2826                 $label = get_string('stacktrace', 'debug') . $labelsep;
2827                 $output .= $this->notification("<strong>$label</strong> " . format_backtrace($backtrace), 'notifytiny');
2828             }
2829             if ($obbuffer !== '' ) {
2830                 $label = get_string('outputbuffer', 'debug') . $labelsep;
2831                 $output .= $this->notification("<strong>$label</strong> " . s($obbuffer), 'notifytiny');
2832             }
2833         }
2835         if (empty($CFG->rolesactive)) {
2836             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2837         } else if (!empty($link)) {
2838             $output .= $this->continue_button($link);
2839         }
2841         $output .= $this->footer();
2843         // Padding to encourage IE to display our error page, rather than its own.
2844         $output .= str_repeat(' ', 512);
2846         return $output;
2847     }
2849     /**
2850      * Output a notification (that is, a status message about something that has just happened).
2851      *
2852      * Note: \core\notification::add() may be more suitable for your usage.
2853      *
2854      * @param string $message The message to print out.
2855      * @param string $type    The type of notification. See constants on \core\output\notification.
2856      * @return string the HTML to output.
2857      */
2858     public function notification($message, $type = null) {
2859         $typemappings = [
2860             // Valid types.
2861             'success'           => \core\output\notification::NOTIFY_SUCCESS,
2862             'info'              => \core\output\notification::NOTIFY_INFO,
2863             'warning'           => \core\output\notification::NOTIFY_WARNING,
2864             'error'             => \core\output\notification::NOTIFY_ERROR,
2866             // Legacy types mapped to current types.
2867             'notifyproblem'     => \core\output\notification::NOTIFY_ERROR,
2868             'notifytiny'        => \core\output\notification::NOTIFY_ERROR,
2869             'notifyerror'       => \core\output\notification::NOTIFY_ERROR,
2870             'notifysuccess'     => \core\output\notification::NOTIFY_SUCCESS,
2871             'notifymessage'     => \core\output\notification::NOTIFY_INFO,
2872             'notifyredirect'    => \core\output\notification::NOTIFY_INFO,
2873             'redirectmessage'   => \core\output\notification::NOTIFY_INFO,
2874         ];
2876         $extraclasses = [];
2878         if ($type) {
2879             if (strpos($type, ' ') === false) {
2880                 // No spaces in the list of classes, therefore no need to loop over and determine the class.
2881                 if (isset($typemappings[$type])) {
2882                     $type = $typemappings[$type];
2883                 } else {
2884                     // The value provided did not match a known type. It must be an extra class.
2885                     $extraclasses = [$type];
2886                 }
2887             } else {
2888                 // Identify what type of notification this is.
2889                 $classarray = explode(' ', self::prepare_classes($type));
2891                 // Separate out the type of notification from the extra classes.
2892                 foreach ($classarray as $class) {
2893                     if (isset($typemappings[$class])) {
2894                         $type = $typemappings[$class];
2895                     } else {
2896                         $extraclasses[] = $class;
2897                     }
2898                 }
2899             }
2900         }
2902         $notification = new \core\output\notification($message, $type);
2903         if (count($extraclasses)) {
2904             $notification->set_extra_classes($extraclasses);
2905         }
2907         // Return the rendered template.
2908         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2909     }
2911     /**
2912      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2913      */
2914     public function notify_problem() {
2915         throw new coding_exception('core_renderer::notify_problem() can not be used any more, '.
2916             'please use \core\notification::add(), or \core\output\notification as required.');
2917     }
2919     /**
2920      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2921      */
2922     public function notify_success() {
2923         throw new coding_exception('core_renderer::notify_success() can not be used any more, '.
2924             'please use \core\notification::add(), or \core\output\notification as required.');
2925     }
2927     /**
2928      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2929      */
2930     public function notify_message() {
2931         throw new coding_exception('core_renderer::notify_message() can not be used any more, '.
2932             'please use \core\notification::add(), or \core\output\notification as required.');
2933     }
2935     /**
2936      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2937      */
2938     public function notify_redirect() {
2939         throw new coding_exception('core_renderer::notify_redirect() can not be used any more, '.
2940             'please use \core\notification::add(), or \core\output\notification as required.');
2941     }
2943     /**
2944      * Render a notification (that is, a status message about something that has
2945      * just happened).
2946      *
2947      * @param \core\output\notification $notification the notification to print out
2948      * @return string the HTML to output.
2949      */
2950     protected function render_notification(\core\output\notification $notification) {
2951         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2952     }
2954     /**
2955      * Returns HTML to display a continue button that goes to a particular URL.
2956      *
2957      * @param string|moodle_url $url The url the button goes to.
2958      * @return string the HTML to output.
2959      */
2960     public function continue_button($url) {
2961         if (!($url instanceof moodle_url)) {
2962             $url = new moodle_url($url);
2963         }
2964         $button = new single_button($url, get_string('continue'), 'get', true);
2965         $button->class = 'continuebutton';
2967         return $this->render($button);
2968     }
2970     /**
2971      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2972      *
2973      * Theme developers: DO NOT OVERRIDE! Please override function
2974      * {@link core_renderer::render_paging_bar()} instead.
2975      *
2976      * @param int $totalcount The total number of entries available to be paged through
2977      * @param int $page The page you are currently viewing
2978      * @param int $perpage The number of entries that should be shown per page
2979      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2980      * @param string $pagevar name of page parameter that holds the page number
2981      * @return string the HTML to output.
2982      */
2983     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2984         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2985         return $this->render($pb);
2986     }
2988     /**
2989      * Returns HTML to display the paging bar.
2990      *
2991      * @param paging_bar $pagingbar
2992      * @return string the HTML to output.
2993      */
2994     protected function render_paging_bar(paging_bar $pagingbar) {
2995         // Any more than 10 is not usable and causes weird wrapping of the pagination.
2996         $pagingbar->maxdisplay = 10;
2997         return $this->render_from_template('core/paging_bar', $pagingbar->export_for_template($this));
2998     }
3000     /**
3001      * Returns HTML to display initials bar to provide access to other pages  (usually in a search)
3002      *
3003      * @param string $current the currently selected letter.
3004      * @param string $class class name to add to this initial bar.
3005      * @param string $title the name to put in front of this initial bar.
3006      * @param string $urlvar URL parameter name for this initial.
3007      * @param string $url URL object.
3008      * @param array $alpha of letters in the alphabet.
3009      * @return string the HTML to output.
3010      */
3011     public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null) {
3012         $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha);
3013         return $this->render($ib);
3014     }
3016     /**
3017      * Internal implementation of initials bar rendering.
3018      *
3019      * @param initials_bar $initialsbar
3020      * @return string
3021      */
3022     protected function render_initials_bar(initials_bar $initialsbar) {
3023         return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
3024     }
3026     /**
3027      * Output the place a skip link goes to.
3028      *
3029      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
3030      * @return string the HTML to output.
3031      */
3032     public function skip_link_target($id = null) {
3033         return html_writer::span('', '', array('id' => $id));
3034     }
3036     /**
3037      * Outputs a heading
3038      *
3039      * @param string $text The text of the heading
3040      * @param int $level The level of importance of the heading. Defaulting to 2
3041      * @param string $classes A space-separated list of CSS classes. Defaulting to null
3042      * @param string $id An optional ID
3043      * @return string the HTML to output.
3044      */
3045     public function heading($text, $level = 2, $classes = null, $id = null) {
3046         $level = (integer) $level;
3047         if ($level < 1 or $level > 6) {
3048             throw new coding_exception('Heading level must be an integer between 1 and 6.');
3049         }
3050         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
3051     }
3053     /**
3054      * Outputs a box.
3055      *
3056      * @param string $contents The contents of the box
3057      * @param string $classes A space-separated list of CSS classes
3058      * @param string $id An optional ID
3059      * @param array $attributes An array of other attributes to give the box.
3060      * @return string the HTML to output.
3061      */
3062     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
3063         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
3064     }
3066     /**
3067      * Outputs the opening section of a box.
3068      *
3069      * @param string $classes A space-separated list of CSS classes
3070      * @param string $id An optional ID
3071      * @param array $attributes An array of other attributes to give the box.
3072      * @return string the HTML to output.
3073      */
3074     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
3075         $this->opencontainers->push('box', html_writer::end_tag('div'));
3076         $attributes['id'] = $id;
3077         $attributes['class'] = 'box py-3 ' . renderer_base::prepare_classes($classes);
3078         return html_writer::start_tag('div', $attributes);
3079     }
3081     /**
3082      * Outputs the closing section of a box.
3083      *
3084      * @return string the HTML to output.
3085      */
3086     public function box_end() {
3087         return $this->opencontainers->pop('box');
3088     }
3090     /**
3091      * Outputs a container.
3092      *
3093      * @param string $contents The contents of the box
3094      * @param string $classes A space-separated list of CSS classes
3095      * @param string $id An optional ID
3096      * @return string the HTML to output.
3097      */
3098     public function container($contents, $classes = null, $id = null) {
3099         return $this->container_start($classes, $id) . $contents . $this->container_end();
3100     }
3102     /**
3103      * Outputs the opening section of a container.
3104      *
3105      * @param string $classes A space-separated list of CSS classes
3106      * @param string $id An optional ID
3107      * @return string the HTML to output.
3108      */
3109     public function container_start($classes = null, $id = null) {
3110         $this->opencontainers->push('container', html_writer::end_tag('div'));
3111         return html_writer::start_tag('div', array('id' => $id,
3112                 'class' => renderer_base::prepare_classes($classes)));
3113     }
3115     /**
3116      * Outputs the closing section of a container.
3117      *
3118      * @return string the HTML to output.
3119      */
3120     public function container_end() {
3121         return $this->opencontainers->pop('container');
3122     }
3124     /**
3125      * Make nested HTML lists out of the items
3126      *
3127      * The resulting list will look something like this:
3128      *
3129      * <pre>
3130      * <<ul>>
3131      * <<li>><div class='tree_item parent'>(item contents)</div>
3132      *      <<ul>
3133      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
3134      *      <</ul>>
3135      * <</li>>
3136      * <</ul>>
3137      * </pre>
3138      *
3139      * @param array $items
3140      * @param array $attrs html attributes passed to the top ofs the list
3141      * @return string HTML
3142      */
3143     public function tree_block_contents($items, $attrs = array()) {
3144         // exit if empty, we don't want an empty ul element
3145         if (empty($items)) {
3146             return '';
3147         }
3148         // array of nested li elements
3149         $lis = array();
3150         foreach ($items as $item) {
3151             // this applies to the li item which contains all child lists too
3152             $content = $item->content($this);
3153             $liclasses = array($item->get_css_type());
3154             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
3155                 $liclasses[] = 'collapsed';
3156             }
3157             if ($item->isactive === true) {
3158                 $liclasses[] = 'current_branch';
3159             }
3160             $liattr = array('class'=>join(' ',$liclasses));
3161             // class attribute on the div item which only contains the item content
3162             $divclasses = array('tree_item');
3163             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
3164                 $divclasses[] = 'branch';
3165             } else {
3166                 $divclasses[] = 'leaf';
3167             }
3168             if (!empty($item->classes) && count($item->classes)>0) {
3169                 $divclasses[] = join(' ', $item->classes);
3170             }
3171             $divattr = array('class'=>join(' ', $divclasses));
3172             if (!empty($item->id)) {
3173                 $divattr['id'] = $item->id;
3174             }
3175             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
3176             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
3177                 $content = html_writer::empty_tag('hr') . $content;
3178             }
3179             $content = html_writer::tag('li', $content, $liattr);
3180             $lis[] = $content;
3181         }
3182         return html_writer::tag('ul', implode("\n", $lis), $attrs);
3183     }
3185     /**
3186      * Returns a search box.
3187      *
3188      * @param  string $id     The search box wrapper div id, defaults to an autogenerated one.
3189      * @return string         HTML with the search form hidden by default.
3190      */
3191     public function search_box($id = false) {
3192         global $CFG;
3194         // Accessing $CFG directly as using \core_search::is_global_search_enabled would
3195         // result in an extra included file for each site, even the ones where global search
3196         // is disabled.
3197         if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
3198             return '';
3199         }
3201         if ($id == false) {
3202             $id = uniqid();
3203         } else {
3204             // Needs to be cleaned, we use it for the input id.
3205             $id = clean_param($id, PARAM_ALPHANUMEXT);
3206         }
3208         // JS to animate the form.
3209         $this->page->requires->js_call_amd('core/search-input', 'init', array($id));
3211         $searchicon = html_writer::tag('div', $this->pix_icon('a/search', get_string('search', 'search'), 'moodle'),
3212             array('role' => 'button', 'tabindex' => 0));
3213         $formattrs = array('class' => 'search-input-form', 'action' => $CFG->wwwroot . '/search/index.php');
3214         $inputattrs = array('type' => 'text', 'name' => 'q', 'placeholder' => get_string('search', 'search'),
3215             'size' => 13, 'tabindex' => -1, 'id' => 'id_q_' . $id, 'class' => 'form-control');
3217         $contents = html_writer::tag('label', get_string('enteryoursearchquery', 'search'),
3218             array('for' => 'id_q_' . $id, 'class' => 'accesshide')) . html_writer::empty_tag('input', $inputattrs);
3219         if ($this->page->context && $this->page->context->contextlevel !== CONTEXT_SYSTEM) {
3220             $contents .= html_writer::empty_tag('input', ['type' => 'hidden',
3221                     'name' => 'context', 'value' => $this->page->context->id]);
3222         }
3223         $searchinput = html_writer::tag('form', $contents, $formattrs);
3225         return html_writer::tag('div', $searchicon . $searchinput, array('class' => 'search-input-wrapper nav-link', 'id' => $id));
3226     }
3228     /**
3229      * Allow plugins to provide some content to be rendered in the navbar.
3230      * The plugin must define a PLUGIN_render_navbar_output function that returns
3231      * the HTML they wish to add to the navbar.
3232      *
3233      * @return string HTML for the navbar
3234      */
3235     public function navbar_plugin_output() {
3236         $output = '';
3238         // Give subsystems an opportunity to inject extra html content. The callback
3239         // must always return a string containing valid html.
3240         foreach (\core_component::get_core_subsystems() as $name => $path) {
3241             if ($path) {
3242                 $output .= component_callback($name, 'render_navbar_output', [$this], '');
3243             }
3244         }
3246         if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
3247             foreach ($pluginsfunction as $plugintype => $plugins) {
3248                 foreach ($plugins as $pluginfunction) {
3249                     $output .= $pluginfunction($this);
3250                 }
3251             }
3252         }
3254         return $output;
3255     }
3257     /**
3258      * Construct a user menu, returning HTML that can be echoed out by a
3259      * layout file.
3260      *
3261      * @param stdClass $user A user object, usually $USER.
3262      * @param bool $withlinks true if a dropdown should be built.
3263      * @return string HTML fragment.
3264      */
3265     public function user_menu($user = null, $withlinks = null) {
3266         global $USER, $CFG;
3267         require_once($CFG->dirroot . '/user/lib.php');
3269         if (is_null($user)) {
3270             $user = $USER;
3271         }
3273         // Note: this behaviour is intended to match that of core_renderer::login_info,
3274         // but should not be considered to be good practice; layout options are
3275         // intended to be theme-specific. Please don't copy this snippet anywhere else.
3276         if (is_null($withlinks)) {
3277             $withlinks = empty($this->page->layout_options['nologinlinks']);
3278         }
3280         // Add a class for when $withlinks is false.
3281         $usermenuclasses = 'usermenu';
3282         if (!$withlinks) {
3283             $usermenuclasses .= ' withoutlinks';
3284         }
3286         $returnstr = "";
3288         // If during initial install, return the empty return string.
3289         if (during_initial_install()) {
3290             return $returnstr;
3291         }
3293         $loginpage = $this->is_login_page();
3294         $loginurl = get_login_url();
3295         // If not logged in, show the typical not-logged-in string.
3296         if (!isloggedin()) {
3297             $returnstr = get_string('loggedinnot', 'moodle');
3298             if (!$loginpage) {
3299                 $returnstr .= " (<a href=\"$loginurl\">" . get_string('login') . '</a>)';
3300             }
3301             return html_writer::div(
3302                 html_writer::span(
3303                     $returnstr,
3304                     'login'
3305                 ),
3306                 $usermenuclasses
3307             );
3309         }
3311         // If logged in as a guest user, show a string to that effect.
3312         if (isguestuser()) {
3313             $returnstr = get_string('loggedinasguest');
3314             if (!$loginpage && $withlinks) {
3315                 $returnstr .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
3316             }
3318             return html_writer::div(
3319                 html_writer::span(
3320                     $returnstr,
3321                     'login'
3322                 ),
3323                 $usermenuclasses
3324             );
3325         }
3327         // Get some navigation opts.
3328         $opts = user_get_user_navigation_info($user, $this->page);
3330         $avatarclasses = "avatars";
3331         $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
3332         $usertextcontents = $opts->metadata['userfullname'];
3334         // Other user.
3335         if (!empty($opts->metadata['asotheruser'])) {
3336             $avatarcontents .= html_writer::span(
3337                 $opts->metadata['realuseravatar'],
3338                 'avatar realuser'
3339             );
3340             $usertextcontents = $opts->metadata['realuserfullname'];
3341             $usertextcontents .= html_writer::tag(
3342                 'span',
3343                 get_string(
3344                     'loggedinas',
3345                     'moodle',
3346                     html_writer::span(
3347                         $opts->metadata['userfullname'],
3348                         'value'
3349                     )
3350                 ),
3351                 array('class' => 'meta viewingas')
3352             );
3353         }
3355         // Role.
3356         if (!empty($opts->metadata['asotherrole'])) {
3357             $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
3358             $usertextcontents .= html_writer::span(
3359                 $opts->metadata['rolename'],
3360                 'meta role role-' . $role
3361             );
3362         }
3364         // User login failures.
3365         if (!empty($opts->metadata['userloginfail'])) {
3366             $usertextcontents .= html_writer::span(
3367                 $opts->metadata['userloginfail'],
3368                 'meta loginfailures'
3369             );
3370         }
3372         // MNet.
3373         if (!empty($opts->metadata['asmnetuser'])) {
3374             $mnet = strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['mnetidprovidername'])));
3375             $usertextcontents .= html_writer::span(
3376                 $opts->metadata['mnetidprovidername'],
3377                 'meta mnet mnet-' . $mnet
3378             );
3379         }