[ADD] survey_extra_fields : file question type

survey_extra_fields/__init__.py

@@ -0,0 +1,2 @@
+from . import controllers
+from . import models

survey_extra_fields/__manifest__.py

@@ -0,0 +1,27 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "Survey extra fields",
+    "summary": "Add extra question types to surveys",
+    "description": """
+Add extra question types to surveys:
+----------------------------------------------------
+* File upload question type
+""",
+    "version": "16.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "Elabore",
+    "website": "https://www.elabore.coop",
+    "category": "",
+    "depends": ["survey_base"],
+    "data": [
+        "views/survey_templates.xml",
+        "views/survey_user_views.xml",
+    ],
+    "assets": {
+        "survey.survey_assets": [
+            "/survey_extra_fields/static/src/js/survey_form.js",
+        ],
+    },
+    "installable": True,
+}

survey_extra_fields/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

survey_extra_fields/controllers/main.py

@@ -0,0 +1,49 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+
+import base64
+
+from odoo import http
+from odoo.http import request, content_disposition
+from odoo.addons.survey.controllers.main import Survey
+
+
+class SurveyExtraFieldsController(Survey):
+
+    @http.route(
+        "/survey/file/<string:survey_token>/<string:answer_token>/<int:line_id>",
+        type="http",
+        auth="public",
+    )
+    def survey_file_download(self, survey_token, answer_token, line_id, **kwargs):
+        survey = request.env["survey.survey"].sudo().search(
+            [("access_token", "=", survey_token)], limit=1
+        )
+        if not survey:
+            return request.not_found()
+
+        answer = request.env["survey.user_input"].sudo().search(
+            [
+                ("survey_id", "=", survey.id),
+                ("access_token", "=", answer_token),
+            ],
+            limit=1,
+        )
+        if not answer:
+            return request.not_found()
+
+        line = request.env["survey.user_input.line"].sudo().browse(line_id)
+        if not line.exists() or line.user_input_id != answer:
+            return request.not_found()
+
+        if not line.value_file:
+            return request.not_found()
+
+        file_content = base64.b64decode(line.value_file)
+        filename = line.value_file_fname or "file"
+        return request.make_response(
+            file_content,
+            headers=[
+                ("Content-Type", "application/octet-stream"),
+                ("Content-Disposition", content_disposition(filename)),
+            ],
+        )

survey_extra_fields/i18n/fr.po

@@ -0,0 +1,27 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* survey_extra_fields
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-01-01 00:00+0000\n"
+"PO-Revision-Date: 2024-01-01 00:00+0000\n"
+"Last-Translator: \n"
+"Language-Team: French\n"
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#. module: survey_extra_fields
+#: model:ir.model.fields.selection,name:survey_extra_fields.selection__survey_question__question_type__file
+msgid "File"
+msgstr "Fichier"
+
+#. module: survey_extra_fields
+#: model:ir.model.fields.selection,name:survey_extra_fields.selection__survey_user_input_line__answer_type__file
+msgid "File"
+msgstr "Fichier"

survey_extra_fields/models/__init__.py

@@ -0,0 +1,3 @@
+from . import survey_question
+from . import survey_user_input
+from . import survey_user_input_line

survey_extra_fields/models/survey_question.py

@@ -0,0 +1,11 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+
+from odoo import fields, models
+
+
+class SurveyQuestion(models.Model):
+    _inherit = "survey.question"
+
+    question_type = fields.Selection(
+        selection_add=[("file", "File")]
+    )

survey_extra_fields/models/survey_user_input.py

@@ -0,0 +1,34 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+
+import json
+
+from odoo import models
+
+
+class SurveyUserInput(models.Model):
+    _inherit = "survey.user_input"
+
+    def save_lines(self, question, answer, comment=None):
+        if question.question_type == "file":
+            old_answers = self.env["survey.user_input.line"].search([
+                ("user_input_id", "=", self.id),
+                ("question_id", "=", question.id),
+            ])
+            vals = {
+                "user_input_id": self.id,
+                "question_id": question.id,
+                "skipped": False,
+                "answer_type": "file",
+            }
+            if answer:
+                file_data = json.loads(answer)
+                vals["value_file"] = file_data.get("data")
+                vals["value_file_fname"] = file_data.get("name")
+            else:
+                vals.update(answer_type=None, skipped=True)
+            if old_answers:
+                old_answers.write(vals)
+            else:
+                self.env["survey.user_input.line"].create(vals)
+        else:
+            return super().save_lines(question, answer, comment=comment)

