GitHost.io will be shut down on June 1, 2019. At that point this instance will be unreachable and all data will be irrevocably deleted. More details at https://about.gitlab.com/gitlab-hosted/#githost-is-shutting-down-on-june-1st-2019

activityobject.php 30 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * An activity
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Feed
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @author    Zach Copley <zach@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

35 36
require_once(INSTALLDIR.'/lib/activitystreamjsondocument.php');

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/**
 * A noun-ish thing in the activity universe
 *
 * The activity streams spec talks about activity objects, while also having
 * a tag activity:object, which is in fact an activity object. Aaaaaah!
 *
 * This is just a thing in the activity universe. Can be the subject, object,
 * or indirect object (target!) of an activity verb. Rotten name, and I'm
 * propagating it. *sigh*
 *
 * @category  OStatus
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
 * @link      http://status.net/
 */
class ActivityObject
{
    const ARTICLE   = 'http://activitystrea.ms/schema/1.0/article';
    const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
    const NOTE      = 'http://activitystrea.ms/schema/1.0/note';
    const STATUS    = 'http://activitystrea.ms/schema/1.0/status';
    const FILE      = 'http://activitystrea.ms/schema/1.0/file';
    const PHOTO     = 'http://activitystrea.ms/schema/1.0/photo';
    const ALBUM     = 'http://activitystrea.ms/schema/1.0/photo-album';
    const PLAYLIST  = 'http://activitystrea.ms/schema/1.0/playlist';
    const VIDEO     = 'http://activitystrea.ms/schema/1.0/video';
    const AUDIO     = 'http://activitystrea.ms/schema/1.0/audio';
    const BOOKMARK  = 'http://activitystrea.ms/schema/1.0/bookmark';
    const PERSON    = 'http://activitystrea.ms/schema/1.0/person';
    const GROUP     = 'http://activitystrea.ms/schema/1.0/group';
69
    const _LIST     = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved
70 71 72
    const PLACE     = 'http://activitystrea.ms/schema/1.0/place';
    const COMMENT   = 'http://activitystrea.ms/schema/1.0/comment';
    // ^^^^^^^^^^ 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 80 81 82 83 84 85 86 87 88 89

    // Atom elements we snarf

    const TITLE   = 'title';
    const SUMMARY = 'summary';
    const ID      = 'id';
    const SOURCE  = 'source';

    const NAME  = 'name';
    const URI   = 'uri';
    const EMAIL = 'email';

90 91 92 93 94 95 96
    const POSTEROUS   = 'http://posterous.com/help/rss/1.0';
    const AUTHOR      = 'author';
    const USERIMAGE   = 'userImage';
    const PROFILEURL  = 'profileUrl';
    const NICKNAME    = 'nickName';
    const DISPLAYNAME = 'displayName';

97 98 99 100 101 102
    public $element;
    public $type;
    public $id;
    public $title;
    public $summary;
    public $content;
103
    public $owner;
104
    public $link;
mmn's avatar
mmn committed
105
    public $selfLink;   // think APP (Atom Publishing Protocol)
106 107 108 109 110 111
    public $source;
    public $avatarLinks = array();
    public $geopoint;
    public $poco;
    public $displayName;

Zach Copley's avatar
Zach Copley committed
112 113 114 115 116 117
    // @todo move this stuff to it's own PHOTO activity object
    const MEDIA_DESCRIPTION = 'description';

