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);
139 // Low level exception. No need for i18n.
140 throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
144 function _fromAtomEntry($entry, $feed)
146 $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
148 if (!empty($pubEl)) {
149 $this->time = strtotime($pubEl->textContent);
151 // XXX technically an error; being liberal. Good idea...?
152 $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
153 if (!empty($updateEl)) {
154 $this->time = strtotime($updateEl->textContent);
160 $this->link = ActivityUtils::getPermalink($entry);
162 $verbEl = $this->_child($entry, self::VERB);
164 if (!empty($verbEl)) {
165 $this->verb = trim($verbEl->textContent);
167 $this->verb = ActivityVerb::POST;
168 // XXX: do other implied stuff here
171 $objectEls = $entry->getElementsByTagNameNS(self::SPEC, self::OBJECT);
173 if ($objectEls->length > 0) {
174 for ($i = 0; $i < $objectEls->length; $i++) {
175 $objectEl = $objectEls->item($i);
176 $this->objects[] = new ActivityObject($objectEl);
179 $this->objects[] = new ActivityObject($entry);
182 $actorEl = $this->_child($entry, self::ACTOR);
184 if (!empty($actorEl)) {
186 $this->actor = new ActivityObject($actorEl);
188 // Cliqset has bad actor IDs (just nickname of user). We
189 // work around it by getting the author data and using its
192 if (!preg_match('/^\w+:/', $this->actor->id)) {
193 $authorEl = ActivityUtils::child($entry, 'author');
194 if (!empty($authorEl)) {
195 $authorObj = new ActivityObject($authorEl);
196 $this->actor->id = $authorObj->id;
199 } else if (!empty($feed) &&
200 $subjectEl = $this->_child($feed, self::SUBJECT)) {
202 $this->actor = new ActivityObject($subjectEl);
204 } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
206 $this->actor = new ActivityObject($authorEl);
208 } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
211 $this->actor = new ActivityObject($authorEl);
214 $contextEl = $this->_child($entry, self::CONTEXT);
216 if (!empty($contextEl)) {
217 $this->context = new ActivityContext($contextEl);
219 $this->context = new ActivityContext($entry);
222 $targetEl = $this->_child($entry, self::TARGET);
224 if (!empty($targetEl)) {
225 $this->target = new ActivityObject($targetEl);
228 $this->summary = ActivityUtils::childContent($entry, 'summary');
229 $this->id = ActivityUtils::childContent($entry, 'id');
230 $this->content = ActivityUtils::getContent($entry);
232 $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
234 for ($i = 0; $i < $catEls->length; $i++) {
235 $catEl = $catEls->item($i);
236 $this->categories[] = new AtomCategory($catEl);
240 foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
241 $this->enclosures[] = $link->getAttribute('href');
244 // From APP. Might be useful.
246 $this->selfLink = ActivityUtils::getLink($entry, 'self', 'application/atom+xml');
247 $this->editLink = ActivityUtils::getLink($entry, 'edit', 'application/atom+xml');
250 function _fromRssItem($item, $channel)
252 $verbEl = $this->_child($item, self::VERB);
254 if (!empty($verbEl)) {
255 $this->verb = trim($verbEl->textContent);
257 $this->verb = ActivityVerb::POST;
258 // XXX: do other implied stuff here
261 $pubDateEl = $this->_child($item, self::PUBDATE, self::RSS);
263 if (!empty($pubDateEl)) {
264 $this->time = strtotime($pubDateEl->textContent);
267 if ($authorEl = $this->_child($item, self::AUTHOR, self::RSS)) {
268 $this->actor = ActivityObject::fromRssAuthor($authorEl);
269 } else if ($dcCreatorEl = $this->_child($item, self::CREATOR, self::DC)) {
270 $this->actor = ActivityObject::fromDcCreator($dcCreatorEl);
271 } else if ($posterousEl = $this->_child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS)) {
272 // Special case for Posterous.com
273 $this->actor = ActivityObject::fromPosterousAuthor($posterousEl);
274 } else if (!empty($channel)) {
275 $this->actor = ActivityObject::fromRssChannel($channel);
280 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
282 $contentEl = ActivityUtils::child($item, self::ENCODED, self::CONTENTNS);
284 if (!empty($contentEl)) {
285 // <content:encoded> XML node's text content is HTML; no further processing needed.
286 $this->content = $contentEl->textContent;
288 $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
289 if (!empty($descriptionEl)) {
290 // Per spec, <description> must be plaintext.
291 // In practice, often there's HTML... but these days good
292 // feeds are using <content:encoded> which is explicitly
294 // We'll treat this following spec, and do HTML escaping
295 // to convert from plaintext to HTML.
296 $this->content = htmlspecialchars($descriptionEl->textContent);
300 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, self::RSS);
303 // @fixme thumbnails... maybe
305 $guidEl = ActivityUtils::child($item, self::GUID, self::RSS);
307 if (!empty($guidEl)) {
308 $this->id = $guidEl->textContent;
310 if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
312 $this->link = $this->id;
316 $this->objects[] = new ActivityObject($item);
317 $this->context = new ActivityContext($item);
321 * Returns an Atom <entry> based on this activity
323 * @return DOMElement Atom entry
326 function toAtomEntry()
331 function asString($namespace=false, $author=true, $source=false)
333 $xs = new XMLStringer(true);
334 $this->outputTo($xs, $namespace, $author, $source);
335 return $xs->getString();
338 function outputTo($xs, $namespace=false, $author=true, $source=false)
341 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
342 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
343 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
344 'xmlns:georss' => 'http://www.georss.org/georss',
345 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
346 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
347 'xmlns:media' => 'http://purl.org/syndication/atommedia',
348 'xmlns:statusnet' => 'http://status.net/schema/api/1/');
353 $xs->elementStart('entry', $attrs);
355 if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
357 $obj = $this->objects[0];
358 $obj->outputTo($xs, null);
361 $xs->element('id', null, $this->id);
362 $xs->element('title', null, $this->title);
364 $xs->element('content', array('type' => 'html'), $this->content);
366 if (!empty($this->summary)) {
367 $xs->element('summary', null, $this->summary);
370 if (!empty($this->link)) {
371 $xs->element('link', array('rel' => 'alternate',
372 'type' => 'text/html'),
378 $xs->element('activity:verb', null, $this->verb);
380 $published = self::iso8601Date($this->time);
382 $xs->element('published', null, $published);
383 $xs->element('updated', null, $published);
386 $this->actor->outputTo($xs, 'author');
389 if ($this->verb != ActivityVerb::POST || count($this->objects) != 1) {
390 foreach($this->objects as $object) {
391 $object->outputTo($xs, 'activity:object');
395 if (!empty($this->context)) {
397 if (!empty($this->context->replyToID)) {
398 if (!empty($this->context->replyToUrl)) {
399 $xs->element('thr:in-reply-to',
400 array('ref' => $this->context->replyToID,
401 'href' => $this->context->replyToUrl));
403 $xs->element('thr:in-reply-to',
404 array('ref' => $this->context->replyToID));
408 if (!empty($this->context->replyToUrl)) {
409 $xs->element('link', array('rel' => 'related',
410 'href' => $this->context->replyToUrl));
413 if (!empty($this->context->conversation)) {
414 $xs->element('link', array('rel' => 'ostatus:conversation',
415 'href' => $this->context->conversation));
418 foreach ($this->context->attention as $attnURI) {
419 $xs->element('link', array('rel' => 'ostatus:attention',
420 'href' => $attnURI));
421 $xs->element('link', array('rel' => 'mentioned',
422 'href' => $attnURI));
425 // XXX: shoulda used ActivityVerb::SHARE
427 if (!empty($this->context->forwardID)) {
428 if (!empty($this->context->forwardUrl)) {
429 $xs->element('ostatus:forward',
430 array('ref' => $this->context->forwardID,
431 'href' => $this->context->forwardUrl));
433 $xs->element('ostatus:forward',
434 array('ref' => $this->context->forwardID));
438 if (!empty($this->context->location)) {
439 $loc = $this->context->location;
440 $xs->element('georss:point', null, $loc->lat . ' ' . $loc->lon);
445 $this->target->outputTo($xs, 'activity:target');
448 foreach ($this->categories as $cat) {
452 // can be either URLs or enclosure objects
454 foreach ($this->enclosures as $enclosure) {
455 if (is_string($enclosure)) {
456 $xs->element('link', array('rel' => 'enclosure',
457 'href' => $enclosure));
459 $attributes = array('rel' => 'enclosure',
460 'href' => $enclosure->url,
461 'type' => $enclosure->mimetype,
462 'length' => $enclosure->size);
463 if ($enclosure->title) {
464 $attributes['title'] = $enclosure->title;
466 $xs->element('link', $attributes);
470 // Info on the source feed
472 if ($source && !empty($this->source)) {
473 $xs->elementStart('source');
475 $xs->element('id', null, $this->source->id);
476 $xs->element('title', null, $this->source->title);
478 if (array_key_exists('alternate', $this->source->links)) {
479 $xs->element('link', array('rel' => 'alternate',
480 'type' => 'text/html',
481 'href' => $this->source->links['alternate']));
484 if (array_key_exists('self', $this->source->links)) {
485 $xs->element('link', array('rel' => 'self',
486 'type' => 'application/atom+xml',
487 'href' => $this->source->links['self']));
490 if (array_key_exists('license', $this->source->links)) {
491 $xs->element('link', array('rel' => 'license',
492 'href' => $this->source->links['license']));
495 if (!empty($this->source->icon)) {
496 $xs->element('icon', null, $this->source->icon);
499 if (!empty($this->source->updated)) {
500 $xs->element('updated', null, $this->source->updated);
503 $xs->elementEnd('source');
506 if (!empty($this->selfLink)) {
507 $xs->element('link', array('rel' => 'self',
508 'type' => 'application/atom+xml',
509 'href' => $this->selfLink));
512 if (!empty($this->editLink)) {
513 $xs->element('link', array('rel' => 'edit',
514 'type' => 'application/atom+xml',
515 'href' => $this->editLink));
518 // For throwing in extra elements; used for statusnet:notice_info
520 foreach ($this->extra as $el) {
521 list($tag, $attrs, $content) = $el;
522 $xs->element($tag, $attrs, $content);
525 $xs->elementEnd('entry');
530 private function _child($element, $tag, $namespace=self::SPEC)
532 return ActivityUtils::child($element, $tag, $namespace);
535 static function iso8601Date($tm)
537 $dateStr = date('d F Y H:i:s', $tm);
538 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
539 $d->setTimezone(new DateTimeZone(common_timezone()));
540 return $d->format('c');