[IMP] survey_extra_fields : handle file question on page navigation
Some checks failed
pre-commit / pre-commit (pull_request) Failing after 1m40s
Some checks failed
pre-commit / pre-commit (pull_request) Failing after 1m40s
* Show a stored file (after navigating back) the same way as a freshly selected one: a "filename + Remove file" chip, input hidden until removal. * Keep the stored file when a page is re-submitted without a new selection (instead of overwriting it with a skipped answer). * "Remove file" now sends a sentinel to actually delete the stored file, so the removal persists across navigation.
This commit is contained in:
@@ -6,8 +6,8 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 18.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-06-10 14:31+0000\n"
|
||||
"PO-Revision-Date: 2026-06-10 14:31+0000\n"
|
||||
"POT-Creation-Date: 2026-06-10 15:03+0000\n"
|
||||
"PO-Revision-Date: 2026-06-10 15:03+0000\n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
@@ -20,6 +20,11 @@ msgstr ""
|
||||
msgid ".pdf,.docx,.xlsx"
|
||||
msgstr ""
|
||||
|
||||
#. module: survey_extra_fields
|
||||
#: model_terms:ir.ui.view,arch_db:survey_extra_fields.question_file
|
||||
msgid "<i class=\"fa fa-times me-1\"/>Remove file"
|
||||
msgstr "<i class=\"fa fa-times me-1\"/>Supprimer le fichier"
|
||||
|
||||
#. module: survey_extra_fields
|
||||
#: model:ir.model.fields,field_description:survey_extra_fields.field_survey_question__allowed_extensions
|
||||
msgid "Allowed Extensions"
|
||||
|
||||
@@ -31,14 +31,25 @@ class SurveyUserInput(models.Model):
|
||||
])
|
||||
if old_answers and not overwrite_existing:
|
||||
raise UserError(_("This answer cannot be overwritten."))
|
||||
if not answer and any(line.value_file for line in old_answers):
|
||||
# No new file was submitted: a file input cannot be pre-filled
|
||||
# by the browser when navigating back to a previous page, so an
|
||||
# empty answer here does not mean the user removed their file.
|
||||
# Keep the previously uploaded file instead of overwriting it
|
||||
# with a skipped answer.
|
||||
return
|
||||
vals = {
|
||||
"user_input_id": self.id,
|
||||
"question_id": question.id,
|
||||
"skipped": False,
|
||||
"answer_type": "file",
|
||||
}
|
||||
if answer:
|
||||
file_data = json.loads(answer)
|
||||
file_data = json.loads(answer) if answer else {}
|
||||
if file_data.get("cleared"):
|
||||
# The user explicitly removed the file: drop the stored data and
|
||||
# mark the line as skipped.
|
||||
vals.update(answer_type=None, skipped=True, value_file=False, value_file_fname=False)
|
||||
elif file_data:
|
||||
file_b64 = file_data.get("data", "")
|
||||
file_name = file_data.get("name", "")
|
||||
self._check_file_constraints(question, file_b64, file_name)
|
||||
|
||||
@@ -5,6 +5,76 @@ import { _t } from "@web/core/l10n/translation";
|
||||
import { rpc } from "@web/core/network/rpc";
|
||||
|
||||
publicWidget.registry.SurveyFormWidget.include({
|
||||
/**
|
||||
* @override
|
||||
* Bind delegated listeners on the form root so they keep working after each
|
||||
* page is re-rendered (the inner content is replaced on navigation, but the
|
||||
* root element persists). They let the user clear a selected file before
|
||||
* submitting the form.
|
||||
*/
|
||||
start: function () {
|
||||
return this._super.apply(this, arguments).then(() => {
|
||||
this.$el.on(
|
||||
"change.surveyExtraFile",
|
||||
'input[data-question-type="file"]',
|
||||
this._onFileInputChange.bind(this)
|
||||
);
|
||||
this.$el.on(
|
||||
"click.surveyExtraFile",
|
||||
".o_survey_file_clear",
|
||||
this._onFileClearClick.bind(this)
|
||||
);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* On selection, show the file "chip" (filename + remove button) and hide the
|
||||
* raw input, so a freshly selected file looks exactly like an already stored
|
||||
* one (rendered server-side when navigating back).
|
||||
*/
|
||||
_onFileInputChange: function (ev) {
|
||||
const input = ev.currentTarget;
|
||||
const container = input.closest(".o_survey_comment_container");
|
||||
if (!container || !(input.files && input.files.length > 0)) {
|
||||
return;
|
||||
}
|
||||
const chip = container.querySelector(".o_survey_file_selected");
|
||||
const nameEl = container.querySelector(".o_survey_file_name");
|
||||
if (nameEl) {
|
||||
nameEl.textContent = input.files[0].name;
|
||||
}
|
||||
if (chip) {
|
||||
chip.classList.remove("d-none");
|
||||
}
|
||||
delete input.dataset.fileCleared;
|
||||
input.classList.add("d-none");
|
||||
},
|
||||
|
||||
/**
|
||||
* Discard the current file: hide the chip and bring back the input so the
|
||||
* user can pick a new one. A file already stored server-side is only really
|
||||
* replaced once a new file is submitted (see _save_lines).
|
||||
*/
|
||||
_onFileClearClick: function (ev) {
|
||||
ev.preventDefault();
|
||||
const container = ev.currentTarget.closest(".o_survey_comment_container");
|
||||
if (!container) {
|
||||
return;
|
||||
}
|
||||
const input = container.querySelector('input[data-question-type="file"]');
|
||||
const chip = container.querySelector(".o_survey_file_selected");
|
||||
if (input) {
|
||||
input.value = "";
|
||||
// Flag the explicit removal so the submit tells the server to drop
|
||||
// any previously stored file (instead of preserving it).
|
||||
input.dataset.fileCleared = "1";
|
||||
input.classList.remove("d-none");
|
||||
}
|
||||
if (chip) {
|
||||
chip.classList.add("d-none");
|
||||
}
|
||||
},
|
||||
|
||||
_readFileAsDataURL: function (file) {
|
||||
return new Promise(function (resolve, reject) {
|
||||
const reader = new FileReader();
|
||||
@@ -27,11 +97,13 @@ publicWidget.registry.SurveyFormWidget.include({
|
||||
*/
|
||||
_submitForm: async function (options) {
|
||||
const fileInputs = this.el.querySelectorAll('input[data-question-type="file"]');
|
||||
const hasFiles = Array.from(fileInputs).some(
|
||||
(input) => input.files && input.files.length > 0
|
||||
// A file action is either a new selection or an explicit removal of a
|
||||
// previously stored file (which must be communicated to the server).
|
||||
const hasFileAction = Array.from(fileInputs).some(
|
||||
(input) => (input.files && input.files.length > 0) || input.dataset.fileCleared
|
||||
);
|
||||
|
||||
if (!hasFiles || this.options.isStartScreen) {
|
||||
if (!hasFileAction || this.options.isStartScreen) {
|
||||
return this._super(options);
|
||||
}
|
||||
|
||||
@@ -53,6 +125,8 @@ publicWidget.registry.SurveyFormWidget.include({
|
||||
this._prepareSubmitValues(formData, params);
|
||||
|
||||
// Read all selected files as base64 and add them to the submit params.
|
||||
// Explicitly cleared inputs (no new file) send a "cleared" sentinel so
|
||||
// the server removes the previously stored file.
|
||||
const filePromises = [];
|
||||
for (const input of fileInputs) {
|
||||
if (input.files && input.files.length > 0) {
|
||||
@@ -66,6 +140,8 @@ publicWidget.registry.SurveyFormWidget.include({
|
||||
});
|
||||
})
|
||||
);
|
||||
} else if (input.dataset.fileCleared) {
|
||||
params[input.name] = JSON.stringify({ cleared: true });
|
||||
}
|
||||
}
|
||||
|
||||
@@ -108,7 +184,15 @@ publicWidget.registry.SurveyFormWidget.include({
|
||||
$questionWrapper.data("constrErrorMsg") ||
|
||||
_t("This question requires an answer.");
|
||||
if (questionRequired && !(this.files && this.files.length > 0)) {
|
||||
// A file may already be stored server-side (e.g. uploaded then
|
||||
// navigating back): the chip is visible even though the input is
|
||||
// empty. Treat that as a valid answer.
|
||||
const container = this.closest(".o_survey_comment_container");
|
||||
const chip = container && container.querySelector(".o_survey_file_selected");
|
||||
const hasExistingFile = chip && !chip.classList.contains("d-none");
|
||||
if (!hasExistingFile) {
|
||||
errors[questionId] = constrErrorMsg;
|
||||
}
|
||||
return;
|
||||
}
|
||||
if (this.files && this.files.length > 0) {
|
||||
|
||||
@@ -94,19 +94,38 @@ class TestSurveyFileSaveLines(TestSurveyFileCommon):
|
||||
self.assertEqual(lines.value_file, new_b64.encode())
|
||||
self.assertEqual(lines.value_file_fname, "second.pdf")
|
||||
|
||||
def test_save_file_then_skip(self):
|
||||
"""Uploading a file then submitting empty marks line as skipped."""
|
||||
def test_save_file_then_empty_keeps_file(self):
|
||||
"""Submitting empty after a file keeps it (file inputs cannot be
|
||||
pre-filled when navigating back, so an empty answer must not erase it)."""
|
||||
answer = self._add_answer(self.survey, self.survey_manager.partner_id)
|
||||
file_json = json.dumps({"data": self.file_b64, "name": self.file_name})
|
||||
answer._save_lines(self.question_file, file_json)
|
||||
|
||||
answer._save_lines(self.question_file, "")
|
||||
|
||||
line = answer.user_input_line_ids.filtered(
|
||||
lambda l: l.question_id == self.question_file
|
||||
)
|
||||
self.assertEqual(len(line), 1)
|
||||
self.assertFalse(line.skipped)
|
||||
self.assertEqual(line.value_file, self.file_b64.encode())
|
||||
self.assertEqual(line.value_file_fname, self.file_name)
|
||||
|
||||
def test_save_file_explicitly_cleared(self):
|
||||
"""Submitting the 'cleared' sentinel after a file removes it."""
|
||||
answer = self._add_answer(self.survey, self.survey_manager.partner_id)
|
||||
file_json = json.dumps({"data": self.file_b64, "name": self.file_name})
|
||||
answer._save_lines(self.question_file, file_json)
|
||||
|
||||
answer._save_lines(self.question_file, json.dumps({"cleared": True}))
|
||||
|
||||
line = answer.user_input_line_ids.filtered(
|
||||
lambda l: l.question_id == self.question_file
|
||||
)
|
||||
self.assertEqual(len(line), 1)
|
||||
self.assertTrue(line.skipped)
|
||||
self.assertFalse(line.value_file)
|
||||
self.assertFalse(line.value_file_fname)
|
||||
|
||||
|
||||
class TestSurveyFileConstraints(TestSurveyFileCommon):
|
||||
|
||||
@@ -15,13 +15,26 @@
|
||||
|
||||
<template id="question_file" name="Question: File">
|
||||
<div class="o_survey_comment_container p-0">
|
||||
<t t-if="survey_form_readonly and answer_lines and answer_lines[0].value_file_fname">
|
||||
<p><t t-out="answer_lines[0].value_file_fname"/></p>
|
||||
<t t-set="existing_fname" t-value="answer_lines and answer_lines[0].value_file_fname"/>
|
||||
<t t-if="survey_form_readonly">
|
||||
<p t-if="existing_fname" class="mb-1">
|
||||
<i class="fa fa-paperclip me-1"/><t t-out="answer_lines[0].value_file_fname"/>
|
||||
</p>
|
||||
</t>
|
||||
<t t-if="not survey_form_readonly">
|
||||
<t t-else="">
|
||||
<!-- Uploaded file display, shown both for a fresh selection and when a
|
||||
file was already stored server-side (e.g. navigating back). The raw
|
||||
file input is hidden until the user clicks "Remove file". -->
|
||||
<span t-attf-class="o_survey_file_selected d-inline-flex align-items-center #{'' if existing_fname else 'd-none'}">
|
||||
<i class="fa fa-paperclip me-1"/>
|
||||
<span class="o_survey_file_name"><t t-out="existing_fname or ''"/></span>
|
||||
<button type="button" class="btn btn-link btn-sm text-danger o_survey_file_clear ms-2 py-0">
|
||||
<i class="fa fa-times me-1"/>Remove file
|
||||
</button>
|
||||
</span>
|
||||
<input
|
||||
type="file"
|
||||
class="o_survey_question_file"
|
||||
t-attf-class="o_survey_question_file #{'d-none' if existing_fname else ''}"
|
||||
t-att-name="question.id"
|
||||
t-att-data-question-type="question.question_type"
|
||||
t-att-accept="question.allowed_extensions or None"
|
||||
|
||||
Reference in New Issue
Block a user