"Collections" email notification

Currently, Mahara 17.10, the notification includes all the pages that are part of a collection. Rather than listing them all, it should be the collection title that is listed. When you have a collection consisting of more than 3 pages, the notification gets unnecessarily long.

Example of status quo:

You have been sent a notification from MyPortfolio Schools. Message follows:
------------------------------------------------------------------------

Subject: New access to pages "Design for Learning v.3", "Home v.3",
"Learning-focused Culture v.3", "Professional Learning v.3", "Professional
Relationships v.3", "Teaching as Inquiry v.3", "Teaching v.3", "Te Tiriti o
Waitangi partnership v.3"

You have been added to the access list for the pages "Design for Learning v.3",
"Home v.3", "Learning-focused Culture v.3", "Professional Learning v.3",
"Professional Relationships v.3", "Teaching as Inquiry v.3", "Teaching v.3",
"Te Tiriti o Waitangi partnership v.3" in collection "Name's PTC's 2018 " by Name

See [link to collection]

Suggestion:

Subject: New access to collection "Collection title"

You have been added to the access list for the collection "Collection title" by Name

See [link to collection]

Patch for "master" branch: https://reviews.mahara.org/9722

Commit hash:
Environment tested: Master
Browser tested: Chrome

PRECONDITIONS:
------------------------
1) Mahara users exists (no roles) and is member of Institution1 = (Carol User3 & Bob User2)
2) institution1 admin user exists (Alice User1)
3) Institution1 exists
4) Portfolio collection exists for Carol User3 and contains 3 pages

TEST STEPS:
------------------------
1) Log in as Mahara user (Carol User3)
2) Share the collection with a Mahara user (no roles) and is member of Institution1= Bob User2
3) Verify the email is sent and displays as the following : ✔
Subject: New access to collection "Collection title" ✔

You have been added to the access list for the collection "Collection title" by Name ✔

See [link to collection] ✔
Commit hash:
Environment tested: Master
Browser tested: Chrome

PRECONDITIONS:
------------------------
1) Mahara users exists (no roles) and is member of Institution1 = (Carol User3 & Bob User2)
2) institution1 admin user exists (Alice User1)
3) Institution1 exists
4) Portfolio collection exists for Carol User3 and contains 3 pages

TEST STEPS:
------------------------
1) Log in as Mahara user (Carol User3)
2) Share the collection with a Mahara user (no roles) and is member of Institution1= Bob User2
3) Verify the email is sent and displays as the following : ✔
Subject: New access to collection "Collection title" ✔

You have been added to the access list for the collection "Collection title" by Name ✔

See [link to collection] ✔

4) Share the collection with a Group
5) Verify the email is sent and displays as the following : ✘
Subject: New access to collection "Collection title" ✘

You have been added to the access list for the collection "Collection title" by Name ✘

See [link to collection] ✘

Catalyst QA Failed Testing ✔

NOTE: Sending of collections should always sent the updated email format no matter who gets the email
4) Share the collection with a Group
5) Verify the email is sent and displays as the following : ✘
Subject: New access to collection "Collection title" ✘

You have been added to the access list for the collection "Collection title" by Name ✘
Commit hash:
Environment tested: Master
Browser tested: Chrome

PRECONDITIONS:
------------------------
1) Mahara users exists (no roles) and is member of Institution1 = (Carol User3 & Bob User2)
2) institution1 admin user exists (Alice User1)
3) Institution1 exists
4) Portfolio collection exists for Carol User3 and contains 3 pages

TEST STEPS:
------------------------
1) Log in as Mahara user (Carol User3)
2) Share the collection with a Mahara user (no roles) and is member of Institution1= Bob User2
3) Verify the email is sent and displays as the following : ✔
Subject: New access to collection "Collection title" ✔

You have been added to the access list for the collection "Collection title" by Name ✔

See [link to collection] ✔

4) Share the collection with a Group
5) Verify the email is sent and displays as the following : ✘
Subject: New access to collection "Collection title" ✘

You have been added to the access list for the collection "Collection title" by Name ✘

See [link to collection] ✘

Catalyst QA F...

After some discussion, it was decided that the notification email subject and message body would be simplified.
The subject now reads: 'You have been given access to [number] of portfolio(s)'

The message body now reads: 'You have been given access to the following:'

This is followed by a list of the portfolio titles and their URL's. Collection URL's go to the first page of the collection.
i.e Action Movie Portfolio http://mahara/view/view/php?id=15
Followed by an access date message if applicable for when the user is able to view the portfolios. (This is one date for the whole selection)
Followed by "See [url for the user's shared with me page]"
The email will also include the standard header and footer of all mahara emails.

Re-Test
************************
TITLE: Collections email notification

BUG SUMMARY: After some discussion, it was decided that the notification email subject and message body would be simplified.

   The subject now reads: 'You have been given access to [number] of portfolio(s)'

   The message body now reads: 'You have been given access to the following:'

   This is followed by a list of the portfolio titles and their URL's. Collection URL's go to the
   first page of the collection.
   i.e Action Movie Portfolio http://mahara/view/view/php?id=15
   Followed by an access date message IF APPLICABLE for when the user is able to view the
   portfolios. (This is one date for the whole selection)
   Followed by "See [url for the user's shared with me page]"
   The email will also include the standard header and footer of all mahara emails.

