Merge lp:~msapiro/mailman/topics into lp:mailman/2.2

[Mark Sapiro]

[Mark Sapiro (msapiro)]

This proposal is to merge a fix for bug #255418 to allow a list member to receive all messages which match no defined topic without receiving any messages which match any topics. Review of both the design of the fix and the code are requested.

[lp:~msapiro/mailman/topics]

1010. By Mark Sapiro on 2009-01-29

Merged changes from 2.2 branch.

1011. By Mark Sapiro on 2009-02-04

Merged changes from 2.2 branch.

1012. By Mark Sapiro on 2009-02-06

Merged changes from 2.2 branch

1013. By Mark Sapiro on 2009-02-08

Merged changes from 2.2 branch.

1014. By Mark Sapiro on 2009-02-16

Merged changes from 2.2 branch.

1015. By Mark Sapiro on 2009-02-23

Merged changes from 2.2 branch.

1016. By Mark Sapiro on 2009-05-25

Merges from 2.2 branch

1017. By Mark Sapiro on 2009-05-25

Merges from 2.2 branch

1018. By Mark Sapiro on 2009-08-07

Merged changes from 2.2 branch

1019. By Mark Sapiro on 2009-08-14

Merged change from 2.2 branch

1020. By Mark Sapiro on 2009-09-14

Merged changes from 2.2 branch.

1021. By Mark Sapiro on 2009-10-10

Merged changes from 2.2 branch.

1022. By Mark Sapiro on 2014-12-03

Merged the 2.2 branch.

Unmerged revisions

1022. By Mark Sapiro on 2014-12-03

Merged the 2.2 branch.

1021. By Mark Sapiro on 2009-10-10

Merged changes from 2.2 branch.

1020. By Mark Sapiro on 2009-09-14

Merged changes from 2.2 branch.

1019. By Mark Sapiro on 2009-08-14

Merged change from 2.2 branch

1018. By Mark Sapiro on 2009-08-07

Merged changes from 2.2 branch

1017. By Mark Sapiro on 2009-05-25

Merges from 2.2 branch

1016. By Mark Sapiro on 2009-05-25

Merges from 2.2 branch

1015. By Mark Sapiro on 2009-02-23

Merged changes from 2.2 branch.

1014. By Mark Sapiro on 2009-02-16

Merged changes from 2.2 branch.

1013. By Mark Sapiro on 2009-02-08

Merged changes from 2.2 branch.

=== modified file 'Mailman/Cgi/options.py'
--- Mailman/Cgi/options.py	2014-11-08 01:22:26 +0000
+++ Mailman/Cgi/options.py	2014-12-03 23:52:29 +0000
@@ -569,7 +569,6 @@
                            ('disablemail', mm_cfg.DisableDelivery),
                            ('conceal',     mm_cfg.ConcealSubscription),
                            ('remind',      mm_cfg.SuppressPasswordReminder),
-                           ('rcvtopic',    mm_cfg.ReceiveNonmatchingTopics),
                            ('nodupes',     mm_cfg.DontReceiveDuplicates),
                            ):
             try:
@@ -619,6 +618,7 @@
                 topicnames = [topicnames]
             # unquote the topic names
             topicnames = [urllib.unquote_plus(n) for n in topicnames]
+        rcvtopic = int(cgidata.getvalue('rcvtopic'), 0)
 
         # The standard sigterm handler (see above)
         def sigterm_handler(signum, frame, mlist=mlist):
@@ -646,6 +646,21 @@
                         mustdigest = 1
             # Set the topics information.
             mlist.setMemberTopics(user, topicnames)
+            # And the non-matching option
+            if rcvtopic == 1:
+                mlist.setMemberOption(user, mm_cfg.ReceiveNonmatchingTopics, 1)
+            elif rcvtopic == 0:
+                mlist.setMemberOption(user, mm_cfg.ReceiveNonmatchingTopics, 0)
+                if topicnames:
+                    doc.addError(
+                             _('With selected topics All is coerced to Only'),
+                             tag=_('Notice: '))
+            else:
+                mlist.setMemberOption(user, mm_cfg.ReceiveNonmatchingTopics, 0)
+                if not topicnames:
+                    doc.addError(
+                           _('With no selected topics Only is coerced to All'),
+                           tag=_('Notice: '))
             mlist.Save()
         finally:
             mlist.Unlock()
@@ -854,10 +869,24 @@
     else:
         topicsfield = _('<em>No topics defined</em>')
     replacements['<mm-topics>'] = topicsfield
