Merge pull request #707 from detomon/accessibility-statement-and-feed…

…back-mechanism

Improvement: Implement accessibility statement and feedback mechanism, resolves #567.

CHANGES.md

@@ -4,6 +4,10 @@ moodle-theme_boost_union
 Changes
 -------
 
+### Unreleased
+
+* 2024-12-15 - Feature: Add declaration of accessibility page and accessibility support page, resolves #567.
+
 ### v4.5-r4
 
 * 2024-12-06 - Tests: Add several Behat optimisations to bring down the test suite run time, resolves #765.

README.md

@@ -559,6 +559,18 @@ With these settings, you can add rich text content which will be shown on a gene
 
 With these settings, you can add rich text content which will be shown on a generic page 3.
 
+#### Tab "Accessibility"
+
+In this tab there are the following settings:
+
+#### Declaration of accessibility
+
+With these settings, you can add rich text content which will be shown on a declaration of accessibility page.
+
+#### Accessibility support page
+
+With these settings, you can enable the accessibility support page which provides a contact form for accessibility issues.
+
 #### Tab "Information banners"
 
 In this tab, you can enable and configure multiple information banners to be shown on selected pages.
@@ -857,6 +869,6 @@ Moodle an Hochschulen e.V. would like to thank these main contributors (in alpha
 * University of Bayreuth, Nikolai Jahreis: Code
 * University of Graz, André Menrath: Code
 * University of Lübeck, Christian Wolters: Code, Peer Review, Ideating
-* Zurich University of Applied Sciences (ZHAW): Funding, Ideating
+* Zurich University of Applied Sciences (ZHAW): Code, Funding, Ideating
 
 Additionally, we thank all other contributors who contributed ideas, feedback and code snippets within the Github issues and pull requests as well as all contributors who contributed additional translations in AMOS, the Moodle translation tool.

accessibility/declaration.php

@@ -0,0 +1,74 @@
+<?php
+// 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 <http://www.gnu.org/licenses/>.
+
+/**
+ * Theme Boost Union - Declaration of accessibility page.
+ *
+ * @package    theme_boost_union
+ * @copyright  2024 Katalin Lukacs Toth, ZHAW Zurich University of Applied Sciences <lukc@zhaw.ch>
+ * @copyright  2024 Simon Schoenenberger, ZHAW Zurich University of Applied Sciences <scgo@zhaw.ch>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+// Include config.php.
+// Let codechecker ignore the next line because otherwise it would complain about a missing login check
+// after requiring config.php which is really not needed.
+require(__DIR__ . '/../../../config.php'); // phpcs:disable moodle.Files.RequireLogin.Missing
+
+// Require the necessary libraries.
+require_once($CFG->dirroot.'/theme/boost_union/lib.php');
+require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
+
+// Set page URL.
+$PAGE->set_url('/theme/boost_union/accessibility/declaration.php');
+
+// Set page layout.
+$PAGE->set_pagelayout('standard');
+
+// Set page context.
+$PAGE->set_context(context_system::instance());
+
+// Add page name as body class.
+$PAGE->add_body_class('theme_boost_union-accessibilitydeclaration');
+
+// Get theme config.
+$config = get_config('theme_boost_union');
+
+// If the declaration of accessibility page is disabled, we just show a short friendly warning page and are done.
+if ($config->enableaccessibilitydeclaration != THEME_BOOST_UNION_SETTING_SELECT_YES) {
+    echo $OUTPUT->header();
+    $notification = new \core\output\notification(get_string('accessibilitydeclarationdisabled', 'theme_boost_union'),
+        \core\output\notification::NOTIFY_INFO);
+    $notification->set_show_closebutton(false);
+    echo $OUTPUT->render($notification);
+    echo $OUTPUT->footer();
+    die;
+}
+
+// Set page title.
+$PAGE->set_title(theme_boost_union_get_accessibility_pagetitle('declaration'));
+
+// Start page output.
+echo $OUTPUT->header();
+
+// Show page heading.
+echo $OUTPUT->heading(theme_boost_union_get_accessibility_pagetitle('declaration'));
+
+// Output declaration of accessibility page content.
+echo format_text($config->accessibilitydeclarationcontent, FORMAT_MOODLE, ['trusted' => true, 'noclean' => true]);
+
+// Finish page.
+echo $OUTPUT->footer();

accessibility/support.php

@@ -0,0 +1,207 @@
+<?php
+// 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 <http://www.gnu.org/licenses/>.
+
+/**
+ * Theme Boost Union - Accessibility support page.
+ *
+ * @package    theme_boost_union
+ * @copyright  2024 Katalin Lukacs Toth, ZHAW Zurich University of Applied Sciences <lukc@zhaw.ch>
+ * @copyright  2024 Simon Schoenenberger, ZHAW Zurich University of Applied Sciences <scgo@zhaw.ch>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+// Include config.php.
+// Let codechecker ignore the next line because otherwise it would complain about a missing login check
+// after requiring config.php which is really not needed.
+require(__DIR__ . '/../../../config.php'); // phpcs:disable moodle.Files.RequireLogin.Missing
+
+// Require the necessary libraries.
+require_once($CFG->dirroot.'/theme/boost_union/lib.php');
+require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
+
+// Set page URL.
+$PAGE->set_url('/theme/boost_union/accessibility/support.php');
+
+// Set page layout.
+$PAGE->set_pagelayout('standard');
+
+// Set page context.
+$PAGE->set_context(context_system::instance());
+
+// Add page name as body class.
+$PAGE->add_body_class('theme_boost_union-accessibilitysupport');
+
+// Get theme config.
+$config = get_config('theme_boost_union');
+
+// If the accessibility support page is disabled, we just show a short friendly warning page and are done.
+if ($config->enableaccessibilitysupport != THEME_BOOST_UNION_SETTING_SELECT_YES) {
+    echo $OUTPUT->header();
+    $notification = new \core\output\notification(get_string('accessibilitysupportdisabled', 'theme_boost_union'),
+        \core\output\notification::NOTIFY_INFO);
+    $notification->set_show_closebutton(false);
+    echo $OUTPUT->render($notification);
+    echo $OUTPUT->footer();
+    die;
+}
+
+// If user login is required, we redirect to the login page.
+if (isset($config->allowaccessibilitysupportwithoutlogin) &&
+        $config->allowaccessibilitysupportwithoutlogin != THEME_BOOST_UNION_SETTING_SELECT_YES) {
+    if (!isloggedin() || isguestuser()) {
+        redirect(get_login_url());
+    }
+}
+
+// Set page title.
+$PAGE->set_title(theme_boost_union_get_accessibility_pagetitle('support'));
+
+// Initialize the accessibility support form.
+$form = new \theme_boost_union\form\accessibilitysupport_form();
+
+// Get the page where we came from.
+$referrerpage = $form->get_referrer_page();
+if (!$referrerpage) {
+    $referrerpage = $CFG->wwwroot;
+}
+
+// If the form was cancelled.
+if ($form->is_cancelled()) {
+    // Redirect to the previous page when the form was cancelled.
+    redirect($referrerpage);
+
+    // Otherwise, if the form was submitted and validated.
+} else if ($form->is_submitted() && $form->is_validated() && confirm_sesskey()) {
+    // Get the form data.
+    $data = $form->get_data();
+
+    // Remove the automatic system information field when the sendtechinfo field was unchecked by the user.
+    if (!$data->sendtechinfo) {
+        unset($data->techinfo);
+    }
+
+    // If we have a valid user.
+    $validuser = isloggedin() && !isguestuser();
+    if ($validuser) {
+        // Use the current user as sender when logged in.
+        $from = $USER;
+        $data->notloggedinuser = false;
+    } else {
+        // Use the noreply user as default sender when not logged in.
+        $from = core_user::get_noreply_user();
+        $data->notloggedinuser = true;
+    }
+
+    // Use a generic sender name and email when the user wants to be anonymous.
+    if ($data->sendanonymous) {
+        $from = core_user::get_noreply_user();
+        $data->name = get_string('accessibilitysupportanonymoususer', 'theme_boost_union');
+        $data->email = get_string('accessibilitysupportanonymousemail', 'theme_boost_union');
+    }
+
+    // Compose the mail content from form data.
+    $subjectprefix = get_string('accessibilitysupportusermailsubject', 'theme_boost_union');
+    $subject = '['.$subjectprefix.'] '.$data->subject;
+    $renderer = $PAGE->get_renderer('core');
+    $message = $renderer->render_from_template('theme_boost_union/accessibility-support-email-body', $data);
+
+    // Configure the noreply user as receiver when an accessibility support email was configured.
+    $accessibilityemail = get_config('theme_boost_union', 'accessibilitysupportusermail');
+    // If an accessibility support email was configured, we use it as receiver.
+    if ($accessibilityemail) {
+        // We need to create a dummy user record to send the mail.
+        // The user record is only used to send the mail.
+        $supportuser = \core_user::get_noreply_user();
+        $supportuser->email = $accessibilityemail;
+        $supportuser->firstname = get_string('accessibilitysupportuserfirstname', 'theme_boost_union');
+        $supportuser->lastname = get_string('accessibilitysupportuserlastname', 'theme_boost_union');
+
+        // Otherwise.
+    } else {
+        // Use the default support user as receiver.
+        $supportuser = \core_user::get_support_user();
+    }
+
+    // Send the email.
+    $sendresult = email_to_user($supportuser, $from, $subject, $message);
+
+    // Show fallback page with contact information when the email could not be sent.
+    if (!$sendresult) {
+        // If we have a valid user (who should be allowed to see email addresses).
+        if ($validuser) {
+            // Get the notification support email address to be shown as fallback for valid users.
+            $supportemail = $supportuser->email;
+
+            // Prepare the notification text.
+            $notificationtext = get_string('accessibilitysupportmessagenotsent', 'theme_boost_union');
+            $notificationtext .= '<br />';
+            $notificationtext .= get_string('accessibilitysupportmessagetryalternative', 'theme_boost_union', $supportemail);
+
+            // Otherwise.
+        } else {
+            // Prepare the notification text.
+            $notificationtext = get_string('accessibilitysupportmessagenotsent', 'theme_boost_union');
+            $notificationtext .= '<br />';
+            $notificationtext .= get_string('accessibilitysupportmessagetryagain', 'theme_boost_union');
+        }
+
+        $notification = new \core\output\notification($notificationtext, \core\output\notification::NOTIFY_ERROR);
+        $notification->set_show_closebutton(false);
+        $formoutput = $OUTPUT->render($notification);
+
+        // Set the form data with the subitted data.
+        $form->set_data($data);
+
+        // Render the form.
+        $formoutput .= $form->render();
+
+        // Otherwise, if the message was sent.
+    } else {
+        // Unset the referrer page session variable (to avoid harming future form submissions).
+        unset($SESSION->boost_union_accessibility_pagereferrer);
+
+        // Redirect to the previous page and show message when the email was successfully sent.
+        $level = \core\output\notification::NOTIFY_SUCCESS;
+        redirect($referrerpage, get_string('accessibilitysupportmessagesent', 'theme_boost_union'), 3, $level);
+    }
+
+    // Otherwise, when the form was not submitted yet.
+} else {
+    // Render the form.
+    $formoutput = $form->render();
+}
+
+// Include form specific Javascript.
+$PAGE->requires->js_call_amd('theme_boost_union/accessibilitysupportform', 'init', [
+    [
+        'formId' => $form->get_id(),
+    ],
+]);
+
+// Start page output.
+echo $OUTPUT->header();
+
+// Show page heading.
+echo $OUTPUT->heading(theme_boost_union_get_accessibility_pagetitle('support'));
+
+// Output accessibility support page content.
+echo format_text($config->accessibilitysupportcontent, FORMAT_MOODLE, ['trusted' => true, 'noclean' => true]);
+
+// Output the form.
+echo $formoutput;
+
+// Finish page.
+echo $OUTPUT->footer();