]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/Inbox.php
Qvitter API changes (thanks hannes2peer)
[quix0rs-gnu-social.git] / classes / Inbox.php
index be62611a16504416675d474e6d1920d6d6080273..630ed3ac41aa084791427ffba809c30af7279529 100644 (file)
@@ -29,7 +29,7 @@
 
 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
 
-class Inbox extends Memcached_DataObject
+class Inbox extends Managed_DataObject
 {
     const BOXCAR = 128;
     const MAX_NOTICES = 1024;
@@ -41,21 +41,26 @@ class Inbox extends Memcached_DataObject
     public $user_id;                         // int(4)  primary_key not_null
     public $notice_ids;                      // blob
 
-    /* Static get */
-    function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Inbox',$k,$v); }
-
     /* the code above is auto generated do not remove the tag below */
     ###END_AUTOCODE
 
-    function sequenceKey()
+    public static function schemaDef()
     {
-        return array(false, false, false);
+        return array(
+            'fields' => array(
+                'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the notice'),
+                'notice_ids' => array('type' => 'blob', 'description' => 'packed list of notice ids'),
+            ),
+            'primary key' => array('user_id'),
+            'foreign keys' => array(
+                'inbox_user_id_fkey' => array('user', array('user_id' => 'id')),
+            ),
+        );
     }
 
     /**
      * Create a new inbox from existing Notice_inbox stuff
      */
-
     static function initialize($user_id)
     {
         $inbox = Inbox::fromNoticeInbox($user_id);
@@ -96,17 +101,31 @@ class Inbox extends Memcached_DataObject
         $inbox = new Inbox();
 
         $inbox->user_id = $user_id;
-        $inbox->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
+        $inbox->pack($ids);
         $inbox->fake = true;
 
         return $inbox;
     }
 
+    /**
+     * Append the given notice to the given user's inbox.
+     * Caching updates are managed for the inbox itself.
+     *
+     * If the notice is already in this inbox, the second
+     * add will be silently dropped.
+     *
+     * @param int @user_id
+     * @param int $notice_id
+     * @return boolean success
+     */
     static function insertNotice($user_id, $notice_id)
     {
-        $inbox = DB_DataObject::staticGet('inbox', 'user_id', $user_id);
-
-        if (empty($inbox)) {
+        // Going straight to the DB rather than trusting our caching
+        // during an update. Note: not using DB_DataObject::staticGet,
+        // which is unsafe to use directly (in-process caching causes
+        // memory leaks, which accumulate in queue processes).
+        $inbox = new Inbox();
+        if (!$inbox->get('user_id', $user_id)) {
             $inbox = Inbox::initialize($user_id);
         }
 
@@ -114,6 +133,13 @@ class Inbox extends Memcached_DataObject
             return false;
         }
 
+        $ids = $inbox->unpack();
+        if (in_array(intval($notice_id), $ids)) {
+            // Already in there, we probably re-ran some inbox adds
+            // due to an error. Skip the dupe silently.
+            return true;
+        }
+
         $result = $inbox->query(sprintf('UPDATE inbox '.
                                         'set notice_ids = concat(cast(0x%08x as binary(4)), '.
                                         'substr(notice_ids, 1, %d)) '.
@@ -137,96 +163,20 @@ class Inbox extends Memcached_DataObject
         }
     }
 
-    function stream($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
+    /**
+     * Saves a list of integer notice_ids into a packed blob in this object.
+     * @param array $ids list of integer notice_ids
+     */
+    function pack(array $ids)
     {
-        $inbox = Inbox::staticGet('user_id', $user_id);
-
-        if (empty($inbox)) {
-            $inbox = Inbox::fromNoticeInbox($user_id);
-            if (empty($inbox)) {
-                return array();
-            } else {
-                $inbox->encache();
-            }
-        }
-
-        $ids = unpack('N*', $inbox->notice_ids);
-
-        if (!empty($since_id)) {
-            $newids = array();
-            foreach ($ids as $id) {
-                if ($id > $since_id) {
-                    $newids[] = $id;
-                }
-            }
-            $ids = $newids;
-        }
-
-        if (!empty($max_id)) {
-            $newids = array();
-            foreach ($ids as $id) {
-                if ($id <= $max_id) {
-                    $newids[] = $id;
-                }
-            }
-            $ids = $newids;
-        }
-
-        $ids = array_slice($ids, $offset, $limit);
-
-        return $ids;
+        $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
     }
 
     /**
-     * Wrapper for Inbox::stream() and Notice::getStreamByIds() returning
-     * additional items up to the limit if we were short due to deleted
-     * notices still being listed in the inbox.
-     *
-     * The fast path (when no items are deleted) should be just as fast; the
-     * offset parameter is applied *before* lookups for maximum efficiency.
-     *
-     * This means offset-based paging may show duplicates, but similar behavior
-     * already exists when new notices are posted between page views, so we
-     * think people will be ok with this until id-based paging is introduced
-     * to the user interface.
-     *
-     * @param int $user_id
-     * @param int $offset skip past the most recent N notices (after since_id checks)
-     * @param int $limit
-     * @param mixed $since_id return only notices after but not including this id
-     * @param mixed $max_id return only notices up to and including this id
-     * @param mixed $since obsolete/ignored
-     * @param mixed $own ignored?
-     * @return array of Notice objects
-     *
-     * @todo consider repacking the inbox when this happens?
+     * @return array of integer notice_ids
      */
-    function streamNotices($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
+    function unpack()
     {
-        $ids = self::stream($user_id, $offset, self::MAX_NOTICES, $since_id, $max_id, $since, $own);
-
-        // Do a bulk lookup for the first $limit items
-        // Fast path when nothing's deleted.
-        $firstChunk = array_slice($ids, 0, $limit);
-        $notices = Notice::getStreamByIds($firstChunk);
-
-        $wanted = count($firstChunk); // raw entry count in the inbox up to our $limit
-        if ($notices->N >= $wanted) {
-            return $notices;
-        }
-
-        // There were deleted notices, we'll need to look for more.
-        assert($notices instanceof ArrayWrapper);
-        $items = $notices->_items;
-        $remainder = array_slice($ids, $limit);
-
-        while (count($items) < $wanted && count($remainder) > 0) {
-            $notice = Notice::staticGet(array_shift($remainder));
-            if ($notice) {
-                $items[] = $notice;
-            } else {
-            }
-        }
-        return new ArrayWrapper($items);
+        return unpack('N*', $this->notice_ids);
     }
 }