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 // get immediate object children
176 $objectEls = ActivityUtils::children($entry, self::OBJECT, self::SPEC);
178 if (count($objectEls) > 0) {
179 foreach ($objectEls as $objectEl) {
180 // Special case for embedded activities
181 $objectType = ActivityUtils::childContent($objectEl, self::OBJECTTYPE, self::SPEC);
182 if (!empty($objectType) && $objectType == ActivityObject::ACTIVITY) {
183 $this->objects[] = new Activity($objectEl);
185 $this->objects[] = new ActivityObject($objectEl);
190 $this->objects[] = new ActivityObject($entry);
193 $actorEl = $this->_child($entry, self::ACTOR);
195 if (!empty($actorEl)) {
196 // Standalone <activity:actor> elements are a holdover from older
197 // versions of ActivityStreams. Newer feeds should have this data
198 // integrated straight into <atom:author>.
200 $this->actor = new ActivityObject($actorEl);
202 // Cliqset has bad actor IDs (just nickname of user). We
203 // work around it by getting the author data and using its
206 if (!preg_match('/^\w+:/', $this->actor->id)) {
207 $authorEl = ActivityUtils::child($entry, 'author');
208 if (!empty($authorEl)) {
209 $authorObj = new ActivityObject($authorEl);
210 $this->actor->id = $authorObj->id;
213 } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
215 // An <atom:author> in the entry overrides any author info on
216 // the surrounding feed.
217 $this->actor = new ActivityObject($authorEl);
219 } else if (!empty($feed) &&
220 $subjectEl = $this->_child($feed, self::SUBJECT)) {
222 // Feed subject is used for things like groups.
223 // Should actually possibly not be interpreted as an actor...?
224 $this->actor = new ActivityObject($subjectEl);
226 } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
229 // If there's no <atom:author> on the entry, it's safe to assume
230 // the containing feed's authorship info applies.
231 $this->actor = new ActivityObject($authorEl);
234 $contextEl = $this->_child($entry, self::CONTEXT);
236 if (!empty($contextEl)) {
237 $this->context = new ActivityContext($contextEl);
239 $this->context = new ActivityContext($entry);
242 $targetEl = $this->_child($entry, self::TARGET);
244 if (!empty($targetEl)) {
245 $this->target = new ActivityObject($targetEl);
248 $this->summary = ActivityUtils::childContent($entry, 'summary');
249 $this->id = ActivityUtils::childContent($entry, 'id');
250 $this->content = ActivityUtils::getContent($entry);
252 $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
254 for ($i = 0; $i < $catEls->length; $i++) {
255 $catEl = $catEls->item($i);
256 $this->categories[] = new AtomCategory($catEl);
260 foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
261 $this->enclosures[] = $link->getAttribute('href');
264 // From APP. Might be useful.
266 $this->selfLink = ActivityUtils::getLink($entry, 'self', 'application/atom+xml');
267 $this->editLink = ActivityUtils::getLink($entry, 'edit', 'application/atom+xml');
270 function _fromRssItem($item, $channel)
272 $verbEl = $this->_child($item, self::VERB);
274 if (!empty($verbEl)) {
275 $this->verb = trim($verbEl->textContent);
277 $this->verb = ActivityVerb::POST;
278 // XXX: do other implied stuff here
281 $pubDateEl = $this->_child($item, self::PUBDATE, self::RSS);
283 if (!empty($pubDateEl)) {
284 $this->time = strtotime($pubDateEl->textContent);
287 if ($authorEl = $this->_child($item, self::AUTHOR, self::RSS)) {
288 $this->actor = ActivityObject::fromRssAuthor($authorEl);
289 } else if ($dcCreatorEl = $this->_child($item, self::CREATOR, self::DC)) {
290 $this->actor = ActivityObject::fromDcCreator($dcCreatorEl);
291 } else if ($posterousEl = $this->_child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS)) {
292 // Special case for Posterous.com
293 $this->actor = ActivityObject::fromPosterousAuthor($posterousEl);
294 } else if (!empty($channel)) {
295 $this->actor = ActivityObject::fromRssChannel($channel);
300 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
302 $contentEl = ActivityUtils::child($item, self::ENCODED, self::CONTENTNS);
304 if (!empty($contentEl)) {
305 // <content:encoded> XML node's text content is HTML; no further processing needed.
306 $this->content = $contentEl->textContent;
308 $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
309 if (!empty($descriptionEl)) {
310 // Per spec, <description> must be plaintext.
311 // In practice, often there's HTML... but these days good
312 // feeds are using <content:encoded> which is explicitly
314 // We'll treat this following spec, and do HTML escaping
315 // to convert from plaintext to HTML.
316 $this->content = htmlspecialchars($descriptionEl->textContent);
320 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, self::RSS);
323 // @fixme thumbnails... maybe
325 $guidEl = ActivityUtils::child($item, self::GUID, self::RSS);
327 if (!empty($guidEl)) {
328 $this->id = $guidEl->textContent;
330 if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
332 $this->link = $this->id;
336 $this->objects[] = new ActivityObject($item);
337 $this->context = new ActivityContext($item);
341 * Returns an Atom <entry> based on this activity
343 * @return DOMElement Atom entry
346 function toAtomEntry()
352 * Returns an array based on this activity suitable
353 * for encoding as a JSON object
355 * @return array $activity
363 $activity['actor'] = $this->actor->asArray();
366 $activity['content'] = $this->content;
368 // generator <-- We could use this when we know a notice is created
369 // locally. Or if we know the upstream Generator.
371 // icon <-- possibly a mini object representing verb?
374 $activity['id'] = $this->id;
377 if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
378 $activity['object'] = $this->objects[0]->asArray();
380 // Context stuff. For now I'm just sticking most of it
381 // in a property called "context"
383 if (!empty($this->context)) {
385 if (!empty($this->context->location)) {
386 $loc = $this->context->location;
390 $activity['geopoint'] = array(
392 'coordinates' => array($loc->lat, $loc->lon),
393 'deprecated' => true,
396 $activity['location'] = array(
397 'objectType' => 'place',
398 'position' => sprintf("%+02.5F%+03.5F/", $loc->lat, $loc->lon),
403 $name = $loc->getName();
406 $activity['location']['displayName'] = $name;
409 $url = $loc->getURL();
412 $activity['location']['url'] = $url;
416 $activity['to'] = $this->context->getToArray();
417 $activity['context'] = $this->context->asArray();
420 // Instead of adding enclosures as an extension to JSON
421 // Activities, it seems like we should be using the
422 // attachements property of ActivityObject
424 $attachments = array();
426 // XXX: OK, this is kinda cheating. We should probably figure out
427 // what kind of objects these are based on mime-type and then
428 // create specific object types. Right now this rely on
429 // duck-typing. Also, we should include an embed code for
430 // video attachments.
432 foreach ($this->enclosures as $enclosure) {
434 if (is_string($enclosure)) {
436 $attachments[]['id'] = $enclosure;
440 $attachments[]['id'] = $enclosure->url;
442 $mediaLink = new ActivityStreamsMediaLink(
447 // XXX: Add 'size' as an extension to MediaLink?
450 $attachments[]['mediaLink'] = $mediaLink->asArray(); // extension
452 if ($enclosure->title) {
453 $attachments[]['displayName'] = $enclosure->title;
458 if (!empty($attachments)) {
459 $activity['object']['attachments'] = $attachments;
463 $activity['object'] = array();
464 foreach($this->objects as $object) {
465 $oa = $object->asArray();
466 if ($object instanceof Activity) {
469 $oa['objectType'] = 'activity';
471 $activity['object'][] = $oa;
476 $activity['published'] = self::iso8601Date($this->time);
480 'objectType' => 'service',
481 'displayName' => common_config('site', 'name'),
482 'url' => common_root_url()
485 $activity['provider'] = $provider;
488 if (!empty($this->target)) {
489 $activity['target'] = $this->target->asArray();
493 $activity['title'] = $this->title;
495 // updated <-- Optional. Should we use this to indicate the time we r
496 // eceived a remote notice? Probably not.
500 // We can probably use the whole schema URL here but probably the
501 // relative simple name is easier to parse
502 $activity['verb'] = substr($this->verb, strrpos($this->verb, '/') + 1);
505 $activity['url'] = $this->id;
507 /* Purely extensions hereafter */
509 if ($activity['verb'] == 'post') {
511 foreach ($this->categories as $cat) {
512 if (mb_strlen($cat->term) > 0) {
513 // Couldn't figure out which object type to use, so...
514 $tags[] = array('objectType' => 'http://activityschema.org/object/hashtag',
515 'displayName' => $cat->term);
518 if (count($tags) > 0) {
519 $activity['object']['tags'] = $tags;
523 // XXX: a bit of a hack... Since JSON isn't namespaced we probably
524 // shouldn't be using 'statusnet:notice_info', but this will work
527 foreach ($this->extra as $e) {
528 list($objectName, $props, $txt) = $e;
529 if (!empty($objectName)) {
530 $activity[$objectName] = $props;
534 return array_filter($activity);
537 function asString($namespace=false, $author=true, $source=false)
539 $xs = new XMLStringer(true);
540 $this->outputTo($xs, $namespace, $author, $source);
541 return $xs->getString();
544 function outputTo($xs, $namespace=false, $author=true, $source=false, $tag='entry')
547 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
548 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
549 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
550 'xmlns:georss' => 'http://www.georss.org/georss',
551 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
552 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
553 'xmlns:media' => 'http://purl.org/syndication/atommedia',
554 'xmlns:statusnet' => 'http://status.net/schema/api/1/');
559 $xs->elementStart($tag, $attrs);
561 if ($tag != 'entry') {
562 $xs->element('activity:object-type', null, ActivityObject::ACTIVITY);
565 if ($this->verb == ActivityVerb::POST && count($this->objects) == 1 && $tag == 'entry') {
567 $obj = $this->objects[0];
568 $obj->outputTo($xs, null);
571 $xs->element('id', null, $this->id);
572 $xs->element('title', null, $this->title);
574 $xs->element('content', array('type' => 'html'), $this->content);
576 if (!empty($this->summary)) {
577 $xs->element('summary', null, $this->summary);
580 if (!empty($this->link)) {
581 $xs->element('link', array('rel' => 'alternate',
582 'type' => 'text/html'),
588 $xs->element('activity:verb', null, $this->verb);
590 $published = self::iso8601Date($this->time);
592 $xs->element('published', null, $published);
593 $xs->element('updated', null, $published);
596 $this->actor->outputTo($xs, 'author');
599 if ($this->verb != ActivityVerb::POST || count($this->objects) != 1 || $tag != 'entry') {
600 foreach($this->objects as $object) {
601 if ($object instanceof Activity) {
602 $object->outputTo($xs, false, true, true, 'activity:object');
604 $object->outputTo($xs, 'activity:object');
609 if (!empty($this->context)) {
611 if (!empty($this->context->replyToID)) {
612 if (!empty($this->context->replyToUrl)) {
613 $xs->element('thr:in-reply-to',
614 array('ref' => $this->context->replyToID,
615 'href' => $this->context->replyToUrl));
617 $xs->element('thr:in-reply-to',
618 array('ref' => $this->context->replyToID));
622 if (!empty($this->context->replyToUrl)) {
623 $xs->element('link', array('rel' => 'related',
624 'href' => $this->context->replyToUrl));
627 if (!empty($this->context->conversation)) {
628 $xs->element('link', array('rel' => 'ostatus:conversation',
629 'href' => $this->context->conversation));
632 foreach ($this->context->attention as $attnURI) {
633 $xs->element('link', array('rel' => 'ostatus:attention',
634 'href' => $attnURI));
635 $xs->element('link', array('rel' => 'mentioned',
636 'href' => $attnURI));
639 // XXX: shoulda used ActivityVerb::SHARE
641 if (!empty($this->context->forwardID)) {
642 if (!empty($this->context->forwardUrl)) {
643 $xs->element('ostatus:forward',
644 array('ref' => $this->context->forwardID,
645 'href' => $this->context->forwardUrl));
647 $xs->element('ostatus:forward',
648 array('ref' => $this->context->forwardID));
652 if (!empty($this->context->location)) {
653 $loc = $this->context->location;
654 $xs->element('georss:point', null, $loc->lat . ' ' . $loc->lon);
659 $this->target->outputTo($xs, 'activity:target');
662 foreach ($this->categories as $cat) {
666 // can be either URLs or enclosure objects
668 foreach ($this->enclosures as $enclosure) {
669 if (is_string($enclosure)) {
670 $xs->element('link', array('rel' => 'enclosure',
671 'href' => $enclosure));
673 $attributes = array('rel' => 'enclosure',
674 'href' => $enclosure->url,
675 'type' => $enclosure->mimetype,
676 'length' => $enclosure->size);
677 if ($enclosure->title) {
678 $attributes['title'] = $enclosure->title;
680 $xs->element('link', $attributes);
684 // Info on the source feed
686 if ($source && !empty($this->source)) {
687 $xs->elementStart('source');
689 $xs->element('id', null, $this->source->id);
690 $xs->element('title', null, $this->source->title);
692 if (array_key_exists('alternate', $this->source->links)) {
693 $xs->element('link', array('rel' => 'alternate',
694 'type' => 'text/html',
695 'href' => $this->source->links['alternate']));
698 if (array_key_exists('self', $this->source->links)) {
699 $xs->element('link', array('rel' => 'self',
700 'type' => 'application/atom+xml',
701 'href' => $this->source->links['self']));
704 if (array_key_exists('license', $this->source->links)) {
705 $xs->element('link', array('rel' => 'license',
706 'href' => $this->source->links['license']));
709 if (!empty($this->source->icon)) {
710 $xs->element('icon', null, $this->source->icon);
713 if (!empty($this->source->updated)) {
714 $xs->element('updated', null, $this->source->updated);
717 $xs->elementEnd('source');
720 if (!empty($this->selfLink)) {
721 $xs->element('link', array('rel' => 'self',
722 'type' => 'application/atom+xml',
723 'href' => $this->selfLink));
726 if (!empty($this->editLink)) {
727 $xs->element('link', array('rel' => 'edit',
728 'type' => 'application/atom+xml',
729 'href' => $this->editLink));
732 // For throwing in extra elements; used for statusnet:notice_info
734 foreach ($this->extra as $el) {
735 list($tag, $attrs, $content) = $el;
736 $xs->element($tag, $attrs, $content);
739 $xs->elementEnd($tag);
744 private function _child($element, $tag, $namespace=self::SPEC)
746 return ActivityUtils::child($element, $tag, $namespace);
750 * For consistency, we'll always output UTC rather than local time.
751 * Note that clients *should* accept any timezone we give them as long
752 * as it's properly formatted.
754 * @param int $tm Unix timestamp
757 static function iso8601Date($tm)
759 $dateStr = date('d F Y H:i:s', $tm);
760 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
761 return $d->format('c');