plugins/Realtime/RealtimePlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Superclass for plugins that do "real time" updates of timelines using Ajax
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Superclass for plugin to do realtime updates
  36  *
  37  * Based on experience with the Comet and Meteor plugins,
  38  * this superclass extracts out some of the common functionality
  39  *
  40  * @category Plugin
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46 class RealtimePlugin extends Plugin
  47 {
  48     protected $showurl = null;
  49
  50     /**
  51      * When it's time to initialize the plugin, calculate and
  52      * pass the URLs we need.
  53      */
  54     function onInitializePlugin()
  55     {
  56         // FIXME: need to find a better way to pass this pattern in
  57         $this->showurl = common_local_url('shownotice',
  58                                             array('notice' => '0000000000'));
  59         return true;
  60     }
  61
  62     function onCheckSchema()
  63     {
  64         $schema = Schema::get();
  65         $schema->ensureTable('realtime_channel', Realtime_channel::schemaDef());
  66         return true;
  67     }
  68
  69     function onAutoload($cls)
  70     {
  71         $dir = dirname(__FILE__);
  72
  73         switch ($cls)
  74         {
  75         case 'KeepalivechannelAction':
  76         case 'ClosechannelAction':
  77             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  78             return false;
  79         case 'Realtime_channel':
  80             include_once $dir.'/'.$cls.'.php';
  81             return false;
  82         default:
  83             return true;
  84         }
  85     }
  86
  87     /**
  88      * Hook for RouterInitialized event.
  89      *
  90      * @param Net_URL_Mapper $m path-to-action mapper
  91      * @return boolean hook return
  92      */
  93     function onRouterInitialized($m)
  94     {
  95         $m->connect('main/channel/:channelkey/keepalive',
  96                     array('action' => 'keepalivechannel'),
  97                     array('channelkey' => '[a-z0-9]{32}'));
  98         $m->connect('main/channel/:channelkey/close',
  99                     array('action' => 'closechannel'),
 100                     array('channelkey' => '[a-z0-9]{32}'));
 101         return true;
 102     }
 103
 104     function onEndShowScripts($action)
 105     {
 106         $channel = $this->_getChannel($action);
 107
 108         if (empty($channel)) {
 109             return true;
 110         }
 111
 112         $timeline = $this->_pathToChannel(array($channel->channel_key));
 113
 114         // If there's not a timeline on this page,
 115         // just return true
 116
 117         if (empty($timeline)) {
 118             return true;
 119         }
 120
 121         $base = $action->selfUrl();
 122         if (mb_strstr($base, '?')) {
 123             $url = $base . '&realtime=1';
 124         } else {
 125             $url = $base . '?realtime=1';
 126         }
 127
 128         $scripts = $this->_getScripts();
 129
 130         foreach ($scripts as $script) {
 131             $action->script($script);
 132         }
 133
 134         $user = common_current_user();
 135
 136         if (!empty($user->id)) {
 137             $user_id = $user->id;
 138         } else {
 139             $user_id = 0;
 140         }
 141
 142         if ($action->boolean('realtime')) {
 143             $realtimeUI = ' RealtimeUpdate.initPopupWindow();';
 144         }
 145         else {
 146             $pluginPath = common_path('plugins/Realtime/');
 147             $keepalive = common_local_url('keepalivechannel', array('channelkey' => $channel->channel_key));
 148             $close = common_local_url('closechannel', array('channelkey' => $channel->channel_key));
 149             $realtimeUI = ' RealtimeUpdate.initActions('.json_encode($url).', '.json_encode($timeline).', '.json_encode($pluginPath).', '.json_encode($keepalive).', '.json_encode($close).'); ';
 150         }
 151
 152         $script = ' $(document).ready(function() { '.
 153           $realtimeUI.
 154             $this->_updateInitialize($timeline, $user_id).
 155           '}); ';
 156         $action->inlineScript($script);
 157
 158         return true;
 159     }
 160
 161     function onEndShowStatusNetStyles($action)
 162     {
 163         $action->cssLink(Plugin::staticPath('Realtime', 'realtimeupdate.css'),
 164                          null,
 165                          'screen, projection, tv');
 166         return true;
 167     }
 168
 169     function onHandleQueuedNotice($notice)
 170     {
 171         $paths = array();
 172
 173         // Add to the author's timeline
 174
 175         try {
 176             $profile = $notice->getProfile();
 177         } catch (Exception $e) {
 178             $this->log(LOG_ERR, $e->getMessage());
 179             return true;
 180         }
 181
 182         $user = User::staticGet('id', $notice->profile_id);
 183
 184         if (!empty($user)) {
 185             $paths[] = array('showstream', $user->nickname, null);
 186         }
 187
 188         // Add to the public timeline
 189
 190         if ($notice->is_local == Notice::LOCAL_PUBLIC ||
 191             ($notice->is_local == Notice::REMOTE && !common_config('public', 'localonly'))) {
 192             $paths[] = array('public', null, null);
 193         }
 194
 195         // Add to the tags timeline
 196
 197         $tags = $this->getNoticeTags($notice);
 198
 199         if (!empty($tags)) {
 200             foreach ($tags as $tag) {
 201                 $paths[] = array('tag', $tag, null);
 202             }
 203         }
 204
 205         // Add to inbox timelines
 206         // XXX: do a join
 207
 208         $ni = $notice->whoGets();
 209
 210         foreach (array_keys($ni) as $user_id) {
 211             $user = User::staticGet('id', $user_id);
 212             $paths[] = array('all', $user->nickname, null);
 213         }
 214
 215         // Add to the replies timeline
 216
 217         $reply = new Reply();
 218         $reply->notice_id = $notice->id;
 219
 220         if ($reply->find()) {
 221             while ($reply->fetch()) {
 222                 $user = User::staticGet('id', $reply->profile_id);
 223                 if (!empty($user)) {
 224                     $paths[] = array('replies', $user->nickname, null);
 225                 }
 226             }
 227         }
 228
 229         // Add to the group timeline
 230         // XXX: join
 231
 232         $gi = new Group_inbox();
 233         $gi->notice_id = $notice->id;
 234
 235         if ($gi->find()) {
 236             while ($gi->fetch()) {
 237                 $ug = User_group::staticGet('id', $gi->group_id);
 238                 $paths[] = array('showgroup', $ug->nickname, null);
 239             }
 240         }
 241
 242         if (count($paths) > 0) {
 243
 244             $json = $this->noticeAsJson($notice);
 245
 246             $this->_connect();
 247
 248             // XXX: We should probably fan-out here and do a
 249             // new queue item for each path
 250
 251             foreach ($paths as $path) {
 252
 253                 list($action, $arg1, $arg2) = $path;
 254
 255                 $channels = Realtime_channel::getAllChannels($action, $arg1, $arg2);
 256                 $this->log(LOG_INFO, sprintf(_("%d candidate channels for notice %d"),
 257                                              count($channels),
 258                                              $notice->id));
 259
 260                 foreach ($channels as $channel) {
 261
 262                     // XXX: We should probably fan-out here and do a
 263                     // new queue item for each user/path combo
 264
 265                     if (is_null($channel->user_id)) {
 266                         $profile = null;
 267                     } else {
 268                         $profile = Profile::staticGet('id', $channel->user_id);
 269                     }
 270                     if ($notice->inScope($profile)) {
 271                         $this->log(LOG_INFO,
 272                                    sprintf(_("Delivering notice %d to channel (%s, %s, %s) for user '%s'"),
 273                                            $notice->id,
 274                                            $channel->action,
 275                                            $channel->arg1,
 276                                            $channel->arg2,
 277                                            ($profile) ? ($profile->nickname) : "<public>"));
 278                         $timeline = $this->_pathToChannel(array($channel->channel_key));
 279                         $this->_publish($timeline, $json);
 280                     }
 281                 }
 282             }
 283
 284             $this->_disconnect();
 285         }
 286
 287         return true;
 288     }
 289
 290     function onStartShowBody($action)
 291     {
 292         $realtime = $action->boolean('realtime');
 293         if (!$realtime) {
 294             return true;
 295         }
 296
 297         $action->elementStart('body',
 298                               (common_current_user()) ? array('id' => $action->trimmed('action'),
 299                                                               'class' => 'user_in realtime-popup')
 300                               : array('id' => $action->trimmed('action'),
 301                                       'class'=> 'realtime-popup'));
 302
 303         // XXX hack to deal with JS that tries to get the
 304         // root url from page output
 305
 306         $action->elementStart('address');
 307
 308         if (common_config('singleuser', 'enabled')) {
 309             $user = User::singleUser();
 310             $url = common_local_url('showstream', array('nickname' => $user->nickname));
 311         } else {
 312             $url = common_local_url('public');
 313         }
 314
 315         $action->element('a', array('class' => 'url',
 316                                     'href' => $url),
 317                          '');
 318
 319         $action->elementEnd('address');
 320
 321         $action->showContentBlock();
 322         $action->showScripts();
 323         $action->elementEnd('body');
 324         return false; // No default processing
 325     }
 326
 327     function noticeAsJson($notice)
 328     {
 329         // FIXME: this code should be abstracted to a neutral third
 330         // party, like Notice::asJson(). I'm not sure of the ethics
 331         // of refactoring from within a plugin, so I'm just abusing
 332         // the ApiAction method. Don't do this unless you're me!
 333
 334         $act = new ApiAction('/dev/null');
 335
 336         $arr = $act->twitterStatusArray($notice, true);
 337         $arr['url'] = $notice->bestUrl();
 338         $arr['html'] = htmlspecialchars($notice->rendered);
 339         $arr['source'] = htmlspecialchars($arr['source']);
 340         $arr['conversation_url'] = $this->getConversationUrl($notice);
 341
 342         $profile = $notice->getProfile();
 343         $arr['user']['profile_url'] = $profile->profileurl;
 344
 345         // Add needed repeat data
 346
 347         if (!empty($notice->repeat_of)) {
 348             $original = Notice::staticGet('id', $notice->repeat_of);
 349             if (!empty($original)) {
 350                 $arr['retweeted_status']['url'] = $original->bestUrl();
 351                 $arr['retweeted_status']['html'] = htmlspecialchars($original->rendered);
 352                 $arr['retweeted_status']['source'] = htmlspecialchars($original->source);
 353                 $originalProfile = $original->getProfile();
 354                 $arr['retweeted_status']['user']['profile_url'] = $originalProfile->profileurl;
 355                 $arr['retweeted_status']['conversation_url'] = $this->getConversationUrl($original);
 356             }
 357             $original = null;
 358         }
 359
 360         return $arr;
 361     }
 362
 363     function getNoticeTags($notice)
 364     {
 365         $tags = null;
 366
 367         $nt = new Notice_tag();
 368         $nt->notice_id = $notice->id;
 369
 370         if ($nt->find()) {
 371             $tags = array();
 372             while ($nt->fetch()) {
 373                 $tags[] = $nt->tag;
 374             }
 375         }
 376
 377         $nt->free();
 378         $nt = null;
 379
 380         return $tags;
 381     }
 382
 383     function getConversationUrl($notice)
 384     {
 385         $convurl = null;
 386
 387         if ($notice->hasConversation()) {
 388             $conv = Conversation::staticGet(
 389                 'id',
 390                 $notice->conversation
 391             );
 392             $convurl = $conv->uri;
 393
 394             if(empty($convurl)) {
 395                 $msg = sprintf( "Could not find Conversation ID %d to make 'in context'"
 396                     . "link for Notice ID %d.",
 397                     $notice->conversation,
 398                     $notice->id
 399                 );
 400
 401                 common_log(LOG_WARNING, $msg);
 402             } else {
 403                 $convurl .= '#notice-' . $notice->id;
 404             }
 405         }
 406
 407         return $convurl;
 408     }
 409
 410     function _getScripts()
 411     {
 412         if (common_config('site', 'minify')) {
 413             $js = 'realtimeupdate.min.js';
 414         } else {
 415             $js = 'realtimeupdate.js';
 416         }
 417         return array(Plugin::staticPath('Realtime', $js));
 418     }
 419
 420     /**
 421      * Export any i18n messages that need to be loaded at runtime...
 422      *
 423      * @param Action $action
 424      * @param array $messages
 425      *
 426      * @return boolean hook return value
 427      */
 428     function onEndScriptMessages($action, &$messages)
 429     {
 430         // TRANS: Text label for realtime view "play" button, usually replaced by an icon.
 431         $messages['realtime_play'] = _m('BUTTON', 'Play');
 432         // TRANS: Tooltip for realtime view "play" button.
 433         $messages['realtime_play_tooltip'] = _m('TOOLTIP', 'Play');
 434         // TRANS: Text label for realtime view "pause" button
 435         $messages['realtime_pause'] = _m('BUTTON', 'Pause');
 436         // TRANS: Tooltip for realtime view "pause" button
 437         $messages['realtime_pause_tooltip'] = _m('TOOLTIP', 'Pause');
 438         // TRANS: Text label for realtime view "popup" button, usually replaced by an icon.
 439         $messages['realtime_popup'] = _m('BUTTON', 'Pop up');
 440         // TRANS: Tooltip for realtime view "popup" button.
 441         $messages['realtime_popup_tooltip'] = _m('TOOLTIP', 'Pop up in a window');
 442
 443         return true;
 444     }
 445
 446     function _updateInitialize($timeline, $user_id)
 447     {
 448         return "RealtimeUpdate.init($user_id, \"$this->showurl\"); ";
 449     }
 450
 451     function _connect()
 452     {
 453     }
 454
 455     function _publish($timeline, $json)
 456     {
 457     }
 458
 459     function _disconnect()
 460     {
 461     }
 462
 463     function _pathToChannel($path)
 464     {
 465         return '';
 466     }
 467
 468
 469     function _getTimeline($action)
 470     {
 471         $channel = $this->_getChannel($action);
 472         if (empty($channel)) {
 473             return null;
 474         }
 475
 476         return $this->_pathToChannel(array($channel->channel_key));
 477     }
 478
 479     function _getChannel($action)
 480     {
 481         $timeline = null;
 482         $arg1     = null;
 483         $arg2     = null;
 484
 485         $action_name = $action->trimmed('action');
 486
 487         // FIXME: lists
 488         // FIXME: search (!)
 489         // FIXME: profile + tag
 490
 491         switch ($action_name) {
 492          case 'public':
 493             // no arguments
 494             break;
 495          case 'tag':
 496             $tag = $action->trimmed('tag');
 497             if (!empty($tag)) {
 498                 $arg1 = $tag;
 499             } else {
 500                 $this->log(LOG_NOTICE, "Unexpected 'tag' action without tag argument");
 501                 return null;
 502             }
 503             break;
 504          case 'showstream':
 505          case 'all':
 506          case 'replies':
 507          case 'showgroup':
 508             $nickname = common_canonical_nickname($action->trimmed('nickname'));
 509             if (!empty($nickname)) {
 510                 $arg1 = $nickname;
 511             } else {
 512                 $this->log(LOG_NOTICE, "Unexpected $action_name action without nickname argument.");
 513                 return null;
 514             }
 515             break;
 516          default:
 517             return null;
 518         }
 519
 520         $user = common_current_user();
 521
 522         $user_id = (!empty($user)) ? $user->id : null;
 523
 524         $channel = Realtime_channel::getChannel($user_id,
 525                                                 $action_name,
 526                                                 $arg1,
 527                                                 $arg2);
 528
 529         return $channel;
 530     }
 531
 532     function onStartReadWriteTables(&$alwaysRW, &$rwdb)
 533     {
 534         $alwaysRW[] = 'realtime_channel';
 535         return true;
 536     }
 537 }