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->rendered ?: $target->content);
  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     public 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 favroites with notice id==0 stored in the database
 137             common_log(LOG_INFO, '"'.get_class($e->obj).'"object had empty id deleting favorite, ignoring...');
 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     static function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
 156     {
 157         $stream = new FaveNoticeStream($user_id, $own);
 158
 159         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 160     }
 161
 162     function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
 163     {
 164         $stream = new FaveNoticeStream($user_id, $own);
 165
 166         return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
 167     }
 168
 169     function asActivity()
 170     {
 171         $target = $this->getTarget();
 172         $actor  = $this->getActor();
 173
 174         $act = new Activity();
 175
 176         $act->verb = ActivityVerb::FAVORITE;
 177
 178         // FIXME: rationalize this with URL below
 179
 180         $act->id   = $this->getUri();
 181
 182         $act->time    = strtotime($this->created);
 183         // TRANS: Activity title when marking a notice as favorite.
 184         $act->title   = _("Favor");
 185         // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
 186         //        notice's nickname and %3$s is the content of the favorited notice.)
 187         $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
 188                                 $actor->getNickname(), $target->getProfile()->getNickname(),
 189                                 $target->rendered ?: $target->content);
 190
 191         $act->actor     = $actor->asActivityObject();
 192         $act->target    = $target->asActivityObject();
 193         $act->objects   = array(clone($act->target));
 194
 195         $url = common_local_url('AtomPubShowFavorite',
 196                                           array('profile' => $actor->id,
 197                                                 'notice'  => $target->id));
 198
 199         $act->selfLink = $url;
 200         $act->editLink = $url;
 201
 202         return $act;
 203     }
 204
 205     static function existsForProfile($notice, Profile $scoped)
 206     {
 207         $fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
 208
 209         return ($fave instanceof Fave);
 210     }
 211
 212     /**
 213      * Fetch a stream of favorites by profile
 214      *
 215      * @param integer $profileId Profile that faved
 216      * @param integer $offset    Offset from last
 217      * @param integer $limit     Number to get
 218      *
 219      * @return mixed stream of faves, use fetch() to iterate
 220      *
 221      * @todo Cache results
 222      * @todo integrate with Fave::stream()
 223      */
 224
 225     static function byProfile($profileId, $offset, $limit)
 226     {
 227         $fav = new Fave();
 228
 229         $fav->user_id = $profileId;
 230
 231         $fav->orderBy('modified DESC');
 232
 233         $fav->limit($offset, $limit);
 234
 235         $fav->find();
 236
 237         return $fav;
 238     }
 239
 240     static function countByProfile(Profile $profile)
 241     {
 242         $c = Cache::instance();
 243         if (!empty($c)) {
 244             $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
 245             if (is_integer($cnt)) {
 246                 return $cnt;
 247             }
 248         }
 249
 250         $faves = new Fave();
 251         $faves->user_id = $profile->id;
 252         $cnt = (int) $faves->count('notice_id');
 253
 254         if (!empty($c)) {
 255             $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
 256         }
 257
 258         return $cnt;
 259     }
 260
 261     static protected $_faves = array();
 262
 263     /**
 264      * All faves of this notice
 265      *
 266      * @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
 267      *
 268      * @return array Array of Fave objects
 269      */
 270     static public function byNotice(Notice $notice)
 271     {
 272         if (!isset(self::$_faves[$notice->id])) {
 273             self::fillFaves(array($notice->id));
 274         }
 275         return self::$_faves[$notice->id];
 276     }
 277
 278     static public function fillFaves(array $notice_ids)
 279     {
 280         $faveMap = Fave::listGet('notice_id', $notice_ids);
 281         self::$_faves = array_replace(self::$_faves, $faveMap);
 282     }
 283
 284     static public function blowCacheForProfileId($profile_id)
 285     {
 286         $cache = Cache::instance();
 287         if ($cache) {
 288             // Faves don't happen chronologically, so we need to blow
 289             // ;last cache, too
 290             $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
 291             $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
 292             $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
 293             $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
 294             $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
 295         }
 296     }
 297     static public function blowCacheForNoticeId($notice_id)
 298     {
 299         $cache = Cache::instance();
 300         if ($cache) {
 301             $cache->delete(Cache::key('fave:list-ids:notice_id:'.$notice_id));
 302         }
 303     }
 304
 305     // Remember that we want the _activity_ notice here, not faves applied
 306     // to the supplied Notice (as with byNotice)!
 307     static public function fromStored(Notice $stored)
 308     {
 309         $class = get_called_class();
 310         $object = new $class;
 311         $object->uri = $stored->uri;
 312         if (!$object->find(true)) {
 313             throw new NoResultException($object);
 314         }
 315         return $object;
 316     }
 317
 318     /**
 319      * Retrieves the _targeted_ notice of a verb (such as the notice that was
 320      * _favorited_, but not the favorite activity itself).
 321      *
 322      * @param Notice $stored    The activity notice.
 323      *
 324      * @throws NoResultException when it can't find what it's looking for.
 325      */
 326     static public function getTargetFromStored(Notice $stored)
 327     {
 328         return self::fromStored($stored)->getTarget();
 329     }
 330
 331     static public function getObjectType()
 332     {
 333         return 'activity';
 334     }
 335
 336     public function asActivityObject(Profile $scoped=null)
 337     {
 338         $actobj = new ActivityObject();
 339         $actobj->id = $this->getUri();
 340         $actobj->type = ActivityUtils::resolveUri(self::getObjectType());
 341         $actobj->actor = $this->getActorObject();
 342         $actobj->target = $this->getTargetObject();
 343         $actobj->objects = array(clone($actobj->target));
 344         $actobj->verb = ActivityVerb::FAVORITE;
 345         $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
 346         $actobj->content = $this->getTarget()->rendered ?: $this->getTarget()->content;
 347         return $actobj;
 348     }
 349
 350     /**
 351      * @param ActivityObject $actobj The _favored_ notice (which we're "in-reply-to")
 352      * @param Notice         $stored The _activity_ notice, i.e. the favor itself.
 353      */
 354     static public function parseActivityObject(ActivityObject $actobj, Notice $stored)
 355     {
 356         $local = ActivityUtils::findLocalObject($actobj->getIdentifiers());
 357         if (!$local instanceof Notice) {
 358             // $local always returns something, but this was not what we expected. Something is wrong.
 359             throw new Exception('Something other than a Notice was returned from findLocalObject');
 360         }
 361
 362         $actor = $stored->getProfile();
 363         $object = new Fave();
 364         $object->user_id = $stored->getProfile()->id;
 365         $object->notice_id = $local->id;
 366         $object->uri = $stored->uri;
 367         $object->created = $stored->created;
 368         $object->modified = $stored->modified;
 369         return $object;
 370     }
 371
 372     static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
 373     {
 374         $target = self::getTargetFromStored($stored);
 375
 376         // The following logic was copied from StatusNet's Activity plugin
 377         if (ActivityUtils::compareVerbs($target->verb, array(ActivityVerb::POST))) {
 378             // "I like the thing you posted"
 379             $act->objects = $target->asActivity()->objects;
 380         } else {
 381             // "I like that you did whatever you did"
 382             $act->target = $target->asActivityObject();
 383             $act->objects = array(clone($act->target));
 384         }
 385         $act->context->replyToID = $target->getUri();
 386         $act->context->replyToUrl = $target->getUrl();
 387         $act->title = ActivityUtils::verbToTitle($act->verb);
 388     }
 389
 390     static function saveActivityObject(ActivityObject $actobj, Notice $stored)
 391     {
 392         $object = self::parseActivityObject($actobj, $stored);
 393         $object->insert();  // exception throwing in Fave's case!
 394
 395         self::blowCacheForProfileId($object->user_id);
 396         self::blowCacheForNoticeId($object->notice_id);
 397         self::blow('popular');
 398
 399         Event::handle('EndFavorNotice', array($stored->getProfile(), $object->getTarget()));
 400         return $object;
 401     }
 402
 403     public function getAttentionArray() {
 404         // not all objects can/should carry attentions, so we don't require extending this
 405         // the format should be an array with URIs to mentioned profiles
 406         return array();
 407     }
 408
 409     public function getTarget()
 410     {
 411         return Notice::getByID($this->notice_id);
 412     }
 413
 414     public function getTargetObject()
 415     {
 416         return $this->getTarget()->asActivityObject();
 417     }
 418
 419     protected $_stored = array();
 420
 421     public function getStored()
 422     {
 423         if (!isset($this->_stored[$this->uri])) {
 424             $stored = new Notice();
 425             $stored->uri = $this->uri;
 426             if (!$stored->find(true)) {
 427                 throw new NoResultException($stored);
 428             }
 429             $this->_stored[$this->uri] = $stored;
 430         }
 431         return $this->_stored[$this->uri];
 432     }
 433
 434     public function getActor()
 435     {
 436         return Profile::getByID($this->user_id);
 437     }
 438
 439     public function getActorObject()
 440     {
 441         return $this->getActor()->asActivityObject();
 442     }
 443
 444     public function getUri()
 445     {
 446         if (!empty($this->uri)) {
 447             return $this->uri;
 448         }
 449
 450         // We (should've in this case) created it ourselves, so we tag it ourselves
 451         return self::newUri($this->getActor(), $this->getTarget(), $this->created);
 452     }
 453 }