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