plugins/Favorite/classes/Fave.php

   1 <?php
   2 /**
   3  * Table Definition for fave
   4  */
   5
   6 class Fave extends Managed_DataObject
   7 {
   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
  14
  15     public static function schemaDef()
  16     {
  17         return array(
  18             'fields' => array(
  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'),
  24             ),
  25             'primary key' => array('notice_id', 'user_id'),
  26             'unique keys' => array(
  27                 'fave_uri_key' => array('uri'),
  28             ),
  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
  32             ),
  33             'indexes' => array(
  34                 'fave_notice_id_idx' => array('notice_id'),
  35                 'fave_user_id_idx' => array('user_id', 'modified'),
  36                 'fave_modified_idx' => array('modified'),
  37             ),
  38         );
  39     }
  40
  41     /**
  42      * Save a favorite record.
  43      * @fixme post-author notification should be moved here
  44      *
  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
  49      */
  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!'));
  54         }
  55
  56         $act = new Activity();
  57         $act->type    = ActivityObject::ACTIVITY;
  58         $act->verb    = ActivityVerb::FAVORITE;
  59         $act->time    = time();
  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->getRendered());
  67         $act->actor   = $actor->asActivityObject();
  68         $act->target  = $target->asActivityObject();
  69         $act->objects = array(clone($act->target));
  70
  71         $url = common_local_url('AtomPubShowFavorite', array('profile'=>$actor->id, 'notice'=>$target->id));
  72         $act->selfLink = $url;
  73         $act->editLink = $url;
  74
  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);
  78
  79         return $stored;
  80     }
  81
  82     static function removeEntry(Profile $actor, Notice $target)
  83     {
  84         $fave            = new Fave();
  85         $fave->user_id   = $actor->getID();
  86         $fave->notice_id = $target->getID();
  87         if (!$fave->find(true)) {
  88             // TRANS: Client error displayed when trying to remove a 'favor' when there is none in the first place.
  89             throw new AlreadyFulfilledException(_('This is already not favorited.'));
  90         }
  91
  92         $result = $fave->delete();
  93         if ($result === false) {
  94             common_log_db_error($fave, 'DELETE', __FILE__);
  95             // TRANS: Server error displayed when removing a favorite from the database fails.
  96             throw new ServerException(_('Could not delete favorite.'));
  97         }
  98
  99         Fave::blowCacheForProfileId($actor->getID());
 100         Fave::blowCacheForNoticeId($target->getID());
 101     }
 102
 103     // exception throwing takeover!
 104     public function insert()
 105     {
 106         if (parent::insert()===false) {
 107             common_log_db_error($this, 'INSERT', __FILE__);
 108             throw new ServerException(sprintf(_m('Could not store new object of type %s'), get_called_class()));
 109         }
 110         self::blowCacheForProfileId($this->user_id);
 111         self::blowCacheForNoticeId($this->notice_id);
 112         return $this;
 113     }
 114
 115     public function delete($useWhere=false)
 116     {
 117         $result = null;
 118
 119         try {
 120             $profile = $this->getActor();
 121             $notice  = $this->getTarget();
 122
 123             if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
 124
 125                 $result = parent::delete($useWhere);
 126
 127                 if ($result !== false) {
 128                     Event::handle('EndDisfavorNotice', array($profile, $notice));
 129                 }
 130             }
 131
 132         } catch (NoResultException $e) {
 133             // In case there's some inconsistency where the profile or notice was deleted without losing the fave db entry
 134             common_log(LOG_INFO, '"'.get_class($e->obj).'" with id=='.var_export($e->obj->id, true).' object not found when deleting favorite, ignoring...');
 135         } catch (EmptyIdException $e) {
 136             // Some buggy instances of GNU social have had favorites with notice id==0 stored in the database
 137             common_log(LOG_INFO, _ve($e->getMessage()));
 138         }
 139
 140         // If we catch an exception above, then $result===null because parent::delete only returns an int>=0 or boolean false
 141         if (is_null($result)) {
 142             // Delete it without the event, as something is wrong and we don't want it anyway.
 143             $result = parent::delete($useWhere);
 144         }
 145
 146         // Err, apparently we can reference $this->user_id after parent::delete,
 147         // I guess it's safe because this is the order it was before!
 148         self::blowCacheForProfileId($this->user_id);
 149         self::blowCacheForNoticeId($this->notice_id);
 150         self::blow('popular');
 151
 152         return $result;
 153     }
 154
 155     // FIXME: Instead of $own, send the scoped Profile so we can pass it along directly to FaveNoticeStream
 156     // and preferrably we should get a Profile instead of $user_id
 157     static function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
 158     {
 159         $target = Profile::getByID($user_id);
 160         $stream = new FaveNoticeStream($target, ($own ? $target : null));
 161
 162         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 163     }
 164
 165     // FIXME: Instead of $own, send the scoped Profile so we can pass it along directly to FaveNoticeStream
 166     // and preferrably we should get a Profile instead of $user_id
 167     function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
 168     {
 169         $target = Profile::getByID($user_id);
 170         $stream = new FaveNoticeStream($target, ($own ? $target : null));
 171
 172         return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
 173     }
 174
 175     function asActivity()
 176     {
 177         $target = $this->getTarget();
 178         $actor  = $this->getActor();
 179
 180         $act = new Activity();
 181
 182         $act->verb = ActivityVerb::FAVORITE;
 183
 184         // FIXME: rationalize this with URL below
 185
 186         $act->id   = $this->getUri();
 187
 188         $act->time    = strtotime($this->created);
 189         // TRANS: Activity title when marking a notice as favorite.
 190         $act->title   = _("Favor");
 191         // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
 192         //        notice's nickname and %3$s is the content of the favorited notice.)
 193         $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
 194                                 $actor->getNickname(), $target->getProfile()->getNickname(),
 195                                 $target->getRendered());
 196
 197         $act->actor     = $actor->asActivityObject();
 198         $act->target    = $target->asActivityObject();
 199         $act->objects   = array(clone($act->target));
 200
 201         $url = common_local_url('AtomPubShowFavorite',
 202                                           array('profile' => $actor->id,
 203                                                 'notice'  => $target->id));
 204
 205         $act->selfLink = $url;
 206         $act->editLink = $url;
 207
 208         return $act;
 209     }
 210
 211     static function existsForProfile($notice, Profile $scoped)
 212     {
 213         $fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
 214
 215         return ($fave instanceof Fave);
 216     }
 217
 218     /**
 219      * Fetch a stream of favorites by profile
 220      *
 221      * @param integer $profileId Profile that faved
 222      * @param integer $offset    Offset from last
 223      * @param integer $limit     Number to get
 224      *
 225      * @return mixed stream of faves, use fetch() to iterate
 226      *
 227      * @todo Cache results
 228      * @todo integrate with Fave::stream()
 229      */
 230
 231     static function byProfile($profileId, $offset, $limit)
 232     {
 233         $fav = new Fave();
 234
 235         $fav->user_id = $profileId;
 236
 237         $fav->orderBy('modified DESC');
 238
 239         $fav->limit($offset, $limit);
 240
 241         $fav->find();
 242
 243         return $fav;
 244     }
 245
 246     static function countByProfile(Profile $profile)
 247     {
 248         $c = Cache::instance();
 249         if (!empty($c)) {
 250             $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
 251             if (is_integer($cnt)) {
 252                 return $cnt;
 253             }
 254         }
 255
 256         $faves = new Fave();
 257         $faves->user_id = $profile->id;
 258         $cnt = (int) $faves->count('notice_id');
 259
 260         if (!empty($c)) {
 261             $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
 262         }
 263
 264         return $cnt;
 265     }
 266
 267     static protected $_faves = array();
 268
 269     /**
 270      * All faves of this notice
 271      *
 272      * @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
 273      *
 274      * @return array Array of Fave objects
 275      */
 276     static public function byNotice($notice)
 277     {
 278         if (!isset(self::$_faves[$notice->id])) {
 279             self::fillFaves(array($notice->id));
 280         }
 281         return self::$_faves[$notice->id];
 282     }
 283
 284     static public function fillFaves(array $notice_ids)
 285     {
 286         $faveMap = Fave::listGet('notice_id', $notice_ids);
 287         self::$_faves = array_replace(self::$_faves, $faveMap);
 288     }
 289
 290     static public function blowCacheForProfileId($profile_id)
 291     {
 292         $cache = Cache::instance();
 293         if ($cache) {
 294             // Faves don't happen chronologically, so we need to blow
 295             // ;last cache, too
 296             $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
 297             $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
 298             $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
 299             $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
 300             $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
 301         }
 302     }
 303     static public function blowCacheForNoticeId($notice_id)
 304     {
 305         $cache = Cache::instance();
 306         if ($cache) {
 307             $cache->delete(Cache::key('fave:list-ids:notice_id:'.$notice_id));
 308         }
 309     }
 310
 311     // Remember that we want the _activity_ notice here, not faves applied
 312     // to the supplied Notice (as with byNotice)!
 313     static public function fromStored(Notice $stored)
 314     {
 315         $class = get_called_class();
 316         $object = new $class;
 317         $object->uri = $stored->uri;
 318         if (!$object->find(true)) {
 319             throw new NoResultException($object);
 320         }
 321         return $object;
 322     }
 323
 324     /**
 325      * Retrieves the _targeted_ notice of a verb (such as the notice that was
 326      * _favorited_, but not the favorite activity itself).
 327      *
 328      * @param Notice $stored    The activity notice.
 329      *
 330      * @throws NoResultException when it can't find what it's looking for.
 331      */
 332     static public function getTargetFromStored(Notice $stored)
 333     {
 334         return self::fromStored($stored)->getTarget();
 335     }
 336
 337     static public function getObjectType()
 338     {
 339         return ActivityObject::ACTIVITY;
 340     }
 341
 342     public function asActivityObject(Profile $scoped=null)
 343     {
 344         $actobj = new ActivityObject();
 345         $actobj->id = $this->getUri();
 346         $actobj->type = ActivityUtils::resolveUri(self::getObjectType());
 347         $actobj->actor = $this->getActorObject();
 348         $actobj->target = $this->getTargetObject();
 349         $actobj->objects = array(clone($actobj->target));
 350         $actobj->verb = ActivityVerb::FAVORITE;
 351         $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
 352         $actobj->content = $this->getTarget()->getRendered();
 353         return $actobj;
 354     }
 355
 356     /**
 357      * @param ActivityObject $actobj The _favored_ notice (which we're "in-reply-to")
 358      * @param Notice         $stored The _activity_ notice, i.e. the favor itself.
 359      */
 360     static public function parseActivityObject(ActivityObject $actobj, Notice $stored)
 361     {
 362         // throws exception if nothing was found, but it could also be a non-Notice...
 363         // FIXME: This should only test _one_ URI (and not the links etc.) though a function like this could be useful in other cases
 364         $local = ActivityUtils::findLocalObject($actobj->getIdentifiers());
 365         if (!$local instanceof Notice) {
 366             // $local always returns something, but this was not what we expected. Something is wrong.
 367             throw new Exception('Something other than a Notice was returned from findLocalObject');
 368         }
 369
 370         $actor = $stored->getProfile();
 371         $object = new Fave();
 372         $object->user_id = $stored->getProfile()->id;
 373         $object->notice_id = $local->id;
 374         $object->uri = $stored->uri;
 375         $object->created = $stored->created;
 376         $object->modified = $stored->modified;
 377         return $object;
 378     }
 379
 380     static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
 381     {
 382         $target = self::getTargetFromStored($stored);
 383
 384         // The following logic was copied from StatusNet's Activity plugin
 385         if (ActivityUtils::compareVerbs($target->verb, array(ActivityVerb::POST))) {
 386             // "I like the thing you posted"
 387             $act->objects = $target->asActivity()->objects;
 388         } else {
 389             // "I like that you did whatever you did"
 390             $act->target = $target->asActivityObject();
 391             $act->objects = array(clone($act->target));
 392         }
 393         $act->context->replyToID = $target->getUri();
 394         $act->context->replyToUrl = $target->getUrl();
 395         $act->title = ActivityUtils::verbToTitle($act->verb);
 396     }
 397
 398     static function saveActivityObject(ActivityObject $actobj, Notice $stored)
 399     {
 400         $object = self::parseActivityObject($actobj, $stored);
 401         $object->insert();  // exception throwing in Fave's case!
 402
 403         self::blowCacheForProfileId($object->user_id);
 404         self::blowCacheForNoticeId($object->notice_id);
 405         self::blow('popular');
 406
 407         Event::handle('EndFavorNotice', array($stored->getProfile(), $object->getTarget()));
 408         return $object;
 409     }
 410
 411     public function getTarget()
 412     {
 413         return Notice::getByID($this->notice_id);
 414     }
 415
 416     public function getTargetObject()
 417     {
 418         return $this->getTarget()->asActivityObject();
 419     }
 420
 421     protected $_stored = array();
 422
 423     public function getStored()
 424     {
 425         if (!isset($this->_stored[$this->uri])) {
 426             $stored = new Notice();
 427             $stored->uri = $this->uri;
 428             if (!$stored->find(true)) {
 429                 throw new NoResultException($stored);
 430             }
 431             $this->_stored[$this->uri] = $stored;
 432         }
 433         return $this->_stored[$this->uri];
 434     }
 435
 436     public function getActor()
 437     {
 438         return Profile::getByID($this->user_id);
 439     }
 440
 441     public function getActorObject()
 442     {
 443         return $this->getActor()->asActivityObject();
 444     }
 445
 446     public function getUri()
 447     {
 448         if (!empty($this->uri)) {
 449             return $this->uri;
 450         }
 451
 452         // We (should've in this case) created it ourselves, so we tag it ourselves
 453         return self::newUri($this->getActor(), $this->getTarget(), $this->created);
 454     }
 455 }