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