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 /**
  21  * @package OStatusPlugin
  22  * @maintainer Brion Vibber <brion@status.net>
  23  */
  24
  25 class Ostatus_profile extends Memcached_DataObject
  26 {
  27     public $__table = 'ostatus_profile';
  28
  29     public $uri;
  30
  31     public $profile_id;
  32     public $group_id;
  33
  34     public $feeduri;
  35     public $salmonuri;
  36
  37     public $created;
  38     public $modified;
  39
  40     public /*static*/ function staticGet($k, $v=null)
  41     {
  42         return parent::staticGet(__CLASS__, $k, $v);
  43     }
  44
  45     /**
  46      * return table definition for DB_DataObject
  47      *
  48      * DB_DataObject needs to know something about the table to manipulate
  49      * instances. This method provides all the DB_DataObject needs to know.
  50      *
  51      * @return array array of column definitions
  52      */
  53
  54     function table()
  55     {
  56         return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  57                      'profile_id' => DB_DATAOBJECT_INT,
  58                      'group_id' => DB_DATAOBJECT_INT,
  59                      'feeduri' => DB_DATAOBJECT_STR,
  60                      'salmonuri' =>  DB_DATAOBJECT_STR,
  61                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
  62                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  63     }
  64
  65     static function schemaDef()
  66     {
  67         return array(new ColumnDef('uri', 'varchar',
  68                                    255, false, 'PRI'),
  69                      new ColumnDef('profile_id', 'integer',
  70                                    null, true, 'UNI'),
  71                      new ColumnDef('group_id', 'integer',
  72                                    null, true, 'UNI'),
  73                      new ColumnDef('feeduri', 'varchar',
  74                                    255, true, 'UNI'),
  75                      new ColumnDef('salmonuri', 'text',
  76                                    null, true),
  77                      new ColumnDef('created', 'datetime',
  78                                    null, false),
  79                      new ColumnDef('modified', 'datetime',
  80                                    null, false));
  81     }
  82
  83     /**
  84      * return key definitions for DB_DataObject
  85      *
  86      * DB_DataObject needs to know about keys that the table has; this function
  87      * defines them.
  88      *
  89      * @return array key definitions
  90      */
  91
  92     function keys()
  93     {
  94         return array_keys($this->keyTypes());
  95     }
  96
  97     /**
  98      * return key definitions for Memcached_DataObject
  99      *
 100      * Our caching system uses the same key definitions, but uses a different
 101      * method to get them.
 102      *
 103      * @return array key definitions
 104      */
 105
 106     function keyTypes()
 107     {
 108         return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
 109     }
 110
 111     function sequenceKey()
 112     {
 113         return array(false, false, false);
 114     }
 115
 116     /**
 117      * Fetch the StatusNet-side profile for this feed
 118      * @return Profile
 119      */
 120     public function localProfile()
 121     {
 122         if ($this->profile_id) {
 123             return Profile::staticGet('id', $this->profile_id);
 124         }
 125         return null;
 126     }
 127
 128     /**
 129      * Fetch the StatusNet-side profile for this feed
 130      * @return Profile
 131      */
 132     public function localGroup()
 133     {
 134         if ($this->group_id) {
 135             return User_group::staticGet('id', $this->group_id);
 136         }
 137         return null;
 138     }
 139
 140     /**
 141      * Returns an XML string fragment with profile information as an
 142      * Activity Streams noun object with the given element type.
 143      *
 144      * Assumes that 'activity' namespace has been previously defined.
 145      *
 146      * @param string $element one of 'actor', 'subject', 'object', 'target'
 147      * @return string
 148      */
 149     function asActivityNoun($element)
 150     {
 151         $xs = new XMLStringer(true);
 152         $avatarHref = Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 153         $avatarType = 'image/png';
 154         if ($this->isGroup()) {
 155             $type = 'http://activitystrea.ms/schema/1.0/group';
 156             $self = $this->localGroup();
 157
 158             // @fixme put a standard getAvatar() interface on groups too
 159             if ($self->homepage_logo) {
 160                 $avatarHref = $self->homepage_logo;
 161                 $map = array('png' => 'image/png',
 162                              'jpg' => 'image/jpeg',
 163                              'jpeg' => 'image/jpeg',
 164                              'gif' => 'image/gif');
 165                 $extension = pathinfo(parse_url($avatarHref, PHP_URL_PATH), PATHINFO_EXTENSION);
 166                 if (isset($map[$extension])) {
 167                     $avatarType = $map[$extension];
 168                 }
 169             }
 170         } else {
 171             $type = 'http://activitystrea.ms/schema/1.0/person';
 172             $self = $this->localProfile();
 173             $avatar = $self->getAvatar(AVATAR_PROFILE_SIZE);
 174             if ($avatar) {
 175                   $avatarHref = $avatar->url;
 176                   $avatarType = $avatar->mediatype;
 177             }
 178         }
 179         $xs->elementStart('activity:' . $element);
 180         $xs->element(
 181             'activity:object-type',
 182             null,
 183             $type
 184         );
 185         $xs->element(
 186             'id',
 187             null,
 188             $this->uri); // ?
 189         $xs->element('title', null, $self->getBestName());
 190
 191         $xs->element(
 192             'link', array(
 193                 'type' => $avatarType,
 194                 'href' => $avatarHref
 195             ),
 196             ''
 197         );
 198
 199         $xs->elementEnd('activity:' . $element);
 200
 201         return $xs->getString();
 202     }
 203
 204     /**
 205      * Damn dirty hack!
 206      */
 207     function isGroup()
 208     {
 209         return (strpos($this->feeduri, '/groups/') !== false);
 210     }
 211
 212     /**
 213      * Subscribe a local user to this remote user.
 214      * PuSH subscription will be started if necessary, and we'll
 215      * send a Salmon notification to the remote server if available
 216      * notifying them of the sub.
 217      *
 218      * @param User $user
 219      * @return boolean success
 220      * @throws FeedException
 221      */
 222     public function subscribeLocalToRemote(User $user)
 223     {
 224         if ($this->isGroup()) {
 225             throw new ServerException("Can't subscribe to a remote group");
 226         }
 227
 228         if ($this->subscribe()) {
 229             if ($user->subscribeTo($this->localProfile())) {
 230                 $this->notify($user->getProfile(), ActivityVerb::FOLLOW, $this);
 231                 return true;
 232             }
 233         }
 234         return false;
 235     }
 236
 237     /**
 238      * Mark this remote profile as subscribing to the given local user,
 239      * and send appropriate notifications to the user.
 240      *
 241      * This will generally be in response to a subscription notification
 242      * from a foreign site to our local Salmon response channel.
 243      *
 244      * @param User $user
 245      * @return boolean success
 246      */
 247     public function subscribeRemoteToLocal(User $user)
 248     {
 249         if ($this->isGroup()) {
 250             throw new ServerException("Remote groups can't subscribe to local users");
 251         }
 252
 253         // @fixme use regular channels for subbing, once they accept remote profiles
 254         $sub = new Subscription();
 255         $sub->subscriber = $this->profile_id;
 256         $sub->subscribed = $user->id;
 257         $sub->created = common_sql_now(); // current time
 258
 259         if ($sub->insert()) {
 260             // @fixme use subs_notify() if refactored to take profiles?
 261             mail_subscribe_notify_profile($user, $this->localProfile());
 262             return true;
 263         }
 264         return false;
 265     }
 266
 267     /**
 268      * Send a subscription request to the hub for this feed.
 269      * The hub will later send us a confirmation POST to /main/push/callback.
 270      *
 271      * @return bool true on success, false on failure
 272      * @throws ServerException if feed state is not valid
 273      */
 274     public function subscribe()
 275     {
 276         $feedsub = FeedSub::ensureFeed($this->feeduri);
 277         if ($feedsub->sub_state == 'active' || $feedsub->sub_state == 'subscribe') {
 278             return true;
 279         } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
 280             return $feedsub->subscribe();
 281         } else if ('unsubscribe') {
 282             throw new FeedSubException("Unsub is pending, can't subscribe...");
 283         }
 284     }
 285
 286     /**
 287      * Send a PuSH unsubscription request to the hub for this feed.
 288      * The hub will later send us a confirmation POST to /main/push/callback.
 289      *
 290      * @return bool true on success, false on failure
 291      * @throws ServerException if feed state is not valid
 292      */
 293     public function unsubscribe() {
 294         $feedsub = FeedSub::staticGet('uri', $this->feeduri);
 295         if ($feedsub->sub_state == 'active') {
 296             return $feedsub->unsubscribe();
 297         } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive' || $feedsub->sub_state == 'unsubscribe') {
 298             return true;
 299         } else if ($feedsub->sub_state == 'subscribe') {
 300             throw new FeedSubException("Feed is awaiting subscription, can't unsub...");
 301         }
 302     }
 303
 304     /**
 305      * Send an Activity Streams notification to the remote Salmon endpoint,
 306      * if so configured.
 307      *
 308      * @param Profile $actor  Actor who did the activity
 309      * @param string  $verb   Activity::SUBSCRIBE or Activity::JOIN
 310      * @param Object  $object object of the action; must define asActivityNoun($tag)
 311      */
 312     public function notify($actor, $verb, $object=null)
 313     {
 314         if (!($actor instanceof Profile)) {
 315             $type = gettype($actor);
 316             if ($type == 'object') {
 317                 $type = get_class($actor);
 318             }
 319             throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
 320         }
 321         if ($object == null) {
 322             $object = $this;
 323         }
 324         if ($this->salmonuri) {
 325
 326             $text = 'update';
 327             $id = TagURI::mint('%s:%s:%s',
 328                                $verb,
 329                                $actor->getURI(),
 330                                common_date_iso8601(time()));
 331
 332             // @fixme consolidate all these NS settings somewhere
 333             $attributes = array('xmlns' => Activity::ATOM,
 334                                 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
 335                                 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
 336                                 'xmlns:georss' => 'http://www.georss.org/georss',
 337                                 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0');
 338
 339             $entry = new XMLStringer();
 340             $entry->elementStart('entry', $attributes);
 341             $entry->element('id', null, $id);
 342             $entry->element('title', null, $text);
 343             $entry->element('summary', null, $text);
 344             $entry->element('published', null, common_date_w3dtf(common_sql_now()));
 345
 346             $entry->element('activity:verb', null, $verb);
 347             $entry->raw($actor->asAtomAuthor());
 348             $entry->raw($actor->asActivityActor());
 349             $entry->raw($object->asActivityNoun('object'));
 350             $entry->elementEnd('entry');
 351
 352             $xml = $entry->getString();
 353             common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
 354
 355             $salmon = new Salmon(); // ?
 356             $salmon->post($this->salmonuri, $xml);
 357         }
 358     }
 359
 360     public function notifyActivity($activity)
 361     {
 362         if ($this->salmonuri) {
 363
 364             $xml = $activity->asString(true);
 365
 366             $salmon = new Salmon(); // ?
 367
 368             $salmon->post($this->salmonuri, $xml);
 369         }
 370
 371         return;
 372     }
 373
 374     function getBestName()
 375     {
 376         if ($this->isGroup()) {
 377             return $this->localGroup()->getBestName();
 378         } else {
 379             return $this->localProfile()->getBestName();
 380         }
 381     }
 382
 383     function atomFeed($actor)
 384     {
 385         $feed = new Atom10Feed();
 386         // @fixme should these be set up somewhere else?
 387         $feed->addNamespace('activity', 'http://activitystrea.ms/spec/1.0/');
 388         $feed->addNamespace('thr', 'http://purl.org/syndication/thread/1.0');
 389         $feed->addNamespace('georss', 'http://www.georss.org/georss');
 390         $feed->addNamespace('ostatus', 'http://ostatus.org/schema/1.0');
 391
 392         $taguribase = common_config('integration', 'taguri');
 393         $feed->setId("tag:{$taguribase}:UserTimeline:{$actor->id}"); // ???
 394
 395         $feed->setTitle($actor->getBestName() . ' timeline'); // @fixme
 396         $feed->setUpdated(time());
 397         $feed->setPublished(time());
 398
 399         $feed->addLink(common_local_url('ApiTimelineUser',
 400                                         array('id' => $actor->id,
 401                                               'type' => 'atom')),
 402                        array('rel' => 'self',
 403                              'type' => 'application/atom+xml'));
 404
 405         $feed->addLink(common_local_url('userbyid',
 406                                         array('id' => $actor->id)),
 407                        array('rel' => 'alternate',
 408                              'type' => 'text/html'));
 409
 410         return $feed;
 411     }
 412
 413     /**
 414      * Read and post notices for updates from the feed.
 415      * Currently assumes that all items in the feed are new,
 416      * coming from a PuSH hub.
 417      *
 418      * @param DOMDocument $feed
 419      */
 420     public function processFeed($feed)
 421     {
 422         $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
 423         if ($entries->length == 0) {
 424             common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
 425             return;
 426         }
 427
 428         for ($i = 0; $i < $entries->length; $i++) {
 429             $entry = $entries->item($i);
 430             $this->processEntry($entry, $feed);
 431         }
 432     }
 433
 434     /**
 435      * Process a posted entry from this feed source.
 436      *
 437      * @param DOMElement $entry
 438      * @param DOMElement $feed for context
 439      */
 440     protected function processEntry($entry, $feed)
 441     {
 442         $activity = new Activity($entry, $feed);
 443
 444         $debug = var_export($activity, true);
 445         common_log(LOG_DEBUG, $debug);
 446
 447         if ($activity->verb == ActivityVerb::POST) {
 448             $this->processPost($activity);
 449         } else {
 450             common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
 451         }
 452     }
 453
 454     /**
 455      * Process an incoming post activity from this remote feed.
 456      * @param Activity $activity
 457      */
 458     protected function processPost($activity)
 459     {
 460         if ($this->isGroup()) {
 461             // @fixme validate these profiles in some way!
 462             $oprofile = self::ensureActorProfile($activity);
 463         } else {
 464             $actorUri = self::getActorProfileURI($activity);
 465             if ($actorUri == $this->uri) {
 466                 // @fixme check if profile info has changed and update it
 467             } else {
 468                 // @fixme drop or reject the messages once we've got the canonical profile URI recorded sanely
 469                 common_log(LOG_INFO, "OStatus: Warning: non-group post with unexpected author: $actorUri expected $this->uri");
 470                 //return;
 471             }
 472             $oprofile = $this;
 473         }
 474
 475         $sourceUri = $activity->object->id;
 476
 477         $dupe = Notice::staticGet('uri', $sourceUri);
 478
 479         if ($dupe) {
 480             common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
 481             return;
 482         }
 483
 484         $sourceUrl = null;
 485
 486         if ($activity->object->link) {
 487             $sourceUrl = $activity->object->link;
 488         } else if (preg_match('!^https?://!', $activity->object->id)) {
 489             $sourceUrl = $activity->object->id;
 490         }
 491
 492         // @fixme sanitize and save HTML content if available
 493
 494         $content = $activity->object->title;
 495
 496         $params = array('is_local' => Notice::REMOTE_OMB,
 497                         'url' => $sourceUrl,
 498                         'uri' => $sourceUri);
 499
 500         $location = $activity->context->location;
 501
 502         if ($location) {
 503             $params['lat'] = $location->lat;
 504             $params['lon'] = $location->lon;
 505             if ($location->location_id) {
 506                 $params['location_ns'] = $location->location_ns;
 507                 $params['location_id'] = $location->location_id;
 508             }
 509         }
 510
 511         // @fixme ensure that groups get handled correctly
 512
 513         $saved = Notice::saveNew($oprofile->localProfile()->id,
 514                                  $content,
 515                                  'ostatus',
 516                                  $params);
 517
 518         // Record which feed this came through...
 519         Ostatus_source::saveNew($saved, $this, 'push');
 520     }
 521
 522     /**
 523      * @param string $profile_url
 524      * @return Ostatus_profile
 525      * @throws FeedSubException
 526      */
 527     public static function ensureProfile($profile_uri, $hints=array())
 528     {
 529         // Get the canonical feed URI and check it
 530         $discover = new FeedDiscovery();
 531         $feeduri = $discover->discoverFromURL($profile_uri);
 532
 533         //$feedsub = FeedSub::ensureFeed($feeduri, $discover->feed);
 534         $huburi = $discover->getAtomLink('hub');
 535         $salmonuri = $discover->getAtomLink('salmon');
 536
 537         if (!$huburi) {
 538             // We can only deal with folks with a PuSH hub
 539             throw new FeedSubNoHubException();
 540         }
 541
 542         // Try to get a profile from the feed activity:subject
 543
 544         $feedEl = $discover->feed->documentElement;
 545
 546         $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
 547
 548         if (!empty($subject)) {
 549             $subjObject = new ActivityObject($subject);
 550             return self::ensureActivityObjectProfile($subjObject, $feeduri, $salmonuri, $hints);
 551         }
 552
 553         // Otherwise, try the feed author
 554
 555         $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
 556
 557         if (!empty($author)) {
 558             $authorObject = new ActivityObject($author);
 559             return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri, $hints);
 560         }
 561
 562         // Sheesh. Not a very nice feed! Let's try fingerpoken in the
 563         // entries.
 564
 565         $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
 566
 567         if (!empty($entries) && $entries->length > 0) {
 568
 569             $entry = $entries->item(0);
 570
 571             $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
 572
 573             if (!empty($actor)) {
 574                 $actorObject = new ActivityObject($actor);
 575                 return self::ensureActivityObjectProfile($actorObject, $feeduri, $salmonuri, $hints);
 576
 577             }
 578
 579             $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
 580
 581             if (!empty($author)) {
 582                 $authorObject = new ActivityObject($author);
 583                 return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri, $hints);
 584             }
 585         }
 586
 587         // XXX: make some educated guesses here
 588
 589         throw new FeedSubException("Can't find enough profile information to make a feed.");
 590     }
 591
 592     /**
 593      *
 594      * Download and update given avatar image
 595      * @param string $url
 596      * @throws Exception in various failure cases
 597      */
 598     protected function updateAvatar($url)
 599     {
 600         // @fixme this should be better encapsulated
 601         // ripped from oauthstore.php (for old OMB client)
 602         $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
 603         copy($url, $temp_filename);
 604
 605         if ($this->isGroup()) {
 606             $id = $this->group_id;
 607         } else {
 608             $id = $this->profile_id;
 609         }
 610         // @fixme should we be using different ids?
 611         $imagefile = new ImageFile($id, $temp_filename);
 612         $filename = Avatar::filename($id,
 613                                      image_type_to_extension($imagefile->type),
 614                                      null,
 615                                      common_timestamp());
 616         rename($temp_filename, Avatar::path($filename));
 617         if ($this->isGroup()) {
 618             $group = $this->localGroup();
 619             $group->setOriginal($filename);
 620         } else {
 621             $profile = $this->localProfile();
 622             $profile->setOriginal($filename);
 623         }
 624     }
 625
 626     protected static function getActivityObjectAvatar($object)
 627     {
 628         // XXX: go poke around in the feed
 629         return $object->avatar;
 630     }
 631
 632     /**
 633      * Get an appropriate avatar image source URL, if available.
 634      *
 635      * @param ActivityObject $actor
 636      * @param DOMElement $feed
 637      * @return string
 638      */
 639
 640     protected static function getAvatar($actor, $feed)
 641     {
 642         $url = '';
 643         $icon = '';
 644         if ($actor->avatar) {
 645             $url = trim($actor->avatar);
 646         }
 647         if (!$url) {
 648             // Check <atom:logo> and <atom:icon> on the feed
 649             $els = $feed->childNodes();
 650             if ($els && $els->length) {
 651                 for ($i = 0; $i < $els->length; $i++) {
 652                     $el = $els->item($i);
 653                     if ($el->namespaceURI == Activity::ATOM) {
 654                         if (empty($url) && $el->localName == 'logo') {
 655                             $url = trim($el->textContent);
 656                             break;
 657                         }
 658                         if (empty($icon) && $el->localName == 'icon') {
 659                             // Use as a fallback
 660                             $icon = trim($el->textContent);
 661                         }
 662                     }
 663                 }
 664             }
 665             if ($icon && !$url) {
 666                 $url = $icon;
 667             }
 668         }
 669         if ($url) {
 670             $opts = array('allowed_schemes' => array('http', 'https'));
 671             if (Validate::uri($url, $opts)) {
 672                 return $url;
 673             }
 674         }
 675         return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
 676     }
 677
 678     /**
 679      * Fetch, or build if necessary, an Ostatus_profile for the actor
 680      * in a given Activity Streams activity.
 681      *
 682      * @param Activity $activity
 683      * @param string $feeduri if we already know the canonical feed URI!
 684      * @param string $salmonuri if we already know the salmon return channel URI
 685      * @return Ostatus_profile
 686      */
 687
 688     public static function ensureActorProfile($activity, $feeduri=null, $salmonuri=null)
 689     {
 690         return self::ensureActivityObjectProfile($activity->actor, $feeduri, $salmonuri);
 691     }
 692
 693     public static function ensureActivityObjectProfile($object, $feeduri=null, $salmonuri=null, $hints=array())
 694     {
 695         $profile = self::getActivityObjectProfile($object);
 696         if (!$profile) {
 697             $profile = self::createActivityObjectProfile($object, $feeduri, $salmonuri, $hints);
 698         }
 699         return $profile;
 700     }
 701
 702     /**
 703      * @param Activity $activity
 704      * @return mixed matching Ostatus_profile or false if none known
 705      */
 706     protected static function getActorProfile($activity)
 707     {
 708         return self::getActivityObjectProfile($activity->actor);
 709     }
 710
 711     protected static function getActivityObjectProfile($object)
 712     {
 713         $uri = self::getActivityObjectProfileURI($object);
 714         return Ostatus_profile::staticGet('uri', $uri);
 715     }
 716
 717     protected static function getActorProfileURI($activity)
 718     {
 719         return self::getActivityObjectProfileURI($activity->actor);
 720     }
 721
 722     /**
 723      * @param Activity $activity
 724      * @return string
 725      * @throws ServerException
 726      */
 727     protected static function getActivityObjectProfileURI($object)
 728     {
 729         $opts = array('allowed_schemes' => array('http', 'https'));
 730         if ($object->id && Validate::uri($object->id, $opts)) {
 731             return $object->id;
 732         }
 733         if ($object->link && Validate::uri($object->link, $opts)) {
 734             return $object->link;
 735         }
 736         throw new ServerException("No author ID URI found");
 737     }
 738
 739     /**
 740      * @fixme validate stuff somewhere
 741      */
 742
 743     protected static function createActorProfile($activity, $feeduri=null, $salmonuri=null)
 744     {
 745         $actor = $activity->actor;
 746
 747         self::createActivityObjectProfile($actor, $feeduri, $salmonuri);
 748     }
 749
 750     protected static function createActivityObjectProfile($object, $feeduri=null, $salmonuri=null, $hints=array())
 751     {
 752         $homeuri  = $object->id;
 753         $nickname = self::getActivityObjectNickname($object, $hints);
 754         $avatar   = self::getActivityObjectAvatar($object);
 755
 756         if (!$homeuri) {
 757             common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
 758             throw new ServerException("No profile URI");
 759         }
 760
 761         if (empty($feeduri)) {
 762             if (array_key_exists('feedurl', $hints)) {
 763                 $feeduri = $hints['feedurl'];
 764             }
 765         }
 766
 767         if (empty($salmonuri)) {
 768             if (array_key_exists('salmon', $hints)) {
 769                 $salmonuri = $hints['salmon'];
 770             }
 771         }
 772
 773         if (!$feeduri || !$salmonuri) {
 774             // Get the canonical feed URI and check it
 775             $discover = new FeedDiscovery();
 776             $feeduri = $discover->discoverFromURL($homeuri);
 777
 778             $huburi = $discover->getAtomLink('hub');
 779             $salmonuri = $discover->getAtomLink('salmon');
 780
 781             if (!$huburi) {
 782                 // We can only deal with folks with a PuSH hub
 783                 throw new FeedSubNoHubException();
 784             }
 785         }
 786
 787         $profile = new Profile();
 788         $profile->nickname   = $nickname;
 789         $profile->fullname   = $object->title;
 790         if (!empty($object->link)) {
 791             $profile->profileurl = $object->link;
 792         } else if (array_key_exists('profileurl', $hints)) {
 793             $profile->profileurl = $hints['profileurl'];
 794         }
 795         $profile->created    = common_sql_now();
 796
 797         // @fixme bio
 798         // @fixme tags/categories
 799         // @fixme location?
 800         // @todo tags from categories
 801         // @todo lat/lon/location?
 802
 803         $profile_id = $profile->insert();
 804
 805         if (!$profile_id) {
 806             throw new ServerException("Can't save local profile");
 807         }
 808
 809         // @fixme either need to do feed discovery here
 810         // or need to split out some of the feed stuff
 811         // so we can leave it empty until later.
 812
 813         $oprofile = new Ostatus_profile();
 814
 815         $oprofile->uri        = $homeuri;
 816         $oprofile->feeduri    = $feeduri;
 817         $oprofile->salmonuri  = $salmonuri;
 818         $oprofile->profile_id = $profile_id;
 819
 820         $oprofile->created    = common_sql_now();
 821         $oprofile->modified   = common_sql_now();
 822
 823         $ok = $oprofile->insert();
 824
 825         if ($ok) {
 826             $oprofile->updateAvatar($avatar);
 827             return $oprofile;
 828         } else {
 829             throw new ServerException("Can't save OStatus profile");
 830         }
 831     }
 832
 833     protected static function getActivityObjectNickname($object, $hints=array())
 834     {
 835         // XXX: check whatever PoCo calls a nickname first
 836
 837         // Try the definitive ID
 838
 839         $nickname = self::nicknameFromURI($object->id);
 840
 841         // Try a Webfinger if one was passed (way) down
 842
 843         if (empty($nickname)) {
 844             if (array_key_exists('webfinger', $hints)) {
 845                 $nickname = self::nicknameFromURI($hints['webfinger']);
 846             }
 847         }
 848
 849         // Try the name
 850
 851         if (empty($nickname)) {
 852             $nickname = common_nicknamize($object->title);
 853         }
 854
 855         return $nickname;
 856     }
 857
 858     protected static function nicknameFromURI($uri)
 859     {
 860         preg_match('/(\w+):/', $uri, $matches);
 861
 862         $protocol = $matches[1];
 863
 864         switch ($protocol) {
 865         case 'acct':
 866         case 'mailto':
 867             if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
 868                 return common_canonical_nickname($matches[1]);
 869             }
 870             return null;
 871         case 'http':
 872             return common_url_to_nickname($uri);
 873             break;
 874         default:
 875             return null;
 876         }
 877     }
 878
 879     public static function ensureWebfinger($addr)
 880     {
 881         // First, look it up
 882
 883         $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
 884
 885         if (!empty($oprofile)) {
 886             return $oprofile;
 887         }
 888
 889         // Now, try some discovery
 890
 891         $wf = new Webfinger();
 892
 893         $result = $wf->lookup($addr);
 894
 895         if (!$result) {
 896             return null;
 897         }
 898
 899         foreach ($result->links as $link) {
 900             switch ($link['rel']) {
 901             case Webfinger::PROFILEPAGE:
 902                 $profileUrl = $link['href'];
 903                 break;
 904             case 'salmon':
 905                 $salmonEndpoint = $link['href'];
 906                 break;
 907             case Webfinger::UPDATESFROM:
 908                 $feedUrl = $link['href'];
 909                 break;
 910             default:
 911                 common_log(LOG_NOTICE, "Don't know what to do with rel = '{$link['rel']}'");
 912                 break;
 913             }
 914         }
 915
 916         $hints = array('webfinger' => $addr,
 917                        'profileurl' => $profileUrl,
 918                        'feedurl' => $feedUrl,
 919                        'salmon' => $salmonEndpoint);
 920
 921         // If we got a feed URL, try that
 922
 923         if (isset($feedUrl)) {
 924             try {
 925                 $oprofile = self::ensureProfile($feedUrl, $hints);
 926                 return $oprofile;
 927             } catch (Exception $e) {
 928                 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
 929                 // keep looking
 930             }
 931         }
 932
 933         // If we got a profile page, try that!
 934
 935         if (isset($profileUrl)) {
 936             try {
 937                 $oprofile = self::ensureProfile($profileUrl, $hints);
 938                 return $oprofile;
 939             } catch (Exception $e) {
 940                 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
 941                 // keep looking
 942             }
 943         }
 944
 945         // XXX: try hcard
 946         // XXX: try FOAF
 947
 948         if (isset($salmonEndpoint)) {
 949
 950             // An account URL, a salmon endpoint, and a dream? Not much to go
 951             // on, but let's give it a try
 952
 953             $uri = 'acct:'.$addr;
 954
 955             $profile = new Profile();
 956
 957             $profile->nickname = self::nicknameFromUri($uri);
 958             $profile->created  = common_sql_now();
 959
 960             if (isset($profileUrl)) {
 961                 $profile->profileurl = $profileUrl;
 962             }
 963
 964             $profile_id = $profile->insert();
 965
 966             if (!$profile_id) {
 967                 common_log_db_error($profile, 'INSERT', __FILE__);
 968                 throw new Exception("Couldn't save profile for '$addr'");
 969             }
 970
 971             $oprofile = new Ostatus_profile();
 972
 973             $oprofile->uri        = $uri;
 974             $oprofile->salmonuri  = $salmonEndpoint;
 975             $oprofile->profile_id = $profile_id;
 976             $oprofile->created    = common_sql_now();
 977
 978             if (isset($feedUrl)) {
 979                 $profile->feeduri = $feedUrl;
 980             }
 981
 982             $result = $oprofile->insert();
 983
 984             if (!$result) {
 985                 common_log_db_error($oprofile, 'INSERT', __FILE__);
 986                 throw new Exception("Couldn't save ostatus_profile for '$addr'");
 987             }
 988
 989             return $oprofile;
 990         }
 991
 992         return null;
 993     }
 994 }