gnu-social/classes/Fave.php

241 lines
6.9 KiB
PHP
Raw Normal View History

<?php
/**
* Table Definition for fave
*/
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
2009-05-01 20:01:28 +01:00
class Fave extends Memcached_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 $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
/* Static get */
function staticGet($k,$v=null)
{ return Memcached_DataObject::staticGet('Fave',$k,$v); }
/* the code above is auto generated do not remove the tag below */
###END_AUTOCODE
/**
* 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;
if (!$fave->insert()) {
common_log_db_error($fave, 'INSERT', __FILE__);
return false;
}
self::blow('fave:by_notice', $fave->notice_id);
Event::handle('EndFavorNotice', array($profile, $notice));
}
return $fave;
}
2009-05-01 20:01:28 +01:00
function delete()
{
$profile = Profile::staticGet('id', $this->user_id);
$notice = Notice::staticGet('id', $this->notice_id);
$result = null;
if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) {
$result = parent::delete();
self::blow('fave:by_notice', $this->notice_id);
if ($result) {
Event::handle('EndDisfavorNotice', array($profile, $notice));
}
}
return $result;
}
function pkeyGet($kv)
{
return Memcached_DataObject::pkeyGet('Fave', $kv);
}
2009-05-01 20:01:28 +01:00
function stream($user_id, $offset=0, $limit=NOTICES_PER_PAGE, $own=false, $since_id=0, $max_id=0)
2009-05-01 20:01:28 +01:00
{
$ids = Notice::stream(array('Fave', '_streamDirect'),
array($user_id, $own),
($own) ? 'fave:ids_by_user_own:'.$user_id :
2009-07-05 16:32:57 +01:00
'fave:ids_by_user:'.$user_id,
$offset, $limit, $since_id, $max_id);
2009-05-01 20:01:28 +01:00
return $ids;
}
/**
* Note that the sorting for this is by order of *fave* not order of *notice*.
*
* @fixme add since_id, max_id support?
*
* @param <type> $user_id
* @param <type> $own
* @param <type> $offset
* @param <type> $limit
* @param <type> $since_id
* @param <type> $max_id
* @return <type>
*/
function _streamDirect($user_id, $own, $offset, $limit, $since_id, $max_id)
2009-05-01 20:01:28 +01:00
{
$fav = new Fave();
$qry = null;
if ($own) {
$qry = 'SELECT fave.* FROM fave ';
$qry .= 'WHERE fave.user_id = ' . $user_id . ' ';
} else {
$qry = 'SELECT fave.* FROM fave ';
$qry .= 'INNER JOIN notice ON fave.notice_id = notice.id ';
$qry .= 'WHERE fave.user_id = ' . $user_id . ' ';
$qry .= 'AND notice.is_local != ' . Notice::GATEWAY . ' ';
}
2009-05-01 20:01:28 +01:00
if ($since_id != 0) {
$qry .= 'AND notice_id > ' . $since_id . ' ';
2009-05-01 20:01:28 +01:00
}
if ($max_id != 0) {
$qry .= 'AND notice_id <= ' . $max_id . ' ';
2009-05-01 20:01:28 +01:00
}
// NOTE: we sort by fave time, not by notice time!
$qry .= 'ORDER BY modified DESC ';
2009-05-01 20:01:28 +01:00
if (!is_null($offset)) {
$qry .= "LIMIT $limit OFFSET $offset";
2009-05-01 20:01:28 +01:00
}
$fav->query($qry);
2009-05-01 20:01:28 +01:00
$ids = array();
while ($fav->fetch()) {
$ids[] = $fav->notice_id;
2009-05-01 20:01:28 +01:00
}
$fav->free();
unset($fav);
2009-05-01 20:01:28 +01:00
return $ids;
}
function asActivity()
{
$notice = Notice::staticGet('id', $this->notice_id);
$profile = Profile::staticGet('id', $this->user_id);
$act = new Activity();
$act->verb = ActivityVerb::FAVORITE;
2010-12-10 23:50:50 +00:00
// FIXME: rationalize this with URL below
$act->id = TagURI::mint('favor:%d:%d:%s',
$profile->id,
$notice->id,
common_date_iso8601($this->modified));
$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->uri);
$act->actor = ActivityObject::fromProfile($profile);
$act->objects[] = ActivityObject::fromNotice($notice);
2010-12-10 23:50:50 +00:00
$url = common_local_url('AtomPubShowFavorite',
array('profile' => $this->user_id,
'notice' => $this->notice_id));
$act->selfLink = $url;
$act->editLink = $url;
return $act;
}
2010-12-12 17:22:04 +00:00
/**
* 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;
}
/**
* Grab a list of profile who have favored this notice.
*
* @return ArrayWrapper masquerading as a Fave
*/
static function byNotice($noticeId)
{
$c = self::memcache();
$key = Cache::key('fave:by_notice', $noticeId);
$wrapper = $c->get($key);
if (!$wrapper) {
// @fixme caching & scalability!
$fave = new Fave();
$fave->notice_id = $noticeId;
$fave->find();
$profiles = array();
while ($fave->fetch()) {
$list[] = clone($fave);
}
$wrapper = new ArrayWrapper($list);
$c->set($key, $wrapper);
}
return $wrapper;
}
}