Add threading notice stream class to threaded pages

For those pages where threading is important, we now have an extra filtering stream
class to skip stuff in conversations that have "already" been seen.

lib/groupnoticestream.php

@@ -44,16 +44,18 @@ if (!defined('STATUSNET')) {
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  * @link      http://status.net/
  */
-class GroupNoticeStream extends ScopingNoticeStream
+class GroupNoticeStream extends ThreadingNoticeStream
 {
     function __construct($group, $profile = -1)
     {
         if (is_int($profile) && $profile == -1) {
             $profile = Profile::current();
         }
-        parent::__construct(new CachingNoticeStream(new RawGroupNoticeStream($group),
-                                                    'user_group:notice_ids:' . $group->id),
-                            $profile);
+
+        $stream = new ScopingNoticeStream(new CachingNoticeStream(new RawGroupNoticeStream($group),
+                                                                  'user_group:notice_ids:' . $group->id),
+                                          $profile);
+        parent::__construct($stream);
     }
 }
 

lib/inboxnoticestream.php

@@ -20,7 +20,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
- * @category  Cache
+ * @category  
  * @package   StatusNet
  * @author    Evan Prodromou <evan@status.net>
  * @copyright 2011 StatusNet, Inc.
@@ -44,7 +44,7 @@ if (!defined('STATUSNET')) {
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  * @link      http://status.net/
  */
-class InboxNoticeStream extends ScopingNoticeStream
+class InboxNoticeStream extends ThreadingNoticeStream
 {
     /**
      * Constructor
@@ -58,7 +58,8 @@ class InboxNoticeStream extends ScopingNoticeStream
         }
         // Note: we don't use CachingNoticeStream since RawInboxNoticeStream
         // uses Inbox::staticGet(), which is cached.
-        parent::__construct(new RawInboxNoticeStream($user), $profile);
+        $stream = new ScopingNoticeStream(new RawInboxNoticeStream($user), $profile);
+        parent::__construct($stream);
     }
 }
 

lib/publicnoticestream.php

@@ -45,13 +45,13 @@ if (!defined('STATUSNET')) {
  * @link      http://status.net/
  */
 
-class PublicNoticeStream extends ScopingNoticeStream
+class PublicNoticeStream extends ThreadingNoticeStream
 {
     function __construct($profile=null)
     {
-        parent::__construct(new CachingNoticeStream(new RawPublicNoticeStream(),
-                                                    'public'),
-                            $profile);
+        $stream = new ScopingNoticeStream(new CachingNoticeStream(new RawPublicNoticeStream(), 'public'),
+                                          $profile);
+        parent::__construct($stream);
     }
 }
 

lib/threadingnoticestream.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2011, StatusNet, Inc.
+ *
+ * Notice stream that's good for threading lists
+ * 
+ * PHP version 5
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Notice stream
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2011 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    // This check helps protect against security problems;
+    // your code file can't be executed directly from the web.
+    exit(1);
+}
+
+/**
+ * This notice stream filters notices by whether their conversation
+ * has been seen before. It's a good (well, OK) way to get streams
+ * for a ThreadedNoticeList display.
+ *
+ * @category  Notice stream
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2011 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link      http://status.net/
+ */
+
+class ThreadingNoticeStream extends FilteringNoticeStream
+{
+    protected $seen = array();
+
+    function getNotices($offset, $limit, $sinceId=null, $maxId=null)
+    {
+        // Clear this each time we're called
+        $this->seen = array();
+        return parent::getNotices($offset, $limit, $sinceId, $maxId);
+    }
+
+    function filter($notice)
+    {
+        if (!array_key_exists($notice->id, $this->seen)) {
+            $this->seen[$notice->id] = true;
+            return true;
+        } else {
+            return false;
+        }
+    }
+}