==============================================

Commit hash: 2d52712457ca0e3c759f521ce595c5915a709d88
Environment tested: Master
Browser tested: Chrome
Theme used: n/a

PRECONDITIONS:
------------------------
1) Mahara users exists (no roles) and is member of Institution1 = (Carol User3 & Bob User2)
2) institution1 admin user exists (Alice User1)
3) Institution1 exists
4) Portfolio collection exists for Carol User3 and contains 3 pages

TEST STEPS:
------------------------
1) Log in as Mahara user (Carol User3)
2) Share the collection with a Mahara user (no roles) and is member of Institution1= Bob User2
3) Verify the email is sent and displays as the following :

Subject: 'You have been given access to [number] of portfolio(s)' ✔

Message body: 'You have been given access to the following:' ✔

This is followed by a list of the portfolio titles and their URL's. Collection URL's go to the first page of the collection. ✔
Followed by an access date message IF APPLICABLE for when the user is able to view the portfolios. (This is one date for the whole selection) ✔
Followed by "See [url for the user's shared with me page]" ✔
The email will also include the standard header and footer of all mahara emails. ✔

Catalyst QA Approved ✔

New Commit hash: 10929670a76b3bf72f3e03c72a3b50d0fe41ed51
Environment tested: Master
Browser tested: Chrome
Theme used: Raw | Default raw | Ocean | Modern | Primary school

PRECONDITIONS:
------------------------
1) Mahara users exists (no roles) and is member of Institution1 = (Carol User3 & Bob User2)
2) institution1 admin user exists (Alice User1)
3) Institution1 exists
4) The following Portfolio collections exists for Carol User3 as follows
    a) Collection 1 contains 1 pages
    b) Collection 2 contains 2 pages
    c) Collection 3 contains 3 pages

TEST STEPS:
------------------------
1) Log in as Mahara user (Carol User3)
2) Share all 3 of the collections at once with a Mahara user (no roles) and is member of Institution1 = Bob User2
3) Verify the email is sent and displays as the following:

Subject: 'You have been given access to 3 portfolios by Carol User3 ✔

Message body: ✔
You have been given access to the following:

Collection 1 http://mahara.stevens-lp.dynamic.wgtn.cat-it.co.nz/view/view.php?id=18
Collection 2 http://mahara.stevens-lp.dynamic.wgtn.cat-it.co.nz/view/view.php?id=19
Collection 3 http://mahara.stevens-lp.dynamic.wgtn.cat-it.co.nz/view/view.php?id=21
See http://mahara.stevens-lp.dynamic.wgtn.cat-it.co.nz//view/sharedviews.php

This is an auto-generated notification from Mahara. To update your notification preferences, visit http://mahara.stevens-lp.dynamic.wgtn.cat-it.co.nz/account/activity/preferences/index.php

Please do not reply to this message.

4) Verify that there are no bullet points within the email message body ✔

Catalyst QA Approved ✔

=================================================
THIS PATCH FAILS AS IT INTRODUCES NEW BUGS.
=================================================

1. Bug - additional emails are sent for each of the collections on top of the email that mentions all three collections shared

2. Bug - The first single email sent as mentioned above does not display the collection name

3. Bug - The Inbox Block located on the dashboard does not display the access emails - it now displays only lines where email subjects should exist

4. Bug - The accordion functionality for notifications on the Inbox | Notifications page no longer working - will not display message body

see attached screenshots for more details.

The patch previously was sending duplicate notifications when collections were shared due to a doubling up of rows in the activity_queue table. The problem of duplicate emails has been addressed, however, it is possible to receive multiple emails after the one change to access- when a collection is first created a row is entered into the activity_queue. This is to ensure that existing pages that already have access rules do not have their rules overwritten when added to a branch new collection. It is possible to create a new collection and then share that with pages that are not in a collection. You may see an email giving access to the collection and other pages, followed by an email about gaining access to the collection. This is because sharing a collection in combination with anything else means the data in the activity_queue table doesn't match up to the row inserted when the collection was first created so a notification will be sent out for both the collection and other things shared and the collection on its own- these aren't duplicate emails but also can't really be avoided.

Reviewed: https://reviews.mahara.org/9722
Committed: https://git.mahara.org/mahara/mahara/commit/81a57af38eafaa86d376b90bf533777b5d6a0a39
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit 81a57af38eafaa86d376b90bf533777b5d6a0a39
Author: Lisa Seeto <email address hidden>
Date: Mon Apr 8 14:21:37 2019 +1200

Bug 922911: "Collections" email notification

- updated display rules to use the new subject and message body
for collection notifications
- only add record to activity_queue if a record does not exist

behatnotneeded

Change-Id: I0b8bcb9bd75c5c01af20c432614ac4491cc07a5d
Signed-off-by: Lisa Seeto <email address hidden>