3 * StatusNet, the distributed open-source microblogging tool
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * An activity in the ActivityStrea.ms world
38 * An activity is kind of like a sentence: someone did something
41 * 'someone' is the 'actor'; 'did something' is the verb;
42 * 'something else' is the object.
46 * @author Evan Prodromou <evan@status.net>
47 * @copyright 2010 StatusNet, Inc.
48 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
49 * @link http://status.net/
53 const SPEC = 'http://activitystrea.ms/spec/1.0/';
54 const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
55 const MEDIA = 'http://purl.org/syndication/atommedia';
58 const OBJECT = 'object';
59 const ACTOR = 'actor';
60 const SUBJECT = 'subject';
61 const OBJECTTYPE = 'object-type';
62 const CONTEXT = 'context';
63 const TARGET = 'target';
65 const ATOM = 'http://www.w3.org/2005/Atom';
67 const AUTHOR = 'author';
68 const PUBLISHED = 'published';
69 const UPDATED = 'updated';
71 const RSS = null; // no namespace!
73 const PUBDATE = 'pubDate';
74 const DESCRIPTION = 'description';
77 const IMAGE = 'image';
80 const DC = 'http://purl.org/dc/elements/1.1/';
82 const CREATOR = 'creator';
84 const CONTENTNS = 'http://purl.org/rss/1.0/modules/content/';
85 const ENCODED = 'encoded';
87 public $actor; // an ActivityObject
88 public $verb; // a string (the URL)
89 public $objects = array(); // an array of ActivityObjects
90 public $target; // an ActivityObject
91 public $context; // an ActivityObject
92 public $time; // Time of the activity
93 public $link; // an ActivityObject
94 public $entry; // the source entry
95 public $feed; // the source feed
97 public $summary; // summary of activity
98 public $content; // HTML content of activity
99 public $id; // ID of the activity
100 public $title; // title of the activity
101 public $categories = array(); // list of AtomCategory objects
102 public $enclosures = array(); // list of enclosure URL references
104 public $extra = array(); // extra elements as array(tag, attrs, content)
105 public $source; // ActivitySource object representing 'home feed'
106 public $selfLink; // <link rel='self' type='application/atom+xml'>
107 public $editLink; // <link rel='edit' type='application/atom+xml'>
110 * Turns a regular old Atom <entry> into a magical activity
112 * @param DOMElement $entry Atom entry to poke at
113 * @param DOMElement $feed Atom feed, for context
115 function __construct($entry = null, $feed = null)
117 if (is_null($entry)) {
121 // Insist on a feed's root DOMElement; don't allow a DOMDocument
122 if ($feed instanceof DOMDocument) {
123 throw new ClientException(
124 // TRANS: Client exception thrown when a feed instance is a DOMDocument.
125 _('Expecting a root feed element but got a whole XML document.')
129 $this->entry = $entry;
132 if ($entry->namespaceURI == Activity::ATOM &&
133 $entry->localName == 'entry') {
134 $this->_fromAtomEntry($entry, $feed);
135 } else if ($entry->namespaceURI == Activity::RSS &&
136 $entry->localName == 'item') {
137 $this->_fromRssItem($entry, $feed);
138 } else if ($entry->namespaceURI == Activity::SPEC &&
139 $entry->localName == 'object') {
140 $this->_fromAtomEntry($entry, $feed);
142 // Low level exception. No need for i18n.
143 throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
147 function _fromAtomEntry($entry, $feed)
149 $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
151 if (!empty($pubEl)) {
152 $this->time = strtotime($pubEl->textContent);
154 // XXX technically an error; being liberal. Good idea...?
155 $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
156 if (!empty($updateEl)) {
157 $this->time = strtotime($updateEl->textContent);
163 $this->link = ActivityUtils::getPermalink($entry);
165 $verbEl = $this->_child($entry, self::VERB);
167 if (!empty($verbEl)) {
168 $this->verb = trim($verbEl->textContent);
170 $this->verb = ActivityVerb::POST;
171 // XXX: do other implied stuff here
174 $objectEls = $entry->getElementsByTagNameNS(self::SPEC, self::OBJECT);
176 if ($objectEls->length > 0) {
177 for ($i = 0; $i < $objectEls->length; $i++) {
178 $objectEl = $objectEls->item($i);
179 // Only immediate children (don't slurp embedded activities' objects!)
180 if ($objectEl->parentNode != $entry) {
183 // Special case for embedded activities
184 $objectType = ActivityUtils::childContent($objectEl, self::OBJECTTYPE, self::SPEC);
185 if (!empty($objectType) && $objectType == ActivityObject::ACTIVITY) {
186 $this->objects[] = new Activity($objectEl);
188 $this->objects[] = new ActivityObject($objectEl);
193 $this->objects[] = new ActivityObject($entry);
196 $actorEl = $this->_child($entry, self::ACTOR);
198 if (!empty($actorEl)) {
199 // Standalone <activity:actor> elements are a holdover from older
200 // versions of ActivityStreams. Newer feeds should have this data
201 // integrated straight into <atom:author>.
203 $this->actor = new ActivityObject($actorEl);
205 // Cliqset has bad actor IDs (just nickname of user). We
206 // work around it by getting the author data and using its
209 if (!preg_match('/^\w+:/', $this->actor->id)) {
210 $authorEl = ActivityUtils::child($entry, 'author');
211 if (!empty($authorEl)) {
212 $authorObj = new ActivityObject($authorEl);
213 $this->actor->id = $authorObj->id;
216 } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
218 // An <atom:author> in the entry overrides any author info on
219 // the surrounding feed.
220 $this->actor = new ActivityObject($authorEl);
222 } else if (!empty($feed) &&
223 $subjectEl = $this->_child($feed, self::SUBJECT)) {
225 // Feed subject is used for things like groups.
226 // Should actually possibly not be interpreted as an actor...?
227 $this->actor = new ActivityObject($subjectEl);
229 } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
232 // If there's no <atom:author> on the entry, it's safe to assume
233 // the containing feed's authorship info applies.
234 $this->actor = new ActivityObject($authorEl);
237 $contextEl = $this->_child($entry, self::CONTEXT);
239 if (!empty($contextEl)) {
240 $this->context = new ActivityContext($contextEl);
242 $this->context = new ActivityContext($entry);
245 $targetEl = $this->_child($entry, self::TARGET);
247 if (!empty($targetEl)) {
248 $this->target = new ActivityObject($targetEl);
251 $this->summary = ActivityUtils::childContent($entry, 'summary');
252 $this->id = ActivityUtils::childContent($entry, 'id');
253 $this->content = ActivityUtils::getContent($entry);
255 $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
257 for ($i = 0; $i < $catEls->length; $i++) {
258 $catEl = $catEls->item($i);
259 $this->categories[] = new AtomCategory($catEl);
263 foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
264 $this->enclosures[] = $link->getAttribute('href');
267 // From APP. Might be useful.
269 $this->selfLink = ActivityUtils::getLink($entry, 'self', 'application/atom+xml');
270 $this->editLink = ActivityUtils::getLink($entry, 'edit', 'application/atom+xml');
273 function _fromRssItem($item, $channel)
275 $verbEl = $this->_child($item, self::VERB);
277 if (!empty($verbEl)) {
278 $this->verb = trim($verbEl->textContent);
280 $this->verb = ActivityVerb::POST;
281 // XXX: do other implied stuff here
284 $pubDateEl = $this->_child($item, self::PUBDATE, self::RSS);
286 if (!empty($pubDateEl)) {
287 $this->time = strtotime($pubDateEl->textContent);
290 if ($authorEl = $this->_child($item, self::AUTHOR, self::RSS)) {
291 $this->actor = ActivityObject::fromRssAuthor($authorEl);
292 } else if ($dcCreatorEl = $this->_child($item, self::CREATOR, self::DC)) {
293 $this->actor = ActivityObject::fromDcCreator($dcCreatorEl);
294 } else if ($posterousEl = $this->_child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS)) {
295 // Special case for Posterous.com
296 $this->actor = ActivityObject::fromPosterousAuthor($posterousEl);
297 } else if (!empty($channel)) {
298 $this->actor = ActivityObject::fromRssChannel($channel);
303 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
305 $contentEl = ActivityUtils::child($item, self::ENCODED, self::CONTENTNS);
307 if (!empty($contentEl)) {
308 // <content:encoded> XML node's text content is HTML; no further processing needed.
309 $this->content = $contentEl->textContent;
311 $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
312 if (!empty($descriptionEl)) {
313 // Per spec, <description> must be plaintext.
314 // In practice, often there's HTML... but these days good
315 // feeds are using <content:encoded> which is explicitly
317 // We'll treat this following spec, and do HTML escaping
318 // to convert from plaintext to HTML.
319 $this->content = htmlspecialchars($descriptionEl->textContent);
323 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, self::RSS);
326 // @fixme thumbnails... maybe
328 $guidEl = ActivityUtils::child($item, self::GUID, self::RSS);
330 if (!empty($guidEl)) {
331 $this->id = $guidEl->textContent;
333 if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
335 $this->link = $this->id;
339 $this->objects[] = new ActivityObject($item);
340 $this->context = new ActivityContext($item);
344 * Returns an Atom <entry> based on this activity
346 * @return DOMElement Atom entry
349 function toAtomEntry()
355 * Returns an array based on this activity suitable
356 * for encoding as a JSON object
358 * @return array $activity
366 $activity['actor'] = $this->actor->asArray();
369 $activity['body'] = $this->content;
371 // generator <-- We could use this when we know a notice is created
372 // locally. Or if we know the upstream Generator.
374 // icon <-- I've decided to use the posting user's stream avatar here
375 // for now (also included in the avatarLinks extension)
379 if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
380 $activity['object'] = $this->objects[0]->asArray();
382 // Context stuff. For now I'm just sticking most of it
383 // in a property called "context"
385 if (!empty($this->context)) {
387 if (!empty($this->context->location)) {
388 $loc = $this->context->location;
392 $activity['geopoint'] = array(
394 'coordinates' => array($loc->lat, $loc->lon)
399 $activity['to'] = $this->context->getToArray();
400 $activity['context'] = $this->context->asArray();
403 // Instead of adding enclosures as an extension to JSON
404 // Activities, it seems like we should be using the
405 // attachedObjects property of ActivityObject
407 $attachedObjects = array();
409 // XXX: OK, this is kinda cheating. We should probably figure out
410 // what kind of objects these are based on mime-type and then
411 // create specific object types. Right now this rely on
412 // duck-typing. Also, we should include an embed code for
413 // video attachments.
415 foreach ($this->enclosures as $enclosure) {
417 if (is_string($enclosure)) {
419 $attachedObjects[]['id'] = $enclosure;
423 $attachedObjects[]['id'] = $enclosure->url;
425 $mediaLink = new ActivityStreamsMediaLink(
430 // XXX: Add 'size' as an extension to MediaLink?
433 $attachedObjects[]['mediaLink'] = $mediaLink->asArray(); // extension
435 if ($enclosure->title) {
436 $attachedObjects[]['displayName'] = $enclosure->title;
441 if (!empty($attachedObjects)) {
442 $activity['object']['attachedObjects'] = $attachedObjects;
446 $activity['object'] = array();
447 foreach($this->objects as $object) {
448 $oa = $object->asArray();
449 if ($object instanceof Activity) {
452 $oa['objectType'] = 'activity';
454 $activity['object'][] = $oa;
458 $activity['postedTime'] = self::iso8601Date($this->time); // Change to exactly be RFC3339?
462 'objectType' => 'service',
463 'displayName' => common_config('site', 'name'),
464 'url' => common_root_url()
467 $activity['provider'] = $provider;
470 if (!empty($this->target)) {
471 $activity['target'] = $this->target->asArray();
475 $activity['title'] = $this->title;
477 // updatedTime <-- Should we use this to indicate the time we received
478 // a remote notice? Probably not.
482 // We can probably use the whole schema URL here but probably the
483 // relative simple name is easier to parse
484 $activity['verb'] = substr($this->verb, strrpos($this->verb, '/') + 1);
486 /* Purely extensions hereafter */
490 // Use an Activity Object for term? Which object? Note?
491 foreach ($this->categories as $cat) {
492 $tags[] = $cat->term;
495 $activity['tags'] = $tags;
497 // XXX: a bit of a hack... Since JSON isn't namespaced we probably
498 // shouldn't be using 'statusnet:notice_info', but this will work
501 foreach ($this->extra as $e) {
502 list($objectName, $props, $txt) = $e;
503 if (!empty($objectName)) {
504 $activity[$objectName] = $props;
508 return array_filter($activity);
511 function asString($namespace=false, $author=true, $source=false)
513 $xs = new XMLStringer(true);
514 $this->outputTo($xs, $namespace, $author, $source);
515 return $xs->getString();
518 function outputTo($xs, $namespace=false, $author=true, $source=false, $tag='entry')
521 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
522 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
523 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
524 'xmlns:georss' => 'http://www.georss.org/georss',
525 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
526 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
527 'xmlns:media' => 'http://purl.org/syndication/atommedia',
528 'xmlns:statusnet' => 'http://status.net/schema/api/1/');
533 $xs->elementStart($tag, $attrs);
535 if ($tag != 'entry') {
536 $xs->element('activity:object-type', null, ActivityObject::ACTIVITY);
539 if ($this->verb == ActivityVerb::POST && count($this->objects) == 1 && $tag == 'entry') {
541 $obj = $this->objects[0];
542 $obj->outputTo($xs, null);
545 $xs->element('id', null, $this->id);
546 $xs->element('title', null, $this->title);
548 $xs->element('content', array('type' => 'html'), $this->content);
550 if (!empty($this->summary)) {
551 $xs->element('summary', null, $this->summary);
554 if (!empty($this->link)) {
555 $xs->element('link', array('rel' => 'alternate',
556 'type' => 'text/html'),
562 $xs->element('activity:verb', null, $this->verb);
564 $published = self::iso8601Date($this->time);
566 $xs->element('published', null, $published);
567 $xs->element('updated', null, $published);
570 $this->actor->outputTo($xs, 'author');
572 // XXX: Remove <activity:actor> ASAP! Author information
573 // has been moved to the author element in the Activity
574 // Streams spec. We're outputting actor only for backward
575 // compatibility with clients that can only parse
576 // activities based on older versions of the spec.
578 $depMsg = 'Deprecation warning: activity:actor is present '
579 . 'only for backward compatibility. It will be '
580 . 'removed in the next version of StatusNet.';
581 $xs->comment($depMsg);
582 $this->actor->outputTo($xs, 'activity:actor');
585 if ($this->verb != ActivityVerb::POST || count($this->objects) != 1 || $tag != 'entry') {
586 foreach($this->objects as $object) {
587 if ($object instanceof Activity) {
588 $object->outputTo($xs, false, true, true, 'activity:object');
590 $object->outputTo($xs, 'activity:object');
595 if (!empty($this->context)) {
597 if (!empty($this->context->replyToID)) {
598 if (!empty($this->context->replyToUrl)) {
599 $xs->element('thr:in-reply-to',
600 array('ref' => $this->context->replyToID,
601 'href' => $this->context->replyToUrl));
603 $xs->element('thr:in-reply-to',
604 array('ref' => $this->context->replyToID));
608 if (!empty($this->context->replyToUrl)) {
609 $xs->element('link', array('rel' => 'related',
610 'href' => $this->context->replyToUrl));
613 if (!empty($this->context->conversation)) {
614 $xs->element('link', array('rel' => 'ostatus:conversation',
615 'href' => $this->context->conversation));
618 foreach ($this->context->attention as $attnURI) {
619 $xs->element('link', array('rel' => 'ostatus:attention',
620 'href' => $attnURI));
621 $xs->element('link', array('rel' => 'mentioned',
622 'href' => $attnURI));
625 // XXX: shoulda used ActivityVerb::SHARE
627 if (!empty($this->context->forwardID)) {
628 if (!empty($this->context->forwardUrl)) {
629 $xs->element('ostatus:forward',
630 array('ref' => $this->context->forwardID,
631 'href' => $this->context->forwardUrl));
633 $xs->element('ostatus:forward',
634 array('ref' => $this->context->forwardID));
638 if (!empty($this->context->location)) {
639 $loc = $this->context->location;
640 $xs->element('georss:point', null, $loc->lat . ' ' . $loc->lon);
645 $this->target->outputTo($xs, 'activity:target');
648 foreach ($this->categories as $cat) {
652 // can be either URLs or enclosure objects
654 foreach ($this->enclosures as $enclosure) {
655 if (is_string($enclosure)) {
656 $xs->element('link', array('rel' => 'enclosure',
657 'href' => $enclosure));
659 $attributes = array('rel' => 'enclosure',
660 'href' => $enclosure->url,
661 'type' => $enclosure->mimetype,
662 'length' => $enclosure->size);
663 if ($enclosure->title) {
664 $attributes['title'] = $enclosure->title;
666 $xs->element('link', $attributes);
670 // Info on the source feed
672 if ($source && !empty($this->source)) {
673 $xs->elementStart('source');
675 $xs->element('id', null, $this->source->id);
676 $xs->element('title', null, $this->source->title);
678 if (array_key_exists('alternate', $this->source->links)) {
679 $xs->element('link', array('rel' => 'alternate',
680 'type' => 'text/html',
681 'href' => $this->source->links['alternate']));
684 if (array_key_exists('self', $this->source->links)) {
685 $xs->element('link', array('rel' => 'self',
686 'type' => 'application/atom+xml',
687 'href' => $this->source->links['self']));
690 if (array_key_exists('license', $this->source->links)) {
691 $xs->element('link', array('rel' => 'license',
692 'href' => $this->source->links['license']));
695 if (!empty($this->source->icon)) {
696 $xs->element('icon', null, $this->source->icon);
699 if (!empty($this->source->updated)) {
700 $xs->element('updated', null, $this->source->updated);
703 $xs->elementEnd('source');
706 if (!empty($this->selfLink)) {
707 $xs->element('link', array('rel' => 'self',
708 'type' => 'application/atom+xml',
709 'href' => $this->selfLink));
712 if (!empty($this->editLink)) {
713 $xs->element('link', array('rel' => 'edit',
714 'type' => 'application/atom+xml',
715 'href' => $this->editLink));
718 // For throwing in extra elements; used for statusnet:notice_info
720 foreach ($this->extra as $el) {
721 list($tag, $attrs, $content) = $el;
722 $xs->element($tag, $attrs, $content);
725 $xs->elementEnd($tag);
730 private function _child($element, $tag, $namespace=self::SPEC)
732 return ActivityUtils::child($element, $tag, $namespace);
736 * For consistency, we'll always output UTC rather than local time.
737 * Note that clients *should* accept any timezone we give them as long
738 * as it's properly formatted.
740 * @param int $tm Unix timestamp
743 static function iso8601Date($tm)
745 $dateStr = date('d F Y H:i:s', $tm);
746 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
747 return $d->format('c');