3 * Table Definition for fave
6 class Fave extends Managed_DataObject
8 public $__table = 'fave'; // table name
9 public $notice_id; // int(4) primary_key not_null
10 public $user_id; // int(4) primary_key not_null
11 public $uri; // varchar(255)
12 public $created; // datetime multiple_key not_null
13 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
15 public static function schemaDef()
19 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'),
20 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'),
21 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
22 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
23 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
25 'primary key' => array('notice_id', 'user_id'),
26 'unique keys' => array(
27 'fave_uri_key' => array('uri'),
29 'foreign keys' => array(
30 'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
31 'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites
34 'fave_notice_id_idx' => array('notice_id'),
35 'fave_user_id_idx' => array('user_id', 'modified'),
36 'fave_modified_idx' => array('modified'),
42 * Save a favorite record.
43 * @fixme post-author notification should be moved here
45 * @param Profile $profile the local or remote user who likes
46 * @param Notice $notice the notice that is liked
47 * @return Fave record on success
48 * @throws Exception on failure
50 static function addNew(Profile $profile, Notice $notice) {
54 if (Event::handle('StartFavorNotice', array($profile, $notice, &$fave))) {
58 $fave->user_id = $profile->id;
59 $fave->notice_id = $notice->id;
60 $fave->created = common_sql_now();
61 $fave->modified = common_sql_now();
62 $fave->uri = self::newUri($profile,
66 // throws exception (Fave specific until migrated into Managed_DataObject
69 self::blowCacheForProfileId($fave->user_id);
70 self::blowCacheForNoticeId($fave->notice_id);
71 self::blow('popular');
73 Event::handle('EndFavorNotice', array($profile, $notice));
79 // exception throwing takeover!
80 public function insert()
82 if (parent::insert()===false) {
83 common_log_db_error($this, 'INSERT', __FILE__);
84 throw new ServerException(sprintf(_m('Could not store new object of type %s'), get_called_class()));
86 self::blowCacheForProfileId($this->user_id);
87 self::blowCacheForNoticeId($this->notice_id);
91 public function delete($useWhere=false)
93 $profile = Profile::getKV('id', $this->user_id);
94 $notice = Notice::getKV('id', $this->notice_id);
98 if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
100 $result = parent::delete($useWhere);
102 self::blowCacheForProfileId($this->user_id);
103 self::blowCacheForNoticeId($this->notice_id);
104 self::blow('popular');
107 Event::handle('EndDisfavorNotice', array($profile, $notice));
114 function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
116 $stream = new FaveNoticeStream($user_id, $own);
118 return $stream->getNotices($offset, $limit, $since_id, $max_id);
121 function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
123 $stream = new FaveNoticeStream($user_id, $own);
125 return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
128 function asActivity()
130 $target = $this->getTarget();
131 $actor = $this->getActor();
133 $act = new Activity();
135 $act->verb = ActivityVerb::FAVORITE;
137 // FIXME: rationalize this with URL below
139 $act->id = $this->getUri();
141 $act->time = strtotime($this->created);
142 // TRANS: Activity title when marking a notice as favorite.
143 $act->title = _("Favor");
144 $act->content = $target->rendered ?: $target->content;
146 $act->actor = $actor->asActivityObject();
147 $act->target = $target->asActivityObject();
148 $act->objects = array(clone($act->target));
150 $url = common_local_url('AtomPubShowFavorite',
151 array('profile' => $actor->id,
152 'notice' => $target->id));
154 $act->selfLink = $url;
155 $act->editLink = $url;
160 static function existsForProfile($notice, Profile $scoped)
162 $fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
164 return ($fave instanceof Fave);
168 * Fetch a stream of favorites by profile
170 * @param integer $profileId Profile that faved
171 * @param integer $offset Offset from last
172 * @param integer $limit Number to get
174 * @return mixed stream of faves, use fetch() to iterate
176 * @todo Cache results
177 * @todo integrate with Fave::stream()
180 static function byProfile($profileId, $offset, $limit)
184 $fav->user_id = $profileId;
186 $fav->orderBy('modified DESC');
188 $fav->limit($offset, $limit);
195 static function countByProfile(Profile $profile)
197 $c = Cache::instance();
199 $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
200 if (is_integer($cnt)) {
206 $faves->user_id = $profile->id;
207 $cnt = (int) $faves->count('notice_id');
210 $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
216 static protected $_faves = array();
219 * All faves of this notice
221 * @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
223 * @return array Array of Fave objects
225 static public function byNotice($notice)
227 if (!isset(self::$_faves[$notice->id])) {
228 self::fillFaves(array($notice->id));
230 return self::$_faves[$notice->id];
233 static public function fillFaves(array $notice_ids)
235 $faveMap = Fave::listGet('notice_id', $notice_ids);
236 self::$_faves = array_replace(self::$_faves, $faveMap);
239 static public function blowCacheForProfileId($profile_id)
241 $cache = Cache::instance();
243 // Faves don't happen chronologically, so we need to blow
245 $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
246 $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
247 $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
248 $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
249 $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
252 static public function blowCacheForNoticeId($notice_id)
254 $cache = Cache::instance();
256 $cache->delete(Cache::key('fave:list-ids:notice_id:'.$notice_id));
260 // Remember that we want the _activity_ notice here, not faves applied
261 // to the supplied Notice (as with byNotice)!
262 static public function fromStored(Notice $stored)
264 $class = get_called_class();
265 $object = new $class;
266 $object->uri = $stored->uri;
267 if (!$object->find(true)) {
268 throw new NoResultException($object);
274 * Retrieves the _targeted_ notice of a verb (such as the notice that was
275 * _favorited_, but not the favorite activity itself).
277 * @param Notice $stored The activity notice.
279 * @throws NoResultException when it can't find what it's looking for.
281 static public function getTargetFromStored(Notice $stored)
283 return self::fromStored($stored)->getTarget();
286 static public function getObjectType()
291 public function asActivityObject(Profile $scoped=null)
293 $actobj = new ActivityObject();
294 $actobj->id = $this->getUri();
295 $actobj->type = ActivityUtils::resolveUri(self::getObjectType());
296 $actobj->actor = $this->getActorObject();
297 $actobj->target = $this->getTargetObject();
298 $actobj->objects = array(clone($actobj->target));
299 $actobj->verb = ActivityVerb::FAVORITE;
300 $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
301 $actobj->content = $this->getTarget()->rendered ?: $this->getTarget()->content;
306 * @param ActivityObject $actobj The _favored_ notice (which we're "in-reply-to")
307 * @param Notice $stored The _activity_ notice, i.e. the favor itself.
309 static public function parseActivityObject(ActivityObject $actobj, Notice $stored)
311 $local = ActivityUtils::findLocalObject($actobj->getIdentifiers());
312 if (!$local instanceof Notice) {
313 // $local always returns something, but this was not what we expected. Something is wrong.
314 throw new Exception('Something other than a Notice was returned from findLocalObject');
317 $actor = $stored->getProfile();
318 $object = new Fave();
319 $object->user_id = $stored->getProfile()->id;
320 $object->notice_id = $local->id;
321 $object->uri = $stored->uri;
322 $object->created = $stored->created;
323 $object->modified = $stored->modified;
327 static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
329 $target = self::getTargetFromStored($stored);
331 // The following logic was copied from StatusNet's Activity plugin
332 if (ActivityUtils::compareTypes($target->verb, array(ActivityVerb::POST))) {
333 // "I like the thing you posted"
334 $act->objects = $target->asActivity()->objects;
336 // "I like that you did whatever you did"
337 $act->target = $target->asActivityObject();
338 $act->objects = array(clone($act->target));
340 $act->context->replyToID = $target->getUri();
341 $act->context->replyToUrl = $target->getUrl();
342 $act->title = ActivityUtils::verbToTitle($act->verb);
345 static function saveActivityObject(ActivityObject $actobj, Notice $stored)
347 $object = self::parseActivityObject($actobj, $stored);
348 $object->insert(); // exception throwing!
349 Event::handle('EndFavorNotice', array($stored->getProfile(), $object->getTarget()));
353 public function getAttentionArray() {
354 // not all objects can/should carry attentions, so we don't require extending this
355 // the format should be an array with URIs to mentioned profiles
359 public function getTarget()
361 // throws exception on failure
362 $target = new Notice();
363 $target->id = $this->notice_id;
364 if (!$target->find(true)) {
365 throw new NoResultException($target);
371 public function getTargetObject()
373 return $this->getTarget()->asActivityObject();
376 protected $_stored = array();
378 public function getStored()
380 if (!isset($this->_stored[$this->uri])) {
381 $stored = new Notice();
382 $stored->uri = $this->uri;
383 if (!$stored->find(true)) {
384 throw new NoResultException($stored);
386 $this->_stored[$this->uri] = $stored;
388 return $this->_stored[$this->uri];
391 public function getActor()
393 $profile = new Profile();
394 $profile->id = $this->user_id;
395 if (!$profile->find(true)) {
396 throw new NoResultException($profile);
401 public function getActorObject()
403 return $this->getActor()->asActivityObject();
406 public function getUri()
408 if (!empty($this->uri)) {
412 // We (should've in this case) created it ourselves, so we tag it ourselves
413 return self::newUri($this->getActor(), $this->getTarget(), $this->created);
416 static function newUri(Profile $actor, Managed_DataObject $target, $created=null)
418 if (is_null($created)) {
419 $created = common_sql_now();
421 return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
423 ActivityUtils::resolveUri(self::getObjectType(), true),
425 common_date_iso8601($created));