'."\n"; + $output .= '

'; + $output .= "\n"; + $output .= '

'; + $output .= (!empty($clearfix)) ? '

' : '

'; + + return $output; +} + + +/** + * Internal function - do not use directly! + * Ending part of the surrounding divs for custom corners + * @param string $idbase + * @return string + */ +function _print_custom_corners_end($idbase) { +/// Analise if we want ids for the custom corner elements + $idbb = ''; + + if ($idbase) { + $idbb = 'id="' . $idbase . '-bb" '; + } + +/// Output begins + $output = '

'; + $output .= "\n"; + $output .= '

'."\n"; + $output .= '

'; + + return $output; +} + + +/** + * Print a self contained form with a single submit button. + * + * @param string $link used as the action attribute on the form, so the URL that will be hit if the button is clicked. + * @param array $options these become hidden form fields, so these options get passed to the script at $link. + * @param string $label the caption that appears on the button. + * @param string $method HTTP method used on the request of the button is clicked. 'get' or 'post'. + * @param string $target no longer used. + * @param boolean $return if false, output the form directly, otherwise return the HTML as a string. + * @param string $tooltip a tooltip to add to the button as a title attribute. + * @param boolean $disabled if true, the button will be disabled. + * @param string $jsconfirmmessage if not empty then display a confirm dialogue with this string as the question. + * @return string / nothing depending on the $return paramter. + */ +function print_single_button($link, $options, $label='OK', $method='get', $target='_self', $return=false, $tooltip='', $disabled = false, $jsconfirmmessage='') { + $output = ''; + $link = str_replace('"', '"', $link); //basic XSS protection + $output .= '

'; + // taking target out, will need to add later target="'.$target.'" + $output .= '

"; + + if ($return) { + return $output; + } else { + echo $output; + } +} + + +/** + * Print a spacer image with the option of including a line break. + * + * @param int $height ? + * @param int $width ? + * @param boolean $br ? + * @todo Finish documenting this function + */ +function print_spacer($height=1, $width=1, $br=true, $return=false) { + global $CFG; + $output = ''; + + $output .= '

'; + if ($br) { + $output .= '
'."\n"; + } + + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Given the path to a picture file in a course, or a URL, + * this function includes the picture in the page. + * + * @param string $path ? + * @param int $courseid ? + * @param int $height ? + * @param int $width ? + * @param string $link ? + * @todo Finish documenting this function + */ +function print_file_picture($path, $courseid=0, $height='', $width='', $link='', $return=false) { + global $CFG; + $output = ''; + + if ($height) { + $height = 'height="'. $height .'"'; + } + if ($width) { + $width = 'width="'. $width .'"'; + } + if ($link) { + $output .= ''; + } + if (substr(strtolower($path), 0, 7) == 'http://') { + $output .= '

'; + + } else if ($courseid) { + $output .= '

