lib/activityobject.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * An activity
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Feed
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * A noun-ish thing in the activity universe
  37  *
  38  * The activity streams spec talks about activity objects, while also having
  39  * a tag activity:object, which is in fact an activity object. Aaaaaah!
  40  *
  41  * This is just a thing in the activity universe. Can be the subject, object,
  42  * or indirect object (target!) of an activity verb. Rotten name, and I'm
  43  * propagating it. *sigh*
  44  *
  45  * @category  OStatus
  46  * @package   StatusNet
  47  * @author    Evan Prodromou <evan@status.net>
  48  * @copyright 2010 StatusNet, Inc.
  49  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  50  * @link      http://status.net/
  51  */
  52
  53 class ActivityObject
  54 {
  55     const ARTICLE   = 'http://activitystrea.ms/schema/1.0/article';
  56     const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
  57     const NOTE      = 'http://activitystrea.ms/schema/1.0/note';
  58     const STATUS    = 'http://activitystrea.ms/schema/1.0/status';
  59     const FILE      = 'http://activitystrea.ms/schema/1.0/file';
  60     const PHOTO     = 'http://activitystrea.ms/schema/1.0/photo';
  61     const ALBUM     = 'http://activitystrea.ms/schema/1.0/photo-album';
  62     const PLAYLIST  = 'http://activitystrea.ms/schema/1.0/playlist';
  63     const VIDEO     = 'http://activitystrea.ms/schema/1.0/video';
  64     const AUDIO     = 'http://activitystrea.ms/schema/1.0/audio';
  65     const BOOKMARK  = 'http://activitystrea.ms/schema/1.0/bookmark';
  66     const PERSON    = 'http://activitystrea.ms/schema/1.0/person';
  67     const GROUP     = 'http://activitystrea.ms/schema/1.0/group';
  68     const PLACE     = 'http://activitystrea.ms/schema/1.0/place';
  69     const COMMENT   = 'http://activitystrea.ms/schema/1.0/comment';
  70     // ^^^^^^^^^^ tea!
  71
  72     // Atom elements we snarf
  73
  74     const TITLE   = 'title';
  75     const SUMMARY = 'summary';
  76     const ID      = 'id';
  77     const SOURCE  = 'source';
  78
  79     const NAME  = 'name';
  80     const URI   = 'uri';
  81     const EMAIL = 'email';
  82
  83     const POSTEROUS   = 'http://posterous.com/help/rss/1.0';
  84     const AUTHOR      = 'author';
  85     const USERIMAGE   = 'userImage';
  86     const PROFILEURL  = 'profileUrl';
  87     const NICKNAME    = 'nickName';
  88     const DISPLAYNAME = 'displayName';
  89
  90     public $element;
  91     public $type;
  92     public $id;
  93     public $title;
  94     public $summary;
  95     public $content;
  96     public $link;
  97     public $source;
  98     public $avatarLinks = array();
  99     public $geopoint;
 100     public $poco;
 101     public $displayName;
 102
 103     // @todo move this stuff to it's own PHOTO activity object
 104     const MEDIA_DESCRIPTION = 'description';
 105
 106     public $thumbnail;
 107     public $largerImage;
 108     public $description;
 109
 110     /**
 111      * Constructor
 112      *
 113      * This probably needs to be refactored
 114      * to generate a local class (ActivityPerson, ActivityFile, ...)
 115      * based on the object type.
 116      *
 117      * @param DOMElement $element DOM thing to turn into an Activity thing
 118      */
 119
 120     function __construct($element = null)
 121     {
 122         if (empty($element)) {
 123             return;
 124         }
 125
 126         $this->element = $element;
 127
 128         $this->geopoint = $this->_childContent(
 129             $element,
 130             ActivityContext::POINT,
 131             ActivityContext::GEORSS
 132         );
 133
 134         if ($element->tagName == 'author') {
 135             $this->_fromAuthor($element);
 136         } else if ($element->tagName == 'item') {
 137             $this->_fromRssItem($element);
 138         } else {
 139             $this->_fromAtomEntry($element);
 140         }
 141
 142         // Some per-type attributes...
 143         if ($this->type == self::PERSON || $this->type == self::GROUP) {
 144             $this->displayName = $this->title;
 145
 146             $photos = ActivityUtils::getLinks($element, 'photo');
 147             if (count($photos)) {
 148                 foreach ($photos as $link) {
 149                     $this->avatarLinks[] = new AvatarLink($link);
 150                 }
 151             } else {
 152                 $avatars = ActivityUtils::getLinks($element, 'avatar');
 153                 foreach ($avatars as $link) {
 154                     $this->avatarLinks[] = new AvatarLink($link);
 155                 }
 156             }
 157
 158             $this->poco = new PoCo($element);
 159         }
 160
 161         if ($this->type == self::PHOTO) {
 162
 163             $this->thumbnail   = ActivityUtils::getLink($element, 'preview');
 164             $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
 165
 166             $this->description = ActivityUtils::childContent(
 167                 $element,
 168                 ActivityObject::MEDIA_DESCRIPTION,
 169                 Activity::MEDIA
 170             );
 171
 172         }
 173     }
 174
 175     private function _fromAuthor($element)
 176     {
 177         $this->type  = self::PERSON; // XXX: is this fair?
 178         $this->title = $this->_childContent($element, self::NAME);
 179
 180         $this->id = $this->_childContent($element, self::URI);
 181
 182         if (empty($this->id)) {
 183             $email = $this->_childContent($element, self::EMAIL);
 184             if (!empty($email)) {
 185                 // XXX: acct: ?
 186                 $this->id = 'mailto:'.$email;
 187             }
 188         }
 189     }
 190
 191     private function _fromAtomEntry($element)
 192     {
 193         $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
 194                                            Activity::SPEC);
 195
 196         if (empty($this->type)) {
 197             $this->type = ActivityObject::NOTE;
 198         }
 199
 200         $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
 201         $this->content = ActivityUtils::getContent($element);
 202
 203         // We don't like HTML in our titles, although it's technically allowed
 204
 205         $title = ActivityUtils::childHtmlContent($element, self::TITLE);
 206
 207         $this->title = html_entity_decode(strip_tags($title));
 208
 209         $this->source  = $this->_getSource($element);
 210
 211         $this->link = ActivityUtils::getPermalink($element);
 212
 213         $this->id = $this->_childContent($element, self::ID);
 214
 215         if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
 216             $this->id = $this->link;
 217         }
 218     }
 219
 220     // @fixme rationalize with Activity::_fromRssItem()
 221
 222     private function _fromRssItem($item)
 223     {
 224         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
 225
 226         $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
 227
 228         if (!empty($contentEl)) {
 229             $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
 230         } else {
 231             $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
 232             if (!empty($descriptionEl)) {
 233                 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
 234             }
 235         }
 236
 237         $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
 238
 239         $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
 240
 241         if (!empty($guidEl)) {
 242             $this->id = $guidEl->textContent;
 243
 244             if ($guidEl->hasAttribute('isPermaLink')) {
 245                 // overwrites <link>
 246                 $this->link = $this->id;
 247             }
 248         }
 249     }
 250
 251     public static function fromRssAuthor($el)
 252     {
 253         $text = $el->textContent;
 254
 255         if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
 256             $email = $match[1];
 257             $name = $match[2];
 258         } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
 259             $name = $match[1];
 260             $email = $match[2];
 261         } else if (preg_match('/.*@.*/', $text)) {
 262             $email = $text;
 263             $name = null;
 264         } else {
 265             $name = $text;
 266             $email = null;
 267         }
 268
 269         // Not really enough info
 270
 271         $obj = new ActivityObject();
 272
 273         $obj->element = $el;
 274
 275         $obj->type  = ActivityObject::PERSON;
 276         $obj->title = $name;
 277
 278         if (!empty($email)) {
 279             $obj->id = 'mailto:'.$email;
 280         }
 281
 282         return $obj;
 283     }
 284
 285     public static function fromDcCreator($el)
 286     {
 287         // Not really enough info
 288
 289         $text = $el->textContent;
 290
 291         $obj = new ActivityObject();
 292
 293         $obj->element = $el;
 294
 295         $obj->title = $text;
 296         $obj->type  = ActivityObject::PERSON;
 297
 298         return $obj;
 299     }
 300
 301     public static function fromRssChannel($el)
 302     {
 303         $obj = new ActivityObject();
 304
 305         $obj->element = $el;
 306
 307         $obj->type = ActivityObject::PERSON; // @fixme guess better
 308
 309         $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
 310         $obj->link  = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
 311         $obj->id    = ActivityUtils::getLink($el, Activity::SELF);
 312
 313         if (empty($obj->id)) {
 314             $obj->id = $obj->link;
 315         }
 316
 317         $desc = ActivityUtils::childContent($el, Activity::DESCRIPTION, Activity::RSS);
 318
 319         if (!empty($desc)) {
 320             $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
 321         }
 322
 323         $imageEl = ActivityUtils::child($el, Activity::IMAGE, Activity::RSS);
 324
 325         if (!empty($imageEl)) {
 326             $url = ActivityUtils::childContent($imageEl, Activity::URL, Activity::RSS);
 327             $al = new AvatarLink();
 328             $al->url = $url;
 329             $obj->avatarLinks[] = $al;
 330         }
 331
 332         return $obj;
 333     }
 334
 335     public static function fromPosterousAuthor($el)
 336     {
 337         $obj = new ActivityObject();
 338
 339         $obj->type = ActivityObject::PERSON; // @fixme any others...?
 340
 341         $userImage = ActivityUtils::childContent($el, self::USERIMAGE, self::POSTEROUS);
 342
 343         if (!empty($userImage)) {
 344             $al = new AvatarLink();
 345             $al->url = $userImage;
 346             $obj->avatarLinks[] = $al;
 347         }
 348
 349         $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
 350         $obj->id   = $obj->link;
 351
 352         $obj->poco = new PoCo();
 353
 354         $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
 355         $obj->poco->displayName       = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
 356
 357         $obj->title = $obj->poco->displayName;
 358
 359         return $obj;
 360     }
 361
 362     private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
 363     {
 364         return ActivityUtils::childContent($element, $tag, $namespace);
 365     }
 366
 367     // Try to get a unique id for the source feed
 368
 369     private function _getSource($element)
 370     {
 371         $sourceEl = ActivityUtils::child($element, 'source');
 372
 373         if (empty($sourceEl)) {
 374             return null;
 375         } else {
 376             $href = ActivityUtils::getLink($sourceEl, 'self');
 377             if (!empty($href)) {
 378                 return $href;
 379             } else {
 380                 return ActivityUtils::childContent($sourceEl, 'id');
 381             }
 382         }
 383     }
 384
 385     static function fromNotice(Notice $notice)
 386     {
 387         $object = new ActivityObject();
 388
 389         $object->type    = ActivityObject::NOTE;
 390
 391         $object->id      = $notice->uri;
 392         $object->title   = $notice->content;
 393         $object->content = $notice->rendered;
 394         $object->link    = $notice->bestUrl();
 395
 396         return $object;
 397     }
 398
 399     static function fromProfile(Profile $profile)
 400     {
 401         $object = new ActivityObject();
 402
 403         $object->type   = ActivityObject::PERSON;
 404         $object->id     = $profile->getUri();
 405         $object->title  = $profile->getBestName();
 406         $object->link   = $profile->profileurl;
 407
 408         $orig = $profile->getOriginalAvatar();
 409
 410         if (!empty($orig)) {
 411             $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
 412         }
 413
 414         $sizes = array(
 415             AVATAR_PROFILE_SIZE,
 416             AVATAR_STREAM_SIZE,
 417             AVATAR_MINI_SIZE
 418         );
 419
 420         foreach ($sizes as $size) {
 421
 422             $alink  = null;
 423             $avatar = $profile->getAvatar($size);
 424
 425             if (!empty($avatar)) {
 426                 $alink = AvatarLink::fromAvatar($avatar);
 427             } else {
 428                 $alink = new AvatarLink();
 429                 $alink->type   = 'image/png';
 430                 $alink->height = $size;
 431                 $alink->width  = $size;
 432                 $alink->url    = Avatar::defaultImage($size);
 433             }
 434
 435             $object->avatarLinks[] = $alink;
 436         }
 437
 438         if (isset($profile->lat) && isset($profile->lon)) {
 439             $object->geopoint = (float)$profile->lat
 440                 . ' ' . (float)$profile->lon;
 441         }
 442
 443         $object->poco = PoCo::fromProfile($profile);
 444
 445         return $object;
 446     }
 447
 448     static function fromGroup($group)
 449     {
 450         $object = new ActivityObject();
 451
 452         $object->type   = ActivityObject::GROUP;
 453         $object->id     = $group->getUri();
 454         $object->title  = $group->getBestName();
 455         $object->link   = $group->getUri();
 456
 457         $object->avatarLinks[] = AvatarLink::fromFilename(
 458             $group->homepage_logo,
 459             AVATAR_PROFILE_SIZE
 460         );
 461
 462         $object->avatarLinks[] = AvatarLink::fromFilename(
 463             $group->stream_logo,
 464             AVATAR_STREAM_SIZE
 465         );
 466
 467         $object->avatarLinks[] = AvatarLink::fromFilename(
 468             $group->mini_logo,
 469             AVATAR_MINI_SIZE
 470         );
 471
 472         $object->poco = PoCo::fromGroup($group);
 473
 474         return $object;
 475     }
 476
 477     function asString($tag='activity:object')
 478     {
 479         $xs = new XMLStringer(true);
 480
 481         $xs->elementStart($tag);
 482
 483         $xs->element('activity:object-type', null, $this->type);
 484
 485         $xs->element(self::ID, null, $this->id);
 486
 487         if (!empty($this->title)) {
 488             $xs->element(
 489                 self::TITLE,
 490                 null,
 491                 common_xml_safe_str($this->title)
 492             );
 493         }
 494
 495         if (!empty($this->summary)) {
 496             $xs->element(
 497                 self::SUMMARY,
 498                 null,
 499                 common_xml_safe_str($this->summary)
 500             );
 501         }
 502
 503         if (!empty($this->content)) {
 504             // XXX: assuming HTML content here
 505             $xs->element(
 506                 ActivityUtils::CONTENT,
 507                 array('type' => 'html'),
 508                 common_xml_safe_str($this->content)
 509             );
 510         }
 511
 512         if (!empty($this->link)) {
 513             $xs->element(
 514                 'link',
 515                 array(
 516                     'rel' => 'alternate',
 517                     'type' => 'text/html',
 518                     'href' => $this->link
 519                 ),
 520                 null
 521             );
 522         }
 523
 524         if ($this->type == ActivityObject::PERSON
 525             || $this->type == ActivityObject::GROUP) {
 526
 527             foreach ($this->avatarLinks as $avatar) {
 528                 $xs->element(
 529                     'link', array(
 530                         'rel'  => 'avatar',
 531                         'type'         => $avatar->type,
 532                         'media:width'  => $avatar->width,
 533                         'media:height' => $avatar->height,
 534                         'href' => $avatar->url
 535                     ),
 536                     null
 537                 );
 538             }
 539         }
 540
 541         if (!empty($this->geopoint)) {
 542             $xs->element(
 543                 'georss:point',
 544                 null,
 545                 $this->geopoint
 546             );
 547         }
 548
 549         if (!empty($this->poco)) {
 550             $xs->raw($this->poco->asString());
 551         }
 552
 553         $xs->elementEnd($tag);
 554
 555         return $xs->getString();
 556     }
 557 }