Inbox counts: Add mark all messages as read

Conflicts:

	r2/r2/lib/js.py

Author: umbrae

install-reddit.sh

@@ -613,6 +613,7 @@ function set_consumer_count {
 set_consumer_count log_q 0
 set_consumer_count cloudsearch_q 0
 set_consumer_count scraper_q 1
+set_consumer_count markread_q 1
 set_consumer_count commentstree_q 1
 set_consumer_count newcomments_q 1
 set_consumer_count vote_link_q 1

r2/r2/config/queues.py

@@ -83,6 +83,7 @@ def declare_queues(g):
         "log_q": MessageQueue(bind_to_self=True),
         "cloudsearch_changes": MessageQueue(bind_to_self=True),
         "butler_q": MessageQueue(),
+        "markread_q": MessageQueue(),
     })
 
     if g.shard_link_vote_queues:
@@ -102,4 +103,6 @@ def declare_queues(g):
     queues.newcomments_q << "new_comment"
     queues.butler_q << ("new_comment",
                         "usertext_edited")
+    queues.markread_q << "mark_all_read"
+
     return queues

r2/r2/controllers/api.py

@@ -2689,62 +2689,47 @@ def POST_collapse_message(self, things):
     def POST_uncollapse_message(self, things):
         self.collapse_handler(things, False)
 
-    def unread_handler(self, things, unread):
+    @require_oauth2_scope("privatemessages")
+    @noresponse(VUser(),
+                VModhash(),
+                things = VByName('id', multiple=True, limit=25))
+    @api_doc(api_section.messages)
+    def POST_unread_message(self, things):
         if not things:
             if (errors.TOO_MANY_THING_IDS, 'id') in c.errors:
                 return abort(413)
             else:
                 return abort(400)
 
-        sr_messages = defaultdict(list)
-        comments = []
-        messages = []
-        # Group things by subreddit or type
-        for thing in things:
-            if isinstance(thing, Message):
-                if getattr(thing, 'sr_id', False):
-                    sr_messages[thing.sr_id].append(thing)
-                else:
-                    messages.append(thing)
-            else:
-                comments.append(thing)
-
-        if sr_messages:
-            mod_srs = Subreddit.reverse_moderator_ids(c.user)
-            srs = Subreddit._byID(sr_messages.keys())
-        else:
-            mod_srs = []
-
-        # Batch set items as unread
-        for sr_id, things in sr_messages.items():
-            # Remove the item(s) from the user's inbox
-            queries.set_unread(things, c.user, unread)
-            if sr_id in mod_srs:
-                # Only moderators can change the read status of that
-                # message in the modmail inbox
-                sr = srs[sr_id]
-                queries.set_unread(things, sr, unread)
-        if comments:
-            queries.set_unread(comments, c.user, unread)
-        if messages:
-            queries.set_unread(messages, c.user, unread)
-
+        queries.unread_handler(things, c.user, unread=True)
 
     @require_oauth2_scope("privatemessages")
     @noresponse(VUser(),
                 VModhash(),
                 things = VByName('id', multiple=True, limit=25))
     @api_doc(api_section.messages)
-    def POST_unread_message(self, things):
-        self.unread_handler(things, True)
+    def POST_read_message(self, things):
+        if not things:
+            if (errors.TOO_MANY_THING_IDS, 'id') in c.errors:
+                return abort(413)
+            else:
+                return abort(400)
+
+        queries.unread_handler(things, c.user, unread=False)
 
     @require_oauth2_scope("privatemessages")
     @noresponse(VUser(),
                 VModhash(),
-                things = VByName('id', multiple=True, limit=25))
+                VRatelimit(rate_user=True, prefix="rate_read_all_"))
     @api_doc(api_section.messages)
