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 onEndFindMentions($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      * Notify remote server and garbage collect unused feeds on unsubscribe.
 256      * @fixme send these operations to background queues
 257      *
 258      * @param User $user
 259      * @param Profile $other
 260      * @return hook return value
 261      */
 262     function onEndUnsubscribe($profile, $other)
 263     {
 264         $user = User::staticGet('id', $profile->id);
 265
 266         if (empty($user)) {
 267             return true;
 268         }
 269
 270         $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
 271
 272         if (empty($oprofile)) {
 273             return true;
 274         }
 275
 276         // Drop the PuSH subscription if there are no other subscribers.
 277
 278         if ($other->subscriberCount() == 0) {
 279             common_log(LOG_INFO, "Unsubscribing from now-unused feed $oprofile->feeduri");
 280             $oprofile->unsubscribe();
 281         }
 282
 283         $act = new Activity();
 284
 285         $act->verb = ActivityVerb::UNFOLLOW;
 286
 287         $act->id   = TagURI::mint('unfollow:%d:%d:%s',
 288                                   $profile->id,
 289                                   $other->id,
 290                                   common_date_iso8601(time()));
 291
 292         $act->time    = time();
 293         $act->title   = _("Unfollow");
 294         $act->content = sprintf(_("%s stopped following %s."),
 295                                $profile->getBestName(),
 296                                $other->getBestName());
 297
 298         $act->actor   = ActivityObject::fromProfile($profile);
 299         $act->object  = ActivityObject::fromProfile($other);
 300
 301         $oprofile->notifyActivity($act);
 302
 303         return true;
 304     }
 305
 306     /**
 307      * Make sure necessary tables are filled out.
 308      */
 309     function onCheckSchema() {
 310         $schema = Schema::get();
 311         $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
 312         $schema->ensureTable('ostatus_source', Ostatus_source::schemaDef());
 313         $schema->ensureTable('feedsub', FeedSub::schemaDef());
 314         $schema->ensureTable('hubsub', HubSub::schemaDef());
 315         $schema->ensureTable('magicsig', Magicsig::schemaDef());
 316         return true;
 317     }
 318
 319     function onEndShowStatusNetStyles($action) {
 320         $action->cssLink(common_path('plugins/OStatus/theme/base/css/ostatus.css'));
 321         return true;
 322     }
 323
 324     function onEndShowStatusNetScripts($action) {
 325         $action->script(common_path('plugins/OStatus/js/ostatus.js'));
 326         return true;
 327     }
 328
 329     /**
 330      * Override the "from ostatus" bit in notice lists to link to the
 331      * original post and show the domain it came from.
 332      *
 333      * @param Notice in $notice
 334      * @param string out &$name
 335      * @param string out &$url
 336      * @param string out &$title
 337      * @return mixed hook return code
 338      */
 339     function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
 340     {
 341         if ($notice->source == 'ostatus') {
 342             $bits = parse_url($notice->uri);
 343             $domain = $bits['host'];
 344
 345             $name = $domain;
 346             $url = $notice->uri;
 347             $title = sprintf(_m("Sent from %s via OStatus"), $domain);
 348             return false;
 349         }
 350     }
 351
 352     /**
 353      * Send incoming PuSH feeds for OStatus endpoints in for processing.
 354      *
 355      * @param FeedSub $feedsub
 356      * @param DOMDocument $feed
 357      * @return mixed hook return code
 358      */
 359     function onStartFeedSubReceive($feedsub, $feed)
 360     {
 361         $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
 362         if ($oprofile) {
 363             $oprofile->processFeed($feed);
 364         } else {
 365             common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
 366         }
 367     }
 368
 369     function onEndSubscribe($subscriber, $other)
 370     {
 371         $user = User::staticGet('id', $subscriber->id);
 372
 373         if (empty($user)) {
 374             return true;
 375         }
 376
 377         $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
 378
 379         if (empty($oprofile)) {
 380             return true;
 381         }
 382
 383         $act = new Activity();
 384
 385         $act->verb = ActivityVerb::FOLLOW;
 386
 387         $act->id   = TagURI::mint('follow:%d:%d:%s',
 388                                   $subscriber->id,
 389                                   $other->id,
 390                                   common_date_iso8601(time()));
 391
 392         $act->time    = time();
 393         $act->title   = _("Follow");
 394         $act->content = sprintf(_("%s is now following %s."),
 395                                $subscriber->getBestName(),
 396                                $other->getBestName());
 397
 398         $act->actor   = ActivityObject::fromProfile($subscriber);
 399         $act->object  = ActivityObject::fromProfile($other);
 400
 401         $oprofile->notifyActivity($act);
 402
 403         return true;
 404     }
 405
 406     /**
 407      * When one of our local users tries to join a remote group,
 408      * notify the remote server. If the notification is rejected,
 409      * deny the join.
 410      *
 411      * @param User_group $group
 412      * @param User $user
 413      *
 414      * @return mixed hook return value
 415      */
 416
 417     function onStartJoinGroup($group, $user)
 418     {
 419         $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
 420         if ($oprofile) {
 421             $member = Profile::staticGet($user->id);
 422
 423             $act = new Activity();
 424             $act->id = TagURI::mint('join:%d:%d:%s',
 425                                     $member->id,
 426                                     $group->id,
 427                                     common_date_iso8601(time()));
 428
 429             $act->actor = ActivityObject::fromProfile($member);
 430             $act->verb = ActivityVerb::JOIN;
 431             $act->object = $oprofile->asActivityObject();
 432
 433             $act->time = time();
 434             $act->title = _m("Join");
 435             $act->content = sprintf(_m("%s has joined group %s."),
 436                                     $member->getBestName(),
 437                                     $oprofile->getBestName());
 438
 439             if ($oprofile->notifyActivity($act)) {
 440                 return true;
 441             } else {
 442                 throw new ServerException(_m("Failed joining remote group."));
 443             }
 444         }
 445     }
 446
 447     /**
 448      * When one of our local users leaves a remote group, notify the remote
 449      * server.
 450      *
 451      * @fixme Might be good to schedule a resend of the leave notification
 452      * if it failed due to a transitory error. We've canceled the local
 453      * membership already anyway, but if the remote server comes back up
 454      * it'll be left with a stray membership record.
 455      *
 456      * @param User_group $group
 457      * @param User $user
 458      *
 459      * @return mixed hook return value
 460      */
 461
 462     function onEndLeaveGroup($group, $user)
 463     {
 464         $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
 465         if ($oprofile) {
 466             // Drop the PuSH subscription if there are no other subscribers.
 467
 468             $members = $group->getMembers(0, 1);
 469             if ($members->N == 0) {
 470                 common_log(LOG_INFO, "Unsubscribing from now-unused group feed $oprofile->feeduri");
 471                 $oprofile->unsubscribe();
 472             }
 473
 474
 475             $member = Profile::staticGet($user->id);
 476
 477             $act = new Activity();
 478             $act->id = TagURI::mint('leave:%d:%d:%s',
 479                                     $member->id,
 480                                     $group->id,
 481                                     common_date_iso8601(time()));
 482
 483             $act->actor = ActivityObject::fromProfile($member);
 484             $act->verb = ActivityVerb::LEAVE;
 485             $act->object = $oprofile->asActivityObject();
 486
 487             $act->time = time();
 488             $act->title = _m("Leave");
 489             $act->content = sprintf(_m("%s has left group %s."),
 490                                     $member->getBestName(),
 491                                     $oprofile->getBestName());
 492
 493             $oprofile->notifyActivity($act);
 494         }
 495     }
 496
 497     /**
 498      * Notify remote users when their notices get favorited.
 499      *
 500      * @param Profile or User $profile of local user doing the faving
 501      * @param Notice $notice being favored
 502      * @return hook return value
 503      */
 504
 505     function onEndFavorNotice(Profile $profile, Notice $notice)
 506     {
 507         $user = User::staticGet('id', $profile->id);
 508
 509         if (empty($user)) {
 510             return true;
 511         }
 512
 513         $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
 514
 515         if (empty($oprofile)) {
 516             return true;
 517         }
 518
 519         $act = new Activity();
 520
 521         $act->verb = ActivityVerb::FAVORITE;
 522         $act->id   = TagURI::mint('favor:%d:%d:%s',
 523                                   $profile->id,
 524                                   $notice->id,
 525                                   common_date_iso8601(time()));
 526
 527         $act->time    = time();
 528         $act->title   = _("Favor");
 529         $act->content = sprintf(_("%s marked notice %s as a favorite."),
 530                                $profile->getBestName(),
 531                                $notice->uri);
 532
 533         $act->actor   = ActivityObject::fromProfile($profile);
 534         $act->object  = ActivityObject::fromNotice($notice);
 535
 536         $oprofile->notifyActivity($act);
 537
 538         return true;
 539     }
 540
 541     /**
 542      * Notify remote users when their notices get de-favorited.
 543      *
 544      * @param Profile $profile Profile person doing the de-faving
 545      * @param Notice  $notice  Notice being favored
 546      *
 547      * @return hook return value
 548      */
 549
 550     function onEndDisfavorNotice(Profile $profile, Notice $notice)
 551     {
 552         $user = User::staticGet('id', $profile->id);
 553
 554         if (empty($user)) {
 555             return true;
 556         }
 557
 558         $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
 559
 560         if (empty($oprofile)) {
 561             return true;
 562         }
 563
 564         $act = new Activity();
 565
 566         $act->verb = ActivityVerb::UNFAVORITE;
 567         $act->id   = TagURI::mint('disfavor:%d:%d:%s',
 568                                   $profile->id,
 569                                   $notice->id,
 570                                   common_date_iso8601(time()));
 571         $act->time    = time();
 572         $act->title   = _("Disfavor");
 573         $act->content = sprintf(_("%s marked notice %s as no longer 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     function onStartGetProfileUri($profile, &$uri)
 586     {
 587         $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
 588         if (!empty($oprofile)) {
 589             $uri = $oprofile->uri;
 590             return false;
 591         }
 592         return true;
 593     }
 594
 595     function onStartUserGroupHomeUrl($group, &$url)
 596     {
 597         return $this->onStartUserGroupPermalink($group, &$url);
 598     }
 599
 600     function onStartUserGroupPermalink($group, &$url)
 601     {
 602         $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
 603         if ($oprofile) {
 604             // @fixme this should probably be in the user_group table
 605             // @fixme this uri not guaranteed to be a profile page
 606             $url = $oprofile->uri;
 607             return false;
 608         }
 609     }
 610
 611     function onStartShowSubscriptionsContent($action)
 612     {
 613         $user = common_current_user();
 614         if ($user && ($user->id == $action->profile->id)) {
 615             $action->elementStart('div', 'entity_actions');
 616             $action->elementStart('p', array('id' => 'entity_remote_subscribe',
 617                                              'class' => 'entity_subscribe'));
 618             $action->element('a', array('href' => common_local_url('ostatussub'),
 619                                         'class' => 'entity_remote_subscribe')
 620                                 , _m('Subscribe to remote user'));
 621             $action->elementEnd('p');
 622             $action->elementEnd('div');
 623         }
 624
 625         return true;
 626     }
 627 }