Merge lp:~gmb/launchpad/team-subscription-opt-out into lp:launchpad/db-devel

[Graham Binns]

[r=allenap,stub][ui=none][bug=751173][incr] A BugSubscriptionFilterMute table has been added to the database.

This branch adds a BugSubscriptionFilterMute table to the database and
its associated interface and model to the tree.

The idea behind BugSubscriptionFilterMute is that people should be able
to mute team subscriptions if they want to. The story being that:

 As a member of ~launchpad
 I want to be able to mute emails that I would receive because
 ~launchpad is structurally subscribed to a project
 So that I don't have to read bug mail in which I'm not interested.

[Gavin Panella (allenap)]

All looks good, but perhaps there ought to be some tests for the basics, like adding to and removing from the store.

review: Approve (code)

[Stuart Bishop (stub)]

Some discussion on IRC. The following version is approved as patch-2208-58-0.sql:

-- Copyright 2011 Canonical Ltd. This software is licensed under the
-- GNU Affero General Public License version 3 (see the file LICENSE).

SET client_min_messages=ERROR;

-- A table to store subscription mutes in.

CREATE TABLE BugSubscriptionFilterMute (
    person integer REFERENCES Person(id)
        ON DELETE CASCADE NOT NULL,
    filter integer REFERENCES BugSubscriptionFilter(id)
        ON DELETE CASCADE NOT NULL,
    date_created timestamp without time zone
        DEFAULT timezone('UTC'::text, now()) NOT NULL,
    CONSTRAINT bugsubscriptionfiltermute_pkey PRIMARY KEY (person, filter)
);

-- We don't need an index on person, as the primary key index can be used
-- for those lookups. We have an index on just filter, as the bulk of our
-- lookups will be on filter.
CREATE INDEX bugsubscriptionfiltermute__filter__idx
    ON BugSubscriptionFilterMute(filter);

INSERT INTO LaunchpadDatabaseRevision VALUES (2208, 58, 0);

review: Approve (db)

=== modified file 'database/schema/comments.sql'
--- database/schema/comments.sql	2011-03-29 10:17:46 +0000
+++ database/schema/comments.sql	2011-04-04 12:32:01 +0000
@@ -231,6 +231,12 @@
 COMMENT ON COLUMN BugSubscriptionFilterTag.tag IS 'A bug tag.';
 COMMENT ON COLUMN BugSubscriptionFilterTag.include IS 'If True, send only messages for bugs having this tag, else send only messages for bugs which do not have this tag.';
 
+-- BugSubscriptionFilterMute
+COMMENT ON TABLE BugSubscriptionFilterMute IS 'Mutes for subscription filters.';
+COMMENT ON COLUMN BugSubscriptionFilterMute.person IS 'The person that muted their subscription to this filter.';
+COMMENT ON COLUMN BugSubscriptionFilterMute.filter IS 'The subscription filter of this record';
+COMMENT ON COLUMN BugSubscriptionFilterMute.date_created IS 'The date at which this mute was created.';
+
 -- BugTag
 COMMENT ON TABLE BugTag IS 'Attaches simple text tags to a bug.';
 COMMENT ON COLUMN BugTag.bug IS 'The bug the tags is attached to.';

=== added file 'database/schema/patch-2208-58-0.sql'
--- database/schema/patch-2208-58-0.sql	1970-01-01 00:00:00 +0000
+++ database/schema/patch-2208-58-0.sql	2011-04-04 12:32:01 +0000
@@ -0,0 +1,25 @@
+-- Copyright 2011 Canonical Ltd. This software is licensed under the
+-- GNU Affero General Public License version 3 (see the file LICENSE).
+
+SET client_min_messages=ERROR;
+
+-- A table to store subscription mutes in.
+
+CREATE TABLE BugSubscriptionFilterMute (
+    person integer REFERENCES Person(id)
+        ON DELETE CASCADE NOT NULL,
+    filter integer REFERENCES BugSubscriptionFilter(id)
+        ON DELETE CASCADE NOT NULL,
+    date_created timestamp without time zone
+        DEFAULT timezone('UTC'::text, now()) NOT NULL,
+    CONSTRAINT bugsubscriptionfiltermute_pkey PRIMARY KEY (person, filter)
+);
+
+-- We don't need an index on person, as the primary key index can be used
+-- for those lookups. We have an index on just filter, as the bulk of our
+-- lookups will be on filter.
+CREATE INDEX bugsubscriptionfiltermute__filter__idx
+    ON BugSubscriptionFilterMute(filter);
+
+INSERT INTO LaunchpadDatabaseRevision VALUES (2208, 58, 0);
+

