/**
* Table Definition for fave
*/
-require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
class Fave extends Managed_DataObject
{
- ###START_AUTOCODE
- /* the code below is auto generated do not remove the above tag */
-
public $__table = 'fave'; // table name
public $notice_id; // int(4) primary_key not_null
public $user_id; // int(4) primary_key not_null
- public $uri; // varchar(255)
+ public $uri; // varchar(191) not 255 because utf8mb4 takes more space not 255 because utf8mb4 takes more space
+ public $created; // datetime multiple_key not_null
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
- /* the code above is auto generated do not remove the tag below */
- ###END_AUTOCODE
-
public static function schemaDef()
{
return array(
'fields' => array(
'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'),
'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'),
- 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
+ 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'),
+ 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
),
'primary key' => array('notice_id', 'user_id'),
* Save a favorite record.
* @fixme post-author notification should be moved here
*
- * @param Profile $profile the local or remote user who likes
- * @param Notice $notice the notice that is liked
- * @return mixed false on failure, or Fave record on success
+ * @param Profile $actor the local or remote Profile who favorites
+ * @param Notice $target the notice that is favorited
+ * @return Fave record on success
+ * @throws Exception on failure
*/
- static function addNew(Profile $profile, Notice $notice) {
+ static function addNew(Profile $actor, Notice $target) {
+ if (self::existsForProfile($target, $actor)) {
+ // TRANS: Client error displayed when trying to mark a notice as favorite that already is a favorite.
+ throw new AlreadyFulfilledException(_('You have already favorited this!'));
+ }
- $fave = null;
+ $act = new Activity();
+ $act->type = ActivityObject::ACTIVITY;
+ $act->verb = ActivityVerb::FAVORITE;
+ $act->time = time();
+ $act->id = self::newUri($actor, $target, common_sql_date($act->time));
+ $act->title = _("Favor");
+ // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
+ // notice's nickname and %3$s is the content of the favorited notice.)
+ $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
+ $actor->getNickname(), $target->getProfile()->getNickname(),
+ $target->rendered ?: $target->content);
+ $act->actor = $actor->asActivityObject();
+ $act->target = $target->asActivityObject();
+ $act->objects = array(clone($act->target));
+
+ $url = common_local_url('AtomPubShowFavorite', array('profile'=>$actor->id, 'notice'=>$target->id));
+ $act->selfLink = $url;
+ $act->editLink = $url;
- if (Event::handle('StartFavorNotice', array($profile, $notice, &$fave))) {
+ // saveActivity will in turn also call Fave::saveActivityObject which does
+ // what this function used to do before this commit.
+ $stored = Notice::saveActivity($act, $actor);
- $fave = new Fave();
+ return $stored;
+ }
- $fave->user_id = $profile->id;
- $fave->notice_id = $notice->id;
- $fave->modified = common_sql_now();
- $fave->uri = self::newURI($fave->user_id,
- $fave->notice_id,
- $fave->modified);
- if (!$fave->insert()) {
- common_log_db_error($fave, 'INSERT', __FILE__);
- return false;
- }
- self::blow('fave:list-ids:notice_id:%d', $fave->notice_id);
- self::blow('popular');
+ public function removeEntry(Profile $actor, Notice $target)
+ {
+ $fave = new Fave();
+ $fave->user_id = $actor->getID();
+ $fave->notice_id = $target->getID();
+ if (!$fave->find(true)) {
+ // TRANS: Client error displayed when trying to remove a 'favor' when there is none in the first place.
+ throw new AlreadyFulfilledException(_('This is already not favorited.'));
+ }
- Event::handle('EndFavorNotice', array($profile, $notice));
+ $result = $fave->delete();
+ if ($result === false) {
+ common_log_db_error($fave, 'DELETE', __FILE__);
+ // TRANS: Server error displayed when removing a favorite from the database fails.
+ throw new ServerException(_('Could not delete favorite.'));
}
- return $fave;
+ Fave::blowCacheForProfileId($actor->getID());
+ Fave::blowCacheForNoticeId($target->getID());
+ }
+
+ // exception throwing takeover!
+ public function insert()
+ {
+ if (parent::insert()===false) {
+ common_log_db_error($this, 'INSERT', __FILE__);
+ throw new ServerException(sprintf(_m('Could not store new object of type %s'), get_called_class()));
+ }
+ self::blowCacheForProfileId($this->user_id);
+ self::blowCacheForNoticeId($this->notice_id);
+ return $this;
}
- function delete($useWhere=false)
+ public function delete($useWhere=false)
{
$profile = Profile::getKV('id', $this->user_id);
$notice = Notice::getKV('id', $this->notice_id);
if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
$result = parent::delete($useWhere);
- self::blow('fave:list-ids:notice_id:%d', $this->notice_id);
+
+ self::blowCacheForProfileId($this->user_id);
+ self::blowCacheForNoticeId($this->notice_id);
self::blow('popular');
if ($result) {
return $result;
}
- function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
+ static function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
{
$stream = new FaveNoticeStream($user_id, $own);
function asActivity()
{
- $notice = Notice::getKV('id', $this->notice_id);
-
- if (!$notice) {
- throw new Exception("Fave for non-existent notice: " . $this->notice_id);
- }
-
- $profile = Profile::getKV('id', $this->user_id);
-
- if (!$profile) {
- throw new Exception("Fave by non-existent profile: " . $this->user_id);
- }
+ $target = $this->getTarget();
+ $actor = $this->getActor();
$act = new Activity();
// FIXME: rationalize this with URL below
- $act->id = $this->getURI();
+ $act->id = $this->getUri();
- $act->time = strtotime($this->modified);
+ $act->time = strtotime($this->created);
// TRANS: Activity title when marking a notice as favorite.
$act->title = _("Favor");
- // TRANS: Ntofication given when a user marks a notice as favorite.
- // TRANS: %1$s is a user nickname or full name, %2$s is a notice URI.
- $act->content = sprintf(_('%1$s marked notice %2$s as a favorite.'),
- $profile->getBestName(),
- $notice->getUrl());
+ // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
+ // notice's nickname and %3$s is the content of the favorited notice.)
+ $act->content = sprintf(_('%1$s favorited something by %2$s: %3$s'),
+ $actor->getNickname(), $target->getProfile()->getNickname(),
+ $target->rendered ?: $target->content);
- $act->actor = ActivityObject::fromProfile($profile);
- $act->objects[] = ActivityObject::fromNotice($notice);
+ $act->actor = $actor->asActivityObject();
+ $act->target = $target->asActivityObject();
+ $act->objects = array(clone($act->target));
$url = common_local_url('AtomPubShowFavorite',
- array('profile' => $this->user_id,
- 'notice' => $this->notice_id));
+ array('profile' => $actor->id,
+ 'notice' => $target->id));
$act->selfLink = $url;
$act->editLink = $url;
return $act;
}
- static function existsForProfile($notice, Profile $scoped) {
+ static function existsForProfile($notice, Profile $scoped)
+ {
$fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
return ($fave instanceof Fave);
return $fav;
}
- function getURI()
+ static function countByProfile(Profile $profile)
{
- if (!empty($this->uri)) {
- return $this->uri;
- } else {
- return self::newURI($this->user_id, $this->notice_id, $this->modified);
+ $c = Cache::instance();
+ if (!empty($c)) {
+ $cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
+ if (is_integer($cnt)) {
+ return $cnt;
+ }
}
- }
- static function newURI($profile_id, $notice_id, $modified)
- {
- return TagURI::mint('favor:%d:%d:%s',
- $profile_id,
- $notice_id,
- common_date_iso8601($modified));
- }
+ $faves = new Fave();
+ $faves->user_id = $profile->id;
+ $cnt = (int) $faves->count('notice_id');
+ if (!empty($c)) {
+ $c->set(Cache::key('fave:count_by_profile:'.$profile->id), $cnt);
+ }
+
+ return $cnt;
+ }
static protected $_faves = array();
*
* @return array Array of Fave objects
*/
- static public function byNotice($notice)
+ static public function byNotice(Notice $notice)
{
if (!isset(self::$_faves[$notice->id])) {
self::fillFaves(array($notice->id));
$faveMap = Fave::listGet('notice_id', $notice_ids);
self::$_faves = array_replace(self::$_faves, $faveMap);
}
+
+ static public function blowCacheForProfileId($profile_id)
+ {
+ $cache = Cache::instance();
+ if ($cache) {
+ // Faves don't happen chronologically, so we need to blow
+ // ;last cache, too
+ $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id));
+ $cache->delete(Cache::key('fave:ids_by_user:'.$profile_id.';last'));
+ $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id));
+ $cache->delete(Cache::key('fave:ids_by_user_own:'.$profile_id.';last'));
+ $cache->delete(Cache::key('fave:count_by_profile:'.$profile_id));
+ }
+ }
+ static public function blowCacheForNoticeId($notice_id)
+ {
+ $cache = Cache::instance();
+ if ($cache) {
+ $cache->delete(Cache::key('fave:list-ids:notice_id:'.$notice_id));
+ }
+ }
+
+ // Remember that we want the _activity_ notice here, not faves applied
+ // to the supplied Notice (as with byNotice)!
+ static public function fromStored(Notice $stored)
+ {
+ $class = get_called_class();
+ $object = new $class;
+ $object->uri = $stored->uri;
+ if (!$object->find(true)) {
+ throw new NoResultException($object);
+ }
+ return $object;
+ }
+
+ /**
+ * Retrieves the _targeted_ notice of a verb (such as the notice that was
+ * _favorited_, but not the favorite activity itself).
+ *
+ * @param Notice $stored The activity notice.
+ *
+ * @throws NoResultException when it can't find what it's looking for.
+ */
+ static public function getTargetFromStored(Notice $stored)
+ {
+ return self::fromStored($stored)->getTarget();
+ }
+
+ static public function getObjectType()
+ {
+ return 'activity';
+ }
+
+ public function asActivityObject(Profile $scoped=null)
+ {
+ $actobj = new ActivityObject();
+ $actobj->id = $this->getUri();
+ $actobj->type = ActivityUtils::resolveUri(self::getObjectType());
+ $actobj->actor = $this->getActorObject();
+ $actobj->target = $this->getTargetObject();
+ $actobj->objects = array(clone($actobj->target));
+ $actobj->verb = ActivityVerb::FAVORITE;
+ $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
+ $actobj->content = $this->getTarget()->rendered ?: $this->getTarget()->content;
+ return $actobj;
+ }
+
+ /**
+ * @param ActivityObject $actobj The _favored_ notice (which we're "in-reply-to")
+ * @param Notice $stored The _activity_ notice, i.e. the favor itself.
+ */
+ static public function parseActivityObject(ActivityObject $actobj, Notice $stored)
+ {
+ $local = ActivityUtils::findLocalObject($actobj->getIdentifiers());
+ if (!$local instanceof Notice) {
+ // $local always returns something, but this was not what we expected. Something is wrong.
+ throw new Exception('Something other than a Notice was returned from findLocalObject');
+ }
+
+ $actor = $stored->getProfile();
+ $object = new Fave();
+ $object->user_id = $stored->getProfile()->id;
+ $object->notice_id = $local->id;
+ $object->uri = $stored->uri;
+ $object->created = $stored->created;
+ $object->modified = $stored->modified;
+ return $object;
+ }
+
+ static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
+ {
+ $target = self::getTargetFromStored($stored);
+
+ // The following logic was copied from StatusNet's Activity plugin
+ if (ActivityUtils::compareVerbs($target->verb, array(ActivityVerb::POST))) {
+ // "I like the thing you posted"
+ $act->objects = $target->asActivity()->objects;
+ } else {
+ // "I like that you did whatever you did"
+ $act->target = $target->asActivityObject();
+ $act->objects = array(clone($act->target));
+ }
+ $act->context->replyToID = $target->getUri();
+ $act->context->replyToUrl = $target->getUrl();
+ $act->title = ActivityUtils::verbToTitle($act->verb);
+ }
+
+ static function saveActivityObject(ActivityObject $actobj, Notice $stored)
+ {
+ $object = self::parseActivityObject($actobj, $stored);
+ $object->insert(); // exception throwing in Fave's case!
+
+ self::blowCacheForProfileId($object->user_id);
+ self::blowCacheForNoticeId($object->notice_id);
+ self::blow('popular');
+
+ Event::handle('EndFavorNotice', array($stored->getProfile(), $object->getTarget()));
+ return $object;
+ }
+
+ public function getAttentionArray() {
+ // not all objects can/should carry attentions, so we don't require extending this
+ // the format should be an array with URIs to mentioned profiles
+ return array();
+ }
+
+ public function getTarget()
+ {
+ // throws exception on failure
+ $target = new Notice();
+ $target->id = $this->notice_id;
+ if (!$target->find(true)) {
+ throw new NoResultException($target);
+ }
+
+ return $target;
+ }
+
+ public function getTargetObject()
+ {
+ return $this->getTarget()->asActivityObject();
+ }
+
+ protected $_stored = array();
+
+ public function getStored()
+ {
+ if (!isset($this->_stored[$this->uri])) {
+ $stored = new Notice();
+ $stored->uri = $this->uri;
+ if (!$stored->find(true)) {
+ throw new NoResultException($stored);
+ }
+ $this->_stored[$this->uri] = $stored;
+ }
+ return $this->_stored[$this->uri];
+ }
+
+ public function getActor()
+ {
+ return Profile::getByID($this->user_id);
+ }
+
+ public function getActorObject()
+ {
+ return $this->getActor()->asActivityObject();
+ }
+
+ public function getUri()
+ {
+ if (!empty($this->uri)) {
+ return $this->uri;
+ }
+
+ // We (should've in this case) created it ourselves, so we tag it ourselves
+ return self::newUri($this->getActor(), $this->getTarget(), $this->created);
+ }
}
projects / quix0rs-gnu-social.git / blobdiff