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/
54 const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
55 const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
56 const NOTE = 'http://activitystrea.ms/schema/1.0/note';
57 const STATUS = 'http://activitystrea.ms/schema/1.0/status';
58 const FILE = 'http://activitystrea.ms/schema/1.0/file';
59 const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
60 const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
61 const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
62 const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
63 const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
64 const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
65 const PERSON = 'http://activitystrea.ms/schema/1.0/person';
66 const GROUP = 'http://activitystrea.ms/schema/1.0/group';
67 const PLACE = 'http://activitystrea.ms/schema/1.0/place';
68 const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
71 // Atom elements we snarf
73 const TITLE = 'title';
74 const SUMMARY = 'summary';
76 const SOURCE = 'source';
80 const EMAIL = 'email';
82 const POSTEROUS = 'http://posterous.com/help/rss/1.0';
83 const AUTHOR = 'author';
84 const USERIMAGE = 'userImage';
85 const PROFILEURL = 'profileUrl';
86 const NICKNAME = 'nickName';
87 const DISPLAYNAME = 'displayName';
97 public $avatarLinks = array();
102 // @todo move this stuff to it's own PHOTO activity object
103 const MEDIA_DESCRIPTION = 'description';
109 // Extra stuff, that may need to be serialized
111 public $extra = array();
116 * This probably needs to be refactored
117 * to generate a local class (ActivityPerson, ActivityFile, ...)
118 * based on the object type.
120 * @param DOMElement $element DOM thing to turn into an Activity thing
122 function __construct($element = null)
124 if (empty($element)) {
128 $this->element = $element;
130 $this->geopoint = $this->_childContent(
132 ActivityContext::POINT,
133 ActivityContext::GEORSS
136 if ($element->tagName == 'author') {
137 $this->_fromAuthor($element);
138 } else if ($element->tagName == 'item') {
139 $this->_fromRssItem($element);
141 $this->_fromAtomEntry($element);
144 // Some per-type attributes...
145 if ($this->type == self::PERSON || $this->type == self::GROUP) {
146 $this->displayName = $this->title;
148 $photos = ActivityUtils::getLinks($element, 'photo');
149 if (count($photos)) {
150 foreach ($photos as $link) {
151 $this->avatarLinks[] = new AvatarLink($link);
154 $avatars = ActivityUtils::getLinks($element, 'avatar');
155 foreach ($avatars as $link) {
156 $this->avatarLinks[] = new AvatarLink($link);
160 $this->poco = new PoCo($element);
163 if ($this->type == self::PHOTO) {
165 $this->thumbnail = ActivityUtils::getLink($element, 'preview');
166 $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
168 $this->description = ActivityUtils::childContent(
170 ActivityObject::MEDIA_DESCRIPTION,
176 private function _fromAuthor($element)
178 $this->type = self::PERSON; // XXX: is this fair?
179 $this->title = $this->_childContent($element, self::NAME);
181 $this->id = $this->_childContent($element, self::URI);
183 if (empty($this->id)) {
184 $email = $this->_childContent($element, self::EMAIL);
185 if (!empty($email)) {
187 $this->id = 'mailto:'.$email;
192 private function _fromAtomEntry($element)
194 $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
197 if (empty($this->type)) {
198 $this->type = ActivityObject::NOTE;
201 $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
202 $this->content = ActivityUtils::getContent($element);
204 // We don't like HTML in our titles, although it's technically allowed
206 $title = ActivityUtils::childHtmlContent($element, self::TITLE);
208 $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
210 $this->source = $this->_getSource($element);
212 $this->link = ActivityUtils::getPermalink($element);
214 $this->id = $this->_childContent($element, self::ID);
216 if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
217 $this->id = $this->link;
221 // @todo FIXME: rationalize with Activity::_fromRssItem()
222 private function _fromRssItem($item)
224 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
226 $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
228 if (!empty($contentEl)) {
229 $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
231 $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
232 if (!empty($descriptionEl)) {
233 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
237 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
239 $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
241 if (!empty($guidEl)) {
242 $this->id = $guidEl->textContent;
244 if ($guidEl->hasAttribute('isPermaLink')) {
246 $this->link = $this->id;
251 public static function fromRssAuthor($el)
253 $text = $el->textContent;
255 if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
258 } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
261 } else if (preg_match('/.*@.*/', $text)) {
269 // Not really enough info
271 $obj = new ActivityObject();
275 $obj->type = ActivityObject::PERSON;
278 if (!empty($email)) {
279 $obj->id = 'mailto:'.$email;
285 public static function fromDcCreator($el)
287 // Not really enough info
289 $text = $el->textContent;
291 $obj = new ActivityObject();
296 $obj->type = ActivityObject::PERSON;
301 public static function fromRssChannel($el)
303 $obj = new ActivityObject();
307 $obj->type = ActivityObject::PERSON; // @fixme guess better
309 $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
310 $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
311 $obj->id = ActivityUtils::getLink($el, Activity::SELF);
313 if (empty($obj->id)) {
314 $obj->id = $obj->link;
317 $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);
320 $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
323 $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);
325 if (!empty($imageEl)) {
326 $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
327 $al = new AvatarLink();
329 $obj->avatarLinks[] = $al;
335 public static function fromPosterousAuthor($el)
337 $obj = new ActivityObject();
339 $obj->type = ActivityObject::PERSON; // @fixme any others...?
341 $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);
343 if (!empty($userImage)) {
344 $al = new AvatarLink();
345 $al->url = $userImage;
346 $obj->avatarLinks[] = $al;
349 $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
350 $obj->id = $obj->link;
352 $obj->poco = new PoCo();
354 $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
355 $obj->poco->displayName = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
357 $obj->title = $obj->poco->displayName;
362 private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
364 return ActivityUtils::childContent($element, $tag, $namespace);
367 // Try to get a unique id for the source feed
369 private function _getSource($element)
371 $sourceEl = ActivityUtils::child($element, 'source');
373 if (empty($sourceEl)) {
376 $href = ActivityUtils::getLink($sourceEl, 'self');
380 return ActivityUtils::childContent($sourceEl, 'id');
385 static function fromNotice(Notice $notice)
387 $object = new ActivityObject();
389 if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
391 $object->type = ActivityObject::NOTE;
393 $object->id = $notice->uri;
394 $object->title = $notice->content;
395 $object->content = $notice->rendered;
396 $object->link = $notice->bestUrl();
398 Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
404 static function fromProfile(Profile $profile)
406 $object = new ActivityObject();
408 if (Event::handle('StartActivityObjectFromProfile', array($profile, &$object))) {
410 $object->type = ActivityObject::PERSON;
411 $object->id = $profile->getUri();
412 $object->title = $profile->getBestName();
413 $object->link = $profile->profileurl;
415 $orig = $profile->getOriginalAvatar();
418 $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
427 foreach ($sizes as $size) {
429 $avatar = $profile->getAvatar($size);
431 if (!empty($avatar)) {
432 $alink = AvatarLink::fromAvatar($avatar);
434 $alink = new AvatarLink();
435 $alink->type = 'image/png';
436 $alink->height = $size;
437 $alink->width = $size;
438 $alink->url = Avatar::defaultImage($size);
440 if ($size == AVATAR_PROFILE_SIZE) {
441 // Hack for Twitter import: we don't have a 96x96 image,
442 // but we do have a 73x73 image. For now, fake it with that.
443 $avatar = $profile->getAvatar(73);
445 $alink = AvatarLink::fromAvatar($avatar);
446 $alink->height= $size;
447 $alink->width = $size;
452 $object->avatarLinks[] = $alink;
455 if (isset($profile->lat) && isset($profile->lon)) {
456 $object->geopoint = (float)$profile->lat
457 . ' ' . (float)$profile->lon;
460 $object->poco = PoCo::fromProfile($profile);
462 Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
468 static function fromGroup($group)
470 $object = new ActivityObject();
472 if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
474 $object->type = ActivityObject::GROUP;
475 $object->id = $group->getUri();
476 $object->title = $group->getBestName();
477 $object->link = $group->getUri();
479 $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
480 AVATAR_PROFILE_SIZE);
482 $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
485 $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
488 $object->poco = PoCo::fromGroup($group);
490 Event::handle('EndActivityObjectFromGroup', array($group, &$object));
496 function outputTo($xo, $tag='activity:object')
499 $xo->elementStart($tag);
502 $xo->element('activity:object-type', null, $this->type);
504 $xo->element(self::ID, null, $this->id);
506 if (!empty($this->title)) {
510 common_xml_safe_str($this->title)
514 if (!empty($this->summary)) {
518 common_xml_safe_str($this->summary)
522 if (!empty($this->content)) {
523 // XXX: assuming HTML content here
525 ActivityUtils::CONTENT,
526 array('type' => 'html'),
527 common_xml_safe_str($this->content)
531 if (!empty($this->link)) {
535 'rel' => 'alternate',
536 'type' => 'text/html',
537 'href' => $this->link
543 if ($this->type == ActivityObject::PERSON
544 || $this->type == ActivityObject::GROUP) {
546 foreach ($this->avatarLinks as $avatar) {
550 'type' => $avatar->type,
551 'media:width' => $avatar->width,
552 'media:height' => $avatar->height,
553 'href' => $avatar->url
560 if (!empty($this->geopoint)) {
568 if (!empty($this->poco)) {
569 $xo->raw($this->poco->asString());
572 foreach ($this->extra as $el) {
573 list($extraTag, $attrs, $content) = $el;
574 $xo->element($extraTag, $attrs, $content);
578 $xo->elementEnd($tag);
584 function asString($tag='activity:object')
586 $xs = new XMLStringer(true);
588 $this->outputTo($xs, $tag);
590 return $xs->getString();