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 $actor the local or remote Profile who favorites
46 * @param Notice $target the notice that is favorited
47 * @return Fave record on success
48 * @throws Exception on failure
50 static function addNew(Profile $actor, Notice $target) {
51 $act = new Activity();
52 $act->type = ActivityObject::ACTIVITY;
53 $act->verb = ActivityVerb::FAVORITE;
55 $act->id = self::newUri($actor, $target, common_sql_date($act->time));
56 $act->title = _("Favor");
57 // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
58 // notice's nickname and %3$s is the content of the favorited notice.)
59 $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
60 $actor->getNickname(), $target->getProfile()->getNickname(),
61 $target->rendered ?: $target->content);
62 $act->actor = $actor->asActivityObject();
63 $act->target = $target->asActivityObject();
64 $act->objects = array(clone($act->target));
66 $url = common_local_url('AtomPubShowFavorite', array('profile'=>$actor->id, 'notice'=>$target->id));
67 $act->selfLink = $url;
68 $act->editLink = $url;
70 // saveActivity will in turn also call Fave::saveActivityObject which does
71 // what this function used to do before this commit.
72 $stored = Notice::saveActivity($act, $actor);
77 // exception throwing takeover!
78 public function insert()
80 if (parent::insert()===false) {
81 common_log_db_error($this, 'INSERT', __FILE__);
82 throw new ServerException(sprintf(_m('Could not store new object of type %s'), get_called_class()));
84 self::blowCacheForProfileId($this->user_id);
85 self::blowCacheForNoticeId($this->notice_id);
89 public function delete($useWhere=false)
91 $profile = Profile::getKV('id', $this->user_id);
92 $notice = Notice::getKV('id', $this->notice_id);
96 if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
98 $result = parent::delete($useWhere);
100 self::blowCacheForProfileId($this->user_id);
101 self::blowCacheForNoticeId($this->notice_id);
102 self::blow('popular');
105 Event::handle('EndDisfavorNotice', array($profile, $notice));
112 function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
114 $stream = new FaveNoticeStream($user_id, $own);
116 return $stream->getNotices($offset, $limit, $since_id, $max_id);
119 function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
121 $stream = new FaveNoticeStream($user_id, $own);
123 return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
126 function asActivity()
128 $target = $this->getTarget();
129 $actor = $this->getActor();
131 $act = new Activity();
133 $act->verb = ActivityVerb::FAVORITE;
135 // FIXME: rationalize this with URL below
137 $act->id = $this->getUri();
139 $act->time = strtotime($this->created);
140 // TRANS: Activity title when marking a notice as favorite.
141 $act->title = _("Favor");
142 // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
143 // notice's nickname and %3$s is the content of the favorited notice.)
144 $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
145 $actor->getNickname(), $target->getProfile()->getNickname(),
146 $target->rendered ?: $target->content);
148 $act->actor = $actor->asActivityObject();
149 $act->target = $target->asActivityObject();
150 $act->objects = array(clone($act->target));
152 $url = common_local_url('AtomPubShowFavorite',
153 array('profile' => $actor->id,
154 'notice' => $target->id));
156 $act->selfLink = $url;
157 $act->editLink = $url;
162 static function existsForProfile($notice, Profile $scoped)
164 $fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
166 return ($fave instanceof Fave);
170 * Fetch a stream of favorites by profile
172 * @param integer $profileId Profile that faved
173 * @param integer $offset Offset from last
174 * @param integer $limit Number to get
176 * @return mixed stream of faves, use fetch() to iterate
178 * @todo Cache results
179 * @todo integrate with Fave::stream()
182 static function byProfile($profileId, $offset, $limit)
186 $fav->user_id = $profileId;
188 $fav->orderBy('modified DESC');
190 $fav->limit($offset, $limit);
197 static function countByProfile(Profile $profile)
199 $c = Cache::instance();
201 $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
202 if (is_integer($cnt)) {
208 $faves->user_id = $profile->id;
209 $cnt = (int) $faves->count('notice_id');
212 $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
218 static protected $_faves = array();
221 * All faves of this notice
223 * @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
225 * @return array Array of Fave objects
227 static public function byNotice($notice)
229 if (!isset(self::$_faves[$notice->id])) {
230 self::fillFaves(array($notice->id));
232 return self::$_faves[$notice->id];
235 static public function fillFaves(array $notice_ids)
237 $faveMap = Fave::listGet('notice_id', $notice_ids);
238 self::$_faves = array_replace(self::$_faves, $faveMap);
241 static public function blowCacheForProfileId($profile_id)
243 $cache = Cache::instance();
245 // Faves don't happen chronologically, so we need to blow
247 $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
248 $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
249 $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
250 $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
251 $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
254 static public function blowCacheForNoticeId($notice_id)
256 $cache = Cache::instance();
258 $cache->delete(Cache::key('fave:list-ids:notice_id:'.$notice_id));
262 // Remember that we want the _activity_ notice here, not faves applied
263 // to the supplied Notice (as with byNotice)!
264 static public function fromStored(Notice $stored)
266 $class = get_called_class();
267 $object = new $class;
268 $object->uri = $stored->uri;
269 if (!$object->find(true)) {
270 throw new NoResultException($object);
276 * Retrieves the _targeted_ notice of a verb (such as the notice that was
277 * _favorited_, but not the favorite activity itself).
279 * @param Notice $stored The activity notice.
281 * @throws NoResultException when it can't find what it's looking for.
283 static public function getTargetFromStored(Notice $stored)
285 return self::fromStored($stored)->getTarget();
288 static public function getObjectType()
293 public function asActivityObject(Profile $scoped=null)
295 $actobj = new ActivityObject();
296 $actobj->id = $this->getUri();
297 $actobj->type = ActivityUtils::resolveUri(self::getObjectType());
298 $actobj->actor = $this->getActorObject();
299 $actobj->target = $this->getTargetObject();
300 $actobj->objects = array(clone($actobj->target));
301 $actobj->verb = ActivityVerb::FAVORITE;
302 $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
303 $actobj->content = $this->getTarget()->rendered ?: $this->getTarget()->content;
308 * @param ActivityObject $actobj The _favored_ notice (which we're "in-reply-to")
309 * @param Notice $stored The _activity_ notice, i.e. the favor itself.
311 static public function parseActivityObject(ActivityObject $actobj, Notice $stored)
313 $local = ActivityUtils::findLocalObject($actobj->getIdentifiers());
314 if (!$local instanceof Notice) {
315 // $local always returns something, but this was not what we expected. Something is wrong.
316 throw new Exception('Something other than a Notice was returned from findLocalObject');
319 $actor = $stored->getProfile();
320 $object = new Fave();
321 $object->user_id = $stored->getProfile()->id;
322 $object->notice_id = $local->id;
323 $object->uri = $stored->uri;
324 $object->created = $stored->created;
325 $object->modified = $stored->modified;
329 static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
331 $target = self::getTargetFromStored($stored);
333 // The following logic was copied from StatusNet's Activity plugin
334 if (ActivityUtils::compareTypes($target->verb, array(ActivityVerb::POST))) {
335 // "I like the thing you posted"
336 $act->objects = $target->asActivity()->objects;
338 // "I like that you did whatever you did"
339 $act->target = $target->asActivityObject();
340 $act->objects = array(clone($act->target));
342 $act->context->replyToID = $target->getUri();
343 $act->context->replyToUrl = $target->getUrl();
344 $act->title = ActivityUtils::verbToTitle($act->verb);
347 static function saveActivityObject(ActivityObject $actobj, Notice $stored)
349 $object = self::parseActivityObject($actobj, $stored);
350 $object->insert(); // exception throwing in Fave's case!
352 self::blowCacheForProfileId($object->user_id);
353 self::blowCacheForNoticeId($object->notice_id);
354 self::blow('popular');
356 Event::handle('EndFavorNotice', array($stored->getProfile(), $object->getTarget()));
360 public function getAttentionArray() {
361 // not all objects can/should carry attentions, so we don't require extending this
362 // the format should be an array with URIs to mentioned profiles
366 public function getTarget()
368 // throws exception on failure
369 $target = new Notice();
370 $target->id = $this->notice_id;
371 if (!$target->find(true)) {
372 throw new NoResultException($target);
378 public function getTargetObject()
380 return $this->getTarget()->asActivityObject();
383 protected $_stored = array();
385 public function getStored()
387 if (!isset($this->_stored[$this->uri])) {
388 $stored = new Notice();
389 $stored->uri = $this->uri;
390 if (!$stored->find(true)) {
391 throw new NoResultException($stored);
393 $this->_stored[$this->uri] = $stored;
395 return $this->_stored[$this->uri];
398 public function getActor()
400 $profile = new Profile();
401 $profile->id = $this->user_id;
402 if (!$profile->find(true)) {
403 throw new NoResultException($profile);
408 public function getActorObject()
410 return $this->getActor()->asActivityObject();
413 public function getUri()
415 if (!empty($this->uri)) {
419 // We (should've in this case) created it ourselves, so we tag it ourselves
420 return self::newUri($this->getActor(), $this->getTarget(), $this->created);
423 static function newUri(Profile $actor, Managed_DataObject $target, $created=null)
425 if (is_null($created)) {
426 $created = common_sql_now();
428 return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
430 ActivityUtils::resolveUri(self::getObjectType(), true),
432 common_date_iso8601($created));