forked from GNUsocial/gnu-social
379 lines
12 KiB
PHP
379 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Table Definition for fave
|
|
*/
|
|
|
|
class Fave extends Managed_DataObject
|
|
{
|
|
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 $created; // datetime multiple_key not_null
|
|
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
|
|
|
|
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'),
|
|
'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'),
|
|
'unique keys' => array(
|
|
'fave_uri_key' => array('uri'),
|
|
),
|
|
'foreign keys' => array(
|
|
'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
|
|
'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites
|
|
),
|
|
'indexes' => array(
|
|
'fave_notice_id_idx' => array('notice_id'),
|
|
'fave_user_id_idx' => array('user_id', 'modified'),
|
|
'fave_modified_idx' => array('modified'),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
static function addNew(Profile $profile, Notice $notice) {
|
|
|
|
$fave = null;
|
|
|
|
if (Event::handle('StartFavorNotice', array($profile, $notice, &$fave))) {
|
|
|
|
$fave = new Fave();
|
|
|
|
$fave->user_id = $profile->id;
|
|
$fave->notice_id = $notice->id;
|
|
$fave->created = common_sql_now();
|
|
$fave->modified = common_sql_now();
|
|
$fave->uri = self::newURI($profile,
|
|
$notice,
|
|
$fave->created);
|
|
|
|
try {
|
|
$fave->insert();
|
|
} catch (ServerException $e) {
|
|
common_log_db_error($fave, 'INSERT', __FILE__);
|
|
return false;
|
|
}
|
|
self::blowCacheForProfileId($fave->user_id);
|
|
self::blowCacheForNoticeId($fave->notice_id);
|
|
self::blow('popular');
|
|
|
|
Event::handle('EndFavorNotice', array($profile, $notice));
|
|
}
|
|
|
|
return $fave;
|
|
}
|
|
|
|
// exception throwing takeover!
|
|
public function insert() {
|
|
if (!parent::insert()) {
|
|
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;
|
|
}
|
|
|
|
public function delete($useWhere=false)
|
|
{
|
|
$profile = Profile::getKV('id', $this->user_id);
|
|
$notice = Notice::getKV('id', $this->notice_id);
|
|
|
|
$result = null;
|
|
|
|
if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
|
|
|
|
$result = parent::delete($useWhere);
|
|
|
|
self::blowCacheForProfileId($this->user_id);
|
|
self::blowCacheForNoticeId($this->notice_id);
|
|
self::blow('popular');
|
|
|
|
if ($result) {
|
|
Event::handle('EndDisfavorNotice', array($profile, $notice));
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
|
|
{
|
|
$stream = new FaveNoticeStream($user_id, $own);
|
|
|
|
return $stream->getNotices($offset, $limit, $since_id, $max_id);
|
|
}
|
|
|
|
function idStream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
|
|
{
|
|
$stream = new FaveNoticeStream($user_id, $own);
|
|
|
|
return $stream->getNoticeIds($offset, $limit, $since_id, $max_id);
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
$act = new Activity();
|
|
|
|
$act->verb = ActivityVerb::FAVORITE;
|
|
|
|
// FIXME: rationalize this with URL below
|
|
|
|
$act->id = $this->getURI();
|
|
|
|
$act->time = strtotime($this->modified);
|
|
// 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());
|
|
|
|
$act->actor = ActivityObject::fromProfile($profile);
|
|
$act->objects[] = ActivityObject::fromNotice($notice);
|
|
|
|
$url = common_local_url('AtomPubShowFavorite',
|
|
array('profile' => $this->user_id,
|
|
'notice' => $this->notice_id));
|
|
|
|
$act->selfLink = $url;
|
|
$act->editLink = $url;
|
|
|
|
return $act;
|
|
}
|
|
|
|
static function existsForProfile($notice, Profile $scoped) {
|
|
$fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
|
|
|
|
return ($fave instanceof Fave);
|
|
}
|
|
|
|
/**
|
|
* Fetch a stream of favorites by profile
|
|
*
|
|
* @param integer $profileId Profile that faved
|
|
* @param integer $offset Offset from last
|
|
* @param integer $limit Number to get
|
|
*
|
|
* @return mixed stream of faves, use fetch() to iterate
|
|
*
|
|
* @todo Cache results
|
|
* @todo integrate with Fave::stream()
|
|
*/
|
|
|
|
static function byProfile($profileId, $offset, $limit)
|
|
{
|
|
$fav = new Fave();
|
|
|
|
$fav->user_id = $profileId;
|
|
|
|
$fav->orderBy('modified DESC');
|
|
|
|
$fav->limit($offset, $limit);
|
|
|
|
$fav->find();
|
|
|
|
return $fav;
|
|
}
|
|
|
|
static function countByProfile(Profile $profile)
|
|
{
|
|
$c = Cache::instance();
|
|
if (!empty($c)) {
|
|
$cnt = $c->get(Cache::key('fave:count_by_profile:'.$profile->id));
|
|
if (is_integer($cnt)) {
|
|
return $cnt;
|
|
}
|
|
}
|
|
|
|
$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();
|
|
|
|
/**
|
|
* All faves of this notice
|
|
*
|
|
* @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
|
|
*
|
|
* @return array Array of Fave objects
|
|
*/
|
|
static public function byNotice($notice)
|
|
{
|
|
if (!isset(self::$_faves[$notice->id])) {
|
|
self::fillFaves(array($notice->id));
|
|
}
|
|
return self::$_faves[$notice->id];
|
|
}
|
|
|
|
static public function fillFaves(array $notice_ids)
|
|
{
|
|
$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;
|
|
}
|
|
|
|
static public function verbToTitle($verb) {
|
|
return ucfirst($verb);
|
|
}
|
|
|
|
static public function object_type()
|
|
{
|
|
return 'activity';
|
|
}
|
|
|
|
public function asActivityObject(Profile $scoped=null) {
|
|
$actobj = new ActivityObject();
|
|
$actobj->id = $this->getUri();
|
|
$actobj->type = ActivityUtils::resolveUri(ActivityObject::ACTIVITY);
|
|
$actobj->actor = $this->getActorObject();
|
|
$actobj->objects = array(clone($actobj->target));
|
|
$actobj->title = Stored_ActivityVerb::verbToTitle($this->verb);
|
|
//$actobj->verb = $this->verb;
|
|
//$actobj->target = $this->getTargetObject();
|
|
return $actobj;
|
|
}
|
|
|
|
static public function parseActivityObject(ActivityObject $actobj, Notice $stored) {
|
|
$actor = $stored->getProfile();
|
|
$object = new Fave();
|
|
$object->user_id = $actor->id;
|
|
$object->notice_id = $stored->id;
|
|
$object->object_uri = $stored->uri;
|
|
$object->created = $stored->created;
|
|
return $object;
|
|
}
|
|
|
|
static function saveActivityObject(ActivityObject $actobj, Notice $stored) {
|
|
$object = self::parseActivityObject($actobj, $stored);
|
|
$object->insert(); // exception throwing!
|
|
return $object;
|
|
}
|
|
|
|
|
|
public function getTarget() {
|
|
// throws exception on failure
|
|
return ActivityUtils::findLocalObject(array($this->uri), $this->type);
|
|
}
|
|
|
|
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() {
|
|
$profile = new Profile();
|
|
$profile->id = $this->user_id;
|
|
if (!$profile->find(true)) {
|
|
throw new NoResultException($profile);
|
|
}
|
|
return $profile;
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
static function newURI(Profile $actor, Managed_DataObject $target, $created=null)
|
|
{
|
|
if (is_null($created)) {
|
|
$created = common_sql_now();
|
|
}
|
|
return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
|
|
$actor->id,
|
|
ActivityUtils::resolveUri(self::object_type(), true),
|
|
$target->id,
|
|
common_date_iso8601($created));
|
|
}
|
|
}
|