From 2eee07daa4432bbc89bdec12941d8ef7b7bc431c Mon Sep 17 00:00:00 2001 From: Paul Holden Date: Sat, 20 Feb 2021 00:28:28 +0000 Subject: [PATCH] MDL-71090 tool_dataprivacy: convert contact DPO to modal forms. --- .../dataprivacy/amd/build/contactdpo.min.js | 2 + .../amd/build/contactdpo.min.js.map | 1 + admin/tool/dataprivacy/amd/src/contactdpo.js | 67 ++++++++++++ admin/tool/dataprivacy/classes/external.php | 3 +- .../dataprivacy/classes/form/contactdpo.php | 100 ++++++++++++++++++ .../dataprivacy/classes/output/renderer.php | 5 +- .../dataprivacy/lang/en/tool_dataprivacy.php | 1 + admin/tool/dataprivacy/lib.php | 6 +- .../templates/contact_dpo.mustache | 58 ---------- .../behat/contact_privacy_officer.feature | 16 +-- 10 files changed, 187 insertions(+), 72 deletions(-) create mode 100644 admin/tool/dataprivacy/amd/build/contactdpo.min.js create mode 100644 admin/tool/dataprivacy/amd/build/contactdpo.min.js.map create mode 100644 admin/tool/dataprivacy/amd/src/contactdpo.js create mode 100644 admin/tool/dataprivacy/classes/form/contactdpo.php delete mode 100644 admin/tool/dataprivacy/templates/contact_dpo.mustache diff --git a/admin/tool/dataprivacy/amd/build/contactdpo.min.js b/admin/tool/dataprivacy/amd/build/contactdpo.min.js new file mode 100644 index 00000000000..73514788d05 --- /dev/null +++ b/admin/tool/dataprivacy/amd/build/contactdpo.min.js @@ -0,0 +1,2 @@ +define ("tool_dataprivacy/contactdpo",["exports","core_form/modalform","core/notification","core/str","core/toast"],function(a,b,c,d,e){"use strict";Object.defineProperty(a,"__esModule",{value:!0});a.init=void 0;b=f(b);c=f(c);function f(a){return a&&a.__esModule?a:{default:a}}var g={CONTACT_DPO:"[data-action=\"contactdpo\"]"};a.init=function init(){var a=document.querySelector(g.CONTACT_DPO);a.addEventListener("click",function(f){f.preventDefault();var g=new b.default({modalConfig:{title:(0,d.get_string)("contactdataprotectionofficer","tool_dataprivacy")},formClass:"tool_dataprivacy\\form\\contactdpo",saveButtonText:(0,d.get_string)("send","tool_dataprivacy"),returnFocus:a});g.addEventListener(g.events.FORM_SUBMITTED,function(a){if(a.detail.result){(0,d.get_string)("requestsubmitted","tool_dataprivacy").then(e.add).catch()}else{var b=a.detail.warnings.map(function(a){return a.message});c.default.addNotification({type:"error",message:b.join("
")})}});g.show()})}}); +//# sourceMappingURL=contactdpo.min.js.map diff --git a/admin/tool/dataprivacy/amd/build/contactdpo.min.js.map b/admin/tool/dataprivacy/amd/build/contactdpo.min.js.map new file mode 100644 index 00000000000..6445af76e86 --- /dev/null +++ b/admin/tool/dataprivacy/amd/build/contactdpo.min.js.map @@ -0,0 +1 @@ +{"version":3,"sources":["../src/contactdpo.js"],"names":["SELECTORS","CONTACT_DPO","init","triggerElement","document","querySelector","addEventListener","event","preventDefault","modalForm","ModalForm","modalConfig","title","formClass","saveButtonText","returnFocus","events","FORM_SUBMITTED","detail","result","then","addToast","catch","warningMessages","warnings","map","warning","message","Notification","addNotification","type","join","show"],"mappings":"oNAwBA,OACA,O,sDAIMA,CAAAA,CAAS,CAAG,CACdC,WAAW,CAAE,8BADC,C,QAOE,QAAPC,CAAAA,IAAO,EAAM,CACtB,GAAMC,CAAAA,CAAc,CAAGC,QAAQ,CAACC,aAAT,CAAuBL,CAAS,CAACC,WAAjC,CAAvB,CAEAE,CAAc,CAACG,gBAAf,CAAgC,OAAhC,CAAyC,SAAAC,CAAK,CAAI,CAC9CA,CAAK,CAACC,cAAN,GAEA,GAAMC,CAAAA,CAAS,CAAG,GAAIC,UAAJ,CAAc,CAC5BC,WAAW,CAAE,CACTC,KAAK,CAAE,iBAAU,8BAAV,CAA0C,kBAA1C,CADE,CADe,CAI5BC,SAAS,CAAE,oCAJiB,CAK5BC,cAAc,CAAE,iBAAU,MAAV,CAAkB,kBAAlB,CALY,CAM5BC,WAAW,CAAEZ,CANe,CAAd,CAAlB,CAUAM,CAAS,CAACH,gBAAV,CAA2BG,CAAS,CAACO,MAAV,CAAiBC,cAA5C,CAA4D,SAAAV,CAAK,CAAI,CACjE,GAAIA,CAAK,CAACW,MAAN,CAAaC,MAAjB,CAAyB,CACrB,iBAAU,kBAAV,CAA8B,kBAA9B,EAAkDC,IAAlD,CAAuDC,KAAvD,EAAiEC,KAAjE,EACH,CAFD,IAEO,CACH,GAAMC,CAAAA,CAAe,CAAGhB,CAAK,CAACW,MAAN,CAAaM,QAAb,CAAsBC,GAAtB,CAA0B,SAAAC,CAAO,QAAIA,CAAAA,CAAO,CAACC,OAAZ,CAAjC,CAAxB,CACAC,UAAaC,eAAb,CAA6B,CACzBC,IAAI,CAAE,OADmB,CAEzBH,OAAO,CAAEJ,CAAe,CAACQ,IAAhB,CAAqB,MAArB,CAFgB,CAA7B,CAIH,CACJ,CAVD,EAYAtB,CAAS,CAACuB,IAAV,EACH,CA1BD,CA2BH,C","sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * Javascript module for contacting the site DPO\n *\n * @module tool_dataprivacy/contactdpo\n * @package tool_dataprivacy\n * @copyright 2021 Paul Holden \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport ModalForm from 'core_form/modalform';\nimport Notification from 'core/notification';\nimport {get_string as getString} from 'core/str';\nimport {add as addToast} from 'core/toast';\n\nconst SELECTORS = {\n CONTACT_DPO: '[data-action=\"contactdpo\"]',\n};\n\n/**\n * Initialize module\n */\nexport const init = () => {\n const triggerElement = document.querySelector(SELECTORS.CONTACT_DPO);\n\n triggerElement.addEventListener('click', event => {\n event.preventDefault();\n\n const modalForm = new ModalForm({\n modalConfig: {\n title: getString('contactdataprotectionofficer', 'tool_dataprivacy'),\n },\n formClass: 'tool_dataprivacy\\\\form\\\\contactdpo',\n saveButtonText: getString('send', 'tool_dataprivacy'),\n returnFocus: triggerElement,\n });\n\n // Show a toast notification when the form is submitted.\n modalForm.addEventListener(modalForm.events.FORM_SUBMITTED, event => {\n if (event.detail.result) {\n getString('requestsubmitted', 'tool_dataprivacy').then(addToast).catch();\n } else {\n const warningMessages = event.detail.warnings.map(warning => warning.message);\n Notification.addNotification({\n type: 'error',\n message: warningMessages.join('
')\n });\n }\n });\n\n modalForm.show();\n });\n};\n"],"file":"contactdpo.min.js"} \ No newline at end of file diff --git a/admin/tool/dataprivacy/amd/src/contactdpo.js b/admin/tool/dataprivacy/amd/src/contactdpo.js new file mode 100644 index 00000000000..50417a84db9 --- /dev/null +++ b/admin/tool/dataprivacy/amd/src/contactdpo.js @@ -0,0 +1,67 @@ +// This file is part of Moodle - http://moodle.org/ +// +// Moodle is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Moodle is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Moodle. If not, see . + +/** + * Javascript module for contacting the site DPO + * + * @module tool_dataprivacy/contactdpo + * @package tool_dataprivacy + * @copyright 2021 Paul Holden + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +import ModalForm from 'core_form/modalform'; +import Notification from 'core/notification'; +import {get_string as getString} from 'core/str'; +import {add as addToast} from 'core/toast'; + +const SELECTORS = { + CONTACT_DPO: '[data-action="contactdpo"]', +}; + +/** + * Initialize module + */ +export const init = () => { + const triggerElement = document.querySelector(SELECTORS.CONTACT_DPO); + + triggerElement.addEventListener('click', event => { + event.preventDefault(); + + const modalForm = new ModalForm({ + modalConfig: { + title: getString('contactdataprotectionofficer', 'tool_dataprivacy'), + }, + formClass: 'tool_dataprivacy\\form\\contactdpo', + saveButtonText: getString('send', 'tool_dataprivacy'), + returnFocus: triggerElement, + }); + + // Show a toast notification when the form is submitted. + modalForm.addEventListener(modalForm.events.FORM_SUBMITTED, event => { + if (event.detail.result) { + getString('requestsubmitted', 'tool_dataprivacy').then(addToast).catch(); + } else { + const warningMessages = event.detail.warnings.map(warning => warning.message); + Notification.addNotification({ + type: 'error', + message: warningMessages.join('
') + }); + } + }); + + modalForm.show(); + }); +}; diff --git a/admin/tool/dataprivacy/classes/external.php b/admin/tool/dataprivacy/classes/external.php index c2ab73195dd..d9e5a411a4e 100644 --- a/admin/tool/dataprivacy/classes/external.php +++ b/admin/tool/dataprivacy/classes/external.php @@ -212,7 +212,8 @@ class external extends external_api { $warnings[] = [ 'item' => $dpo->id, 'warningcode' => 'errorsendingtodpo', - 'message' => get_string('errorsendingmessagetodpo', 'tool_dataprivacy') + 'message' => get_string('errorsendingmessagetodpo', 'tool_dataprivacy', + fullname($dpo)) ]; } } diff --git a/admin/tool/dataprivacy/classes/form/contactdpo.php b/admin/tool/dataprivacy/classes/form/contactdpo.php new file mode 100644 index 00000000000..dc172913b08 --- /dev/null +++ b/admin/tool/dataprivacy/classes/form/contactdpo.php @@ -0,0 +1,100 @@ +. + + +namespace tool_dataprivacy\form; + +use context; +use context_user; +use moodle_exception; +use moodle_url; +use core_form\dynamic_form; +use tool_dataprivacy\api; +use tool_dataprivacy\external; + +/** + * Contact DPO modal form + * + * @package tool_dataprivacy + * @copyright 2021 Paul Holden + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class contactdpo extends dynamic_form { + + /** + * Form definition + */ + protected function definition() { + global $USER; + + $mform = $this->_form; + + $mform->addElement('static', 'replyto', get_string('replyto', 'tool_dataprivacy'), s($USER->email)); + + $mform->addElement('textarea', 'message', get_string('message', 'tool_dataprivacy'), 'cols="60" rows="8"'); + $mform->setType('message', PARAM_TEXT); + $mform->addRule('message', get_string('required'), 'required', null, 'client'); + } + + /** + * Return form context + * + * @return context + */ + protected function get_context_for_dynamic_submission(): context { + global $USER; + + return context_user::instance($USER->id); + } + + /** + * Check if current user has access to this form, otherwise throw exception + * + * @throws moodle_exception + */ + protected function check_access_for_dynamic_submission(): void { + if (!api::can_contact_dpo()) { + throw new moodle_exception('errorcontactdpodisabled', 'tool_dataprivacy'); + } + } + + /** + * Process the form submission, used if form was submitted via AJAX + * + * @return array + */ + public function process_dynamic_submission() { + return external::contact_dpo($this->get_data()->message); + } + + /** + * Load in existing data as form defaults (not applicable) + */ + public function set_data_for_dynamic_submission(): void { + return; + } + + /** + * Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX + * + * @return moodle_url + */ + protected function get_page_url_for_dynamic_submission(): moodle_url { + global $USER; + + return new moodle_url('/user/profile.php', ['id' => $USER->id]); + } +} diff --git a/admin/tool/dataprivacy/classes/output/renderer.php b/admin/tool/dataprivacy/classes/output/renderer.php index 803290669a5..5d3f4cb6bd7 100644 --- a/admin/tool/dataprivacy/classes/output/renderer.php +++ b/admin/tool/dataprivacy/classes/output/renderer.php @@ -55,14 +55,11 @@ class renderer extends plugin_renderer_base { /** * Render the contact DPO link. * - * @param string $replytoemail The Reply-to email address * @return string The HTML for the link. - * @throws coding_exception */ - public function render_contact_dpo_link($replytoemail) { + public function render_contact_dpo_link() { $params = [ 'data-action' => 'contactdpo', - 'data-replytoemail' => $replytoemail, ]; return html_writer::link('#', get_string('contactdataprotectionofficer', 'tool_dataprivacy'), $params); } diff --git a/admin/tool/dataprivacy/lang/en/tool_dataprivacy.php b/admin/tool/dataprivacy/lang/en/tool_dataprivacy.php index 46d7af262b8..53ce8601dcf 100644 --- a/admin/tool/dataprivacy/lang/en/tool_dataprivacy.php +++ b/admin/tool/dataprivacy/lang/en/tool_dataprivacy.php @@ -135,6 +135,7 @@ $string['effectiveretentionperioduser'] = '{$a} (since the last time the user ac $string['emailsalutation'] = 'Dear {$a},'; $string['errorcannotrequestdeleteforself'] = 'You don\'t have permission to create deletion request for yourself.'; $string['errorcannotrequestdeleteforother'] = 'You don\'t have permission to create deletion request for this user.'; +$string['errorcontactdpodisabled'] = 'Contacting the privacy officer is disabled'; $string['errorinvalidrequestcomments'] = 'The comments field may contain plain text only.'; $string['errorinvalidrequestcreationmethod'] = 'Invalid request creation method!'; $string['errorinvalidrequeststatus'] = 'Invalid request status!'; diff --git a/admin/tool/dataprivacy/lib.php b/admin/tool/dataprivacy/lib.php index 5b5f28acebf..25091fddf8c 100644 --- a/admin/tool/dataprivacy/lib.php +++ b/admin/tool/dataprivacy/lib.php @@ -54,10 +54,12 @@ function tool_dataprivacy_myprofile_navigation(tree $tree, $user, $iscurrentuser // Contact data protection officer link. if (\tool_dataprivacy\api::can_contact_dpo() && $iscurrentuser) { $renderer = $PAGE->get_renderer('tool_dataprivacy'); - $content = $renderer->render_contact_dpo_link($USER->email); + $content = $renderer->render_contact_dpo_link(); $node = new core_user\output\myprofile\node('privacyandpolicies', 'contactdpo', null, null, null, $content); $category->add_node($node); - $PAGE->requires->js_call_amd('tool_dataprivacy/myrequestactions', 'init'); + + // Require our Javascript module to handle contact DPO interaction. + $PAGE->requires->js_call_amd('tool_dataprivacy/contactdpo', 'init'); $url = new moodle_url('/admin/tool/dataprivacy/mydatarequests.php'); $node = new core_user\output\myprofile\node('privacyandpolicies', 'datarequests', diff --git a/admin/tool/dataprivacy/templates/contact_dpo.mustache b/admin/tool/dataprivacy/templates/contact_dpo.mustache deleted file mode 100644 index d3a0e868392..00000000000 --- a/admin/tool/dataprivacy/templates/contact_dpo.mustache +++ /dev/null @@ -1,58 +0,0 @@ -{{! - This file is part of Moodle - http://moodle.org/ - - Moodle is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - Moodle is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with Moodle. If not, see . -}} -{{! - @template tool_dataprivacy/contact_dpo - - The purpose of this template is to enable the user to contact the site's DPO via email. - - Classes required for JS: - * none - - Data attributes required for JS: - * none - - Context variables required for this template: - * userid int The user's ID. - * email string The user's email address. - - Example context (json): - { - "userid": 1, - "replytoemail": "martha@example.com" - } -}} -
-
- -
{{replytoemail}}
-
-
- -
- - -
-
-
- diff --git a/admin/tool/dataprivacy/tests/behat/contact_privacy_officer.feature b/admin/tool/dataprivacy/tests/behat/contact_privacy_officer.feature index 528d1f69325..28f5de84d12 100644 --- a/admin/tool/dataprivacy/tests/behat/contact_privacy_officer.feature +++ b/admin/tool/dataprivacy/tests/behat/contact_privacy_officer.feature @@ -8,19 +8,21 @@ Feature: Contact the privacy officer Given the following "users" exist: | username | firstname | lastname | email | | student1 | Student | 1 | s1@example.com | - And I log in as "admin" - And I set the following administration settings values: - | contactdataprotectionofficer | 1 | - And I log out @javascript Scenario: Contacting the privacy officer - Given I log in as "student1" + Given the following config values are set as admin: + | contactdataprotectionofficer | 1 | tool_dataprivacy | + When I log in as "student1" And I follow "Profile" in the user menu - And I should see "Contact the privacy officer" And I click on "Contact the privacy officer" "link" And I set the field "Message" to "Hello DPO!" And I click on "Send" "button" in the "Contact the privacy officer" "dialogue" - And I should see "Your request has been submitted to the privacy officer" + Then I should see "Your request has been submitted to the privacy officer" And I click on "Data requests" "link" And I should see "Hello DPO!" in the "General inquiry" "table_row" + + Scenario: Contacting the privacy officer when not enabled + When I log in as "student1" + And I follow "Profile" in the user menu + Then "Contact the privacy officer" "link" should not exist