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 * @copyright 2010 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
35 * Utilities for turning DOMish things into Activityish things
37 * Some common functions that I didn't have the bandwidth to try to factor
38 * into some kind of reasonable superclass, so just dumped here. Might
39 * be useful to have an ActivityObject parent class or something.
43 * @author Evan Prodromou <evan@status.net>
44 * @copyright 2010 StatusNet, Inc.
45 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
46 * @link http://status.net/
51 const ATOM = 'http://www.w3.org/2005/Atom';
59 * Get the permalink for an Activity object
61 * @param DOMElement $element A DOM element
63 * @return string related link, if any
66 static function getLink($element)
68 $links = $element->getElementsByTagnameNS(self::ATOM, self::LINK);
70 foreach ($links as $link) {
72 $rel = $link->getAttribute(self::REL);
73 $type = $link->getAttribute(self::TYPE);
75 if ($rel == 'alternate' && $type == 'text/html') {
76 return $link->getAttribute(self::HREF);
85 * A noun-ish thing in the activity universe
87 * The activity streams spec talks about activity objects, while also having
88 * a tag activity:object, which is in fact an activity object. Aaaaaah!
90 * This is just a thing in the activity universe. Can be the subject, object,
91 * or indirect object (target!) of an activity verb. Rotten name, and I'm
92 * propagating it. *sigh*
96 * @author Evan Prodromou <evan@status.net>
97 * @copyright 2010 StatusNet, Inc.
98 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
99 * @link http://status.net/
104 const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
105 const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
106 const NOTE = 'http://activitystrea.ms/schema/1.0/note';
107 const STATUS = 'http://activitystrea.ms/schema/1.0/status';
108 const FILE = 'http://activitystrea.ms/schema/1.0/file';
109 const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
110 const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
111 const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
112 const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
113 const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
114 const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
115 const PERSON = 'http://activitystrea.ms/schema/1.0/person';
116 const GROUP = 'http://activitystrea.ms/schema/1.0/group';
117 const PLACE = 'http://activitystrea.ms/schema/1.0/place';
118 const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
121 // Atom elements we snarf
123 const TITLE = 'title';
124 const SUMMARY = 'summary';
125 const CONTENT = 'content';
127 const SOURCE = 'source';
131 const EMAIL = 'email';
144 * This probably needs to be refactored
145 * to generate a local class (ActivityPerson, ActivityFile, ...)
146 * based on the object type.
148 * @param DOMElement $element DOM thing to turn into an Activity thing
151 function __construct($element)
153 $this->source = $element;
155 if ($element->tagName == 'author') {
157 $this->type = self::PERSON; // XXX: is this fair?
158 $this->title = $this->_childContent($element, self::NAME);
159 $this->id = $this->_childContent($element, self::URI);
161 if (empty($this->id)) {
162 $email = $this->_childContent($element, self::EMAIL);
163 if (!empty($email)) {
165 $this->id = 'mailto:'.$email;
171 $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
174 if (empty($this->type)) {
175 $this->type = ActivityObject::NOTE;
178 $this->id = $this->_childContent($element, self::ID);
179 $this->title = $this->_childContent($element, self::TITLE);
180 $this->summary = $this->_childContent($element, self::SUMMARY);
181 $this->content = $this->_childContent($element, self::CONTENT);
182 $this->source = $this->_childContent($element, self::SOURCE);
184 $this->link = ActivityUtils::getLink($element);
186 // XXX: grab PoCo stuff
191 * Grab the text content of a DOM element child of the current element
193 * @param DOMElement $element Element whose children we examine
194 * @param string $tag Tag to look up
195 * @param string $namespace Namespace to use, defaults to Atom
197 * @return string content of the child
200 private function _childContent($element, $tag, $namespace=Activity::ATOM)
202 $els = $element->getElementsByTagnameNS($namespace, $tag);
204 if (empty($els) || $els->length == 0) {
208 return $el->textContent;
214 * Utility class to hold a bunch of constant defining default verb types
218 * @author Evan Prodromou <evan@status.net>
219 * @copyright 2010 StatusNet, Inc.
220 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
221 * @link http://status.net/
226 const POST = 'http://activitystrea.ms/schema/1.0/post';
227 const SHARE = 'http://activitystrea.ms/schema/1.0/share';
228 const SAVE = 'http://activitystrea.ms/schema/1.0/save';
229 const FAVORITE = 'http://activitystrea.ms/schema/1.0/favorite';
230 const PLAY = 'http://activitystrea.ms/schema/1.0/play';
231 const FOLLOW = 'http://activitystrea.ms/schema/1.0/follow';
232 const FRIEND = 'http://activitystrea.ms/schema/1.0/make-friend';
233 const JOIN = 'http://activitystrea.ms/schema/1.0/join';
234 const TAG = 'http://activitystrea.ms/schema/1.0/tag';
238 * An activity in the ActivityStrea.ms world
240 * An activity is kind of like a sentence: someone did something
243 * 'someone' is the 'actor'; 'did something' is the verb;
244 * 'something else' is the object.
248 * @author Evan Prodromou <evan@status.net>
249 * @copyright 2010 StatusNet, Inc.
250 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
251 * @link http://status.net/
256 const SPEC = 'http://activitystrea.ms/spec/1.0/';
257 const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
260 const OBJECT = 'object';
261 const ACTOR = 'actor';
262 const SUBJECT = 'subject';
263 const OBJECTTYPE = 'object-type';
264 const CONTEXT = 'context';
265 const TARGET = 'target';
267 const ATOM = 'http://www.w3.org/2005/Atom';
269 const AUTHOR = 'author';
270 const PUBLISHED = 'published';
271 const UPDATED = 'updated';
273 public $actor; // an ActivityObject
274 public $verb; // a string (the URL)
275 public $object; // an ActivityObject
276 public $target; // an ActivityObject
277 public $context; // an ActivityObject
278 public $time; // Time of the activity
279 public $link; // an ActivityObject
280 public $entry; // the source entry
281 public $feed; // the source feed
284 * Turns a regular old Atom <entry> into a magical activity
286 * @param DOMElement $entry Atom entry to poke at
287 * @param DOMElement $feed Atom feed, for context
290 function __construct($entry, $feed = null)
292 $this->entry = $entry;
295 $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
297 if (!empty($pubEl)) {
298 $this->time = strtotime($pubEl->textContent);
300 // XXX technically an error; being liberal. Good idea...?
301 $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
302 if (!empty($updateEl)) {
303 $this->time = strtotime($updateEl->textContent);
309 $this->link = ActivityUtils::getLink($entry);
311 $verbEl = $this->_child($entry, self::VERB);
313 if (!empty($verbEl)) {
314 $this->verb = trim($verbEl->textContent);
316 $this->verb = ActivityVerb::POST;
317 // XXX: do other implied stuff here
320 $objectEl = $this->_child($entry, self::OBJECT);
322 if (!empty($objectEl)) {
323 $this->object = new ActivityObject($objectEl);
325 $this->object = new ActivityObject($entry);
328 $actorEl = $this->_child($entry, self::ACTOR);
330 if (!empty($actorEl)) {
332 $this->actor = new ActivityObject($actorEl);
334 } else if (!empty($feed) &&
335 $subjectEl = $this->_child($feed, self::SUBJECT)) {
337 $this->actor = new ActivityObject($subjectEl);
339 } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
341 $this->actor = new ActivityObject($authorEl);
343 } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
346 $this->actor = new ActivityObject($authorEl);
349 $contextEl = $this->_child($entry, self::CONTEXT);
351 if (!empty($contextEl)) {
352 $this->context = new ActivityObject($contextEl);
355 $targetEl = $this->_child($entry, self::TARGET);
357 if (!empty($targetEl)) {
358 $this->target = new ActivityObject($targetEl);
363 * Returns an Atom <entry> based on this activity
365 * @return DOMElement Atom entry
368 function toAtomEntry()
374 * Gets the first child element with the given tag
376 * @param DOMElement $element element to pick at
377 * @param string $tag tag to look for
378 * @param string $namespace Namespace to look under
380 * @return DOMElement found element or null
383 private function _child($element, $tag, $namespace=self::SPEC)
385 $els = $element->getElementsByTagnameNS($namespace, $tag);
387 if (empty($els) || $els->length == 0) {
390 return $els->item(0);