    public $thumbnail;
    public $largerImage;
    public $description;
118
    public $extra = array();
Zach Copley's avatar
Zach Copley committed
119

120 121
    public $stream;

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    /**
     * Constructor
     *
     * This probably needs to be refactored
     * to generate a local class (ActivityPerson, ActivityFile, ...)
     * based on the object type.
     *
     * @param DOMElement $element DOM thing to turn into an Activity thing
     */
    function __construct($element = null)
    {
        if (empty($element)) {
            return;
        }

        $this->element = $element;

        $this->geopoint = $this->_childContent(
            $element,
            ActivityContext::POINT,
            ActivityContext::GEORSS
        );

        if ($element->tagName == 'author') {
            $this->_fromAuthor($element);
        } else if ($element->tagName == 'item') {
            $this->_fromRssItem($element);
        } else {
            $this->_fromAtomEntry($element);
        }

        // Some per-type attributes...
        if ($this->type == self::PERSON || $this->type == self::GROUP) {
            $this->displayName = $this->title;

            $photos = ActivityUtils::getLinks($element, 'photo');
            if (count($photos)) {
                foreach ($photos as $link) {
                    $this->avatarLinks[] = new AvatarLink($link);
                }
            } else {
                $avatars = ActivityUtils::getLinks($element, 'avatar');
                foreach ($avatars as $link) {
                    $this->avatarLinks[] = new AvatarLink($link);
                }
            }

            $this->poco = new PoCo($element);
        }
Zach Copley's avatar
Zach Copley committed
171 172 173 174 175 176 177 178 179 180 181 182

        if ($this->type == self::PHOTO) {

            $this->thumbnail   = ActivityUtils::getLink($element, 'preview');
            $this->largerImage = ActivityUtils::getLink($element, 'enclosure');

            $this->description = ActivityUtils::childContent(
                $element,
                ActivityObject::MEDIA_DESCRIPTION,
                Activity::MEDIA
            );
        }
183 184 185 186
        if ($this->type == self::_LIST) {
            $owner = ActivityUtils::child($this->element, Activity::AUTHOR, Activity::SPEC);
            $this->owner = new ActivityObject($owner);
        }
187 188 189 190
    }

    private function _fromAuthor($element)
    {
191 192 193 194 195 196 197
        $this->type = $this->_childContent($element,
                                           Activity::OBJECTTYPE,
                                           Activity::SPEC);

        if (empty($this->type)) {
            $this->type = self::PERSON; // XXX: is this fair?
        }
198

199

200
        // Start with <poco::displayName>
201

202 203 204 205 206 207 208 209 210 211
        $this->title = ActivityUtils::childContent($element, PoCo::DISPLAYNAME, PoCo::NS);

        // try falling back to <atom:title>

        if (empty($this->title)) {
            $title = ActivityUtils::childHtmlContent($element, self::TITLE);

            if (!empty($title)) {
                $this->title = common_strip_html($title);
            }
212 213
        }

214
        // fall back to <atom:name> as a last resort
215 216 217 218

        if (empty($this->title)) {
            $this->title = $this->_childContent($element, self::NAME);
        }
219

220 221 222 223 224 225 226 227 228 229 230
        // start with <atom:id>

        $this->id = $this->_childContent($element, self::ID);

        // fall back to <atom:uri>

        if (empty($this->id)) {
            $this->id = $this->_childContent($element, self::URI);
        }

        // fall further back to <atom:email>
231 232 233 234 235 236 237 238

        if (empty($this->id)) {
            $email = $this->_childContent($element, self::EMAIL);
            if (!empty($email)) {
                // XXX: acct: ?
                $this->id = 'mailto:'.$email;
            }
        }
239 240 241 242 243 244 245 246

        $this->link = ActivityUtils::getPermalink($element);

        // fall finally back to <link rel=alternate>

        if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
            $this->id = $this->link;
        }
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
    }

    private function _fromAtomEntry($element)
    {
        $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
                                           Activity::SPEC);

        if (empty($this->type)) {
            $this->type = ActivityObject::NOTE;
        }

        $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
        $this->content = ActivityUtils::getContent($element);

        // We don't like HTML in our titles, although it's technically allowed
262
        $this->title = common_strip_html(ActivityUtils::childHtmlContent($element, self::TITLE));
263 264 265 266

        $this->source  = $this->_getSource($element);

        $this->link = ActivityUtils::getPermalink($element);
mmn's avatar
mmn committed
267
        $this->selfLink = ActivityUtils::getSelfLink($element);
268 269 270 271 272 273

        $this->id = $this->_childContent($element, self::ID);

        if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
            $this->id = $this->link;
        }
274 275
    }

276
    // @todo FIXME: rationalize with Activity::_fromRssItem()