firstname) && isset($user->lastname)))) ) { + $needrec = true; + $user = $user->id; + } + } else { + if ($alttext) { + // we need firstname, lastname, imagealt, can't escape... + $needrec = true; + } else { + $userobj = new StdClass; // fake it to save DB traffic + $userobj->id = $user; + $userobj->picture = $picture; + $user = clone($userobj); + unset($userobj); + } + } + if ($needrec) { + $user = get_record('user','id',$user, '', '', '', '', 'id,firstname,lastname,imagealt'); + } + + if ($link) { + $url = '/user/view.php?id='. $user->id .'&course='. $courseid ; + if ($target) { + $target='onclick="return openpopup(\''.$url.'\');"'; + } + $output = ''; + } else { + $output = ''; + } + if (empty($size)) { + $file = 'f2'; + $size = 35; + } else if ($size === true or $size == 1) { + $file = 'f1'; + $size = 100; + } else if ($size >= 50) { + $file = 'f1'; + } else { + $file = 'f2'; + } + $class = "userpicture"; + + if (is_null($picture)) { + $picture = $user->picture; + } + + if ($picture) { // Print custom user picture + require_once($CFG->libdir.'/filelib.php'); + $src = get_file_url($user->id.'/'.$file.'.jpg', null, 'user'); + } else { // Print default user pictures (use theme version if available) + $class .= " defaultuserpic"; + $src = "$CFG->pixpath/u/$file.png"; + } + $imagealt = ''; + if ($alttext) { + if (!empty($user->imagealt)) { + $imagealt = $user->imagealt; + } else { + $imagealt = get_string('pictureof','',fullname($user)); + } + } + + $output .= " $\"".s($imagealt).'"$ '; + if ($link) { + $output .= ''; + } + + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Prints a summary of a user in a nice little box. + * + * @uses $CFG + * @uses $USER + * @param user $user A {@link $USER} object representing a user + * @param course $course A {@link $COURSE} object representing a course + */ +function print_user($user, $course, $messageselect=false, $return=false) { + + global $CFG, $USER; + + $output = ''; + + static $string; + static $datestring; + static $countries; + + $context = get_context_instance(CONTEXT_COURSE, $course->id); + if (isset($user->context->id)) { + $usercontext = get_context_instance_by_id($user->context->id); + } + + if (empty($string)) { // Cache all the strings for the rest of the page + + $string->email = get_string('email'); + $string->city = get_string('city'); + $string->lastaccess = get_string('lastaccess'); + $string->activity = get_string('activity'); + $string->unenrol = get_string('unenrol'); + $string->loginas = get_string('loginas'); + $string->fullprofile = get_string('fullprofile'); + $string->role = get_string('role'); + $string->name = get_string('name'); + $string->never = get_string('never'); + + $datestring->day = get_string('day'); + $datestring->days = get_string('days'); + $datestring->hour = get_string('hour'); + $datestring->hours = get_string('hours'); + $datestring->min = get_string('min'); + $datestring->mins = get_string('mins'); + $datestring->sec = get_string('sec'); + $datestring->secs = get_string('secs'); + $datestring->year = get_string('year'); + $datestring->years = get_string('years'); + + $countries = get_list_of_countries(); + } + +/// Get the hidden field list + if (has_capability('moodle/course:viewhiddenuserfields', $context)) { + $hiddenfields = array(); + } else { + $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields)); + } + + $output .= ''; + $output .= ''; + $output .= ''; + $output .= '

'; + $output .= print_user_picture($user, $course->id, $user->picture, true, true); + $output .= '

'; + $output .= '

'.fullname($user, has_capability('moodle/site:viewfullnames', $context)).'

'; + $output .= '

'; + if (!empty($user->role) and ($user->role <> $course->teacher)) { + $output .= $string->role .': '. $user->role .'
'; + } + if ($user->maildisplay == 1 or ($user->maildisplay == 2 and ($course->id != SITEID) and !isguest()) or +has_capability('moodle/course:viewhiddenuserfields', $context)) { + $output .= $string->email .': '. $user->email .'
'; + } + if (($user->city or $user->country) and (!isset($hiddenfields['city']) or !isset($hiddenfields['country']))) { + $output .= $string->city .': '; + if ($user->city && !isset($hiddenfields['city'])) { + $output .= $user->city; + } + if (!empty($countries[$user->country]) && !isset($hiddenfields['country'])) { + if ($user->city && !isset($hiddenfields['city'])) { + $output .= ', '; + } + $output .= $countries[$user->country]; + } + $output .= '
'; + } + + if (!isset($hiddenfields['lastaccess'])) { + if ($user->lastaccess) { + $output .= $string->lastaccess .': '. userdate($user->lastaccess); + $output .= ' ('. format_time(time() - $user->lastaccess, $datestring) .')'; + } else { + $output .= $string->lastaccess .': '. $string->never; + } + } + $output .= '

'; + //link to blogs + if ($CFG->bloglevel > 0) { + $output .= ''.get_string('blogs','blog').'
'; + } + //link to notes + if (has_capability('moodle/notes:manage', $context) || has_capability('moodle/notes:view', $context)) { + $output .= ''.get_string('notes','notes').'
'; + } + + if (has_capability('moodle/user:viewuseractivitiesreport', $context) || (isset($usercontext) && has_capability('moodle/user:viewuseractivitiesreport', $usercontext))) { + $timemidnight = usergetmidnight(time()); + $output .= ''. $string->activity .'
'; + } + if (has_capability('moodle/role:assign', $context) and get_user_roles($context, $user->id, false)) { // I can unassing and user has some role + $output .= ''. $string->unenrol .'
'; + } + if ($USER->id != $user->id && empty($USER->realuser) && has_capability('moodle/user:loginas', $context) && + ! has_capability('moodle/site:doanything', $context, $user->id, false)) { + $output .= ''. $string->loginas .'
'; + } + $output .= ''. $string->fullprofile .'...'; + + if (!empty($messageselect)) { + $output .= '
'; + } + + $output .= '

'; + + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Print a specified group's avatar. + * + * @param group $group A single {@link group} object OR array of groups. + * @param int $courseid The course ID. + * @param boolean $large Default small picture, or large. + * @param boolean $return If false print picture, otherwise return the output as string + * @param boolean $link Enclose image in a link to view specified course? + * @return string + * @todo Finish documenting this function + */ +function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) { + global $CFG; + + if (is_array($group)) { + $output = ''; + foreach($group as $g) { + $output .= print_group_picture($g, $courseid, $large, true, $link); + } + if ($return) { + return $output; + } else { + echo $output; + return; + } + } + + $context = get_context_instance(CONTEXT_COURSE, $courseid); + + if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) { + return ''; + } + + if ($link or has_capability('moodle/site:accessallgroups', $context)) { + $output = ''; + } else { + $output = ''; + } + if ($large) { + $file = 'f1'; + } else { + $file = 'f2'; + } + if ($group->picture) { // Print custom group picture + require_once($CFG->libdir.'/filelib.php'); + $grouppictureurl = get_file_url($group->id.'/'.$file.'.jpg', null, 'usergroup'); + $output .= ' '.s(get_string('group').' '.$group->name).'

'.s(get_string('group').' '.$group->name).'

'; + } + if ($link or has_capability('moodle/site:accessallgroups', $context)) { + $output .= ''; + } + + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Print a png image. + * + * @param string $url ? + * @param int $sizex ? + * @param int $sizey ? + * @param boolean $return ? + * @param string $parameters ? + * @todo Finish documenting this function + */ +function print_png($url, $sizex, $sizey, $return, $parameters='alt=""') { + global $CFG; + static $recentIE; + + if (!isset($recentIE)) { + $recentIE = check_browser_version('MSIE', '5.0'); + } + + if ($recentIE) { // work around the HORRIBLE bug IE has with alpha transparencies + $output .= '

'; + } else { + $output .= '

$table->data[] - An array of arrays containing the data. + *

$table->width - A percentage of the page + *

$table->tablealign - Align the whole table + *

$table->cellpadding - Padding on each cell + *

$table->cellspacing - Spacing between cells + *

$table->class - class attribute to put on the table + *

$table->id - id attribute to put on the table. + *

$table->rowclass[] - classes to add to particular rows. + *

$table->summary - Description of the contents for screen readers. + * + * @param bool $return whether to return an output string or echo now + * @return boolean or $string + * @todo Finish documenting this function + */ +function print_table($table, $return=false) { + $output = ''; + + if (isset($table->align)) { + foreach ($table->align as $key => $aa) { + if ($aa) { + $align[$key] = ' text-align:'. fix_align_rtl($aa) .';'; // Fix for RTL languages + } else { + $align[$key] = ''; + } + } + } + if (isset($table->size)) { + foreach ($table->size as $key => $ss) { + if ($ss) { + $size[$key] = ' width:'. $ss .';'; + } else { + $size[$key] = ''; + } + } + } + if (isset($table->wrap)) { + foreach ($table->wrap as $key => $ww) { + if ($ww) { + $wrap[$key] = ' white-space:nowrap;'; + } else { + $wrap[$key] = ''; + } + } + } + + if (empty($table->width)) { + $table->width = '80%'; + } + + if (empty($table->tablealign)) { + $table->tablealign = 'center'; + } + + if (!isset($table->cellpadding)) { + $table->cellpadding = '5'; + } + + if (!isset($table->cellspacing)) { + $table->cellspacing = '1'; + } + + if (empty($table->class)) { + $table->class = 'generaltable'; + } + + $tableid = empty($table->id) ? '' : 'id="'.$table->id.'"'; + + $output .= 'summary)) { + $output .= " summary=\"$table->summary\""; + } + $output .= " cellpadding=\"$table->cellpadding\" cellspacing=\"$table->cellspacing\" class=\"$table->class boxalign$table->tablealign\" $tableid>\n"; + + $countcols = 0; + + if (!empty($table->head)) { + $countcols = count($table->head); + $output .= ''; + $keys=array_keys($table->head); + $lastkey = end($keys); + foreach ($table->head as $key => $heading) { + + if (!isset($size[$key])) { + $size[$key] = ''; + } + if (!isset($align[$key])) { + $align[$key] = ''; + } + if ($key == $lastkey) { + $extraclass = ' lastcol'; + } else { + $extraclass = ''; + } + + $output .= ''; + } + $output .= ''."\n"; + } + + if (!empty($table->data)) { + $oddeven = 1; + $keys=array_keys($table->data); + $lastrowkey = end($keys); + foreach ($table->data as $key => $row) { + $oddeven = $oddeven ? 0 : 1; + if (!isset($table->rowclass[$key])) { + $table->rowclass[$key] = ''; + } + if ($key == $lastrowkey) { + $table->rowclass[$key] .= ' lastrow'; + } + $output .= ''."\n"; + if ($row == 'hr' and $countcols) { + $output .= ''; + } else { /// it's a normal row of data + $keys2=array_keys($row); + $lastkey = end($keys2); + foreach ($row as $key => $item) { + if (!isset($size[$key])) { + $size[$key] = ''; + } + if (!isset($align[$key])) { + $align[$key] = ''; + } + if (!isset($wrap[$key])) { + $wrap[$key] = ''; + } + if ($key == $lastkey) { + $extraclass = ' lastcol'; + } else { + $extraclass = ''; + } + $output .= ''; + } + } + $output .= ''."\n"; + } + } + $output .= '

'. $heading .'
	'. $item .'

'."\n"; + + if ($return) { + return $output; + } + + echo $output; + return true; +} + +function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) { + static $strftimerecent = null; + $output = ''; + + if (is_null($viewfullnames)) { + $context = get_context_instance(CONTEXT_SYSTEM); + $viewfullnames = has_capability('moodle/site:viewfullnames', $context); + } + + if (is_null($strftimerecent)) { + $strftimerecent = get_string('strftimerecent'); + } + + $output .= '

'; + $output .= '

'.userdate($time, $strftimerecent).'

'; + $output .= '

'.fullname($user, $viewfullnames).'

'; + $output .= '

'.format_string($text,true).'

'; + + if ($return) { + return $output; + } else { + echo $output; + } +} + + +/** + * Prints a basic textarea field. + * + * @uses $CFG + * @param boolean $usehtmleditor ? + * @param int $rows ? + * @param int $cols ? + * @param null $width Legacy field no longer used! Set to zero to get control over mincols + * @param null $height Legacy field no longer used! Set to zero to get control over minrows + * @param string $name ? + * @param string $value ? + * @param int $courseid ? + * @todo Finish documenting this function + */ +function print_textarea($usehtmleditor, $rows, $cols, $width, $height, $name, $value='', $courseid=0, $return=false, $id='') { +/// $width and height are legacy fields and no longer used as pixels like they used to be. +/// However, you can set them to zero to override the mincols and minrows values below. + + global $CFG, $COURSE, $HTTPSPAGEREQUIRED; + static $scriptcount = 0; // For loading the htmlarea script only once. + + $mincols = 65; + $minrows = 10; + $str = ''; + + if ($id === '') { + $id = 'edit-'.$name; + } + + if ( empty($CFG->editorsrc) ) { // for backward compatibility. + if (empty($courseid)) { + $courseid = $COURSE->id; + } + + if ($usehtmleditor) { + if (!empty($courseid) and has_capability('moodle/course:managefiles', get_context_instance(CONTEXT_COURSE, $courseid))) { + $httpsrequired = empty($HTTPSPAGEREQUIRED) ? '' : '&httpsrequired=1'; + // needed for course file area browsing in image insert plugin + $str .= ($scriptcount < 1) ? ''."\n" : ''; + } else { + $httpsrequired = empty($HTTPSPAGEREQUIRED) ? '' : '?httpsrequired=1'; + $str .= ($scriptcount < 1) ? ''."\n" : ''; + + } + $str .= ($scriptcount < 1) ? ''."\n" : ''; + $scriptcount++; + + if ($height) { // Usually with legacy calls + if ($rows < $minrows) { + $rows = $minrows; + } + } + if ($width) { // Usually with legacy calls + if ($cols < $mincols) { + $cols = $mincols; + } + } + } + } + $str .= ''."\n"; + + if ($usehtmleditor) { + // Show shortcuts button if HTML editor is in use, but only if JavaScript is enabled (MDL-9556) + $str .= ''; + } + + if ($return) { + return $str; + } + echo $str; +} + +/** + * Sets up the HTML editor on textareas in the current page. + * If a field name is provided, then it will only be + * applied to that field - otherwise it will be used + * on every textarea in the page. + * + * In most cases no arguments need to be supplied + * + * @param string $name Form element to replace with HTMl editor by name + */ +function use_html_editor($name='', $editorhidebuttons='', $id='') { + global $THEME; + + $editor = 'editor_'.md5($name); //name might contain illegal characters + if ($id === '') { + $id = 'edit-'.$name; + } + echo "\n".''."\n"; +} + +function print_editor_config($editorhidebuttons='', $return=false) { + global $CFG; + + $str = "config.pageStyle = \"body {"; + + if (!(empty($CFG->editorbackgroundcolor))) { + $str .= " background-color: $CFG->editorbackgroundcolor;"; + } + + if (!(empty($CFG->editorfontfamily))) { + $str .= " font-family: $CFG->editorfontfamily;"; + } + + if (!(empty($CFG->editorfontsize))) { + $str .= " font-size: $CFG->editorfontsize;"; + } + + $str .= " }\";\n"; + $str .= "config.killWordOnPaste = "; + $str .= (empty($CFG->editorkillword)) ? "false":"true"; + $str .= ';'."\n"; + $str .= 'config.fontname = {'."\n"; + + $fontlist = isset($CFG->editorfontlist) ? explode(';', $CFG->editorfontlist) : array(); + $i = 1; // Counter is used to get rid of the last comma. + + foreach ($fontlist as $fontline) { + if (!empty($fontline)) { + if ($i > 1) { + $str .= ','."\n"; + } + list($fontkey, $fontvalue) = split(':', $fontline); + $str .= '"'. $fontkey ."\":\t'". $fontvalue ."'"; + + $i++; + } + } + $str .= '};'; + + if (!empty($editorhidebuttons)) { + $str .= "\nconfig.hideSomeButtons(\" ". $editorhidebuttons ." \");\n"; + } else if (!empty($CFG->editorhidebuttons)) { + $str .= "\nconfig.hideSomeButtons(\" ". $CFG->editorhidebuttons ." \");\n"; + } + + if (!empty($CFG->editorspelling) && !empty($CFG->aspellpath)) { + $str .= print_speller_code($CFG->htmleditor, true); + } + + if ($return) { + return $str; + } + echo $str; +} + +/** + * Returns a turn edit on/off button for course in a self contained form. + * Used to be an icon, but it's now a simple form button + * + * Note that the caller is responsible for capchecks. + * + * @uses $CFG + * @uses $USER + * @param int $courseid The course to update by id as found in 'course' table + * @return string + */ +function update_course_icon($courseid) { + global $CFG, $USER; + + if (!empty($USER->editing)) { + $string = get_string('turneditingoff'); + $edit = '0'; + } else { + $string = get_string('turneditingon'); + $edit = '1'; + } + + return ''; +} + +/** + * Returns a little popup menu for switching roles + * + * @uses $CFG + * @uses $USER + * @param int $courseid The course to update by id as found in 'course' table + * @return string + */ +function switchroles_form($courseid) { + + global $CFG, $USER; + + + if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) { + return ''; + } + + if (!empty($USER->access['rsw'][$context->path])){ // Just a button to return to normal + $options = array(); + $options['id'] = $courseid; + $options['sesskey'] = sesskey(); + $options['switchrole'] = 0; + + return print_single_button($CFG->wwwroot.'/course/view.php', $options, + get_string('switchrolereturn'), 'post', '_self', true); + } + + if (has_capability('moodle/role:switchroles', $context)) { + if (!$roles = get_assignable_roles_for_switchrole($context)) { + return ''; // Nothing to show! + } + // unset default user role - it would not work + unset($roles[$CFG->guestroleid]); + return popup_form($CFG->wwwroot.'/course/view.php?id='.$courseid.'&sesskey='.sesskey().'&switchrole=', + $roles, 'switchrole', '', get_string('switchroleto'), 'switchrole', get_string('switchroleto'), true); + } + + return ''; +} + + +/** + * Returns a turn edit on/off button for course in a self contained form. + * Used to be an icon, but it's now a simple form button + * + * @uses $CFG + * @uses $USER + * @param int $courseid The course to update by id as found in 'course' table + * @return string + */ +function update_mymoodle_icon() { + + global $CFG, $USER; + + if (!empty($USER->editing)) { + $string = get_string('updatemymoodleoff'); + $edit = '0'; + } else { + $string = get_string('updatemymoodleon'); + $edit = '1'; + } + + return ""; +} + +/** + * Returns a turn edit on/off button for tag in a self contained form. + * + * @uses $CFG + * @uses $USER + * @return string + */ +function update_tag_button($tagid) { + + global $CFG, $USER; + + if (!empty($USER->editing)) { + $string = get_string('turneditingoff'); + $edit = '0'; + } else { + $string = get_string('turneditingon'); + $edit = '1'; + } + + return ""; +} + +/** + * Prints the editing button on a module "view" page + * + * @uses $CFG + * @param type description + * @todo Finish documenting this function + */ +function update_module_button($moduleid, $courseid, $string) { + global $CFG, $USER; + + if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $moduleid))) { + $string = get_string('updatethis', '', $string); + + return ""; + } else { + return ''; + } +} + +/** + * Prints the editing button on a category page + * + * @uses $CFG + * @uses $USER + * @param int $categoryid ? + * @return string + * @todo Finish documenting this function + */ +function update_category_button($categoryid) { + global $CFG, $USER; + + if (has_capability('moodle/category:update', get_context_instance(CONTEXT_COURSECAT, $categoryid))) { + if (!empty($USER->categoryediting)) { + $string = get_string('turneditingoff'); + $edit = 'off'; + } else { + $string = get_string('turneditingon'); + $edit = 'on'; + } + + return ""; + } +} + +/** + * Prints the editing button on categories listing + * + * @uses $CFG + * @uses $USER + * @return string + */ +function update_categories_button() { + global $CFG, $USER; + + if (has_capability('moodle/category:update', get_context_instance(CONTEXT_SYSTEM))) { + if (!empty($USER->categoryediting)) { + $string = get_string('turneditingoff'); + $categoryedit = 'off'; + } else { + $string = get_string('turneditingon'); + $categoryedit = 'on'; + } + + return "'; + } +} + +/** + * Prints the editing button on search results listing + * For bulk move courses to another category + */ + +function update_categories_search_button($search,$page,$perpage) { + global $CFG, $USER; + + // not sure if this capability is the best here + if (has_capability('moodle/category:update', get_context_instance(CONTEXT_SYSTEM))) { + if (!empty($USER->categoryediting)) { + $string = get_string("turneditingoff"); + $edit = "off"; + $perpage = 30; + } else { + $string = get_string("turneditingon"); + $edit = "on"; + } + + return ""; + } +} + +/** + * Given a course and a (current) coursemodule + * This function returns a small popup menu with all the + * course activity modules in it, as a navigation menu + * The data is taken from the serialised array stored in + * the course record + * + * @param course $course A {@link $COURSE} object. + * @param course $cm A {@link $COURSE} object. + * @param string $targetwindow ? + * @return string + * @todo Finish documenting this function + */ +function navmenu($course, $cm=NULL, $targetwindow='self') { + + global $CFG, $THEME, $USER; + + if (empty($THEME->navmenuwidth)) { + $width = 50; + } else { + $width = $THEME->navmenuwidth; + } + + if ($cm) { + $cm = $cm->id; + } + + if ($course->format == 'weeks') { + $strsection = get_string('week'); + } else { + $strsection = get_string('topic'); + } + $strjumpto = get_string('jumpto'); + + $modinfo = get_fast_modinfo($course); + $context = get_context_instance(CONTEXT_COURSE, $course->id); + + $section = -1; + $selected = ''; + $url = ''; + $previousmod = NULL; + $backmod = NULL; + $nextmod = NULL; + $selectmod = NULL; + $logslink = NULL; + $flag = false; + $menu = array(); + $menustyle = array(); + + $sections = get_records('course_sections','course',$course->id,'section','section,visible,summary'); + + if (!empty($THEME->makenavmenulist)) { /// A hack to produce an XHTML navmenu list for use in themes + $THEME->navmenulist = navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width, $cm); + } + + foreach ($modinfo->cms as $mod) { + if ($mod->modname == 'label') { + continue; + } + + if ($mod->sectionnum > $course->numsections) { /// Don't show excess hidden sections + break; + } + + if (!$mod->uservisible) { // do not icnlude empty sections at all + continue; + } + + if ($mod->sectionnum > 0 and $section != $mod->sectionnum) { + $thissection = $sections[$mod->sectionnum]; + + if ($thissection->visible or !$course->hiddensections or + has_capability('moodle/course:viewhiddensections', $context)) { + $thissection->summary = strip_tags(format_string($thissection->summary,true)); + if ($course->format == 'weeks' or empty($thissection->summary)) { + $menu[] = '--'.$strsection ." ". $mod->sectionnum; + } else { + if (strlen($thissection->summary) < ($width-3)) { + $menu[] = '--'.$thissection->summary; + } else { + $menu[] = '--'.substr($thissection->summary, 0, $width).'...'; + } + } + $section = $mod->sectionnum; + } else { + // no activities from this hidden section shown + continue; + } + } + + $url = $mod->modname.'/view.php?id='. $mod->id; + if ($flag) { // the current mod is the "next" mod + $nextmod = $mod; + $flag = false; + } + $localname = $mod->name; + if ($cm == $mod->id) { + $selected = $url; + $selectmod = $mod; + $backmod = $previousmod; + $flag = true; // set flag so we know to use next mod for "next" + $localname = $strjumpto; + $strjumpto = ''; + } else { + $localname = strip_tags(format_string($localname,true)); + $tl=textlib_get_instance(); + if ($tl->strlen($localname) > ($width+5)) { + $localname = $tl->substr($localname, 0, $width).'...'; + } + if (!$mod->visible) { + $localname = '('.$localname.')'; + } + } + $menu[$url] = $localname; + if (empty($THEME->navmenuiconshide)) { + $menustyle[$url] = 'style="background-image: url('.$CFG->modpixpath.'/'.$mod->modname.'/icon.gif);"'; // Unfortunately necessary to do this here + } + $previousmod = $mod; + } + //Accessibility: added Alt text, replaced > < with 'silent' character and 'accesshide' text. + + if ($selectmod and has_capability('moodle/site:viewreports', $context)) { + $logstext = get_string('alllogs'); + $logslink = '

'."\n".'frametarget.'onclick="this.target=\''.$CFG->framename.'\';"'.' href="'. + $CFG->wwwroot.'/course/report/log/index.php?chooselog=1&user=0&date=0&id='. + $course->id.'&modid='.$selectmod->id.'">'. + '

'."\n".'

'; + + } + if ($backmod) { + $backtext= get_string('activityprev', 'access'); + $backmod = '

'; + } + if ($nextmod) { + $nexttext= get_string('activitynext', 'access'); + $nextmod = '

'; + } + + return ''; +} + +/** + * Given a course + * This function returns a small popup menu with all the + * course activity modules in it, as a navigation menu + * outputs a simple list structure in XHTML + * The data is taken from the serialised array stored in + * the course record + * + * @param course $course A {@link $COURSE} object. + * @return string + * @todo Finish documenting this function + */ +function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) { + + global $CFG; + + $section = -1; + $url = ''; + $menu = array(); + $doneheading = false; + + $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id); + + $menu[] = '

'.$strjumpto.'
'.$item.''; + $menu[] = '
- '. + ''. + ''.$mod->name.'

'; + + return implode("\n", $menu); +} + +/** + * Prints form items with the names $day, $month and $year + * + * @param string $day fieldname + * @param string $month fieldname + * @param string $year fieldname + * @param int $currenttime A default timestamp in GMT + * @param boolean $return + */ +function print_date_selector($day, $month, $year, $currenttime=0, $return=false) { + + if (!$currenttime) { + $currenttime = time(); + } + $currentdate = usergetdate($currenttime); + + for ($i=1; $i<=31; $i++) { + $days[$i] = $i; + } + for ($i=1; $i<=12; $i++) { + $months[$i] = userdate(gmmktime(12,0,0,$i,15,2000), "%B"); + } + for ($i=1970; $i<=2020; $i++) { + $years[$i] = $i; + } + return choose_from_menu($days, $day, $currentdate['mday'], '', '', '0', $return) + .choose_from_menu($months, $month, $currentdate['mon'], '', '', '0', $return) + .choose_from_menu($years, $year, $currentdate['year'], '', '', '0', $return); + +} + +/** + *Prints form items with the names $hour and $minute + * + * @param string $hour fieldname + * @param string ? $minute fieldname + * @param $currenttime A default timestamp in GMT + * @param int $step minute spacing + * @param boolean $return + */ +function print_time_selector($hour, $minute, $currenttime=0, $step=5, $return=false) { + + if (!$currenttime) { + $currenttime = time(); + } + $currentdate = usergetdate($currenttime); + if ($step != 1) { + $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step; + } + for ($i=0; $i<=23; $i++) { + $hours[$i] = sprintf("%02d",$i); + } + for ($i=0; $i<=59; $i+=$step) { + $minutes[$i] = sprintf("%02d",$i); + } + + return choose_from_menu($hours, $hour, $currentdate['hours'], '','','0',$return) + .choose_from_menu($minutes, $minute, $currentdate['minutes'], '','','0',$return); +} + +/** + * Prints time limit value selector + * + * @uses $CFG + * @param int $timelimit default + * @param string $unit + * @param string $name + * @param boolean $return + */ +function print_timer_selector($timelimit = 0, $unit = '', $name = 'timelimit', $return=false) { + + global $CFG; + + if ($unit) { + $unit = ' '.$unit; + } + + // Max timelimit is sessiontimeout - 10 minutes. + $maxvalue = ($CFG->sessiontimeout / 60) - 10; + + for ($i=1; $i<=$maxvalue; $i++) { + $minutes[$i] = $i.$unit; + } + return choose_from_menu($minutes, $name, $timelimit, get_string('none'), '','','0',$return); +} + +/** + * Prints a grade menu (as part of an existing form) with help + * Showing all possible numerical grades and scales + * + * @uses $CFG + * @param int $courseid ? + * @param string $name ? + * @param string $current ? + * @param boolean $includenograde ? + * @todo Finish documenting this function + */ +function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) { + + global $CFG; + + $output = ''; + $strscale = get_string('scale'); + $strscales = get_string('scales'); + + $scales = get_scales_menu($courseid); + foreach ($scales as $i => $scalename) { + $grades[-$i] = $strscale .': '. $scalename; + } + if ($includenograde) { + $grades[0] = get_string('nograde'); + } + for ($i=100; $i>=1; $i--) { + $grades[$i] = $i; + } + $output .= choose_from_menu($grades, $name, $current, '', '', 0, true); + + $linkobject = ' '.$strscales.'

'; + $output .= link_to_popup_window ('/course/scales.php?id='. $courseid .'&list=true', 'ratingscales', + $linkobject, 400, 500, $strscales, 'none', true); + + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Prints a scale menu (as part of an existing form) including help button + * Just like {@link print_grade_menu()} but without the numeric grades + * + * @param int $courseid ? + * @param string $name ? + * @param string $current ? + * @todo Finish documenting this function + */ +function print_scale_menu($courseid, $name, $current, $return=false) { + + global $CFG; + + $output = ''; + $strscales = get_string('scales'); + $output .= choose_from_menu(get_scales_menu($courseid), $name, $current, '', '', 0, true); + + $linkobject = ' '.$strscales.'

'; + $output .= link_to_popup_window ('/course/scales.php?id='. $courseid .'&list=true', 'ratingscales', + $linkobject, 400, 500, $strscales, 'none', true); + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Prints a help button about a scale + * + * @uses $CFG + * @param id $courseid ? + * @param object $scale ? + * @todo Finish documenting this function + */ +function print_scale_menu_helpbutton($courseid, $scale, $return=false) { + + global $CFG; + + $output = ''; + $strscales = get_string('scales'); + + $linkobject = ' '.$scale->name.'

'; + $output .= link_to_popup_window ('/course/scales.php?id='. $courseid .'&list=true&scaleid='. $scale->id, 'ratingscale', + $linkobject, 400, 500, $scale->name, 'none', true); + if ($return) { + return $output; + } else { + echo $output; + } +} + +/** + * Print an error page displaying an error message. New method - use this for new code. + * + * @uses $SESSION + * @uses $CFG + * @param string $errorcode The name of the string from error.php (or other specified file) to print + * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page. + * @param object $a Extra words and phrases that might be required in the error string + * @param array $extralocations An array of strings with other locations to look for string files + * @return does not return, terminates script + */ +function print_error($errorcode, $module='error', $link='', $a=NULL, $extralocations=NULL) { + global $CFG, $SESSION, $THEME; + + if (empty($module) || $module === 'moodle' || $module === 'core') { + $module = 'error'; + } + + $message = get_string($errorcode, $module, $a, $extralocations); + if ($module === 'error' and strpos($message, '[[') === 0) { + //search in moodle file if error specified - needed for backwards compatibility + $message = get_string($errorcode, 'moodle', $a, $extralocations); + } + + if (empty($link) and !defined('ADMIN_EXT_HEADER_PRINTED')) { + if ( !empty($SESSION->fromurl) ) { + $link = $SESSION->fromurl; + unset($SESSION->fromurl); + } else { + $link = $CFG->wwwroot .'/'; + } + } + + if (!empty($CFG->errordocroot)) { + $errordocroot = $CFG->errordocroot; + } else if (!empty($CFG->docroot)) { + $errordocroot = $CFG->docroot; + } else { + $errordocroot = 'http://docs.moodle.org'; + } + + if (defined('FULLME') && FULLME == 'cron') { + // Errors in cron should be mtrace'd. + mtrace($message); + die; + } + + if ($module === 'error') { + $modulelink = 'moodle'; + } else { + $modulelink = $module; + } + + $message = clean_text('

'.$message.'

'. + '

'. + ''. + get_string('moreinformation').'

'); + + if (! defined('HEADER_PRINTED')) { + //header not yet printed + @header('HTTP/1.0 404 Not Found'); + print_header(get_string('error')); + } else { + print_container_end_all(false, $THEME->open_header_containers); + } + + echo '
'; + + print_simple_box($message, '', '', '', '', 'errorbox'); + + debugging('Stack trace:', DEBUG_DEVELOPER); + + // in case we are logging upgrade in admin/index.php stop it + if (function_exists('upgrade_log_finish')) { + upgrade_log_finish(); + } + + if (!empty($link)) { + print_continue($link); + } + + print_footer(); + + for ($i=0;$i<512;$i++) { // Padding to help IE work with 404 + echo ' '; + } + die; +} + +/** + * Print an error to STDOUT and exit with a non-zero code. For commandline scripts. + * Default errorcode is 1. + * + * Very useful for perl-like error-handling: + * + * do_somethting() or mdie("Something went wrong"); + * + * @param string $msg Error message + * @param integer $errorcode Error code to emit + */ +function mdie($msg='', $errorcode=1) { + trigger_error($msg); + exit($errorcode); +} + +/** + * Returns a string of html with an image of a help icon linked to a help page on a number of help topics. + * Should be used only with htmleditor or textarea. + * @param mixed $helptopics variable amount of params accepted. Each param may be a string or an array of arguments for + * helpbutton. + * @return string + */ +function editorhelpbutton(){ + global $CFG, $SESSION; + $items = func_get_args(); + $i = 1; + $urlparams = array(); + $titles = array(); + foreach ($items as $item){ + if (is_array($item)){ + $urlparams[] = "keyword$i=".urlencode($item[0]); + $urlparams[] = "title$i=".urlencode($item[1]); + if (isset($item[2])){ + $urlparams[] = "module$i=".urlencode($item[2]); + } + $titles[] = trim($item[1], ". \t"); + }elseif (is_string($item)){ + $urlparams[] = "button$i=".urlencode($item); + switch ($item){ + case 'reading' : + $titles[] = get_string("helpreading"); + break; + case 'writing' : + $titles[] = get_string("helpwriting"); + break; + case 'questions' : + $titles[] = get_string("helpquestions"); + break; + case 'emoticons' : + $titles[] = get_string("helpemoticons"); + break; + case 'richtext' : + $titles[] = get_string('helprichtext'); + break; + case 'text' : + $titles[] = get_string('helptext'); + break; + default : + error('Unknown help topic '.$item); + } + } + $i++; + } + if (count($titles)>1){ + //join last two items with an 'and' + $a = new object(); + $a->one = $titles[count($titles) - 2]; + $a->two = $titles[count($titles) - 1]; + $titles[count($titles) - 2] = get_string('and', '', $a); + unset($titles[count($titles) - 1]); + } + $alttag = join (', ', $titles); + + $paramstring = join('&', $urlparams); + $linkobject = ' '.$alttag.'

'; + return link_to_popup_window(s('/lib/form/editorhelp.php?'.$paramstring), 'popup', $linkobject, 400, 500, $alttag, 'none', true); +} + +/** + * Print a help button. + * + * @uses $CFG + * @param string $page The keyword that defines a help page + * @param string $title The title of links, rollover tips, alt tags etc + * 'Help with' (or the language equivalent) will be prefixed and '...' will be stripped. + * @param string $module Which module is the page defined in + * @param mixed $image Use a help image for the link? (true/false/"both") + * @param boolean $linktext If true, display the title next to the help icon. + * @param string $text If defined then this text is used in the page, and + * the $page variable is ignored. + * @param boolean $return If true then the output is returned as a string, if false it is printed to the current page. + * @param string $imagetext The full text for the helpbutton icon. If empty use default help.gif + * @return string + * @todo Finish documenting this function + */ +function helpbutton ($page, $title, $module='moodle', $image=true, $linktext=false, $text='', $return=false, + $imagetext='') { + global $CFG, $COURSE; + + //warning if ever $text parameter is used + //$text option won't work properly because the text needs to be always cleaned and, + // when cleaned... html tags always break, so it's unusable. + if ( isset($text) && $text!='') { + debugging('Warning: it\'s not recommended to use $text parameter in helpbutton ($page=' . $page . ', $module=' . $module . ') function', DEBUG_DEVELOPER); + } + + // fix for MDL-7734 + if (!empty($COURSE->lang)) { + $forcelang = $COURSE->lang; + } else { + $forcelang = ''; + } + + if ($module == '') { + $module = 'moodle'; + } + + if ($title == '' && $linktext == '') { + debugging('Error in call to helpbutton function: at least one of $title and $linktext is required'); + } + + // Warn users about new window for Accessibility + $tooltip = get_string('helpprefix2', '', trim($title, ". \t")) .' ('.get_string('newwindow').')'; + + $linkobject = ''; + + if ($image) { + if ($linktext) { + // MDL-7469 If text link is displayed with help icon, change to alt to "help with this". + $linkobject .= $title.' '; + $tooltip = get_string('helpwiththis'); + } + if ($imagetext) { + $linkobject .= $imagetext; + } else { + $linkobject .= ' '.s(strip_tags($tooltip)).'

'; + } + } else { + $linkobject .= $tooltip; + } + + // fix for MDL-7734 + if ($text) { + $url = '/help.php?module='. $module .'&text='. s(urlencode($text).'&forcelang='.$forcelang); + } else { + $url = '/help.php?module='. $module .'&file='. $page .'.html&forcelang='.$forcelang; + } + + $link = ''. + link_to_popup_window ($url, 'popup', $linkobject, 400, 500, $tooltip, 'none', true). + ''; + + if ($return) { + return $link; + } else { + echo $link; + } +} + +/** + * Print a help button. + * + * Prints a special help button that is a link to the "live" emoticon popup + * @uses $CFG + * @uses $SESSION + * @param string $form ? + * @param string $field ? + * @todo Finish documenting this function + */ +function emoticonhelpbutton($form, $field, $return = false) { + + global $CFG, $SESSION; + + $SESSION->inserttextform = $form; + $SESSION->inserttextfield = $field; + $imagetext = '

'; + $help = helpbutton('emoticons', get_string('helpemoticons'), 'moodle', true, true, '', true, $imagetext); + if (!$return){ + echo $help; + } else { + return $help; + } +} + +/** + * Print a help button. + * + * Prints a special help button for html editors (htmlarea in this case) + * @uses $CFG + */ +function editorshortcutshelpbutton() { + + global $CFG; + $imagetext = ' '.
+ get_string('editorshortcutkeys').'

'; + + return helpbutton('editorshortcuts', get_string('editorshortcutkeys'), 'moodle', true, false, '', true, $imagetext); +} + +/** + * Print a message and exit. + * + * @uses $CFG + * @param string $message ? + * @param string $link ? + * @todo Finish documenting this function + */ +function notice ($message, $link='', $course=NULL) { + global $CFG, $SITE, $THEME, $COURSE; + + $message = clean_text($message); // In case nasties are in here + + if (defined('FULLME') && FULLME == 'cron') { + // notices in cron should be mtrace'd. + mtrace($message); + die; + } + + if (! defined('HEADER_PRINTED')) { + //header not yet printed + print_header(get_string('notice')); + } else { + print_container_end_all(false, $THEME->open_header_containers); + } + + print_box($message, 'generalbox', 'notice'); + print_continue($link); + + if (empty($course)) { + print_footer($COURSE); + } else { + print_footer($course); + } + exit; +} + +/** + * Print a message along with "Yes" and "No" links for the user to continue. + * + * @param string $message The text to display + * @param string $linkyes The link to take the user to if they choose "Yes" + * @param string $linkno The link to take the user to if they choose "No" + * TODO Document remaining arguments + */ +function notice_yesno ($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') { + + global $CFG; + + $message = clean_text($message); + $linkyes = clean_text($linkyes); + $linkno = clean_text($linkno); + + print_box_start('generalbox', 'notice'); + echo '

'. $message .'

'; + echo '

'; + print_single_button($linkyes, $optionsyes, get_string('yes'), $methodyes, $CFG->framename); + print_single_button($linkno, $optionsno, get_string('no'), $methodno, $CFG->framename); + echo '

'; + print_box_end(); +} + +/** + * Provide an definition of error_get_last for PHP before 5.2.0. This simply + * returns NULL, since there is not way to get the right answer. + */ +if (!function_exists('error_get_last')) { + // the eval is needed to prevent PHP 5.2+ from getting a parse error! + eval(' + function error_get_last() { + return NULL; + } + '); +} + +/** + * Redirects the user to another page, after printing a notice + * + * @param string $url The url to take the user to + * @param string $message The text message to display to the user about the redirect, if any + * @param string $delay How long before refreshing to the new page at $url? + * @todo '&' needs to be encoded into '&' for XHTML compliance, + * however, this is not true for javascript. Therefore we + * first decode all entities in $url (since we cannot rely on) + * the correct input) and then encode for where it's needed + * echo ""; + */ +function redirect($url, $message='', $delay=-1) { + + global $CFG, $THEME; + + if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()])) { + $url = sid_process_url($url); + } + + $message = clean_text($message); + + $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&", $url); + $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('')); + $url = str_replace('&', '&', $encodedurl); + +/// At developer debug level. Don't redirect if errors have been printed on screen. +/// Currenly only works in PHP 5.2+; we do not want strict PHP5 errors + $lasterror = error_get_last(); + $error = defined('DEBUGGING_PRINTED') or (!empty($lasterror) && ($lasterror['type'] & DEBUG_DEVELOPER)); + $errorprinted = debugging('', DEBUG_ALL) && $CFG->debugdisplay && $error; + if ($errorprinted) { + $message = "Error output, so disabling automatic redirect.

" . $message; + } + + $performanceinfo = ''; + if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) { + if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) { + $perf = get_performance_info(); + error_log("PERF: " . $perf['txt']); + } + } + +/// when no message and header printed yet, try to redirect + if (empty($message) and !defined('HEADER_PRINTED')) { + + // Technically, HTTP/1.1 requires Location: header to contain + // the absolute path. (In practice browsers accept relative + // paths - but still, might as well do it properly.) + // This code turns relative into absolute. + if (!preg_match('|^[a-z]+:|', $url)) { + // Get host name http://www.wherever.com + $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot); + if (preg_match('|^/|', $url)) { + // URLs beginning with / are relative to web server root so we just add them in + $url = $hostpart.$url; + } else { + // URLs not beginning with / are relative to path of current script, so add that on. + $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url; + } + // Replace all ..s + while (true) { + $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url); + if ($newurl == $url) { + break; + } + $url = $newurl; + } + } + + $delay = 0; + //try header redirection first + @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other'); //302 might not work for POST requests, 303 is ignored by obsolete clients + @header('Location: '.$url); + //another way for older browsers and already sent headers (eg trailing whitespace in config.php) + echo ''; + echo ''; // To cope with Mozilla bug + die; + } + + if ($delay == -1) { + $delay = 3; // if no delay specified wait 3 seconds + } + if (! defined('HEADER_PRINTED')) { + // this type of redirect might not be working in some browsers - such as lynx :-( + print_header('', '', '', '', $errorprinted ? '' : ('')); + $delay += 3; // double redirect prevention, it was sometimes breaking upgrades before 1.7 + } else { + print_container_end_all(false, $THEME->open_header_containers); + } + echo '

'; + echo '

' . $message . '

'; + echo '

( '. get_string('continue') .' )

'; + echo '

'; + + if (!$errorprinted) { +?> + +docroot = false; // to prevent the link to moodle docs from being displayed on redirect page. + print_footer('none'); + die; +} + +/** + * Print a bold message in an optional color. + * + * @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 + */ +function notify($message, $style='notifyproblem', $align='center', $return=false) { + if ($style == 'green') { + $style = 'notifysuccess'; // backward compatible with old color system + } + + $message = clean_text($message); + + $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 + * @return string + */ + function obfuscate_email($email) { + + $i = 0; + $length = strlen($email); + $obfuscated = ''; + while ($i < $length) { + if (rand(0,2)) { + $obfuscated.='%'.dechex(ord($email{$i})); + } else { + $obfuscated.=$email{$i}; + } + $i++; + } + return $obfuscated; +} + +/** + * This function takes some text and replaces about half of the characters + * with HTML entity equivalents. Return string is obviously longer. + * + * @param string $plaintext The text to be obfuscated + * @return string + */ +function obfuscate_text($plaintext) { + + $i=0; + $length = strlen($plaintext); + $obfuscated=''; + $prev_obfuscated = false; + while ($i < $length) { + $c = ord($plaintext{$i}); + $numerical = ($c >= ord('0')) && ($c <= ord('9')); + if ($prev_obfuscated and $numerical ) { + $obfuscated.='&#'.ord($plaintext{$i}).';'; + } else if (rand(0,2)) { + $obfuscated.='&#'.ord($plaintext{$i}).';'; + $prev_obfuscated = true; + } else { + $obfuscated.=$plaintext{$i}; + $prev_obfuscated = false; + } + $i++; + } + return $obfuscated; +} + +/** + * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()} + * to generate a fully obfuscated email link, ready to use. + * + * @param string $email The email address to display + * @param string $label The text to dispalyed as hyperlink to $email + * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink + * @return string + */ +function obfuscate_mailto($email, $label='', $dimmed=false) { + + if (empty($label)) { + $label = $email; + } + if ($dimmed) { + $title = get_string('emaildisable'); + $dimmed = ' class="dimmed"'; + } else { + $title = ''; + $dimmed = ''; + } + return sprintf("%s", + obfuscate_text('mailto'), obfuscate_email($email), + obfuscate_text($label)); +} + +/** + * Prints a single paging bar to provide access to other pages (usually in a search) + * + * @param int $totalcount Thetotal number of entries available to be paged through + * @param int $page The page you are currently viewing + * @param int $perpage The number of entries that should be shown per page + * @param mixed $baseurl If this is a string then it is the url which will be appended with $pagevar, an equals sign and the page number. + * If this is a moodle_url object then the pagevar param will be replaced by the page no, for each page. + * @param string $pagevar This is the variable name that you use for the page number in your code (ie. 'tablepage', 'blogpage', etc) + * @param bool $nocurr do not display the current page as a link + * @param bool $return whether to return an output string or echo now + * @return bool or string + */ +function print_paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar='page',$nocurr=false, $return=false) { + $maxdisplay = 18; + $output = ''; + + if ($totalcount > $perpage) { + $output .= '

'; + $output .= get_string('page') .':'; + if ($page > 0) { + $pagenum = $page - 1; + if (!is_a($baseurl, 'moodle_url')){ + $output .= ' ('. get_string('previous') .') '; + } else { + $output .= ' ('. get_string('previous') .') '; + } + } + if ($perpage > 0) { + $lastpage = ceil($totalcount / $perpage); + } else { + $lastpage = 1; + } + if ($page > 15) { + $startpage = $page - 10; + if (!is_a($baseurl, 'moodle_url')){ + $output .= ' 1 ...'; + } else { + $output .= ' 1 ...'; + } + } else { + $startpage = 0; + } + $currpage = $startpage; + $displaycount = $displaypage = 0; + while ($displaycount < $maxdisplay and $currpage < $lastpage) { + $displaypage = $currpage+1; + if ($page == $currpage && empty($nocurr)) { + $output .= ' '. $displaypage; + } else { + if (!is_a($baseurl, 'moodle_url')){ + $output .= ' '. $displaypage .''; + } else { + $output .= ' '. $displaypage .''; + } + + } + $displaycount++; + $currpage++; + } + if ($currpage < $lastpage) { + $lastpageactual = $lastpage - 1; + if (!is_a($baseurl, 'moodle_url')){ + $output .= ' ...'. $lastpage .' '; + } else { + $output .= ' ...'. $lastpage .' '; + } + } + $pagenum = $page + 1; + if ($pagenum != $displaypage) { + if (!is_a($baseurl, 'moodle_url')){ + $output .= ' ('. get_string('next') .')'; + } else { + $output .= ' ('. get_string('next') .')'; + } + } + $output .= '

'; + } + + if ($return) { + return $output; + } + + echo $output; + return true; +} + +/** + * This function is used to rebuild the tag because some formats (PLAIN and WIKI) + * will transform it to html entities + * + * @param string $text Text to search for nolink tag in + * @return string + */ +function rebuildnolinktag($text) { + + $text = preg_replace('/<(\/*nolink)>/i','<$1>',$text); + + return $text; +} + +/** + * Prints a nice side block with an optional header. The content can either + * be a block of HTML or a list of text with optional icons. + * + * @param string $heading Block $title embedded in HTML tags, for example

. + * @param string $content ? + * @param array $list ? + * @param array $icons ? + * @param string $footer ? + * @param array $attributes ? + * @param string $title Plain text title, as embedded in the $heading. + * @todo Finish documenting this function. Show example of various attributes, etc. + */ +function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') { + + //Accessibility: skip block link, with title-text (or $block_id) to differentiate links. + static $block_id = 0; + $block_id++; + if (empty($heading)) { + $skip_text = get_string('skipblock', 'access').' '.$block_id; + } + else { + $skip_text = get_string('skipa', 'access', strip_tags($title)); + } + $skip_link = ''.$skip_text.''; + $skip_dest = ''; + + if (! empty($heading)) { + echo $skip_link; + } + //ELSE: a single link on a page "Skip block 4" is too confusing - ignore. + + print_side_block_start($heading, $attributes); + + if ($content) { + echo $content; + if ($footer) { + echo '
'. $footer .'
'; + } + } else { + if ($list) { + $row = 0; + //Accessibility: replaced unnecessary table with list, see themes/standard/styles_layout.css + echo "\n
\n"; + foreach ($list as $key => $string) { + echo '
'; + if ($icons) { + echo '
'. $icons[$key] .'
'; + } + echo '
'. $string .'
'; + echo "
\n"; + $row = $row ? 0:1; + } + echo "
\n"; + } + if ($footer) { + echo '
'. $footer .'
'; + } + + } + + print_side_block_end($attributes, $title); + echo $skip_dest; +} + +/** + * Starts a nice side block with an optional header. + * + * @param string $heading ? + * @param array $attributes ? + * @todo Finish documenting this function + / +function print_side_block_start($heading='', $attributes = array()) { + + global $CFG, $THEME; + + // If there are no special attributes, give a default CSS class + if (empty($attributes) || !is_array($attributes)) { + $attributes = array('class' => 'sideblock'); + + } else if(!isset($attributes['class'])) { + $attributes['class'] = 'sideblock'; + + } else if(!strpos($attributes['class'], 'sideblock')) { + $attributes['class'] .= ' sideblock'; + } + + // OK, the class is surely there and in addition to anything + // else, it's tagged as a sideblock + + / + + // IE misery: if I do it this way, blocks which start hidden cannot be "unhidden" + + // If there is a cookie to hide this thing, start it hidden + if (!empty($attributes['id']) && isset($_COOKIE['hide:'.$attributes['id']])) { + $attributes['class'] = 'hidden '.$attributes['class']; + } + */ + + $attrtext = ''; + foreach ($attributes as $attr => $val) { + $attrtext .= ' '.$attr.'="'.$val.'"'; + } + + echo '
'; + + if (!empty($THEME->customcorners)) { + echo '
'."\n"; + } + if ($heading) { + //Accessibility: H2 more appropriate in moodleblock.class.php: _title_html. + echo '
'; + if (!empty($THEME->customcorners)) { + echo '

'; + echo '
'; + echo '
'; + } + echo $heading; + if (!empty($THEME->customcorners)) { + echo '
'; + } + echo '
'; + } else { + if (!empty($THEME->customcorners)) { + echo '

'; + } + } + + if (!empty($THEME->customcorners)) { + echo '
'; + echo '
'; + } + echo '
'; + +} + + +/** + * Print table ending tags for a side block box. + */ +function print_side_block_end($attributes = array(), $title='') { + global $CFG, $THEME; + + echo '
'; + + if (!empty($THEME->customcorners)) { + echo '

'; + } + + echo '
'; + + $strshow = addslashes_js(get_string('showblocka', 'access', strip_tags($title))); + $strhide = addslashes_js(get_string('hideblocka', 'access', strip_tags($title))); + + // IE workaround: if I do it THIS way, it works! WTF? + if (!empty($CFG->allowuserblockhiding) && isset($attributes['id'])) { + echo ''; + } + +} + + +/** + * Prints out code needed for spellchecking. + * Original idea by Ludo (Marc Alier). + * + * Opening CDATA and + + '; + +/// Print the navigation panel if required + $numpages = quiz_number_of_pages($attempt->layout); + if ($numpages > 1) { + quiz_print_navigation_panel($page, $numpages); + } + +/// Print all the questions + $number = quiz_first_questionnumber($attempt->layout, $pagelist); + foreach ($pagequestions as $i) { + $options = quiz_get_renderoptions($quiz->review, $states[$i]); + // Print the question + print_question($questions[$i], $states[$i], $number, $quiz, $options); + save_question_session($questions[$i], $states[$i]); + $number += $questions[$i]->length; + } + +/// Print the submit buttons + $strconfirmattempt = addslashes(get_string("confirmclose", "quiz")); + $onclick = "return confirm('$strconfirmattempt')"; + echo "
\n"; + + echo "\n"; + if ($quiz->optionflags & QUESTION_ADAPTIVE) { + echo "\n"; + } + echo "\n"; + + echo "
"; + + // Print the navigation panel if required + if ($numpages > 1) { + quiz_print_navigation_panel($page, $numpages); + } + + // Finish the form + echo '

'.$icon.stripslashes_safe($text); + $output .= helpbutton($helppage, $text, $module, true, false, '', true); + $output .= '

'.stripslashes($heading).'