plugins/OStatus/classes/Ostatus_profile.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2009-2010, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET')) {
  21     exit(1);
  22 }
  23
  24 /**
  25  * @package OStatusPlugin
  26  * @maintainer Brion Vibber <brion@status.net>
  27  */
  28 class Ostatus_profile extends Memcached_DataObject
  29 {
  30     public $__table = 'ostatus_profile';
  31
  32     public $uri;
  33
  34     public $profile_id;
  35     public $group_id;
  36
  37     public $feeduri;
  38     public $salmonuri;
  39     public $avatar; // remote URL of the last avatar we saved
  40
  41     public $created;
  42     public $modified;
  43
  44     public /*static*/ function staticGet($k, $v=null)
  45     {
  46         return parent::staticGet(__CLASS__, $k, $v);
  47     }
  48
  49     /**
  50      * return table definition for DB_DataObject
  51      *
  52      * DB_DataObject needs to know something about the table to manipulate
  53      * instances. This method provides all the DB_DataObject needs to know.
  54      *
  55      * @return array array of column definitions
  56      */
  57     function table()
  58     {
  59         return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  60                      'profile_id' => DB_DATAOBJECT_INT,
  61                      'group_id' => DB_DATAOBJECT_INT,
  62                      'feeduri' => DB_DATAOBJECT_STR,
  63                      'salmonuri' =>  DB_DATAOBJECT_STR,
  64                      'avatar' =>  DB_DATAOBJECT_STR,
  65                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
  66                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  67     }
  68
  69     static function schemaDef()
  70     {
  71         return array(new ColumnDef('uri', 'varchar',
  72                                    255, false, 'PRI'),
  73                      new ColumnDef('profile_id', 'integer',
  74                                    null, true, 'UNI'),
  75                      new ColumnDef('group_id', 'integer',
  76                                    null, true, 'UNI'),
  77                      new ColumnDef('feeduri', 'varchar',
  78                                    255, true, 'UNI'),
  79                      new ColumnDef('salmonuri', 'text',
  80                                    null, true),
  81                      new ColumnDef('avatar', 'text',
  82                                    null, true),
  83                      new ColumnDef('created', 'datetime',
  84                                    null, false),
  85                      new ColumnDef('modified', 'datetime',
  86                                    null, false));
  87     }
  88
  89     /**
  90      * return key definitions for DB_DataObject
  91      *
  92      * DB_DataObject needs to know about keys that the table has; this function
  93      * defines them.
  94      *
  95      * @return array key definitions
  96      */
  97     function keys()
  98     {
  99         return array_keys($this->keyTypes());
 100     }
 101
 102     /**
 103      * return key definitions for Memcached_DataObject
 104      *
 105      * Our caching system uses the same key definitions, but uses a different
 106      * method to get them.
 107      *
 108      * @return array key definitions
 109      */
 110     function keyTypes()
 111     {
 112         return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
 113     }
 114
 115     function sequenceKey()
 116     {
 117         return array(false, false, false);
 118     }
 119
 120     /**
 121      * Fetch the StatusNet-side profile for this feed
 122      * @return Profile
 123      */
 124     public function localProfile()
 125     {
 126         if ($this->profile_id) {
 127             return Profile::staticGet('id', $this->profile_id);
 128         }
 129         return null;
 130     }
 131
 132     /**
 133      * Fetch the StatusNet-side profile for this feed
 134      * @return Profile
 135      */
 136     public function localGroup()
 137     {
 138         if ($this->group_id) {
 139             return User_group::staticGet('id', $this->group_id);
 140         }
 141         return null;
 142     }
 143
 144     /**
 145      * Returns an ActivityObject describing this remote user or group profile.
 146      * Can then be used to generate Atom chunks.
 147      *
 148      * @return ActivityObject
 149      */
 150     function asActivityObject()
 151     {
 152         if ($this->isGroup()) {
 153             return ActivityObject::fromGroup($this->localGroup());
 154         } else {
 155             return ActivityObject::fromProfile($this->localProfile());
 156         }
 157     }
 158
 159     /**
 160      * Returns an XML string fragment with profile information as an
 161      * Activity Streams noun object with the given element type.
 162      *
 163      * Assumes that 'activity' namespace has been previously defined.
 164      *
 165      * @fixme replace with wrappers on asActivityObject when it's got everything.
 166      *
 167      * @param string $element one of 'actor', 'subject', 'object', 'target'
 168      * @return string
 169      */
 170     function asActivityNoun($element)
 171     {
 172         if ($this->isGroup()) {
 173             $noun = ActivityObject::fromGroup($this->localGroup());
 174             return $noun->asString('activity:' . $element);
 175         } else {
 176             $noun = ActivityObject::fromProfile($this->localProfile());
 177             return $noun->asString('activity:' . $element);
 178         }
 179     }
 180
 181     /**
 182      * @return boolean true if this is a remote group
 183      */
 184     function isGroup()
 185     {
 186         if ($this->profile_id && !$this->group_id) {
 187             return false;
 188         } else if ($this->group_id && !$this->profile_id) {
 189             return true;
 190         } else if ($this->group_id && $this->profile_id) {
 191             // TRANS: Server exception. %s is a URI.
 192             throw new ServerException(sprintf(_m('Invalid ostatus_profile state: both group and profile IDs set for %s.'),$this->uri));
 193         } else {
 194             // TRANS: Server exception. %s is a URI.
 195             throw new ServerException(sprintf(_m('Invalid ostatus_profile state: both group and profile IDs empty for %s.'),$this->uri));
 196         }
 197     }
 198
 199     /**
 200      * Send a subscription request to the hub for this feed.
 201      * The hub will later send us a confirmation POST to /main/push/callback.
 202      *
 203      * @return bool true on success, false on failure
 204      * @throws ServerException if feed state is not valid
 205      */
 206     public function subscribe()
 207     {
 208         $feedsub = FeedSub::ensureFeed($this->feeduri);
 209         if ($feedsub->sub_state == 'active') {
 210             // Active subscription, we don't need to do anything.
 211             return true;
 212         } else {
 213             // Inactive or we got left in an inconsistent state.
 214             // Run a subscription request to make sure we're current!
 215             return $feedsub->subscribe();
 216         }
 217     }
 218
 219     /**
 220      * Check if this remote profile has any active local subscriptions, and
 221      * if not drop the PuSH subscription feed.
 222      *
 223      * @return bool true on success, false on failure
 224      */
 225     public function unsubscribe() {
 226         $this->garbageCollect();
 227     }
 228
 229     /**
 230      * Check if this remote profile has any active local subscriptions, and
 231      * if not drop the PuSH subscription feed.
 232      *
 233      * @return boolean
 234      */
 235     public function garbageCollect()
 236     {
 237         $feedsub = FeedSub::staticGet('uri', $this->feeduri);
 238         return $feedsub->garbageCollect();
 239     }
 240
 241     /**
 242      * Check if this remote profile has any active local subscriptions, so the
 243      * PuSH subscription layer can decide if it can drop the feed.
 244      *
 245      * This gets called via the FeedSubSubscriberCount event when running
 246      * FeedSub::garbageCollect().
 247      *
 248      * @return int
 249      */
 250     public function subscriberCount()
 251     {
 252         if ($this->isGroup()) {
 253             $members = $this->localGroup()->getMembers(0, 1);
 254             $count = $members->N;
 255         } else {
 256             $count = $this->localProfile()->subscriberCount();
 257         }
 258         common_log(LOG_INFO, __METHOD__ . " SUB COUNT BEFORE: $count");
 259
 260         // Other plugins may be piggybacking on OStatus without having
 261         // an active group or user-to-user subscription we know about.
 262         Event::handle('Ostatus_profileSubscriberCount', array($this, &$count));
 263         common_log(LOG_INFO, __METHOD__ . " SUB COUNT AFTER: $count");
 264
 265         return $count;
 266     }
 267
 268     /**
 269      * Send an Activity Streams notification to the remote Salmon endpoint,
 270      * if so configured.
 271      *
 272      * @param Profile $actor  Actor who did the activity
 273      * @param string  $verb   Activity::SUBSCRIBE or Activity::JOIN
 274      * @param Object  $object object of the action; must define asActivityNoun($tag)
 275      */
 276     public function notify($actor, $verb, $object=null)
 277     {
 278         if (!($actor instanceof Profile)) {
 279             $type = gettype($actor);
 280             if ($type == 'object') {
 281                 $type = get_class($actor);
 282             }
 283             // TRANS: Server exception.
 284             // TRANS: %1$s is the method name the exception occured in, %2$s is the actor type.
 285             throw new ServerException(sprintf(_m('Invalid actor passed to %1$s: %2$s.'),__METHOD__,$type));
 286         }
 287         if ($object == null) {
 288             $object = $this;
 289         }
 290         if ($this->salmonuri) {
 291
 292             $text = 'update';
 293             $id = TagURI::mint('%s:%s:%s',
 294                                $verb,
 295                                $actor->getURI(),
 296                                common_date_iso8601(time()));
 297
 298             // @fixme consolidate all these NS settings somewhere
 299             $attributes = array('xmlns' => Activity::ATOM,
 300                                 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
 301                                 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
 302                                 'xmlns:georss' => 'http://www.georss.org/georss',
 303                                 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
 304                                 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
 305                                 'xmlns:media' => 'http://purl.org/syndication/atommedia');
 306
 307             $entry = new XMLStringer();
 308             $entry->elementStart('entry', $attributes);
 309             $entry->element('id', null, $id);
 310             $entry->element('title', null, $text);
 311             $entry->element('summary', null, $text);
 312             $entry->element('published', null, common_date_w3dtf(common_sql_now()));
 313
 314             $entry->element('activity:verb', null, $verb);
 315             $entry->raw($actor->asAtomAuthor());
 316             $entry->raw($actor->asActivityActor());
 317             $entry->raw($object->asActivityNoun('object'));
 318             $entry->elementEnd('entry');
 319
 320             $xml = $entry->getString();
 321             common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
 322
 323             $salmon = new Salmon(); // ?
 324             return $salmon->post($this->salmonuri, $xml, $actor);
 325         }
 326         return false;
 327     }
 328
 329     /**
 330      * Send a Salmon notification ping immediately, and confirm that we got
 331      * an acceptable response from the remote site.
 332      *
 333      * @param mixed $entry XML string, Notice, or Activity
 334      * @return boolean success
 335      */
 336     public function notifyActivity($entry, $actor)
 337     {
 338         if ($this->salmonuri) {
 339             $salmon = new Salmon();
 340             return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
 341         }
 342
 343         return false;
 344     }
 345
 346     /**
 347      * Queue a Salmon notification for later. If queues are disabled we'll
 348      * send immediately but won't get the return value.
 349      *
 350      * @param mixed $entry XML string, Notice, or Activity
 351      * @return boolean success
 352      */
 353     public function notifyDeferred($entry, $actor)
 354     {
 355         if ($this->salmonuri) {
 356             $data = array('salmonuri' => $this->salmonuri,
 357                           'entry' => $this->notifyPrepXml($entry),
 358                           'actor' => $actor->id);
 359
 360             $qm = QueueManager::get();
 361             return $qm->enqueue($data, 'salmon');
 362         }
 363
 364         return false;
 365     }
 366
 367     protected function notifyPrepXml($entry)
 368     {
 369         $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
 370         if (is_string($entry)) {
 371             return $entry;
 372         } else if ($entry instanceof Activity) {
 373             return $preamble . $entry->asString(true);
 374         } else if ($entry instanceof Notice) {
 375             return $preamble . $entry->asAtomEntry(true, true);
 376         } else {
 377             // TRANS: Server exception.
 378             throw new ServerException(_m('Invalid type passed to Ostatus_profile::notify. It must be XML string or Activity entry.'));
 379         }
 380     }
 381
 382     function getBestName()
 383     {
 384         if ($this->isGroup()) {
 385             return $this->localGroup()->getBestName();
 386         } else {
 387             return $this->localProfile()->getBestName();
 388         }
 389     }
 390
 391     /**
 392      * Read and post notices for updates from the feed.
 393      * Currently assumes that all items in the feed are new,
 394      * coming from a PuSH hub.
 395      *
 396      * @param DOMDocument $doc
 397      * @param string $source identifier ("push")
 398      */
 399     public function processFeed(DOMDocument $doc, $source)
 400     {
 401         $feed = $doc->documentElement;
 402
 403         if ($feed->localName == 'feed' && $feed->namespaceURI == Activity::ATOM) {
 404             $this->processAtomFeed($feed, $source);
 405         } else if ($feed->localName == 'rss') { // @fixme check namespace
 406             $this->processRssFeed($feed, $source);
 407         } else {
 408             // TRANS: Exception.
 409             throw new Exception(_m('Unknown feed format.'));
 410         }
 411     }
 412
 413     public function processAtomFeed(DOMElement $feed, $source)
 414     {
 415         $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
 416         if ($entries->length == 0) {
 417             common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
 418             return;
 419         }
 420
 421         for ($i = 0; $i < $entries->length; $i++) {
 422             $entry = $entries->item($i);
 423             $this->processEntry($entry, $feed, $source);
 424         }
 425     }
 426
 427     public function processRssFeed(DOMElement $rss, $source)
 428     {
 429         $channels = $rss->getElementsByTagName('channel');
 430
 431         if ($channels->length == 0) {
 432             // TRANS: Exception.
 433             throw new Exception(_m('RSS feed without a channel.'));
 434         } else if ($channels->length > 1) {
 435             common_log(LOG_WARNING, __METHOD__ . ": more than one channel in an RSS feed");
 436         }
 437
 438         $channel = $channels->item(0);
 439
 440         $items = $channel->getElementsByTagName('item');
 441
 442         for ($i = 0; $i < $items->length; $i++) {
 443             $item = $items->item($i);
 444             $this->processEntry($item, $channel, $source);
 445         }
 446     }
 447
 448     /**
 449      * Process a posted entry from this feed source.
 450      *
 451      * @param DOMElement $entry
 452      * @param DOMElement $feed for context
 453      * @param string $source identifier ("push" or "salmon")
 454      */
 455
 456     public function processEntry($entry, $feed, $source)
 457     {
 458         $activity = new Activity($entry, $feed);
 459
 460         if (Event::handle('StartHandleFeedEntry', array($activity))) {
 461
 462             // @todo process all activity objects
 463             switch ($activity->objects[0]->type) {
 464             case ActivityObject::ARTICLE:
 465             case ActivityObject::BLOGENTRY:
 466             case ActivityObject::NOTE:
 467             case ActivityObject::STATUS:
 468             case ActivityObject::COMMENT:
 469                         case null:
 470                 if ($activity->verb == ActivityVerb::POST) {
 471                     $this->processPost($activity, $source);
 472                 } else {
 473                     common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
 474                 }
 475                 break;
 476             default:
 477                 // TRANS: Client exception.
 478                 throw new ClientException(_m('Can\'t handle that kind of post.'));
 479             }
 480
 481             Event::handle('EndHandleFeedEntry', array($activity));
 482         }
 483     }
 484
 485     /**
 486      * Process an incoming post activity from this remote feed.
 487      * @param Activity $activity
 488      * @param string $method 'push' or 'salmon'
 489      * @return mixed saved Notice or false
 490      * @fixme break up this function, it's getting nasty long
 491      */
 492     public function processPost($activity, $method)
 493     {
 494         if ($this->isGroup()) {
 495             // A group feed will contain posts from multiple authors.
 496             // @fixme validate these profiles in some way!
 497             $oprofile = self::ensureActorProfile($activity);
 498             if ($oprofile->isGroup()) {
 499                 // Groups can't post notices in StatusNet.
 500                 common_log(LOG_WARNING, "OStatus: skipping post with group listed as author: $oprofile->uri in feed from $this->uri");
 501                 return false;
 502             }
 503         } else {
 504             $actor = $activity->actor;
 505
 506             if (empty($actor)) {
 507                 // OK here! assume the default
 508             } else if ($actor->id == $this->uri || $actor->link == $this->uri) {
 509                 $this->updateFromActivityObject($actor);
 510             } else if ($actor->id) {
 511                 // We have an ActivityStreams actor with an explicit ID that doesn't match the feed owner.
 512                 // This isn't what we expect from mainline OStatus person feeds!
 513                 // Group feeds go down another path, with different validation...
 514                 // Most likely this is a plain ol' blog feed of some kind which
 515                 // doesn't match our expectations. We'll take the entry, but ignore
 516                 // the <author> info.
 517                 common_log(LOG_WARNING, "Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for {$this->uri}");
 518             } else {
 519                 // Plain <author> without ActivityStreams actor info.
 520                 // We'll just ignore this info for now and save the update under the feed's identity.
 521             }
 522
 523             $oprofile = $this;
 524         }
 525
 526         // It's not always an ActivityObject::NOTE, but... let's just say it is.
 527
 528         $note = $activity->objects[0];
 529
 530         // The id URI will be used as a unique identifier for for the notice,
 531         // protecting against duplicate saves. It isn't required to be a URL;
 532         // tag: URIs for instance are found in Google Buzz feeds.
 533         $sourceUri = $note->id;
 534         $dupe = Notice::staticGet('uri', $sourceUri);
 535         if ($dupe) {
 536             common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
 537             return false;
 538         }
 539
 540         // We'll also want to save a web link to the original notice, if provided.
 541         $sourceUrl = null;
 542         if ($note->link) {
 543             $sourceUrl = $note->link;
 544         } else if ($activity->link) {
 545             $sourceUrl = $activity->link;
 546         } else if (preg_match('!^https?://!', $note->id)) {
 547             $sourceUrl = $note->id;
 548         }
 549
 550         // Use summary as fallback for content
 551
 552         if (!empty($note->content)) {
 553             $sourceContent = $note->content;
 554         } else if (!empty($note->summary)) {
 555             $sourceContent = $note->summary;
 556         } else if (!empty($note->title)) {
 557             $sourceContent = $note->title;
 558         } else {
 559             // @fixme fetch from $sourceUrl?
 560             // TRANS: Client exception. %s is a source URI.
 561             throw new ClientException(sprintf(_m('No content for notice %s.'),$sourceUri));
 562         }
 563
 564         // Get (safe!) HTML and text versions of the content
 565
 566         $rendered = $this->purify($sourceContent);
 567         $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
 568
 569         $shortened = common_shorten_links($content);
 570
 571         // If it's too long, try using the summary, and make the
 572         // HTML an attachment.
 573
 574         $attachment = null;
 575
 576         if (Notice::contentTooLong($shortened)) {
 577             $attachment = $this->saveHTMLFile($note->title, $rendered);
 578             $summary = html_entity_decode(strip_tags($note->summary), ENT_QUOTES, 'UTF-8');
 579             if (empty($summary)) {
 580                 $summary = $content;
 581             }
 582             $shortSummary = common_shorten_links($summary);
 583             if (Notice::contentTooLong($shortSummary)) {
 584                 $url = common_shorten_url($sourceUrl);
 585                 $shortSummary = substr($shortSummary,
 586                                        0,
 587                                        Notice::maxContent() - (mb_strlen($url) + 2));
 588                 $content = $shortSummary . ' ' . $url;
 589
 590                 // We mark up the attachment link specially for the HTML output
 591                 // so we can fold-out the full version inline.
 592
 593                 // @fixme I18N this tooltip will be saved with the site's default language
 594                 // TRANS: Shown when a notice is longer than supported and/or when attachments are present. At runtime
 595                 // TRANS: this will usually be replaced with localised text from StatusNet core messages.
 596                 $showMoreText = _m('Show more');
 597                 $attachUrl = common_local_url('attachment',
 598                                               array('attachment' => $attachment->id));
 599                 $rendered = common_render_text($shortSummary) .
 600                             '<a href="' . htmlspecialchars($attachUrl) .'"'.
 601                             ' class="attachment more"' .
 602                             ' title="'. htmlspecialchars($showMoreText) . '">' .
 603                             '&#8230;' .
 604                             '</a>';
 605             }
 606         }
 607
 608         $options = array('is_local' => Notice::REMOTE_OMB,
 609                         'url' => $sourceUrl,
 610                         'uri' => $sourceUri,
 611                         'rendered' => $rendered,
 612                         'replies' => array(),
 613                         'groups' => array(),
 614                         'tags' => array(),
 615                         'urls' => array());
 616
 617         // Check for optional attributes...
 618
 619         if (!empty($activity->time)) {
 620             $options['created'] = common_sql_date($activity->time);
 621         }
 622
 623         if ($activity->context) {
 624             // Any individual or group attn: targets?
 625             $replies = $activity->context->attention;
 626             $options['groups'] = $this->filterReplies($oprofile, $replies);
 627             $options['replies'] = $replies;
 628
 629             // Maintain direct reply associations
 630             // @fixme what about conversation ID?
 631             if (!empty($activity->context->replyToID)) {
 632                 $orig = Notice::staticGet('uri',
 633                                           $activity->context->replyToID);
 634                 if (!empty($orig)) {
 635                     $options['reply_to'] = $orig->id;
 636                 }
 637             }
 638
 639             $location = $activity->context->location;
 640             if ($location) {
 641                 $options['lat'] = $location->lat;
 642                 $options['lon'] = $location->lon;
 643                 if ($location->location_id) {
 644                     $options['location_ns'] = $location->location_ns;
 645                     $options['location_id'] = $location->location_id;
 646                 }
 647             }
 648         }
 649
 650         // Atom categories <-> hashtags
 651         foreach ($activity->categories as $cat) {
 652             if ($cat->term) {
 653                 $term = common_canonical_tag($cat->term);
 654                 if ($term) {
 655                     $options['tags'][] = $term;
 656                 }
 657             }
 658         }
 659
 660         // Atom enclosures -> attachment URLs
 661         foreach ($activity->enclosures as $href) {
 662             // @fixme save these locally or....?
 663             $options['urls'][] = $href;
 664         }
 665
 666         try {
 667             $saved = Notice::saveNew($oprofile->profile_id,
 668                                      $content,
 669                                      'ostatus',
 670                                      $options);
 671             if ($saved) {
 672                 Ostatus_source::saveNew($saved, $this, $method);
 673                 if (!empty($attachment)) {
 674                     File_to_post::processNew($attachment->id, $saved->id);
 675                 }
 676             }
 677         } catch (Exception $e) {
 678             common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
 679             throw $e;
 680         }
 681         common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
 682         return $saved;
 683     }
 684
 685     /**
 686      * Clean up HTML
 687      */
 688     protected function purify($html)
 689     {
 690         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 691         $config = array('safe' => 1,
 692                         'deny_attribute' => 'id,style,on*');
 693         return htmLawed($html, $config);
 694     }
 695
 696     /**
 697      * Filters a list of recipient ID URIs to just those for local delivery.
 698      * @param Ostatus_profile local profile of sender
 699      * @param array in/out &$attention_uris set of URIs, will be pruned on output
 700      * @return array of group IDs
 701      */
 702     protected function filterReplies($sender, &$attention_uris)
 703     {
 704         common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
 705         $groups = array();
 706         $replies = array();
 707         foreach (array_unique($attention_uris) as $recipient) {
 708             // Is the recipient a local user?
 709             $user = User::staticGet('uri', $recipient);
 710             if ($user) {
 711                 // @fixme sender verification, spam etc?
 712                 $replies[] = $recipient;
 713                 continue;
 714             }
 715
 716             // Is the recipient a local group?
 717             // $group = User_group::staticGet('uri', $recipient);
 718             $id = OStatusPlugin::localGroupFromUrl($recipient);
 719             if ($id) {
 720                 $group = User_group::staticGet('id', $id);
 721                 if ($group) {
 722                     // Deliver to all members of this local group if allowed.
 723                     $profile = $sender->localProfile();
 724                     if ($profile->isMember($group)) {
 725                         $groups[] = $group->id;
 726                     } else {
 727                         common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
 728                     }
 729                     continue;
 730                 } else {
 731                     common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
 732                 }
 733             }
 734
 735             // Is the recipient a remote user or group?
 736             try {
 737                 $oprofile = Ostatus_profile::ensureProfileURI($recipient);
 738                 if ($oprofile->isGroup()) {
 739                     // Deliver to local members of this remote group.
 740                     // @fixme sender verification?
 741                     $groups[] = $oprofile->group_id;
 742                 } else {
 743                     // may be canonicalized or something
 744                     $replies[] = $oprofile->uri;
 745                 }
 746                 continue;
 747             } catch (Exception $e) {
 748                 // Neither a recognizable local nor remote user!
 749                 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient: " . $e->getMessage());
 750             }
 751
 752         }
 753         $attention_uris = $replies;
 754         common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
 755         common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
 756         return $groups;
 757     }
 758
 759     /**
 760      * Look up and if necessary create an Ostatus_profile for the remote entity
 761      * with the given profile page URL. This should never return null -- you
 762      * will either get an object or an exception will be thrown.
 763      *
 764      * @param string $profile_url
 765      * @return Ostatus_profile
 766      * @throws Exception on various error conditions
 767      * @throws OStatusShadowException if this reference would obscure a local user/group
 768      */
 769
 770     public static function ensureProfileURL($profile_url, $hints=array())
 771     {
 772         $oprofile = self::getFromProfileURL($profile_url);
 773
 774         if (!empty($oprofile)) {
 775             return $oprofile;
 776         }
 777
 778         $hints['profileurl'] = $profile_url;
 779
 780         // Fetch the URL
 781         // XXX: HTTP caching
 782
 783         $client = new HTTPClient();
 784         $client->setHeader('Accept', 'text/html,application/xhtml+xml');
 785         $response = $client->get($profile_url);
 786
 787         if (!$response->isOk()) {
 788             // TRANS: Exception. %s is a profile URL.
 789             throw new Exception(sprintf(_m('Could not reach profile page %s.'),$profile_url));
 790         }
 791
 792         // Check if we have a non-canonical URL
 793
 794         $finalUrl = $response->getUrl();
 795
 796         if ($finalUrl != $profile_url) {
 797
 798             $hints['profileurl'] = $finalUrl;
 799
 800             $oprofile = self::getFromProfileURL($finalUrl);
 801
 802             if (!empty($oprofile)) {
 803                 return $oprofile;
 804             }
 805         }
 806
 807         // Try to get some hCard data
 808
 809         $body = $response->getBody();
 810
 811         $hcardHints = DiscoveryHints::hcardHints($body, $finalUrl);
 812
 813         if (!empty($hcardHints)) {
 814             $hints = array_merge($hints, $hcardHints);
 815         }
 816
 817         // Check if they've got an LRDD header
 818
 819         $lrdd = LinkHeader::getLink($response, 'lrdd', 'application/xrd+xml');
 820
 821         if (!empty($lrdd)) {
 822
 823             $xrd = Discovery::fetchXrd($lrdd);
 824             $xrdHints = DiscoveryHints::fromXRD($xrd);
 825
 826             $hints = array_merge($hints, $xrdHints);
 827         }
 828
 829         // If discovery found a feedurl (probably from LRDD), use it.
 830
 831         if (array_key_exists('feedurl', $hints)) {
 832             return self::ensureFeedURL($hints['feedurl'], $hints);
 833         }
 834
 835         // Get the feed URL from HTML
 836
 837         $discover = new FeedDiscovery();
 838
 839         $feedurl = $discover->discoverFromHTML($finalUrl, $body);
 840
 841         if (!empty($feedurl)) {
 842             $hints['feedurl'] = $feedurl;
 843             return self::ensureFeedURL($feedurl, $hints);
 844         }
 845
 846         // TRANS: Exception. %s is a URL.
 847         throw new Exception(sprintf(_m('Could not find a feed URL for profile page %s.'),$finalUrl));
 848     }
 849
 850     /**
 851      * Look up the Ostatus_profile, if present, for a remote entity with the
 852      * given profile page URL. Will return null for both unknown and invalid
 853      * remote profiles.
 854      *
 855      * @return mixed Ostatus_profile or null
 856      * @throws OStatusShadowException for local profiles
 857      */
 858     static function getFromProfileURL($profile_url)
 859     {
 860         $profile = Profile::staticGet('profileurl', $profile_url);
 861
 862         if (empty($profile)) {
 863             return null;
 864         }
 865
 866         // Is it a known Ostatus profile?
 867
 868         $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
 869
 870         if (!empty($oprofile)) {
 871             return $oprofile;
 872         }
 873
 874         // Is it a local user?
 875
 876         $user = User::staticGet('id', $profile->id);
 877
 878         if (!empty($user)) {
 879             // @todo i18n FIXME: use sprintf and add i18n (?)
 880             throw new OStatusShadowException($profile, "'$profile_url' is the profile for local user '{$user->nickname}'.");
 881         }
 882
 883         // Continue discovery; it's a remote profile
 884         // for OMB or some other protocol, may also
 885         // support OStatus
 886
 887         return null;
 888     }
 889
 890     /**
 891      * Look up and if necessary create an Ostatus_profile for remote entity
 892      * with the given update feed. This should never return null -- you will
 893      * either get an object or an exception will be thrown.
 894      *
 895      * @return Ostatus_profile
 896      * @throws Exception
 897      */
 898     public static function ensureFeedURL($feed_url, $hints=array())
 899     {
 900         $discover = new FeedDiscovery();
 901
 902         $feeduri = $discover->discoverFromFeedURL($feed_url);
 903         $hints['feedurl'] = $feeduri;
 904
 905         $huburi = $discover->getHubLink();
 906         $hints['hub'] = $huburi;
 907         $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
 908         $hints['salmon'] = $salmonuri;
 909
 910         if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
 911             // We can only deal with folks with a PuSH hub
 912             throw new FeedSubNoHubException();
 913         }
 914
 915         $feedEl = $discover->root;
 916
 917         if ($feedEl->tagName == 'feed') {
 918             return self::ensureAtomFeed($feedEl, $hints);
 919         } else if ($feedEl->tagName == 'channel') {
 920             return self::ensureRssChannel($feedEl, $hints);
 921         } else {
 922             throw new FeedSubBadXmlException($feeduri);
 923         }
 924     }
 925
 926     /**
 927      * Look up and, if necessary, create an Ostatus_profile for the remote
 928      * profile with the given Atom feed - actually loaded from the feed.
 929      * This should never return null -- you will either get an object or
 930      * an exception will be thrown.
 931      *
 932      * @param DOMElement $feedEl root element of a loaded Atom feed
 933      * @param array $hints additional discovery information passed from higher levels
 934      * @fixme should this be marked public?
 935      * @return Ostatus_profile
 936      * @throws Exception
 937      */
 938
 939     public static function ensureAtomFeed($feedEl, $hints)
 940     {
 941         $author = ActivityUtils::getFeedAuthor($feedEl);
 942
 943         if (empty($author)) {
 944             // XXX: make some educated guesses here
 945             // TRANS: Feed sub exception.
 946             throw new FeedSubException(_m('Can\'t find enough profile '.
 947                                           'information to make a feed.'));
 948         }
 949
 950         return self::ensureActivityObjectProfile($author, $hints);
 951     }
 952
 953     /**
 954      * Look up and, if necessary, create an Ostatus_profile for the remote
 955      * profile with the given RSS feed - actually loaded from the feed.
 956      * This should never return null -- you will either get an object or
 957      * an exception will be thrown.
 958      *
 959      * @param DOMElement $feedEl root element of a loaded RSS feed
 960      * @param array $hints additional discovery information passed from higher levels
 961      * @fixme should this be marked public?
 962      * @return Ostatus_profile
 963      * @throws Exception
 964      */
 965     public static function ensureRssChannel($feedEl, $hints)
 966     {
 967         // Special-case for Posterous. They have some nice metadata in their
 968         // posterous:author elements. We should use them instead of the channel.
 969
 970         $items = $feedEl->getElementsByTagName('item');
 971
 972         if ($items->length > 0) {
 973             $item = $items->item(0);
 974             $authorEl = ActivityUtils::child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS);
 975             if (!empty($authorEl)) {
 976                 $obj = ActivityObject::fromPosterousAuthor($authorEl);
 977                 // Posterous has multiple authors per feed, and multiple feeds
 978                 // per author. We check if this is the "main" feed for this author.
 979                 if (array_key_exists('profileurl', $hints) &&
 980                     !empty($obj->poco) &&
 981                     common_url_to_nickname($hints['profileurl']) == $obj->poco->preferredUsername) {
 982                     return self::ensureActivityObjectProfile($obj, $hints);
 983                 }
 984             }
 985         }
 986
 987         // @fixme we should check whether this feed has elements
 988         // with different <author> or <dc:creator> elements, and... I dunno.
 989         // Do something about that.
 990
 991         $obj = ActivityObject::fromRssChannel($feedEl);
 992
 993         return self::ensureActivityObjectProfile($obj, $hints);
 994     }
 995
 996     /**
 997      * Download and update given avatar image
 998      *
 999      * @param string $url
1000      * @throws Exception in various failure cases
1001      */
1002     protected function updateAvatar($url)
1003     {
1004         if ($url == $this->avatar) {
1005             // We've already got this one.
1006             return;
1007         }
1008         if (!common_valid_http_url($url)) {
1009             // TRANS: Server exception. %s is a URL.
1010             throw new ServerException(sprintf(_m("Invalid avatar URL %s."), $url));
1011         }
1012
1013         if ($this->isGroup()) {
1014             $self = $this->localGroup();
1015         } else {
1016             $self = $this->localProfile();
1017         }
1018         if (!$self) {
1019             throw new ServerException(sprintf(
1020                 // TRANS: Server exception. %s is a URI.
1021                 _m("Tried to update avatar for unsaved remote profile %s."),
1022                 $this->uri));
1023         }
1024
1025         // @fixme this should be better encapsulated
1026         // ripped from oauthstore.php (for old OMB client)
1027         $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
1028         try {
1029             if (!copy($url, $temp_filename)) {
1030                 // TRANS: Server exception. %s is a URL.
1031                 throw new ServerException(sprintf(_m("Unable to fetch avatar from %s."), $url));
1032             }
1033
1034             if ($this->isGroup()) {
1035                 $id = $this->group_id;
1036             } else {
1037                 $id = $this->profile_id;
1038             }
1039             // @fixme should we be using different ids?
1040             $imagefile = new ImageFile($id, $temp_filename);
1041             $filename = Avatar::filename($id,
1042                                          image_type_to_extension($imagefile->type),
1043                                          null,
1044                                          common_timestamp());
1045             rename($temp_filename, Avatar::path($filename));
1046         } catch (Exception $e) {
1047             unlink($temp_filename);
1048             throw $e;
1049         }
1050         // @fixme hardcoded chmod is lame, but seems to be necessary to
1051         // keep from accidentally saving images from command-line (queues)
1052         // that can't be read from web server, which causes hard-to-notice
1053         // problems later on:
1054         //
1055         // http://status.net/open-source/issues/2663
1056         chmod(Avatar::path($filename), 0644);
1057
1058         $self->setOriginal($filename);
1059
1060         $orig = clone($this);
1061         $this->avatar = $url;
1062         $this->update($orig);
1063     }
1064
1065     /**
1066      * Pull avatar URL from ActivityObject or profile hints
1067      *
1068      * @param ActivityObject $object
1069      * @param array $hints
1070      * @return mixed URL string or false
1071      */
1072
1073     public static function getActivityObjectAvatar($object, $hints=array())
1074     {
1075         if ($object->avatarLinks) {
1076             $best = false;
1077             // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
1078             foreach ($object->avatarLinks as $avatar) {
1079                 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
1080                     // Exact match!
1081                     $best = $avatar;
1082                     break;
1083                 }
1084                 if (!$best || $avatar->width > $best->width) {
1085                     $best = $avatar;
1086                 }
1087             }
1088             return $best->url;
1089         } else if (array_key_exists('avatar', $hints)) {
1090             return $hints['avatar'];
1091         }
1092         return false;
1093     }
1094
1095     /**
1096      * Get an appropriate avatar image source URL, if available.
1097      *
1098      * @param ActivityObject $actor
1099      * @param DOMElement $feed
1100      * @return string
1101      */
1102
1103     protected static function getAvatar($actor, $feed)
1104     {
1105         $url = '';
1106         $icon = '';
1107         if ($actor->avatar) {
1108             $url = trim($actor->avatar);
1109         }
1110         if (!$url) {
1111             // Check <atom:logo> and <atom:icon> on the feed
1112             $els = $feed->childNodes();
1113             if ($els && $els->length) {
1114                 for ($i = 0; $i < $els->length; $i++) {
1115                     $el = $els->item($i);
1116                     if ($el->namespaceURI == Activity::ATOM) {
1117                         if (empty($url) && $el->localName == 'logo') {
1118                             $url = trim($el->textContent);
1119                             break;
1120                         }
1121                         if (empty($icon) && $el->localName == 'icon') {
1122                             // Use as a fallback
1123                             $icon = trim($el->textContent);
1124                         }
1125                     }
1126                 }
1127             }
1128             if ($icon && !$url) {
1129                 $url = $icon;
1130             }
1131         }
1132         if ($url) {
1133             $opts = array('allowed_schemes' => array('http', 'https'));
1134             if (Validate::uri($url, $opts)) {
1135                 return $url;
1136             }
1137         }
1138         return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
1139     }
1140
1141     /**
1142      * Fetch, or build if necessary, an Ostatus_profile for the actor
1143      * in a given Activity Streams activity.
1144      * This should never return null -- you will either get an object or
1145      * an exception will be thrown.
1146      *
1147      * @param Activity $activity
1148      * @param string $feeduri if we already know the canonical feed URI!
1149      * @param string $salmonuri if we already know the salmon return channel URI
1150      * @return Ostatus_profile
1151      * @throws Exception
1152      */
1153
1154     public static function ensureActorProfile($activity, $hints=array())
1155     {
1156         return self::ensureActivityObjectProfile($activity->actor, $hints);
1157     }
1158
1159     /**
1160      * Fetch, or build if necessary, an Ostatus_profile for the profile
1161      * in a given Activity Streams object (can be subject, actor, or object).
1162      * This should never return null -- you will either get an object or
1163      * an exception will be thrown.
1164      *
1165      * @param ActivityObject $object
1166      * @param array $hints additional discovery information passed from higher levels
1167      * @return Ostatus_profile
1168      * @throws Exception
1169      */
1170
1171     public static function ensureActivityObjectProfile($object, $hints=array())
1172     {
1173         $profile = self::getActivityObjectProfile($object);
1174         if ($profile) {
1175             $profile->updateFromActivityObject($object, $hints);
1176         } else {
1177             $profile = self::createActivityObjectProfile($object, $hints);
1178         }
1179         return $profile;
1180     }
1181
1182     /**
1183      * @param Activity $activity
1184      * @return mixed matching Ostatus_profile or false if none known
1185      * @throws ServerException if feed info invalid
1186      */
1187     public static function getActorProfile($activity)
1188     {
1189         return self::getActivityObjectProfile($activity->actor);
1190     }
1191
1192     /**
1193      * @param ActivityObject $activity
1194      * @return mixed matching Ostatus_profile or false if none known
1195      * @throws ServerException if feed info invalid
1196      */
1197     protected static function getActivityObjectProfile($object)
1198     {
1199         $uri = self::getActivityObjectProfileURI($object);
1200         return Ostatus_profile::staticGet('uri', $uri);
1201     }
1202
1203     /**
1204      * Get the identifier URI for the remote entity described
1205      * by this ActivityObject. This URI is *not* guaranteed to be
1206      * a resolvable HTTP/HTTPS URL.
1207      *
1208      * @param ActivityObject $object
1209      * @return string
1210      * @throws ServerException if feed info invalid
1211      */
1212     protected static function getActivityObjectProfileURI($object)
1213     {
1214         if ($object->id) {
1215             if (ActivityUtils::validateUri($object->id)) {
1216                 return $object->id;
1217             }
1218         }
1219
1220         // If the id is missing or invalid (we've seen feeds mistakenly listing
1221         // things like local usernames in that field) then we'll use the profile
1222         // page link, if valid.
1223         if ($object->link && common_valid_http_url($object->link)) {
1224             return $object->link;
1225         }
1226         throw new ServerException("No author ID URI found.");
1227     }
1228
1229     /**
1230      * @fixme validate stuff somewhere
1231      */
1232
1233     /**
1234      * Create local ostatus_profile and profile/user_group entries for
1235      * the provided remote user or group.
1236      * This should never return null -- you will either get an object or
1237      * an exception will be thrown.
1238      *
1239      * @param ActivityObject $object
1240      * @param array $hints
1241      *
1242      * @return Ostatus_profile
1243      */
1244     protected static function createActivityObjectProfile($object, $hints=array())
1245     {
1246         $homeuri = $object->id;
1247         $discover = false;
1248
1249         if (!$homeuri) {
1250             common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
1251             throw new Exception("No profile URI");
1252         }
1253
1254         $user = User::staticGet('uri', $homeuri);
1255         if ($user) {
1256             // TRANS: Exception.
1257             throw new Exception(_m('Local user can\'t be referenced as remote.'));
1258         }
1259
1260         if (OStatusPlugin::localGroupFromUrl($homeuri)) {
1261             // TRANS: Exception.
1262             throw new Exception(_m('Local group can\'t be referenced as remote.'));
1263         }
1264
1265         if (array_key_exists('feedurl', $hints)) {
1266             $feeduri = $hints['feedurl'];
1267         } else {
1268             $discover = new FeedDiscovery();
1269             $feeduri = $discover->discoverFromURL($homeuri);
1270         }
1271
1272         if (array_key_exists('salmon', $hints)) {
1273             $salmonuri = $hints['salmon'];
1274         } else {
1275             if (!$discover) {
1276                 $discover = new FeedDiscovery();
1277                 $discover->discoverFromFeedURL($hints['feedurl']);
1278             }
1279             $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1280         }
1281
1282         if (array_key_exists('hub', $hints)) {
1283             $huburi = $hints['hub'];
1284         } else {
1285             if (!$discover) {
1286                 $discover = new FeedDiscovery();
1287                 $discover->discoverFromFeedURL($hints['feedurl']);
1288             }
1289             $huburi = $discover->getHubLink();
1290         }
1291
1292         if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
1293             // We can only deal with folks with a PuSH hub
1294             throw new FeedSubNoHubException();
1295         }
1296
1297         $oprofile = new Ostatus_profile();
1298
1299         $oprofile->uri        = $homeuri;
1300         $oprofile->feeduri    = $feeduri;
1301         $oprofile->salmonuri  = $salmonuri;
1302
1303         $oprofile->created    = common_sql_now();
1304         $oprofile->modified   = common_sql_now();
1305
1306         if ($object->type == ActivityObject::PERSON) {
1307             $profile = new Profile();
1308             $profile->created = common_sql_now();
1309             self::updateProfile($profile, $object, $hints);
1310
1311             $oprofile->profile_id = $profile->insert();
1312             if (!$oprofile->profile_id) {
1313             // TRANS: Server exception.
1314                 throw new ServerException(_m('Can\'t save local profile.'));
1315             }
1316         } else {
1317             $group = new User_group();
1318             $group->uri = $homeuri;
1319             $group->created = common_sql_now();
1320             self::updateGroup($group, $object, $hints);
1321
1322             $oprofile->group_id = $group->insert();
1323             if (!$oprofile->group_id) {
1324                 // TRANS: Server exception.
1325                 throw new ServerException(_m('Can\'t save local profile.'));
1326             }
1327         }
1328
1329         $ok = $oprofile->insert();
1330
1331         if (!$ok) {
1332             // TRANS: Server exception.
1333             throw new ServerException(_m('Can\'t save OStatus profile.'));
1334         }
1335
1336         $avatar = self::getActivityObjectAvatar($object, $hints);
1337
1338         if ($avatar) {
1339             try {
1340                 $oprofile->updateAvatar($avatar);
1341             } catch (Exception $ex) {
1342                 // Profile is saved, but Avatar is messed up. We're
1343                 // just going to continue.
1344                 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: ". $ex->getMessage());
1345             }
1346         }
1347
1348         return $oprofile;
1349     }
1350
1351     /**
1352      * Save any updated profile information to our local copy.
1353      * @param ActivityObject $object
1354      * @param array $hints
1355      */
1356     public function updateFromActivityObject($object, $hints=array())
1357     {
1358         if ($this->isGroup()) {
1359             $group = $this->localGroup();
1360             self::updateGroup($group, $object, $hints);
1361         } else {
1362             $profile = $this->localProfile();
1363             self::updateProfile($profile, $object, $hints);
1364         }
1365         $avatar = self::getActivityObjectAvatar($object, $hints);
1366         if ($avatar) {
1367             try {
1368                 $this->updateAvatar($avatar);
1369             } catch (Exception $ex) {
1370                 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: " . $ex->getMessage());
1371             }
1372         }
1373     }
1374
1375     public static function updateProfile($profile, $object, $hints=array())
1376     {
1377         $orig = clone($profile);
1378
1379         $profile->nickname = self::getActivityObjectNickname($object, $hints);
1380
1381         if (!empty($object->title)) {
1382             $profile->fullname = $object->title;
1383         } else if (array_key_exists('fullname', $hints)) {
1384             $profile->fullname = $hints['fullname'];
1385         }
1386
1387         if (!empty($object->link)) {
1388             $profile->profileurl = $object->link;
1389         } else if (array_key_exists('profileurl', $hints)) {
1390             $profile->profileurl = $hints['profileurl'];
1391         } else if (Validate::uri($object->id, array('allowed_schemes' => array('http', 'https')))) {
1392             $profile->profileurl = $object->id;
1393         }
1394
1395         $profile->bio      = self::getActivityObjectBio($object, $hints);
1396         $profile->location = self::getActivityObjectLocation($object, $hints);
1397         $profile->homepage = self::getActivityObjectHomepage($object, $hints);
1398
1399         if (!empty($object->geopoint)) {
1400             $location = ActivityContext::locationFromPoint($object->geopoint);
1401             if (!empty($location)) {
1402                 $profile->lat = $location->lat;
1403                 $profile->lon = $location->lon;
1404             }
1405         }
1406
1407         // @fixme tags/categories
1408         // @todo tags from categories
1409
1410         if ($profile->id) {
1411             common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1412             $profile->update($orig);
1413         }
1414     }
1415
1416     protected static function updateGroup($group, $object, $hints=array())
1417     {
1418         $orig = clone($group);
1419
1420         $group->nickname = self::getActivityObjectNickname($object, $hints);
1421         $group->fullname = $object->title;
1422
1423         if (!empty($object->link)) {
1424             $group->mainpage = $object->link;
1425         } else if (array_key_exists('profileurl', $hints)) {
1426             $group->mainpage = $hints['profileurl'];
1427         }
1428
1429         // @todo tags from categories
1430         $group->description = self::getActivityObjectBio($object, $hints);
1431         $group->location = self::getActivityObjectLocation($object, $hints);
1432         $group->homepage = self::getActivityObjectHomepage($object, $hints);
1433
1434         if ($group->id) {
1435             common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1436             $group->update($orig);
1437         }
1438     }
1439
1440     protected static function getActivityObjectHomepage($object, $hints=array())
1441     {
1442         $homepage = null;
1443         $poco     = $object->poco;
1444
1445         if (!empty($poco)) {
1446             $url = $poco->getPrimaryURL();
1447             if ($url && $url->type == 'homepage') {
1448                 $homepage = $url->value;
1449             }
1450         }
1451
1452         // @todo Try for a another PoCo URL?
1453
1454         return $homepage;
1455     }
1456
1457     protected static function getActivityObjectLocation($object, $hints=array())
1458     {
1459         $location = null;
1460
1461         if (!empty($object->poco) &&
1462             isset($object->poco->address->formatted)) {
1463             $location = $object->poco->address->formatted;
1464         } else if (array_key_exists('location', $hints)) {
1465             $location = $hints['location'];
1466         }
1467
1468         if (!empty($location)) {
1469             if (mb_strlen($location) > 255) {
1470                 $location = mb_substr($note, 0, 255 - 3) . ' … ';
1471             }
1472         }
1473
1474         // @todo Try to find location some othe way? Via goerss point?
1475
1476         return $location;
1477     }
1478
1479     protected static function getActivityObjectBio($object, $hints=array())
1480     {
1481         $bio  = null;
1482
1483         if (!empty($object->poco)) {
1484             $note = $object->poco->note;
1485         } else if (array_key_exists('bio', $hints)) {
1486             $note = $hints['bio'];
1487         }
1488
1489         if (!empty($note)) {
1490             if (Profile::bioTooLong($note)) {
1491                 // XXX: truncate ok?
1492                 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' … ';
1493             } else {
1494                 $bio = $note;
1495             }
1496         }
1497
1498         // @todo Try to get bio info some other way?
1499
1500         return $bio;
1501     }
1502
1503     public static function getActivityObjectNickname($object, $hints=array())
1504     {
1505         if ($object->poco) {
1506             if (!empty($object->poco->preferredUsername)) {
1507                 return common_nicknamize($object->poco->preferredUsername);
1508             }
1509         }
1510
1511         if (!empty($object->nickname)) {
1512             return common_nicknamize($object->nickname);
1513         }
1514
1515         if (array_key_exists('nickname', $hints)) {
1516             return $hints['nickname'];
1517         }
1518
1519         // Try the profile url (like foo.example.com or example.com/user/foo)
1520         if (!empty($object->link)) {
1521             $profileUrl = $object->link;
1522         } else if (!empty($hints['profileurl'])) {
1523             $profileUrl = $hints['profileurl'];
1524         }
1525
1526         if (!empty($profileUrl)) {
1527             $nickname = self::nicknameFromURI($profileUrl);
1528         }
1529
1530         // Try the URI (may be a tag:, http:, acct:, ...
1531
1532         if (empty($nickname)) {
1533             $nickname = self::nicknameFromURI($object->id);
1534         }
1535
1536         // Try a Webfinger if one was passed (way) down
1537
1538         if (empty($nickname)) {
1539             if (array_key_exists('webfinger', $hints)) {
1540                 $nickname = self::nicknameFromURI($hints['webfinger']);
1541             }
1542         }
1543
1544         // Try the name
1545
1546         if (empty($nickname)) {
1547             $nickname = common_nicknamize($object->title);
1548         }
1549
1550         return $nickname;
1551     }
1552
1553     protected static function nicknameFromURI($uri)
1554     {
1555         if (preg_match('/(\w+):/', $uri, $matches)) {
1556             $protocol = $matches[1];
1557         } else {
1558             return null;
1559         }
1560
1561         switch ($protocol) {
1562         case 'acct':
1563         case 'mailto':
1564             if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1565                 return common_canonical_nickname($matches[1]);
1566             }
1567             return null;
1568         case 'http':
1569             return common_url_to_nickname($uri);
1570             break;
1571         default:
1572             return null;
1573         }
1574     }
1575
1576     /**
1577      * Look up, and if necessary create, an Ostatus_profile for the remote
1578      * entity with the given webfinger address.
1579      * This should never return null -- you will either get an object or
1580      * an exception will be thrown.
1581      *
1582      * @param string $addr webfinger address
1583      * @return Ostatus_profile
1584      * @throws Exception on error conditions
1585      * @throws OStatusShadowException if this reference would obscure a local user/group
1586      */
1587     public static function ensureWebfinger($addr)
1588     {
1589         // First, try the cache
1590
1591         $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1592
1593         if ($uri !== false) {
1594             if (is_null($uri)) {
1595                 // Negative cache entry
1596                 // TRANS: Exception.
1597                 throw new Exception(_m('Not a valid webfinger address.'));
1598             }
1599             $oprofile = Ostatus_profile::staticGet('uri', $uri);
1600             if (!empty($oprofile)) {
1601                 return $oprofile;
1602             }
1603         }
1604
1605         // Try looking it up
1606
1607         $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
1608
1609         if (!empty($oprofile)) {
1610             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1611             return $oprofile;
1612         }
1613
1614         // Now, try some discovery
1615
1616         $disco = new Discovery();
1617
1618         try {
1619             $xrd = $disco->lookup($addr);
1620         } catch (Exception $e) {
1621             // Save negative cache entry so we don't waste time looking it up again.
1622             // @fixme distinguish temporary failures?
1623             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1624                 // TRANS: Exception.
1625             throw new Exception(_m('Not a valid webfinger address.'));
1626         }
1627
1628         $hints = array('webfinger' => $addr);
1629
1630         $dhints = DiscoveryHints::fromXRD($xrd);
1631
1632         $hints = array_merge($hints, $dhints);
1633
1634         // If there's an Hcard, let's grab its info
1635
1636         if (array_key_exists('hcard', $hints)) {
1637             if (!array_key_exists('profileurl', $hints) ||
1638                 $hints['hcard'] != $hints['profileurl']) {
1639                 $hcardHints = DiscoveryHints::fromHcardUrl($hints['hcard']);
1640                 $hints = array_merge($hcardHints, $hints);
1641             }
1642         }
1643
1644         // If we got a feed URL, try that
1645
1646         if (array_key_exists('feedurl', $hints)) {
1647             try {
1648                 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
1649                 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
1650                 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1651                 return $oprofile;
1652             } catch (Exception $e) {
1653                 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
1654                 // keep looking
1655             }
1656         }
1657
1658         // If we got a profile page, try that!
1659
1660         if (array_key_exists('profileurl', $hints)) {
1661             try {
1662                 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
1663                 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
1664                 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1665                 return $oprofile;
1666             } catch (OStatusShadowException $e) {
1667                 // We've ended up with a remote reference to a local user or group.
1668                 // @fixme ideally we should be able to say who it was so we can
1669                 // go back and refer to it the regular way
1670                 throw $e;
1671             } catch (Exception $e) {
1672                 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
1673                 // keep looking
1674                 //
1675                 // @fixme this means an error discovering from profile page
1676                 // may give us a corrupt entry using the webfinger URI, which
1677                 // will obscure the correct page-keyed profile later on.
1678             }
1679         }
1680
1681         // XXX: try hcard
1682         // XXX: try FOAF
1683
1684         if (array_key_exists('salmon', $hints)) {
1685
1686             $salmonEndpoint = $hints['salmon'];
1687
1688             // An account URL, a salmon endpoint, and a dream? Not much to go
1689             // on, but let's give it a try
1690
1691             $uri = 'acct:'.$addr;
1692
1693             $profile = new Profile();
1694
1695             $profile->nickname = self::nicknameFromUri($uri);
1696             $profile->created  = common_sql_now();
1697
1698             if (isset($profileUrl)) {
1699                 $profile->profileurl = $profileUrl;
1700             }
1701
1702             $profile_id = $profile->insert();
1703
1704             if (!$profile_id) {
1705                 common_log_db_error($profile, 'INSERT', __FILE__);
1706                 // TRANS: Exception. %s is a webfinger address.
1707                 throw new Exception(sprintf(_m('Couldn\'t save profile for "%s".'),$addr));
1708             }
1709
1710             $oprofile = new Ostatus_profile();
1711
1712             $oprofile->uri        = $uri;
1713             $oprofile->salmonuri  = $salmonEndpoint;
1714             $oprofile->profile_id = $profile_id;
1715             $oprofile->created    = common_sql_now();
1716
1717             if (isset($feedUrl)) {
1718                 $profile->feeduri = $feedUrl;
1719             }
1720
1721             $result = $oprofile->insert();
1722
1723             if (!$result) {
1724                 common_log_db_error($oprofile, 'INSERT', __FILE__);
1725                 // TRANS: Exception. %s is a webfinger address.
1726                 throw new Exception(sprintf(_m('Couldn\'t save ostatus_profile for "%s".'),$addr));
1727             }
1728
1729             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1730             return $oprofile;
1731         }
1732
1733         // TRANS: Exception. %s is a webfinger address.
1734         throw new Exception(sprintf(_m('Couldn\'t find a valid profile for "%s".'),$addr));
1735     }
1736
1737     /**
1738      * Store the full-length scrubbed HTML of a remote notice to an attachment
1739      * file on our server. We'll link to this at the end of the cropped version.
1740      *
1741      * @param string $title plaintext for HTML page's title
1742      * @param string $rendered HTML fragment for HTML page's body
1743      * @return File
1744      */
1745     function saveHTMLFile($title, $rendered)
1746     {
1747         $final = sprintf("<!DOCTYPE html>\n" .
1748                          '<html><head>' .
1749                          '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">' .
1750                          '<title>%s</title>' .
1751                          '</head>' .
1752                          '<body>%s</body></html>',
1753                          htmlspecialchars($title),
1754                          $rendered);
1755
1756         $filename = File::filename($this->localProfile(),
1757                                    'ostatus', // ignored?
1758                                    'text/html');
1759
1760         $filepath = File::path($filename);
1761
1762         file_put_contents($filepath, $final);
1763
1764         $file = new File;
1765
1766         $file->filename = $filename;
1767         $file->url      = File::url($filename);
1768         $file->size     = filesize($filepath);
1769         $file->date     = time();
1770         $file->mimetype = 'text/html';
1771
1772         $file_id = $file->insert();
1773
1774         if ($file_id === false) {
1775             common_log_db_error($file, "INSERT", __FILE__);
1776             // TRANS: Server exception.
1777             throw new ServerException(_m('Could not store HTML content of long post as file.'));
1778         }
1779
1780         return $file;
1781     }
1782
1783     static function ensureProfileURI($uri)
1784     {
1785         $oprofile = null;
1786
1787         // First, try to query it
1788
1789         $oprofile = Ostatus_profile::staticGet('uri', $uri);
1790
1791         // If unfound, do discovery stuff
1792
1793         if (empty($oprofile)) {
1794             if (preg_match("/^(\w+)\:(.*)/", $uri, $match)) {
1795                 $protocol = $match[1];
1796                 switch ($protocol) {
1797                 case 'http':
1798                 case 'https':
1799                     $oprofile = Ostatus_profile::ensureProfileURL($uri);
1800                     break;
1801                 case 'acct':
1802                 case 'mailto':
1803                     $rest = $match[2];
1804                     $oprofile = Ostatus_profile::ensureWebfinger($rest);
1805                 default:
1806                     common_log("Unrecognized URI protocol for profile: $protocol ($uri)");
1807                     break;
1808                 }
1809             }
1810         }
1811         return $oprofile;
1812     }
1813 }
1814
1815 /**
1816  * Exception indicating we've got a remote reference to a local user,
1817  * not a remote user!
1818  *
1819  * If we can ue a local profile after all, it's available as $e->profile.
1820  */
1821 class OStatusShadowException extends Exception
1822 {
1823     public $profile;
1824
1825     /**
1826      * @param Profile $profile
1827      * @param string $message
1828      */
1829     function __construct($profile, $message) {
1830         $this->profile = $profile;
1831         parent::__construct($message);
1832     }
1833 }