277 278
    private function _fromRssItem($item)
    {
279 280 281 282
        if (empty($this->type)) {
            $this->type = ActivityObject::NOTE;
        }

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
        $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);

        $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);

        if (!empty($contentEl)) {
            $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
        } else {
            $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
            if (!empty($descriptionEl)) {
                $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
            }
        }

        $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);

        $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);

        if (!empty($guidEl)) {
            $this->id = $guidEl->textContent;

303
            if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
                // overwrites <link>
                $this->link = $this->id;
            }
        }
    }

    public static function fromRssAuthor($el)
    {
        $text = $el->textContent;

        if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
            $email = $match[1];
            $name = $match[2];
        } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
            $name = $match[1];
            $email = $match[2];
        } else if (preg_match('/.*@.*/', $text)) {
            $email = $text;
            $name = null;
        } else {
            $name = $text;
            $email = null;
        }

        // Not really enough info

        $obj = new ActivityObject();

        $obj->element = $el;

        $obj->type  = ActivityObject::PERSON;
        $obj->title = $name;

        if (!empty($email)) {
            $obj->id = 'mailto:'.$email;
        }

        return $obj;
    }

    public static function fromDcCreator($el)
    {
        // Not really enough info

        $text = $el->textContent;

        $obj = new ActivityObject();

        $obj->element = $el;

        $obj->title = $text;
        $obj->type  = ActivityObject::PERSON;

        return $obj;
    }

    public static function fromRssChannel($el)
    {
        $obj = new ActivityObject();

        $obj->element = $el;

        $obj->type = ActivityObject::PERSON; // @fixme guess better

        $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
        $obj->link  = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
        $obj->id    = ActivityUtils::getLink($el, Activity::SELF);

        if (empty($obj->id)) {
            $obj->id = $obj->link;
        }

        $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);

        if (!empty($desc)) {
            $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
        }

        $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);

        if (!empty($imageEl)) {
385 386 387 388
            $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
            $al = new AvatarLink();
            $al->url = $url;
            $obj->avatarLinks[] = $al;
389 390 391 392 393
        }

        return $obj;
    }

394 395 396 397 398 399 400 401 402
    public static function fromPosterousAuthor($el)
    {
        $obj = new ActivityObject();

        $obj->type = ActivityObject::PERSON; // @fixme any others...?

        $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);

        if (!empty($userImage)) {
403 404 405
            $al = new AvatarLink();
            $al->url = $userImage;
            $obj->avatarLinks[] = $al;
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
        }

        $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
        $obj->id   = $obj->link;

        $obj->poco = new PoCo();

        $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
        $obj->poco->displayName       = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);

        $obj->title = $obj->poco->displayName;

        return $obj;
    }

421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
    {
        return ActivityUtils::childContent($element, $tag, $namespace);
    }

    // Try to get a unique id for the source feed

    private function _getSource($element)
    {
        $sourceEl = ActivityUtils::child($element, 'source');

        if (empty($sourceEl)) {
            return null;
        } else {
            $href = ActivityUtils::getLink($sourceEl, 'self');
            if (!empty($href)) {
                return $href;
            } else {
                return ActivityUtils::childContent($sourceEl, 'id');
            }
        }
    }

444
    static function fromGroup(User_group $group)
445 446 447
    {
        $object = new ActivityObject();

448
        if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
449

450 451 452 453
            $object->type   = ActivityObject::GROUP;
            $object->id     = $group->getUri();
            $object->title  = $group->getBestName();
            $object->link   = $group->getUri();
454

455 456
            $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
                                                              AVATAR_PROFILE_SIZE);
457

458 459
            $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
                                                              AVATAR_STREAM_SIZE);
460

461 462
            $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
                                                              AVATAR_MINI_SIZE);
463

464 465 466
            $object->poco = PoCo::fromGroup($group);
            Event::handle('EndActivityObjectFromGroup', array($group, &$object));
        }
467 468 469

        return $object;
    }
470

471 472 473 474 475 476 477 478 479 480
    static function fromPeopletag($ptag)
    {
        $object = new ActivityObject();
        if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) {
            $object->type    = ActivityObject::_LIST;

            $object->id      = $ptag->getUri();
            $object->title   = $ptag->tag;
            $object->summary = $ptag->description;
            $object->link    = $ptag->homeUrl();
481
            $object->owner   = Profile::getKV('id', $ptag->tagger);
482
            $object->poco    = PoCo::fromProfile($object->owner);
483
            Event::handle('EndActivityObjectFromPeopletag', array($ptag, &$object));
484 485 486 487
        }
        return $object;
    }

