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/
54 const SPEC = 'http://activitystrea.ms/spec/1.0/';
55 const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
56 const MEDIA = 'http://purl.org/syndication/atommedia';
59 const OBJECT = 'object';
60 const ACTOR = 'actor';
61 const SUBJECT = 'subject';
62 const OBJECTTYPE = 'object-type';
63 const CONTEXT = 'context';
64 const TARGET = 'target';
66 const ATOM = 'http://www.w3.org/2005/Atom';
68 const AUTHOR = 'author';
69 const PUBLISHED = 'published';
70 const UPDATED = 'updated';
72 const RSS = null; // no namespace!
74 const PUBDATE = 'pubDate';
75 const DESCRIPTION = 'description';
78 const IMAGE = 'image';
81 const DC = 'http://purl.org/dc/elements/1.1/';
83 const CREATOR = 'creator';
85 const CONTENTNS = 'http://purl.org/rss/1.0/modules/content/';
86 const ENCODED = 'encoded';
88 public $actor; // an ActivityObject
89 public $verb; // a string (the URL)
90 public $objects = array(); // an array of ActivityObjects
91 public $target; // an ActivityObject
92 public $context; // an ActivityObject
93 public $time; // Time of the activity
94 public $link; // an ActivityObject
95 public $entry; // the source entry
96 public $feed; // the source feed
98 public $summary; // summary of activity
99 public $content; // HTML content of activity
100 public $id; // ID of the activity
101 public $title; // title of the activity
102 public $categories = array(); // list of AtomCategory objects
103 public $enclosures = array(); // list of enclosure URL references
106 * Turns a regular old Atom <entry> into a magical activity
108 * @param DOMElement $entry Atom entry to poke at
109 * @param DOMElement $feed Atom feed, for context
112 function __construct($entry = null, $feed = null)
114 if (is_null($entry)) {
118 // Insist on a feed's root DOMElement; don't allow a DOMDocument
119 if ($feed instanceof DOMDocument) {
120 throw new ClientException(
121 _("Expecting a root feed element but got a whole XML document.")
125 $this->entry = $entry;
128 if ($entry->namespaceURI == Activity::ATOM &&
129 $entry->localName == 'entry') {
130 $this->_fromAtomEntry($entry, $feed);
131 } else if ($entry->namespaceURI == Activity::RSS &&
132 $entry->localName == 'item') {
133 $this->_fromRssItem($entry, $feed);
135 throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
139 function _fromAtomEntry($entry, $feed)
141 $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
143 if (!empty($pubEl)) {
144 $this->time = strtotime($pubEl->textContent);
146 // XXX technically an error; being liberal. Good idea...?
147 $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
148 if (!empty($updateEl)) {
149 $this->time = strtotime($updateEl->textContent);
155 $this->link = ActivityUtils::getPermalink($entry);
157 $verbEl = $this->_child($entry, self::VERB);
159 if (!empty($verbEl)) {
160 $this->verb = trim($verbEl->textContent);
162 $this->verb = ActivityVerb::POST;
163 // XXX: do other implied stuff here
166 $objectEls = $entry->getElementsByTagNameNS(self::SPEC, self::OBJECT);
168 if ($objectEls->length > 0) {
169 for ($i = 0; $i < $objectEls->length; $i++) {
170 $objectEl = $objectEls->item($i);
171 $this->objects[] = new ActivityObject($objectEl);
174 $this->objects[] = new ActivityObject($entry);
177 $actorEl = $this->_child($entry, self::ACTOR);
179 if (!empty($actorEl)) {
181 $this->actor = new ActivityObject($actorEl);
183 // Cliqset has bad actor IDs (just nickname of user). We
184 // work around it by getting the author data and using its
187 if (!preg_match('/^\w+:/', $this->actor->id)) {
188 $authorEl = ActivityUtils::child($entry, 'author');
189 if (!empty($authorEl)) {
190 $authorObj = new ActivityObject($authorEl);
191 $this->actor->id = $authorObj->id;
194 } else if (!empty($feed) &&
195 $subjectEl = $this->_child($feed, self::SUBJECT)) {
197 $this->actor = new ActivityObject($subjectEl);
199 } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
201 $this->actor = new ActivityObject($authorEl);
203 } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
206 $this->actor = new ActivityObject($authorEl);
209 $contextEl = $this->_child($entry, self::CONTEXT);
211 if (!empty($contextEl)) {
212 $this->context = new ActivityContext($contextEl);
214 $this->context = new ActivityContext($entry);
217 $targetEl = $this->_child($entry, self::TARGET);
219 if (!empty($targetEl)) {
220 $this->target = new ActivityObject($targetEl);
223 $this->summary = ActivityUtils::childContent($entry, 'summary');
224 $this->id = ActivityUtils::childContent($entry, 'id');
225 $this->content = ActivityUtils::getContent($entry);
227 $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
229 for ($i = 0; $i < $catEls->length; $i++) {
230 $catEl = $catEls->item($i);
231 $this->categories[] = new AtomCategory($catEl);
235 foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
236 $this->enclosures[] = $link->getAttribute('href');
240 function _fromRssItem($item, $channel)
242 $verbEl = $this->_child($item, self::VERB);
244 if (!empty($verbEl)) {
245 $this->verb = trim($verbEl->textContent);
247 $this->verb = ActivityVerb::POST;
248 // XXX: do other implied stuff here
251 $pubDateEl = $this->_child($item, self::PUBDATE, self::RSS);
253 if (!empty($pubDateEl)) {
254 $this->time = strtotime($pubDateEl->textContent);
257 if ($authorEl = $this->_child($item, self::AUTHOR, self::RSS)) {
258 $this->actor = ActivityObject::fromRssAuthor($authorEl);
259 } else if ($dcCreatorEl = $this->_child($item, self::CREATOR, self::DC)) {
260 $this->actor = ActivityObject::fromDcCreator($dcCreatorEl);
261 } else if ($posterousEl = $this->_child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS)) {
262 // Special case for Posterous.com
263 $this->actor = ActivityObject::fromPosterousAuthor($posterousEl);
264 } else if (!empty($channel)) {
265 $this->actor = ActivityObject::fromRssChannel($channel);
270 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
272 $contentEl = ActivityUtils::child($item, self::ENCODED, self::CONTENTNS);
274 if (!empty($contentEl)) {
275 // <content:encoded> XML node's text content is HTML; no further processing needed.
276 $this->content = $contentEl->textContent;
278 $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
279 if (!empty($descriptionEl)) {
280 // Per spec, <description> must be plaintext.
281 // In practice, often there's HTML... but these days good
282 // feeds are using <content:encoded> which is explicitly
284 // We'll treat this following spec, and do HTML escaping
285 // to convert from plaintext to HTML.
286 $this->content = htmlspecialchars($descriptionEl->textContent);
290 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, self::RSS);
293 // @fixme thumbnails... maybe
295 $guidEl = ActivityUtils::child($item, self::GUID, self::RSS);
297 if (!empty($guidEl)) {
298 $this->id = $guidEl->textContent;
300 if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
302 $this->link = $this->id;
306 $this->objects[] = new ActivityObject($item);
307 $this->context = new ActivityContext($item);
311 * Returns an Atom <entry> based on this activity
313 * @return DOMElement Atom entry
316 function toAtomEntry()
321 function asString($namespace=false)
323 $xs = new XMLStringer(true);
326 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
327 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
328 'xmlns:georss' => 'http://www.georss.org/georss',
329 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
330 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
331 'xmlns:media' => 'http://purl.org/syndication/atommedia');
336 $xs->elementStart('entry', $attrs);
338 $xs->element('id', null, $this->id);
339 $xs->element('title', null, $this->title);
340 $xs->element('published', null, common_date_iso8601($this->time));
341 $xs->element('content', array('type' => 'html'), $this->content);
343 if (!empty($this->summary)) {
344 $xs->element('summary', null, $this->summary);
347 if (!empty($this->link)) {
348 $xs->element('link', array('rel' => 'alternate',
349 'type' => 'text/html'),
355 $xs->elementStart('author');
356 $xs->element('uri', array(), $this->actor->id);
357 if ($this->actor->title) {
358 $xs->element('name', array(), $this->actor->title);
360 $xs->elementEnd('author');
361 $xs->raw($this->actor->asString('activity:actor'));
363 $xs->element('activity:verb', null, $this->verb);
365 if (!empty($this->objects)) {
366 foreach($this->objects as $object) {
367 $xs->raw($object->asString());
372 $xs->raw($this->target->asString('activity:target'));
375 foreach ($this->categories as $cat) {
376 $xs->raw($cat->asString());
379 $xs->elementEnd('entry');
381 return $xs->getString();
384 private function _child($element, $tag, $namespace=self::SPEC)
386 return ActivityUtils::child($element, $tag, $namespace);