=== modified file 'database/schema/security.cfg'
--- database/schema/security.cfg	2011-04-01 14:46:21 +0000
+++ database/schema/security.cfg	2011-04-04 12:32:01 +0000
@@ -1107,6 +1107,7 @@
 public.bugproductinfestation            = SELECT, INSERT, UPDATE
 public.bugsubscription                  = SELECT, INSERT, UPDATE, DELETE
 public.bugsubscriptionfilter            = SELECT, INSERT, UPDATE, DELETE
+public.bugsubscriptionfiltermute        = SELECT, INSERT, UPDATE, DELETE
 public.bugsubscriptionfilterstatus      = SELECT, INSERT, UPDATE, DELETE
 public.bugsubscriptionfilterimportance  = SELECT, INSERT, UPDATE, DELETE
 public.bugsubscriptionfiltertag         = SELECT, INSERT, UPDATE, DELETE
@@ -1530,6 +1531,7 @@
 public.bugnotificationrecipient         = SELECT, INSERT, UPDATE
 public.bugsubscription                  = SELECT, INSERT
 public.bugsubscriptionfilter            = SELECT, INSERT
+public.bugsubscriptionfiltermute        = SELECT, INSERT
 public.bugsubscriptionfilterstatus      = SELECT, INSERT
 public.bugsubscriptionfilterimportance  = SELECT, INSERT
 public.bugsubscriptionfiltertag         = SELECT, INSERT

=== modified file 'lib/lp/bugs/configure.zcml'
--- lib/lp/bugs/configure.zcml	2011-03-30 13:33:35 +0000
+++ lib/lp/bugs/configure.zcml	2011-04-04 12:32:01 +0000
@@ -642,6 +642,17 @@
           set_schema=".interfaces.bugsubscriptionfilter.IBugSubscriptionFilterAttributes" />
     </class>
 
+    <!-- BugSubscriptionFilterMute -->
+    <class
+        class=".model.bugsubscriptionfilter.BugSubscriptionFilterMute">
+      <allow
+          interface=".interfaces.bugsubscriptionfilter.IBugSubscriptionFilterMute"/>
+      <require
+          permission="launchpad.Edit"
+          set_schema=".interfaces.bugsubscriptionfilter.IBugSubscriptionFilterMute" />
+    </class>
+
+
     <!-- BugSubscriptionInfo -->
 
     <class class=".model.bug.BugSubscriptionInfo">

=== modified file 'lib/lp/bugs/interfaces/bugsubscriptionfilter.py'
--- lib/lp/bugs/interfaces/bugsubscriptionfilter.py	2011-03-23 15:55:44 +0000
+++ lib/lp/bugs/interfaces/bugsubscriptionfilter.py	2011-04-04 12:32:01 +0000
@@ -6,6 +6,7 @@
 __metaclass__ = type
 __all__ = [
     "IBugSubscriptionFilter",
+    "IBugSubscriptionFilterMute",
     ]
 
 
@@ -19,6 +20,7 @@
 from zope.schema import (
     Bool,
     Choice,
+    Datetime,
     FrozenSet,
     Int,
     Text,
@@ -33,7 +35,10 @@
 from lp.bugs.interfaces.structuralsubscription import (
     IStructuralSubscription,
     )
-from lp.services.fields import SearchTag
+from lp.services.fields import (
+    PersonChoice,
+    SearchTag,
+    )
 
 
 class IBugSubscriptionFilterAttributes(Interface):
@@ -109,3 +114,17 @@
     IBugSubscriptionFilterAttributes, IBugSubscriptionFilterMethods):
     """A bug subscription filter."""
     export_as_webservice_entry()
