lib/activity.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 class PoCoURL
  36 {
  37     const URLS      = 'urls';
  38     const TYPE      = 'type';
  39     const VALUE     = 'value';
  40     const PRIMARY   = 'primary';
  41
  42     public $type;
  43     public $value;
  44     public $primary;
  45
  46     function __construct($type, $value, $primary = false)
  47     {
  48         $this->type    = $type;
  49         $this->value   = $value;
  50         $this->primary = $primary;
  51     }
  52
  53     function asString()
  54     {
  55         $xs = new XMLStringer(true);
  56         $xs->elementStart('poco:urls');
  57         $xs->element('poco:type', null, $this->type);
  58         $xs->element('poco:value', null, $this->value);
  59         if (!empty($this->primary)) {
  60             $xs->element('poco:primary', null, 'true');
  61         }
  62         $xs->elementEnd('poco:urls');
  63         return $xs->getString();
  64     }
  65 }
  66
  67 class PoCoAddress
  68 {
  69     const ADDRESS   = 'address';
  70     const FORMATTED = 'formatted';
  71
  72     public $formatted;
  73
  74     // @todo Other address fields
  75
  76     function asString()
  77     {
  78         if (!empty($this->formatted)) {
  79             $xs = new XMLStringer(true);
  80             $xs->elementStart('poco:address');
  81             $xs->element('poco:formatted', null, common_xml_safe_str($this->formatted));
  82             $xs->elementEnd('poco:address');
  83             return $xs->getString();
  84         }
  85
  86         return null;
  87     }
  88 }
  89
  90 class PoCo
  91 {
  92     const NS = 'http://portablecontacts.net/spec/1.0';
  93
  94     const USERNAME     = 'preferredUsername';
  95     const DISPLAYNAME  = 'displayName';
  96     const NOTE         = 'note';
  97
  98     public $preferredUsername;
  99     public $displayName;
 100     public $note;
 101     public $address;
 102     public $urls = array();
 103
 104     function __construct($element = null)
 105     {
 106         if (empty($element)) {
 107             return;
 108         }
 109
 110         $this->preferredUsername = ActivityUtils::childContent(
 111             $element,
 112             self::USERNAME,
 113             self::NS
 114         );
 115
 116         $this->displayName = ActivityUtils::childContent(
 117             $element,
 118             self::DISPLAYNAME,
 119             self::NS
 120         );
 121
 122         $this->note = ActivityUtils::childContent(
 123             $element,
 124             self::NOTE,
 125             self::NS
 126         );
 127
 128         $this->address = $this->_getAddress($element);
 129         $this->urls = $this->_getURLs($element);
 130     }
 131
 132     private function _getURLs($element)
 133     {
 134         $urlEls = $element->getElementsByTagnameNS(self::NS, PoCoURL::URLS);
 135         $urls = array();
 136
 137         foreach ($urlEls as $urlEl) {
 138
 139             $type = ActivityUtils::childContent(
 140                 $urlEl,
 141                 PoCoURL::TYPE,
 142                 PoCo::NS
 143             );
 144
 145             $value = ActivityUtils::childContent(
 146                 $urlEl,
 147                 PoCoURL::VALUE,
 148                 PoCo::NS
 149             );
 150
 151             $primary = ActivityUtils::childContent(
 152                 $urlEl,
 153                 PoCoURL::PRIMARY,
 154                 PoCo::NS
 155             );
 156
 157             $isPrimary = false;
 158
 159             if (isset($primary) && $primary == 'true') {
 160                 $isPrimary = true;
 161             }
 162
 163             // @todo check to make sure a primary hasn't already been added
 164
 165             array_push($urls, new PoCoURL($type, $value, $isPrimary));
 166         }
 167         return $urls;
 168     }
 169
 170     private function _getAddress($element)
 171     {
 172         $addressEl = ActivityUtils::child(
 173             $element,
 174             PoCoAddress::ADDRESS,
 175             PoCo::NS
 176         );
 177
 178         if (!empty($addressEl)) {
 179             $formatted = ActivityUtils::childContent(
 180                 $addressEl,
 181                 PoCoAddress::FORMATTED,
 182                 self::NS
 183             );
 184
 185             if (!empty($formatted)) {
 186                 $address = new PoCoAddress();
 187                 $address->formatted = $formatted;
 188                 return $address;
 189             }
 190         }
 191
 192         return null;
 193     }
 194
 195     function fromProfile($profile)
 196     {
 197         if (empty($profile)) {
 198             return null;
 199         }
 200
 201         $poco = new PoCo();
 202
 203         $poco->preferredUsername = $profile->nickname;
 204         $poco->displayName       = $profile->getBestName();
 205
 206         $poco->note = $profile->bio;
 207
 208         $paddy = new PoCoAddress();
 209         $paddy->formatted = $profile->location;
 210         $poco->address = $paddy;
 211
 212         if (!empty($profile->homepage)) {
 213             array_push(
 214                 $poco->urls,
 215                 new PoCoURL(
 216                     'homepage',
 217                     $profile->homepage,
 218                     true
 219                 )
 220             );
 221         }
 222
 223         return $poco;
 224     }
 225
 226     function fromGroup($group)
 227     {
 228         if (empty($group)) {
 229             return null;
 230         }
 231
 232         $poco = new PoCo();
 233
 234         $poco->preferredUsername = $group->nickname;
 235         $poco->displayName       = $group->getBestName();
 236
 237         $poco->note = $group->description;
 238
 239         $paddy = new PoCoAddress();
 240         $paddy->formatted = $group->location;
 241         $poco->address = $paddy;
 242
 243         if (!empty($group->homepage)) {
 244             array_push(
 245                 $poco->urls,
 246                 new PoCoURL(
 247                     'homepage',
 248                     $group->homepage,
 249                     true
 250                 )
 251             );
 252         }
 253
 254         return $poco;
 255     }
 256
 257     function getPrimaryURL()
 258     {
 259         foreach ($this->urls as $url) {
 260             if ($url->primary) {
 261                 return $url;
 262             }
 263         }
 264     }
 265
 266     function asString()
 267     {
 268         $xs = new XMLStringer(true);
 269         $xs->element(
 270             'poco:preferredUsername',
 271             null,
 272             $this->preferredUsername
 273         );
 274
 275         $xs->element(
 276             'poco:displayName',
 277             null,
 278             $this->displayName
 279         );
 280
 281         if (!empty($this->note)) {
 282             $xs->element('poco:note', null, common_xml_safe_str($this->note));
 283         }
 284
 285         if (!empty($this->address)) {
 286             $xs->raw($this->address->asString());
 287         }
 288
 289         foreach ($this->urls as $url) {
 290             $xs->raw($url->asString());
 291         }
 292
 293         return $xs->getString();
 294     }
 295 }
 296
 297 /**
 298  * Utilities for turning DOMish things into Activityish things
 299  *
 300  * Some common functions that I didn't have the bandwidth to try to factor
 301  * into some kind of reasonable superclass, so just dumped here. Might
 302  * be useful to have an ActivityObject parent class or something.
 303  *
 304  * @category  OStatus
 305  * @package   StatusNet
 306  * @author    Evan Prodromou <evan@status.net>
 307  * @copyright 2010 StatusNet, Inc.
 308  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
 309  * @link      http://status.net/
 310  */
 311
 312 class ActivityUtils
 313 {
 314     const ATOM = 'http://www.w3.org/2005/Atom';
 315
 316     const LINK = 'link';
 317     const REL  = 'rel';
 318     const TYPE = 'type';
 319     const HREF = 'href';
 320
 321     const CONTENT = 'content';
 322     const SRC     = 'src';
 323
 324     /**
 325      * Get the permalink for an Activity object
 326      *
 327      * @param DOMElement $element A DOM element
 328      *
 329      * @return string related link, if any
 330      */
 331
 332     static function getPermalink($element)
 333     {
 334         return self::getLink($element, 'alternate', 'text/html');
 335     }
 336
 337     /**
 338      * Get the permalink for an Activity object
 339      *
 340      * @param DOMElement $element A DOM element
 341      *
 342      * @return string related link, if any
 343      */
 344
 345     static function getLink(DOMNode $element, $rel, $type=null)
 346     {
 347         $els = $element->childNodes;
 348
 349         foreach ($els as $link) {
 350             if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) {
 351
 352                 $linkRel = $link->getAttribute(self::REL);
 353                 $linkType = $link->getAttribute(self::TYPE);
 354
 355                 if ($linkRel == $rel &&
 356                     (is_null($type) || $linkType == $type)) {
 357                     return $link->getAttribute(self::HREF);
 358                 }
 359             }
 360         }
 361
 362         return null;
 363     }
 364
 365     static function getLinks(DOMNode $element, $rel, $type=null)
 366     {
 367         $els = $element->childNodes;
 368         $out = array();
 369
 370         foreach ($els as $link) {
 371             if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) {
 372
 373                 $linkRel = $link->getAttribute(self::REL);
 374                 $linkType = $link->getAttribute(self::TYPE);
 375
 376                 if ($linkRel == $rel &&
 377                     (is_null($type) || $linkType == $type)) {
 378                     $out[] = $link;
 379                 }
 380             }
 381         }
 382
 383         return $out;
 384     }
 385
 386     /**
 387      * Gets the first child element with the given tag
 388      *
 389      * @param DOMElement $element   element to pick at
 390      * @param string     $tag       tag to look for
 391      * @param string     $namespace Namespace to look under
 392      *
 393      * @return DOMElement found element or null
 394      */
 395
 396     static function child(DOMNode $element, $tag, $namespace=self::ATOM)
 397     {
 398         $els = $element->childNodes;
 399         if (empty($els) || $els->length == 0) {
 400             return null;
 401         } else {
 402             for ($i = 0; $i < $els->length; $i++) {
 403                 $el = $els->item($i);
 404                 if ($el->localName == $tag && $el->namespaceURI == $namespace) {
 405                     return $el;
 406                 }
 407             }
 408         }
 409     }
 410
 411     /**
 412      * Grab the text content of a DOM element child of the current element
 413      *
 414      * @param DOMElement $element   Element whose children we examine
 415      * @param string     $tag       Tag to look up
 416      * @param string     $namespace Namespace to use, defaults to Atom
 417      *
 418      * @return string content of the child
 419      */
 420
 421     static function childContent(DOMNode $element, $tag, $namespace=self::ATOM)
 422     {
 423         $el = self::child($element, $tag, $namespace);
 424
 425         if (empty($el)) {
 426             return null;
 427         } else {
 428             return $el->textContent;
 429         }
 430     }
 431
 432     /**
 433      * Get the content of an atom:entry-like object
 434      *
 435      * @param DOMElement $element The element to examine.
 436      *
 437      * @return string unencoded HTML content of the element, like "This -&lt; is <b>HTML</b>."
 438      *
 439      * @todo handle remote content
 440      * @todo handle embedded XML mime types
 441      * @todo handle base64-encoded non-XML and non-text mime types
 442      */
 443
 444     static function getContent($element)
 445     {
 446         $contentEl = ActivityUtils::child($element, self::CONTENT);
 447
 448         if (!empty($contentEl)) {
 449
 450             $src  = $contentEl->getAttribute(self::SRC);
 451
 452             if (!empty($src)) {
 453                 throw new ClientException(_("Can't handle remote content yet."));
 454             }
 455
 456             $type = $contentEl->getAttribute(self::TYPE);
 457
 458             // slavishly following http://atompub.org/rfc4287.html#rfc.section.4.1.3.3
 459
 460             if (empty($type) || $type == 'text') {
 461                 return $contentEl->textContent;
 462             } else if ($type == 'html') {
 463                 $text = $contentEl->textContent;
 464                 return htmlspecialchars_decode($text, ENT_QUOTES);
 465             } else if ($type == 'xhtml') {
 466                 $divEl = ActivityUtils::child($contentEl, 'div', 'http://www.w3.org/1999/xhtml');
 467                 if (empty($divEl)) {
 468                     return null;
 469                 }
 470                 $doc = $divEl->ownerDocument;
 471                 $text = '';
 472                 $children = $divEl->childNodes;
 473
 474                 for ($i = 0; $i < $children->length; $i++) {
 475                     $child = $children->item($i);
 476                     $text .= $doc->saveXML($child);
 477                 }
 478                 return trim($text);
 479             } else if (in_array($type, array('text/xml', 'application/xml')) ||
 480                        preg_match('#(+|/)xml$#', $type)) {
 481                 throw new ClientException(_("Can't handle embedded XML content yet."));
 482             } else if (strncasecmp($type, 'text/', 5)) {
 483                 return $contentEl->textContent;
 484             } else {
 485                 throw new ClientException(_("Can't handle embedded Base64 content yet."));
 486             }
 487         }
 488     }
 489 }
 490
 491 // XXX: Arg! This wouldn't be necessary if we used Avatars conistently
 492 class AvatarLink
 493 {
 494     public $url;
 495     public $type;
 496     public $size;
 497     public $width;
 498     public $height;
 499
 500     function __construct($element=null)
 501     {
 502         if ($element) {
 503             // @fixme use correct namespaces
 504             $this->url = $element->getAttribute('href');
 505             $this->type = $element->getAttribute('type');
 506             $width = $element->getAttribute('media:width');
 507             if ($width != null) {
 508                 $this->width = intval($width);
 509             }
 510             $height = $element->getAttribute('media:height');
 511             if ($height != null) {
 512                 $this->height = intval($height);
 513             }
 514         }
 515     }
 516
 517     static function fromAvatar($avatar)
 518     {
 519         if (empty($avatar)) {
 520             return null;
 521         }
 522         $alink = new AvatarLink();
 523         $alink->type   = $avatar->mediatype;
 524         $alink->height = $avatar->height;
 525         $alink->width  = $avatar->width;
 526         $alink->url    = $avatar->displayUrl();
 527         return $alink;
 528     }
 529
 530     static function fromFilename($filename, $size)
 531     {
 532         $alink = new AvatarLink();
 533         $alink->url    = $filename;
 534         $alink->height = $size;
 535         if (!empty($filename)) {
 536             $alink->width  = $size;
 537             $alink->type   = self::mediatype($filename);
 538         } else {
 539             $alink->url    = User_group::defaultLogo($size);
 540             $alink->type   = 'image/png';
 541         }
 542         return $alink;
 543     }
 544
 545     // yuck!
 546     static function mediatype($filename) {
 547         $ext = strtolower(end(explode('.', $filename)));
 548         if ($ext == 'jpeg') {
 549             $ext = 'jpg';
 550         }
 551         // hope we don't support any others
 552         $types = array('png', 'gif', 'jpg', 'jpeg');
 553         if (in_array($ext, $types)) {
 554             return 'image/' . $ext;
 555         }
 556         return null;
 557     }
 558 }
 559
 560 /**
 561  * A noun-ish thing in the activity universe
 562  *
 563  * The activity streams spec talks about activity objects, while also having
 564  * a tag activity:object, which is in fact an activity object. Aaaaaah!
 565  *
 566  * This is just a thing in the activity universe. Can be the subject, object,
 567  * or indirect object (target!) of an activity verb. Rotten name, and I'm
 568  * propagating it. *sigh*
 569  *
 570  * @category  OStatus
 571  * @package   StatusNet
 572  * @author    Evan Prodromou <evan@status.net>
 573  * @copyright 2010 StatusNet, Inc.
 574  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
 575  * @link      http://status.net/
 576  */
 577
 578 class ActivityObject
 579 {
 580     const ARTICLE   = 'http://activitystrea.ms/schema/1.0/article';
 581     const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
 582     const NOTE      = 'http://activitystrea.ms/schema/1.0/note';
 583     const STATUS    = 'http://activitystrea.ms/schema/1.0/status';
 584     const FILE      = 'http://activitystrea.ms/schema/1.0/file';
 585     const PHOTO     = 'http://activitystrea.ms/schema/1.0/photo';
 586     const ALBUM     = 'http://activitystrea.ms/schema/1.0/photo-album';
 587     const PLAYLIST  = 'http://activitystrea.ms/schema/1.0/playlist';
 588     const VIDEO     = 'http://activitystrea.ms/schema/1.0/video';
 589     const AUDIO     = 'http://activitystrea.ms/schema/1.0/audio';
 590     const BOOKMARK  = 'http://activitystrea.ms/schema/1.0/bookmark';
 591     const PERSON    = 'http://activitystrea.ms/schema/1.0/person';
 592     const GROUP     = 'http://activitystrea.ms/schema/1.0/group';
 593     const PLACE     = 'http://activitystrea.ms/schema/1.0/place';
 594     const COMMENT   = 'http://activitystrea.ms/schema/1.0/comment';
 595     // ^^^^^^^^^^ tea!
 596
 597     // Atom elements we snarf
 598
 599     const TITLE   = 'title';
 600     const SUMMARY = 'summary';
 601     const ID      = 'id';
 602     const SOURCE  = 'source';
 603
 604     const NAME  = 'name';
 605     const URI   = 'uri';
 606     const EMAIL = 'email';
 607
 608     public $element;
 609     public $type;
 610     public $id;
 611     public $title;
 612     public $summary;
 613     public $content;
 614     public $link;
 615     public $source;
 616     public $avatarLinks = array();
 617     public $geopoint;
 618     public $poco;
 619     public $displayName;
 620
 621     /**
 622      * Constructor
 623      *
 624      * This probably needs to be refactored
 625      * to generate a local class (ActivityPerson, ActivityFile, ...)
 626      * based on the object type.
 627      *
 628      * @param DOMElement $element DOM thing to turn into an Activity thing
 629      */
 630
 631     function __construct($element = null)
 632     {
 633         if (empty($element)) {
 634             return;
 635         }
 636
 637         $this->element = $element;
 638
 639         $this->geopoint = $this->_childContent(
 640             $element,
 641             ActivityContext::POINT,
 642             ActivityContext::GEORSS
 643         );
 644
 645         if ($element->tagName == 'author') {
 646
 647             $this->type  = self::PERSON; // XXX: is this fair?
 648             $this->title = $this->_childContent($element, self::NAME);
 649             $this->id    = $this->_childContent($element, self::URI);
 650
 651             if (empty($this->id)) {
 652                 $email = $this->_childContent($element, self::EMAIL);
 653                 if (!empty($email)) {
 654                     // XXX: acct: ?
 655                     $this->id = 'mailto:'.$email;
 656                 }
 657             }
 658
 659         } else {
 660
 661             $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
 662                                                Activity::SPEC);
 663
 664             if (empty($this->type)) {
 665                 $this->type = ActivityObject::NOTE;
 666             }
 667
 668             $this->id      = $this->_childContent($element, self::ID);
 669             $this->title   = $this->_childContent($element, self::TITLE);
 670             $this->summary = $this->_childContent($element, self::SUMMARY);
 671
 672             $this->source  = $this->_getSource($element);
 673
 674             $this->content = ActivityUtils::getContent($element);
 675
 676             $this->link = ActivityUtils::getPermalink($element);
 677
 678         }
 679
 680         // Some per-type attributes...
 681         if ($this->type == self::PERSON || $this->type == self::GROUP) {
 682             $this->displayName = $this->title;
 683
 684             $photos = ActivityUtils::getLinks($element, 'photo');
 685             if (count($photos)) {
 686                 foreach ($photos as $link) {
 687                     $this->avatarLinks[] = new AvatarLink($link);
 688                 }
 689             } else {
 690                 $avatars = ActivityUtils::getLinks($element, 'avatar');
 691                 foreach ($avatars as $link) {
 692                     $this->avatarLinks[] = new AvatarLink($link);
 693                 }
 694             }
 695
 696             $this->poco = new PoCo($element);
 697         }
 698     }
 699
 700     private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
 701     {
 702         return ActivityUtils::childContent($element, $tag, $namespace);
 703     }
 704
 705     // Try to get a unique id for the source feed
 706
 707     private function _getSource($element)
 708     {
 709         $sourceEl = ActivityUtils::child($element, 'source');
 710
 711         if (empty($sourceEl)) {
 712             return null;
 713         } else {
 714             $href = ActivityUtils::getLink($sourceEl, 'self');
 715             if (!empty($href)) {
 716                 return $href;
 717             } else {
 718                 return ActivityUtils::childContent($sourceEl, 'id');
 719             }
 720         }
 721     }
 722
 723     static function fromNotice($notice)
 724     {
 725         $object = new ActivityObject();
 726
 727         $object->type    = ActivityObject::NOTE;
 728
 729         $object->id      = $notice->uri;
 730         $object->title   = $notice->content;
 731         $object->content = $notice->rendered;
 732         $object->link    = $notice->bestUrl();
 733
 734         return $object;
 735     }
 736
 737     static function fromProfile($profile)
 738     {
 739         $object = new ActivityObject();
 740
 741         $object->type   = ActivityObject::PERSON;
 742         $object->id     = $profile->getUri();
 743         $object->title  = $profile->getBestName();
 744         $object->link   = $profile->profileurl;
 745
 746         $orig = $profile->getOriginalAvatar();
 747
 748         if (!empty($orig)) {
 749             $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
 750         }
 751
 752         $sizes = array(
 753             AVATAR_PROFILE_SIZE,
 754             AVATAR_STREAM_SIZE,
 755             AVATAR_MINI_SIZE
 756         );
 757
 758         foreach ($sizes as $size) {
 759
 760             $alink  = null;
 761             $avatar = $profile->getAvatar($size);
 762
 763             if (!empty($avatar)) {
 764                 $alink = AvatarLink::fromAvatar($avatar);
 765             } else {
 766                 $alink = new AvatarLink();
 767                 $alink->type   = 'image/png';
 768                 $alink->height = $size;
 769                 $alink->width  = $size;
 770                 $alink->url    = Avatar::defaultImage($size);
 771             }
 772
 773             $object->avatarLinks[] = $alink;
 774         }
 775
 776         if (isset($profile->lat) && isset($profile->lon)) {
 777             $object->geopoint = (float)$profile->lat
 778                 . ' ' . (float)$profile->lon;
 779         }
 780
 781         $object->poco = PoCo::fromProfile($profile);
 782
 783         return $object;
 784     }
 785
 786     static function fromGroup($group)
 787     {
 788         $object = new ActivityObject();
 789
 790         $object->type   = ActivityObject::GROUP;
 791         $object->id     = $group->getUri();
 792         $object->title  = $group->getBestName();
 793         $object->link   = $group->getUri();
 794
 795         $object->avatarLinks[] = AvatarLink::fromFilename(
 796             $group->homepage_logo,
 797             AVATAR_PROFILE_SIZE
 798         );
 799
 800         $object->avatarLinks[] = AvatarLink::fromFilename(
 801             $group->stream_logo,
 802             AVATAR_STREAM_SIZE
 803         );
 804
 805         $object->avatarLinks[] = AvatarLink::fromFilename(
 806             $group->mini_logo,
 807             AVATAR_MINI_SIZE
 808         );
 809
 810         $object->poco = PoCo::fromGroup($group);
 811
 812         return $object;
 813     }
 814
 815     function asString($tag='activity:object')
 816     {
 817         $xs = new XMLStringer(true);
 818
 819         $xs->elementStart($tag);
 820
 821         $xs->element('activity:object-type', null, $this->type);
 822
 823         $xs->element(self::ID, null, $this->id);
 824
 825         if (!empty($this->title)) {
 826             $xs->element(
 827                 self::TITLE,
 828                 null,
 829                 common_xml_safe_str($this->title)
 830             );
 831         }
 832
 833         if (!empty($this->summary)) {
 834             $xs->element(
 835                 self::SUMMARY,
 836                 null,
 837                 common_xml_safe_str($this->summary)
 838             );
 839         }
 840
 841         if (!empty($this->content)) {
 842             // XXX: assuming HTML content here
 843             $xs->element(
 844                 ActivityUtils::CONTENT,
 845                 array('type' => 'html'),
 846                 common_xml_safe_str($this->content)
 847             );
 848         }
 849
 850         if (!empty($this->link)) {
 851             $xs->element(
 852                 'link',
 853                 array(
 854                     'rel' => 'alternate',
 855                     'type' => 'text/html',
 856                     'href' => $this->link
 857                 ),
 858                 null
 859             );
 860         }
 861
 862         if ($this->type == ActivityObject::PERSON
 863             || $this->type == ActivityObject::GROUP) {
 864
 865             foreach ($this->avatarLinks as $avatar) {
 866                 $xs->element(
 867                     'link', array(
 868                         'rel'  => 'avatar',
 869                         'type'         => $avatar->type,
 870                         'media:width'  => $avatar->width,
 871                         'media:height' => $avatar->height,
 872                         'href' => $avatar->url
 873                     ),
 874                     null
 875                 );
 876             }
 877         }
 878
 879         if (!empty($this->geopoint)) {
 880             $xs->element(
 881                 'georss:point',
 882                 null,
 883                 $this->geopoint
 884             );
 885         }
 886
 887         if (!empty($this->poco)) {
 888             $xs->raw($this->poco->asString());
 889         }
 890
 891         $xs->elementEnd($tag);
 892
 893         return $xs->getString();
 894     }
 895 }
 896
 897 /**
 898  * Utility class to hold a bunch of constant defining default verb types
 899  *
 900  * @category  OStatus
 901  * @package   StatusNet
 902  * @author    Evan Prodromou <evan@status.net>
 903  * @copyright 2010 StatusNet, Inc.
 904  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
 905  * @link      http://status.net/
 906  */
 907
 908 class ActivityVerb
 909 {
 910     const POST     = 'http://activitystrea.ms/schema/1.0/post';
 911     const SHARE    = 'http://activitystrea.ms/schema/1.0/share';
 912     const SAVE     = 'http://activitystrea.ms/schema/1.0/save';
 913     const FAVORITE = 'http://activitystrea.ms/schema/1.0/favorite';
 914     const PLAY     = 'http://activitystrea.ms/schema/1.0/play';
 915     const FOLLOW   = 'http://activitystrea.ms/schema/1.0/follow';
 916     const FRIEND   = 'http://activitystrea.ms/schema/1.0/make-friend';
 917     const JOIN     = 'http://activitystrea.ms/schema/1.0/join';
 918     const TAG      = 'http://activitystrea.ms/schema/1.0/tag';
 919
 920     // Custom OStatus verbs for the flipside until they're standardized
 921     const DELETE     = 'http://ostatus.org/schema/1.0/unfollow';
 922     const UNFAVORITE = 'http://ostatus.org/schema/1.0/unfavorite';
 923     const UNFOLLOW   = 'http://ostatus.org/schema/1.0/unfollow';
 924     const LEAVE      = 'http://ostatus.org/schema/1.0/leave';
 925
 926     // For simple profile-update pings; no content to share.
 927     const UPDATE_PROFILE = 'http://ostatus.org/schema/1.0/update-profile';
 928 }
 929
 930 class ActivityContext
 931 {
 932     public $replyToID;
 933     public $replyToUrl;
 934     public $location;
 935     public $attention = array();
 936     public $conversation;
 937
 938     const THR     = 'http://purl.org/syndication/thread/1.0';
 939     const GEORSS  = 'http://www.georss.org/georss';
 940     const OSTATUS = 'http://ostatus.org/schema/1.0';
 941
 942     const INREPLYTO = 'in-reply-to';
 943     const REF       = 'ref';
 944     const HREF      = 'href';
 945
 946     const POINT     = 'point';
 947
 948     const ATTENTION    = 'ostatus:attention';
 949     const CONVERSATION = 'ostatus:conversation';
 950
 951     function __construct($element)
 952     {
 953         $replyToEl = ActivityUtils::child($element, self::INREPLYTO, self::THR);
 954
 955         if (!empty($replyToEl)) {
 956             $this->replyToID  = $replyToEl->getAttribute(self::REF);
 957             $this->replyToUrl = $replyToEl->getAttribute(self::HREF);
 958         }
 959
 960         $this->location = $this->getLocation($element);
 961
 962         $this->conversation = ActivityUtils::getLink($element, self::CONVERSATION);
 963
 964         // Multiple attention links allowed
 965
 966         $links = $element->getElementsByTagNameNS(ActivityUtils::ATOM, ActivityUtils::LINK);
 967
 968         for ($i = 0; $i < $links->length; $i++) {
 969
 970             $link = $links->item($i);
 971
 972             $linkRel = $link->getAttribute(ActivityUtils::REL);
 973
 974             if ($linkRel == self::ATTENTION) {
 975                 $this->attention[] = $link->getAttribute(self::HREF);
 976             }
 977         }
 978     }
 979
 980     /**
 981      * Parse location given as a GeoRSS-simple point, if provided.
 982      * http://www.georss.org/simple
 983      *
 984      * @param feed item $entry
 985      * @return mixed Location or false
 986      */
 987     function getLocation($dom)
 988     {
 989         $points = $dom->getElementsByTagNameNS(self::GEORSS, self::POINT);
 990
 991         for ($i = 0; $i < $points->length; $i++) {
 992             $point = $points->item($i)->textContent;
 993             return self::locationFromPoint($point);
 994         }
 995
 996         return null;
 997     }
 998
 999     // XXX: Move to ActivityUtils or Location?
1000     static function locationFromPoint($point)
1001     {
1002         $point = str_replace(',', ' ', $point); // per spec "treat commas as whitespace"
1003         $point = preg_replace('/\s+/', ' ', $point);
1004         $point = trim($point);
1005         $coords = explode(' ', $point);
1006         if (count($coords) == 2) {
1007             list($lat, $lon) = $coords;
1008             if (is_numeric($lat) && is_numeric($lon)) {
1009                 common_log(LOG_INFO, "Looking up location for $lat $lon from georss point");
1010                 return Location::fromLatLon($lat, $lon);
1011             }
1012         }
1013         common_log(LOG_ERR, "Ignoring bogus georss:point value $point");
1014         return null;
1015     }
1016 }
1017
1018 /**
1019  * An activity in the ActivityStrea.ms world
1020  *
1021  * An activity is kind of like a sentence: someone did something
1022  * to something else.
1023  *
1024  * 'someone' is the 'actor'; 'did something' is the verb;
1025  * 'something else' is the object.
1026  *
1027  * @category  OStatus
1028  * @package   StatusNet
1029  * @author    Evan Prodromou <evan@status.net>
1030  * @copyright 2010 StatusNet, Inc.
1031  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
1032  * @link      http://status.net/
1033  */
1034
1035 class Activity
1036 {
1037     const SPEC   = 'http://activitystrea.ms/spec/1.0/';
1038     const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
1039
1040     const VERB       = 'verb';
1041     const OBJECT     = 'object';
1042     const ACTOR      = 'actor';
1043     const SUBJECT    = 'subject';
1044     const OBJECTTYPE = 'object-type';
1045     const CONTEXT    = 'context';
1046     const TARGET     = 'target';
1047
1048     const ATOM = 'http://www.w3.org/2005/Atom';
1049
1050     const AUTHOR    = 'author';
1051     const PUBLISHED = 'published';
1052     const UPDATED   = 'updated';
1053
1054     public $actor;   // an ActivityObject
1055     public $verb;    // a string (the URL)
1056     public $object;  // an ActivityObject
1057     public $target;  // an ActivityObject
1058     public $context; // an ActivityObject
1059     public $time;    // Time of the activity
1060     public $link;    // an ActivityObject
1061     public $entry;   // the source entry
1062     public $feed;    // the source feed
1063
1064     public $summary; // summary of activity
1065     public $content; // HTML content of activity
1066     public $id;      // ID of the activity
1067     public $title;   // title of the activity
1068     public $categories = array(); // list of AtomCategory objects
1069     public $enclosures = array(); // list of enclosure URL references
1070
1071     /**
1072      * Turns a regular old Atom <entry> into a magical activity
1073      *
1074      * @param DOMElement $entry Atom entry to poke at
1075      * @param DOMElement $feed  Atom feed, for context
1076      */
1077
1078     function __construct($entry = null, $feed = null)
1079     {
1080         if (is_null($entry)) {
1081             return;
1082         }
1083
1084         $this->entry = $entry;
1085
1086         // @fixme Don't send in a DOMDocument
1087         if ($feed instanceof DOMDocument) {
1088             common_log(
1089                 LOG_WARNING,
1090                 'Activity::__construct() - '
1091                 . 'DOMDocument passed in for feed by mistake. '
1092                 . "Expecting a 'feed' DOMElement."
1093             );
1094             $feed = $feed->getElementsByTagName('feed')->item(0);
1095         }
1096
1097         $this->feed  = $feed;
1098
1099         $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
1100
1101         if (!empty($pubEl)) {
1102             $this->time = strtotime($pubEl->textContent);
1103         } else {
1104             // XXX technically an error; being liberal. Good idea...?
1105             $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
1106             if (!empty($updateEl)) {
1107                 $this->time = strtotime($updateEl->textContent);
1108             } else {
1109                 $this->time = null;
1110             }
1111         }
1112
1113         $this->link = ActivityUtils::getPermalink($entry);
1114
1115         $verbEl = $this->_child($entry, self::VERB);
1116
1117         if (!empty($verbEl)) {
1118             $this->verb = trim($verbEl->textContent);
1119         } else {
1120             $this->verb = ActivityVerb::POST;
1121             // XXX: do other implied stuff here
1122         }
1123
1124         $objectEl = $this->_child($entry, self::OBJECT);
1125
1126         if (!empty($objectEl)) {
1127             $this->object = new ActivityObject($objectEl);
1128         } else {
1129             $this->object = new ActivityObject($entry);
1130         }
1131
1132         $actorEl = $this->_child($entry, self::ACTOR);
1133
1134         if (!empty($actorEl)) {
1135
1136             $this->actor = new ActivityObject($actorEl);
1137
1138         } else if (!empty($feed) &&
1139                    $subjectEl = $this->_child($feed, self::SUBJECT)) {
1140
1141             $this->actor = new ActivityObject($subjectEl);
1142
1143         } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
1144
1145             $this->actor = new ActivityObject($authorEl);
1146
1147         } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
1148                                                               self::ATOM)) {
1149
1150             $this->actor = new ActivityObject($authorEl);
1151         }
1152
1153         $contextEl = $this->_child($entry, self::CONTEXT);
1154
1155         if (!empty($contextEl)) {
1156             $this->context = new ActivityContext($contextEl);
1157         } else {
1158             $this->context = new ActivityContext($entry);
1159         }
1160
1161         $targetEl = $this->_child($entry, self::TARGET);
1162
1163         if (!empty($targetEl)) {
1164             $this->target = new ActivityObject($targetEl);
1165         }
1166
1167         $this->summary = ActivityUtils::childContent($entry, 'summary');
1168         $this->id      = ActivityUtils::childContent($entry, 'id');
1169         $this->content = ActivityUtils::getContent($entry);
1170
1171         $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
1172         if ($catEls) {
1173             for ($i = 0; $i < $catEls->length; $i++) {
1174                 $catEl = $catEls->item($i);
1175                 $this->categories[] = new AtomCategory($catEl);
1176             }
1177         }
1178
1179         foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
1180             $this->enclosures[] = $link->getAttribute('href');
1181         }
1182     }
1183
1184     /**
1185      * Returns an Atom <entry> based on this activity
1186      *
1187      * @return DOMElement Atom entry
1188      */
1189
1190     function toAtomEntry()
1191     {
1192         return null;
1193     }
1194
1195     function asString($namespace=false)
1196     {
1197         $xs = new XMLStringer(true);
1198
1199         if ($namespace) {
1200             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1201                            'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1202                            'xmlns:georss' => 'http://www.georss.org/georss',
1203                            'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
1204                            'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1205                            'xmlns:media' => 'http://purl.org/syndication/atommedia');
1206         } else {
1207             $attrs = array();
1208         }
1209
1210         $xs->elementStart('entry', $attrs);
1211
1212         $xs->element('id', null, $this->id);
1213         $xs->element('title', null, $this->title);
1214         $xs->element('published', null, common_date_iso8601($this->time));
1215         $xs->element('content', array('type' => 'html'), $this->content);
1216
1217         if (!empty($this->summary)) {
1218             $xs->element('summary', null, $this->summary);
1219         }
1220
1221         if (!empty($this->link)) {
1222             $xs->element('link', array('rel' => 'alternate',
1223                                        'type' => 'text/html'),
1224                          $this->link);
1225         }
1226
1227         // XXX: add context
1228
1229         $xs->elementStart('author');
1230         $xs->element('uri', array(), $this->actor->id);
1231         if ($this->actor->title) {
1232             $xs->element('name', array(), $this->actor->title);
1233         }
1234         $xs->elementEnd('author');
1235         $xs->raw($this->actor->asString('activity:actor'));
1236
1237         $xs->element('activity:verb', null, $this->verb);
1238
1239         if ($this->object) {
1240             $xs->raw($this->object->asString());
1241         }
1242
1243         if ($this->target) {
1244             $xs->raw($this->target->asString('activity:target'));
1245         }
1246
1247         foreach ($this->categories as $cat) {
1248             $xs->raw($cat->asString());
1249         }
1250
1251         $xs->elementEnd('entry');
1252
1253         return $xs->getString();
1254     }
1255
1256     private function _child($element, $tag, $namespace=self::SPEC)
1257     {
1258         return ActivityUtils::child($element, $tag, $namespace);
1259     }
1260 }
1261
1262 class AtomCategory
1263 {
1264     public $term;
1265     public $scheme;
1266     public $label;
1267
1268     function __construct($element=null)
1269     {
1270         if ($element && $element->attributes) {
1271             $this->term = $this->extract($element, 'term');
1272             $this->scheme = $this->extract($element, 'scheme');
1273             $this->label = $this->extract($element, 'label');
1274         }
1275     }
1276
1277     protected function extract($element, $attrib)
1278     {
1279         $node = $element->attributes->getNamedItemNS(Activity::ATOM, $attrib);
1280         if ($node) {
1281             return trim($node->textContent);
1282         }
1283         $node = $element->attributes->getNamedItem($attrib);
1284         if ($node) {
1285             return trim($node->textContent);
1286         }
1287         return null;
1288     }
1289
1290     function asString()
1291     {
1292         $attribs = array();
1293         if ($this->term !== null) {
1294             $attribs['term'] = $this->term;
1295         }
1296         if ($this->scheme !== null) {
1297             $attribs['scheme'] = $this->scheme;
1298         }
1299         if ($this->label !== null) {
1300             $attribs['label'] = $this->label;
1301         }
1302         $xs = new XMLStringer();
1303         $xs->element('category', $attribs);
1304         return $xs->asString();
1305     }
1306 }