Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-73935

Improve flexibility of site support form and consistency of site support info provided in Moodle

    XMLWordPrintable

Details

    • MOODLE_400_STABLE
    • MOODLE_400_STABLE
    • MDL-73935-master
    • Hide

      Setup

      In order to test this, you'll need to setup your Moodle to send emails and have support email and no-reply email set.

      • SMTP configuration - Install MailCatcher and just add 127.0.0.1:1025 to smtphosts setting in Site administration > Server > Email > Outgoing mail configuration
        • Still on that page, set No-reply address to a valid email address.
        • Note: Ensure the service is running during the test by running the command mailcatcher.
      • Support email set in Site administration > Server > Supportcontact

      Test contact site support page

      1. Log in as admin.
      2. Click on the in the footer and then click Contact site support link.
      3. CONFIRM you are redirected to the Site homepage and see a confirmation message.
      4. Look the MailCatcher page http://127.0.0.1:1080/ in your browser and CONFIRM you have received the support email and the details match those you sent.
      5. Navigate to Site administration > Server > Support contact and set the Support page to https://moodle.com/contact/support/
      6. Click on the in the footer and then click "Contact site support" link.
      7. CONFIRM you don't see the contact page and you are redirected to Moodle's support page in a new window/tab.
      8. Remove the Support page.
      9. Update the smtphosts setting in Site administration > Server > Email > Outgoing mail configuration so that it uses an invalid port (eg add a 1 to the end) and save.
      10. Click on the in the footer and then click "Contact site support" link.
      11. Fill the form and submit.
      12. CONFIRM you are redirected back to the support page and CONFIRM you see the grey error box, with text "Unfortunately your support request can't be sent at this time!".
      13. CONFIRM in that box you also see "You can still submit your support request to [supportemail]".
      14. CONFIRM that below the error box, you see the support form and CONFIRM all of the information you previously filled in has been re-populated in the form.
      15. Log out, then send another support request as you did in steps 10-12. CONFIRM the result is the same, except that you do not see "You can still submit your support request to [supportemail]" anymore.
      16. Log back in as admin and remove the value for the smtphosts setting in Site administration > Server > Email > Outgoing mail configuration and save.
      17. Click on the in the footer and then click "Contact site support" link.
      18. CONFIRM you are redirected to the support page and the form is available to fill in and submit (you don't need to submit it).
      19. Log out, then click on the in the footer and then click "Contact site support" link.
      20. CONFIRM you see the same thing as you saw in step 18.
      21. Click the "Cancel" button and CONFIRM you are redirected to the homepage.

      Test error page

      1. Visit <wwwroot>/error/index.php.
      2. CONFIRM that above the "continue" button in the centre of the page, you see a Contact site support link.
      3. Click the link and CONFIRM you are taken to the support page and see the support form.
      4. As site admin navigate to Site administration > Server > Support contact and set the Support page to https://moodle.com/contact/support/
      5. Return to <wwwroot>/error/index.php.
      6. Click the Contact site support link again and CONFIRM you don't see the contact page and you are redirected to Moodle's support page in a new window/tab.
      Show
      Setup In order to test this, you'll need to setup your Moodle to send emails and have support email and no-reply email set. SMTP configuration - Install MailCatcher and just add 127.0.0.1:1025 to smtphosts setting in Site administration > Server > Email > Outgoing mail configuration Still on that page, set No-reply address to a valid email address. Note: Ensure the service is running during the test by running the command mailcatcher . Support email set in Site administration > Server > Supportcontact Test contact site support page Log in as admin. Click on the in the footer and then click Contact site support link. CONFIRM you are redirected to the Site homepage and see a confirmation message. Look the MailCatcher page http://127.0.0.1:1080/ in your browser and CONFIRM you have received the support email and the details match those you sent. Navigate to Site administration > Server > Support contact and set the Support page to https://moodle.com/contact/support/ Click on the in the footer and then click "Contact site support" link. CONFIRM you don't see the contact page and you are redirected to Moodle's support page in a new window/tab. Remove the Support page . Update the smtphosts setting in Site administration > Server > Email > Outgoing mail configuration so that it uses an invalid port (eg add a 1 to the end) and save. Click on the in the footer and then click "Contact site support" link. Fill the form and submit. CONFIRM you are redirected back to the support page and CONFIRM you see the grey error box, with text "Unfortunately your support request can't be sent at this time!". CONFIRM in that box you also see "You can still submit your support request to [supportemail] ". CONFIRM that below the error box, you see the support form and CONFIRM all of the information you previously filled in has been re-populated in the form. Log out, then send another support request as you did in steps 10-12. CONFIRM the result is the same, except that you do not see "You can still submit your support request to [supportemail] " anymore. Log back in as admin and remove the value for the smtphosts setting in Site administration > Server > Email > Outgoing mail configuration and save. Click on the in the footer and then click "Contact site support" link. CONFIRM you are redirected to the support page and the form is available to fill in and submit (you don't need to submit it). Log out, then click on the in the footer and then click "Contact site support" link. CONFIRM you see the same thing as you saw in step 18. Click the "Cancel" button and CONFIRM you are redirected to the homepage. Test error page Visit <wwwroot>/error/index.php . CONFIRM that above the "continue" button in the centre of the page, you see a Contact site support link. Click the link and CONFIRM you are taken to the support page and see the support form. As site admin navigate to Site administration > Server > Support contact and set the Support page to https://moodle.com/contact/support/ Return to <wwwroot>/error/index.php . Click the Contact site support link again and CONFIRM you don't see the contact page and you are redirected to Moodle's support page in a new window/tab.
    • 2
    • HQ Team International CIH2-218

    Description

      Remove SMTP limitation

      The current implementation of the site support form checks if outbound SMTP is configured in Moodle, and if not will not provide the form (instead showing a message and linking logged in users to the support email address). Since sites may be using another external MTA, we should allow sending via the form regardless, and only display the aforementioned message if the system registers that it has failed (if it succeeds with the request, but the mail fails to send from the MTA, that is out of the view of Moodle so out of scope to be handled). We should also then display the form again below the message, so that if it's a temporary outage they can try again, and worst case still have their message available to copy out and email through manually.

      Remove support email where it is exposed elsewhere

      In MDL-73608 we removed access to the support email address from the new "footer" link, but there are some existing places in Moodle where it is also available, which should act consistently and link to the support form (and also not expose the now compulsory support email address to unauthenticated users). An example of this is /error/index.php, but we need to check for any other leaks.

      Attachments

        Issue Links

          Activity

            People

              michaelh Michael Hawkins
              michaelh Michael Hawkins
              Simey Lameze Simey Lameze
              Eloy Lafuente (stronk7) Eloy Lafuente (stronk7)
              Angelia Dela Cruz Angelia Dela Cruz
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 days, 1 hour, 29 minutes
                  2d 1h 29m

                  Clockify

                    Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.