plugins/OStatus/OStatusPlugin.php

   1 <?php
   2 /*
   3 StatusNet Plugin: 0.9
   4 Plugin Name: FeedSub
   5 Plugin URI: http://status.net/wiki/Feed_subscription
   6 Description: FeedSub allows subscribing to real-time updates from external feeds supporting PubHubSubbub protocol.
   7 Version: 0.1
   8 Author: Brion Vibber <brion@status.net>
   9 Author URI: http://status.net/
  10 */
  11
  12 /*
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2009, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 /**
  31  * @package FeedSubPlugin
  32  * @maintainer Brion Vibber <brion@status.net>
  33  */
  34
  35 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  36
  37 define('FEEDSUB_SERVICE', 100); // fixme -- avoid hardcoding these?
  38
  39 // We bundle the XML_Parse_Feed library...
  40 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib');
  41
  42 class FeedSubException extends Exception
  43 {
  44 }
  45
  46 class OStatusPlugin extends Plugin
  47 {
  48     /**
  49      * Hook for RouterInitialized event.
  50      *
  51      * @param Net_URL_Mapper $m path-to-action mapper
  52      * @return boolean hook return
  53      */
  54     function onRouterInitialized($m)
  55     {
  56         // Discovery actions
  57         $m->connect('.well-known/host-meta',
  58                     array('action' => 'hostmeta'));
  59         $m->connect('main/webfinger',
  60                     array('action' => 'webfinger'));
  61         $m->connect('main/ostatus',
  62                     array('action' => 'ostatusinit'));
  63         $m->connect('main/ostatus?nickname=:nickname',
  64                   array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
  65         $m->connect('main/ostatussub',
  66                     array('action' => 'ostatussub'));
  67         $m->connect('main/ostatussub',
  68                     array('action' => 'ostatussub'), array('feed' => '[A-Za-z0-9\.\/\:]+'));
  69
  70         // PuSH actions
  71         $m->connect('main/push/hub', array('action' => 'pushhub'));
  72
  73         $m->connect('main/push/callback/:feed',
  74                     array('action' => 'pushcallback'),
  75                     array('feed' => '[0-9]+'));
  76         $m->connect('settings/feedsub',
  77                     array('action' => 'feedsubsettings'));
  78
  79         // Salmon endpoint
  80         $m->connect('main/salmon/user/:id',
  81                     array('action' => 'salmon'),
  82                     array('id' => '[0-9]+'));
  83         $m->connect('main/salmon/group/:id',
  84                     array('action' => 'salmongroup'),
  85                     array('id' => '[0-9]+'));
  86         return true;
  87     }
  88
  89     /**
  90      * Set up queue handlers for outgoing hub pushes
  91      * @param QueueManager $qm
  92      * @return boolean hook return
  93      */
  94     function onEndInitializeQueueManager(QueueManager $qm)
  95     {
  96         $qm->connect('hubverify', 'HubVerifyQueueHandler');
  97         $qm->connect('hubdistrib', 'HubDistribQueueHandler');
  98         $qm->connect('hubout', 'HubOutQueueHandler');
  99         return true;
 100     }
 101
 102     /**
 103      * Put saved notices into the queue for pubsub distribution.
 104      */
 105     function onStartEnqueueNotice($notice, &$transports)
 106     {
 107         $transports[] = 'hubdistrib';
 108         return true;
 109     }
 110
 111     /**
 112      * Set up a PuSH hub link to our internal link for canonical timeline
 113      * Atom feeds for users and groups.
 114      */
 115     function onStartApiAtom(Action $action)
 116     {
 117         if ($action instanceof ApiTimelineUserAction) {
 118             $salmonAction = 'salmon';
 119         } else if ($action instanceof ApiTimelineGroupAction) {
 120             $salmonAction = 'salmongroup';
 121         } else {
 122             return;
 123         }
 124
 125         $id = $action->arg('id');
 126         if (strval(intval($id)) === strval($id)) {
 127             // Canonical form of id in URL? These are used for OStatus syndication.
 128
 129             $hub = common_config('ostatus', 'hub');
 130             if (empty($hub)) {
 131                 // Updates will be handled through our internal PuSH hub.
 132                 $hub = common_local_url('pushhub');
 133             }
 134             $action->element('link', array('rel' => 'hub',
 135                                            'href' => $hub));
 136
 137             // Also, we'll add in the salmon link
 138             $salmon = common_local_url($salmonAction, array('id' => $id));
 139             $action->element('link', array('rel' => 'salmon',
 140                                            'href' => $salmon));
 141         }
 142     }
 143
 144     /**
 145      * Add the feed settings page to the Connect Settings menu
 146      *
 147      * @param Action &$action The calling page
 148      *
 149      * @return boolean hook return
 150      */
 151     function onEndConnectSettingsNav(&$action)
 152     {
 153         $action_name = $action->trimmed('action');
 154
 155         $action->menuItem(common_local_url('feedsubsettings'),
 156                           _m('Feeds'),
 157                           _m('Feed subscription options'),
 158                           $action_name === 'feedsubsettings');
 159
 160         return true;
 161     }
 162
 163     /**
 164      * Automatically load the actions and libraries used by the plugin
 165      *
 166      * @param Class $cls the class
 167      *
 168      * @return boolean hook return
 169      *
 170      */
 171     function onAutoload($cls)
 172     {
 173         $base = dirname(__FILE__);
 174         $lower = strtolower($cls);
 175         $files = array("$base/classes/$cls.php",
 176                        "$base/lib/$lower.php");
 177         if (substr($lower, -6) == 'action') {
 178             $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
 179         }
 180         foreach ($files as $file) {
 181             if (file_exists($file)) {
 182                 include_once $file;
 183                 return false;
 184             }
 185         }
 186         return true;
 187     }
 188
 189     /**
 190      * Add in an OStatus subscribe button
 191      */
 192     function onStartProfilePageActionsElements($output, $profile)
 193     {
 194         $cur = common_current_user();
 195
 196         if (empty($cur)) {
 197             // Add an OStatus subscribe
 198             $output->elementStart('li', 'entity_subscribe');
 199             $url = common_local_url('ostatusinit',
 200                                     array('nickname' => $profile->nickname));
 201             $output->element('a', array('href' => $url,
 202                                         'class' => 'entity_remote_subscribe'),
 203                                 _m('OStatus'));
 204
 205             $output->elementEnd('li');
 206         }
 207     }
 208
 209     /**
 210      * Check if we've got remote replies to send via Salmon.
 211      *
 212      * @fixme push webfinger lookup & sending to a background queue
 213      * @fixme also detect short-form name for remote subscribees where not ambiguous
 214      */
 215     function onEndNoticeSave($notice)
 216     {
 217         $count = preg_match_all('/(\w+\.)*\w+@(\w+\.)*\w+(\w+\-\w+)*\.\w+/', $notice->content, $matches);
 218         if ($count) {
 219             foreach ($matches[0] as $webfinger) {
 220                 // Check to see if we've got an actual webfinger
 221                 $w = new Webfinger;
 222
 223                 $endpoint_uri = '';
 224
 225                 $result = $w->lookup($webfinger);
 226                 if (empty($result)) {
 227                     continue;
 228                 }
 229
 230                 foreach ($result->links as $link) {
 231                     if ($link['rel'] == 'salmon') {
 232                         $endpoint_uri = $link['href'];
 233                     }
 234                 }
 235
 236                 if (empty($endpoint_uri)) {
 237                     continue;
 238                 }
 239
 240                 $xml = '<?xml version="1.0" encoding="UTF-8" ?>';
 241                 $xml .= $notice->asAtomEntry();
 242
 243                 $salmon = new Salmon();
 244                 $salmon->post($endpoint_uri, $xml);
 245             }
 246         }
 247     }
 248
 249     /**
 250      * Garbage collect unused feeds on unsubscribe
 251      */
 252     function onEndUnsubscribe($user, $other)
 253     {
 254         $feed = Feedinfo::staticGet('profile_id', $other->id);
 255         if ($feed) {
 256             $sub = new Subscription();
 257             $sub->subscribed = $other->id;
 258             $sub->limit(1);
 259             if (!$sub->find(true)) {
 260                 common_log(LOG_INFO, "Unsubscribing from now-unused feed $feed->feeduri on hub $feed->huburi");
 261                 $feed->unsubscribe();
 262             }
 263         }
 264         return true;
 265     }
 266
 267     /**
 268      * Make sure necessary tables are filled out.
 269      */
 270     function onCheckSchema() {
 271         $schema = Schema::get();
 272         $schema->ensureTable('feedinfo', Feedinfo::schemaDef());
 273         $schema->ensureTable('hubsub', HubSub::schemaDef());
 274         return true;
 275     }
 276 }