+
+
+class IBugSubscriptionFilterMute(Interface):
+    """A mute on an IBugSubscriptionFilter."""
+
+    person = PersonChoice(
+        title=_('Person'), required=True, vocabulary='ValidPersonOrTeam',
+        readonly=True, description=_("The person subscribed."))
+    filter = Reference(
+        IBugSubscriptionFilter, title=_("Subscription filter"),
+        description=_("The subscription filter to be muted."))
+    date_created = Datetime(
+        title=_("The date on which the mute was created."), required=False,
+        readonly=True)

=== modified file 'lib/lp/bugs/model/bugsubscriptionfilter.py'
--- lib/lp/bugs/model/bugsubscriptionfilter.py	2011-03-30 15:20:46 +0000
+++ lib/lp/bugs/model/bugsubscriptionfilter.py	2011-04-04 12:32:01 +0000
@@ -4,12 +4,18 @@
 # pylint: disable-msg=E0611,W0212
 
 __metaclass__ = type
-__all__ = ['BugSubscriptionFilter']
+__all__ = [
+    'BugSubscriptionFilter',
+    'BugSubscriptionFilterMute',
+    ]
+
+import pytz
 
 from itertools import chain
 
 from storm.locals import (
     Bool,
+    DateTime,
     Int,
     Reference,
     SQL,
@@ -18,12 +24,16 @@
     )
 from zope.interface import implements
 
+from canonical.database.constants import UTC_NOW
 from canonical.database.enumcol import DBEnum
 from canonical.database.sqlbase import sqlvalues
 from canonical.launchpad import searchbuilder
 from canonical.launchpad.interfaces.lpstorm import IStore
 from lp.bugs.enum import BugNotificationLevel
-from lp.bugs.interfaces.bugsubscriptionfilter import IBugSubscriptionFilter
+from lp.bugs.interfaces.bugsubscriptionfilter import (
+    IBugSubscriptionFilter,
+    IBugSubscriptionFilterMute,
+    )
 from lp.bugs.interfaces.bugtask import (
     BugTaskImportance,
     BugTaskStatus,
@@ -35,6 +45,7 @@
     BugSubscriptionFilterStatus,
     )
 from lp.bugs.model.bugsubscriptionfiltertag import BugSubscriptionFilterTag
+from lp.registry.interfaces.person import validate_person
 from lp.services.database.stormbase import StormBase
 
 
@@ -237,3 +248,23 @@
             # There are no other filters.  We can delete the parent
             # subscription.
             self.structural_subscription.delete()
+
+
+class BugSubscriptionFilterMute(StormBase):
+    """A filter to specialize a *structural* subscription."""
+
+    implements(IBugSubscriptionFilterMute)
+
+    __storm_table__ = "BugSubscriptionFilterMute"
+
+    person_id = Int("person", allow_none=False, validator=validate_person)
+    person = Reference(person_id, "Person.id")
+
+    filter_id = Int("filter", allow_none=False)
+    filter = Reference(filter_id, "StructuralSubscription.id")
+
+    __storm_primary__ = 'person_id', 'filter_id'
+
+    date_created = DateTime(
+        "date_created", allow_none=False, default=UTC_NOW,
+        tzinfo=pytz.UTC)

=== modified file 'lib/lp/registry/model/person.py'
--- lib/lp/registry/model/person.py	2011-03-31 19:10:35 +0000
+++ lib/lp/registry/model/person.py	2011-04-04 12:32:01 +0000
@@ -3965,6 +3965,9 @@
         self._mergeBugNotificationRecipient(cur, from_id, to_id)
         skip.append(('bugnotificationrecipient', 'person'))
 
+        # We ignore BugSubscriptionFilterMutes.
+        skip.append(('bugsubscriptionfiltermute', 'person'))
+
         self._mergePackageBugSupervisor(cur, from_id, to_id)
         skip.append(('packagebugsupervisor', 'bug_supervisor'))