afb52f86fca8e029bc48cb43efef41b49abea4ec
[moodle.git] / question / type / essay / renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Essay question renderer class.
19  *
20  * @package    qtype
21  * @subpackage essay
22  * @copyright  2009 The Open University
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Generates the output for essay questions.
32  *
33  * @copyright  2009 The Open University
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class qtype_essay_renderer extends qtype_renderer {
37     public function formulation_and_controls(question_attempt $qa,
38             question_display_options $options) {
40         $question = $qa->get_question();
41         $responseoutput = $question->get_format_renderer($this->page);
43         // Answer field.
44         $step = $qa->get_last_step_with_qt_var('answer');
45         if (empty($options->readonly)) {
46             $answer = $responseoutput->response_area_input('answer', $qa,
47                     $step, $question->responsefieldlines, $options->context);
49         } else {
50             $answer = $responseoutput->response_area_read_only('answer', $qa,
51                     $step, $question->responsefieldlines, $options->context);
52         }
54         $files = '';
55         if ($question->attachments) {
56             if (empty($options->readonly)) {
57                 $files = $this->files_input($qa, $question->attachments, $options);
59             } else {
60                 $files = $this->files_read_only($qa, $options);
61             }
62         }
64         $result = '';
65         $result .= html_writer::tag('div', $question->format_questiontext($qa),
66                 array('class' => 'qtext'));
68         $result .= html_writer::start_tag('div', array('class' => 'ablock'));
69         $result .= html_writer::tag('div', $answer, array('class' => 'answer'));
70         $result .= html_writer::tag('div', $files, array('class' => 'attachments'));
71         $result .= html_writer::end_tag('div');
73         return $result;
74     }
76     /**
77      * Displays any attached files when the question is in read-only mode.
78      * @param question_attempt $qa the question attempt to display.
79      * @param question_display_options $options controls what should and should
80      *      not be displayed. Used to get the context.
81      */
82     public function files_read_only(question_attempt $qa, question_display_options $options) {
83         $files = $qa->get_last_qt_files('attachments', $options->context->id);
84         $output = array();
86         foreach ($files as $file) {
87             $output[] = html_writer::tag('p', html_writer::link($qa->get_response_file_url($file),
88                     $this->output->pix_icon(file_file_icon($file), get_mimetype_description($file),
89                     'moodle', array('class' => 'icon')) . ' ' . s($file->get_filename())));
90         }
91         return implode($output);
92     }
94     /**
95      * Displays the input control for when the student should upload a single file.
96      * @param question_attempt $qa the question attempt to display.
97      * @param int $numallowed the maximum number of attachments allowed. -1 = unlimited.
98      * @param question_display_options $options controls what should and should
99      *      not be displayed. Used to get the context.
100      */
101     public function files_input(question_attempt $qa, $numallowed,
102             question_display_options $options) {
103         global $CFG;
104         require_once($CFG->dirroot . '/lib/form/filemanager.php');
106         $pickeroptions = new stdClass();
107         $pickeroptions->mainfile = null;
108         $pickeroptions->maxfiles = $numallowed;
109         $pickeroptions->itemid = $qa->prepare_response_files_draft_itemid(
110                 'attachments', $options->context->id);
111         $pickeroptions->context = $options->context;
113         $pickeroptions->itemid = $qa->prepare_response_files_draft_itemid(
114                 'attachments', $options->context->id);
116         return form_filemanager_render($pickeroptions) . html_writer::empty_tag(
117                 'input', array('type' => 'hidden', 'name' => $qa->get_qt_field_name('attachments'),
118                 'value' => $pickeroptions->itemid));
119     }
121     public function manual_comment(question_attempt $qa, question_display_options $options) {
122         if ($options->manualcomment != question_display_options::EDITABLE) {
123             return '';
124         }
126         $question = $qa->get_question();
127         return html_writer::nonempty_tag('div', $question->format_text(
128                 $question->graderinfo, $question->graderinfo, $qa, 'qtype_essay',
129                 'graderinfo', $question->id), array('class' => 'graderinfo'));
130     }
134 /**
135  * A base class to abstract out the differences between different type of
136  * response format.
137  *
138  * @copyright  2011 The Open University
139  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
140  */
141 abstract class qtype_essay_format_renderer_base extends plugin_renderer_base {
142     /**
143      * Render the students respone when the question is in read-only mode.
144      * @param string $name the variable name this input edits.
145      * @param question_attempt $qa the question attempt being display.
146      * @param question_attempt_step $step the current step.
147      * @param int $lines approximate size of input box to display.
148      * @param object $context the context teh output belongs to.
149      * @return string html to display the response.
150      */
151     public abstract function response_area_read_only($name, question_attempt $qa,
152             question_attempt_step $step, $lines, $context);
154     /**
155      * Render the students respone when the question is in read-only mode.
156      * @param string $name the variable name this input edits.
157      * @param question_attempt $qa the question attempt being display.
158      * @param question_attempt_step $step the current step.
159      * @param int $lines approximate size of input box to display.
160      * @param object $context the context teh output belongs to.
161      * @return string html to display the response for editing.
162      */
163     public abstract function response_area_input($name, question_attempt $qa,
164             question_attempt_step $step, $lines, $context);
166     /**
167      * @return string specific class name to add to the input element.
168      */
169     protected abstract function class_name();
173 /**
174  * An essay format renderer for essays where the student should use the HTML
175  * editor without the file picker.
176  *
177  * @copyright  2011 The Open University
178  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
179  */
180 class qtype_essay_format_editor_renderer extends plugin_renderer_base {
181     protected function class_name() {
182         return 'qtype_essay_editor';
183     }
185     public function response_area_read_only($name, $qa, $step, $lines, $context) {
186         return html_writer::tag('div', $this->prepare_response($name, $qa, $step, $context),
187                 array('class' => $this->class_name() . ' qtype_essay_response readonly'));
188     }
190     public function response_area_input($name, $qa, $step, $lines, $context) {
191         global $CFG;
192         require_once($CFG->dirroot . '/repository/lib.php');
194         $inputname = $qa->get_qt_field_name($name);
195         $responseformat = $step->get_qt_var($name . 'format');
196         $id = $inputname . '_id';
198         $editor = editors_get_preferred_editor($responseformat);
199         $strformats = format_text_menu();
200         $formats = $editor->get_supported_formats();
201         foreach ($formats as $fid) {
202             $formats[$fid] = $strformats[$fid];
203         }
205         list($draftitemid, $reponse) = $this->prepare_response_for_editing(
206                 $name, $step, $context);
208         $editor->use_editor($id, $this->get_editor_options($context),
209                 $this->get_filepicker_options($context, $draftitemid));
211         $output = '';
212         $output .= html_writer::start_tag('div', array('class' =>
213                 $this->class_name() . ' qtype_essay_response'));
215         $output .= html_writer::tag('div', html_writer::tag('textarea', s($reponse),
216                 array('id' => $id, 'name' => $inputname, 'rows' => $lines, 'cols' => 60)));
218         $output .= html_writer::start_tag('div');
219         if (count($formats == 1)) {
220             reset($formats);
221             $output .= html_writer::empty_tag('input', array('type' => 'hidden',
222                     'name' => $inputname . 'format', 'value' => key($formats)));
224         } else {
225             $output .= html_writer::select($formats, $inputname . 'format', $responseformat, '');
226         }
227         $output .= html_writer::end_tag('div');
229         $output .= $this->filepicker_html($inputname, $draftitemid);
231         $output .= html_writer::end_tag('div');
232         return $output;
233     }
235     /**
236      * Prepare the response for read-only display.
237      * @param string $name the variable name this input edits.
238      * @param question_attempt $qa the question attempt being display.
239      * @param question_attempt_step $step the current step.
240      * @param object $context the context the attempt belongs to.
241      * @return string the response prepared for display.
242      */
243     protected function prepare_response($name, question_attempt $qa,
244             question_attempt_step $step, $context) {
245         if (!$step->has_qt_var($name)) {
246             return '';
247         }
249         $formatoptions = new stdClass();
250         $formatoptions->para = false;
251         return format_text($step->get_qt_var($name), $step->get_qt_var($name . 'format'),
252                 $formatoptions);
253     }
255     /**
256      * Prepare the response for editing.
257      * @param string $name the variable name this input edits.
258      * @param question_attempt_step $step the current step.
259      * @param object $context the context the attempt belongs to.
260      * @return string the response prepared for display.
261      */
262     protected function prepare_response_for_editing($name,
263             question_attempt_step $step, $context) {
264         return array(0, $step->get_qt_var($name));
265     }
267     /**
268      * @param object $context the context the attempt belongs to.
269      * @return array options for the editor.
270      */
271     protected function get_editor_options($context) {
272         return array('context' => $context);
273     }
275     /**
276      * @param object $context the context the attempt belongs to.
277      * @param int $draftitemid draft item id.
278      * @return array filepicker options for the editor.
279      */
280     protected function get_filepicker_options($context, $draftitemid) {
281         return array();
282     }
284     /**
285      * @param string $inputname input field name.
286      * @param int $draftitemid draft file area itemid.
287      * @return string HTML for the filepicker, if used.
288      */
289     protected function filepicker_html($inputname, $draftitemid) {
290         return '';
291     }
295 /**
296  * An essay format renderer for essays where the student should use the HTML
297  * editor with the file picker.
298  *
299  * @copyright  2011 The Open University
300  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
301  */
302 class qtype_essay_format_editorfilepicker_renderer extends qtype_essay_format_editor_renderer {
303     protected function class_name() {
304         return 'qtype_essay_editorfilepicker';
305     }
307     protected function prepare_response($name, question_attempt $qa,
308             question_attempt_step $step, $context) {
309         if (!$step->has_qt_var($name)) {
310             return '';
311         }
313         $formatoptions = new stdClass();
314         $formatoptions->para = false;
315         $text = $qa->rewrite_response_pluginfile_urls($step->get_qt_var($name),
316                 $context->id, 'answer', $step);
317         return format_text($text, $step->get_qt_var($name . 'format'), $formatoptions);
318     }
320     protected function prepare_response_for_editing($name,
321             question_attempt_step $step, $context) {
322         return $step->prepare_response_files_draft_itemid_with_text(
323                 $name, $context->id, $step->get_qt_var($name));
324     }
326     protected function get_editor_options($context) {
327         return array(
328             'subdirs' => 0,
329             'maxbytes' => 0,
330             'maxfiles' => -1,
331             'context' => $context,
332             'noclean' => 0,
333             'trusttext'=>0
334         );
335     }
337     /**
338      * Get the options required to configure the filepicker for one of the editor
339      * toolbar buttons.
340      * @param mixed $acceptedtypes array of types of '*'.
341      * @param int $draftitemid the draft area item id.
342      * @param object $context the context.
343      * @return object the required options.
344      */
345     protected function specific_filepicker_options($acceptedtypes, $draftitemid, $context) {
346         $filepickeroptions = new stdClass();
347         $filepickeroptions->accepted_types = $acceptedtypes;
348         $filepickeroptions->return_types = FILE_INTERNAL | FILE_EXTERNAL;
349         $filepickeroptions->context = $context;
350         $filepickeroptions->env = 'filepicker';
352         $options = initialise_filepicker($filepickeroptions);
353         $options->context = $context;
354         $options->client_id = uniqid();
355         $options->env = 'editor';
356         $options->itemid = $draftitemid;
358         return $options;
359     }
361     protected function get_filepicker_options($context, $draftitemid) {
362         global $CFG;
364         return array(
365             'image' => $this->specific_filepicker_options(array('image'),
366                             $draftitemid, $context),
367             'media' => $this->specific_filepicker_options(array('video', 'audio'),
368                             $draftitemid, $context),
369             'link'  => $this->specific_filepicker_options('*',
370                             $draftitemid, $context),
371         );
372     }
374     protected function filepicker_html($inputname, $draftitemid) {
375         $nonjspickerurl = new moodle_url('/repository/draftfiles_manager.php', array(
376             'action' => 'browse',
377             'env' => 'editor',
378             'itemid' => $draftitemid,
379             'subdirs' => false,
380             'maxfiles' => -1,
381             'sesskey' => sesskey(),
382         ));
384         return html_writer::empty_tag('input', array('type' => 'hidden',
385                 'name' => $inputname . ':itemid', 'value' => $draftitemid)) .
386                 html_writer::tag('noscript', html_writer::tag('div',
387                     html_writer::tag('object', '', array('type' => 'text/html',
388                         'data' => $nonjspickerurl, 'height' => 160, 'width' => 600,
389                         'style' => 'border: 1px solid #000;'))));
390     }
394 /**
395  * An essay format renderer for essays where the student should use a plain
396  * input box, but with a normal, proportional font.
397  *
398  * @copyright  2011 The Open University
399  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
400  */
401 class qtype_essay_format_plain_renderer extends plugin_renderer_base {
402     /**
403      * @return string the HTML for the textarea.
404      */
405     protected function textarea($response, $lines, $attributes) {
406         $attributes['class'] = $this->class_name() . ' qtype_essay_response';
407         $attributes['rows'] = $lines;
408         $attributes['cols'] = 60;
409         return html_writer::tag('textarea', s($response), $attributes);
410     }
412     protected function class_name() {
413         return 'qtype_essay_plain';
414     }
416     public function response_area_read_only($name, $qa, $step, $lines, $context) {
417         return $this->textarea($step->get_qt_var($name), $lines, array('readonly' => 'readonly'));
418     }
420     public function response_area_input($name, $qa, $step, $lines, $context) {
421         $inputname = $qa->get_qt_field_name($name);
422         return $this->textarea($step->get_qt_var($name), $lines, array('name' => $inputname)) .
423                 html_writer::empty_tag('input', array('type' => 'hidden',
424                     'name' => $inputname . 'format', 'value' => FORMAT_PLAIN));
425     }
429 /**
430  * An essay format renderer for essays where the student should use a plain
431  * input box with a monospaced font. You might use this, for example, for a
432  * question where the students should type computer code.
433  *
434  * @copyright  2011 The Open University
435  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
436  */
437 class qtype_essay_format_monospaced_renderer extends qtype_essay_format_plain_renderer {
438     protected function class_name() {
439         return 'qtype_essay_monospaced';
440     }