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     function onInitializePlugin()
  54     {
  55         $this->replyurl = common_local_url('newnotice');
  56         $this->favorurl = common_local_url('favor');
  57         // FIXME: need to find a better way to pass this pattern in
  58         $this->deleteurl = common_local_url('deletenotice',
  59                                             array('notice' => '0000000000'));
  60     }
  61
  62     function onEndShowScripts($action)
  63     {
  64         $path = null;
  65
  66         switch ($action->trimmed('action')) {
  67          case 'public':
  68             $path = array('public');
  69             break;
  70          case 'tag':
  71             $tag = $action->trimmed('tag');
  72             if (!empty($tag)) {
  73                 $path = array('tag', $tag);
  74             } else {
  75                 return true;
  76             }
  77             break;
  78          default:
  79             return true;
  80         }
  81
  82         $timeline = $this->_pathToChannel($path);
  83
  84         $scripts = $this->_getScripts();
  85
  86         foreach ($scripts as $script) {
  87             $action->script($script);
  88         }
  89
  90         $user = common_current_user();
  91
  92         if (!empty($user->id)) {
  93             $user_id = $user->id;
  94         } else {
  95             $user_id = 0;
  96         }
  97
  98         $action->script('plugins/Realtime/jquery.getUrlParam.js');
  99
 100         $action->elementStart('script', array('type' => 'text/javascript'));
 101         $action->raw('
 102         <!--
 103         $(document).ready(function() {
 104             ' . $this->_updateInitialize($timeline, $user_id) . '
 105         });
 106         -->
 107         ');
 108         $action->elementEnd('script');
 109
 110         return true;
 111     }
 112
 113     function onEndNoticeSave($notice)
 114     {
 115         $paths = array();
 116
 117         // XXX: Add other timelines; this is just for the public one
 118
 119         if ($notice->is_local ||
 120             ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
 121             $paths[] = array('public');
 122         }
 123
 124         $tags = $this->getNoticeTags($notice);
 125
 126         if (!empty($tags)) {
 127             foreach ($tags as $tag) {
 128                 $paths[] = array('tag', $tag);
 129             }
 130         }
 131
 132         if (count($paths) > 0) {
 133
 134             $json = $this->noticeAsJson($notice);
 135
 136             $this->_connect();
 137
 138             foreach ($paths as $path) {
 139                 $timeline = $this->_pathToChannel($path);
 140                 $this->_publish($timeline, $json);
 141             }
 142
 143             $this->_disconnect();
 144         }
 145
 146         return true;
 147     }
 148
 149     function noticeAsJson($notice)
 150     {
 151         // FIXME: this code should be abstracted to a neutral third
 152         // party, like Notice::asJson(). I'm not sure of the ethics
 153         // of refactoring from within a plugin, so I'm just abusing
 154         // the TwitterApiAction method. Don't do this unless you're me!
 155
 156         require_once(INSTALLDIR.'/lib/twitterapi.php');
 157
 158         $act = new TwitterApiAction('/dev/null');
 159
 160         $arr = $act->twitter_status_array($notice, true);
 161         $arr['url'] = $notice->bestUrl();
 162         $arr['html'] = htmlspecialchars($notice->rendered);
 163         $arr['source'] = htmlspecialchars($arr['source']);
 164
 165         if (!empty($notice->reply_to)) {
 166             $reply_to = Notice::staticGet('id', $notice->reply_to);
 167             if (!empty($reply_to)) {
 168                 $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
 169             }
 170             $reply_to = null;
 171         }
 172
 173         $profile = $notice->getProfile();
 174         $arr['user']['profile_url'] = $profile->profileurl;
 175
 176         return $arr;
 177     }
 178
 179     function getNoticeTags($notice)
 180     {
 181         $tags = null;
 182
 183         $nt = new Notice_tag();
 184         $nt->notice_id = $notice->id;
 185
 186         if ($nt->find()) {
 187             $tags = array();
 188             while ($nt->fetch()) {
 189                 $tags[] = $nt->tag;
 190             }
 191         }
 192
 193         $nt->free();
 194         $nt = null;
 195
 196         return $tags;
 197     }
 198
 199     // Push this up to Plugin
 200
 201     function log($level, $msg)
 202     {
 203         common_log($level, get_class($this) . ': '.$msg);
 204     }
 205
 206     function _getScripts()
 207     {
 208         return array('plugins/Realtime/realtimeupdate.js',
 209                      'plugins/Realtime/json2.js');
 210     }
 211
 212     function _updateInitialize($timeline, $user_id)
 213     {
 214         return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\"); ";
 215     }
 216
 217     function _connect()
 218     {
 219     }
 220
 221     function _publish($timeline, $json)
 222     {
 223     }
 224
 225     function _disconnect()
 226     {
 227     }
 228
 229     function _pathToChannel($path)
 230     {
 231         return '';
 232     }
 233 }