488 489 490 491 492 493 494 495
    static function fromFile(File $file)
    {
        $object = new ActivityObject();

        if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) {

            $object->type = self::mimeTypeToObjectType($file->mimetype);
            $object->id   = TagURI::mint(sprintf("file:%d", $file->id));
496
            $object->link = common_local_url('attachment', array('attachment' => $file->id));
497 498 499 500 501 502 503 504 505

            if ($file->title) {
                $object->title = $file->title;
            }

            if ($file->date) {
                $object->date = $file->date;
            }

506 507
            try {
                $thumbnail = $file->getThumbnail();
508
                $object->thumbnail = $thumbnail;
509 510
            } catch (UseFileAsThumbnailException $e) {
                $object->thumbnail = null;
511 512
            } catch (UnsupportedMediaException $e) {
                $object->thumbnail = null;
513 514
            }

515
            switch (self::canonicalType($object->type)) {
516
            case 'image':
517
                $object->largerImage = $file->getUrl();
518
                break;
519 520
            case 'video':
            case 'audio':
521
                $object->stream = $file->getUrl();
522 523 524 525 526 527 528 529 530
                break;
            }

            Event::handle('EndActivityObjectFromFile', array($file, &$object));
        }

        return $object;
    }

531 532 533
    static function fromNoticeSource(Notice_source $source)
    {
        $object = new ActivityObject();
534 535
        $wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
                           'activity', 'feed', 'mirror', 'twitter', 'facebook');
536 537 538 539

        if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) {
            $object->type = ActivityObject::APPLICATION;

540
            if (in_array($source->code, $wellKnown)) {
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
                // We use one ID for all well-known StatusNet sources
                $object->id = "tag:status.net,2009:notice-source:".$source->code;
            } else if ($source->url) {
                // They registered with an URL
                $object->id = $source->url;
            } else {
                // Locally-registered, no URL
                $object->id = TagURI::mint("notice-source:".$source->code);
            }

            if ($source->url) {
                $object->link = $source->url;
            }

            if ($source->name) {
                $object->title = $source->name;
            } else {
                $object->title = $source->code;
            }

            if ($source->created) {
                $object->date = $source->created;
            }
            
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
            $object->extra[] = array('status_net', array('source_code' => $source->code));

            Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object));
        }

        return $object;
    }

    static function fromMessage(Message $message)
    {
        $object = new ActivityObject();

        if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) {

            $object->type    = ActivityObject::NOTE;
            $object->id      = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
            $object->content = $message->rendered;
            $object->date    = $message->created;
583

584 585 586 587 588 589 590 591
            if ($message->url) {
                $object->link = $message->url;
            } else {
                $object->link = common_local_url('showmessage', array('message' => $message->id));
            }

            $object->extra[] = array('status_net', array('message_id' => $message->id));
            
592
            Event::handle('EndActivityObjectFromMessage', array($message, &$object));
593 594 595 596 597
        }

        return $object;
    }

