Merge branch 'json-activities' into 0.9.x

This commit is contained in:
Zach Copley 2011-02-25 00:15:26 -08:00
commit 17176ee445
21 changed files with 785 additions and 87 deletions

View File

@ -169,6 +169,14 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link,'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -263,6 +263,14 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link,'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -106,6 +106,11 @@ class ApiTimelineGroupAction extends ApiPrivateAuthAction
$self = $this->getSelfUri(); $self = $this->getSelfUri();
$link = common_local_url(
'ApiTimelineGroup',
array('nickname' => $this->group->nickname)
);
switch($this->format) { switch($this->format) {
case 'xml': case 'xml':
$this->showXmlTimeline($this->notices); $this->showXmlTimeline($this->notices);
@ -123,24 +128,20 @@ class ApiTimelineGroupAction extends ApiPrivateAuthAction
break; break;
case 'atom': case 'atom':
header('Content-Type: application/atom+xml; charset=utf-8'); header('Content-Type: application/atom+xml; charset=utf-8');
try {
$atom->addEntryFromNotices($this->notices); $atom->addEntryFromNotices($this->notices);
$this->raw($atom->getString()); $this->raw($atom->getString());
} catch (Atom10FeedException $e) {
$this->serverError(
// TRANS: Server error displayed when generating an Atom feed fails.
// TRANS: %s is the error.
sprintf(_('Could not generate feed for group - %s'),$e->getMessage()),
400,
$this->format
);
return;
}
break; break;
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($atom->title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
$this->clientError( $this->clientError(
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.

View File

@ -168,6 +168,14 @@ class ApiTimelineHomeAction extends ApiBareAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -169,6 +169,14 @@ class ApiTimelineMentionsAction extends ApiBareAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -234,6 +234,14 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -92,6 +92,20 @@ class ApiTimelineRetweetedToMeAction extends ApiAuthAction
$offset = ($this->page-1) * $this->cnt; $offset = ($this->page-1) * $this->cnt;
$limit = $this->cnt; $limit = $this->cnt;
// TRANS: Title for Atom feed "repeated to me". %s is the user nickname.
$title = sprintf(_("Repeated to %s"), $this->auth_user->nickname);
$subtitle = sprintf(
_('%1$s notices that were to repeated to %2$s / %3$s.'),
$sitename, $this->user->nickname, $profile->getBestName()
);
$taguribase = TagURI::base();
$id = "tag:$taguribase:RepeatedToMe:" . $this->auth_user->id;
$link = common_local_url(
'all',
array('nickname' => $this->auth_user->nickname)
);
$strm = $this->auth_user->repeatedToMe($offset, $limit, $this->since_id, $this->max_id); $strm = $this->auth_user->repeatedToMe($offset, $limit, $this->since_id, $this->max_id);
switch ($this->format) { switch ($this->format) {
@ -102,16 +116,31 @@ class ApiTimelineRetweetedToMeAction extends ApiAuthAction
$this->showJsonTimeline($strm); $this->showJsonTimeline($strm);
break; break;
case 'atom': case 'atom':
$profile = $this->auth_user->getProfile(); header('Content-Type: application/atom+xml; charset=utf-8');
// TRANS: Title for Atom feed "repeated to me". %s is the user nickname. $atom = new AtomNoticeFeed($this->auth_user);
$title = sprintf(_("Repeated to %s"), $this->auth_user->nickname);
$taguribase = TagURI::base();
$id = "tag:$taguribase:RepeatedToMe:" . $this->auth_user->id;
$link = common_local_url('all',
array('nickname' => $this->auth_user->nickname));
$this->showAtomTimeline($strm, $title, $id, $link); $atom->setId($id);
$atom->setTitle($title);
$atom->setSubtitle($subtitle);
$atom->setUpdated('now');
$atom->addLink($link);
$id = $this->arg('id');
$atom->setSelfLink($self);
$atom->addEntryFromNotices($strm);
$this->raw($atom->getString());
break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($strm);
$this->raw($doc->asString());
break; break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.

View File

@ -93,9 +93,27 @@ class ApiTimelineRetweetsOfMeAction extends ApiAuthAction
$offset = ($this->page-1) * $this->cnt; $offset = ($this->page-1) * $this->cnt;
$limit = $this->cnt; $limit = $this->cnt;
$strm = $this->auth_user->repeatsOfMe($offset, $limit, $this->since_id, $this->max_id); // TRANS: Title of list of repeated notices of the logged in user.
// TRANS: %s is the nickname of the logged in user.
$title = sprintf(_("Repeats of %s"), $this->auth_user->nickname);
$sitename = common_config('site', 'name');
common_debug(var_export($strm, true)); $profile = $this->auth_user->getProfile();
$subtitle = sprintf(
_('%1$s notices that %2$s / %3$s has repeated.'),
$sitename, $this->auth_user->nickname, $profile->getBestName()
);
$taguribase = TagURI::base();
$id = "tag:$taguribase:RepeatsOfMe:" . $this->auth_user->id;
$link = common_local_url(
'all',
array('nickname' => $this->auth_user->nickname)
);
$strm = $this->auth_user->repeatsOfMe($offset, $limit, $this->since_id, $this->max_id);
switch ($this->format) { switch ($this->format) {
case 'xml': case 'xml':
@ -105,49 +123,28 @@ class ApiTimelineRetweetsOfMeAction extends ApiAuthAction
$this->showJsonTimeline($strm); $this->showJsonTimeline($strm);
break; break;
case 'atom': case 'atom':
$profile = $this->auth_user->getProfile();
// TRANS: Title of list of repeated notices of the logged in user.
// TRANS: %s is the nickname of the logged in user.
$title = sprintf(_("Repeats of %s"), $this->auth_user->nickname);
$taguribase = TagURI::base();
$id = "tag:$taguribase:RepeatsOfMe:" . $this->auth_user->id;
header('Content-Type: application/atom+xml; charset=utf-8'); header('Content-Type: application/atom+xml; charset=utf-8');
$atom = new AtomNoticeFeed($this->auth_user); $atom = new AtomNoticeFeed($this->auth_user);
$atom->setId($id); $atom->setId($id);
$atom->setTitle($title); $atom->setTitle($title);
$atom->setSubtitle($subtitle); $atom->setSubtitle($subtitle);
$atom->setUpdated('now'); $atom->setUpdated('now');
$atom->addLink($link);
$atom->addLink( $atom->setSelfLink($this->getSelfUri());
common_local_url(
'showstream',
array('nickname' => $this->auth_user->nickname)
)
);
$id = $this->arg('id');
$aargs = array('format' => 'atom');
if (!empty($id)) {
$aargs['id'] = $id;
}
$atom->addLink(
$this->getSelfUri('ApiTimelineRetweetsOfMe', $aargs),
array('rel' => 'self', 'type' => 'application/atom+xml')
);
$atom->addEntryFromNotices($strm); $atom->addEntryFromNotices($strm);
$this->raw($atom->getString()); $this->raw($atom->getString());
break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($strm);
$this->raw($doc->asString());
break; break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), 404);
break; break;
} }
} }

View File

@ -107,7 +107,7 @@ class ApiTimelineTagAction extends ApiPrivateAuthAction
$sitename $sitename
); );
$taguribase = TagURI::base(); $taguribase = TagURI::base();
$id = "tag:$taguribase:TagTimeline:".$tag; $id = "tag:$taguribase:TagTimeline:".$this->tag;
$link = common_local_url( $link = common_local_url(
'tag', 'tag',
@ -116,8 +116,6 @@ class ApiTimelineTagAction extends ApiPrivateAuthAction
$self = $this->getSelfUri(); $self = $this->getSelfUri();
common_debug("self link is: $self");
switch($this->format) { switch($this->format) {
case 'xml': case 'xml':
$this->showXmlTimeline($this->notices); $this->showXmlTimeline($this->notices);
@ -154,6 +152,14 @@ class ApiTimelineTagAction extends ApiPrivateAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -201,6 +201,17 @@ class ApiTimelineUserAction extends ApiBareAuthAction
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);
break; break;
case 'as':
header('Content-Type: application/json; charset=utf-8');
$doc = new ActivityStreamJSONDocument($this->auth_user);
$doc->setTitle($atom->title);
$doc->addLink($link, 'alternate', 'text/html');
$doc->addItemsFromNotices($this->notices);
// XXX: Add paging extension?
$this->raw($doc->asString());
break;
default: default:
// TRANS: Client error displayed when trying to handle an unknown API method. // TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404); $this->clientError(_('API method not found.'), $code = 404);

View File

@ -1250,14 +1250,13 @@ class Notice extends Memcached_DataObject
* @return Activity activity object representing this Notice. * @return Activity activity object representing this Notice.
*/ */
function asActivity() function asActivity($cur)
{ {
$act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id)); $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
if (!empty($act)) { if (!empty($act)) {
return $act; return $act;
} }
$act = new Activity(); $act = new Activity();
if (Event::handle('StartNoticeAsActivity', array($this, &$act))) { if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
@ -1265,6 +1264,7 @@ class Notice extends Memcached_DataObject
$profile = $this->getProfile(); $profile = $this->getProfile();
$act->actor = ActivityObject::fromProfile($profile); $act->actor = ActivityObject::fromProfile($profile);
$act->actor->extra[] = $profile->profileInfo($cur);
$act->verb = ActivityVerb::POST; $act->verb = ActivityVerb::POST;
$act->objects[] = ActivityObject::fromNotice($this); $act->objects[] = ActivityObject::fromNotice($this);
@ -1404,7 +1404,7 @@ class Notice extends Memcached_DataObject
$author=true, $author=true,
$cur=null) $cur=null)
{ {
$act = $this->asActivity(); $act = $this->asActivity($cur);
$act->extra[] = $this->noticeInfo($cur); $act->extra[] = $this->noticeInfo($cur);
return $act->asString($namespace, $author, $source); return $act->asString($namespace, $author, $source);
} }

View File

@ -946,12 +946,12 @@ class Profile extends Memcached_DataObject
* *
* @param User $cur Current user * @param User $cur Current user
* *
* @return array representation of <statusnet:profile_info> element * @return array representation of <statusnet:profile_info> element or null
*/ */
function profileInfo($cur) function profileInfo($cur)
{ {
$profileInfoAttr = array(); $profileInfoAttr = array('local_id' => $this->id);
if ($cur != null) { if ($cur != null) {
// Whether the current user is a subscribed to this profile // Whether the current user is a subscribed to this profile

View File

@ -337,6 +337,157 @@ class Activity
return null; return null;
} }
/**
* Returns an array based on this activity suitable
* for encoding as a JSON object
*
* @return array $activity
*/
function asArray()
{
$activity = array();
// actor
$activity['actor'] = $this->actor->asArray();
// body
$activity['body'] = $this->content;
// generator <-- We could use this when we know a notice is created
// locally. Or if we know the upstream Generator.
// icon <-- I've decided to use the posting user's stream avatar here
// for now (also included in the avatarLinks extension)
// object
if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
$activity['object'] = $this->objects[0]->asArray();
// Context stuff. For now I'm just sticking most of it
// in a property called "context"
if (!empty($this->context)) {
if (!empty($this->context->location)) {
$loc = $this->context->location;
// GeoJSON
$activity['geopoint'] = array(
'type' => 'Point',
'coordinates' => array($loc->lat, $loc->lon)
);
}
$activity['to'] = $this->context->getToArray();
$activity['context'] = $this->context->asArray();
}
// Instead of adding enclosures as an extension to JSON
// Activities, it seems like we should be using the
// attachedObjects property of ActivityObject
$attachedObjects = array();
// XXX: OK, this is kinda cheating. We should probably figure out
// what kind of objects these are based on mime-type and then
// create specific object types. Right now this rely on
// duck-typing. Also, we should include an embed code for
// video attachments.
foreach ($this->enclosures as $enclosure) {
if (is_string($enclosure)) {
$attachedObjects[]['id'] = $enclosure;
} else {
$attachedObjects[]['id'] = $enclosure->url;
$mediaLink = new ActivityStreamsMediaLink(
$enclosure->url,
null,
null,
$enclosure->mimetype
// XXX: Add 'size' as an extension to MediaLink?
);
$attachedObjects[]['mediaLink'] = $mediaLink->asArray(); // extension
if ($enclosure->title) {
$attachedObjects[]['displayName'] = $enclosure->title;
}
}
}
if (!empty($attachedObjects)) {
$activity['object']['attachedObjects'] = $attachedObjects;
}
} else {
$activity['object'] = array();
foreach($this->objects as $object) {
$activity['object'][] = $object->asArray();
}
}
$activity['postedTime'] = self::iso8601Date($this->time); // Change to exactly be RFC3339?
// provider
$provider = array(
'objectType' => 'service',
'displayName' => common_config('site', 'name'),
'url' => common_root_url()
);
$activity['provider'] = $provider;
// target
if (!empty($this->target)) {
$activity['target'] = $this->target->asArray();
}
// title
$activity['title'] = $this->title;
// updatedTime <-- Should we use this to indicate the time we received
// a remote notice? Probably not.
// verb
//
// We can probably use the whole schema URL here but probably the
// relative simple name is easier to parse
$activity['verb'] = substr($this->verb, strrpos($this->verb, '/') + 1);
/* Purely extensions hereafter */
$tags = array();
// Use an Activity Object for term? Which object? Note?
foreach ($this->categories as $cat) {
$tags[] = $cat->term;
}
$activity['tags'] = $tags;
// XXX: a bit of a hack... Since JSON isn't namespaced we probably
// shouldn't be using 'statusnet:notice_info', but this will work
// for the moment.
foreach ($this->extra as $e) {
list($objectName, $props, $txt) = $e;
if (!empty($objectName)) {
$activity[$objectName] = $props;
}
}
return array_filter($activity);
}
function asString($namespace=false, $author=true, $source=false) function asString($namespace=false, $author=true, $source=false)
{ {
$xs = new XMLStringer(true); $xs = new XMLStringer(true);

View File

@ -130,4 +130,80 @@ class ActivityContext
common_log(LOG_ERR, "Ignoring bogus georss:point value $point"); common_log(LOG_ERR, "Ignoring bogus georss:point value $point");
return null; return null;
} }
/**
* Returns context (StatusNet stuff) as an array suitable for serializing
* in JSON. Right now context stuff is an extension to Activity.
*
* @return array the context
*/
function asArray()
{
$context = array();
$context['inReplyTo'] = $this->getInReplyToArray();
$context['conversation'] = $this->conversation;
$context['forwardId'] = $this->forwardID;
$context['forwardUrl'] = $this->forwardUrl;
return array_filter($context);
} }
/**
* Returns an array of arrays representing Activity Objects (intended to be
* serialized in JSON) that represent WHO the Activity is supposed to
* be received by. This is not really specified but appears in an example
* of the current spec as an extension. We might want to figure out a JSON
* serialization for OStatus and use that to express mentions instead.
*
* XXX: People's ideas on how to do this are all over the place
*
* @return array the array of recipients
*/
function getToArray()
{
$tos = array();
foreach ($this->attention as $attnUrl) {
$to = array(
'objectType' => 'person',
'id' => $attnUrl,
'url' => $attnUrl
);
$tos[] = $to;
}
return $tos;
}
/**
* Return an array for the notices this notice is a reply to
* suitable for serializing as JSON note objects.
*
* @return array the array of notes
*/
function getInReplyToArray()
{
if (empty($this->replyToID) && empty($this->replyToUrl)) {
return null;
}
$replyToObj = array('objectType' => 'note');
// XXX: Possibly shorten this to just the numeric ID?
// Currently, it's the full URI of the notice.
if (!empty($this->replyToID)) {
$replyToObj['id'] = $this->replyToID;
}
if (!empty($this->replyToUrl)) {
$replyToObj['url'] = $this->replyToUrl;
}
return $replyToObj;
}
}

View File

@ -633,4 +633,103 @@ class ActivityObject
return $xs->getString(); return $xs->getString();
} }
/*
* Returns an array based on this Activity Object suitable for
* encoding as JSON.
*
* @return array $object the activity object array
*/
function asArray()
{
$object = array();
// XXX: attachedObjects are added by Activity
// displayName
$object['displayName'] = $this->title;
// TODO: downstreamDuplicates
// embedCode (used for video)
// id
//
// XXX: Should we use URL here? or a crazy tag URI?
$object['id'] = $this->id;
if ($this->type == ActivityObject::PERSON
|| $this->type == ActivityObject::GROUP) {
// XXX: Not sure what the best avatar is to use for the
// author's "image". For now, I'm using the large size.
$avatarLarge = null;
$avatarMediaLinks = array();
foreach ($this->avatarLinks as $a) {
// Make a MediaLink for every other Avatar
$avatar = new ActivityStreamsMediaLink(
$a->url,
$a->width,
$a->height,
$a->type,
'avatar'
);
// Find the big avatar to use as the "image"
if ($a->height == AVATAR_PROFILE_SIZE) {
$imgLink = $avatar;
}
$avatarMediaLinks[] = $avatar->asArray();
}
$object['avatarLinks'] = $avatarMediaLinks; // extension
// image
$object['image'] = $imgLink->asArray();
}
// objectType
//
// We can probably use the whole schema URL here but probably the
// relative simple name is easier to parse
$object['type'] = substr($this->type, strrpos($this->type, '/') + 1);
// summary
$object['summary'] = $this->summary;
// TODO: upstreamDuplicates
// url (XXX: need to put the right thing here...)
$object['url'] = $this->id;
/* Extensions */
foreach ($this->extra as $e) {
list($objectName, $props, $txt) = $e;
$object[$objectName] = $props;
}
// GeoJSON
if (!empty($this->geopoint)) {
list($lat, $long) = explode(' ', $this->geopoint);
$object['geopoint'] = array(
'type' => 'Point',
'coordinates' => array($lat, $long)
);
}
if (!empty($this->poco)) {
$object['contact'] = $this->poco->asArray();
}
return array_filter($object);
}
} }

