case 'json':
$this->showJsonTimeline($this->notices);
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:
// TRANS: Client error displayed when trying to handle an unknown API method.
$this->clientError(_('API method not found.'), $code = 404);
* @return Activity activity object representing this Notice.
*/
- function asActivity()
+ function asActivity($cur)
{
$act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
if (!empty($act)) {
return $act;
}
-
$act = new Activity();
if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
$profile = $this->getProfile();
- $act->actor = ActivityObject::fromProfile($profile);
- $act->verb = ActivityVerb::POST;
- $act->objects[] = ActivityObject::fromNotice($this);
+ $act->actor = ActivityObject::fromProfile($profile);
+ $act->actor->extra[] = $profile->profileInfo($cur);
+ $act->verb = ActivityVerb::POST;
+ $act->objects[] = ActivityObject::fromNotice($this);
// XXX: should this be handled by default processing for object entry?
$author=true,
$cur=null)
{
- $act = $this->asActivity();
+ $act = $this->asActivity($cur);
$act->extra[] = $this->noticeInfo($cur);
return $act->asString($namespace, $author, $source);
}
*
* @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)
{
- $profileInfoAttr = array();
+ $profileInfoAttr = array('local_id' => $this->id);
if ($cur != null) {
// Whether the current user is a subscribed to this profile
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 should use this when we know a notice is created
+ // locally
+
+ // icon <-- Should we use this? Maybe a little bubble like we have
+ // on Facebook posts?
+
+ // object
+ if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
+ $activity['object'] = $this->objects[0]->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 <-- We should probably use this for showing the the source
+ // of remote notices, if known
+
+ // 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 */
+
+ // 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)
{
$xs = new XMLStringer(true);
if (empty($this->type)) {
$this->type = self::PERSON; // XXX: is this fair?
}
-
+
// start with <atom:title>
$title = ActivityUtils::childHtmlContent($element, self::TITLE);
static function fromNotice(Notice $notice)
{
$object = new ActivityObject();
-
+
if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
$object->type = ActivityObject::NOTE;
return $object;
}
-
+
function outputTo($xo, $tag='activity:object')
{
if (!empty($tag)) {
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['avatars'] = $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;
+ }
+
+ return array_filter($object);
+ }
}
--- /dev/null
+<?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);
+ }
+}
$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>
// This is for backward compatibility with clients (especially
$m->connect('api/statuses/friends_timeline.:format',
array('action' => 'ApiTimelineFriends',
- 'format' => '(xml|json|rss|atom)'));
+ 'format' => '(xml|json|rss|atom|as)'));
$m->connect('api/statuses/friends_timeline/:id.:format',
array('action' => 'ApiTimelineFriends',
projects / quix0rs-gnu-social.git / commitdiff