Merge branch 'MDL-70242-310' of git://github.com/marinaglancy/moodle into MOODLE_310_...
[moodle.git] / question / type / essay / question.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 definition 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();
29 require_once($CFG->dirroot . '/question/type/questionbase.php');
31 /**
32  * Represents an essay question.
33  *
34  * @copyright  2009 The Open University
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class qtype_essay_question extends question_with_responses {
39     public $responseformat;
41     /** @var int Indicates whether an inline response is required ('0') or optional ('1')  */
42     public $responserequired;
44     public $responsefieldlines;
45     public $attachments;
47     /** @var int maximum file size in bytes */
48     public $maxbytes;
50     /** @var int The number of attachments required for a response to be complete. */
51     public $attachmentsrequired;
53     public $graderinfo;
54     public $graderinfoformat;
55     public $responsetemplate;
56     public $responsetemplateformat;
58     /** @var array The string array of file types accepted upon file submission. */
59     public $filetypeslist;
61     public function make_behaviour(question_attempt $qa, $preferredbehaviour) {
62         return question_engine::make_behaviour('manualgraded', $qa, $preferredbehaviour);
63     }
65     /**
66      * @param moodle_page the page we are outputting to.
67      * @return qtype_essay_format_renderer_base the response-format-specific renderer.
68      */
69     public function get_format_renderer(moodle_page $page) {
70         return $page->get_renderer('qtype_essay', 'format_' . $this->responseformat);
71     }
73     public function get_expected_data() {
74         if ($this->responseformat == 'editorfilepicker') {
75             $expecteddata = array('answer' => question_attempt::PARAM_RAW_FILES);
76         } else {
77             $expecteddata = array('answer' => PARAM_RAW);
78         }
79         $expecteddata['answerformat'] = PARAM_ALPHANUMEXT;
80         if ($this->attachments != 0) {
81             $expecteddata['attachments'] = question_attempt::PARAM_FILES;
82         }
83         return $expecteddata;
84     }
86     public function summarise_response(array $response) {
87         if (isset($response['answer'])) {
88             return question_utils::to_plain_text($response['answer'],
89                     $response['answerformat'], array('para' => false));
90         } else {
91             return null;
92         }
93     }
95     public function un_summarise_response(string $summary) {
96         if (!empty($summary)) {
97             return ['answer' => text_to_html($summary)];
98         } else {
99             return [];
100         }
101     }
103     public function get_correct_response() {
104         return null;
105     }
107     public function is_complete_response(array $response) {
108         // Determine if the given response has online text and attachments.
109         $hasinlinetext = array_key_exists('answer', $response) && ($response['answer'] !== '');
110         $hasattachments = array_key_exists('attachments', $response)
111             && $response['attachments'] instanceof question_response_files;
113         // Determine the number of attachments present.
114         if ($hasattachments) {
115             // Check the filetypes.
116             $filetypesutil = new \core_form\filetypes_util();
117             $allowlist = $filetypesutil->normalize_file_types($this->filetypeslist);
118             $wrongfiles = array();
119             foreach ($response['attachments']->get_files() as $file) {
120                 if (!$filetypesutil->is_allowed_file_type($file->get_filename(), $allowlist)) {
121                     $wrongfiles[] = $file->get_filename();
122                 }
123             }
124             if ($wrongfiles) { // At least one filetype is wrong.
125                 return false;
126             }
127             $attachcount = count($response['attachments']->get_files());
128         } else {
129             $attachcount = 0;
130         }
132         // Determine if we have /some/ content to be graded.
133         $hascontent = $hasinlinetext || ($attachcount > 0);
135         // Determine if we meet the optional requirements.
136         $meetsinlinereq = $hasinlinetext || (!$this->responserequired) || ($this->responseformat == 'noinline');
137         $meetsattachmentreq = ($attachcount >= $this->attachmentsrequired);
139         // The response is complete iff all of our requirements are met.
140         return $hascontent && $meetsinlinereq && $meetsattachmentreq;
141     }
143     public function is_gradable_response(array $response) {
144         // Determine if the given response has online text and attachments.
145         if (array_key_exists('answer', $response) && ($response['answer'] !== '')) {
146             return true;
147         } else if (array_key_exists('attachments', $response)
148                 && $response['attachments'] instanceof question_response_files) {
149             return true;
150         } else {
151             return false;
152         }
153     }
155     public function is_same_response(array $prevresponse, array $newresponse) {
156         if (array_key_exists('answer', $prevresponse) && $prevresponse['answer'] !== $this->responsetemplate) {
157             $value1 = (string) $prevresponse['answer'];
158         } else {
159             $value1 = '';
160         }
161         if (array_key_exists('answer', $newresponse) && $newresponse['answer'] !== $this->responsetemplate) {
162             $value2 = (string) $newresponse['answer'];
163         } else {
164             $value2 = '';
165         }
166         return $value1 === $value2 && ($this->attachments == 0 ||
167                 question_utils::arrays_same_at_key_missing_is_blank(
168                 $prevresponse, $newresponse, 'attachments'));
169     }
171     public function check_file_access($qa, $options, $component, $filearea, $args, $forcedownload) {
172         if ($component == 'question' && $filearea == 'response_attachments') {
173             // Response attachments visible if the question has them.
174             return $this->attachments != 0;
176         } else if ($component == 'question' && $filearea == 'response_answer') {
177             // Response attachments visible if the question has them.
178             return $this->responseformat === 'editorfilepicker';
180         } else if ($component == 'qtype_essay' && $filearea == 'graderinfo') {
181             return $options->manualcomment && $args[0] == $this->id;
183         } else {
184             return parent::check_file_access($qa, $options, $component,
185                     $filearea, $args, $forcedownload);
186         }
187     }
189     /**
190      * Return the question settings that define this question as structured data.
191      *
192      * @param question_attempt $qa the current attempt for which we are exporting the settings.
193      * @param question_display_options $options the question display options which say which aspects of the question
194      * should be visible.
195      * @return mixed structure representing the question settings. In web services, this will be JSON-encoded.
196      */
197     public function get_question_definition_for_external_rendering(question_attempt $qa, question_display_options $options) {
198         // This is a partial implementation, returning only the most relevant question settings for now,
199         // ideally, we should return as much as settings as possible (depending on the state and display options).
201         $settings = [
202             'responseformat' => $this->responseformat,
203             'responserequired' => $this->responserequired,
204             'responsefieldlines' => $this->responsefieldlines,
205             'attachments' => $this->attachments,
206             'attachmentsrequired' => $this->attachmentsrequired,
207             'maxbytes' => $this->maxbytes,
208             'filetypeslist' => $this->filetypeslist,
209             'responsetemplate' => $this->responsetemplate,
210             'responsetemplateformat' => $this->responsetemplateformat,
211         ];
213         return $settings;
214     }