From ac3668bfaedc5fe535f7b7d56d04163696777f48 Mon Sep 17 00:00:00 2001 From: skodak Date: Wed, 22 Apr 2009 05:10:08 +0000 Subject: [PATCH] MDL-18910 full support for module intro editor with embedded images --- lib/weblib.php | 6 ++++-- mod/resource/index.php | 6 ++---- mod/resource/mod_form.php | 8 +------- mod/resource/type/directory/resource.class.php | 6 +----- mod/resource/type/file/resource.class.php | 14 ++++---------- mod/resource/type/html/resource.class.php | 2 +- mod/resource/type/ims/resource.class.php | 5 +---- mod/resource/type/repository/resource.class.php | 13 ++++--------- mod/resource/type/text/resource.class.php | 2 +- mod/scorm/index.php | 4 ++-- mod/scorm/lib.php | 12 +----------- mod/scorm/locallib.php | 2 +- mod/scorm/mod_form.php | 5 +---- mod/scorm/view.php | 5 ++--- mod/survey/mod_form.php | 6 ++---- mod/survey/view.php | 5 ++--- mod/wiki/index.php | 2 +- mod/wiki/mod_form.php | 5 +---- mod/wiki/view.php | 3 +-- 19 files changed, 33 insertions(+), 78 deletions(-) diff --git a/lib/weblib.php b/lib/weblib.php index af987dbe91..540b4646bc 100644 --- a/lib/weblib.php +++ b/lib/weblib.php @@ -1558,10 +1558,12 @@ function filter_text($text, $courseid=NULL) { * @return text */ function format_module_intro($module, $activity, $cmid) { - $options = (object)array('noclean'=>true); + global $CFG; + require_once("$CFG->libdir/filelib.php"); + $options = (object)array('noclean'=>true, 'para'=>false); $context = get_context_instance(CONTEXT_MODULE, $cmid); $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, $module.'_intro', 0); - return format_text($intro, $activity->introformat, $options); + return trim(format_text($intro, $activity->introformat, $options)); } /** diff --git a/mod/resource/index.php b/mod/resource/index.php index 15d85d9e4e..63e968f6ef 100644 --- a/mod/resource/index.php +++ b/mod/resource/index.php @@ -47,8 +47,6 @@ } $currentsection = ""; - $options->para = false; - $options->noclean = true; foreach ($resources as $resource) { if ($course->format == "weeks" or $course->format == "topics") { $printsection = ""; @@ -72,12 +70,12 @@ if (!$resource->visible) { // Show dimmed if the mod is hidden $table->data[] = array ($printsection, "coursemodule\">".format_string($resource->name,true)."", - format_text($resource->intro, $resource->introformat, $options) ); + format_module_intro('resource', $resource, $resource->coursemodule)); } else { //Show normal if the mod is visible $table->data[] = array ($printsection, "coursemodule\">".format_string($resource->name,true)."", - format_text($resource->intro, $resource->introformat, $options) ); + format_module_intro('resource', $resource, $resource->coursemodule)); } } diff --git a/mod/resource/mod_form.php b/mod/resource/mod_form.php index 243ee602d9..f1860c8b25 100644 --- a/mod/resource/mod_form.php +++ b/mod/resource/mod_form.php @@ -28,8 +28,6 @@ class mod_resource_mod_form extends moodleform_mod { //------------------------------------------------------------------------------- $mform->addElement('header', 'general', get_string('general', 'form')); -// $mform->addElement('static', 'statictype', get_string('assignmenttype', 'assignment'), get_string('type'.$type,'assignment')); - $mform->addElement('text', 'name', get_string('name'), array('size'=>'48')); if (!empty($CFG->formatstringstriptags)) { $mform->setType('name', PARAM_TEXT); @@ -38,11 +36,7 @@ class mod_resource_mod_form extends moodleform_mod { } $mform->addRule('name', null, 'required', null, 'client'); - $mform->addElement('htmleditor', 'intro', get_string('summary')); - $mform->setType('intro', PARAM_RAW); - $mform->setHelpButton('intro', array('summary', get_string('summary'), 'resource')); - // summary should be optional again MDL-9485 - //$mform->addRule('summary', get_string('required'), 'required', null, 'client'); + $this->add_intro_editor(false); $mform->addElement('header', 'typedesc', resource_get_name($type)); $this->_resinstance->setup_elements($mform); diff --git a/mod/resource/type/directory/resource.class.php b/mod/resource/type/directory/resource.class.php index f6a2eda765..3a3657c2b5 100644 --- a/mod/resource/type/directory/resource.class.php +++ b/mod/resource/type/directory/resource.class.php @@ -40,10 +40,6 @@ function display() { $subdir = optional_param('subdir','', PARAM_PATH); $resource->reference = clean_param($resource->reference, PARAM_PATH); - $formatoptions = new object(); - $formatoptions->noclean = true; - $formatoptions->para = false; // MDL-12061,

in html editor breaks xhtml strict - add_to_log($course->id, "resource", "view", "view.php?id={$cm->id}", $resource->id, $cm->id); if ($resource->reference) { @@ -91,7 +87,7 @@ function display() { if (trim(strip_tags($resource->intro))) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); print_spacer(10,10); } diff --git a/mod/resource/type/file/resource.class.php b/mod/resource/type/file/resource.class.php index 3a63b42248..d2af53306b 100644 --- a/mod/resource/type/file/resource.class.php +++ b/mod/resource/type/file/resource.class.php @@ -223,9 +223,6 @@ class resource_file extends resource_base { $mimetype = mimeinfo("type", $resource->reference); $pagetitle = strip_tags($course->shortname.': '.format_string($resource->name)); - $formatoptions = new object(); - $formatoptions->noclean = true; - if ($resource->options != "forcedownload") { // TODO nicolasconnault 14-03-07: This option should be renamed "embed" if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) { // It's an image $resourcetype = "image"; @@ -365,7 +362,7 @@ class resource_file extends resource_base { echo ''; if (trim(strip_tags($resource->intro))) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } $link = "wwwroot/mod/resource/view.php?inpopup=true&id={$cm->id}\" " @@ -451,7 +448,7 @@ class resource_file extends resource_base { ///print the intro if (!empty($resource->intro)) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } echo ""; exit; @@ -489,10 +486,7 @@ class resource_file extends resource_base { print_header($pagetitle, $course->fullname, $navigation, "", "", true, update_module_button($cm->id, $course->id, $this->strresource), navmenu($course, $cm, "parent")); - $options = new object(); - $options->para = false; - $options->noclean = true; - echo '

'.format_text($resource->intro, $resource->introformat, $options).'
'; + echo '
'.format_module_intro('resource', $resource, $cm->id).'
'; if (!empty($localpath)) { // Show some help echo '
'; link_to_popup_window ('/mod/resource/type/file/localpath.php', get_string('localfile', 'resource'), @@ -706,7 +700,7 @@ class resource_file extends resource_base { } if (trim($resource->intro)) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } if ($inpopup) { diff --git a/mod/resource/type/html/resource.class.php b/mod/resource/type/html/resource.class.php index 20097e0fff..cadf8dfca8 100644 --- a/mod/resource/type/html/resource.class.php +++ b/mod/resource/type/html/resource.class.php @@ -103,7 +103,7 @@ function display() { echo ''; if (trim(strip_tags($resource->intro))) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } $link = "wwwroot/mod/resource/view.php?inpopup=true&id={$cm->id}\" onclick=\"this.target='resource{$resource->id}'; return openpopup('/mod/resource/view.php?inpopup=true&id={$cm->id}', 'resource{$resource->id}','{$resource->popup}');\">".format_string($resource->name,true).""; diff --git a/mod/resource/type/ims/resource.class.php b/mod/resource/type/ims/resource.class.php index 0a31abb649..a62f96dd4e 100644 --- a/mod/resource/type/ims/resource.class.php +++ b/mod/resource/type/ims/resource.class.php @@ -340,9 +340,6 @@ class resource_ims extends resource_base { $mimetype = mimeinfo("type", $resource->reference); $pagetitle = strip_tags($course->shortname.': '.format_string($resource->name)); - $formatoptions = new object(); - $formatoptions->noclean = true; - /// Cache this per request static $items; @@ -435,7 +432,7 @@ class resource_ims extends resource_base { echo ''; if (trim(strip_tags($resource->intro))) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } $link = "wwwroot/mod/resource/view.php?inpopup=true&id={$cm->id}\" target=\"resource{$resource->id}\" onclick=\"return openpopup('/mod/resource/view.php?inpopup=true&id={$cm->id}', 'resource{$resource->id}','{$resource->popup}');\">".format_string($resource->name,true).""; diff --git a/mod/resource/type/repository/resource.class.php b/mod/resource/type/repository/resource.class.php index f610d336c6..697f0993a0 100644 --- a/mod/resource/type/repository/resource.class.php +++ b/mod/resource/type/repository/resource.class.php @@ -212,9 +212,6 @@ function display() { $mimetype = mimeinfo("type", $resource->reference); $pagetitle = strip_tags($course->shortname.': '.format_string($resource->name)); - $formatoptions = new object(); - $formatoptions->noclean = true; - if ($resource->options != "frame") { if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) { // It's an image $resourcetype = "image"; @@ -314,8 +311,7 @@ function display() { echo ''; if (trim(strip_tags($resource->intro))) { - $formatoptions->noclean = true; - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } $link = "wwwroot/mod/resource/view.php?inpopup=true&id={$cm->id}\" target=\"resource{$resource->id}\" onclick=\"return openpopup('/mod/resource/view.php?inpopup=true&id={$cm->id}', 'resource{$resource->id}','{$resource->popup}');\">".format_string($resource->name,true).""; @@ -365,7 +361,7 @@ function display() { print_header($pagetitle, $course->fullname, $navigation, "", "", true, update_module_button($cm->id, $course->id, $this->strresource), navmenu($course, $cm, "parent")); - echo '
'.format_text($resource->intro, $resource->introformat, $formatoptions).'
'; + echo '
'.format_module_intro('resource', $resource, $cm->id).'
'; if (!empty($localpath)) { // Show some help echo '
'; link_to_popup_window ('/mod/resource/type/file/localpath.php', get_string('localfile', 'resource'), get_string('localfilehelp','resource'), 400, 500, get_string('localfilehelp', 'resource')); @@ -467,9 +463,8 @@ function display() { echo "

"; } - if (trim($resource->summary)) { - $formatoptions->noclean = true; - print_simple_box(format_text($resource->summary, FORMAT_MOODLE, $formatoptions, $course->id), "center"); + if (trim($resource->intro)) { + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } if ($inpopup) { diff --git a/mod/resource/type/text/resource.class.php b/mod/resource/type/text/resource.class.php index 01aa639eb0..1cad6758e2 100644 --- a/mod/resource/type/text/resource.class.php +++ b/mod/resource/type/text/resource.class.php @@ -101,7 +101,7 @@ function display() { echo ''; if (trim(strip_tags($resource->intro))) { - print_simple_box(format_text($resource->intro, $resource->introformat, $formatoptions, $course->id), "center"); + print_simple_box(format_module_intro('resource', $resource, $cm->id), "center"); } $link = "wwwroot/mod/resource/view.php?inpopup=true&id={$cm->id}\" onclick=\"this.target='resource{$resource->id}'; return openpopup('/mod/resource/view.php?inpopup=true&id={$cm->id}', 'resource{$resource->id}','{$resource->popup}');\">".format_string($resource->name,true).""; diff --git a/mod/scorm/index.php b/mod/scorm/index.php index 7afbf08557..3661af88e8 100755 --- a/mod/scorm/index.php +++ b/mod/scorm/index.php @@ -84,11 +84,11 @@ if (!$scorm->visible) { //Show dimmed if the mod is hidden $table->data[] = array ($tt, "coursemodule\">".format_string($scorm->name)."", - format_text($scorm->intro, $scorm->introformat, $options), $reportshow); + format_module_intro('scorm', $scorm, $scorm->coursemodule), $reportshow); } else { //Show normal if the mod is visible $table->data[] = array ($tt, "coursemodule\">".format_string($scorm->name)."", - format_text($scorm->intro, $scorm->introformat, $options), $reportshow); + format_module_intro('scorm', $scorm, $scorm->coursemodule), $reportshow); } } diff --git a/mod/scorm/lib.php b/mod/scorm/lib.php index 4076547a72..0d308a588b 100755 --- a/mod/scorm/lib.php +++ b/mod/scorm/lib.php @@ -774,17 +774,7 @@ function scorm_pluginfile($course, $cminfo, $context, $filearea, $args) { $lifetime = isset($CFG->filelifetime) ? $CFG->filelifetime : 86400; - if ($filearea === 'scorm_intro') { - // all users may access it - $relativepath = '/'.implode('/', $args); - $fullpath = $context->id.'scorm_intro0'.$relativepath; - - $fs = get_file_storage(); - if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) { - return false; - } - - } else if ($filearea === 'scorm_content') { + if ($filearea === 'scorm_content') { $revision = (int)array_shift($args); // prevents caching problems - ignored here $relativepath = '/'.implode('/', $args); $fullpath = $context->id.'scorm_content0'.$relativepath; diff --git a/mod/scorm/locallib.php b/mod/scorm/locallib.php index 35ead245d0..2d071bac23 100755 --- a/mod/scorm/locallib.php +++ b/mod/scorm/locallib.php @@ -701,7 +701,7 @@ function scorm_course_format_display($user,$course) { $colspan = ' colspan="2"'; } $options = (object)array('noclean'=>true); - $headertext .= ''.get_string('summary').':
'.format_text($scorm->intro, $scorm->introformat, $options).''; + $headertext .= ''.get_string('summary').':
'.format_module_intro('scorm', $scorm, $scorm->coursemodule).''; print_simple_box($headertext,'','100%'); scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm, '100%'); } else { diff --git a/mod/scorm/mod_form.php b/mod/scorm/mod_form.php index 5bb3a6cb09..cf50882433 100644 --- a/mod/scorm/mod_form.php +++ b/mod/scorm/mod_form.php @@ -30,10 +30,7 @@ class mod_scorm_mod_form extends moodleform_mod { $mform->addRule('name', null, 'required', null, 'client'); // Summary - $mform->addElement('htmleditor', 'intro', get_string('summary')); - $mform->setType('intro', PARAM_RAW); - $mform->addRule('intro', get_string('required'), 'required', null, 'client'); - $mform->setHelpButton('intro', array('writing', 'questions', 'richtext2'), false, 'editorhelpbutton'); + $this->add_intro_editor(true); // Scorm types $options = array(SCORM_TYPE_LOCAL => get_string('typelocal', 'scorm')); diff --git a/mod/scorm/view.php b/mod/scorm/view.php index 29011a4055..134f0967a2 100755 --- a/mod/scorm/view.php +++ b/mod/scorm/view.php @@ -72,11 +72,10 @@ // Print the main part of the page print_heading(format_string($scorm->name)); $attemptstatus = ''; - if($scorm->displayattemptstatus == 1) { + if ($scorm->displayattemptstatus == 1) { $attemptstatus = scorm_get_attempt_status($USER,$scorm); } - $options = (object)array('noclean'=>true); - print_simple_box(format_text($scorm->intro, $scorm->introformat, $options).$attemptstatus, 'center', '70%', '', 5, 'generalbox', 'intro'); + print_simple_box(format_module_intro('scorm', $scorm, $cm->id).$attemptstatus, 'center', '70%', '', 5, 'generalbox', 'intro'); $scormopen = true; $timenow = time(); diff --git a/mod/survey/mod_form.php b/mod/survey/mod_form.php index 68fe5e0a80..79925e98c7 100644 --- a/mod/survey/mod_form.php +++ b/mod/survey/mod_form.php @@ -4,8 +4,8 @@ require_once ($CFG->dirroot.'/course/moodleform_mod.php'); class mod_survey_mod_form extends moodleform_mod { function definition() { - global $CFG, $DB; + $mform =& $this->_form; $strrequired = get_string('required'); @@ -33,9 +33,7 @@ class mod_survey_mod_form extends moodleform_mod { $mform->addRule('template', $strrequired, 'required', null, 'client'); $mform->setHelpButton('template', array('surveys', get_string('helpsurveys', 'survey'))); - - $mform->addElement('textarea', 'intro', get_string('customintro', 'survey'), 'wrap="virtual" rows="20" cols="75"'); - $mform->setType('intro', PARAM_RAW); + $this->add_intro_editor(false, get_string('customintro', 'survey')); $this->standard_coursemodule_elements(); diff --git a/mod/survey/view.php b/mod/survey/view.php index e0f4558588..84c38d10a3 100644 --- a/mod/survey/view.php +++ b/mod/survey/view.php @@ -80,8 +80,7 @@ } else { - $options = (object)array('noclean'=>true); - print_box(format_text($survey->intro, $survey->introformat, $options), 'generalbox', 'intro'); + print_box(format_module_intro('survey', $survey, $cm->id), 'generalbox', 'intro'); print_spacer(30); $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions)); @@ -112,7 +111,7 @@ echo '
'; echo ""; - print_simple_box(format_text($survey->intro), 'center', '70%', '', 5, 'generalbox', 'intro'); + print_simple_box(format_module_intro('survey', $survey, $cm->id), 'center', '70%', '', 5, 'generalbox', 'intro'); // Get all the major questions and their proper order if (! $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions))) { diff --git a/mod/wiki/index.php b/mod/wiki/index.php index 35e1888b54..bbd5890e57 100644 --- a/mod/wiki/index.php +++ b/mod/wiki/index.php @@ -69,7 +69,7 @@ $timmod = ''.userdate($wiki->timemodified).''; $options = (object)array('noclean'=>true); - $summary = '
'.format_text($wiki->intro, $wiki->introformat, $options).'
'; + $summary = '
'.format_module_intro('wiki', $wiki, $wiki->coursemodule).'
'; $site = get_site(); switch ($wiki->wtype) { diff --git a/mod/wiki/mod_form.php b/mod/wiki/mod_form.php index d288f2b258..2127778ced 100644 --- a/mod/wiki/mod_form.php +++ b/mod/wiki/mod_form.php @@ -21,10 +21,7 @@ class mod_wiki_mod_form extends moodleform_mod { $mform->setType('name', PARAM_NOTAGS); $mform->addRule('name', null, 'required', null, 'client'); - $mform->addElement('htmleditor', 'intro', get_string('summary')); - $mform->setType('intro', PARAM_RAW); - $mform->setHelpButton('intro', array('writing', 'questions', 'richtext2'), false, 'editorhelpbutton'); - $mform->addRule('intro', get_string('required'), 'required', null, 'client'); + $this->add_intro_editor(true); if (!$wikihasentries){ asort($WIKI_TYPES); diff --git a/mod/wiki/view.php b/mod/wiki/view.php index 33dccfafed..7ca02b7478 100644 --- a/mod/wiki/view.php +++ b/mod/wiki/view.php @@ -347,8 +347,7 @@ if($wiki_entry && $ewiki_title==$wiki_entry->pagename && !empty($wiki->intro)) { if (trim(strip_tags($wiki->intro))) { - $options = (object)array('noclean'=>true); - print_box(format_text($wiki->intro, $wiki->introformat, $options), 'generalbox', 'intro'); + print_box(format_module_intro('wiki', $wiki, $cm->id), 'generalbox', 'intro'); } } -- 2.39.5