We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

activityobject.php 17.2 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 35 36 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 69 70 71 72 73 74 75 76 77 78 79 80 81
<?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);
}

/**
 * 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';
    const PLACE     = 'http://activitystrea.ms/schema/1.0/place';
    const COMMENT   = 'http://activitystrea.ms/schema/1.0/comment';
    // ^^^^^^^^^^ tea!

    // 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';

82 83 84 85 86 87 88
    const POSTEROUS   = 'http://posterous.com/help/rss/1.0';
    const AUTHOR      = 'author';
    const USERIMAGE   = 'userImage';
    const PROFILEURL  = 'profileUrl';
    const NICKNAME    = 'nickName';
    const DISPLAYNAME = 'displayName';

89 90 91 92 93 94 95 96 97 98 99 100 101
    public $element;
    public $type;
    public $id;
    public $title;
    public $summary;
    public $content;
    public $link;
    public $source;
    public $avatarLinks = array();
    public $geopoint;
    public $poco;
    public $displayName;

Zach Copley's avatar
Zach Copley committed
102 103 104 105 106 107
    // @todo move this stuff to it's own PHOTO activity object
    const MEDIA_DESCRIPTION = 'description';

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

110 111 112 113 114 115 116 117 118 119 120 121 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
    /**
     * 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
159 160 161 162 163 164 165 166 167 168 169 170

        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
            );
        }
171 172 173 174 175 176
    }

    private function _fromAuthor($element)
    {
        $this->type  = self::PERSON; // XXX: is this fair?
        $this->title = $this->_childContent($element, self::NAME);
177

178
        $this->id = $this->_childContent($element, self::URI);
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204

        if (empty($this->id)) {
            $email = $this->_childContent($element, self::EMAIL);
            if (!empty($email)) {
                // XXX: acct: ?
                $this->id = 'mailto:'.$email;
            }
        }
    }

    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

        $title = ActivityUtils::childHtmlContent($element, self::TITLE);

205
        $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
206 207 208 209

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

        $this->link = ActivityUtils::getPermalink($element);
210 211 212 213 214 215

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

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

218
    // @todo FIXME: rationalize with Activity::_fromRssItem()
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
    private function _fromRssItem($item)
    {
        $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;

            if ($guidEl->hasAttribute('isPermaLink')) {
                // 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)) {
323 324 325 326
            $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
            $al = new AvatarLink();
            $al->url = $url;
            $obj->avatarLinks[] = $al;
327 328 329 330 331
        }

        return $obj;
    }

332 333 334 335 336 337 338 339 340
    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)) {
341 342 343
            $al = new AvatarLink();
            $al->url = $userImage;
            $obj->avatarLinks[] = $al;
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
        }

        $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;
    }

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
    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');
            }
        }
    }

    static function fromNotice(Notice $notice)
    {
        $object = new ActivityObject();
385 386
		
		if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
387

388
			$object->type    = ActivityObject::NOTE;
389

390 391 392 393 394 395 396
			$object->id      = $notice->uri;
			$object->title   = $notice->content;
			$object->content = $notice->rendered;
			$object->link    = $notice->bestUrl();

			Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
		}
397 398 399 400 401 402 403 404

        return $object;
    }

    static function fromProfile(Profile $profile)
    {
        $object = new ActivityObject();

405 406 407 408 409 410 411 412 413 414 415 416 417 418
		if (Event::handle('StartActivityObjectFromProfile', array($profile, &$object))) {

			$object->type   = ActivityObject::PERSON;
			$object->id     = $profile->getUri();
			$object->title  = $profile->getBestName();
			$object->link   = $profile->profileurl;

			$orig = $profile->getOriginalAvatar();

			if (!empty($orig)) {
				$object->avatarLinks[] = AvatarLink::fromAvatar($orig);
			}

			$sizes = array(
419 420 421 422
                AVATAR_PROFILE_SIZE,
                AVATAR_STREAM_SIZE,
                AVATAR_MINI_SIZE
            );
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

			foreach ($sizes as $size) {
				$alink  = null;
				$avatar = $profile->getAvatar($size);

				if (!empty($avatar)) {
					$alink = AvatarLink::fromAvatar($avatar);
				} else {
					$alink = new AvatarLink();
					$alink->type   = 'image/png';
					$alink->height = $size;
					$alink->width  = $size;
					$alink->url    = Avatar::defaultImage($size);

					if ($size == AVATAR_PROFILE_SIZE) {
						// Hack for Twitter import: we don't have a 96x96 image,
						// but we do have a 73x73 image. For now, fake it with that.
						$avatar = $profile->getAvatar(73);
						if ($avatar) {
							$alink = AvatarLink::fromAvatar($avatar);
							$alink->height= $size;
							$alink->width = $size;
						}
					}
				}

				$object->avatarLinks[] = $alink;
			}

			if (isset($profile->lat) && isset($profile->lon)) {
				$object->geopoint = (float)$profile->lat
					. ' ' . (float)$profile->lon;
			}

			$object->poco = PoCo::fromProfile($profile);

			Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
		}
461 462 463 464 465 466 467 468

        return $object;
    }

    static function fromGroup($group)
    {
        $object = new ActivityObject();

469
		if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
470

471 472 473 474
			$object->type   = ActivityObject::GROUP;
			$object->id     = $group->getUri();
			$object->title  = $group->getBestName();
			$object->link   = $group->getUri();
475

476 477
			$object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
															  AVATAR_PROFILE_SIZE);
478

479 480 481 482 483 484 485
			$object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
															  AVATAR_STREAM_SIZE);

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

			$object->poco = PoCo::fromGroup($group);
486

487 488
			Event::handle('EndActivityObjectFromGroup', array($group, &$object));
		}
489 490 491

        return $object;
    }
492 493 494 495 496 497
	
	function outputTo($xo, $tag='activity:object')
	{
		if (!empty($tag)) {
			$xo->elementStart($tag);
		}
498

499
        $xo->element('activity:object-type', null, $this->type);
500

501 502 503 504 505 506 507
        // <author> uses URI

        if ($tag == 'author') {
            $xo->element(self::URI, null, $this->id);
        } else {
            $xo->element(self::ID, null, $this->id);
        }
508 509

        if (!empty($this->title)) {
510 511 512 513 514 515
            $name = common_xml_safe_str($this->title);
            if ($tag == 'author') {
                $xo->element(self::NAME, null, $name);
            } else {
                $xo->element(self::TITLE, null, $name);
            }
516 517 518
        }

        if (!empty($this->summary)) {
519
            $xo->element(
520 521 522 523 524 525 526 527
                self::SUMMARY,
                null,
                common_xml_safe_str($this->summary)
            );
        }

        if (!empty($this->content)) {
            // XXX: assuming HTML content here
528
            $xo->element(
529 530 531 532 533 534 535
                ActivityUtils::CONTENT,
                array('type' => 'html'),
                common_xml_safe_str($this->content)
            );
        }

        if (!empty($this->link)) {
536
            $xo->element(
537 538 539 540 541 542 543 544 545 546 547 548 549 550
                'link',
                array(
                    'rel' => 'alternate',
                    'type' => 'text/html',
                    'href' => $this->link
                ),
                null
            );
        }

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

            foreach ($this->avatarLinks as $avatar) {
551
                $xo->element(
552 553 554 555 556 557 558 559 560 561 562 563 564
                    'link', array(
                        'rel'  => 'avatar',
                        'type'         => $avatar->type,
                        'media:width'  => $avatar->width,
                        'media:height' => $avatar->height,
                        'href' => $avatar->url
                    ),
                    null
                );
            }
        }

        if (!empty($this->geopoint)) {
565
            $xo->element(
566 567 568 569 570 571 572
                'georss:point',
                null,
                $this->geopoint
            );
        }

        if (!empty($this->poco)) {
573
            $this->poco->outputTo($xo);
574 575 576 577 578
        }

        foreach ($this->extra as $el) {
            list($extraTag, $attrs, $content) = $el;
            $xo->element($extraTag, $attrs, $content);
579 580
        }

581 582 583 584 585 586 587 588 589 590 591 592
		if (!empty($tag)) {
			$xo->elementEnd($tag);
		}

        return;
	}

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

		$this->outputTo($xs, $tag);
593 594 595 596

        return $xs->getString();
    }
}