598 599 600 601 602
    function outputTo($xo, $tag='activity:object')
    {
        if (!empty($tag)) {
            $xo->elementStart($tag);
        }
603

604 605
        if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
            $xo->element('activity:object-type', null, $this->type);
606

607
            // <author> uses URI
608 609

            if ($tag == 'author') {
610
                $xo->element(self::URI, null, $this->id);
611
            } else {
612
                $xo->element(self::ID, null, $this->id);
613
            }
614

615 616 617 618 619 620 621 622 623 624 625
            if (!empty($this->title)) {
                $name = common_xml_safe_str($this->title);
                if ($tag == 'author') {
                    // XXX: Backward compatibility hack -- atom:name should contain
                    // full name here, instead of nickname, i.e.: $name. Change
                    // this in the next version.
                    $xo->element(self::NAME, null, $this->poco->preferredUsername);
                } else {
                    $xo->element(self::TITLE, null, $name);
                }
            }
626

627 628 629 630 631 632 633
            if (!empty($this->summary)) {
                $xo->element(
                    self::SUMMARY,
                    null,
                    common_xml_safe_str($this->summary)
                );
            }
634

635 636
            if (!empty($this->content)) {
                // XXX: assuming HTML content here
637 638
                $xo->element(
                    ActivityUtils::CONTENT,
639 640
                    array('type' => 'html'),
                    common_xml_safe_str($this->content)
641
                );
642
            }
643

644
            if (!empty($this->link)) {
645
                $xo->element(
646 647 648 649 650
                    'link',
                    array(
                        'rel' => 'alternate',
                        'type' => 'text/html',
                        'href' => $this->link
651 652 653 654 655
                    ),
                    null
                );
            }

mmn's avatar
mmn committed
656 657 658 659 660 661 662 663 664 665 666 667
            if (!empty($this->selfLink)) {
                $xo->element(
                    'link',
                    array(
                        'rel' => 'self',
                        'type' => 'application/atom+xml',
                        'href' => $this->selfLink
                    ),
                    null
                );
            }

668 669 670 671
            if(!empty($this->owner)) {
                $owner = $this->owner->asActivityNoun(self::AUTHOR);
                $xo->raw($owner);
            }
672

673 674 675
            if ($this->type == ActivityObject::PERSON
                || $this->type == ActivityObject::GROUP) {

676 677 678 679 680 681 682 683 684 685
                foreach ($this->avatarLinks as $alink) {
                    $xo->element('link',
                            array(
                                'rel'          => 'avatar',
                                'type'         => $alink->type,
                                'media:width'  => $alink->width,
                                'media:height' => $alink->height,
                                'href'         => $alink->url,
                                ),
                            null);
686 687
                }
            }
688

689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
            if (!empty($this->geopoint)) {
                $xo->element(
                    'georss:point',
                    null,
                    $this->geopoint
                );
            }

            if (!empty($this->poco)) {
                $this->poco->outputTo($xo);
            }

            // @fixme there's no way here to make a tree; elements can only contain plaintext
            // @fixme these may collide with JSON extensions
            foreach ($this->extra as $el) {
704
                list($extraTag, $attrs, $content) = array_pad($el, 3, null);
705 706
                $xo->element($extraTag, $attrs, $content);
            }
707

708
            Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
709 710
        }

711 712 713
        if (!empty($tag)) {
            $xo->elementEnd($tag);
        }
714 715

        return;
716
    }
717 718 719 720 721

    function asString($tag='activity:object')
    {
        $xs = new XMLStringer(true);

722
        $this->outputTo($xs, $tag);
723 724 725

        return $xs->getString();
    }