survey_extra_fields/models/survey_user_input_line.py

@@ -0,0 +1,17 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+
+from odoo import fields, models
+
+
+class SurveyUserInputLine(models.Model):
+    _inherit = "survey.user_input.line"
+
+    answer_type = fields.Selection(
+        selection_add=[("file", "File")]
+    )
+
+    def _compute_display_name(self):
+        super()._compute_display_name()
+        for line in self:
+            if line.answer_type == "file" and line.value_file_fname:
+                line.display_name = line.value_file_fname

survey_extra_fields/static/src/js/survey_form.js

@@ -0,0 +1,121 @@
+odoo.define("survey_extra_fields.survey_form", function (require) {
+    "use strict";
+
+    var core = require("web.core");
+    var _t = core._t;
+    var survey_form = require("survey.form");
+
+    survey_form.include({
+        _readFileAsDataURL: function (file) {
+            return new Promise(function (resolve, reject) {
+                var reader = new FileReader();
+                reader.onload = function (e) {
+                    resolve(e.target.result);
+                };
+                reader.onerror = function () {
+                    reject(reader.error);
+                };
+                reader.readAsDataURL(file);
+            });
+        },
+
+        _submitForm: function (options) {
+            var self = this;
+            var $fileInputs = this.$('input[data-question-type="file"]');
+            var hasFiles = false;
+            $fileInputs.each(function () {
+                if (this.files && this.files.length > 0) {
+                    hasFiles = true;
+                    return false;
+                }
+            });
+
+            if (!hasFiles || this.options.isStartScreen) {
+                return this._super(options);
+            }
+
+            // Async flow: read files then submit
+            var params = {};
+            if (options.previousPageId) {
+                params.previous_page_id = options.previousPageId;
+            }
+
+            var $form = this.$("form");
+            var formData = new FormData($form[0]);
+
+            if (!options.skipValidation) {
+                if (!this._validateForm($form, formData)) {
+                    return;
+                }
+            }
+
+            this._prepareSubmitValues(formData, params);
+
+            // Read all selected files as base64
+            var filePromises = [];
+            $fileInputs.each(function () {
+                if (this.files && this.files.length > 0) {
+                    var file = this.files[0];
+                    var name = this.name;
+                    filePromises.push(
+                        self._readFileAsDataURL(file).then(function (dataURL) {
+                            params[name] = JSON.stringify({
+                                data: dataURL.split(",")[1],
+                                name: file.name,
+                            });
+                        })
+                    );
+                }
+            });
+
+            this.preventEnterSubmit = true;
+
+            if (this.options.sessionInProgress) {
+                this.fadeInOutDelay = 400;
+                this.readonly = true;
+            }
+
+            Promise.all(filePromises).then(function () {
+                var submitPromise = self._rpc({
+                    route: _.str.sprintf(
+                        "%s/%s/%s",
+                        "/survey/submit",
+                        self.options.surveyToken,
+                        self.options.answerToken
+                    ),
+                    params: params,
+                });
+                self._nextScreen(submitPromise, options);
+            });
+        },
+
+        _validateForm: function ($form, formData) {
+            var result = this._super.apply(this, arguments);
+            var errors = {};
+            var inactiveQuestionIds = this.options.sessionInProgress
+                ? []
+                : this._getInactiveConditionalQuestionIds();
+
+            $form.find('input[data-question-type="file"]').each(function () {
+                var $questionWrapper = $(this).closest(".js_question-wrapper");
+                var questionId = $questionWrapper.attr("id");
+                if (inactiveQuestionIds.includes(parseInt(questionId))) {
+                    return;
+                }
+                var questionRequired = $questionWrapper.data("required");
+                var constrErrorMsg =
+                    $questionWrapper.data("constrErrorMsg") ||
+                    _t("This question requires an answer.");
+                if (questionRequired && !(this.files && this.files.length > 0)) {
+                    errors[questionId] = constrErrorMsg;
+                }
+            });
+
+            if (_.keys(errors).length > 0) {
+                this._showErrors(errors);
+                return false;
+            }
+            return result;
+        },
+    });
+});

survey_extra_fields/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_survey_file

survey_extra_fields/tests/test_survey_file.py