-    replacements['<mm-suppress-nonmatching-topics>'] = (
-        mlist.FormatOptionButton(mm_cfg.ReceiveNonmatchingTopics, 0, user))
-    replacements['<mm-receive-nonmatching-topics>'] = (
-        mlist.FormatOptionButton(mm_cfg.ReceiveNonmatchingTopics, 1, user))
+    # Figure out the nonmatching selection
+    if not mlist.topics or (not usertopics and not
+                mlist.getMemberOption(user, mm_cfg.ReceiveNonmatchingTopics)):
+        topicselectval = 0
+    elif (usertopics and not
+                mlist.getMemberOption(user, mm_cfg.ReceiveNonmatchingTopics)):
+        topicselectval = 2
+    else:
+        topicselectval = 1
+    table = Table(border="0")
+    table.AddRow([RadioButton('rcvtopic', 2, checked=topicselectval==2),
+                  _('Only')])
+    table.AddRow([RadioButton('rcvtopic', 1, checked=topicselectval==1),
+                  _('Non-match')])
+    table.AddRow([RadioButton('rcvtopic', 0, checked=topicselectval==0),
+                  _('All')])
+    topicselection = table.Format()
+    replacements['<mm-nonmatching-topics-selection>'] = topicselection
 
     if cpuser is not None:
         replacements['<mm-case-preserved-user>'] = _('''
 
=== modified file 'Mailman/Gui/Topics.py'
--- Mailman/Gui/Topics.py	2009-02-09 23:30:34 +0000
+++ Mailman/Gui/Topics.py	2014-12-03 23:52:29 +0000
@@ -56,8 +56,10 @@
              match against a topic filter, the message is logically placed
              into a topic <em>bucket</em>.  Each user can then choose to only
              receive messages from the mailing list for a particular topic
-             bucket (or buckets).  Any message not categorized in a topic
-             bucket registered with the user is not delivered to the list.
+             bucket (or buckets).  Any message categorized only in topic
+             buckets not registered with the user is not delivered to the
+             user.  Additionally, the user can also choose whether or not to
+             receive those messages not categorized in any topic bucket.
 
              <p>Note that this feature only works with regular delivery, not
              digest delivery.
 
=== modified file 'Mailman/Handlers/CalcRecips.py'
--- Mailman/Handlers/CalcRecips.py	2014-09-19 16:24:03 +0000
+++ Mailman/Handlers/CalcRecips.py	2014-12-03 23:52:29 +0000
@@ -116,9 +116,10 @@
         # who are interested in one of the hit topics.
         for user in recips:
             utopics = mlist.getMemberTopics(user)
-            if not utopics:
-                # This user is not interested in any topics, so they get all
-                # postings.
+            if (not utopics and
+                not mlist.getMemberOption(user,
+                                          mm_cfg.ReceiveNonmatchingTopics)):
+                # This user wants all postings.
                 continue
             # BAW: Slow, first-match, set intersection!
             for topic in utopics:
@@ -132,8 +133,8 @@
     else:
         # The semantics for a message that did not hit any of the pre-canned
         # topics is to troll through the membership list, looking for users
-        # who selected at least one topic of interest, but turned on
-        # ReceiveNonmatchingTopics.
+        # who selected no topics, or who selected at least one topic of
+        # interest, but turned on ReceiveNonmatchingTopics.
         for user in recips:
             if not mlist.getMemberTopics(user):
                 # The user did not select any topics of interest, so he gets
 
=== modified file 'Mailman/versions.py'
--- Mailman/versions.py	2014-10-17 15:43:49 +0000
+++ Mailman/versions.py	2014-12-03 23:52:29 +0000
@@ -322,6 +322,16 @@
         for name, pattern, description, emptyflag in stored_state['topics']:
             pattern = Utils.strip_verbose_pattern(pattern)
             l.topics.append((name, pattern, description, emptyflag))
+    #
+    # If pre 2.2 list has topics and regular member has no selection, make
+    # sure ReceiveNonmatchingTopics is off for the member.
+    #
+    if stored_state['data_version'] <= 97:
+        if l.topics:
+            for member in l.members.keys():
+                if not l.getMemberTopics(member):
+                    l.setMemberOption(member,
+                                      mm_cfg.ReceiveNonmatchingTopics, 0)
     # from_is_list was called author_is_list in 2.1.16rc2 (only).
     PreferStored('author_is_list', 'from_is_list',
                  mm_cfg.DEFAULT_FROM_IS_LIST)
 
=== modified file 'templates/en/options.html'
--- templates/en/options.html	2004-11-13 23:57:05 +0000
+++ templates/en/options.html	2014-12-03 23:52:29 +0000
@@ -251,35 +251,30 @@
                 By selecting one or more topics, you can filter the
                 traffic on the mailing list, so as to receive only a
                 subset of the messages.  If a message matches one of
-                your selected topics, then you will get the message,
-                otherwise you will not.
+                your selected topics, then you will get the message;
+                if it matches only non-selected topics, you will not.
 
                 <p>If a message does not match any topic, the delivery
-                rule depends on the setting of the option below.  If
-                you do not select any topics of interest, you will get
-                all the messages sent to the mailing list.
+                rule depends on the setting of the option below.
+
+                <p>Topics apply only to individual messages.  Digest members
+                receive digests containing all messages regardless of topic.
         </td><td bgcolor="#cccccc">
         <mm-topics>
         </td></tr>
 
     <tr><td bgcolor="#cccccc">
-        <strong>Do you want to receive messages that do not match any
-                topic filter?</strong><p>
-
-                This option only takes effect if you've subscribed to
-                at least one topic above.  It describes what the
-                default delivery rule is for messages that don't match
-                any topic filter.  Selecting <em>No</em> says that if
-                the message does not match any topic filters, then you
-                won't get the message, while selecting <em>Yes</em>
-                says to deliver such non-matching messages to you.
-
-                <p>If no topics of interest are selected above, then
-                you will receive every message sent to the mailing
-                list.
+        <strong>Which messages do you want to receive?</strong><p>
+                This option describes what the delivery rule is if
+                there are defined topics above.  Selecting <em>Only</em>
+                says that you will only receive messages which match
+                topics you have selected above.  Selecting <em>Non-match</em>
+                says that you will receive messages which match your
+                selected topics if any plus those messages which don't
+                match any topics.  Selecting <em>All</em> says you will
+                receive all messages regardless of topic.
         </td><td bgcolor="#cccccc">
-        <mm-suppress-nonmatching-topics>No<br>
-        <mm-receive-nonmatching-topics>Yes
+        <mm-nonmatching-topics-selection>
         </td></tr>
 
     <tr><td bgcolor="#cccccc">