move core schema to class files

[quix0rs-gnu-social.git] / classes / Fave.php

diff --git a/classes/Fave.php b/classes/Fave.php
index 7ca9ade7f04b846c53982c8507fce5293436d793..c5dae31b0257fd24a7301e226c99e937fffba705 100644 (file)
--- a/classes/Fave.php
+++ b/classes/Fave.php
@@ -4,7 +4,7 @@
  */
 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
 
-class Fave extends Memcached_DataObject
+class Fave extends Managed_DataObject
 {
     ###START_AUTOCODE
     /* the code below is auto generated do not remove the above tag */
@@ -21,6 +21,27 @@ class Fave extends Memcached_DataObject
     /* the code above is auto generated do not remove the tag below */
     ###END_AUTOCODE
 
+    public static function schemaDef()
+    {
+        return array(
+            'fields' => array(
+                'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'),
+                'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'),
+                'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+            ),
+            'primary key' => array('notice_id', 'user_id'),
+            'foreign keys' => array(
+                'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
+                'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites
+            ),
+            'indexes' => array(
+                'fave_notice_id_idx' => array('notice_id'),
+                'fave_user_id_idx' => array('user_id', 'modified'),
+                'fave_modified_idx' => array('modified'),
+            ),
+        );
+    }
+
     /**
      * Save a favorite record.
      * @fixme post-author notification should be moved here
@@ -44,6 +65,7 @@ class Fave extends Memcached_DataObject
                 common_log_db_error($fave, 'INSERT', __FILE__);
                 return false;
             }
+            self::blow('fave:list-ids:notice_id:%d', $fave->notice_id);
 
             Event::handle('EndFavorNotice', array($profile, $notice));
         }
@@ -61,6 +83,7 @@ class Fave extends Memcached_DataObject
         if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
 
             $result = parent::delete();
+            self::blow('fave:list-ids:notice_id:%d', $this->notice_id);
 
             if ($result) {
                 Event::handle('EndDisfavorNotice', array($profile, $notice));
@@ -75,58 +98,83 @@ class Fave extends Memcached_DataObject
         return Memcached_DataObject::pkeyGet('Fave', $kv);
     }
 
-    function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false)
+    function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
     {
-        $ids = Notice::stream(array('Fave', '_streamDirect'),
-                              array($user_id, $own),
-                              ($own) ? 'fave:ids_by_user_own:'.$user_id :
-                              'fave:ids_by_user:'.$user_id,
-                              $offset, $limit);
-        return $ids;
+        $stream = new FaveNoticeStream($user_id, $own);
+
+        return $stream->getNotices($offset, $limit, $since_id, $max_id);
     }
 
-    function _streamDirect($user_id, $own, $offset, $limit, $since_id, $max_id)
+    function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
     {
-        $fav = new Fave();
-        $qry = null;
-
-        if ($own) {
-            $qry  = 'SELECT fave.* FROM fave ';
-            $qry .= 'WHERE fave.user_id = ' . $user_id . ' ';
-        } else {
-             $qry =  'SELECT fave.* FROM fave ';
-             $qry .= 'INNER JOIN notice ON fave.notice_id = notice.id ';
-             $qry .= 'WHERE fave.user_id = ' . $user_id . ' ';
-             $qry .= 'AND notice.is_local != ' . Notice::GATEWAY . ' ';
-        }
+        $stream = new FaveNoticeStream($user_id, $own);
 
-        if ($since_id != 0) {
-            $qry .= 'AND notice_id > ' . $since_id . ' ';
-        }
+        return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
+    }
 
-        if ($max_id != 0) {
-            $qry .= 'AND notice_id <= ' . $max_id . ' ';
-        }
+    function asActivity()
+    {
+        $notice  = Notice::staticGet('id', $this->notice_id);
+        $profile = Profile::staticGet('id', $this->user_id);
 
-        // NOTE: we sort by fave time, not by notice time!
+        $act = new Activity();
 
-        $qry .= 'ORDER BY modified DESC ';
+        $act->verb = ActivityVerb::FAVORITE;
 
-        if (!is_null($offset)) {
-            $qry .= "LIMIT $limit OFFSET $offset";
-        }
+        // FIXME: rationalize this with URL below
 
-        $fav->query($qry);
+        $act->id   = TagURI::mint('favor:%d:%d:%s',
+                                  $profile->id,
+                                  $notice->id,
+                                  common_date_iso8601($this->modified));
 
-        $ids = array();
+        $act->time    = strtotime($this->modified);
+        // TRANS: Activity title when marking a notice as favorite.
+        $act->title   = _("Favor");
+        // TRANS: Ntofication given when a user marks a notice as favorite.
+        // TRANS: %1$s is a user nickname or full name, %2$s is a notice URI.
+        $act->content = sprintf(_('%1$s marked notice %2$s as a favorite.'),
+                               $profile->getBestName(),
+                               $notice->uri);
 
-        while ($fav->fetch()) {
-            $ids[] = $fav->notice_id;
-        }
+        $act->actor     = ActivityObject::fromProfile($profile);
+        $act->objects[] = ActivityObject::fromNotice($notice);
+
+        $url = common_local_url('AtomPubShowFavorite',
+                                          array('profile' => $this->user_id,
+                                                'notice'  => $this->notice_id));
+
+        $act->selfLink = $url;
+        $act->editLink = $url;
+
+        return $act;
+    }
+
+    /**
+     * Fetch a stream of favorites by profile
+     *
+     * @param integer $profileId Profile that faved
+     * @param integer $offset    Offset from last
+     * @param integer $limit     Number to get
+     *
+     * @return mixed stream of faves, use fetch() to iterate
+     *
+     * @todo Cache results
+     * @todo integrate with Fave::stream()
+     */
+
+    static function byProfile($profileId, $offset, $limit)
+    {
+        $fav = new Fave();
+
+        $fav->user_id = $profileId;
+
+        $fav->orderBy('modified DESC');
+
+        $fav->limit($offset, $limit);
 
-        $fav->free();
-        unset($fav);
+        $fav->find();
 
-        return $ids;
+        return $fav;
     }
 }