@@ -0,0 +1,212 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+
+import base64
+import json
+from unittest.mock import patch, MagicMock
+
+from werkzeug.exceptions import NotFound
+from werkzeug.wrappers import Response
+
+from odoo.addons.survey.tests import common
+
+
+class TestSurveyFileCommon(common.TestSurveyCommon):
+    def setUp(self):
+        super().setUp()
+        self.file_content = b"Hello, this is a test file."
+        self.file_b64 = base64.b64encode(self.file_content).decode()
+        self.file_name = "test_document.pdf"
+
+        self.question_file = self._add_question(
+            self.page_0,
+            "Upload your document",
+            "file",
+            constr_mandatory=False,
+            survey_id=self.survey.id,
+        )
+        self.question_file_required = self._add_question(
+            self.page_0,
+            "Upload your required document",
+            "file",
+            constr_mandatory=True,
+            survey_id=self.survey.id,
+        )
+
+    def _create_answer_with_file(self):
+        answer = self._add_answer(self.survey, False, email="test@example.com")
+        line = self.env["survey.user_input.line"].create({
+            "user_input_id": answer.id,
+            "question_id": self.question_file.id,
+            "answer_type": "file",
+            "skipped": False,
+            "value_file": self.file_b64,
+            "value_file_fname": self.file_name,
+        })
+        return answer, line
+
+
+class TestSurveyFileSaveLines(TestSurveyFileCommon):
+    """Test the save_lines method for file question type."""
+
+    def test_save_file_answer(self):
+        """Submitting a file stores base64 data and filename."""
+        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)
+
+        line = answer.user_input_line_ids.filtered(
+            lambda l: l.question_id == self.question_file
+        )
+        self.assertEqual(len(line), 1)
+        self.assertEqual(line.answer_type, "file")
+        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_skipped(self):
+        """Submitting empty answer marks the line as skipped."""
+        answer = self._add_answer(self.survey, self.survey_manager.partner_id)
+
+        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.assertTrue(line.skipped)
+        self.assertFalse(line.answer_type)
+
+    def test_save_file_update_existing(self):
+        """Submitting a new file updates the existing answer line."""
+        answer = self._add_answer(self.survey, self.survey_manager.partner_id)
+        file_json_1 = json.dumps({"data": self.file_b64, "name": "first.pdf"})
+        answer.save_lines(self.question_file, file_json_1)
+
+        new_b64 = base64.b64encode(b"Updated content").decode()
+        file_json_2 = json.dumps({"data": new_b64, "name": "second.pdf"})
+        answer.save_lines(self.question_file, file_json_2)
+
+        lines = answer.user_input_line_ids.filtered(
+            lambda l: l.question_id == self.question_file
+        )
+        self.assertEqual(len(lines), 1, "Should update, not create a second line")
+        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."""
+        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.assertTrue(line.skipped)
+
+
+class TestSurveyFileDisplayName(TestSurveyFileCommon):
+    """Test the display_name computation for file answer lines."""
+
+    def test_display_name_filename(self):
+        answer = self._add_answer(self.survey, self.survey_manager.partner_id)
+        line = self.env["survey.user_input.line"].create({
+            "user_input_id": answer.id,
+            "question_id": self.question_file.id,
+            "answer_type": "file",
+            "skipped": False,
+            "value_file": self.file_b64,
+            "value_file_fname": "my_filename.pdf",
+        })
+        self.assertEqual(line.display_name, "my_filename.pdf")
+
+
+class TestSurveyFileDownloadController(TestSurveyFileCommon):
+    """Test the file download controller logic with mocked request."""
+
+    def _call_download(self, survey_token, answer_token, line_id):
+        """Call the controller method with a mocked request context."""
+        from odoo.addons.survey_extra_fields.controllers.main import (
+            SurveyExtraFieldsController,
+        )
+
+        mock_request = MagicMock()
+        mock_request.env = self.env
+        mock_request.not_found.return_value = NotFound()
+        mock_request.make_response.side_effect = (
+            lambda content, headers=None: Response(content, headers=headers)
+        )
+
+        controller = SurveyExtraFieldsController()
+        with patch(
+            "odoo.addons.survey_extra_fields.controllers.main.request",
+            mock_request,
+        ):
+            try:
+                return controller.survey_file_download(
+                    survey_token, answer_token, line_id
+                )
+            except NotFound:
+                return NotFound()
+
+    def test_download_valid(self):
+        """Valid tokens return the file content."""
+        answer, line = self._create_answer_with_file()
+
+        response = self._call_download(
+            self.survey.access_token, answer.access_token, line.id
+        )
+
+        self.assertIsInstance(response, Response)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data, self.file_content)
+
+    def test_download_invalid_survey_token(self):
+        """Invalid survey token returns not_found."""
+        answer, line = self._create_answer_with_file()
+
+        response = self._call_download(
+            "invalid-token", answer.access_token, line.id
+        )
+
+        self.assertIsInstance(response, NotFound)
+
+    def test_download_invalid_answer_token(self):
+        """Invalid answer token returns not_found."""
+        answer, line = self._create_answer_with_file()
+
+        response = self._call_download(
+            self.survey.access_token, "invalid-token", line.id
+        )
+
+        self.assertIsInstance(response, NotFound)
+
+    def test_download_line_not_belonging_to_answer(self):
+        """Accessing a line from another answer returns not_found."""
+        answer, line = self._create_answer_with_file()
+        other_answer = self._add_answer(self.survey, False, email="other@example.com")
+
+        response = self._call_download(
+            self.survey.access_token, other_answer.access_token, line.id
+        )
+
+        self.assertIsInstance(response, NotFound)
+
+    def test_download_no_file(self):
+        """Accessing a line without file data returns not_found."""
+        answer = self._add_answer(self.survey, False, email="test@example.com")
+        line = self.env["survey.user_input.line"].create({
+            "user_input_id": answer.id,
+            "question_id": self.question_file.id,
+            "skipped": True,
+        })
+
+        response = self._call_download(
+            self.survey.access_token, answer.access_token, line.id
+        )
+
+        self.assertIsInstance(response, NotFound)

survey_extra_fields/views/survey_templates.xml

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <!-- Extend question_container (form view during survey filling) -->
+    <template
+        id="question_container_inh_type_file"
+        inherit_id="survey.question_container"
+    >
+        <xpath expr="//t[@t-call='survey.question_matrix']/.." position="after">
+            <t t-if="question.question_type == 'file'">
+                <t t-call="survey_extra_fields.question_file"/>
+            </t>
+        </xpath>
+    </template>
+
+    <template id="question_file" name="Question: File">
+        <div class="o_survey_comment_container p-0">
+            <t t-if="answer_lines and answer_lines[0].value_file_fname">
+                <p><t t-out="answer_lines[0].value_file_fname"/></p>
+            </t>
+            <t t-if="not survey_form_readonly">
+                <input
+                    type="file"
+                    class="o_survey_question_file"
+                    t-att-name="question.id"
+                    t-att-data-question-type="question.question_type"
+                />
+            </t>
+        </div>
+    </template>
+
+    <!-- Extend print/review page to show file answers -->
+    <template
+        id="survey_page_print_inh_type_file"
+        inherit_id="survey.survey_page_print"
+    >
+        <xpath expr="//div[hasclass('o_survey_question_error')]" position="before">
+            <t t-if="question.question_type == 'file'">
+                <t t-if="answer_lines">
+                    <t t-set="answer_line" t-value="answer_lines[0]"/>
+                    <t t-if="answer_line.skipped">
+                        <div class="row g-0">
+                            <div class="col-12 col-md-6 col-lg-4 rounded ps-4 o_survey_question_skipped">
+                                <input type="text"
+                                    class="form-control fst-italic o_survey_question_file bg-transparent rounded-0 p-0"
+                                    value="Skipped"/>
+                            </div>
+                        </div>
+                    </t>
+                    <t t-elif="answer_line.value_file_fname">
+                        <div class="row g-0">
+                            <div class="col-12 col-md-6 col-lg-4">
+                                <a t-attf-href="/survey/file/#{survey.access_token}/#{answer.access_token}/#{answer_line.id}"
+                                   target="_blank">
+                                    <i class="fa fa-download me-1"/><t t-out="answer_line.value_file_fname"/>
+                                </a>
+                            </div>
+                        </div>
+                    </t>
+                </t>
+            </t>
+        </xpath>
+    </template>
+
+</odoo>

survey_extra_fields/views/survey_user_views.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="survey_user_input_line_view_form_inh" model="ir.ui.view">
+        <field name="name">survey.user_input.line.view.form.inherit.extra_fields</field>
+        <field name="model">survey.user_input.line</field>
+        <field name="inherit_id" ref="survey.survey_user_input_line_view_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='suggested_answer_id']" position="after">
+                <field name="value_file" filename="value_file_fname" colspan="2"
+                    attrs="{'invisible': [('answer_type', '!=', 'file')]}"/>
+                <field name="value_file_fname" invisible="1"/>
+            </xpath>
+        </field>
+    </record>
+
+</odoo>