public $title; // title of the activity
public $categories = array(); // list of AtomCategory objects
public $enclosures = array(); // list of enclosure URL references
+ public $attachments = array(); // list of attachments
+ public $extra = array(); // extra elements as array(tag, attrs, content)
+ public $source; // ActivitySource object representing 'home feed'
+ public $selfLink; // <link rel='self' type='application/atom+xml'>
+ public $editLink; // <link rel='edit' type='application/atom+xml'>
+ public $generator; // ActivityObject representing the generating application
/**
* Turns a regular old Atom <entry> into a magical activity
*
} else if ($entry->namespaceURI == Activity::RSS &&
$entry->localName == 'item') {
$this->_fromRssItem($entry, $feed);
+ } else if ($entry->namespaceURI == Activity::SPEC &&
+ $entry->localName == 'object') {
+ $this->_fromAtomEntry($entry, $feed);
} else {
// Low level exception. No need for i18n.
throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
// XXX: do other implied stuff here
}
- $objectEls = $entry->getElementsByTagNameNS(self::SPEC, self::OBJECT);
+ // get immediate object children
+
+ $objectEls = ActivityUtils::children($entry, self::OBJECT, self::SPEC);
- if ($objectEls->length > 0) {
- for ($i = 0; $i < $objectEls->length; $i++) {
- $objectEl = $objectEls->item($i);
- $this->objects[] = new ActivityObject($objectEl);
+ if (count($objectEls) > 0) {
+ foreach ($objectEls as $objectEl) {
+ // Special case for embedded activities
+ $objectType = ActivityUtils::childContent($objectEl, self::OBJECTTYPE, self::SPEC);
+ if (!empty($objectType) && $objectType == ActivityObject::ACTIVITY) {
+ $this->objects[] = new Activity($objectEl);
+ } else {
+ $this->objects[] = new ActivityObject($objectEl);
+ }
}
} else {
+ // XXX: really?
$this->objects[] = new ActivityObject($entry);
}
$actorEl = $this->_child($entry, self::ACTOR);
if (!empty($actorEl)) {
+ // Standalone <activity:actor> elements are a holdover from older
+ // versions of ActivityStreams. Newer feeds should have this data
+ // integrated straight into <atom:author>.
$this->actor = new ActivityObject($actorEl);
$this->actor->id = $authorObj->id;
}
}
+ } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
+
+ // An <atom:author> in the entry overrides any author info on
+ // the surrounding feed.
+ $this->actor = new ActivityObject($authorEl);
+
} else if (!empty($feed) &&
$subjectEl = $this->_child($feed, self::SUBJECT)) {
+ // Feed subject is used for things like groups.
+ // Should actually possibly not be interpreted as an actor...?
$this->actor = new ActivityObject($subjectEl);
- } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
-
- $this->actor = new ActivityObject($authorEl);
-
} else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
self::ATOM)) {
+ // If there's no <atom:author> on the entry, it's safe to assume
+ // the containing feed's authorship info applies.
$this->actor = new ActivityObject($authorEl);
}
if (!empty($targetEl)) {
$this->target = new ActivityObject($targetEl);
+ } elseif (ActivityUtils::compareVerbs($this->verb, array(ActivityVerb::FAVORITE))) {
+ // StatusNet didn't send a 'target' for their Favorite atom entries
+ $this->target = clone($this->objects[0]);
}
$this->summary = ActivityUtils::childContent($entry, 'summary');
foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
$this->enclosures[] = $link->getAttribute('href');
}
+
+ // From APP. Might be useful.
+
+ $this->selfLink = ActivityUtils::getLink($entry, 'self', 'application/atom+xml');
+ $this->editLink = ActivityUtils::getLink($entry, 'edit', 'application/atom+xml');
}
function _fromRssItem($item, $channel)
*
* @return DOMElement Atom entry
*/
+
function toAtomEntry()
{
return null;
}
- function asString($namespace=false, $author=true)
+ /**
+ * 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();
+
+ // content
+ $activity['content'] = $this->content;
+
+ // generator
+
+ if (!empty($this->generator)) {
+ $activity['generator'] = $this->generator->asArray();
+ }
+
+ // icon <-- possibly a mini object representing verb?
+
+ // id
+ $activity['id'] = $this->id;
+
+ // object
+
+ if (count($this->objects) == 0) {
+ common_log(LOG_ERR, "Can't save " . $this->id);
+ } else {
+ if (count($this->objects) > 1) {
+ common_log(LOG_WARNING, "Ignoring " . (count($this->objects) - 1) . " extra objects in JSON output for activity " . $this->id);
+ }
+ $object = $this->objects[0];
+
+ if ($object instanceof Activity) {
+ // Sharing a post activity is more like sharing the original object
+ if (ActivityVerb::canonical($this->verb) == ActivityVerb::canonical(ActivityVerb::SHARE) &&
+ ActivityVerb::canonical($object->verb) == ActivityVerb::canonical(ActivityVerb::POST)) {
+ // XXX: Here's one for the obfuscation record books
+ $object = $object->objects[0];
+ }
+ }
+
+ $activity['object'] = $object->asArray();
+
+ if ($object instanceof Activity) {
+ $activity['object']['objectType'] = 'activity';
+ }
+
+ foreach ($this->attachments as $attachment) {
+ if (empty($activity['object']['attachments'])) {
+ $activity['object']['attachments'] = array();
+ }
+ $activity['object']['attachments'][] = $attachment->asArray();
+ }
+ }
+
+ // Context stuff.
+
+ if (!empty($this->context)) {
+
+ if (!empty($this->context->location)) {
+ $loc = $this->context->location;
+
+ $activity['location'] = array(
+ 'objectType' => 'place',
+ 'position' => sprintf("%+02.5F%+03.5F/", $loc->lat, $loc->lon),
+ 'lat' => $loc->lat,
+ 'lon' => $loc->lon
+ );
+
+ $name = $loc->getName();
+
+ if ($name) {
+ $activity['location']['displayName'] = $name;
+ }
+
+ $url = $loc->getURL();
+
+ if ($url) {
+ $activity['location']['url'] = $url;
+ }
+ }
+
+ $activity['to'] = $this->context->getToArray();
+
+ $ctxarr = $this->context->asArray();
+
+ if (array_key_exists('inReplyTo', $ctxarr)) {
+ $activity['object']['inReplyTo'] = $ctxarr['inReplyTo'];
+ unset($ctxarr['inReplyTo']);
+ }
+
+ if (!array_key_exists('status_net', $activity)) {
+ $activity['status_net'] = array();
+ }
+
+ foreach ($ctxarr as $key => $value) {
+ $activity['status_net'][$key] = $value;
+ }
+ }
+
+ // published
+ $activity['published'] = self::iso8601Date($this->time);
+
+ // 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;
+
+ // updated <-- Optional. Should we use this to indicate the time we r
+ // eceived a remote notice? Probably not.
+
+ // verb
+
+ $activity['verb'] = ActivityVerb::canonical($this->verb);
+
+ // url
+ if ($this->link) {
+ $activity['url'] = $this->link;
+ }
+
+ /* Purely extensions hereafter */
+
+ if ($activity['verb'] == 'post') {
+ $tags = array();
+ foreach ($this->categories as $cat) {
+ if (mb_strlen($cat->term) > 0) {
+ // Couldn't figure out which object type to use, so...
+ $tags[] = array('objectType' => 'http://activityschema.org/object/hashtag',
+ 'displayName' => $cat->term);
+ }
+ }
+ if (count($tags) > 0) {
+ $activity['object']['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)) {
+ $parts = explode(":", $objectName);
+ if (count($parts) == 2 && $parts[0] == "statusnet") {
+ if (!array_key_exists('status_net', $activity)) {
+ $activity['status_net'] = array();
+ }
+ $activity['status_net'][$parts[1]] = $props;
+ } else {
+ $activity[$objectName] = $props;
+ }
+ }
+ }
+
+ return array_filter($activity);
+ }
+
+ function asString($namespace=false, $author=true, $source=false)
{
$xs = new XMLStringer(true);
+ $this->outputTo($xs, $namespace, $author, $source);
+ return $xs->getString();
+ }
+ function outputTo($xs, $namespace=false, $author=true, $source=false, $tag='entry')
+ {
if ($namespace) {
$attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
+ 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
'xmlns:georss' => 'http://www.georss.org/georss',
'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
- 'xmlns:media' => 'http://purl.org/syndication/atommedia');
+ 'xmlns:media' => 'http://purl.org/syndication/atommedia',
+ 'xmlns:statusnet' => 'http://status.net/schema/api/1/');
} else {
$attrs = array();
}
- $xs->elementStart('entry', $attrs);
+ $xs->elementStart($tag, $attrs);
- $xs->element('id', null, $this->id);
- $xs->element('title', null, $this->title);
- $xs->element('published', null, self::iso8601Date($this->time));
- $xs->element('content', array('type' => 'html'), $this->content);
-
- if (!empty($this->summary)) {
- $xs->element('summary', null, $this->summary);
+ if ($tag != 'entry') {
+ $xs->element('activity:object-type', null, ActivityObject::ACTIVITY);
}
- if (!empty($this->link)) {
- $xs->element('link', array('rel' => 'alternate',
- 'type' => 'text/html'),
- $this->link);
- }
+ if ($this->verb == ActivityVerb::POST && count($this->objects) == 1 && $tag == 'entry') {
- // XXX: add context
+ $obj = $this->objects[0];
+ $obj->outputTo($xs, null);
- if ($author) {
- $xs->elementStart('author');
- $xs->element('uri', array(), $this->actor->id);
- if ($this->actor->title) {
- $xs->element('name', array(), $this->actor->title);
+ } else {
+ $xs->element('id', null, $this->id);
+
+ if ($this->title) {
+ $xs->element('title', null, $this->title);
+ } else {
+ // Require element
+ $xs->element('title', null, "");
+ }
+
+ $xs->element('content', array('type' => 'html'), $this->content);
+
+ if (!empty($this->summary)) {
+ $xs->element('summary', null, $this->summary);
}
- $xs->elementEnd('author');
- $xs->raw($this->actor->asString('activity:actor'));
+
+ if (!empty($this->link)) {
+ $xs->element('link', array('rel' => 'alternate',
+ 'type' => 'text/html',
+ 'href' => $this->link));
+ }
+
}
$xs->element('activity:verb', null, $this->verb);
- if (!empty($this->objects)) {
+ $published = self::iso8601Date($this->time);
+
+ $xs->element('published', null, $published);
+ $xs->element('updated', null, $published);
+
+ if ($author) {
+ $this->actor->outputTo($xs, 'author');
+ }
+
+ if ($this->verb != ActivityVerb::POST || count($this->objects) != 1 || $tag != 'entry') {
foreach($this->objects as $object) {
- $xs->raw($object->asString());
+ if ($object instanceof Activity) {
+ $object->outputTo($xs, false, true, true, 'activity:object');
+ } else {
+ $object->outputTo($xs, 'activity:object');
+ }
+ }
+ }
+
+ if (!empty($this->context)) {
+
+ if (!empty($this->context->replyToID)) {
+ if (!empty($this->context->replyToUrl)) {
+ $xs->element('thr:in-reply-to',
+ array('ref' => $this->context->replyToID,
+ 'href' => $this->context->replyToUrl));
+ } else {
+ $xs->element('thr:in-reply-to',
+ array('ref' => $this->context->replyToID));
+ }
+ }
+
+ if (!empty($this->context->replyToUrl)) {
+ $xs->element('link', array('rel' => 'related',
+ 'href' => $this->context->replyToUrl));
+ }
+
+ if (!empty($this->context->conversation)) {
+ $xs->element('link', array('rel' => ActivityContext::CONVERSATION,
+ 'href' => $this->context->conversation));
+ $xs->element(ActivityContext::CONVERSATION, null, $this->context->conversation);
+ /* Since we use XMLWriter we just use the previously hardcoded prefix for ostatus,
+ otherwise we should use something like this:
+ $xs->elementNS(array(ActivityContext::OSTATUS => 'ostatus'), // namespace
+ 'conversation', // tag (or the element name from ActivityContext::CONVERSATION)
+ null, // attributes
+ $this->context->conversation); // content
+ */
+ }
+
+ foreach ($this->context->attention as $attnURI=>$type) {
+ $xs->element('link', array('rel' => ActivityContext::MENTIONED,
+ ActivityContext::OBJECTTYPE => $type, // FIXME: undocumented
+ 'href' => $attnURI));
+ }
+
+ if (!empty($this->context->location)) {
+ $loc = $this->context->location;
+ $xs->element('georss:point', null, $loc->lat . ' ' . $loc->lon);
}
}
if ($this->target) {
- $xs->raw($this->target->asString('activity:target'));
+ $this->target->outputTo($xs, 'activity:target');
}
foreach ($this->categories as $cat) {
- $xs->raw($cat->asString());
+ $cat->outputTo($xs);
}
- $xs->elementEnd('entry');
+ // can be either URLs or enclosure objects
- return $xs->getString();
+ foreach ($this->enclosures as $enclosure) {
+ if (is_string($enclosure)) {
+ $xs->element('link', array('rel' => 'enclosure',
+ 'href' => $enclosure));
+ } else {
+ $attributes = array('rel' => 'enclosure',
+ 'href' => $enclosure->url,
+ 'type' => $enclosure->mimetype,
+ 'length' => $enclosure->size);
+ if ($enclosure->title) {
+ $attributes['title'] = $enclosure->title;
+ }
+ $xs->element('link', $attributes);
+ }
+ }
+
+ // Info on the source feed
+
+ if ($source && !empty($this->source)) {
+ $xs->elementStart('source');
+
+ $xs->element('id', null, $this->source->id);
+ $xs->element('title', null, $this->source->title);
+
+ if (array_key_exists('alternate', $this->source->links)) {
+ $xs->element('link', array('rel' => 'alternate',
+ 'type' => 'text/html',
+ 'href' => $this->source->links['alternate']));
+ }
+
+ if (array_key_exists('self', $this->source->links)) {
+ $xs->element('link', array('rel' => 'self',
+ 'type' => 'application/atom+xml',
+ 'href' => $this->source->links['self']));
+ }
+
+ if (array_key_exists('license', $this->source->links)) {
+ $xs->element('link', array('rel' => 'license',
+ 'href' => $this->source->links['license']));
+ }
+
+ if (!empty($this->source->icon)) {
+ $xs->element('icon', null, $this->source->icon);
+ }
+
+ if (!empty($this->source->updated)) {
+ $xs->element('updated', null, $this->source->updated);
+ }
+
+ $xs->elementEnd('source');
+ }
+
+ if (!empty($this->selfLink)) {
+ $xs->element('link', array('rel' => 'self',
+ 'type' => 'application/atom+xml',
+ 'href' => $this->selfLink));
+ }
+
+ if (!empty($this->editLink)) {
+ $xs->element('link', array('rel' => 'edit',
+ 'type' => 'application/atom+xml',
+ 'href' => $this->editLink));
+ }
+
+ // For throwing in extra elements; used for statusnet:notice_info
+
+ foreach ($this->extra as $el) {
+ list($tag, $attrs, $content) = $el;
+ $xs->element($tag, $attrs, $content);
+ }
+
+ $xs->elementEnd($tag);
+
+ return;
}
private function _child($element, $tag, $namespace=self::SPEC)
return ActivityUtils::child($element, $tag, $namespace);
}
+ /**
+ * For consistency, we'll always output UTC rather than local time.
+ * Note that clients *should* accept any timezone we give them as long
+ * as it's properly formatted.
+ *
+ * @param int $tm Unix timestamp
+ * @return string
+ */
static function iso8601Date($tm)
{
$dateStr = date('d F Y H:i:s', $tm);
$d = new DateTime($dateStr, new DateTimeZone('UTC'));
- $d->setTimezone(new DateTimeZone(common_timezone()));
return $d->format('c');
}
}
projects / quix0rs-gnu-social.git / blobdiff