View File

@ -0,0 +1,217 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Class for serializing Activity Streams in JSON
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Feed
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2011 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET'))
{
exit(1);
}
/**
* A class for generating JSON documents that represent an Activity Streams
*
* @category Feed
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class ActivityStreamJSONDocument
{
/* Top level array representing the document */
protected $doc = array();
/* The current authenticated user */
protected $cur = null;
/**
* Constructor
*
* @param User $cur the current authenticated user
*/
function __construct($cur = null)
{
$this->cur = $cur;
/* Title of the JSON document */
$this->doc['title'] = null;
/* Array of activity items */
$this->doc['items'] = array();
/* Array of links associated with the document */
$this->doc['links'] = array();
}
/**
* Set the title of the document
*
* @param String $title the title
*/
function setTitle($title)
{
$this->doc['title'] = $title;
}
/**
* Add more than one Item to the document
*
* @param mixed $notices an array of Notice objects or handle
*
*/
function addItemsFromNotices($notices)
{
if (is_array($notices)) {
foreach ($notices as $notice) {
$this->addItemFromNotice($notice);
}
} else {
while ($notices->fetch()) {
$this->addItemFromNotice($notices);
}
}
}
/**
* Add a single Notice to the document
*
* @param Notice $notice a Notice to add
*/
function addItemFromNotice($notice)
{
$cur = empty($this->cur) ? common_current_user() : $this->cur;
$act = $notice->asActivity($cur);
$act->extra[] = $notice->noticeInfo($cur);
array_push($this->doc['items'], $act->asArray());
}
/**
* Add a link to the JSON document
*
* @param string $url the URL for the link
* @param string $rel the link relationship
*/
function addLink($url = null, $rel = null, $mediaType = null)
{
$link = new ActivityStreamsLink($url, $rel, $mediaType);
$this->doc['link'][] = $link->asArray();
}
/*
* Return the entire document as a big string of JSON
*
* @return string encoded JSON output
*/
function asString()
{
return json_encode(array_filter($this->doc));
}
}
/**
* A class for representing MediaLinks in JSON Activities
*
* @category Feed
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class ActivityStreamsMediaLink extends ActivityStreamsLink
{
private $linkDict;
function __construct(
$url = null,
$width = null,
$height = null,
$mediaType = null,
$rel = null,
$duration = null
)
{
parent::__construct($url, $rel, $mediaType);
$this->linkDict = array(
'width' => $width,
'height' => $height,
'duration' => $duration
);
}
function asArray()
{
return array_merge(
parent::asArray(),
array_filter($this->linkDict)
);
}
}
/**
* A class for representing links in JSON Activities
*
* @category Feed
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class ActivityStreamsLink
{
private $linkDict;
function __construct($url = null, $rel = null, $mediaType = null)
{
// links MUST have a URL
if (empty($url)) {
throw new Exception('Links must have a URL.');
}
$this->linkDict = array(
'url' => $url,
'rel' => $rel, // extension
'type' => $mediaType // extension
);
}
function asArray()
{
return array_filter($this->linkDict);
}
}

View File

@ -64,7 +64,7 @@ class AtomUserNoticeFeed extends AtomNoticeFeed
$ao = ActivityObject::fromProfile($profile); $ao = ActivityObject::fromProfile($profile);
$ao->extra[] = $profile->profileInfo($cur); array_push($ao->extra, $profile->profileInfo($cur));
// XXX: For users, we generate an author _AND_ an <activity:subject> // XXX: For users, we generate an author _AND_ an <activity:subject>
// This is for backward compatibility with clients (especially // This is for backward compatibility with clients (especially

View File

@ -241,4 +241,42 @@ class PoCo
$url->outputTo($xo); $url->outputTo($xo);
} }
} }
/**
* Output a Portable Contact as an array suitable for serializing
* as JSON
*
* @return $array the PoCo array
*/
function asArray()
{
$poco = array();
$poco['preferredUsername'] = $this->preferredUsername;
$poco['displayName'] = $this->displayName;
if (!empty($this->note)) {
$poco['note'] = $this->note;
} }
if (!empty($this->address)) {
$poco['addresses'] = $this->address->asArray();
}
if (!empty($this->urls)) {
$urls = array();
foreach ($this->urls as $url) {
$urls[] = $url->asArray();
}
$poco['urls'] = $urls;
}
return $poco;
}
}

