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
 351             if (!($link instanceof DOMElement)) {
 352                 continue;
 353             }
 354
 355             if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) {
 356
 357                 $linkRel = $link->getAttribute(self::REL);
 358                 $linkType = $link->getAttribute(self::TYPE);
 359
 360                 if ($linkRel == $rel &&
 361                     (is_null($type) || $linkType == $type)) {
 362                     return $link->getAttribute(self::HREF);
 363                 }
 364             }
 365         }
 366
 367         return null;
 368     }
 369
 370     static function getLinks(DOMNode $element, $rel, $type=null)
 371     {
 372         $els = $element->childNodes;
 373         $out = array();
 374
 375         foreach ($els as $link) {
 376             if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) {
 377
 378                 $linkRel = $link->getAttribute(self::REL);
 379                 $linkType = $link->getAttribute(self::TYPE);
 380
 381                 if ($linkRel == $rel &&
 382                     (is_null($type) || $linkType == $type)) {
 383                     $out[] = $link;
 384                 }
 385             }
 386         }
 387
 388         return $out;
 389     }
 390
 391     /**
 392      * Gets the first child element with the given tag
 393      *
 394      * @param DOMElement $element   element to pick at
 395      * @param string     $tag       tag to look for
 396      * @param string     $namespace Namespace to look under
 397      *
 398      * @return DOMElement found element or null
 399      */
 400
 401     static function child(DOMNode $element, $tag, $namespace=self::ATOM)
 402     {
 403         $els = $element->childNodes;
 404         if (empty($els) || $els->length == 0) {
 405             return null;
 406         } else {
 407             for ($i = 0; $i < $els->length; $i++) {
 408                 $el = $els->item($i);
 409                 if ($el->localName == $tag && $el->namespaceURI == $namespace) {
 410                     return $el;
 411                 }
 412             }
 413         }
 414     }
 415
 416     /**
 417      * Grab the text content of a DOM element child of the current element
 418      *
 419      * @param DOMElement $element   Element whose children we examine
 420      * @param string     $tag       Tag to look up
 421      * @param string     $namespace Namespace to use, defaults to Atom
 422      *
 423      * @return string content of the child
 424      */
 425
 426     static function childContent(DOMNode $element, $tag, $namespace=self::ATOM)
 427     {
 428         $el = self::child($element, $tag, $namespace);
 429
 430         if (empty($el)) {
 431             return null;
 432         } else {
 433             return $el->textContent;
 434         }
 435     }
 436
 437     /**
 438      * Get the content of an atom:entry-like object
 439      *
 440      * @param DOMElement $element The element to examine.
 441      *
 442      * @return string unencoded HTML content of the element, like "This -&lt; is <b>HTML</b>."
 443      *
 444      * @todo handle remote content
 445      * @todo handle embedded XML mime types
 446      * @todo handle base64-encoded non-XML and non-text mime types
 447      */
 448
 449     static function getContent($element)
 450     {
 451         $contentEl = ActivityUtils::child($element, self::CONTENT);
 452
 453         if (!empty($contentEl)) {
 454
 455             $src  = $contentEl->getAttribute(self::SRC);
 456
 457             if (!empty($src)) {
 458                 throw new ClientException(_("Can't handle remote content yet."));
 459             }
 460
 461             $type = $contentEl->getAttribute(self::TYPE);
 462
 463             // slavishly following http://atompub.org/rfc4287.html#rfc.section.4.1.3.3
 464
 465             if (empty($type) || $type == 'text') {
 466                 return $contentEl->textContent;
 467             } else if ($type == 'html') {
 468                 $text = $contentEl->textContent;
 469                 return htmlspecialchars_decode($text, ENT_QUOTES);
 470             } else if ($type == 'xhtml') {
 471                 $divEl = ActivityUtils::child($contentEl, 'div', 'http://www.w3.org/1999/xhtml');
 472                 if (empty($divEl)) {
 473                     return null;
 474                 }
 475                 $doc = $divEl->ownerDocument;
 476                 $text = '';
 477                 $children = $divEl->childNodes;
 478
 479                 for ($i = 0; $i < $children->length; $i++) {
 480                     $child = $children->item($i);
 481                     $text .= $doc->saveXML($child);
 482                 }
 483                 return trim($text);
 484             } else if (in_array($type, array('text/xml', 'application/xml')) ||
 485                        preg_match('#(+|/)xml$#', $type)) {
 486                 throw new ClientException(_("Can't handle embedded XML content yet."));
 487             } else if (strncasecmp($type, 'text/', 5)) {
 488                 return $contentEl->textContent;
 489             } else {
 490                 throw new ClientException(_("Can't handle embedded Base64 content yet."));
 491             }
 492         }
 493     }
 494 }
 495
 496 // XXX: Arg! This wouldn't be necessary if we used Avatars conistently
 497 class AvatarLink
 498 {
 499     public $url;
 500     public $type;
 501     public $size;
 502     public $width;
 503     public $height;
 504
 505     function __construct($element=null)
 506     {
 507         if ($element) {
 508             // @fixme use correct namespaces
 509             $this->url = $element->getAttribute('href');
 510             $this->type = $element->getAttribute('type');
 511             $width = $element->getAttribute('media:width');
 512             if ($width != null) {
 513                 $this->width = intval($width);
 514             }
 515             $height = $element->getAttribute('media:height');
 516             if ($height != null) {
 517                 $this->height = intval($height);
 518             }
 519         }
 520     }
 521
 522     static function fromAvatar($avatar)
 523     {
 524         if (empty($avatar)) {
 525             return null;
 526         }
 527         $alink = new AvatarLink();
 528         $alink->type   = $avatar->mediatype;
 529         $alink->height = $avatar->height;
 530         $alink->width  = $avatar->width;
 531         $alink->url    = $avatar->displayUrl();
 532         return $alink;
 533     }
 534
 535     static function fromFilename($filename, $size)
 536     {
 537         $alink = new AvatarLink();
 538         $alink->url    = $filename;
 539         $alink->height = $size;
 540         if (!empty($filename)) {
 541             $alink->width  = $size;
 542             $alink->type   = self::mediatype($filename);
 543         } else {
 544             $alink->url    = User_group::defaultLogo($size);
 545             $alink->type   = 'image/png';
 546         }
 547         return $alink;
 548     }
 549
 550     // yuck!
 551     static function mediatype($filename) {
 552         $ext = strtolower(end(explode('.', $filename)));
 553         if ($ext == 'jpeg') {
 554             $ext = 'jpg';
 555         }
 556         // hope we don't support any others
 557         $types = array('png', 'gif', 'jpg', 'jpeg');
 558         if (in_array($ext, $types)) {
 559             return 'image/' . $ext;
 560         }
 561         return null;
 562     }
 563 }
 564
 565 /**
 566  * A noun-ish thing in the activity universe
 567  *
 568  * The activity streams spec talks about activity objects, while also having
 569  * a tag activity:object, which is in fact an activity object. Aaaaaah!
 570  *
 571  * This is just a thing in the activity universe. Can be the subject, object,
 572  * or indirect object (target!) of an activity verb. Rotten name, and I'm
 573  * propagating it. *sigh*
 574  *
 575  * @category  OStatus
 576  * @package   StatusNet
 577  * @author    Evan Prodromou <evan@status.net>
 578  * @copyright 2010 StatusNet, Inc.
 579  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
 580  * @link      http://status.net/
 581  */
 582
 583 class ActivityObject
 584 {
 585     const ARTICLE   = 'http://activitystrea.ms/schema/1.0/article';
 586     const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
 587     const NOTE      = 'http://activitystrea.ms/schema/1.0/note';
 588     const STATUS    = 'http://activitystrea.ms/schema/1.0/status';
 589     const FILE      = 'http://activitystrea.ms/schema/1.0/file';
 590     const PHOTO     = 'http://activitystrea.ms/schema/1.0/photo';
 591     const ALBUM     = 'http://activitystrea.ms/schema/1.0/photo-album';
 592     const PLAYLIST  = 'http://activitystrea.ms/schema/1.0/playlist';
 593     const VIDEO     = 'http://activitystrea.ms/schema/1.0/video';
 594     const AUDIO     = 'http://activitystrea.ms/schema/1.0/audio';
 595     const BOOKMARK  = 'http://activitystrea.ms/schema/1.0/bookmark';
 596     const PERSON    = 'http://activitystrea.ms/schema/1.0/person';
 597     const GROUP     = 'http://activitystrea.ms/schema/1.0/group';
 598     const PLACE     = 'http://activitystrea.ms/schema/1.0/place';
 599     const COMMENT   = 'http://activitystrea.ms/schema/1.0/comment';
 600     // ^^^^^^^^^^ tea!
 601
 602     // Atom elements we snarf
 603
 604     const TITLE   = 'title';
 605     const SUMMARY = 'summary';
 606     const ID      = 'id';
 607     const SOURCE  = 'source';
 608
 609     const NAME  = 'name';
 610     const URI   = 'uri';
 611     const EMAIL = 'email';
 612
 613     public $element;
 614     public $type;
 615     public $id;
 616     public $title;
 617     public $summary;
 618     public $content;
 619     public $link;
 620     public $source;
 621     public $avatarLinks = array();
 622     public $geopoint;
 623     public $poco;
 624     public $displayName;
 625
 626     /**
 627      * Constructor
 628      *
 629      * This probably needs to be refactored
 630      * to generate a local class (ActivityPerson, ActivityFile, ...)
 631      * based on the object type.
 632      *
 633      * @param DOMElement $element DOM thing to turn into an Activity thing
 634      */
 635
 636     function __construct($element = null)
 637     {
 638         if (empty($element)) {
 639             return;
 640         }
 641
 642         $this->element = $element;
 643
 644         $this->geopoint = $this->_childContent(
 645             $element,
 646             ActivityContext::POINT,
 647             ActivityContext::GEORSS
 648         );
 649
 650         if ($element->tagName == 'author') {
 651             $this->_fromAuthor($element);
 652         } else if ($element->tagName == 'item') {
 653             $this->_fromRssItem($element);
 654         } else {
 655             $this->_fromAtomEntry($element);
 656         }
 657
 658         // Some per-type attributes...
 659         if ($this->type == self::PERSON || $this->type == self::GROUP) {
 660             $this->displayName = $this->title;
 661
 662             $photos = ActivityUtils::getLinks($element, 'photo');
 663             if (count($photos)) {
 664                 foreach ($photos as $link) {
 665                     $this->avatarLinks[] = new AvatarLink($link);
 666                 }
 667             } else {
 668                 $avatars = ActivityUtils::getLinks($element, 'avatar');
 669                 foreach ($avatars as $link) {
 670                     $this->avatarLinks[] = new AvatarLink($link);
 671                 }
 672             }
 673
 674             $this->poco = new PoCo($element);
 675         }
 676     }
 677
 678     private function _fromAuthor($element)
 679     {
 680         $this->type  = self::PERSON; // XXX: is this fair?
 681         $this->title = $this->_childContent($element, self::NAME);
 682         $this->id    = $this->_childContent($element, self::URI);
 683
 684         if (empty($this->id)) {
 685             $email = $this->_childContent($element, self::EMAIL);
 686             if (!empty($email)) {
 687                 // XXX: acct: ?
 688                 $this->id = 'mailto:'.$email;
 689             }
 690         }
 691     }
 692
 693     private function _fromAtomEntry($element)
 694     {
 695         $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
 696                                            Activity::SPEC);
 697
 698         if (empty($this->type)) {
 699             $this->type = ActivityObject::NOTE;
 700         }
 701
 702         $this->id      = $this->_childContent($element, self::ID);
 703         $this->title   = $this->_childContent($element, self::TITLE);
 704         $this->summary = $this->_childContent($element, self::SUMMARY);
 705
 706         $this->source  = $this->_getSource($element);
 707
 708         $this->content = ActivityUtils::getContent($element);
 709
 710         $this->link = ActivityUtils::getPermalink($element);
 711     }
 712
 713     // @fixme rationalize with Activity::_fromRssItem()
 714
 715     private function _fromRssItem($item)
 716     {
 717         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
 718
 719         $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
 720
 721         if (!empty($contentEl)) {
 722             $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
 723         } else {
 724             $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
 725             if (!empty($descriptionEl)) {
 726                 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
 727             }
 728         }
 729
 730         $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
 731
 732         $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
 733
 734         if (!empty($guidEl)) {
 735             $this->id = $guidEl->textContent;
 736
 737             if ($guidEl->hasAttribute('isPermaLink')) {
 738                 // overwrites <link>
 739                 $this->link = $this->id;
 740             }
 741         }
 742     }
 743
 744     public static function fromRssAuthor($el)
 745     {
 746         $text = $el->textContent;
 747
 748         if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
 749             $email = $match[1];
 750             $name = $match[2];
 751         } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
 752             $name = $match[1];
 753             $email = $match[2];
 754         } else if (preg_match('/.*@.*/', $text)) {
 755             $email = $text;
 756             $name = null;
 757         } else {
 758             $name = $text;
 759             $email = null;
 760         }
 761
 762         // Not really enough info
 763
 764         $obj = new ActivityObject();
 765
 766         $obj->element = $el;
 767
 768         $obj->type  = ActivityObject::PERSON;
 769         $obj->title = $name;
 770
 771         if (!empty($email)) {
 772             $obj->id = 'mailto:'.$email;
 773         }
 774
 775         return $obj;
 776     }
 777
 778     public static function fromDcCreator($el)
 779     {
 780         // Not really enough info
 781
 782         $text = $el->textContent;
 783
 784         $obj = new ActivityObject();
 785
 786         $obj->element = $el;
 787
 788         $obj->title = $text;
 789         $obj->type  = ActivityObject::PERSON;
 790
 791         return $obj;
 792     }
 793
 794     public static function fromRssChannel($el)
 795     {
 796         $obj = new ActivityObject();
 797
 798         $obj->element = $el;
 799
 800         $obj->type = ActivityObject::PERSON; // @fixme guess better
 801
 802         $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, self::RSS);
 803         $obj->link  = ActivityUtils::childContent($el, ActivityUtils::LINK, self::RSS);
 804         $obj->id    = ActivityUtils::getLink($el, self::SELF);
 805
 806         $desc = ActivityUtils::childContent($el, self::DESCRIPTION, self::RSS);
 807
 808         if (!empty($desc)) {
 809             $obj->content = htmlspecialchars_decode($desc, ENT_QUOTES);
 810         }
 811
 812         $imageEl = ActivityUtils::child($el, self::IMAGE, self::RSS);
 813
 814         if (!empty($imageEl)) {
 815             $obj->avatarLinks[] = ActivityUtils::childContent($imageEl, self::URL, self::RSS);
 816         }
 817
 818         return $obj;
 819     }
 820
 821     private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
 822     {
 823         return ActivityUtils::childContent($element, $tag, $namespace);
 824     }
 825
 826     // Try to get a unique id for the source feed
 827
 828     private function _getSource($element)
 829     {
 830         $sourceEl = ActivityUtils::child($element, 'source');
 831
 832         if (empty($sourceEl)) {
 833             return null;
 834         } else {
 835             $href = ActivityUtils::getLink($sourceEl, 'self');
 836             if (!empty($href)) {
 837                 return $href;
 838             } else {
 839                 return ActivityUtils::childContent($sourceEl, 'id');
 840             }
 841         }
 842     }
 843
 844     static function fromNotice(Notice $notice)
 845     {
 846         $object = new ActivityObject();
 847
 848         $object->type    = ActivityObject::NOTE;
 849
 850         $object->id      = $notice->uri;
 851         $object->title   = $notice->content;
 852         $object->content = $notice->rendered;
 853         $object->link    = $notice->bestUrl();
 854
 855         return $object;
 856     }
 857
 858     static function fromProfile(Profile $profile)
 859     {
 860         $object = new ActivityObject();
 861
 862         $object->type   = ActivityObject::PERSON;
 863         $object->id     = $profile->getUri();
 864         $object->title  = $profile->getBestName();
 865         $object->link   = $profile->profileurl;
 866
 867         $orig = $profile->getOriginalAvatar();
 868
 869         if (!empty($orig)) {
 870             $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
 871         }
 872
 873         $sizes = array(
 874             AVATAR_PROFILE_SIZE,
 875             AVATAR_STREAM_SIZE,
 876             AVATAR_MINI_SIZE
 877         );
 878
 879         foreach ($sizes as $size) {
 880
 881             $alink  = null;
 882             $avatar = $profile->getAvatar($size);
 883
 884             if (!empty($avatar)) {
 885                 $alink = AvatarLink::fromAvatar($avatar);
 886             } else {
 887                 $alink = new AvatarLink();
 888                 $alink->type   = 'image/png';
 889                 $alink->height = $size;
 890                 $alink->width  = $size;
 891                 $alink->url    = Avatar::defaultImage($size);
 892             }
 893
 894             $object->avatarLinks[] = $alink;
 895         }
 896
 897         if (isset($profile->lat) && isset($profile->lon)) {
 898             $object->geopoint = (float)$profile->lat
 899                 . ' ' . (float)$profile->lon;
 900         }
 901
 902         $object->poco = PoCo::fromProfile($profile);
 903
 904         return $object;
 905     }
 906
 907     static function fromGroup($group)
 908     {
 909         $object = new ActivityObject();
 910
 911         $object->type   = ActivityObject::GROUP;
 912         $object->id     = $group->getUri();
 913         $object->title  = $group->getBestName();
 914         $object->link   = $group->getUri();
 915
 916         $object->avatarLinks[] = AvatarLink::fromFilename(
 917             $group->homepage_logo,
 918             AVATAR_PROFILE_SIZE
 919         );
 920
 921         $object->avatarLinks[] = AvatarLink::fromFilename(
 922             $group->stream_logo,
 923             AVATAR_STREAM_SIZE
 924         );
 925
 926         $object->avatarLinks[] = AvatarLink::fromFilename(
 927             $group->mini_logo,
 928             AVATAR_MINI_SIZE
 929         );
 930
 931         $object->poco = PoCo::fromGroup($group);
 932
 933         return $object;
 934     }
 935
 936     function asString($tag='activity:object')
 937     {
 938         $xs = new XMLStringer(true);
 939
 940         $xs->elementStart($tag);
 941
 942         $xs->element('activity:object-type', null, $this->type);
 943
 944         $xs->element(self::ID, null, $this->id);
 945
 946         if (!empty($this->title)) {
 947             $xs->element(
 948                 self::TITLE,
 949                 null,
 950                 common_xml_safe_str($this->title)
 951             );
 952         }
 953
 954         if (!empty($this->summary)) {
 955             $xs->element(
 956                 self::SUMMARY,
 957                 null,
 958                 common_xml_safe_str($this->summary)
 959             );
 960         }
 961
 962         if (!empty($this->content)) {
 963             // XXX: assuming HTML content here
 964             $xs->element(
 965                 ActivityUtils::CONTENT,
 966                 array('type' => 'html'),
 967                 common_xml_safe_str($this->content)
 968             );
 969         }
 970
 971         if (!empty($this->link)) {
 972             $xs->element(
 973                 'link',
 974                 array(
 975                     'rel' => 'alternate',
 976                     'type' => 'text/html',
 977                     'href' => $this->link
 978                 ),
 979                 null
 980             );
 981         }
 982
 983         if ($this->type == ActivityObject::PERSON
 984             || $this->type == ActivityObject::GROUP) {
 985
 986             foreach ($this->avatarLinks as $avatar) {
 987                 $xs->element(
 988                     'link', array(
 989                         'rel'  => 'avatar',
 990                         'type'         => $avatar->type,
 991                         'media:width'  => $avatar->width,
 992                         'media:height' => $avatar->height,
 993                         'href' => $avatar->url
 994                     ),
 995                     null
 996                 );
 997             }
 998         }
 999
1000         if (!empty($this->geopoint)) {
1001             $xs->element(
1002                 'georss:point',
1003                 null,
1004                 $this->geopoint
1005             );
1006         }
1007
1008         if (!empty($this->poco)) {
1009             $xs->raw($this->poco->asString());
1010         }
1011
1012         $xs->elementEnd($tag);
1013
1014         return $xs->getString();
1015     }
1016 }
1017
1018 /**
1019  * Utility class to hold a bunch of constant defining default verb types
1020  *
1021  * @category  OStatus
1022  * @package   StatusNet
1023  * @author    Evan Prodromou <evan@status.net>
1024  * @copyright 2010 StatusNet, Inc.
1025  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
1026  * @link      http://status.net/
1027  */
1028
1029 class ActivityVerb
1030 {
1031     const POST     = 'http://activitystrea.ms/schema/1.0/post';
1032     const SHARE    = 'http://activitystrea.ms/schema/1.0/share';
1033     const SAVE     = 'http://activitystrea.ms/schema/1.0/save';
1034     const FAVORITE = 'http://activitystrea.ms/schema/1.0/favorite';
1035     const PLAY     = 'http://activitystrea.ms/schema/1.0/play';
1036     const FOLLOW   = 'http://activitystrea.ms/schema/1.0/follow';
1037     const FRIEND   = 'http://activitystrea.ms/schema/1.0/make-friend';
1038     const JOIN     = 'http://activitystrea.ms/schema/1.0/join';
1039     const TAG      = 'http://activitystrea.ms/schema/1.0/tag';
1040
1041     // Custom OStatus verbs for the flipside until they're standardized
1042     const DELETE     = 'http://ostatus.org/schema/1.0/unfollow';
1043     const UNFAVORITE = 'http://ostatus.org/schema/1.0/unfavorite';
1044     const UNFOLLOW   = 'http://ostatus.org/schema/1.0/unfollow';
1045     const LEAVE      = 'http://ostatus.org/schema/1.0/leave';
1046
1047     // For simple profile-update pings; no content to share.
1048     const UPDATE_PROFILE = 'http://ostatus.org/schema/1.0/update-profile';
1049 }
1050
1051 class ActivityContext
1052 {
1053     public $replyToID;
1054     public $replyToUrl;
1055     public $location;
1056     public $attention = array();
1057     public $conversation;
1058
1059     const THR     = 'http://purl.org/syndication/thread/1.0';
1060     const GEORSS  = 'http://www.georss.org/georss';
1061     const OSTATUS = 'http://ostatus.org/schema/1.0';
1062
1063     const INREPLYTO = 'in-reply-to';
1064     const REF       = 'ref';
1065     const HREF      = 'href';
1066
1067     const POINT     = 'point';
1068
1069     const ATTENTION    = 'ostatus:attention';
1070     const CONVERSATION = 'ostatus:conversation';
1071
1072     function __construct($element)
1073     {
1074         $replyToEl = ActivityUtils::child($element, self::INREPLYTO, self::THR);
1075
1076         if (!empty($replyToEl)) {
1077             $this->replyToID  = $replyToEl->getAttribute(self::REF);
1078             $this->replyToUrl = $replyToEl->getAttribute(self::HREF);
1079         }
1080
1081         $this->location = $this->getLocation($element);
1082
1083         $this->conversation = ActivityUtils::getLink($element, self::CONVERSATION);
1084
1085         // Multiple attention links allowed
1086
1087         $links = $element->getElementsByTagNameNS(ActivityUtils::ATOM, ActivityUtils::LINK);
1088
1089         for ($i = 0; $i < $links->length; $i++) {
1090
1091             $link = $links->item($i);
1092
1093             $linkRel = $link->getAttribute(ActivityUtils::REL);
1094
1095             if ($linkRel == self::ATTENTION) {
1096                 $this->attention[] = $link->getAttribute(self::HREF);
1097             }
1098         }
1099     }
1100
1101     /**
1102      * Parse location given as a GeoRSS-simple point, if provided.
1103      * http://www.georss.org/simple
1104      *
1105      * @param feed item $entry
1106      * @return mixed Location or false
1107      */
1108     function getLocation($dom)
1109     {
1110         $points = $dom->getElementsByTagNameNS(self::GEORSS, self::POINT);
1111
1112         for ($i = 0; $i < $points->length; $i++) {
1113             $point = $points->item($i)->textContent;
1114             return self::locationFromPoint($point);
1115         }
1116
1117         return null;
1118     }
1119
1120     // XXX: Move to ActivityUtils or Location?
1121     static function locationFromPoint($point)
1122     {
1123         $point = str_replace(',', ' ', $point); // per spec "treat commas as whitespace"
1124         $point = preg_replace('/\s+/', ' ', $point);
1125         $point = trim($point);
1126         $coords = explode(' ', $point);
1127         if (count($coords) == 2) {
1128             list($lat, $lon) = $coords;
1129             if (is_numeric($lat) && is_numeric($lon)) {
1130                 common_log(LOG_INFO, "Looking up location for $lat $lon from georss point");
1131                 return Location::fromLatLon($lat, $lon);
1132             }
1133         }
1134         common_log(LOG_ERR, "Ignoring bogus georss:point value $point");
1135         return null;
1136     }
1137 }
1138
1139 /**
1140  * An activity in the ActivityStrea.ms world
1141  *
1142  * An activity is kind of like a sentence: someone did something
1143  * to something else.
1144  *
1145  * 'someone' is the 'actor'; 'did something' is the verb;
1146  * 'something else' is the object.
1147  *
1148  * @category  OStatus
1149  * @package   StatusNet
1150  * @author    Evan Prodromou <evan@status.net>
1151  * @copyright 2010 StatusNet, Inc.
1152  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
1153  * @link      http://status.net/
1154  */
1155
1156 class Activity
1157 {
1158     const SPEC   = 'http://activitystrea.ms/spec/1.0/';
1159     const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
1160
1161     const VERB       = 'verb';
1162     const OBJECT     = 'object';
1163     const ACTOR      = 'actor';
1164     const SUBJECT    = 'subject';
1165     const OBJECTTYPE = 'object-type';
1166     const CONTEXT    = 'context';
1167     const TARGET     = 'target';
1168
1169     const ATOM = 'http://www.w3.org/2005/Atom';
1170
1171     const AUTHOR    = 'author';
1172     const PUBLISHED = 'published';
1173     const UPDATED   = 'updated';
1174
1175     const RSS = null; // no namespace!
1176
1177     const PUBDATE     = 'pubDate';
1178     const DESCRIPTION = 'description';
1179     const GUID        = 'guid';
1180     const SELF        = 'self';
1181     const IMAGE       = 'image';
1182     const URL         = 'url';
1183
1184     const DC = 'http://purl.org/dc/elements/1.1/';
1185
1186     const CREATOR = 'creator';
1187
1188     const CONTENTNS = 'http://purl.org/rss/1.0/modules/content/';
1189
1190     public $actor;   // an ActivityObject
1191     public $verb;    // a string (the URL)
1192     public $object;  // an ActivityObject
1193     public $target;  // an ActivityObject
1194     public $context; // an ActivityObject
1195     public $time;    // Time of the activity
1196     public $link;    // an ActivityObject
1197     public $entry;   // the source entry
1198     public $feed;    // the source feed
1199
1200     public $summary; // summary of activity
1201     public $content; // HTML content of activity
1202     public $id;      // ID of the activity
1203     public $title;   // title of the activity
1204     public $categories = array(); // list of AtomCategory objects
1205     public $enclosures = array(); // list of enclosure URL references
1206
1207     /**
1208      * Turns a regular old Atom <entry> into a magical activity
1209      *
1210      * @param DOMElement $entry Atom entry to poke at
1211      * @param DOMElement $feed  Atom feed, for context
1212      */
1213
1214     function __construct($entry = null, $feed = null)
1215     {
1216         if (is_null($entry)) {
1217             return;
1218         }
1219
1220         // Insist on a feed's root DOMElement; don't allow a DOMDocument
1221         if ($feed instanceof DOMDocument) {
1222             throw new ClientException(
1223                 _("Expecting a root feed element but got a whole XML document.")
1224             );
1225         }
1226
1227         $this->entry = $entry;
1228         $this->feed  = $feed;
1229
1230         if ($entry->namespaceURI == Activity::ATOM &&
1231             $entry->localName == 'entry') {
1232             $this->_fromAtomEntry($entry, $feed);
1233         } else if ($entry->namespaceURI == Activity::RSS &&
1234                    $entry->localName == 'item') {
1235             $this->_fromRssItem($entry, $feed);
1236         } else {
1237             throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
1238         }
1239     }
1240
1241     function _fromAtomEntry($entry, $feed)
1242     {
1243         $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
1244
1245         if (!empty($pubEl)) {
1246             $this->time = strtotime($pubEl->textContent);
1247         } else {
1248             // XXX technically an error; being liberal. Good idea...?
1249             $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
1250             if (!empty($updateEl)) {
1251                 $this->time = strtotime($updateEl->textContent);
1252             } else {
1253                 $this->time = null;
1254             }
1255         }
1256
1257         $this->link = ActivityUtils::getPermalink($entry);
1258
1259         $verbEl = $this->_child($entry, self::VERB);
1260
1261         if (!empty($verbEl)) {
1262             $this->verb = trim($verbEl->textContent);
1263         } else {
1264             $this->verb = ActivityVerb::POST;
1265             // XXX: do other implied stuff here
1266         }
1267
1268         $objectEl = $this->_child($entry, self::OBJECT);
1269
1270         if (!empty($objectEl)) {
1271             $this->object = new ActivityObject($objectEl);
1272         } else {
1273             $this->object = new ActivityObject($entry);
1274         }
1275
1276         $actorEl = $this->_child($entry, self::ACTOR);
1277
1278         if (!empty($actorEl)) {
1279
1280             $this->actor = new ActivityObject($actorEl);
1281
1282         } else if (!empty($feed) &&
1283                    $subjectEl = $this->_child($feed, self::SUBJECT)) {
1284
1285             $this->actor = new ActivityObject($subjectEl);
1286
1287         } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
1288
1289             $this->actor = new ActivityObject($authorEl);
1290
1291         } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
1292                                                               self::ATOM)) {
1293
1294             $this->actor = new ActivityObject($authorEl);
1295         }
1296
1297         $contextEl = $this->_child($entry, self::CONTEXT);
1298
1299         if (!empty($contextEl)) {
1300             $this->context = new ActivityContext($contextEl);
1301         } else {
1302             $this->context = new ActivityContext($entry);
1303         }
1304
1305         $targetEl = $this->_child($entry, self::TARGET);
1306
1307         if (!empty($targetEl)) {
1308             $this->target = new ActivityObject($targetEl);
1309         }
1310
1311         $this->summary = ActivityUtils::childContent($entry, 'summary');
1312         $this->id      = ActivityUtils::childContent($entry, 'id');
1313         $this->content = ActivityUtils::getContent($entry);
1314
1315         $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
1316         if ($catEls) {
1317             for ($i = 0; $i < $catEls->length; $i++) {
1318                 $catEl = $catEls->item($i);
1319                 $this->categories[] = new AtomCategory($catEl);
1320             }
1321         }
1322
1323         foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
1324             $this->enclosures[] = $link->getAttribute('href');
1325         }
1326     }
1327
1328     function _fromRssItem($item, $rss)
1329     {
1330         $verbEl = $this->_child($item, self::VERB);
1331
1332         if (!empty($verbEl)) {
1333             $this->verb = trim($verbEl->textContent);
1334         } else {
1335             $this->verb = ActivityVerb::POST;
1336             // XXX: do other implied stuff here
1337         }
1338
1339         $pubDateEl = $this->_child($item, self::PUBDATE, self::RSS);
1340
1341         if (!empty($pubDateEl)) {
1342             $this->time = strtotime($pubDateEl->textContent);
1343         }
1344
1345         $authorEl = $this->_child($item, self::AUTHOR, self::RSS);
1346
1347         if (!empty($authorEl)) {
1348             $this->actor = ActivityObject::fromRssAuthor($authorEl);
1349         } else {
1350             $dcCreatorEl = $this->_child($item, self::CREATOR, self::DC);
1351             if (!empty($dcCreatorEl)) {
1352                 $this->actor = ActivityObject::fromDcCreator($dcCreatorEl);
1353             } else if (!empty($rss)) {
1354                 $this->actor = ActivityObject::fromRssChannel($rss);
1355             }
1356         }
1357
1358         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
1359
1360         $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, self::CONTENTNS);
1361
1362         if (!empty($contentEl)) {
1363             $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
1364         } else {
1365             $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
1366             if (!empty($descriptionEl)) {
1367                 $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
1368             }
1369         }
1370
1371         $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, self::RSS);
1372
1373         // @fixme enclosures
1374         // @fixme thumbnails... maybe
1375
1376         $guidEl = ActivityUtils::child($item, self::GUID, self::RSS);
1377
1378         if (!empty($guidEl)) {
1379             $this->id = $guidEl->textContent;
1380
1381             if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
1382                 // overwrites <link>
1383                 $this->link = $this->id;
1384             }
1385         }
1386
1387         $this->object  = new ActivityObject($item);
1388         $this->context = new ActivityContext($item);
1389     }
1390
1391     /**
1392      * Returns an Atom <entry> based on this activity
1393      *
1394      * @return DOMElement Atom entry
1395      */
1396
1397     function toAtomEntry()
1398     {
1399         return null;
1400     }
1401
1402     function asString($namespace=false)
1403     {
1404         $xs = new XMLStringer(true);
1405
1406         if ($namespace) {
1407             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
1408                            'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
1409                            'xmlns:georss' => 'http://www.georss.org/georss',
1410                            'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
1411                            'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
1412                            'xmlns:media' => 'http://purl.org/syndication/atommedia');
1413         } else {
1414             $attrs = array();
1415         }
1416
1417         $xs->elementStart('entry', $attrs);
1418
1419         $xs->element('id', null, $this->id);
1420         $xs->element('title', null, $this->title);
1421         $xs->element('published', null, common_date_iso8601($this->time));
1422         $xs->element('content', array('type' => 'html'), $this->content);
1423
1424         if (!empty($this->summary)) {
1425             $xs->element('summary', null, $this->summary);
1426         }
1427
1428         if (!empty($this->link)) {
1429             $xs->element('link', array('rel' => 'alternate',
1430                                        'type' => 'text/html'),
1431                          $this->link);
1432         }
1433
1434         // XXX: add context
1435
1436         $xs->elementStart('author');
1437         $xs->element('uri', array(), $this->actor->id);
1438         if ($this->actor->title) {
1439             $xs->element('name', array(), $this->actor->title);
1440         }
1441         $xs->elementEnd('author');
1442         $xs->raw($this->actor->asString('activity:actor'));
1443
1444         $xs->element('activity:verb', null, $this->verb);
1445
1446         if ($this->object) {
1447             $xs->raw($this->object->asString());
1448         }
1449
1450         if ($this->target) {
1451             $xs->raw($this->target->asString('activity:target'));
1452         }
1453
1454         foreach ($this->categories as $cat) {
1455             $xs->raw($cat->asString());
1456         }
1457
1458         $xs->elementEnd('entry');
1459
1460         return $xs->getString();
1461     }
1462
1463     private function _child($element, $tag, $namespace=self::SPEC)
1464     {
1465         return ActivityUtils::child($element, $tag, $namespace);
1466     }
1467 }
1468
1469 class AtomCategory
1470 {
1471     public $term;
1472     public $scheme;
1473     public $label;
1474
1475     function __construct($element=null)
1476     {
1477         if ($element && $element->attributes) {
1478             $this->term = $this->extract($element, 'term');
1479             $this->scheme = $this->extract($element, 'scheme');
1480             $this->label = $this->extract($element, 'label');
1481         }
1482     }
1483
1484     protected function extract($element, $attrib)
1485     {
1486         $node = $element->attributes->getNamedItemNS(Activity::ATOM, $attrib);
1487         if ($node) {
1488             return trim($node->textContent);
1489         }
1490         $node = $element->attributes->getNamedItem($attrib);
1491         if ($node) {
1492             return trim($node->textContent);
1493         }
1494         return null;
1495     }
1496
1497     function asString()
1498     {
1499         $attribs = array();
1500         if ($this->term !== null) {
1501             $attribs['term'] = $this->term;
1502         }
1503         if ($this->scheme !== null) {
1504             $attribs['scheme'] = $this->scheme;
1505         }
1506         if ($this->label !== null) {
1507             $attribs['label'] = $this->label;
1508         }
1509         $xs = new XMLStringer();
1510         $xs->element('category', $attribs);
1511         return $xs->asString();
1512     }
1513 }