Make the file upload work with required setting, fix delete of records

Author: srobotta

classes/question/file.php

@@ -70,20 +70,25 @@ protected function responseclass() {
     /**
      * Survey display output.
      *
-     * @param \stdClass $formdata
+     * @param response $response
      * @param object $descendantsdata
      * @param bool $blankquestionnaire
      * @return string
      */
-    protected function question_survey_display($formdata, $descendantsdata, $blankquestionnaire = false) {
+    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire = false) {
         global $CFG, $PAGE;
         require_once($CFG->libdir . '/filelib.php');
+
         $elname = 'q' . $this->id;
-        $draftitemid = file_get_submitted_draft_itemid($elname);
-        $component = 'mod_questionnaire';
+        // Make sure there is a response, fetch the draft id from the original request.
+        if (isset($response->answers[$this->id]) && !empty($response->answers[$this->id]) && isset($_REQUEST[$elname . 'draft'])) {
+            $draftitemid = (int)$_REQUEST[$elname . 'draft'];
+        } else {
+            $draftitemid = file_get_submitted_draft_itemid($elname);
+        }
         $options = self::get_file_manager_option();
         if ($draftitemid > 0) {
-            file_prepare_draft_area($draftitemid, $this->context->id, $component, 'file', $this->id, $options);
+            file_prepare_draft_area($draftitemid, $this->context->id, 'mod_questionnaire', 'file', $this->id, $options);
         } else {
             $draftitemid = file_get_unused_draft_itemid();
         }
@@ -101,14 +106,40 @@ protected function question_survey_display($formdata, $descendantsdata, $blankqu
         );
         $fm = new form_filemanager((object) $fmoptions);
         $output = $PAGE->get_renderer('core', 'files');
-        $html = $output->render($fm);
 
-        $html .= '<input value="' . $draftitemid . '" name="' . $elname . '" type="hidden" />';
-        $html .= '<input value="" id="' . $this->id . '" type="hidden" />';
+        $html = '<div class="form-filemanager" data-fieldtype="filemanager">' .
+            $output->render($fm) .
+            '<input type="hidden" name="' . $elname . '" value="' . $draftitemid . '" />' .
+            '<input type="hidden" name="' . $elname . 'draft" value="' . $draftitemid . '" />' .
+            '</div>';
 
         return $html;
     }
 
+    /**
+     * Check question's form data for complete response.
+     * @param \stdClass $responsedata The data entered into the response.
+     * @return bool
+     */
+    public function response_complete($responsedata) {
+        $answered = false;
+        // If $responsedata is a response object, look through the answers.
+        if (is_a($responsedata, 'mod_questionnaire\responsetype\response\response') &&
+            isset($responsedata->answers[$this->id]) && !empty($responsedata->answers[$this->id])
+        ) {
+            $answer = reset($responsedata->answers[$this->id]);
+            $answered = ((int)$answer->value > 0);
+        // If $responsedata is webform data, check that it is not empty.
+        } else if (isset($responsedata->{'q'.$this->id})) {
+            $draftitemid = (int)$responsedata->{'q' . $this->id};
+            if ($draftitemid > 0) {
+                $info = file_get_draft_area_info($draftitemid);
+                $answered = $info['filecount'] > 0;
+            }
+        }
+        return !($this->required() && ($this->deleted == 'n') && !$answered);
+    }
+
     /**
      * Get file manager options
      *

classes/responsetype/file.php

@@ -55,6 +55,8 @@ public static function answers_from_webform($responsedata, $question) {
                 $file = reset($files);
                 $record->value = $file->get_id();
                 $answers[] = answer\answer::create_from_data($record);
+            } else {
+                self::delete_old_response((int)$question->id, (int)$record->responseid);
             }
         }
         return $answers;
@@ -114,11 +116,34 @@ public static function response_answers_by_question($rid) {
         return $answers;
     }
 
+    /**
+     * Delete old entries from the questionnaire_response_file table and also the corresponding entries
+     * in the files table.
+     * @param int $question_id
+     * @param int $response_id
+     * @return void
+     * @throws \dml_exception
+     */
+    public static function delete_old_response(int $question_id, int $response_id) {
+        global $DB;
+        // Check, if we have an old response file from a former attempt.
+        $record = $DB->get_record(static::response_table(), [
+            'response_id' => $response_id,
+            'question_id' => $question_id,
+        ]);
+        if ($record) {
+            // Old record found, then delete all referenced entries in the files table and then delete this entry.
+            $DB->delete_records('files', ['component' => 'mod_questionnaire', 'itemid' => $record->itemid]);
+            $DB->delete_records(self::response_table(), ['id' => $record->id]);
+        }
+    }
+
     /**
      * Insert a provided response to the question.
      *
      * @param \mod_questionnaire\responsetype\response\response|\stdClass $responsedata
      * @return bool|int
+     * @throws \dml_exception
      */
     public function insert_response($responsedata) {
         global $DB;
@@ -135,6 +160,9 @@ public function insert_response($responsedata) {
             $record->question_id = $this->question->id;
             $record->fileid = intval(clean_text($response->answers[$this->question->id][0]->value));
 
+            // Delete any previous attempts.
+            self::delete_old_response((int)$this->question->id, (int)$response->id);
+
             // When saving the draft file, the itemid was the same as the draftitemid. This must now be
             // corrected to the primary key that is questionaire_response_file.id to have a correct reference.
             $recordid = $DB->insert_record(static::response_table(), $record);

locallib.php

@@ -317,13 +317,14 @@ function questionnaire_delete_response($response, $questionnaire='') {
     }
 
     // Delete all of the response data for a response.
-    $DB->delete_records('questionnaire_response_bool', array('response_id' => $rid));
-    $DB->delete_records('questionnaire_response_date', array('response_id' => $rid));
-    $DB->delete_records('questionnaire_resp_multiple', array('response_id' => $rid));
-    $DB->delete_records('questionnaire_response_other', array('response_id' => $rid));
-    $DB->delete_records('questionnaire_response_rank', array('response_id' => $rid));
-    $DB->delete_records('questionnaire_resp_single', array('response_id' => $rid));
-    $DB->delete_records('questionnaire_response_text', array('response_id' => $rid));
+    $DB->delete_records('questionnaire_response_bool', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_response_date', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_resp_multiple', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_response_other', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_response_rank', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_resp_single', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_response_text', ['response_id' => $rid]);
+    $DB->delete_records('questionnaire_response_file', ['response_id' => $rid]);
 
     $status = $status && $DB->delete_records('questionnaire_response', array('id' => $rid));
 
@@ -354,6 +355,7 @@ function questionnaire_delete_responses($qid) {
     $DB->delete_records('questionnaire_response_rank', ['question_id' => $qid]);
     $DB->delete_records('questionnaire_resp_single', ['question_id' => $qid]);
     $DB->delete_records('questionnaire_response_text', ['question_id' => $qid]);
+    $DB->delete_records('questionnaire_response_file', ['question_id' => $qid]);
 
     return true;
 }