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')) {
35 require_once(INSTALLDIR.'/lib/activitystreamjsondocument.php');
38 * A noun-ish thing in the activity universe
40 * The activity streams spec talks about activity objects, while also having
41 * a tag activity:object, which is in fact an activity object. Aaaaaah!
43 * This is just a thing in the activity universe. Can be the subject, object,
44 * or indirect object (target!) of an activity verb. Rotten name, and I'm
45 * propagating it. *sigh*
49 * @author Evan Prodromou <evan@status.net>
50 * @copyright 2010 StatusNet, Inc.
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
52 * @link http://status.net/
56 const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
57 const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
58 const NOTE = 'http://activitystrea.ms/schema/1.0/note';
59 const STATUS = 'http://activitystrea.ms/schema/1.0/status';
60 const FILE = 'http://activitystrea.ms/schema/1.0/file';
61 const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
62 const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
63 const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
64 const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
65 const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
66 const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
67 const PERSON = 'http://activitystrea.ms/schema/1.0/person';
68 const GROUP = 'http://activitystrea.ms/schema/1.0/group';
69 const _LIST = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved
70 const PLACE = 'http://activitystrea.ms/schema/1.0/place';
71 const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
73 const ACTIVITY = 'http://activitystrea.ms/schema/1.0/activity';
74 const SERVICE = 'http://activitystrea.ms/schema/1.0/service';
75 const IMAGE = 'http://activitystrea.ms/schema/1.0/image';
76 const COLLECTION = 'http://activitystrea.ms/schema/1.0/collection';
77 const APPLICATION = 'http://activitystrea.ms/schema/1.0/application';
79 // Atom elements we snarf
81 const TITLE = 'title';
82 const SUMMARY = 'summary';
84 const SOURCE = 'source';
88 const EMAIL = 'email';
90 const POSTEROUS = 'http://posterous.com/help/rss/1.0';
91 const AUTHOR = 'author';
92 const USERIMAGE = 'userImage';
93 const PROFILEURL = 'profileUrl';
94 const NICKNAME = 'nickName';
95 const DISPLAYNAME = 'displayName';
106 public $avatarLinks = array();
111 // @todo move this stuff to it's own PHOTO activity object
112 const MEDIA_DESCRIPTION = 'description';
117 public $extra = array();
124 * This probably needs to be refactored
125 * to generate a local class (ActivityPerson, ActivityFile, ...)
126 * based on the object type.
128 * @param DOMElement $element DOM thing to turn into an Activity thing
130 function __construct($element = null)
132 if (empty($element)) {
136 $this->element = $element;
138 $this->geopoint = $this->_childContent(
140 ActivityContext::POINT,
141 ActivityContext::GEORSS
144 if ($element->tagName == 'author') {
145 $this->_fromAuthor($element);
146 } else if ($element->tagName == 'item') {
147 $this->_fromRssItem($element);
149 $this->_fromAtomEntry($element);
152 // Some per-type attributes...
153 if ($this->type == self::PERSON || $this->type == self::GROUP) {
154 $this->displayName = $this->title;
156 $photos = ActivityUtils::getLinks($element, 'photo');
157 if (count($photos)) {
158 foreach ($photos as $link) {
159 $this->avatarLinks[] = new AvatarLink($link);
162 $avatars = ActivityUtils::getLinks($element, 'avatar');
163 foreach ($avatars as $link) {
164 $this->avatarLinks[] = new AvatarLink($link);
168 $this->poco = new PoCo($element);
171 if ($this->type == self::PHOTO) {
173 $this->thumbnail = ActivityUtils::getLink($element, 'preview');
174 $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
176 $this->description = ActivityUtils::childContent(
178 ActivityObject::MEDIA_DESCRIPTION,
182 if ($this->type == self::_LIST) {
183 $owner = ActivityUtils::child($this->element, Activity::AUTHOR, Activity::SPEC);
184 $this->owner = new ActivityObject($owner);
188 private function _fromAuthor($element)
190 $this->type = $this->_childContent($element,
191 Activity::OBJECTTYPE,
194 if (empty($this->type)) {
195 $this->type = self::PERSON; // XXX: is this fair?
199 // Start with <poco::displayName>
201 $this->title = ActivityUtils::childContent($element, PoCo::DISPLAYNAME, PoCo::NS);
203 // try falling back to <atom:title>
205 if (empty($this->title)) {
206 $title = ActivityUtils::childHtmlContent($element, self::TITLE);
208 if (!empty($title)) {
209 $this->title = common_strip_html($title);
213 // fall back to <atom:name> as a last resort
215 if (empty($this->title)) {
216 $this->title = $this->_childContent($element, self::NAME);
219 // start with <atom:id>
221 $this->id = $this->_childContent($element, self::ID);
223 // fall back to <atom:uri>
225 if (empty($this->id)) {
226 $this->id = $this->_childContent($element, self::URI);
229 // fall further back to <atom:email>
231 if (empty($this->id)) {
232 $email = $this->_childContent($element, self::EMAIL);
233 if (!empty($email)) {
235 $this->id = 'mailto:'.$email;
239 $this->link = ActivityUtils::getPermalink($element);
241 // fall finally back to <link rel=alternate>
243 if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
244 $this->id = $this->link;
248 private function _fromAtomEntry($element)
250 $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
253 if (empty($this->type)) {
254 $this->type = ActivityObject::NOTE;
257 $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
258 $this->content = ActivityUtils::getContent($element);
260 // We don't like HTML in our titles, although it's technically allowed
261 $this->title = common_strip_html(ActivityUtils::childHtmlContent($element, self::TITLE));
263 $this->source = $this->_getSource($element);
265 $this->link = ActivityUtils::getPermalink($element);
267 $this->id = $this->_childContent($element, self::ID);
269 if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
270 $this->id = $this->link;
274 // @todo FIXME: rationalize with Activity::_fromRssItem()
275 private function _fromRssItem($item)
277 if (empty($this->type)) {
278 $this->type = ActivityObject::NOTE;
281 $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
283 $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
285 if (!empty($contentEl)) {
286 $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
288 $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
289 if (!empty($descriptionEl)) {
290 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
294 $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
296 $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
298 if (!empty($guidEl)) {
299 $this->id = $guidEl->textContent;
301 if ($guidEl->hasAttribute('isPermaLink')) {
303 $this->link = $this->id;
308 public static function fromRssAuthor($el)
310 $text = $el->textContent;
312 if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
315 } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
318 } else if (preg_match('/.*@.*/', $text)) {
326 // Not really enough info
328 $obj = new ActivityObject();
332 $obj->type = ActivityObject::PERSON;
335 if (!empty($email)) {
336 $obj->id = 'mailto:'.$email;
342 public static function fromDcCreator($el)
344 // Not really enough info
346 $text = $el->textContent;
348 $obj = new ActivityObject();
353 $obj->type = ActivityObject::PERSON;
358 public static function fromRssChannel($el)
360 $obj = new ActivityObject();
364 $obj->type = ActivityObject::PERSON; // @fixme guess better
366 $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
367 $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
368 $obj->id = ActivityUtils::getLink($el, Activity::SELF);
370 if (empty($obj->id)) {
371 $obj->id = $obj->link;
374 $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);
377 $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
380 $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);
382 if (!empty($imageEl)) {
383 $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
384 $al = new AvatarLink();
386 $obj->avatarLinks[] = $al;
392 public static function fromPosterousAuthor($el)
394 $obj = new ActivityObject();
396 $obj->type = ActivityObject::PERSON; // @fixme any others...?
398 $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);
400 if (!empty($userImage)) {
401 $al = new AvatarLink();
402 $al->url = $userImage;
403 $obj->avatarLinks[] = $al;
406 $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
407 $obj->id = $obj->link;
409 $obj->poco = new PoCo();
411 $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
412 $obj->poco->displayName = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
414 $obj->title = $obj->poco->displayName;
419 private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
421 return ActivityUtils::childContent($element, $tag, $namespace);
424 // Try to get a unique id for the source feed
426 private function _getSource($element)
428 $sourceEl = ActivityUtils::child($element, 'source');
430 if (empty($sourceEl)) {
433 $href = ActivityUtils::getLink($sourceEl, 'self');
437 return ActivityUtils::childContent($sourceEl, 'id');
442 static function fromGroup(User_group $group)
444 $object = new ActivityObject();
446 if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
448 $object->type = ActivityObject::GROUP;
449 $object->id = $group->getUri();
450 $object->title = $group->getBestName();
451 $object->link = $group->getUri();
453 $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
454 AVATAR_PROFILE_SIZE);
456 $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
459 $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
462 $object->poco = PoCo::fromGroup($group);
463 Event::handle('EndActivityObjectFromGroup', array($group, &$object));
469 static function fromPeopletag($ptag)
471 $object = new ActivityObject();
472 if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) {
473 $object->type = ActivityObject::_LIST;
475 $object->id = $ptag->getUri();
476 $object->title = $ptag->tag;
477 $object->summary = $ptag->description;
478 $object->link = $ptag->homeUrl();
479 $object->owner = Profile::getKV('id', $ptag->tagger);
480 $object->poco = PoCo::fromProfile($object->owner);
481 Event::handle('EndActivityObjectFromPeopletag', array($ptag, &$object));
486 static function fromFile(File $file)
488 $object = new ActivityObject();
490 if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) {
492 $object->type = self::mimeTypeToObjectType($file->mimetype);
493 $object->id = TagURI::mint(sprintf("file:%d", $file->id));
494 $object->link = common_local_url('attachment', array('attachment' => $file->id));
497 $object->title = $file->title;
501 $object->date = $file->date;
505 $thumbnail = $file->getThumbnail();
506 $object->thumbnail = $thumbnail;
507 } catch (UseFileAsThumbnailException $e) {
508 $object->thumbnail = null;
509 } catch (UnsupportedMediaException $e) {
510 $object->thumbnail = null;
513 switch (self::canonicalType($object->type)) {
515 $object->largerImage = $file->getUrl();
519 $object->stream = $file->getUrl();
523 Event::handle('EndActivityObjectFromFile', array($file, &$object));
529 static function fromNoticeSource(Notice_source $source)
531 $object = new ActivityObject();
532 $wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
533 'activity', 'feed', 'mirror', 'twitter', 'facebook');
535 if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) {
536 $object->type = ActivityObject::APPLICATION;
538 if (in_array($source->code, $wellKnown)) {
539 // We use one ID for all well-known StatusNet sources
540 $object->id = "tag:status.net,2009:notice-source:".$source->code;
541 } else if ($source->url) {
542 // They registered with an URL
543 $object->id = $source->url;
545 // Locally-registered, no URL
546 $object->id = TagURI::mint("notice-source:".$source->code);
550 $object->link = $source->url;
554 $object->title = $source->name;
556 $object->title = $source->code;
559 if ($source->created) {
560 $object->date = $source->created;
563 $object->extra[] = array('status_net', array('source_code' => $source->code));
565 Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object));
571 static function fromMessage(Message $message)
573 $object = new ActivityObject();
575 if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) {
577 $object->type = ActivityObject::NOTE;
578 $object->id = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
579 $object->content = $message->rendered;
580 $object->date = $message->created;
583 $object->link = $message->url;
585 $object->link = common_local_url('showmessage', array('message' => $message->id));
588 $object->extra[] = array('status_net', array('message_id' => $message->id));
590 Event::handle('EndActivityObjectFromMessage', array($message, &$object));
596 function outputTo($xo, $tag='activity:object')
599 $xo->elementStart($tag);
602 if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
603 $xo->element('activity:object-type', null, $this->type);
607 if ($tag == 'author') {
608 $xo->element(self::URI, null, $this->id);
610 $xo->element(self::ID, null, $this->id);
613 if (!empty($this->title)) {
614 $name = common_xml_safe_str($this->title);
615 if ($tag == 'author') {
616 // XXX: Backward compatibility hack -- atom:name should contain
617 // full name here, instead of nickname, i.e.: $name. Change
618 // this in the next version.
619 $xo->element(self::NAME, null, $this->poco->preferredUsername);
621 $xo->element(self::TITLE, null, $name);
625 if (!empty($this->summary)) {
629 common_xml_safe_str($this->summary)
633 if (!empty($this->content)) {
634 // XXX: assuming HTML content here
636 ActivityUtils::CONTENT,
637 array('type' => 'html'),
638 common_xml_safe_str($this->content)
642 if (!empty($this->link)) {
646 'rel' => 'alternate',
647 'type' => 'text/html',
648 'href' => $this->link
654 if(!empty($this->owner)) {
655 $owner = $this->owner->asActivityNoun(self::AUTHOR);
659 if ($this->type == ActivityObject::PERSON
660 || $this->type == ActivityObject::GROUP) {
662 foreach ($this->avatarLinks as $alink) {
666 'type' => $alink->type,
667 'media:width' => $alink->width,
668 'media:height' => $alink->height,
669 'href' => $alink->url,
675 if (!empty($this->geopoint)) {
683 if (!empty($this->poco)) {
684 $this->poco->outputTo($xo);
687 // @fixme there's no way here to make a tree; elements can only contain plaintext
688 // @fixme these may collide with JSON extensions
689 foreach ($this->extra as $el) {
690 list($extraTag, $attrs, $content) = array_pad($el, 3, null);
691 $xo->element($extraTag, $attrs, $content);
694 Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
698 $xo->elementEnd($tag);
704 function asString($tag='activity:object')
706 $xs = new XMLStringer(true);
708 $this->outputTo($xs, $tag);
710 return $xs->getString();
714 * Returns an array based on this Activity Object suitable for
717 * @return array $object the activity object array
724 if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
725 // XXX: attachments are added by Activity
727 // author (Add object for author? Could be useful for repeats.)
729 // content (Add rendered version of the notice?)
731 // downstreamDuplicates
736 $object['id'] = $this->id;
737 } else if ($this->link) {
738 $object['id'] = $this->link;
741 if ($this->type == ActivityObject::PERSON
742 || $this->type == ActivityObject::GROUP) {
745 $object['displayName'] = $this->title;
747 // XXX: Not sure what the best avatar is to use for the
748 // author's "image". For now, I'm using the large size.
751 $avatarMediaLinks = array();
753 foreach ($this->avatarLinks as $a) {
755 // Make a MediaLink for every other Avatar
756 $avatar = new ActivityStreamsMediaLink(
764 // Find the big avatar to use as the "image"
765 if ($a->height == AVATAR_PROFILE_SIZE) {
769 $avatarMediaLinks[] = $avatar->asArray();
772 if (!array_key_exists('status_net', $object)) {
773 $object['status_net'] = array();
776 $object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
779 if (!empty($imgLink)) {
780 $object['image'] = $imgLink->asArray();
786 // We can probably use the whole schema URL here but probably the
787 // relative simple name is easier to parse
789 $object['objectType'] = self::canonicalType($this->type);
792 $object['summary'] = $this->summary;
794 // content, usually rendered HTML
795 $object['content'] = $this->content;
797 // published (probably don't need. Might be useful for repeats.)
799 // updated (probably don't need this)
801 // TODO: upstreamDuplicates
804 $object['url'] = $this->link;
808 // @fixme these may collide with XML extensions
809 // @fixme multiple tags of same name will overwrite each other
810 // @fixme text content from XML extensions will be lost
812 foreach ($this->extra as $e) {
813 list($objectName, $props, $txt) = array_pad($e, 3, null);
814 if (!empty($objectName)) {
815 $parts = explode(":", $objectName);
816 if (count($parts) == 2 && $parts[0] == "statusnet") {
817 if (!array_key_exists('status_net', $object)) {
818 $object['status_net'] = array();
820 $object['status_net'][$parts[1]] = $props;
822 $object[$objectName] = $props;
827 if (!empty($this->geopoint)) {
829 list($lat, $lon) = explode(' ', $this->geopoint);
831 if (!empty($lat) && !empty($lon)) {
832 $object['location'] = array(
833 'objectType' => 'place',
834 'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
839 $loc = Location::fromLatLon((float)$lat, (float)$lon);
842 $name = $loc->getName();
845 $object['location']['displayName'] = $name;
847 $url = $loc->getURL();
850 $object['location']['url'] = $url;
856 if (!empty($this->poco)) {
857 $object['portablecontacts_net'] = array_filter($this->poco->asArray());
860 if (!empty($this->thumbnail)) {
861 if (is_string($this->thumbnail)) {
862 $object['image'] = array('url' => $this->thumbnail);
864 $object['image'] = array('url' => $this->thumbnail->getUrl());
865 if ($this->thumbnail->width) {
866 $object['image']['width'] = $this->thumbnail->width;
868 if ($this->thumbnail->height) {
869 $object['image']['height'] = $this->thumbnail->height;
874 switch (self::canonicalType($this->type)) {
876 if (!empty($this->largerImage)) {
877 $object['fullImage'] = array('url' => $this->largerImage);
882 if (!empty($this->stream)) {
883 $object['stream'] = array('url' => $this->stream);
888 Event::handle('EndActivityObjectOutputJson', array($this, &$object));
890 return array_filter($object);
893 public function getIdentifiers() {
895 foreach(array('id', 'link', 'url') as $id) {
896 if (isset($this->$id)) {
900 return array_unique($ids);
903 static function canonicalType($type) {
904 return ActivityUtils::resolveUri($type, true);
907 static function mimeTypeToObjectType($mimeType) {
912 if (empty($mimeType)) {
916 $parts = explode('/', $mimeType);