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
  47 class RealtimePlugin extends Plugin
  48 {
  49     protected $replyurl = null;
  50     protected $favorurl = null;
  51     protected $deleteurl = null;
  52
  53     /**
  54      * When it's time to initialize the plugin, calculate and
  55      * pass the URLs we need.
  56      */
  57
  58     function onInitializePlugin()
  59     {
  60         $this->replyurl = common_local_url('newnotice');
  61         $this->favorurl = common_local_url('favor');
  62         // FIXME: need to find a better way to pass this pattern in
  63         $this->deleteurl = common_local_url('deletenotice',
  64                                             array('notice' => '0000000000'));
  65         return true;
  66     }
  67
  68     function onEndShowScripts($action)
  69     {
  70         $timeline = $this->_getTimeline($action);
  71
  72         // If there's not a timeline on this page,
  73         // just return true
  74
  75         if (empty($timeline)) {
  76             return true;
  77         }
  78
  79         $base = $action->selfUrl();
  80         if (mb_strstr($url, '?')) {
  81             $url = $base . '&realtime=1';
  82         } else {
  83             $url = $base . '?realtime=1';
  84         }
  85
  86         $title = $action->title();
  87
  88         $scripts = $this->_getScripts();
  89
  90         foreach ($scripts as $script) {
  91             $action->script($script);
  92         }
  93
  94         $user = common_current_user();
  95
  96         if (!empty($user->id)) {
  97             $user_id = $user->id;
  98         } else {
  99             $user_id = 0;
 100         }
 101
 102         // FIXME: Need to check if the current URL is a poped realtime window
 103         if (1==2) {
 104             $realtimeUI = ' RealtimeUpdate.initPopupWindow();';
 105         }
 106         else {
 107             // FIXME: This icon URL is no good if fancy URLs are off.
 108             $iconurl = $base.'plugins/Realtime/icon_external.gif';
 109             $realtimeUI = ' RealtimeUpdate.addPopup("'.$url.'", "'.$title.'", "'. $iconurl .'");';
 110         }
 111
 112         $action->elementStart('script', array('type' => 'text/javascript'));
 113
 114         $script = ' $(document).ready(function() { '.
 115           $this->_updateInitialize($timeline, $user_id).
 116           $realtimeUI.
 117           '}); ';
 118         $action->raw($script);
 119
 120         $action->elementEnd('script');
 121
 122         return true;
 123     }
 124
 125     function onEndNoticeSave($notice)
 126     {
 127         $paths = array();
 128
 129         // Add to the author's timeline
 130
 131         $user = User::staticGet('id', $notice->profile_id);
 132
 133         if (!empty($user)) {
 134             $paths[] = array('showstream', $user->nickname);
 135         }
 136
 137         // Add to the public timeline
 138
 139         if ($notice->is_local ||
 140             ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
 141             $paths[] = array('public');
 142         }
 143
 144         // Add to the tags timeline
 145
 146         $tags = $this->getNoticeTags($notice);
 147
 148         if (!empty($tags)) {
 149             foreach ($tags as $tag) {
 150                 $paths[] = array('tag', $tag);
 151             }
 152         }
 153
 154         // Add to inbox timelines
 155         // XXX: do a join
 156
 157         $inbox = new Notice_inbox();
 158         $inbox->notice_id = $notice->id;
 159
 160         if ($inbox->find()) {
 161             while ($inbox->fetch()) {
 162                 $user = User::staticGet('id', $inbox->user_id);
 163                 $paths[] = array('all', $user->nickname);
 164             }
 165         }
 166
 167         // Add to the replies timeline
 168
 169         $reply = new Reply();
 170         $reply->notice_id = $notice->id;
 171
 172         if ($reply->find()) {
 173             while ($reply->fetch()) {
 174                 $user = User::staticGet('id', $reply->profile_id);
 175                 if (!empty($user)) {
 176                     $paths[] = array('replies', $user->nickname);
 177                 }
 178             }
 179         }
 180
 181         // Add to the group timeline
 182         // XXX: join
 183
 184         $gi = new Group_inbox();
 185         $gi->notice_id = $notice->id;
 186
 187         if ($gi->find()) {
 188             while ($gi->fetch()) {
 189                 $ug = User_group::staticGet('id', $gi->group_id);
 190                 $paths[] = array('showgroup', $ug->nickname);
 191             }
 192         }
 193
 194         if (count($paths) > 0) {
 195
 196             $json = $this->noticeAsJson($notice);
 197
 198             $this->_connect();
 199
 200             foreach ($paths as $path) {
 201                 $timeline = $this->_pathToChannel($path);
 202                 $this->_publish($timeline, $json);
 203             }
 204
 205             $this->_disconnect();
 206         }
 207
 208         return true;
 209     }
 210
 211     function onStartShowBody($action)
 212     {
 213         $realtime = $action->boolean('realtime');
 214         if (!$realtime) {
 215             return true;
 216         }
 217
 218         $action->elementStart('body',
 219                               (common_current_user()) ? array('id' => $action->trimmed('action'),
 220                                                               'class' => 'user_in')
 221                               : array('id' => $action->trimmed('action')));
 222
 223         $action->elementStart('div', array('id' => 'header'));
 224         // XXX hack to deal with JS that tries to get the
 225         // root url from page output
 226         $action->elementStart('address');
 227         $action->element('a', array('class' => 'url',
 228                                   'href' => common_local_url('public')),
 229                          '');
 230         $action->elementEnd('address');
 231
 232         if (common_logged_in()) {
 233             $action->showNoticeForm();
 234         }
 235         $action->elementEnd('div');
 236
 237         $action->showContentBlock();
 238         $action->elementEnd('body');
 239         return false; // No default processing
 240     }
 241
 242     function noticeAsJson($notice)
 243     {
 244         // FIXME: this code should be abstracted to a neutral third
 245         // party, like Notice::asJson(). I'm not sure of the ethics
 246         // of refactoring from within a plugin, so I'm just abusing
 247         // the TwitterApiAction method. Don't do this unless you're me!
 248
 249         require_once(INSTALLDIR.'/lib/twitterapi.php');
 250
 251         $act = new TwitterApiAction('/dev/null');
 252
 253         $arr = $act->twitter_status_array($notice, true);
 254         $arr['url'] = $notice->bestUrl();
 255         $arr['html'] = htmlspecialchars($notice->rendered);
 256         $arr['source'] = htmlspecialchars($arr['source']);
 257
 258         if (!empty($notice->reply_to)) {
 259             $reply_to = Notice::staticGet('id', $notice->reply_to);
 260             if (!empty($reply_to)) {
 261                 $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
 262             }
 263             $reply_to = null;
 264         }
 265
 266         $profile = $notice->getProfile();
 267         $arr['user']['profile_url'] = $profile->profileurl;
 268
 269         return $arr;
 270     }
 271
 272     function getNoticeTags($notice)
 273     {
 274         $tags = null;
 275
 276         $nt = new Notice_tag();
 277         $nt->notice_id = $notice->id;
 278
 279         if ($nt->find()) {
 280             $tags = array();
 281             while ($nt->fetch()) {
 282                 $tags[] = $nt->tag;
 283             }
 284         }
 285
 286         $nt->free();
 287         $nt = null;
 288
 289         return $tags;
 290     }
 291
 292     // Push this up to Plugin
 293
 294     function log($level, $msg)
 295     {
 296         common_log($level, get_class($this) . ': '.$msg);
 297     }
 298
 299     function _getScripts()
 300     {
 301         return array('plugins/Realtime/realtimeupdate.js',
 302                      'plugins/Realtime/json2.js');
 303     }
 304
 305     function _updateInitialize($timeline, $user_id)
 306     {
 307         return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\"); ";
 308     }
 309
 310     function _connect()
 311     {
 312     }
 313
 314     function _publish($timeline, $json)
 315     {
 316     }
 317
 318     function _disconnect()
 319     {
 320     }
 321
 322     function _pathToChannel($path)
 323     {
 324         return '';
 325     }
 326
 327     function _getTimeline($action)
 328     {
 329         $path = null;
 330         $timeline = null;
 331
 332         $action_name = $action->trimmed('action');
 333
 334         switch ($action_name) {
 335          case 'public':
 336             $path = array('public');
 337             break;
 338          case 'tag':
 339             $tag = $action->trimmed('tag');
 340             if (!empty($tag)) {
 341                 $path = array('tag', $tag);
 342             }
 343             break;
 344          case 'showstream':
 345          case 'all':
 346          case 'replies':
 347          case 'showgroup':
 348             $nickname = common_canonical_nickname($action->trimmed('nickname'));
 349             if (!empty($nickname)) {
 350                 $path = array($action_name, $nickname);
 351             }
 352             break;
 353          default:
 354             break;
 355         }
 356
 357         if (!empty($path)) {
 358             $timeline = $this->_pathToChannel($path);
 359         }
 360
 361         return $timeline;
 362     }
 363 }