classes/Fave.php

   1 <?php
   2 /**
   3  * Table Definition for fave
   4  */
   5 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
   6
   7 class Fave extends Managed_DataObject
   8 {
   9     ###START_AUTOCODE
  10     /* the code below is auto generated do not remove the above tag */
  11
  12     public $__table = 'fave';                            // table name
  13     public $notice_id;                       // int(4)  primary_key not_null
  14     public $user_id;                         // int(4)  primary_key not_null
  15     public $uri;                             // varchar(255)
  16     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  17
  18     /* Static get */
  19     function staticGet($k,$v=null)
  20     { return Memcached_DataObject::staticGet('Fave',$k,$v); }
  21
  22     /* the code above is auto generated do not remove the tag below */
  23     ###END_AUTOCODE
  24
  25     public static function schemaDef()
  26     {
  27         return array(
  28             'fields' => array(
  29                 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'),
  30                 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'),
  31                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
  32                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  33             ),
  34             'primary key' => array('notice_id', 'user_id'),
  35             'unique keys' => array(
  36                 'fave_uri_key' => array('uri'),
  37             ),
  38             'foreign keys' => array(
  39                 'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
  40                 'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites
  41             ),
  42             'indexes' => array(
  43                 'fave_notice_id_idx' => array('notice_id'),
  44                 'fave_user_id_idx' => array('user_id', 'modified'),
  45                 'fave_modified_idx' => array('modified'),
  46             ),
  47         );
  48     }
  49
  50     /**
  51      * Save a favorite record.
  52      * @fixme post-author notification should be moved here
  53      *
  54      * @param Profile $profile the local or remote user who likes
  55      * @param Notice $notice the notice that is liked
  56      * @return mixed false on failure, or Fave record on success
  57      */
  58     static function addNew(Profile $profile, Notice $notice) {
  59
  60         $fave = null;
  61
  62         if (Event::handle('StartFavorNotice', array($profile, $notice, &$fave))) {
  63
  64             $fave = new Fave();
  65
  66             $fave->user_id   = $profile->id;
  67             $fave->notice_id = $notice->id;
  68             $fave->modified  = common_sql_now();
  69             $fave->uri       = self::newURI($fave->user_id,
  70                                             $fave->notice_id,
  71                                             $fave->modified);
  72             if (!$fave->insert()) {
  73                 common_log_db_error($fave, 'INSERT', __FILE__);
  74                 return false;
  75             }
  76             self::blow('fave:list-ids:notice_id:%d', $fave->notice_id);
  77
  78             Event::handle('EndFavorNotice', array($profile, $notice));
  79         }
  80
  81         return $fave;
  82     }
  83
  84     function delete()
  85     {
  86         $profile = Profile::staticGet('id', $this->user_id);
  87         $notice  = Notice::staticGet('id', $this->notice_id);
  88
  89         $result = null;
  90
  91         if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
  92
  93             $result = parent::delete();
  94             self::blow('fave:list-ids:notice_id:%d', $this->notice_id);
  95
  96             if ($result) {
  97                 Event::handle('EndDisfavorNotice', array($profile, $notice));
  98             }
  99         }
 100
 101         return $result;
 102     }
 103
 104     function pkeyGet($kv)
 105     {
 106         return Memcached_DataObject::pkeyGet('Fave', $kv);
 107     }
 108
 109     function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
 110     {
 111         $stream = new FaveNoticeStream($user_id, $own);
 112
 113         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 114     }
 115
 116     function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
 117     {
 118         $stream = new FaveNoticeStream($user_id, $own);
 119
 120         return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
 121     }
 122
 123     function asActivity()
 124     {
 125         $notice  = Notice::staticGet('id', $this->notice_id);
 126         $profile = Profile::staticGet('id', $this->user_id);
 127
 128         $act = new Activity();
 129
 130         $act->verb = ActivityVerb::FAVORITE;
 131
 132         // FIXME: rationalize this with URL below
 133
 134         $act->id   = $this->getURI();
 135
 136         $act->time    = strtotime($this->modified);
 137         // TRANS: Activity title when marking a notice as favorite.
 138         $act->title   = _("Favor");
 139         // TRANS: Ntofication given when a user marks a notice as favorite.
 140         // TRANS: %1$s is a user nickname or full name, %2$s is a notice URI.
 141         $act->content = sprintf(_('%1$s marked notice %2$s as a favorite.'),
 142                                $profile->getBestName(),
 143                                $notice->uri);
 144
 145         $act->actor     = ActivityObject::fromProfile($profile);
 146         $act->objects[] = ActivityObject::fromNotice($notice);
 147
 148         $url = common_local_url('AtomPubShowFavorite',
 149                                           array('profile' => $this->user_id,
 150                                                 'notice'  => $this->notice_id));
 151
 152         $act->selfLink = $url;
 153         $act->editLink = $url;
 154
 155         return $act;
 156     }
 157
 158     /**
 159      * Fetch a stream of favorites by profile
 160      *
 161      * @param integer $profileId Profile that faved
 162      * @param integer $offset    Offset from last
 163      * @param integer $limit     Number to get
 164      *
 165      * @return mixed stream of faves, use fetch() to iterate
 166      *
 167      * @todo Cache results
 168      * @todo integrate with Fave::stream()
 169      */
 170
 171     static function byProfile($profileId, $offset, $limit)
 172     {
 173         $fav = new Fave();
 174
 175         $fav->user_id = $profileId;
 176
 177         $fav->orderBy('modified DESC');
 178
 179         $fav->limit($offset, $limit);
 180
 181         $fav->find();
 182
 183         return $fav;
 184     }
 185
 186     function getURI()
 187     {
 188         if (!empty($this->uri)) {
 189             return $this->uri;
 190         } else {
 191             return self::newURI($this->user_id, $this->notice_id, $this->modified);
 192         }
 193     }
 194
 195     static function newURI($profile_id, $notice_id, $modified)
 196     {
 197         return TagURI::mint('favor:%d:%d:%s',
 198                             $profile_id,
 199                             $notice_id,
 200                             common_date_iso8601($modified));
 201     }
 202 }