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->content = $notice->rendered;
 442             $object->link    = $notice->bestUrl();
 443
 444             $object->extra[] = array('status_net', array('notice_id' => $notice->id));
 445
 446             Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
 447         }
 448
 449         return $object;
 450     }
 451
 452     static function fromProfile(Profile $profile)
 453     {
 454         $object = new ActivityObject();
 455
 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;
 461
 462             try {
 463                 $orig = Avatar::getOriginal($profile);
 464                 $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
 465             } catch (Exception $e) {
 466                 // Could not find an original avatar to link
 467             }
 468
 469             $sizes = array(
 470                 AVATAR_PROFILE_SIZE,
 471                 AVATAR_STREAM_SIZE,
 472                 AVATAR_MINI_SIZE
 473             );
 474
 475             foreach ($sizes as $size) {
 476                 $alink  = null;
 477                 try {
 478                     $avatar = $profile->getAvatar($size);
 479                     $alink = AvatarLink::fromAvatar($avatar);
 480                 } catch (Exception $e) {
 481                     $alink = new AvatarLink();
 482                     $alink->type   = 'image/png';
 483                     $alink->height = $size;
 484                     $alink->width  = $size;
 485                     $alink->url    = Avatar::defaultImage($size);
 486                 }
 487
 488                 $object->avatarLinks[] = $alink;
 489             }
 490
 491             if (isset($profile->lat) && isset($profile->lon)) {
 492                 $object->geopoint = (float)$profile->lat
 493                     . ' ' . (float)$profile->lon;
 494             }
 495
 496             $object->poco = PoCo::fromProfile($profile);
 497
 498             if ($profile->isLocal()) {
 499                 $object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $profile->nickname))));
 500             }
 501
 502             Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
 503         }
 504
 505         return $object;
 506     }
 507
 508     static function fromGroup($group)
 509     {
 510         $object = new ActivityObject();
 511
 512         if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
 513
 514             $object->type   = ActivityObject::GROUP;
 515             $object->id     = $group->getUri();
 516             $object->title  = $group->getBestName();
 517             $object->link   = $group->getUri();
 518
 519             $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
 520                                                               AVATAR_PROFILE_SIZE);
 521
 522             $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
 523                                                               AVATAR_STREAM_SIZE);
 524
 525             $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
 526                                                               AVATAR_MINI_SIZE);
 527
 528             $object->poco = PoCo::fromGroup($group);
 529             Event::handle('EndActivityObjectFromGroup', array($group, &$object));
 530         }
 531
 532         return $object;
 533     }
 534
 535     static function fromPeopletag($ptag)
 536     {
 537         $object = new ActivityObject();
 538         if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) {
 539             $object->type    = ActivityObject::_LIST;
 540
 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));
 548         }
 549         return $object;
 550     }
 551
 552     static function fromFile(File $file)
 553     {
 554         $object = new ActivityObject();
 555
 556         if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) {
 557
 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));
 561
 562             if ($file->title) {
 563                 $object->title = $file->title;
 564             }
 565
 566             if ($file->date) {
 567                 $object->date = $file->date;
 568             }
 569
 570             $thumbnail = $file->getThumbnail();
 571
 572             if (!empty($thumbnail)) {
 573                 $object->thumbnail = $thumbnail;
 574             }
 575
 576             switch (ActivityObject::canonicalType($object->type)) {
 577             case 'image':
 578                 $object->largerImage = $file->url;
 579                 break;
 580             case 'video':
 581             case 'audio':
 582                 $object->stream = $file->url;
 583                 break;
 584             }
 585
 586             Event::handle('EndActivityObjectFromFile', array($file, &$object));
 587         }
 588
 589         return $object;
 590     }
 591
 592     static function fromNoticeSource(Notice_source $source)
 593     {
 594         $object = new ActivityObject();
 595         $wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
 596                            'activity', 'feed', 'mirror', 'twitter', 'facebook');
 597
 598         if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) {
 599             $object->type = ActivityObject::APPLICATION;
 600
 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;
 607             } else {
 608                 // Locally-registered, no URL
 609                 $object->id = TagURI::mint("notice-source:".$source->code);
 610             }
 611
 612             if ($source->url) {
 613                 $object->link = $source->url;
 614             }
 615
 616             if ($source->name) {
 617                 $object->title = $source->name;
 618             } else {
 619                 $object->title = $source->code;
 620             }
 621
 622             if ($source->created) {
 623                 $object->date = $source->created;
 624             }
 625
 626             $object->extra[] = array('status_net', array('source_code' => $source->code));
 627
 628             Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object));
 629         }
 630
 631         return $object;
 632     }
 633
 634     static function fromMessage(Message $message)
 635     {
 636         $object = new ActivityObject();
 637
 638         if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) {
 639
 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;
 644
 645             if ($message->url) {
 646                 $object->link = $message->url;
 647             } else {
 648                 $object->link = common_local_url('showmessage', array('message' => $message->id));
 649             }
 650
 651             $object->extra[] = array('status_net', array('message_id' => $message->id));
 652
 653             Event::handle('EndActivityObjectFromMessage', array($message, &$object));
 654         }
 655
 656         return $object;
 657     }
 658
 659     function outputTo($xo, $tag='activity:object')
 660     {
 661         if (!empty($tag)) {
 662             $xo->elementStart($tag);
 663         }
 664
 665         if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
 666             $xo->element('activity:object-type', null, $this->type);
 667
 668             // <author> uses URI
 669
 670             if ($tag == 'author') {
 671                 $xo->element(self::URI, null, $this->id);
 672             } else {
 673                 $xo->element(self::ID, null, $this->id);
 674             }
 675
 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);
 683                 } else {
 684                     $xo->element(self::TITLE, null, $name);
 685                 }
 686             }
 687
 688             if (!empty($this->summary)) {
 689                 $xo->element(
 690                     self::SUMMARY,
 691                     null,
 692                     common_xml_safe_str($this->summary)
 693                 );
 694             }
 695
 696             if (!empty($this->content)) {
 697                 // XXX: assuming HTML content here
 698                 $xo->element(
 699                     ActivityUtils::CONTENT,
 700                     array('type' => 'html'),
 701                     common_xml_safe_str($this->content)
 702                 );
 703             }
 704
 705             if (!empty($this->link)) {
 706                 $xo->element(
 707                     'link',
 708                     array(
 709                         'rel' => 'alternate',
 710                         'type' => 'text/html',
 711                         'href' => $this->link
 712                     ),
 713                     null
 714                 );
 715             }
 716
 717             if(!empty($this->owner)) {
 718                 $owner = $this->owner->asActivityNoun(self::AUTHOR);
 719                 $xo->raw($owner);
 720             }
 721
 722             if ($this->type == ActivityObject::PERSON
 723                 || $this->type == ActivityObject::GROUP) {
 724
 725                 foreach ($this->avatarLinks as $alink) {
 726                     $xo->element('link',
 727                             array(
 728                                 'rel'          => 'avatar',
 729                                 'type'         => $alink->type,
 730                                 'media:width'  => $alink->width,
 731                                 'media:height' => $alink->height,
 732                                 'href'         => $alink->url,
 733                                 ),
 734                             null);
 735                 }
 736             }
 737
 738             if (!empty($this->geopoint)) {
 739                 $xo->element(
 740                     'georss:point',
 741                     null,
 742                     $this->geopoint
 743                 );
 744             }
 745
 746             if (!empty($this->poco)) {
 747                 $this->poco->outputTo($xo);
 748             }
 749
 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);
 755             }
 756
 757             Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
 758         }
 759
 760         if (!empty($tag)) {
 761             $xo->elementEnd($tag);
 762         }
 763
 764         return;
 765     }
 766
 767     function asString($tag='activity:object')
 768     {
 769         $xs = new XMLStringer(true);
 770
 771         $this->outputTo($xs, $tag);
 772
 773         return $xs->getString();
 774     }
 775
 776     /*
 777      * Returns an array based on this Activity Object suitable for
 778      * encoding as JSON.
 779      *
 780      * @return array $object the activity object array
 781      */
 782
 783     function asArray()
 784     {
 785         $object = array();
 786
 787         if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
 788             // XXX: attachments are added by Activity
 789
 790             // author (Add object for author? Could be useful for repeats.)
 791
 792             // content (Add rendered version of the notice?)
 793
 794             // displayName
 795
 796             if ($this->title) {
 797                 $object['displayName'] = $this->title;
 798             }
 799
 800             // downstreamDuplicates
 801
 802             // id
 803
 804             if ($this->id) {
 805                 $object['id'] = $this->id;
 806             } else if ($this->link) {
 807                 $object['id'] = $this->link;
 808             }
 809
 810             if ($this->type == ActivityObject::PERSON
 811                 || $this->type == ActivityObject::GROUP) {
 812
 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.
 815
 816                 $imgLink          = null;
 817                 $avatarMediaLinks = array();
 818
 819                 foreach ($this->avatarLinks as $a) {
 820
 821                     // Make a MediaLink for every other Avatar
 822                     $avatar = new ActivityStreamsMediaLink(
 823                         $a->url,
 824                         $a->width,
 825                         $a->height,
 826                         $a->type,
 827                         'avatar'
 828                     );
 829
 830                     // Find the big avatar to use as the "image"
 831                     if ($a->height == AVATAR_PROFILE_SIZE) {
 832                         $imgLink = $avatar;
 833                     }
 834
 835                     $avatarMediaLinks[] = $avatar->asArray();
 836                 }
 837
 838                 if (!array_key_exists('status_net', $object)) {
 839                     $object['status_net'] = array();
 840                 }
 841
 842                 $object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
 843
 844                 // image
 845                 if (!empty($imgLink)) {
 846                     $object['image']  = $imgLink->asArray();
 847                 }
 848             }
 849
 850             // objectType
 851             //
 852             // We can probably use the whole schema URL here but probably the
 853             // relative simple name is easier to parse
 854
 855             $object['objectType'] = ActivityObject::canonicalType($this->type);
 856
 857             // summary
 858             $object['summary'] = $this->summary;
 859
 860             // content
 861             $object['content'] = $this->content;
 862
 863             // published (probably don't need. Might be useful for repeats.)
 864
 865             // updated (probably don't need this)
 866
 867             // TODO: upstreamDuplicates
 868
 869             if ($this->link) {
 870                 $object['url'] = $this->link;
 871             }
 872
 873             /* Extensions */
 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
 877
 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();
 885                         }
 886                         $object['status_net'][$parts[1]] = $props;
 887                     } else {
 888                         $object[$objectName] = $props;
 889                     }
 890                 }
 891             }
 892
 893             if (!empty($this->geopoint)) {
 894
 895                 list($lat, $lon) = explode(' ', $this->geopoint);
 896
 897                 if (!empty($lat) && !empty($lon)) {
 898                     $object['location'] = array(
 899                         'objectType' => 'place',
 900                         'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
 901                         'lat' => $lat,
 902                         'lon' => $lon
 903                     );
 904
 905                     $loc = Location::fromLatLon((float)$lat, (float)$lon);
 906
 907                     if ($loc) {
 908                         $name = $loc->getName();
 909
 910                         if ($name) {
 911                             $object['location']['displayName'] = $name;
 912                         }
 913                         $url = $loc->getURL();
 914
 915                         if ($url) {
 916                             $object['location']['url'] = $url;
 917                         }
 918                     }
 919                 }
 920             }
 921
 922             if (!empty($this->poco)) {
 923                 $object['portablecontacts_net'] = array_filter($this->poco->asArray());
 924             }
 925
 926             if (!empty($this->thumbnail)) {
 927                 if (is_string($this->thumbnail)) {
 928                     $object['image'] = array('url' => $this->thumbnail);
 929                 } else {
 930                     $object['image'] = array('url' => $this->thumbnail->url);
 931                     if ($this->thumbnail->width) {
 932                         $object['image']['width'] = $this->thumbnail->width;
 933                     }
 934                     if ($this->thumbnail->height) {
 935                         $object['image']['height'] = $this->thumbnail->height;
 936                     }
 937                 }
 938             }
 939
 940             switch (ActivityObject::canonicalType($this->type)) {
 941             case 'image':
 942                 if (!empty($this->largerImage)) {
 943                     $object['fullImage'] = array('url' => $this->largerImage);
 944                 }
 945                 break;
 946             case 'audio':
 947             case 'video':
 948                 if (!empty($this->stream)) {
 949                     $object['stream'] = array('url' => $this->stream);
 950                 }
 951                 break;
 952             }
 953
 954             Event::handle('EndActivityObjectOutputJson', array($this, &$object));
 955         }
 956         return array_filter($object);
 957     }
 958
 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));
 963         } else {
 964             return $type;
 965         }
 966     }
 967
 968     static function mimeTypeToObjectType($mimeType) {
 969         $ot = null;
 970
 971         // Default
 972
 973         if (empty($mimeType)) {
 974             return self::FILE;
 975         }
 976
 977         $parts = explode('/', $mimeType);
 978
 979         switch ($parts[0]) {
 980         case 'image':
 981             $ot = self::IMAGE;
 982             break;
 983         case 'audio':
 984             $ot = self::AUDIO;
 985             break;
 986         case 'video':
 987             $ot = self::VIDEO;
 988             break;
 989         default:
 990             $ot = self::FILE;
 991         }
 992
 993         return $ot;
 994     }
 995 }