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