726 727 728 729 730 731 732 733 734 735 736 737

    /*
     * Returns an array based on this Activity Object suitable for
     * encoding as JSON.
     *
     * @return array $object the activity object array
     */

    function asArray()
    {
        $object = array();

738
        if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
739 740 741 742 743
            // XXX: attachments are added by Activity

            // author (Add object for author? Could be useful for repeats.)

            // content (Add rendered version of the notice?)
744

745
            // downstreamDuplicates
746

747
            // id
748 749 750 751 752 753

            if ($this->id) {
                $object['id'] = $this->id;
            } else if ($this->link) {
                $object['id'] = $this->link;
            }
754

755 756
            if ($this->type == ActivityObject::PERSON
                || $this->type == ActivityObject::GROUP) {
757

758 759 760
                // displayName
                $object['displayName'] = $this->title;

761 762
                // XXX: Not sure what the best avatar is to use for the
                // author's "image". For now, I'm using the large size.
763

764
                $imgLink          = null;
765
                $avatarMediaLinks = array();
766

767
                foreach ($this->avatarLinks as $a) {
768

769 770 771 772 773 774 775 776
                    // Make a MediaLink for every other Avatar
                    $avatar = new ActivityStreamsMediaLink(
                        $a->url,
                        $a->width,
                        $a->height,
                        $a->type,
                        'avatar'
                    );
777

778 779 780 781
                    // Find the big avatar to use as the "image"
                    if ($a->height == AVATAR_PROFILE_SIZE) {
                        $imgLink = $avatar;
                    }
782

783 784
                    $avatarMediaLinks[] = $avatar->asArray();
                }
785

786 787 788 789 790
                if (!array_key_exists('status_net', $object)) {
                    $object['status_net'] = array();
                }

                $object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
791

792
                // image
793 794 795
                if (!empty($imgLink)) {
                    $object['image']  = $imgLink->asArray();
                }
796
            }
797

798 799 800 801
            // objectType
            //
            // We can probably use the whole schema URL here but probably the
            // relative simple name is easier to parse
802

803
            $object['objectType'] = self::canonicalType($this->type);
804

805 806
            // summary
            $object['summary'] = $this->summary;
807

808
            // content, usually rendered HTML
809 810 811 812 813
            $object['content'] = $this->content;

            // published (probably don't need. Might be useful for repeats.)

            // updated (probably don't need this)
814

815
            // TODO: upstreamDuplicates
816

817 818 819
            if ($this->link) {
                $object['url'] = $this->link;
            }
820

821 822 823 824
            /* Extensions */
            // @fixme these may collide with XML extensions
            // @fixme multiple tags of same name will overwrite each other
            // @fixme text content from XML extensions will be lost
825

826
            foreach ($this->extra as $e) {
827
                list($objectName, $props, $txt) = array_pad($e, 3, null);
828 829 830 831 832 833 834 835 836 837 838
                if (!empty($objectName)) {
                    $parts = explode(":", $objectName);
                    if (count($parts) == 2 && $parts[0] == "statusnet") {
                        if (!array_key_exists('status_net', $object)) {
                            $object['status_net'] = array();
                        }
                        $object['status_net'][$parts[1]] = $props;
                    } else {
                        $object[$objectName] = $props;
                    }
                }
839
            }
840

841
            if (!empty($this->geopoint)) {
842

843
                list($lat, $lon) = explode(' ', $this->geopoint);
844

845 846 847 848 849 850 851
                if (!empty($lat) && !empty($lon)) {
                    $object['location'] = array(
                        'objectType' => 'place',
                        'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
                        'lat' => $lat,
                        'lon' => $lon
                    );
852

853
                    $loc = Location::fromLatLon((float)$lat, (float)$lon);
854

855 856
                    if ($loc) {
                        $name = $loc->getName();
857

858 859 860 861
                        if ($name) {
                            $object['location']['displayName'] = $name;
                        }
                        $url = $loc->getURL();
862

863 864 865
                        if ($url) {
                            $object['location']['url'] = $url;
                        }
866 867
                    }
                }
868
            }
869

870
            if (!empty($this->poco)) {
871
                $object['portablecontacts_net'] = array_filter($this->poco->asArray());
872
            }
873

874 875 876 877
            if (!empty($this->thumbnail)) {
                if (is_string($this->thumbnail)) {
                    $object['image'] = array('url' => $this->thumbnail);
                } else {
878
                    $object['image'] = array('url' => $this->thumbnail->getUrl());
879 880 881 882 883 884 885 886 887
                    if ($this->thumbnail->width) {
                        $object['image']['width'] = $this->thumbnail->width;
                    }
                    if ($this->thumbnail->height) {
                        $object['image']['height'] = $this->thumbnail->height;
                    }
                }
            }

888
            switch (self::canonicalType($this->type)) {
889
            case 'image':
890 891 892 893
                if (!empty($this->largerImage)) {
                    $object['fullImage'] = array('url' => $this->largerImage);
                }
                break;
894 895
            case 'audio':
            case 'video':
896 897 898 899 900 901
                if (!empty($this->stream)) {
                    $object['stream'] = array('url' => $this->stream);
                }
                break;
            }

902
            Event::handle('EndActivityObjectOutputJson', array($this, &$object));
903
        }
904
        return array_filter($object);
905
    }
906

907 908 909 910 911 912
    public function getIdentifiers() {
        $ids = array();
        foreach(array('id', 'link', 'url') as $id) {
            if (isset($this->$id)) {
                $ids[] = $this->$id;
            }
913
        }
914 915 916 917 918
        return array_unique($ids);
    }

    static function canonicalType($type) {
        return ActivityUtils::resolveUri($type, true);
919
    }
920 921 922

    static function mimeTypeToObjectType($mimeType) {
        $ot = null;
923 924 925 926 927 928 929

        // Default

        if (empty($mimeType)) {
            return self::FILE;
        }

930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
        $parts = explode('/', $mimeType);

        switch ($parts[0]) {
        case 'image':
            $ot = self::IMAGE;
            break;
        case 'audio':
            $ot = self::AUDIO;
            break;
        case 'video':
            $ot = self::VIDEO;
            break;
        default:
            $ot = self::FILE;
        }

        return $ot;
    }
948
}