View File

@ -56,4 +56,17 @@ class PoCoAddress
$xo->elementEnd('poco:address'); $xo->elementEnd('poco:address');
} }
} }
/**
* Return this PoCo address as an array suitable for serializing in JSON
*
* @return array the address
*/
function asArray()
{
if (!empty($this->formatted)) {
return array('formatted' => $this->formatted);
}
}
} }

View File

@ -67,4 +67,24 @@ class PoCoURL
} }
$xo->elementEnd('poco:urls'); $xo->elementEnd('poco:urls');
} }
/**
* Return this PoCo URL as an array suitable for serializing in JSON
*
* @array $url the url
*/
function asArray()
{
$url = array();
$url['type'] = $this->type;
$url['value'] = $this->value;
if (!empty($this->primary)) {
$url['primary'] = 'true';
}
return $url;
}
} }

View File

@ -407,64 +407,64 @@ class Router
$m->connect('api/statuses/public_timeline.:format', $m->connect('api/statuses/public_timeline.:format',
array('action' => 'ApiTimelinePublic', array('action' => 'ApiTimelinePublic',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/friends_timeline.:format', $m->connect('api/statuses/friends_timeline.:format',
array('action' => 'ApiTimelineFriends', array('action' => 'ApiTimelineFriends',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/friends_timeline/:id.:format', $m->connect('api/statuses/friends_timeline/:id.:format',
array('action' => 'ApiTimelineFriends', array('action' => 'ApiTimelineFriends',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/home_timeline.:format', $m->connect('api/statuses/home_timeline.:format',
array('action' => 'ApiTimelineHome', array('action' => 'ApiTimelineHome',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/home_timeline/:id.:format', $m->connect('api/statuses/home_timeline/:id.:format',
array('action' => 'ApiTimelineHome', array('action' => 'ApiTimelineHome',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/user_timeline.:format', $m->connect('api/statuses/user_timeline.:format',
array('action' => 'ApiTimelineUser', array('action' => 'ApiTimelineUser',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/user_timeline/:id.:format', $m->connect('api/statuses/user_timeline/:id.:format',
array('action' => 'ApiTimelineUser', array('action' => 'ApiTimelineUser',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/mentions.:format', $m->connect('api/statuses/mentions.:format',
array('action' => 'ApiTimelineMentions', array('action' => 'ApiTimelineMentions',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/mentions/:id.:format', $m->connect('api/statuses/mentions/:id.:format',
array('action' => 'ApiTimelineMentions', array('action' => 'ApiTimelineMentions',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/replies.:format', $m->connect('api/statuses/replies.:format',
array('action' => 'ApiTimelineMentions', array('action' => 'ApiTimelineMentions',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/replies/:id.:format', $m->connect('api/statuses/replies/:id.:format',
array('action' => 'ApiTimelineMentions', array('action' => 'ApiTimelineMentions',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/retweeted_by_me.:format', $m->connect('api/statuses/retweeted_by_me.:format',
array('action' => 'ApiTimelineRetweetedByMe', array('action' => 'ApiTimelineRetweetedByMe',
'format' => '(xml|json|atom)')); 'format' => '(xml|json|atom|as)'));
$m->connect('api/statuses/retweeted_to_me.:format', $m->connect('api/statuses/retweeted_to_me.:format',
array('action' => 'ApiTimelineRetweetedToMe', array('action' => 'ApiTimelineRetweetedToMe',
'format' => '(xml|json|atom)')); 'format' => '(xml|json|atom|as)'));
$m->connect('api/statuses/retweets_of_me.:format', $m->connect('api/statuses/retweets_of_me.:format',
array('action' => 'ApiTimelineRetweetsOfMe', array('action' => 'ApiTimelineRetweetsOfMe',
'format' => '(xml|json|atom)')); 'format' => '(xml|json|atom|as)'));
$m->connect('api/statuses/friends.:format', $m->connect('api/statuses/friends.:format',
array('action' => 'ApiUserFriends', array('action' => 'ApiUserFriends',
@ -625,12 +625,12 @@ class Router
$m->connect('api/favorites.:format', $m->connect('api/favorites.:format',
array('action' => 'ApiTimelineFavorites', array('action' => 'ApiTimelineFavorites',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/favorites/:id.:format', $m->connect('api/favorites/:id.:format',
array('action' => 'ApiTimelineFavorites', array('action' => 'ApiTimelineFavorites',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/favorites/create/:id.:format', $m->connect('api/favorites/create/:id.:format',
array('action' => 'ApiFavoriteCreate', array('action' => 'ApiFavoriteCreate',
@ -695,7 +695,7 @@ class Router
$m->connect('api/statusnet/groups/timeline/:id.:format', $m->connect('api/statusnet/groups/timeline/:id.:format',
array('action' => 'ApiTimelineGroup', array('action' => 'ApiTimelineGroup',
'id' => Nickname::INPUT_FMT, 'id' => Nickname::INPUT_FMT,
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statusnet/groups/show.:format', $m->connect('api/statusnet/groups/show.:format',
array('action' => 'ApiGroupShow', array('action' => 'ApiGroupShow',
@ -756,7 +756,7 @@ class Router
// Tags // Tags
$m->connect('api/statusnet/tags/timeline/:tag.:format', $m->connect('api/statusnet/tags/timeline/:tag.:format',
array('action' => 'ApiTimelineTag', array('action' => 'ApiTimelineTag',
'format' => '(xml|json|rss|atom)')); 'format' => '(xml|json|rss|atom|as)'));
// media related // media related
$m->connect( $m->connect(