'; - - $message = clean_text(''. - '
'. - ''. - get_string('moreinformation').'
'); - - print_simple_box($message, '', '', '', '', 'errorbox'); - - if ($showerrordebugwarning) { - debugging('error() is a deprecated function, please call print_error() instead of error()', DEBUG_DEVELOPER); - - } else { - if (debugging('', DEBUG_DEVELOPER)) { - if ($debuginfo) { - debugging($debuginfo, DEBUG_DEVELOPER, $backtrace); - } else { - notify('Stack trace:'.print_backtrace($backtrace, false, true), 'notifytiny'); - } - } - } - - if (!empty($link)) { - print_continue($link); - } - - print_footer(); - - for ($i=0;$i<512;$i++) { // Padding to help IE work with 404 - echo ' '; - } - exit(1); // general error code -} - -/** - * Internal function - do not use directly!! - * This function is used if fatal error occures before the themes are fully initialised (eg. in lib/setup.php) - * - * @uses $_SERVER - * @uses DEBUG_DEVELOPER - * @param string $errorcode - * @param string $module - * @param string $a - * @param string $link - * @param array $backtrace - * @param string $debuginfo - * @return void Script dies does not return - */ -function _print_early_error($errorcode, $module, $a, $backtrace=null, $debuginfo=null) { - $message = get_string($errorcode, $module, $a); - if ($module === 'error' and strpos($message, '[[') === 0) { - //search in moodle file if error specified - needed for backwards compatibility - $message = get_string($errorcode, 'moodle', $a); - } - $message = clean_text($message); - - // In the name of protocol correctness, monitoring and performance - // profiling, set the appropriate error headers for machine comsumption - if (isset($_SERVER['SERVER_PROTOCOL'])) { - // Avoid it with cron.php. Note that we assume it's HTTP/1.x - @header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable'); - } - - // better disable any caching - @header('Content-Type: text/html; charset=utf-8'); - @header('Cache-Control: no-store, no-cache, must-revalidate'); - @header('Cache-Control: post-check=0, pre-check=0', false); - @header('Pragma: no-cache'); - @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT'); - @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT'); - - echo ' - - - -
-'.$message.'
-
';
- if (debugging('', DEBUG_DEVELOPER)) {
- if ($debuginfo) {
- debugging($debuginfo, DEBUG_DEVELOPER, $backtrace);
- } else if ($backtrace) {
- notify('Stack trace:'.print_backtrace($backtrace, false, true), 'notifytiny');
- }
- }
-
- echo '';
- exit(1); // general error code
-}
-
-/**
* Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
* Default errorcode is 1.
*
@@ -6287,43 +5794,6 @@
}
/**
- * Print a bold message in an optional color.
- *
- * @global object
- * @uses CLI_SCRIPT
- * @param string $message The message to print out
- * @param string $style Optional style to display message text in
- * @param string $align Alignment option
- * @param bool $return whether to return an output string or echo now
- * @return string|bool Depending on $result
- */
-function notify($message, $style='notifyproblem', $align='center', $return=false) {
- global $DB;
-
- if ($style == 'green') {
- $style = 'notifysuccess'; // backward compatible with old color system
- }
-
- $message = clean_text($message);
- if (!CLI_SCRIPT) {
- $output = ''. $message .'
'."\n";
- } else {
- if ($style === 'notifysuccess') {
- $output = '++'.$message.'++'."\n";
- } else {
- $output = '!!'.$message.'!!'."\n";
- }
- }
-
- if ($return) {
- return $output;
- }
-
- echo $output;
-}
-
-
-/**
* Given an email address, this function will return an obfuscated version of it
*
* @param string $email The email address to obfuscate
@@ -6918,34 +6388,6 @@
return $subtree;
}
-
-/**
- * Returns a string containing a link to the user documentation for the current
- * page. Also contains an icon by default. Shown to teachers and admin only.
- *
- * @global object
- * @global object
- * @param string $text The text to be displayed for the link
- * @param string $iconpath The path to the icon to be displayed
- * @return string The link to user documentation for this current page
- */
-function page_doc_link($text='', $iconpath='') {
- global $CFG, $PAGE;
-
- if (empty($CFG->docroot) || during_initial_install()) {
- return '';
- }
- if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
- return '';
- }
-
- $path = $PAGE->docspath;
- if (!$path) {
- return '';
- }
- return doc_link($path, $text, $iconpath);
-}
-
/**
* Returns the Moodle Docs URL in the users language
*
@@ -7021,85 +6463,32 @@
* @param array $backtrace use different backtrace
* @return bool
*/
-function debugging($message='', $level=DEBUG_NORMAL, $backtrace=null) {
-
+function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
global $CFG;
- if (empty($CFG->debug)) {
+ if (empty($CFG->debug) || $CFG->debug < $level) {
return false;
}
- if ($CFG->debug >= $level) {
- if ($message) {
- if (!$backtrace) {
- $backtrace = debug_backtrace();
- }
- $from = print_backtrace($backtrace, CLI_SCRIPT, true);
- if (!isset($CFG->debugdisplay)) {
- $CFG->debugdisplay = ini_get_bool('display_errors');
- }
- if ($CFG->debugdisplay) {
- if (!defined('DEBUGGING_PRINTED')) {
- define('DEBUGGING_PRINTED', 1); // indicates we have printed something
- }
- notify($message . $from, 'notifytiny');
- } else {
- trigger_error($message . $from, E_USER_NOTICE);
- }
- }
- return true;
+ if (!isset($CFG->debugdisplay)) {
+ $CFG->debugdisplay = ini_get_bool('display_errors');
}
- return false;
-}
-/**
- * Prints formatted backtrace
- *
- * @global object
- * @param array $callers backtrace array
- * @param bool $return return as string or print
- * @return string|bool Depending on $return
- */
-function print_backtrace($callers, $plaintext=false, $return=false) {
- // do not use $CFG->dirroot because it might not be available in desctructors
- $dirroot = dirname(dirname(__FILE__));
-
- if (empty($callers)) {
- if ($return) {
- return '';
- } else {
- return;
+ if ($message) {
+ if (!$backtrace) {
+ $backtrace = debug_backtrace();
}
- }
-
- $from = $plaintext ? '' : '- ';
- foreach ($callers as $caller) {
- if (!isset($caller['line'])) {
- $caller['line'] = '?'; // probably call_user_func()
- }
- if (!isset($caller['file'])) {
- $caller['file'] = 'unknownfile'; // probably call_user_func()
- }
- $from .= $plaintext ? '* ' : '
- '; - $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']); - if (isset($caller['function'])) { - $from .= ': call to '; - if (isset($caller['class'])) { - $from .= $caller['class'] . $caller['type']; - } - $from .= $caller['function'] . '()'; - } else if (isset($caller['exception'])) { - $from .= ': '.$caller['exception'].' thrown'; + $from = format_backtrace($backtrace, CLI_SCRIPT); + if ($CFG->debugdisplay) { + if (!defined('DEBUGGING_PRINTED')) { + define('DEBUGGING_PRINTED', 1); // indicates we have printed something + } + notify($message . $from, 'notifytiny'); + } else { + trigger_error($message . $from, E_USER_NOTICE); } - $from .= $plaintext ? "\n" : ' '; - } - $from .= $plaintext ? '' : '
+' . $message . '
+
';
+ if (debugging('', DEBUG_DEVELOPER)) {
+ if (!empty($debuginfo)) {
+ echo '' . $debuginfo . '
';
+ }
+ if (!empty($backtrace)) {
+ echo 'Stack trace: ' . format_backtrace($backtrace, false) . '
';
+ }
+ }
+
+ echo '';
+}
+
+/**
+ * Formats a backtrace ready for output.
+ *
+ * @param array $callers backtrace array, as returned by debug_backtrace().
+ * @param boolean $plaintext if false, generates HTML, if true generates plain text.
+ * @return string formatted backtrace, ready for output.
+ */
+function format_backtrace($callers, $plaintext = false) {
+ // do not use $CFG->dirroot because it might not be available in desctructors
+ $dirroot = dirname(dirname(__FILE__));
+
+ if (empty($callers)) {
+ return '';
+ }
+
+ $from = $plaintext ? '' : '- ';
+ foreach ($callers as $caller) {
+ if (!isset($caller['line'])) {
+ $caller['line'] = '?'; // probably call_user_func()
+ }
+ if (!isset($caller['file'])) {
+ $caller['file'] = 'unknownfile'; // probably call_user_func()
+ }
+ $from .= $plaintext ? '* ' : '
- '; + $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']); + if (isset($caller['function'])) { + $from .= ': call to '; + if (isset($caller['class'])) { + $from .= $caller['class'] . $caller['type']; + } + $from .= $caller['function'] . '()'; + } else if (isset($caller['exception'])) { + $from .= ': '.$caller['exception'].' thrown'; + } + $from .= $plaintext ? "\n" : ' '; + } + $from .= $plaintext ? '' : '
' .
+ '' .
+ '
';
+
+ } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
+ // Special case for during install/upgrade.
+ return ''.
+ '' .
+ '
';
+
+ } else if ($PAGE->course->id == $SITE->id) {
+ $homelink = '';
+
+ } else {
+ return '';
+ }
+ }
+
+ public function header($page = null, $navigation = '', $button=' ', $menu='') {
+ global $USER, $CFG, $THEME;
+
+ if (is_null($page)) {
+ global $PAGE;
+ $page = $PAGE;
+ }
+
+ if (gettype($navigation) == 'string' && strlen($navigation) != 0 && $navigation != 'home') {
+ debugging("print_header() was sent a string as 3rd ($navigation) parameter. "
+ . "This is deprecated in favour of an array built by build_navigation(). Please upgrade your code.", DEBUG_DEVELOPER);
+ }
+
+ $page->set_state(moodle_page::STATE_PRINTING_HEADER);
+
+ $doctype = '';
+ $htmlattributes = get_html_lang(true);
+ $htmlattributes .= ' xmlns="http://www.w3.org/1999/xhtml"'; // See debug_header
+
+ // Add any stylesheets required using the horrible legacy mechanism. TODO kill this.
+ foreach ($CFG->stylesheets as $stylesheet) {
+ $page->requires->css($stylesheet, true);
+ }
+
+ // Set up some navigation variables
+ if (is_newnav($navigation) || $navigation != 'home') {
+ $home = false;
+ } else {
+ $home = true;
+ $navigation = '';
+ }
+
+ $navmenulist = isset($THEME->navmenulist) ? $THEME->navmenulist : '';
+
+ if ($button == '') {
+ $button = ' ';
+ }
+
+ // TODO
+ if (!empty($CFG->maintenance_enabled)) {
+ $button = ''.get_string('maintenancemode', 'admin').' '.$button;
+ if(!empty($title)) {
+ $title .= ' - ';
+ }
+ $title .= get_string('maintenancemode', 'admin');
+ }
+
+ if (!$menu and $navigation) {
+ $menu = user_login_string($page->course);
+ }
+
+ @header('Content-Type: text/html; charset=utf-8');
+ @header('Content-Script-Type: text/javascript');
+ @header('Content-Style-Type: text/css');
+
+ if ($page->cacheable) {
+ // Allow caching on "back" (but not on normal clicks)
+ @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
+ @header('Pragma: no-cache');
+ @header('Expires: ');
+ } else {
+ // Do everything we can to always prevent clients and proxies caching
+ @header('Cache-Control: no-store, no-cache, must-revalidate');
+ @header('Cache-Control: post-check=0, pre-check=0', false);
+ @header('Pragma: no-cache');
+ @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
+ @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+ }
+ @header('Accept-Ranges: none');
+
+ message_popup_window();
+
+ $bodyattributes = ''; // $bodytags; // TODO
+
+ if (!isset($loggedinas)) {
+ $loggedinas = user_login_string($page->course, $USER);
+ }
+
+ if ($loggedinas == $menu) {
+ $menu = '';
+ }
+
+ // Find the appropriate page template, based on $page->generaltype.
+ $templatefile = $THEME->dir . '/layout.html';
+ if ($page->generaltype != 'normal') {
+ $specifictemplatefile = $THEME->dir . '/layout-' . $page->generaltype . '.html';
+ if (is_readable($specifictemplatefile)) {
+ $templatefile = $specifictemplatefile;
+ }
+ }
+
+ if (!is_readable($templatefile)) {
+ return $this->handle_legacy_theme();
+ }
+
+ // Render the template.
+ $template = $this->render_page_template($templatefile, $page, $loggedinas, $menu,
+ $button, $doctype, $htmlattributes, $bodyattributes, $navigation);
+
+ // Slice the template output into header and footer.
+ $cutpos = strpos($template, '[MAIN CONTENT GOES HERE]');
+ if ($cutpos === false) {
+ throw new coding_exception('Layout template ' . $templatefile . ' does not contain the string "[MAIN CONTENT GOES HERE]".');
+ }
+ $header = substr($template, 0, $cutpos);
+ $footer = substr($template, $cutpos + strlen('[MAIN CONTENT GOES HERE]'));
+
+ $header = force_strict_header($header); // TODO
+
+ $this->containerstack->push('header/footer', $footer);
+ $page->set_state(moodle_page::STATE_IN_BODY);
+ return $header . $this->skip_link_target();
+ }
+
+ protected function render_page_template($templatefile, $page, $loggedinas, $menu,
+ $button, $doctype, $htmlattributes, $bodyattributes, $navigation) {
+ global $USER, $CFG, $THEME;
+ // Set some pretend globals from the properties of this class.
+ $OUTPUT = $this;
+ $PAGE = $page;
+ $COURSE = $page->course;
+
+ ob_start();
+ include($templatefile);
+ $template = ob_get_contents();
+ ob_end_clean();
+ return $template;
+ }
+
+ public function footer($page = null) {
+ if (is_null($page)) {
+ global $PAGE;
+ $page = $PAGE;
+ }
+
+ $output = '';
+ if ($this->containerstack->nesting_depth() != 1) {
+ debugging('Some HTML tags were opened in the body of the page but not closed.', DEBUG_DEVELOPER);
+ $output .= $this->containerstack->pop_all_but_last();
+ }
+
+ $footer = $this->containerstack->pop('header/footer');
+
+ // Provide some performance info if required
+ $performanceinfo = '';
+ if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
+ $perf = get_performance_info();
+ if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
+ error_log("PERF: " . $perf['txt']);
+ }
+ if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
+ $performanceinfo = $perf['html'];
+ }
+ }
+ $footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
+
+ $footer = str_replace(self::END_HTML_TOKEN, $page->requires->get_end_code(), $footer);
+
+ $page->set_state(moodle_page::STATE_DONE);
+
+ return $output . $footer;
+ }
+
public function link_to_popup_window() {
}
@@ -756,6 +1043,138 @@
}
return $this->output_tag('span', array('class' => 'error'), $message);
}
+
+ /**
+ * Do not call this function directly.
+ *
+ * To terminate the current script with a fatal error, call the {@link print_error}
+ * function, or throw an exception. Doing either of those things will then call this
+ * funciton to display the error, before terminating the exection.
+ *
+ * @param string $message
+ * @param string $moreinfourl
+ * @param string $link
+ * @param array $backtrace
+ * @param string $debuginfo
+ * @param bool $showerrordebugwarning
+ * @return string the HTML to output.
+ */
+ public function fatal_error($message, $moreinfourl, $link, $backtrace,
+ $debuginfo = null, $showerrordebugwarning = false) {
+
+ $output = '';
+
+ if ($this->containerstack->nesting_depth() == 0) {
+ // Header not yet printed
+ @header('HTTP/1.0 404 Not Found');
+ print_header(get_string('error'));
+ } else {
+ $output .= $this->containerstack->pop_all_but_last();
+ }
+
+ $message = ''.
+ '';
+ $output .= $this->box($message, 'errorbox');
+
+ if (debugging('', DEBUG_DEVELOPER)) {
+ if ($showerrordebugwarning) {
+ $output .= $this->notification('error() is a deprecated function. ' .
+ 'Please call print_error() instead of error()', 'notifytiny');
+ }
+ if (!empty($debuginfo)) {
+ $output .= $this->notification($debuginfo, 'notifytiny');
+ }
+ if (!empty($backtrace)) {
+ $output .= $this->notification('Stack trace: ' .
+ format_backtrace($backtrace, true), 'notifytiny');
+ }
+ }
+
+ if (!empty($link)) {
+ $output .= $this->continue_button($link);
+ }
+
+ print_footer();
+
+ // Padding to encourage IE to display our error page, rather than its own.
+ $output .= str_repeat(' ', 512);
+
+ return $output;
+ }
+
+ /**
+ * Output a notification (that is, a status message about something that has
+ * just happened).
+ *
+ * @param string $message the message to print out
+ * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
+ * @return string the HTML to output.
+ */
+ public function notification($message, $classes = 'notifyproblem') {
+ return $this->output_tag('div', array('class' =>
+ moodle_renderer_base::prepare_classes($classes)), clean_text($message));
+ }
+
+ /**
+ * Print a continue button that goes to a particular URL.
+ *
+ * @param string|moodle_url $link The url the button goes to.
+ * @return string the HTML to output.
+ */
+ public function continue_button($link) {
+ if (!is_a($link, 'moodle_url')) {
+ $link = new moodle_url($link);
+ }
+ return $this->output_tag('div', array('class' => 'continuebutton'),
+ print_single_button($link->out(true), $link->params(), get_string('continue'), 'get', '', true));
+ }
+
+ /**
+ * Output the place a skip link goes to.
+ * @param $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
+ * @return string the HTML to output.
+ */
+ public function skip_link_target($id = 'maincontent') {
+ return $this->output_tag('span', array('id' => $id), '');
+ }
+
+ public function heading($text, $level, $classes = 'main', $id = '') {
+ $level = (integer) $level;
+ if ($level < 1 or $level > 6) {
+ throw new coding_exception('Heading level must be an integer between 1 and 6.');
+ }
+ return $this->output_tag('h' . $level,
+ array('id' => $id, 'class' => moodle_renderer_base::prepare_classes($classes)), $text);
+ }
+
+ public function box($contents, $classes = 'generalbox', $id = '') {
+ return $this->box_start($classes, $id) . $contents . $this->box_end();
+ }
+
+ public function box_start($classes = 'generalbox', $id = '') {
+ $this->containerstack->push('box', $this->output_end_tag('div'));
+ return $this->output_start_tag('div', array('id' => $id,
+ 'class' => 'box ' . moodle_renderer_base::prepare_classes($classes)));
+ }
+
+ public function box_end() {
+ return $this->containerstack->pop('box');
+ }
+
+ public function container($contents, $classes = '', $id = '') {
+ return $this->container_start($classes, $id) . $contents . $this->container_end();
+ }
+
+ public function container_start($classes = '', $id = '') {
+ $this->containerstack->push('container', $this->output_end_tag('div'));
+ return $this->output_start_tag('div', array('id' => $id,
+ 'class' => moodle_renderer_base::prepare_classes($classes)));
+ }
+
+ public function container_end() {
+ return $this->containerstack->pop('container');
+ }
}
@@ -838,7 +1257,7 @@
/**
* This class hold all the information required to describe a