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 * A noun-ish thing in the activity universe
38 * The activity streams spec talks about activity objects, while also having
39 * a tag activity:object, which is in fact an activity object. Aaaaaah!
41 * This is just a thing in the activity universe. Can be the subject, object,
42 * or indirect object (target!) of an activity verb. Rotten name, and I'm
43 * propagating it. *sigh*
47 * @author Evan Prodromou <evan@status.net>
48 * @copyright 2010 StatusNet, Inc.
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
50 * @link http://status.net/
55 const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
56 const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
57 const NOTE = 'http://activitystrea.ms/schema/1.0/note';
58 const STATUS = 'http://activitystrea.ms/schema/1.0/status';
59 const FILE = 'http://activitystrea.ms/schema/1.0/file';
60 const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
61 const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
62 const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
63 const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
64 const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
65 const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
66 const PERSON = 'http://activitystrea.ms/schema/1.0/person';
67 const GROUP = 'http://activitystrea.ms/schema/1.0/group';
68 const PLACE = 'http://activitystrea.ms/schema/1.0/place';
69 const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
72 // Atom elements we snarf
74 const TITLE = 'title';
75 const SUMMARY = 'summary';
77 const SOURCE = 'source';
81 const EMAIL = 'email';
83 const POSTEROUS = 'http://posterous.com/help/rss/1.0';
84 const AUTHOR = 'author';
85 const USERIMAGE = 'userImage';
86 const PROFILEURL = 'profileUrl';
87 const NICKNAME = 'nickName';
88 const DISPLAYNAME = 'displayName';
98 public $avatarLinks = array();
103 // @todo move this stuff to it's own PHOTO activity object
104 const MEDIA_DESCRIPTION = 'description';
113 * This probably needs to be refactored
114 * to generate a local class (ActivityPerson, ActivityFile, ...)
115 * based on the object type.
117 * @param DOMElement $element DOM thing to turn into an Activity thing
120 function __construct($element = null)
122 if (empty($element)) {
126 $this->element = $element;
128 $this->geopoint = $this->_childContent(
130 ActivityContext::POINT,
131 ActivityContext::GEORSS
134 if ($element->tagName == 'author') {
135 $this->_fromAuthor($element);
136 } else if ($element->tagName == 'item') {
137 $this->_fromRssItem($element);
139 $this->_fromAtomEntry($element);
142 // Some per-type attributes...
143 if ($this->type == self::PERSON || $this->type == self::GROUP) {
144 $this->displayName = $this->title;
146 $photos = ActivityUtils::getLinks($element, 'photo');
147 if (count($photos)) {
148 foreach ($photos as $link) {
149 $this->avatarLinks[] = new AvatarLink($link);
152 $avatars = ActivityUtils::getLinks($element, 'avatar');
153 foreach ($avatars as $link) {
154 $this->avatarLinks[] = new AvatarLink($link);
158 $this->poco = new PoCo($element);
161 if ($this->type == self::PHOTO) {
163 $this->thumbnail = ActivityUtils::getLink($element, 'preview');
164 $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
166 $this->description = ActivityUtils::childContent(
168 ActivityObject::MEDIA_DESCRIPTION,
174 private function _fromAuthor($element)
176 $this->type = self::PERSON; // XXX: is this fair?
177 $this->title = $this->_childContent($element, self::NAME);
179 $this->id = $this->_childContent($element, self::URI);
181 if (empty($this->id)) {
182 $email = $this->_childContent($element, self::EMAIL);
183 if (!empty($email)) {
185 $this->id = 'mailto:'.$email;
190 private function _fromAtomEntry($element)
192 $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
195 if (empty($this->type)) {
196 $this->type = ActivityObject::NOTE;
199 $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
200 $this->content = ActivityUtils::getContent($element);
202 // We don't like HTML in our titles, although it's technically allowed
204 $title = ActivityUtils::childHtmlContent($element, self::TITLE);
206 $this->title = html_entity_decode(strip_tags($title));
208 $this->source = $this->_getSource($element);
210 $this->link = ActivityUtils::getPermalink($element);
212 $this->id = $this->_childContent($element, self::ID);
214 if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
215 $this->id = $this->link;
219 // @fixme rationalize with Activity::_fromRssItem()
221 private function _fromRssItem($item)
223 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
225 $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
227 if (!empty($contentEl)) {
228 $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
230 $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
231 if (!empty($descriptionEl)) {
232 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
236 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
238 $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
240 if (!empty($guidEl)) {
241 $this->id = $guidEl->textContent;
243 if ($guidEl->hasAttribute('isPermaLink')) {
245 $this->link = $this->id;
250 public static function fromRssAuthor($el)
252 $text = $el->textContent;
254 if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
257 } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
260 } else if (preg_match('/.*@.*/', $text)) {
268 // Not really enough info
270 $obj = new ActivityObject();
274 $obj->type = ActivityObject::PERSON;
277 if (!empty($email)) {
278 $obj->id = 'mailto:'.$email;
284 public static function fromDcCreator($el)
286 // Not really enough info
288 $text = $el->textContent;
290 $obj = new ActivityObject();
295 $obj->type = ActivityObject::PERSON;
300 public static function fromRssChannel($el)
302 $obj = new ActivityObject();
306 $obj->type = ActivityObject::PERSON; // @fixme guess better
308 $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
309 $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
310 $obj->id = ActivityUtils::getLink($el, Activity::SELF);
312 if (empty($obj->id)) {
313 $obj->id = $obj->link;
316 $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);
319 $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
322 $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);
324 if (!empty($imageEl)) {
325 $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
326 $al = new AvatarLink();
328 $obj->avatarLinks[] = $al;
334 public static function fromPosterousAuthor($el)
336 $obj = new ActivityObject();
338 $obj->type = ActivityObject::PERSON; // @fixme any others...?
340 $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);
342 if (!empty($userImage)) {
343 $al = new AvatarLink();
344 $al->url = $userImage;
345 $obj->avatarLinks[] = $al;
348 $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
349 $obj->id = $obj->link;
351 $obj->poco = new PoCo();
353 $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
354 $obj->poco->displayName = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
356 $obj->title = $obj->poco->displayName;
361 private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
363 return ActivityUtils::childContent($element, $tag, $namespace);
366 // Try to get a unique id for the source feed
368 private function _getSource($element)
370 $sourceEl = ActivityUtils::child($element, 'source');
372 if (empty($sourceEl)) {
375 $href = ActivityUtils::getLink($sourceEl, 'self');
379 return ActivityUtils::childContent($sourceEl, 'id');
384 static function fromNotice(Notice $notice)
386 $object = new ActivityObject();
388 $object->type = ActivityObject::NOTE;
390 $object->id = $notice->uri;
391 $object->title = $notice->content;
392 $object->content = $notice->rendered;
393 $object->link = $notice->bestUrl();
398 static function fromProfile(Profile $profile)
400 $object = new ActivityObject();
402 $object->type = ActivityObject::PERSON;
403 $object->id = $profile->getUri();
404 $object->title = $profile->getBestName();
405 $object->link = $profile->profileurl;
407 $orig = $profile->getOriginalAvatar();
410 $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
419 foreach ($sizes as $size) {
421 $avatar = $profile->getAvatar($size);
423 if (!empty($avatar)) {
424 $alink = AvatarLink::fromAvatar($avatar);
426 $alink = new AvatarLink();
427 $alink->type = 'image/png';
428 $alink->height = $size;
429 $alink->width = $size;
430 $alink->url = Avatar::defaultImage($size);
432 if ($size == AVATAR_PROFILE_SIZE) {
433 // Hack for Twitter import: we don't have a 96x96 image,
434 // but we do have a 73x73 image. For now, fake it with that.
435 $avatar = $profile->getAvatar(73);
437 $alink = AvatarLink::fromAvatar($avatar);
438 $alink->height= $size;
439 $alink->width = $size;
444 $object->avatarLinks[] = $alink;
447 if (isset($profile->lat) && isset($profile->lon)) {
448 $object->geopoint = (float)$profile->lat
449 . ' ' . (float)$profile->lon;
452 $object->poco = PoCo::fromProfile($profile);
457 static function fromGroup($group)
459 $object = new ActivityObject();
461 $object->type = ActivityObject::GROUP;
462 $object->id = $group->getUri();
463 $object->title = $group->getBestName();
464 $object->link = $group->getUri();
466 $object->avatarLinks[] = AvatarLink::fromFilename(
467 $group->homepage_logo,
471 $object->avatarLinks[] = AvatarLink::fromFilename(
476 $object->avatarLinks[] = AvatarLink::fromFilename(
481 $object->poco = PoCo::fromGroup($group);
486 function asString($tag='activity:object')
488 $xs = new XMLStringer(true);
490 $xs->elementStart($tag);
492 $xs->element('activity:object-type', null, $this->type);
494 $xs->element(self::ID, null, $this->id);
496 if (!empty($this->title)) {
500 common_xml_safe_str($this->title)
504 if (!empty($this->summary)) {
508 common_xml_safe_str($this->summary)
512 if (!empty($this->content)) {
513 // XXX: assuming HTML content here
515 ActivityUtils::CONTENT,
516 array('type' => 'html'),
517 common_xml_safe_str($this->content)
521 if (!empty($this->link)) {
525 'rel' => 'alternate',
526 'type' => 'text/html',
527 'href' => $this->link
533 if ($this->type == ActivityObject::PERSON
534 || $this->type == ActivityObject::GROUP) {
536 foreach ($this->avatarLinks as $avatar) {
540 'type' => $avatar->type,
541 'media:width' => $avatar->width,
542 'media:height' => $avatar->height,
543 'href' => $avatar->url
550 if (!empty($this->geopoint)) {
558 if (!empty($this->poco)) {
559 $xs->raw($this->poco->asString());
562 $xs->elementEnd($tag);
564 return $xs->getString();