-    def POST_read_message(self, things):
-        self.unread_handler(things, False)
+    def POST_read_all_messages(self):
+        """Queue up marking all messages for a user as read.
+
+        This may take some time, and returns 202 to acknowledge acceptance of
+        the request.
+        """
+        amqp.add_item('mark_all_read', c.user._fullname)
+        return abort(202)
 
     @require_oauth2_scope("report")
     @noresponse(VUser(),

r2/r2/controllers/listingcontroller.py

@@ -1137,6 +1137,9 @@ def GET_listing(self, where, mark, message, subwhere = None, **env):
             self.mark = 'true'
         if c.user_is_admin:
             c.referrer_policy = "always"
+        if self.where == 'unread':
+            self.next_suggestions_cls = UnreadMessagesSuggestions
+
         return ListingController.GET_listing(self, **env)
 
     @validate(

r2/r2/lib/db/queries.py

@@ -43,7 +43,7 @@
     UserQueryCache,
 )
 from r2.models.last_modified import LastModified
-from r2.lib.utils import SimpleSillyStub
+from r2.lib.utils import in_chunks, SimpleSillyStub
 
 import cPickle as pickle
 
@@ -1166,6 +1166,42 @@ def set_unread(messages, to, unread, mutator=None):
         m.send()
 
 
+def unread_handler(things, user, unread):
+    """Given a user and Things of varying types, set their unread state."""
+    sr_messages = collections.defaultdict(list)
+    comments = []
+    messages = []
+    # Group things by subreddit or type
+    for thing in things:
+        if isinstance(thing, Message):
+            if getattr(thing, 'sr_id', False):
+                sr_messages[thing.sr_id].append(thing)
+            else:
+                messages.append(thing)
+        else:
+            comments.append(thing)
+
+    if sr_messages:
+        mod_srs = Subreddit.reverse_moderator_ids(user)
+        srs = Subreddit._byID(sr_messages.keys())
+    else:
+        mod_srs = []
+
+    # Batch set items as unread
+    for sr_id, things in sr_messages.items():
+        # Remove the item(s) from the user's inbox
+        set_unread(things, user, unread)
+        if sr_id in mod_srs:
+            # Only moderators can change the read status of that
+            # message in the modmail inbox
+            sr = srs[sr_id]
+            set_unread(things, sr, unread)
+    if comments:
+        set_unread(comments, user, unread)
+    if messages:
+        set_unread(messages, user, unread)
+
+
 def unnotify(thing, possible_recipients=None):
     """Given a Thing, remove any notifications to possible recipients for it.
 
@@ -1762,3 +1798,15 @@ def _handle_vote(msg):
         timer.flush()
 
     amqp.consume_items(qname, _handle_vote, verbose = False)
+
+
+def consume_mark_all_read():
+    @g.stats.amqp_processor('markread_q')
+    def process_mark_all_read(msg):
+        user = Account._by_fullname(msg.body)
+        inbox_fullnames = get_unread_inbox(user)
+        for inbox_chunk in in_chunks(inbox_fullnames, size=100):
+            things = Thing._by_fullname(inbox_chunk, return_dict=False)
+            unread_handler(things, user, unread=False)
+
+    amqp.consume_items('markread_q', process_mark_all_read)

r2/r2/lib/js.py

@@ -473,6 +473,7 @@ def use(self):
     "recommender.js",
     "report.js",
     "saved.js",
+    "messages.js",
     PermissionsDataSource({
         "moderator": ModeratorPermissionSet,
         "moderator_invite": ModeratorPermissionSet,

r2/r2/lib/pages/pages.py

@@ -4723,6 +4723,11 @@ def __init__(self):
                 self.suggestion_type = "random"
 
 
+class UnreadMessagesSuggestions(Templated):
+    """Let a user mark all as read if they have > 1 page of unread messages."""
+    pass
+
+
 class ExploreItem(Templated):
     """For managing recommended content."""
 

r2/r2/public/static/css/reddit.less

@@ -52,7 +52,7 @@
         box-shadow: inset 0 1px 1px 1px fadeout(black, 90%);
     }
 
-    &:disabled {
+    &:disabled, &.disabled {
         .linear-gradient(#e9edf1, #dce3ea) !important;
         color: #999999 !important;
         text-shadow: 0 1px 0 lighten(#dce3ea, 15%) !important;
@@ -1248,7 +1248,7 @@ body.with-listing-chooser.explore-page #header .pagename {
 }
 
 .next-suggestions {
-    margin-left: 1.5em;
+    margin-left: 0.75em;
 
     a {
         background: none;
@@ -1257,6 +1257,17 @@ body.with-listing-chooser.explore-page #header .pagename {
     }
 }
 
+.next-suggestions .mark-all-read-container .throbber {
+  position: absolute;
+  margin-left: 5px;
+  margin-top: -2px;
+  padding-left: 22px;
+  min-width: 18px;
+  width: auto;
+  font-size: 10px;
+  line-height: 16px;
+}
+
 /* corner help */
 .help a.help {
     color: #808080;

r2/r2/public/static/js/base.js

@@ -122,6 +122,7 @@ $(function() {
         r.multi.init()
         r.recommend.init()
         r.saved.init()
+        r.messages.init()
         r.resAdvisory.init()
         r.filter.init()
     } catch (err) {

r2/r2/public/static/js/messages.js

@@ -0,0 +1,51 @@
+r.messages = {}
+
+/**
+ * After triggering a mark-as-read request, poll our account to see if our messages have been cleared.
+ * If our messages have not been cleared after a number of iterations, it's likely we had a
+ * message race or other issue, redirect back to stop polling and potentially display the new message.
+ */
+r.messages.pollUnread = _.debounce(function(count) {
+  count = count + 1 || 1;
+
+  // Took too long, redirect in case of issue.
+  if (count > 20) {
+    document.location = "/message/unread";
+    return;
+  }
+
+  r.ajax({
+    type: 'GET',
+    url: '/api/me.json',
+    success: function(response) {
+      if (!response['data']['has_mail']) {
+        document.location = "/message/unread";
+      } else {
+        r.messages.pollUnread(count);
+      }
+    },
+  });
+}, 2000);
+
+r.messages.init = function() {
+  $('a.mark-all-read').on('click', function(e) {
+    var $this = $(this);
+
+    e.preventDefault();
+    e.stopPropagation();
+
+    if ($this.hasClass('disabled')) {
+      return;
+    }
+
+    $this.addClass('disabled');
+    $this.parent().addClass('working');
+
+    r.ajax({
+      type: 'POST',
+      url: '/api/read_all_messages',
+      data: {},
+      success: r.messages.pollUnread,
+    });
+  });
+}

r2/r2/templates/unreadmessagessuggestions.html

@@ -0,0 +1,29 @@
+## The contents of this file are subject to the Common Public Attribution
+## License Version 1.0. (the "License"); you may not use this file except in
+## compliance with the License. You may obtain a copy of the License at
+## http://code.reddit.com/LICENSE. The License is based on the Mozilla Public
+## License Version 1.1, but Sections 14 and 15 have been added to cover use of
+## software over a computer network and provide for limited attribution for the
+## Original Developer. In addition, Exhibit A has been modified to be
+## consistent with Exhibit B.
+##
+## Software distributed under the License is distributed on an "AS IS" basis,
+## WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
+## the specific language governing rights and limitations under the License.
+##
+## The Original Code is reddit.
+##
+## The Original Developer is the Initial Developer.  The Initial Developer of
+## the Original Code is reddit Inc.
+##
+## All portions of the code written by reddit are Copyright (c) 2006-2014
+## reddit Inc. All Rights Reserved.
+###############################################################################
+
+<span class="next-suggestions">
+  ${_('or')}
+  <span class="mark-all-read-container">
+    <a class="basic-button mark-all-read" href="#">${_('mark all as read')}</a>
+    <span class="throbber">${_('(this may take a while)')}</span>
+  </span>
+</span>

upstart/reddit-consumer-markread_q.conf

@@ -0,0 +1,14 @@
+description "mark all messages as read for a user"
+
+instance $x
+
+stop on reddit-stop or runlevel [016]
+
+respawn
+respawn limit 10 5
+
+nice 10
+script
+    . /etc/default/reddit
+    wrap-job paster run --proctitle markread_q$x $REDDIT_INI $REDDIT_ROOT/r2/lib/db/queries.py -c 'consume_mark_all_read()'
+end script