plugins/OStatus/OStatusPlugin.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 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  26
  27 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/');
  28
  29 class FeedSubException extends Exception
  30 {
  31 }
  32
  33 class OStatusPlugin extends Plugin
  34 {
  35     /**
  36      * Hook for RouterInitialized event.
  37      *
  38      * @param Net_URL_Mapper $m path-to-action mapper
  39      * @return boolean hook return
  40      */
  41     function onRouterInitialized($m)
  42     {
  43         // Discovery actions
  44         $m->connect('.well-known/host-meta',
  45                     array('action' => 'hostmeta'));
  46         $m->connect('main/webfinger',
  47                     array('action' => 'webfinger'));
  48         $m->connect('main/ostatus',
  49                     array('action' => 'ostatusinit'));
  50         $m->connect('main/ostatus?nickname=:nickname',
  51                   array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
  52         $m->connect('main/ostatussub',
  53                     array('action' => 'ostatussub'));
  54         $m->connect('main/ostatussub',
  55                     array('action' => 'ostatussub'), array('feed' => '[A-Za-z0-9\.\/\:]+'));
  56
  57         // PuSH actions
  58         $m->connect('main/push/hub', array('action' => 'pushhub'));
  59
  60         $m->connect('main/push/callback/:feed',
  61                     array('action' => 'pushcallback'),
  62                     array('feed' => '[0-9]+'));
  63
  64         // Salmon endpoint
  65         $m->connect('main/salmon/user/:id',
  66                     array('action' => 'usersalmon'),
  67                     array('id' => '[0-9]+'));
  68         $m->connect('main/salmon/group/:id',
  69                     array('action' => 'groupsalmon'),
  70                     array('id' => '[0-9]+'));
  71         return true;
  72     }
  73
  74     /**
  75      * Set up queue handlers for outgoing hub pushes
  76      * @param QueueManager $qm
  77      * @return boolean hook return
  78      */
  79     function onEndInitializeQueueManager(QueueManager $qm)
  80     {
  81         // Outgoing from our internal PuSH hub
  82         $qm->connect('hubverify', 'HubVerifyQueueHandler');
  83         $qm->connect('hubdistrib', 'HubDistribQueueHandler');
  84         $qm->connect('hubout', 'HubOutQueueHandler');
  85
  86         // Incoming from a foreign PuSH hub
  87         $qm->connect('pushinput', 'PushInputQueueHandler');
  88         return true;
  89     }
  90
  91     /**
  92      * Put saved notices into the queue for pubsub distribution.
  93      */
  94     function onStartEnqueueNotice($notice, &$transports)
  95     {
  96         $transports[] = 'hubdistrib';
  97         return true;
  98     }
  99
 100     /**
 101      * Set up a PuSH hub link to our internal link for canonical timeline
 102      * Atom feeds for users and groups.
 103      */
 104     function onStartApiAtom($feed)
 105     {
 106         $id = null;
 107
 108         if ($feed instanceof AtomUserNoticeFeed) {
 109             $salmonAction = 'usersalmon';
 110             $user = $feed->getUser();
 111             $id   = $user->id;
 112             $profile = $user->getProfile();
 113             $feed->setActivitySubject($profile->asActivityNoun('subject'));
 114         } else if ($feed instanceof AtomGroupNoticeFeed) {
 115             $salmonAction = 'groupsalmon';
 116             $group = $feed->getGroup();
 117             $id = $group->id;
 118             $feed->setActivitySubject($group->asActivitySubject());
 119         } else {
 120             return true;
 121         }
 122
 123         if (!empty($id)) {
 124             $hub = common_config('ostatus', 'hub');
 125             if (empty($hub)) {
 126                 // Updates will be handled through our internal PuSH hub.
 127                 $hub = common_local_url('pushhub');
 128             }
 129             $feed->addLink($hub, array('rel' => 'hub'));
 130
 131             // Also, we'll add in the salmon link
 132             $salmon = common_local_url($salmonAction, array('id' => $id));
 133             $feed->addLink($salmon, array('rel' => 'salmon'));
 134         }
 135
 136         return true;
 137     }
 138
 139     /**
 140      * Automatically load the actions and libraries used by the plugin
 141      *
 142      * @param Class $cls the class
 143      *
 144      * @return boolean hook return
 145      *
 146      */
 147     function onAutoload($cls)
 148     {
 149         $base = dirname(__FILE__);
 150         $lower = strtolower($cls);
 151         $map = array('activityverb' => 'activity',
 152                      'activityobject' => 'activity',
 153                      'activityutils' => 'activity');
 154         if (isset($map[$lower])) {
 155             $lower = $map[$lower];
 156         }
 157         $files = array("$base/classes/$cls.php",
 158                        "$base/lib/$lower.php");
 159         if (substr($lower, -6) == 'action') {
 160             $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
 161         }
 162         foreach ($files as $file) {
 163             if (file_exists($file)) {
 164                 include_once $file;
 165                 return false;
 166             }
 167         }
 168         return true;
 169     }
 170
 171     /**
 172      * Add in an OStatus subscribe button
 173      */
 174     function onStartProfileRemoteSubscribe($output, $profile)
 175     {
 176         $cur = common_current_user();
 177
 178         if (empty($cur)) {
 179             // Add an OStatus subscribe
 180             $output->elementStart('li', 'entity_subscribe');
 181             $url = common_local_url('ostatusinit',
 182                                     array('nickname' => $profile->nickname));
 183             $output->element('a', array('href' => $url,
 184                                         'class' => 'entity_remote_subscribe'),
 185                                 _m('Subscribe'));
 186
 187             $output->elementEnd('li');
 188         }
 189
 190         return false;
 191     }
 192
 193     /**
 194      * Check if we've got remote replies to send via Salmon.
 195      *
 196      * @fixme push webfinger lookup & sending to a background queue
 197      * @fixme also detect short-form name for remote subscribees where not ambiguous
 198      */
 199
 200     function onEndNoticeSave($notice)
 201     {
 202         $mentioned = $notice->getReplies();
 203
 204         foreach ($mentioned as $profile_id) {
 205
 206             $oprofile = Ostatus_profile::staticGet('profile_id', $profile_id);
 207
 208             if (!empty($oprofile) && !empty($oprofile->salmonuri)) {
 209
 210                 common_log(LOG_INFO, "Sending notice '{$notice->uri}' to remote profile '{$oprofile->uri}'.");
 211
 212                 // FIXME: this needs to go out in a queue handler
 213
 214                 $xml = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
 215                 $xml .= $notice->asAtomEntry(true, true);
 216
 217                 $salmon = new Salmon();
 218                 $salmon->post($oprofile->salmonuri, $xml);
 219             }
 220         }
 221     }
 222
 223     /**
 224      *
 225      */
 226
 227     function onStartFindMentions($sender, $text, &$mentions)
 228     {
 229         preg_match_all('/(?:^|\s+)@((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)/',
 230                        $text,
 231                        $wmatches,
 232                        PREG_OFFSET_CAPTURE);
 233
 234         foreach ($wmatches[1] as $wmatch) {
 235
 236             $webfinger = $wmatch[0];
 237
 238             $oprofile = Ostatus_profile::ensureWebfinger($webfinger);
 239
 240             if (!empty($oprofile)) {
 241
 242                 $profile = $oprofile->localProfile();
 243
 244                 $mentions[] = array('mentioned' => array($profile),
 245                                     'text' => $wmatch[0],
 246                                     'position' => $wmatch[1],
 247                                     'url' => $profile->profileurl);
 248             }
 249         }
 250
 251         return true;
 252     }
 253
 254     /**
 255      * Make sure necessary tables are filled out.
 256      */
 257     function onCheckSchema() {
 258         $schema = Schema::get();
 259         $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
 260         $schema->ensureTable('ostatus_source', Ostatus_source::schemaDef());
 261         $schema->ensureTable('feedsub', FeedSub::schemaDef());
 262         $schema->ensureTable('hubsub', HubSub::schemaDef());
 263         $schema->ensureTable('magicsig', Magicsig::schemaDef());
 264         return true;
 265     }
 266
 267     function onEndShowStatusNetStyles($action) {
 268         $action->cssLink(common_path('plugins/OStatus/theme/base/css/ostatus.css'));
 269         return true;
 270     }
 271
 272     function onEndShowStatusNetScripts($action) {
 273         $action->script(common_path('plugins/OStatus/js/ostatus.js'));
 274         return true;
 275     }
 276
 277     /**
 278      * Override the "from ostatus" bit in notice lists to link to the
 279      * original post and show the domain it came from.
 280      *
 281      * @param Notice in $notice
 282      * @param string out &$name
 283      * @param string out &$url
 284      * @param string out &$title
 285      * @return mixed hook return code
 286      */
 287     function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
 288     {
 289         if ($notice->source == 'ostatus') {
 290             $bits = parse_url($notice->uri);
 291             $domain = $bits['host'];
 292
 293             $name = $domain;
 294             $url = $notice->uri;
 295             $title = sprintf(_m("Sent from %s via OStatus"), $domain);
 296             return false;
 297         }
 298     }
 299
 300     /**
 301      * Send incoming PuSH feeds for OStatus endpoints in for processing.
 302      *
 303      * @param FeedSub $feedsub
 304      * @param DOMDocument $feed
 305      * @return mixed hook return code
 306      */
 307     function onStartFeedSubReceive($feedsub, $feed)
 308     {
 309         $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
 310         if ($oprofile) {
 311             $oprofile->processFeed($feed);
 312         } else {
 313             common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
 314         }
 315     }
 316
 317     /**
 318      * When about to subscribe to a remote user, start a server-to-server
 319      * PuSH subscription if needed. If we can't establish that, abort.
 320      *
 321      * @fixme If something else aborts later, we could end up with a stray
 322      *        PuSH subscription. This is relatively harmless, though.
 323      *
 324      * @param Profile $subscriber
 325      * @param Profile $other
 326      *
 327      * @return hook return code
 328      *
 329      * @throws Exception
 330      */
 331     function onStartSubscribe($subscriber, $other)
 332     {
 333         $user = User::staticGet('id', $subscriber->id);
 334
 335         if (empty($user)) {
 336             return true;
 337         }
 338
 339         $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
 340
 341         if (empty($oprofile)) {
 342             return true;
 343         }
 344
 345         if (!$oprofile->subscribe()) {
 346             throw new Exception(_m('Could not set up remote subscription.'));
 347         }
 348     }
 349
 350     /**
 351      * Having established a remote subscription, send a notification to the
 352      * remote OStatus profile's endpoint.
 353      *
 354      * @param Profile $subscriber
 355      * @param Profile $other
 356      *
 357      * @return hook return code
 358      *
 359      * @throws Exception
 360      */
 361     function onEndSubscribe($subscriber, $other)
 362     {
 363         $user = User::staticGet('id', $subscriber->id);
 364
 365         if (empty($user)) {
 366             return true;
 367         }
 368
 369         $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
 370
 371         if (empty($oprofile)) {
 372             return true;
 373         }
 374
 375         $act = new Activity();
 376
 377         $act->verb = ActivityVerb::FOLLOW;
 378
 379         $act->id   = TagURI::mint('follow:%d:%d:%s',
 380                                   $subscriber->id,
 381                                   $other->id,
 382                                   common_date_iso8601(time()));
 383
 384         $act->time    = time();
 385         $act->title   = _("Follow");
 386         $act->content = sprintf(_("%s is now following %s."),
 387                                $subscriber->getBestName(),
 388                                $other->getBestName());
 389
 390         $act->actor   = ActivityObject::fromProfile($subscriber);
 391         $act->object  = ActivityObject::fromProfile($other);
 392
 393         $oprofile->notifyActivity($act);
 394
 395         return true;
 396     }
 397
 398     /**
 399      * Notify remote server and garbage collect unused feeds on unsubscribe.
 400      * @fixme send these operations to background queues
 401      *
 402      * @param User $user
 403      * @param Profile $other
 404      * @return hook return value
 405      */
 406     function onEndUnsubscribe($profile, $other)
 407     {
 408         $user = User::staticGet('id', $profile->id);
 409
 410         if (empty($user)) {
 411             return true;
 412         }
 413
 414         $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
 415
 416         if (empty($oprofile)) {
 417             return true;
 418         }
 419
 420         // Drop the PuSH subscription if there are no other subscribers.
 421         $oprofile->garbageCollect();
 422
 423         $act = new Activity();
 424
 425         $act->verb = ActivityVerb::UNFOLLOW;
 426
 427         $act->id   = TagURI::mint('unfollow:%d:%d:%s',
 428                                   $profile->id,
 429                                   $other->id,
 430                                   common_date_iso8601(time()));
 431
 432         $act->time    = time();
 433         $act->title   = _("Unfollow");
 434         $act->content = sprintf(_("%s stopped following %s."),
 435                                $profile->getBestName(),
 436                                $other->getBestName());
 437
 438         $act->actor   = ActivityObject::fromProfile($profile);
 439         $act->object  = ActivityObject::fromProfile($other);
 440
 441         $oprofile->notifyActivity($act);
 442
 443         return true;
 444     }
 445
 446     /**
 447      * When one of our local users tries to join a remote group,
 448      * notify the remote server. If the notification is rejected,
 449      * deny the join.
 450      *
 451      * @param User_group $group
 452      * @param User $user
 453      *
 454      * @return mixed hook return value
 455      */
 456
 457     function onStartJoinGroup($group, $user)
 458     {
 459         $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
 460         if ($oprofile) {
 461             if (!$oprofile->subscribe()) {
 462                 throw new Exception(_m('Could not set up remote group membership.'));
 463             }
 464
 465             $member = Profile::staticGet($user->id);
 466
 467             $act = new Activity();
 468             $act->id = TagURI::mint('join:%d:%d:%s',
 469                                     $member->id,
 470                                     $group->id,
 471                                     common_date_iso8601(time()));
 472
 473             $act->actor = ActivityObject::fromProfile($member);
 474             $act->verb = ActivityVerb::JOIN;
 475             $act->object = $oprofile->asActivityObject();
 476
 477             $act->time = time();
 478             $act->title = _m("Join");
 479             $act->content = sprintf(_m("%s has joined group %s."),
 480                                     $member->getBestName(),
 481                                     $oprofile->getBestName());
 482
 483             if ($oprofile->notifyActivity($act)) {
 484                 return true;
 485             } else {
 486                 $oprofile->garbageCollect();
 487                 throw new Exception(_m("Failed joining remote group."));
 488             }
 489         }
 490     }
 491
 492     /**
 493      * When one of our local users leaves a remote group, notify the remote
 494      * server.
 495      *
 496      * @fixme Might be good to schedule a resend of the leave notification
 497      * if it failed due to a transitory error. We've canceled the local
 498      * membership already anyway, but if the remote server comes back up
 499      * it'll be left with a stray membership record.
 500      *
 501      * @param User_group $group
 502      * @param User $user
 503      *
 504      * @return mixed hook return value
 505      */
 506
 507     function onEndLeaveGroup($group, $user)
 508     {
 509         $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
 510         if ($oprofile) {
 511             // Drop the PuSH subscription if there are no other subscribers.
 512
 513             $members = $group->getMembers(0, 1);
 514             if ($members->N == 0) {
 515                 common_log(LOG_INFO, "Unsubscribing from now-unused group feed $oprofile->feeduri");
 516                 $oprofile->unsubscribe();
 517             }
 518
 519             $member = Profile::staticGet($user->id);
 520
 521             $act = new Activity();
 522             $act->id = TagURI::mint('leave:%d:%d:%s',
 523                                     $member->id,
 524                                     $group->id,
 525                                     common_date_iso8601(time()));
 526
 527             $act->actor = ActivityObject::fromProfile($member);
 528             $act->verb = ActivityVerb::LEAVE;
 529             $act->object = $oprofile->asActivityObject();
 530
 531             $act->time = time();
 532             $act->title = _m("Leave");
 533             $act->content = sprintf(_m("%s has left group %s."),
 534                                     $member->getBestName(),
 535                                     $oprofile->getBestName());
 536
 537             $oprofile->notifyActivity($act);
 538         }
 539     }
 540
 541     /**
 542      * Notify remote users when their notices get favorited.
 543      *
 544      * @param Profile or User $profile of local user doing the faving
 545      * @param Notice $notice being favored
 546      * @return hook return value
 547      */
 548
 549     function onEndFavorNotice(Profile $profile, Notice $notice)
 550     {
 551         $user = User::staticGet('id', $profile->id);
 552
 553         if (empty($user)) {
 554             return true;
 555         }
 556
 557         $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
 558
 559         if (empty($oprofile)) {
 560             return true;
 561         }
 562
 563         $act = new Activity();
 564
 565         $act->verb = ActivityVerb::FAVORITE;
 566         $act->id   = TagURI::mint('favor:%d:%d:%s',
 567                                   $profile->id,
 568                                   $notice->id,
 569                                   common_date_iso8601(time()));
 570
 571         $act->time    = time();
 572         $act->title   = _("Favor");
 573         $act->content = sprintf(_("%s marked notice %s as a favorite."),
 574                                $profile->getBestName(),
 575                                $notice->uri);
 576
 577         $act->actor   = ActivityObject::fromProfile($profile);
 578         $act->object  = ActivityObject::fromNotice($notice);
 579
 580         $oprofile->notifyActivity($act);
 581
 582         return true;
 583     }
 584
 585     /**
 586      * Notify remote users when their notices get de-favorited.
 587      *
 588      * @param Profile $profile Profile person doing the de-faving
 589      * @param Notice  $notice  Notice being favored
 590      *
 591      * @return hook return value
 592      */
 593
 594     function onEndDisfavorNotice(Profile $profile, Notice $notice)
 595     {
 596         $user = User::staticGet('id', $profile->id);
 597
 598         if (empty($user)) {
 599             return true;
 600         }
 601
 602         $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
 603
 604         if (empty($oprofile)) {
 605             return true;
 606         }
 607
 608         $act = new Activity();
 609
 610         $act->verb = ActivityVerb::UNFAVORITE;
 611         $act->id   = TagURI::mint('disfavor:%d:%d:%s',
 612                                   $profile->id,
 613                                   $notice->id,
 614                                   common_date_iso8601(time()));
 615         $act->time    = time();
 616         $act->title   = _("Disfavor");
 617         $act->content = sprintf(_("%s marked notice %s as no longer a favorite."),
 618                                $profile->getBestName(),
 619                                $notice->uri);
 620
 621         $act->actor   = ActivityObject::fromProfile($profile);
 622         $act->object  = ActivityObject::fromNotice($notice);
 623
 624         $oprofile->notifyActivity($act);
 625
 626         return true;
 627     }
 628
 629     function onStartGetProfileUri($profile, &$uri)
 630     {
 631         $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
 632         if (!empty($oprofile)) {
 633             $uri = $oprofile->uri;
 634             return false;
 635         }
 636         return true;
 637     }
 638
 639     function onStartUserGroupHomeUrl($group, &$url)
 640     {
 641         return $this->onStartUserGroupPermalink($group, &$url);
 642     }
 643
 644     function onStartUserGroupPermalink($group, &$url)
 645     {
 646         $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
 647         if ($oprofile) {
 648             // @fixme this should probably be in the user_group table
 649             // @fixme this uri not guaranteed to be a profile page
 650             $url = $oprofile->uri;
 651             return false;
 652         }
 653     }
 654
 655     function onStartShowSubscriptionsContent($action)
 656     {
 657         $user = common_current_user();
 658         if ($user && ($user->id == $action->profile->id)) {
 659             $action->elementStart('div', 'entity_actions');
 660             $action->elementStart('p', array('id' => 'entity_remote_subscribe',
 661                                              'class' => 'entity_subscribe'));
 662             $action->element('a', array('href' => common_local_url('ostatussub'),
 663                                         'class' => 'entity_remote_subscribe')
 664                                 , _m('Subscribe to remote user'));
 665             $action->elementEnd('p');
 666             $action->elementEnd('div');
 667         }
 668
 669         return true;
 670     }
 671 }