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(191) not 255 because utf8mb4 takes more space not 255 because utf8mb4 takes more space
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' => 191, '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 if (self::existsForProfile($target, $actor)) {
52 // TRANS: Client error displayed when trying to mark a notice as favorite that already is a favorite.
53 throw new AlreadyFulfilledException(_('You have already favorited this!'));
56 $act = new Activity();
57 $act->type = ActivityObject::ACTIVITY;
58 $act->verb = ActivityVerb::FAVORITE;
60 $act->id = self::newUri($actor, $target, common_sql_date($act->time));
61 $act->title = _("Favor");
62 // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
63 // notice's nickname and %3$s is the content of the favorited notice.)
64 $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
65 $actor->getNickname(), $target->getProfile()->getNickname(),
66 $target->rendered ?: $target->content);
67 $act->actor = $actor->asActivityObject();
68 $act->target = $target->asActivityObject();
69 $act->objects = array(clone($act->target));
71 $url = common_local_url('AtomPubShowFavorite', array('profile'=>$actor->id, 'notice'=>$target->id));
72 $act->selfLink = $url;
73 $act->editLink = $url;
75 // saveActivity will in turn also call Fave::saveActivityObject which does
76 // what this function used to do before this commit.
77 $stored = Notice::saveActivity($act, $actor);
82 // exception throwing takeover!
83 public function insert()
85 if (parent::insert()===false) {
86 common_log_db_error($this, 'INSERT', __FILE__);
87 throw new ServerException(sprintf(_m('Could not store new object of type %s'), get_called_class()));
89 self::blowCacheForProfileId($this->user_id);
90 self::blowCacheForNoticeId($this->notice_id);
94 public function delete($useWhere=false)
96 $profile = Profile::getKV('id', $this->user_id);
97 $notice = Notice::getKV('id', $this->notice_id);
101 if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
103 $result = parent::delete($useWhere);
105 self::blowCacheForProfileId($this->user_id);
106 self::blowCacheForNoticeId($this->notice_id);
107 self::blow('popular');
110 Event::handle('EndDisfavorNotice', array($profile, $notice));
117 function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
119 $stream = new FaveNoticeStream($user_id, $own);
121 return $stream->getNotices($offset, $limit, $since_id, $max_id);
124 function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
126 $stream = new FaveNoticeStream($user_id, $own);
128 return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
131 function asActivity()
133 $target = $this->getTarget();
134 $actor = $this->getActor();
136 $act = new Activity();
138 $act->verb = ActivityVerb::FAVORITE;
140 // FIXME: rationalize this with URL below
142 $act->id = $this->getUri();
144 $act->time = strtotime($this->created);
145 // TRANS: Activity title when marking a notice as favorite.
146 $act->title = _("Favor");
147 // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
148 // notice's nickname and %3$s is the content of the favorited notice.)
149 $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
150 $actor->getNickname(), $target->getProfile()->getNickname(),
151 $target->rendered ?: $target->content);
153 $act->actor = $actor->asActivityObject();
154 $act->target = $target->asActivityObject();
155 $act->objects = array(clone($act->target));
157 $url = common_local_url('AtomPubShowFavorite',
158 array('profile' => $actor->id,
159 'notice' => $target->id));
161 $act->selfLink = $url;
162 $act->editLink = $url;
167 static function existsForProfile($notice, Profile $scoped)
169 $fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
171 return ($fave instanceof Fave);
175 * Fetch a stream of favorites by profile
177 * @param integer $profileId Profile that faved
178 * @param integer $offset Offset from last
179 * @param integer $limit Number to get
181 * @return mixed stream of faves, use fetch() to iterate
183 * @todo Cache results
184 * @todo integrate with Fave::stream()
187 static function byProfile($profileId, $offset, $limit)
191 $fav->user_id = $profileId;
193 $fav->orderBy('modified DESC');
195 $fav->limit($offset, $limit);
202 static function countByProfile(Profile $profile)
204 $c = Cache::instance();
206 $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
207 if (is_integer($cnt)) {
213 $faves->user_id = $profile->id;
214 $cnt = (int) $faves->count('notice_id');
217 $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
223 static protected $_faves = array();
226 * All faves of this notice
228 * @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
230 * @return array Array of Fave objects
232 static public function byNotice($notice)
234 if (!isset(self::$_faves[$notice->id])) {
235 self::fillFaves(array($notice->id));
237 return self::$_faves[$notice->id];
240 static public function fillFaves(array $notice_ids)
242 $faveMap = Fave::listGet('notice_id', $notice_ids);
243 self::$_faves = array_replace(self::$_faves, $faveMap);
246 static public function blowCacheForProfileId($profile_id)
248 $cache = Cache::instance();
250 // Faves don't happen chronologically, so we need to blow
252 $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
253 $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
254 $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
255 $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
256 $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
259 static public function blowCacheForNoticeId($notice_id)
261 $cache = Cache::instance();
263 $cache->delete(Cache::key('fave:list-ids:notice_id:'.$notice_id));
267 // Remember that we want the _activity_ notice here, not faves applied
268 // to the supplied Notice (as with byNotice)!
269 static public function fromStored(Notice $stored)
271 $class = get_called_class();
272 $object = new $class;
273 $object->uri = $stored->uri;
274 if (!$object->find(true)) {
275 throw new NoResultException($object);
281 * Retrieves the _targeted_ notice of a verb (such as the notice that was
282 * _favorited_, but not the favorite activity itself).
284 * @param Notice $stored The activity notice.
286 * @throws NoResultException when it can't find what it's looking for.
288 static public function getTargetFromStored(Notice $stored)
290 return self::fromStored($stored)->getTarget();
293 static public function getObjectType()
298 public function asActivityObject(Profile $scoped=null)
300 $actobj = new ActivityObject();
301 $actobj->id = $this->getUri();
302 $actobj->type = ActivityUtils::resolveUri(self::getObjectType());
303 $actobj->actor = $this->getActorObject();
304 $actobj->target = $this->getTargetObject();
305 $actobj->objects = array(clone($actobj->target));
306 $actobj->verb = ActivityVerb::FAVORITE;
307 $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
308 $actobj->content = $this->getTarget()->rendered ?: $this->getTarget()->content;
313 * @param ActivityObject $actobj The _favored_ notice (which we're "in-reply-to")
314 * @param Notice $stored The _activity_ notice, i.e. the favor itself.
316 static public function parseActivityObject(ActivityObject $actobj, Notice $stored)
318 $local = ActivityUtils::findLocalObject($actobj->getIdentifiers());
319 if (!$local instanceof Notice) {
320 // $local always returns something, but this was not what we expected. Something is wrong.
321 throw new Exception('Something other than a Notice was returned from findLocalObject');
324 $actor = $stored->getProfile();
325 $object = new Fave();
326 $object->user_id = $stored->getProfile()->id;
327 $object->notice_id = $local->id;
328 $object->uri = $stored->uri;
329 $object->created = $stored->created;
330 $object->modified = $stored->modified;
334 static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
336 $target = self::getTargetFromStored($stored);
338 // The following logic was copied from StatusNet's Activity plugin
339 if (ActivityUtils::compareTypes($target->verb, array(ActivityVerb::POST))) {
340 // "I like the thing you posted"
341 $act->objects = $target->asActivity()->objects;
343 // "I like that you did whatever you did"
344 $act->target = $target->asActivityObject();
345 $act->objects = array(clone($act->target));
347 $act->context->replyToID = $target->getUri();
348 $act->context->replyToUrl = $target->getUrl();
349 $act->title = ActivityUtils::verbToTitle($act->verb);
352 static function saveActivityObject(ActivityObject $actobj, Notice $stored)
354 $object = self::parseActivityObject($actobj, $stored);
355 $object->insert(); // exception throwing in Fave's case!
357 self::blowCacheForProfileId($object->user_id);
358 self::blowCacheForNoticeId($object->notice_id);
359 self::blow('popular');
361 Event::handle('EndFavorNotice', array($stored->getProfile(), $object->getTarget()));
365 public function getAttentionArray() {
366 // not all objects can/should carry attentions, so we don't require extending this
367 // the format should be an array with URIs to mentioned profiles
371 public function getTarget()
373 // throws exception on failure
374 $target = new Notice();
375 $target->id = $this->notice_id;
376 if (!$target->find(true)) {
377 throw new NoResultException($target);
383 public function getTargetObject()
385 return $this->getTarget()->asActivityObject();
388 protected $_stored = array();
390 public function getStored()
392 if (!isset($this->_stored[$this->uri])) {
393 $stored = new Notice();
394 $stored->uri = $this->uri;
395 if (!$stored->find(true)) {
396 throw new NoResultException($stored);
398 $this->_stored[$this->uri] = $stored;
400 return $this->_stored[$this->uri];
403 public function getActor()
405 $profile = new Profile();
406 $profile->id = $this->user_id;
407 if (!$profile->find(true)) {
408 throw new NoResultException($profile);
413 public function getActorObject()
415 return $this->getActor()->asActivityObject();
418 public function getUri()
420 if (!empty($this->uri)) {
424 // We (should've in this case) created it ourselves, so we tag it ourselves
425 return self::newUri($this->getActor(), $this->getTarget(), $this->created);
428 static function newUri(Profile $actor, Managed_DataObject $target, $created=null)
430 if (is_null($created)) {
431 $created = common_sql_now();
433 return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
435 ActivityUtils::resolveUri(self::getObjectType(), true),
437 common_date_iso8601($created));