lib/activityobject.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * An activity
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Feed
  23  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * A noun-ish thing in the activity universe
  37  *
  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!
  40  *
  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*
  44  *
  45  * @category  OStatus
  46  * @package   StatusNet
  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/
  51  */
  52 class ActivityObject
  53 {
  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';
  70     // ^^^^^^^^^^ tea!
  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';
  76
  77     // Atom elements we snarf
  78
  79     const TITLE   = 'title';
  80     const SUMMARY = 'summary';
  81     const ID      = 'id';
  82     const SOURCE  = 'source';
  83
  84     const NAME  = 'name';
  85     const URI   = 'uri';
  86     const EMAIL = 'email';
  87
  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';
  94
  95     public $element;
  96     public $type;
  97     public $id;
  98     public $title;
  99     public $summary;
 100     public $content;
 101     public $owner;
 102     public $link;
 103     public $source;
 104     public $avatarLinks = array();
 105     public $geopoint;
 106     public $poco;
 107     public $displayName;
 108
 109     // @todo move this stuff to it's own PHOTO activity object
 110     const MEDIA_DESCRIPTION = 'description';
 111
 112     public $thumbnail;
 113     public $largerImage;
 114     public $description;
 115     public $extra = array();
 116
 117     public $stream;
 118
 119     /**
 120      * Constructor
 121      *
 122      * This probably needs to be refactored
 123      * to generate a local class (ActivityPerson, ActivityFile, ...)
 124      * based on the object type.
 125      *
 126      * @param DOMElement $element DOM thing to turn into an Activity thing
 127      */
 128     function __construct($element = null)
 129     {
 130         if (empty($element)) {
 131             return;
 132         }
 133
 134         $this->element = $element;
 135
 136         $this->geopoint = $this->_childContent(
 137             $element,
 138             ActivityContext::POINT,
 139             ActivityContext::GEORSS
 140         );
 141
 142         if ($element->tagName == 'author') {
 143             $this->_fromAuthor($element);
 144         } else if ($element->tagName == 'item') {
 145             $this->_fromRssItem($element);
 146         } else {
 147             $this->_fromAtomEntry($element);
 148         }
 149
 150         // Some per-type attributes...
 151         if ($this->type == self::PERSON || $this->type == self::GROUP) {
 152             $this->displayName = $this->title;
 153
 154             $photos = ActivityUtils::getLinks($element, 'photo');
 155             if (count($photos)) {
 156                 foreach ($photos as $link) {
 157                     $this->avatarLinks[] = new AvatarLink($link);
 158                 }
 159             } else {
 160                 $avatars = ActivityUtils::getLinks($element, 'avatar');
 161                 foreach ($avatars as $link) {
 162                     $this->avatarLinks[] = new AvatarLink($link);
 163                 }
 164             }
 165
 166             $this->poco = new PoCo($element);
 167         }
 168
 169         if ($this->type == self::PHOTO) {
 170
 171             $this->thumbnail   = ActivityUtils::getLink($element, 'preview');
 172             $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
 173
 174             $this->description = ActivityUtils::childContent(
 175                 $element,
 176                 ActivityObject::MEDIA_DESCRIPTION,
 177                 Activity::MEDIA
 178             );
 179         }
 180         if ($this->type == self::_LIST) {
 181             $owner = ActivityUtils::child($this->element, Activity::AUTHOR, Activity::SPEC);
 182             $this->owner = new ActivityObject($owner);
 183         }
 184     }
 185
 186     private function _fromAuthor($element)
 187     {
 188         $this->type = $this->_childContent($element,
 189                                            Activity::OBJECTTYPE,
 190                                            Activity::SPEC);
 191
 192         if (empty($this->type)) {
 193             $this->type = self::PERSON; // XXX: is this fair?
 194         }
 195
 196         // start with <atom:title>
 197
 198         $title = ActivityUtils::childHtmlContent($element, self::TITLE);
 199
 200         if (!empty($title)) {
 201             $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
 202         }
 203
 204         // fall back to <atom:name>
 205
 206         if (empty($this->title)) {
 207             $this->title = $this->_childContent($element, self::NAME);
 208         }
 209
 210         // start with <atom:id>
 211
 212         $this->id = $this->_childContent($element, self::ID);
 213
 214         // fall back to <atom:uri>
 215
 216         if (empty($this->id)) {
 217             $this->id = $this->_childContent($element, self::URI);
 218         }
 219
 220         // fall further back to <atom:email>
 221
 222         if (empty($this->id)) {
 223             $email = $this->_childContent($element, self::EMAIL);
 224             if (!empty($email)) {
 225                 // XXX: acct: ?
 226                 $this->id = 'mailto:'.$email;
 227             }
 228         }
 229
 230         $this->link = ActivityUtils::getPermalink($element);
 231
 232         // fall finally back to <link rel=alternate>
 233
 234         if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
 235             $this->id = $this->link;
 236         }
 237     }
 238
 239     private function _fromAtomEntry($element)
 240     {
 241         $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
 242                                            Activity::SPEC);
 243
 244         if (empty($this->type)) {
 245             $this->type = ActivityObject::NOTE;
 246         }
 247
 248         $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
 249         $this->content = ActivityUtils::getContent($element);
 250
 251         // We don't like HTML in our titles, although it's technically allowed
 252
 253         $title = ActivityUtils::childHtmlContent($element, self::TITLE);
 254
 255         $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
 256
 257         $this->source  = $this->_getSource($element);
 258
 259         $this->link = ActivityUtils::getPermalink($element);
 260
 261         $this->id = $this->_childContent($element, self::ID);
 262
 263         if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
 264             $this->id = $this->link;
 265         }
 266     }
 267
 268     // @todo FIXME: rationalize with Activity::_fromRssItem()
 269     private function _fromRssItem($item)
 270     {
 271         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
 272
 273         $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
 274
 275         if (!empty($contentEl)) {
 276             $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
 277         } else {
 278             $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
 279             if (!empty($descriptionEl)) {
 280                 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
 281             }
 282         }
 283
 284         $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
 285
 286         $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
 287
 288         if (!empty($guidEl)) {
 289             $this->id = $guidEl->textContent;
 290
 291             if ($guidEl->hasAttribute('isPermaLink')) {
 292                 // overwrites <link>
 293                 $this->link = $this->id;
 294             }
 295         }
 296     }
 297
 298     public static function fromRssAuthor($el)
 299     {
 300         $text = $el->textContent;
 301
 302         if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
 303             $email = $match[1];
 304             $name = $match[2];
 305         } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
 306             $name = $match[1];
 307             $email = $match[2];
 308         } else if (preg_match('/.*@.*/', $text)) {
 309             $email = $text;
 310             $name = null;
 311         } else {
 312             $name = $text;
 313             $email = null;
 314         }
 315
 316         // Not really enough info
 317
 318         $obj = new ActivityObject();
 319
 320         $obj->element = $el;
 321
 322         $obj->type  = ActivityObject::PERSON;
 323         $obj->title = $name;
 324
 325         if (!empty($email)) {
 326             $obj->id = 'mailto:'.$email;
 327         }
 328
 329         return $obj;
 330     }
 331
 332     public static function fromDcCreator($el)
 333     {
 334         // Not really enough info
 335
 336         $text = $el->textContent;
 337
 338         $obj = new ActivityObject();
 339
 340         $obj->element = $el;
 341
 342         $obj->title = $text;
 343         $obj->type  = ActivityObject::PERSON;
 344
 345         return $obj;
 346     }
 347
 348     public static function fromRssChannel($el)
 349     {
 350         $obj = new ActivityObject();
 351
 352         $obj->element = $el;
 353
 354         $obj->type = ActivityObject::PERSON; // @fixme guess better
 355
 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);
 359
 360         if (empty($obj->id)) {
 361             $obj->id = $obj->link;
 362         }
 363
 364         $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);
 365
 366         if (!empty($desc)) {
 367             $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
 368         }
 369
 370         $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);
 371
 372         if (!empty($imageEl)) {
 373             $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
 374             $al = new AvatarLink();
 375             $al->url = $url;
 376             $obj->avatarLinks[] = $al;
 377         }
 378
 379         return $obj;
 380     }
 381
 382     public static function fromPosterousAuthor($el)
 383     {
 384         $obj = new ActivityObject();
 385
 386         $obj->type = ActivityObject::PERSON; // @fixme any others...?
 387
 388         $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);
 389
 390         if (!empty($userImage)) {
 391             $al = new AvatarLink();
 392             $al->url = $userImage;
 393             $obj->avatarLinks[] = $al;
 394         }
 395
 396         $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
 397         $obj->id   = $obj->link;
 398
 399         $obj->poco = new PoCo();
 400
 401         $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
 402         $obj->poco->displayName       = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
 403
 404         $obj->title = $obj->poco->displayName;
 405
 406         return $obj;
 407     }
 408
 409     private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
 410     {
 411         return ActivityUtils::childContent($element, $tag, $namespace);
 412     }
 413
 414     // Try to get a unique id for the source feed
 415
 416     private function _getSource($element)
 417     {
 418         $sourceEl = ActivityUtils::child($element, 'source');
 419
 420         if (empty($sourceEl)) {
 421             return null;
 422         } else {
 423             $href = ActivityUtils::getLink($sourceEl, 'self');
 424             if (!empty($href)) {
 425                 return $href;
 426             } else {
 427                 return ActivityUtils::childContent($sourceEl, 'id');
 428             }
 429         }
 430     }
 431
 432     static function fromNotice(Notice $notice)
 433     {
 434         $object = new ActivityObject();
 435
 436         if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
 437
 438             $object->type    = (empty($notice->object_type)) ? ActivityObject::NOTE : $notice->object_type;
 439
 440             $object->id      = $notice->uri;
 441             $object->title = 'New ' . ActivityObject::canonicalType($object->type) . ' by ';
 442             try {
 443                 $object->title .= $notice->getProfile()->getAcctUri();
 444             } catch (ProfileNoAcctUriException $e) {
 445                 $object->title .= $e->profile->nickname;
 446             }
 447             $object->content = $notice->rendered;
 448             $object->link    = $notice->bestUrl();
 449
 450             $object->extra[] = array('status_net', array('notice_id' => $notice->id));
 451
 452             Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
 453         }
 454
 455         return $object;
 456     }
 457
 458     static function fromProfile(Profile $profile)
 459     {
 460         $object = new ActivityObject();
 461
 462         if (Event::handle('StartActivityObjectFromProfile', array($profile, &$object))) {
 463             $object->type   = ActivityObject::PERSON;
 464             $object->id     = $profile->getUri();
 465             $object->title  = $profile->getBestName();
 466             $object->link   = $profile->profileurl;
 467
 468             try {
 469                 $avatar = Avatar::getUploaded($profile);
 470                 $object->avatarLinks[] = AvatarLink::fromAvatar($avatar);
 471             } catch (NoAvatarException $e) {
 472                 // Could not find an original avatar to link
 473             }
 474
 475             $sizes = array(
 476                 AVATAR_PROFILE_SIZE,
 477                 AVATAR_STREAM_SIZE,
 478                 AVATAR_MINI_SIZE
 479             );
 480
 481             foreach ($sizes as $size) {
 482                 $alink  = null;
 483                 try {
 484                     $avatar = Avatar::byProfile($profile, $size);
 485                     $alink = AvatarLink::fromAvatar($avatar);
 486                 } catch (NoAvatarException $e) {
 487                     $alink = new AvatarLink();
 488                     $alink->type   = 'image/png';
 489                     $alink->height = $size;
 490                     $alink->width  = $size;
 491                     $alink->url    = Avatar::defaultImage($size);
 492                 }
 493
 494                 $object->avatarLinks[] = $alink;
 495             }
 496
 497             if (isset($profile->lat) && isset($profile->lon)) {
 498                 $object->geopoint = (float)$profile->lat
 499                     . ' ' . (float)$profile->lon;
 500             }
 501
 502             $object->poco = PoCo::fromProfile($profile);
 503
 504             if ($profile->isLocal()) {
 505                 $object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $profile->nickname))));
 506             }
 507
 508             Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
 509         }
 510
 511         return $object;
 512     }
 513
 514     static function fromGroup(User_group $group)
 515     {
 516         $object = new ActivityObject();
 517
 518         if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
 519
 520             $object->type   = ActivityObject::GROUP;
 521             $object->id     = $group->getUri();
 522             $object->title  = $group->getBestName();
 523             $object->link   = $group->getUri();
 524
 525             $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
 526                                                               AVATAR_PROFILE_SIZE);
 527
 528             $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
 529                                                               AVATAR_STREAM_SIZE);
 530
 531             $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
 532                                                               AVATAR_MINI_SIZE);
 533
 534             $object->poco = PoCo::fromGroup($group);
 535             Event::handle('EndActivityObjectFromGroup', array($group, &$object));
 536         }
 537
 538         return $object;
 539     }
 540
 541     static function fromPeopletag($ptag)
 542     {
 543         $object = new ActivityObject();
 544         if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) {
 545             $object->type    = ActivityObject::_LIST;
 546
 547             $object->id      = $ptag->getUri();
 548             $object->title   = $ptag->tag;
 549             $object->summary = $ptag->description;
 550             $object->link    = $ptag->homeUrl();
 551             $object->owner   = Profile::getKV('id', $ptag->tagger);
 552             $object->poco    = PoCo::fromProfile($object->owner);
 553             Event::handle('EndActivityObjectFromPeopletag', array($ptag, &$object));
 554         }
 555         return $object;
 556     }
 557
 558     static function fromFile(File $file)
 559     {
 560         $object = new ActivityObject();
 561
 562         if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) {
 563
 564             $object->type = self::mimeTypeToObjectType($file->mimetype);
 565             $object->id   = TagURI::mint(sprintf("file:%d", $file->id));
 566             $object->link = common_local_url('attachment', array('attachment' => $file->id));
 567
 568             if ($file->title) {
 569                 $object->title = $file->title;
 570             }
 571
 572             if ($file->date) {
 573                 $object->date = $file->date;
 574             }
 575
 576             try {
 577                 $thumbnail = $file->getThumbnail();
 578                 $object->thumbnail = $thumbnail;
 579             } catch (UnsupportedMediaException $e) {
 580                 $object->thumbnail = null;
 581             }
 582
 583             switch (ActivityObject::canonicalType($object->type)) {
 584             case 'image':
 585                 $object->largerImage = $file->url;
 586                 break;
 587             case 'video':
 588             case 'audio':
 589                 $object->stream = $file->url;
 590                 break;
 591             }
 592
 593             Event::handle('EndActivityObjectFromFile', array($file, &$object));
 594         }
 595
 596         return $object;
 597     }
 598
 599     static function fromNoticeSource(Notice_source $source)
 600     {
 601         $object = new ActivityObject();
 602         $wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
 603                            'activity', 'feed', 'mirror', 'twitter', 'facebook');
 604
 605         if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) {
 606             $object->type = ActivityObject::APPLICATION;
 607
 608             if (in_array($source->code, $wellKnown)) {
 609                 // We use one ID for all well-known StatusNet sources
 610                 $object->id = "tag:status.net,2009:notice-source:".$source->code;
 611             } else if ($source->url) {
 612                 // They registered with an URL
 613                 $object->id = $source->url;
 614             } else {
 615                 // Locally-registered, no URL
 616                 $object->id = TagURI::mint("notice-source:".$source->code);
 617             }
 618
 619             if ($source->url) {
 620                 $object->link = $source->url;
 621             }
 622
 623             if ($source->name) {
 624                 $object->title = $source->name;
 625             } else {
 626                 $object->title = $source->code;
 627             }
 628
 629             if ($source->created) {
 630                 $object->date = $source->created;
 631             }
 632
 633             $object->extra[] = array('status_net', array('source_code' => $source->code));
 634
 635             Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object));
 636         }
 637
 638         return $object;
 639     }
 640
 641     static function fromMessage(Message $message)
 642     {
 643         $object = new ActivityObject();
 644
 645         if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) {
 646
 647             $object->type    = ActivityObject::NOTE;
 648             $object->id      = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
 649             $object->content = $message->rendered;
 650             $object->date    = $message->created;
 651
 652             if ($message->url) {
 653                 $object->link = $message->url;
 654             } else {
 655                 $object->link = common_local_url('showmessage', array('message' => $message->id));
 656             }
 657
 658             $object->extra[] = array('status_net', array('message_id' => $message->id));
 659
 660             Event::handle('EndActivityObjectFromMessage', array($message, &$object));
 661         }
 662
 663         return $object;
 664     }
 665
 666     function outputTo($xo, $tag='activity:object')
 667     {
 668         if (!empty($tag)) {
 669             $xo->elementStart($tag);
 670         }
 671
 672         if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
 673             $xo->element('activity:object-type', null, $this->type);
 674
 675             // <author> uses URI
 676
 677             if ($tag == 'author') {
 678                 $xo->element(self::URI, null, $this->id);
 679             } else {
 680                 $xo->element(self::ID, null, $this->id);
 681             }
 682
 683             if (!empty($this->title)) {
 684                 $name = common_xml_safe_str($this->title);
 685                 if ($tag == 'author') {
 686                     // XXX: Backward compatibility hack -- atom:name should contain
 687                     // full name here, instead of nickname, i.e.: $name. Change
 688                     // this in the next version.
 689                     $xo->element(self::NAME, null, $this->poco->preferredUsername);
 690                 } else {
 691                     $xo->element(self::TITLE, null, $name);
 692                 }
 693             }
 694
 695             if (!empty($this->summary)) {
 696                 $xo->element(
 697                     self::SUMMARY,
 698                     null,
 699                     common_xml_safe_str($this->summary)
 700                 );
 701             }
 702
 703             if (!empty($this->content)) {
 704                 // XXX: assuming HTML content here
 705                 $xo->element(
 706                     ActivityUtils::CONTENT,
 707                     array('type' => 'html'),
 708                     common_xml_safe_str($this->content)
 709                 );
 710             }
 711
 712             if (!empty($this->link)) {
 713                 $xo->element(
 714                     'link',
 715                     array(
 716                         'rel' => 'alternate',
 717                         'type' => 'text/html',
 718                         'href' => $this->link
 719                     ),
 720                     null
 721                 );
 722             }
 723
 724             if(!empty($this->owner)) {
 725                 $owner = $this->owner->asActivityNoun(self::AUTHOR);
 726                 $xo->raw($owner);
 727             }
 728
 729             if ($this->type == ActivityObject::PERSON
 730                 || $this->type == ActivityObject::GROUP) {
 731
 732                 foreach ($this->avatarLinks as $alink) {
 733                     $xo->element('link',
 734                             array(
 735                                 'rel'          => 'avatar',
 736                                 'type'         => $alink->type,
 737                                 'media:width'  => $alink->width,
 738                                 'media:height' => $alink->height,
 739                                 'href'         => $alink->url,
 740                                 ),
 741                             null);
 742                 }
 743             }
 744
 745             if (!empty($this->geopoint)) {
 746                 $xo->element(
 747                     'georss:point',
 748                     null,
 749                     $this->geopoint
 750                 );
 751             }
 752
 753             if (!empty($this->poco)) {
 754                 $this->poco->outputTo($xo);
 755             }
 756
 757             // @fixme there's no way here to make a tree; elements can only contain plaintext
 758             // @fixme these may collide with JSON extensions
 759             foreach ($this->extra as $el) {
 760                 list($extraTag, $attrs, $content) = array_pad($el, 3, null);
 761                 $xo->element($extraTag, $attrs, $content);
 762             }
 763
 764             Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
 765         }
 766
 767         if (!empty($tag)) {
 768             $xo->elementEnd($tag);
 769         }
 770
 771         return;
 772     }
 773
 774     function asString($tag='activity:object')
 775     {
 776         $xs = new XMLStringer(true);
 777
 778         $this->outputTo($xs, $tag);
 779
 780         return $xs->getString();
 781     }
 782
 783     /*
 784      * Returns an array based on this Activity Object suitable for
 785      * encoding as JSON.
 786      *
 787      * @return array $object the activity object array
 788      */
 789
 790     function asArray()
 791     {
 792         $object = array();
 793
 794         if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
 795             // XXX: attachments are added by Activity
 796
 797             // author (Add object for author? Could be useful for repeats.)
 798
 799             // content (Add rendered version of the notice?)
 800
 801             // downstreamDuplicates
 802
 803             // id
 804
 805             if ($this->id) {
 806                 $object['id'] = $this->id;
 807             } else if ($this->link) {
 808                 $object['id'] = $this->link;
 809             }
 810
 811             if ($this->type == ActivityObject::PERSON
 812                 || $this->type == ActivityObject::GROUP) {
 813
 814                 // displayName
 815                 $object['displayName'] = $this->title;
 816
 817                 // XXX: Not sure what the best avatar is to use for the
 818                 // author's "image". For now, I'm using the large size.
 819
 820                 $imgLink          = null;
 821                 $avatarMediaLinks = array();
 822
 823                 foreach ($this->avatarLinks as $a) {
 824
 825                     // Make a MediaLink for every other Avatar
 826                     $avatar = new ActivityStreamsMediaLink(
 827                         $a->url,
 828                         $a->width,
 829                         $a->height,
 830                         $a->type,
 831                         'avatar'
 832                     );
 833
 834                     // Find the big avatar to use as the "image"
 835                     if ($a->height == AVATAR_PROFILE_SIZE) {
 836                         $imgLink = $avatar;
 837                     }
 838
 839                     $avatarMediaLinks[] = $avatar->asArray();
 840                 }
 841
 842                 if (!array_key_exists('status_net', $object)) {
 843                     $object['status_net'] = array();
 844                 }
 845
 846                 $object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
 847
 848                 // image
 849                 if (!empty($imgLink)) {
 850                     $object['image']  = $imgLink->asArray();
 851                 }
 852             }
 853
 854             // objectType
 855             //
 856             // We can probably use the whole schema URL here but probably the
 857             // relative simple name is easier to parse
 858
 859             $object['objectType'] = ActivityObject::canonicalType($this->type);
 860
 861             // summary
 862             $object['summary'] = $this->summary;
 863
 864             // content, usually rendered HTML
 865             $object['content'] = $this->content;
 866
 867             // published (probably don't need. Might be useful for repeats.)
 868
 869             // updated (probably don't need this)
 870
 871             // TODO: upstreamDuplicates
 872
 873             if ($this->link) {
 874                 $object['url'] = $this->link;
 875             }
 876
 877             /* Extensions */
 878             // @fixme these may collide with XML extensions
 879             // @fixme multiple tags of same name will overwrite each other
 880             // @fixme text content from XML extensions will be lost
 881
 882             foreach ($this->extra as $e) {
 883                 list($objectName, $props, $txt) = array_pad($e, 3, null);
 884                 if (!empty($objectName)) {
 885                     $parts = explode(":", $objectName);
 886                     if (count($parts) == 2 && $parts[0] == "statusnet") {
 887                         if (!array_key_exists('status_net', $object)) {
 888                             $object['status_net'] = array();
 889                         }
 890                         $object['status_net'][$parts[1]] = $props;
 891                     } else {
 892                         $object[$objectName] = $props;
 893                     }
 894                 }
 895             }
 896
 897             if (!empty($this->geopoint)) {
 898
 899                 list($lat, $lon) = explode(' ', $this->geopoint);
 900
 901                 if (!empty($lat) && !empty($lon)) {
 902                     $object['location'] = array(
 903                         'objectType' => 'place',
 904                         'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
 905                         'lat' => $lat,
 906                         'lon' => $lon
 907                     );
 908
 909                     $loc = Location::fromLatLon((float)$lat, (float)$lon);
 910
 911                     if ($loc) {
 912                         $name = $loc->getName();
 913
 914                         if ($name) {
 915                             $object['location']['displayName'] = $name;
 916                         }
 917                         $url = $loc->getURL();
 918
 919                         if ($url) {
 920                             $object['location']['url'] = $url;
 921                         }
 922                     }
 923                 }
 924             }
 925
 926             if (!empty($this->poco)) {
 927                 $object['portablecontacts_net'] = array_filter($this->poco->asArray());
 928             }
 929
 930             if (!empty($this->thumbnail)) {
 931                 if (is_string($this->thumbnail)) {
 932                     $object['image'] = array('url' => $this->thumbnail);
 933                 } else {
 934                     $object['image'] = array('url' => $this->thumbnail->url);
 935                     if ($this->thumbnail->width) {
 936                         $object['image']['width'] = $this->thumbnail->width;
 937                     }
 938                     if ($this->thumbnail->height) {
 939                         $object['image']['height'] = $this->thumbnail->height;
 940                     }
 941                 }
 942             }
 943
 944             switch (ActivityObject::canonicalType($this->type)) {
 945             case 'image':
 946                 if (!empty($this->largerImage)) {
 947                     $object['fullImage'] = array('url' => $this->largerImage);
 948                 }
 949                 break;
 950             case 'audio':
 951             case 'video':
 952                 if (!empty($this->stream)) {
 953                     $object['stream'] = array('url' => $this->stream);
 954                 }
 955                 break;
 956             }
 957
 958             Event::handle('EndActivityObjectOutputJson', array($this, &$object));
 959         }
 960         return array_filter($object);
 961     }
 962
 963     static function canonicalType($type) {
 964         $ns = 'http://activitystrea.ms/schema/1.0/';
 965         if (substr($type, 0, mb_strlen($ns)) == $ns) {
 966             return substr($type, mb_strlen($ns));
 967         } else {
 968             return $type;
 969         }
 970     }
 971
 972     static function mimeTypeToObjectType($mimeType) {
 973         $ot = null;
 974
 975         // Default
 976
 977         if (empty($mimeType)) {
 978             return self::FILE;
 979         }
 980
 981         $parts = explode('/', $mimeType);
 982
 983         switch ($parts[0]) {
 984         case 'image':
 985             $ot = self::IMAGE;
 986             break;
 987         case 'audio':
 988             $ot = self::AUDIO;
 989             break;
 990         case 'video':
 991             $ot = self::VIDEO;
 992             break;
 993         default:
 994             $ot = self::FILE;
 995         }
 996
 997         return $ot;
 998     }
 999 }