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 _LIST = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved
68 const PLACE = 'http://activitystrea.ms/schema/1.0/place';
69 const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
71 const ACTIVITY = 'http://activitystrea.ms/schema/1.0/activity';
72 const SERVICE = 'http://activitystrea.ms/schema/1.0/service';
73 const IMAGE = 'http://activitystrea.ms/schema/1.0/image';
74 const COLLECTION = 'http://activitystrea.ms/schema/1.0/collection';
75 const APPLICATION = 'http://activitystrea.ms/schema/1.0/application';
77 // Atom elements we snarf
79 const TITLE = 'title';
80 const SUMMARY = 'summary';
82 const SOURCE = 'source';
86 const EMAIL = 'email';
88 const POSTEROUS = 'http://posterous.com/help/rss/1.0';
89 const AUTHOR = 'author';
90 const USERIMAGE = 'userImage';
91 const PROFILEURL = 'profileUrl';
92 const NICKNAME = 'nickName';
93 const DISPLAYNAME = 'displayName';
104 public $avatarLinks = array();
109 // @todo move this stuff to it's own PHOTO activity object
110 const MEDIA_DESCRIPTION = 'description';
115 public $extra = array();
122 * This probably needs to be refactored
123 * to generate a local class (ActivityPerson, ActivityFile, ...)
124 * based on the object type.
126 * @param DOMElement $element DOM thing to turn into an Activity thing
128 function __construct($element = null)
130 if (empty($element)) {
134 $this->element = $element;
136 $this->geopoint = $this->_childContent(
138 ActivityContext::POINT,
139 ActivityContext::GEORSS
142 if ($element->tagName == 'author') {
143 $this->_fromAuthor($element);
144 } else if ($element->tagName == 'item') {
145 $this->_fromRssItem($element);
147 $this->_fromAtomEntry($element);
150 // Some per-type attributes...
151 if ($this->type == self::PERSON || $this->type == self::GROUP) {
152 $this->displayName = $this->title;
154 $photos = ActivityUtils::getLinks($element, 'photo');
155 if (count($photos)) {
156 foreach ($photos as $link) {
157 $this->avatarLinks[] = new AvatarLink($link);
160 $avatars = ActivityUtils::getLinks($element, 'avatar');
161 foreach ($avatars as $link) {
162 $this->avatarLinks[] = new AvatarLink($link);
166 $this->poco = new PoCo($element);
169 if ($this->type == self::PHOTO) {
171 $this->thumbnail = ActivityUtils::getLink($element, 'preview');
172 $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
174 $this->description = ActivityUtils::childContent(
176 ActivityObject::MEDIA_DESCRIPTION,
180 if ($this->type == self::_LIST) {
181 $owner = ActivityUtils::child($this->element, Activity::AUTHOR, Activity::SPEC);
182 $this->owner = new ActivityObject($owner);
186 private function _fromAuthor($element)
188 $this->type = $this->_childContent($element,
189 Activity::OBJECTTYPE,
192 if (empty($this->type)) {
193 $this->type = self::PERSON; // XXX: is this fair?
196 // start with <atom:title>
198 $title = ActivityUtils::childHtmlContent($element, self::TITLE);
200 if (!empty($title)) {
201 $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
204 // fall back to <atom:name>
206 if (empty($this->title)) {
207 $this->title = $this->_childContent($element, self::NAME);
210 // start with <atom:id>
212 $this->id = $this->_childContent($element, self::ID);
214 // fall back to <atom:uri>
216 if (empty($this->id)) {
217 $this->id = $this->_childContent($element, self::URI);
220 // fall further back to <atom:email>
222 if (empty($this->id)) {
223 $email = $this->_childContent($element, self::EMAIL);
224 if (!empty($email)) {
226 $this->id = 'mailto:'.$email;
230 $this->link = ActivityUtils::getPermalink($element);
232 // fall finally back to <link rel=alternate>
234 if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
235 $this->id = $this->link;
239 private function _fromAtomEntry($element)
241 $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
244 if (empty($this->type)) {
245 $this->type = ActivityObject::NOTE;
248 $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
249 $this->content = ActivityUtils::getContent($element);
251 // We don't like HTML in our titles, although it's technically allowed
253 $title = ActivityUtils::childHtmlContent($element, self::TITLE);
255 $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
257 $this->source = $this->_getSource($element);
259 $this->link = ActivityUtils::getPermalink($element);
261 $this->id = $this->_childContent($element, self::ID);
263 if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
264 $this->id = $this->link;
268 // @todo FIXME: rationalize with Activity::_fromRssItem()
269 private function _fromRssItem($item)
271 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
273 $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
275 if (!empty($contentEl)) {
276 $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
278 $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
279 if (!empty($descriptionEl)) {
280 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
284 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
286 $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
288 if (!empty($guidEl)) {
289 $this->id = $guidEl->textContent;
291 if ($guidEl->hasAttribute('isPermaLink')) {
293 $this->link = $this->id;
298 public static function fromRssAuthor($el)
300 $text = $el->textContent;
302 if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
305 } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
308 } else if (preg_match('/.*@.*/', $text)) {
316 // Not really enough info
318 $obj = new ActivityObject();
322 $obj->type = ActivityObject::PERSON;
325 if (!empty($email)) {
326 $obj->id = 'mailto:'.$email;
332 public static function fromDcCreator($el)
334 // Not really enough info
336 $text = $el->textContent;
338 $obj = new ActivityObject();
343 $obj->type = ActivityObject::PERSON;
348 public static function fromRssChannel($el)
350 $obj = new ActivityObject();
354 $obj->type = ActivityObject::PERSON; // @fixme guess better
356 $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
357 $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
358 $obj->id = ActivityUtils::getLink($el, Activity::SELF);
360 if (empty($obj->id)) {
361 $obj->id = $obj->link;
364 $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);
367 $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
370 $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);
372 if (!empty($imageEl)) {
373 $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
374 $al = new AvatarLink();
376 $obj->avatarLinks[] = $al;
382 public static function fromPosterousAuthor($el)
384 $obj = new ActivityObject();
386 $obj->type = ActivityObject::PERSON; // @fixme any others...?
388 $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);
390 if (!empty($userImage)) {
391 $al = new AvatarLink();
392 $al->url = $userImage;
393 $obj->avatarLinks[] = $al;
396 $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
397 $obj->id = $obj->link;
399 $obj->poco = new PoCo();
401 $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
402 $obj->poco->displayName = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
404 $obj->title = $obj->poco->displayName;
409 private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
411 return ActivityUtils::childContent($element, $tag, $namespace);
414 // Try to get a unique id for the source feed
416 private function _getSource($element)
418 $sourceEl = ActivityUtils::child($element, 'source');
420 if (empty($sourceEl)) {
423 $href = ActivityUtils::getLink($sourceEl, 'self');
427 return ActivityUtils::childContent($sourceEl, 'id');
432 static function fromNotice(Notice $notice)
434 $object = new ActivityObject();
436 if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
438 $object->type = (empty($notice->object_type)) ? ActivityObject::NOTE : $notice->object_type;
440 $object->id = $notice->uri;
441 $object->content = $notice->rendered;
442 $object->link = $notice->bestUrl();
444 $object->extra[] = array('status_net', array('notice_id' => $notice->id));
446 Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
452 static function fromProfile(Profile $profile)
454 $object = new ActivityObject();
456 if (Event::handle('StartActivityObjectFromProfile', array($profile, &$object))) {
457 $object->type = ActivityObject::PERSON;
458 $object->id = $profile->getUri();
459 $object->title = $profile->getBestName();
460 $object->link = $profile->profileurl;
463 $avatar = Avatar::getUploaded($profile);
464 $object->avatarLinks[] = AvatarLink::fromAvatar($avatar);
465 } catch (NoAvatarException $e) {
466 // Could not find an original avatar to link
475 foreach ($sizes as $size) {
478 $avatar = Avatar::byProfile($profile, $size);
479 $alink = AvatarLink::fromAvatar($avatar);
480 } catch (NoAvatarException $e) {
481 $alink = new AvatarLink();
482 $alink->type = 'image/png';
483 $alink->height = $size;
484 $alink->width = $size;
485 $alink->url = Avatar::defaultImage($size);
488 $object->avatarLinks[] = $alink;
491 if (isset($profile->lat) && isset($profile->lon)) {
492 $object->geopoint = (float)$profile->lat
493 . ' ' . (float)$profile->lon;
496 $object->poco = PoCo::fromProfile($profile);
498 if ($profile->isLocal()) {
499 $object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $profile->nickname))));
502 Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
508 static function fromGroup(User_group $group)
510 $object = new ActivityObject();
512 if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
514 $object->type = ActivityObject::GROUP;
515 $object->id = $group->getUri();
516 $object->title = $group->getBestName();
517 $object->link = $group->getUri();
519 $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
520 AVATAR_PROFILE_SIZE);
522 $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
525 $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
528 $object->poco = PoCo::fromGroup($group);
529 Event::handle('EndActivityObjectFromGroup', array($group, &$object));
535 static function fromPeopletag($ptag)
537 $object = new ActivityObject();
538 if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) {
539 $object->type = ActivityObject::_LIST;
541 $object->id = $ptag->getUri();
542 $object->title = $ptag->tag;
543 $object->summary = $ptag->description;
544 $object->link = $ptag->homeUrl();
545 $object->owner = Profile::getKV('id', $ptag->tagger);
546 $object->poco = PoCo::fromProfile($object->owner);
547 Event::handle('EndActivityObjectFromPeopletag', array($ptag, &$object));
552 static function fromFile(File $file)
554 $object = new ActivityObject();
556 if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) {
558 $object->type = self::mimeTypeToObjectType($file->mimetype);
559 $object->id = TagURI::mint(sprintf("file:%d", $file->id));
560 $object->link = common_local_url('attachment', array('attachment' => $file->id));
563 $object->title = $file->title;
567 $object->date = $file->date;
570 $thumbnail = $file->getThumbnail();
572 if (!empty($thumbnail)) {
573 $object->thumbnail = $thumbnail;
576 switch (ActivityObject::canonicalType($object->type)) {
578 $object->largerImage = $file->url;
582 $object->stream = $file->url;
586 Event::handle('EndActivityObjectFromFile', array($file, &$object));
592 static function fromNoticeSource(Notice_source $source)
594 $object = new ActivityObject();
595 $wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
596 'activity', 'feed', 'mirror', 'twitter', 'facebook');
598 if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) {
599 $object->type = ActivityObject::APPLICATION;
601 if (in_array($source->code, $wellKnown)) {
602 // We use one ID for all well-known StatusNet sources
603 $object->id = "tag:status.net,2009:notice-source:".$source->code;
604 } else if ($source->url) {
605 // They registered with an URL
606 $object->id = $source->url;
608 // Locally-registered, no URL
609 $object->id = TagURI::mint("notice-source:".$source->code);
613 $object->link = $source->url;
617 $object->title = $source->name;
619 $object->title = $source->code;
622 if ($source->created) {
623 $object->date = $source->created;
626 $object->extra[] = array('status_net', array('source_code' => $source->code));
628 Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object));
634 static function fromMessage(Message $message)
636 $object = new ActivityObject();
638 if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) {
640 $object->type = ActivityObject::NOTE;
641 $object->id = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
642 $object->content = $message->rendered;
643 $object->date = $message->created;
646 $object->link = $message->url;
648 $object->link = common_local_url('showmessage', array('message' => $message->id));
651 $object->extra[] = array('status_net', array('message_id' => $message->id));
653 Event::handle('EndActivityObjectFromMessage', array($message, &$object));
659 function outputTo($xo, $tag='activity:object')
662 $xo->elementStart($tag);
665 if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
666 $xo->element('activity:object-type', null, $this->type);
670 if ($tag == 'author') {
671 $xo->element(self::URI, null, $this->id);
673 $xo->element(self::ID, null, $this->id);
676 if (!empty($this->title)) {
677 $name = common_xml_safe_str($this->title);
678 if ($tag == 'author') {
679 // XXX: Backward compatibility hack -- atom:name should contain
680 // full name here, instead of nickname, i.e.: $name. Change
681 // this in the next version.
682 $xo->element(self::NAME, null, $this->poco->preferredUsername);
684 $xo->element(self::TITLE, null, $name);
688 if (!empty($this->summary)) {
692 common_xml_safe_str($this->summary)
696 if (!empty($this->content)) {
697 // XXX: assuming HTML content here
699 ActivityUtils::CONTENT,
700 array('type' => 'html'),
701 common_xml_safe_str($this->content)
705 if (!empty($this->link)) {
709 'rel' => 'alternate',
710 'type' => 'text/html',
711 'href' => $this->link
717 if(!empty($this->owner)) {
718 $owner = $this->owner->asActivityNoun(self::AUTHOR);
722 if ($this->type == ActivityObject::PERSON
723 || $this->type == ActivityObject::GROUP) {
725 foreach ($this->avatarLinks as $alink) {
729 'type' => $alink->type,
730 'media:width' => $alink->width,
731 'media:height' => $alink->height,
732 'href' => $alink->url,
738 if (!empty($this->geopoint)) {
746 if (!empty($this->poco)) {
747 $this->poco->outputTo($xo);
750 // @fixme there's no way here to make a tree; elements can only contain plaintext
751 // @fixme these may collide with JSON extensions
752 foreach ($this->extra as $el) {
753 list($extraTag, $attrs, $content) = array_pad($el, 3, null);
754 $xo->element($extraTag, $attrs, $content);
757 Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
761 $xo->elementEnd($tag);
767 function asString($tag='activity:object')
769 $xs = new XMLStringer(true);
771 $this->outputTo($xs, $tag);
773 return $xs->getString();
777 * Returns an array based on this Activity Object suitable for
780 * @return array $object the activity object array
787 if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
788 // XXX: attachments are added by Activity
790 // author (Add object for author? Could be useful for repeats.)
792 // content (Add rendered version of the notice?)
797 $object['displayName'] = $this->title;
800 // downstreamDuplicates
805 $object['id'] = $this->id;
806 } else if ($this->link) {
807 $object['id'] = $this->link;
810 if ($this->type == ActivityObject::PERSON
811 || $this->type == ActivityObject::GROUP) {
813 // XXX: Not sure what the best avatar is to use for the
814 // author's "image". For now, I'm using the large size.
817 $avatarMediaLinks = array();
819 foreach ($this->avatarLinks as $a) {
821 // Make a MediaLink for every other Avatar
822 $avatar = new ActivityStreamsMediaLink(
830 // Find the big avatar to use as the "image"
831 if ($a->height == AVATAR_PROFILE_SIZE) {
835 $avatarMediaLinks[] = $avatar->asArray();
838 if (!array_key_exists('status_net', $object)) {
839 $object['status_net'] = array();
842 $object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
845 if (!empty($imgLink)) {
846 $object['image'] = $imgLink->asArray();
852 // We can probably use the whole schema URL here but probably the
853 // relative simple name is easier to parse
855 $object['objectType'] = ActivityObject::canonicalType($this->type);
858 $object['summary'] = $this->summary;
861 $object['content'] = $this->content;
863 // published (probably don't need. Might be useful for repeats.)
865 // updated (probably don't need this)
867 // TODO: upstreamDuplicates
870 $object['url'] = $this->link;
874 // @fixme these may collide with XML extensions
875 // @fixme multiple tags of same name will overwrite each other
876 // @fixme text content from XML extensions will be lost
878 foreach ($this->extra as $e) {
879 list($objectName, $props, $txt) = array_pad($e, 3, null);
880 if (!empty($objectName)) {
881 $parts = explode(":", $objectName);
882 if (count($parts) == 2 && $parts[0] == "statusnet") {
883 if (!array_key_exists('status_net', $object)) {
884 $object['status_net'] = array();
886 $object['status_net'][$parts[1]] = $props;
888 $object[$objectName] = $props;
893 if (!empty($this->geopoint)) {
895 list($lat, $lon) = explode(' ', $this->geopoint);
897 if (!empty($lat) && !empty($lon)) {
898 $object['location'] = array(
899 'objectType' => 'place',
900 'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
905 $loc = Location::fromLatLon((float)$lat, (float)$lon);
908 $name = $loc->getName();
911 $object['location']['displayName'] = $name;
913 $url = $loc->getURL();
916 $object['location']['url'] = $url;
922 if (!empty($this->poco)) {
923 $object['portablecontacts_net'] = array_filter($this->poco->asArray());
926 if (!empty($this->thumbnail)) {
927 if (is_string($this->thumbnail)) {
928 $object['image'] = array('url' => $this->thumbnail);
930 $object['image'] = array('url' => $this->thumbnail->url);
931 if ($this->thumbnail->width) {
932 $object['image']['width'] = $this->thumbnail->width;
934 if ($this->thumbnail->height) {
935 $object['image']['height'] = $this->thumbnail->height;
940 switch (ActivityObject::canonicalType($this->type)) {
942 if (!empty($this->largerImage)) {
943 $object['fullImage'] = array('url' => $this->largerImage);
948 if (!empty($this->stream)) {
949 $object['stream'] = array('url' => $this->stream);
954 Event::handle('EndActivityObjectOutputJson', array($this, &$object));
956 return array_filter($object);
959 static function canonicalType($type) {
960 $ns = 'http://activitystrea.ms/schema/1.0/';
961 if (substr($type, 0, mb_strlen($ns)) == $ns) {
962 return substr($type, mb_strlen($ns));
968 static function mimeTypeToObjectType($mimeType) {
973 if (empty($mimeType)) {
977 $parts = explode('/', $mimeType);