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')) {
  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->elementStart('script', array('type' => 'text/javascript'));
  99         $action->raw("$(document).ready(function() { ");
 100         $action->raw($this->_updateInitialize($timeline, $user_id));
 101         $action->raw(" });");
 102         $action->elementEnd('script');
 103
 104         return true;
 105     }
 106
 107     function onEndNoticeSave($notice)
 108     {
 109         $paths = array();
 110
 111         // XXX: Add other timelines; this is just for the public one
 112
 113         if ($notice->is_local ||
 114             ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
 115             $paths[] = array('public');
 116         }
 117
 118         $tags = $this->getNoticeTags($notice);
 119
 120         if (!empty($tags)) {
 121             foreach ($tags as $tag) {
 122                 $paths[] = array('tag', $tag);
 123             }
 124         }
 125
 126         if (count($paths) > 0) {
 127
 128             $json = $this->noticeAsJson($notice);
 129
 130             $this->_connect();
 131
 132             foreach ($paths as $path) {
 133                 $timeline = $this->_pathToChannel($path);
 134                 $this->_publish($timeline, $json);
 135             }
 136
 137             $this->_disconnect();
 138         }
 139
 140         return true;
 141     }
 142
 143     function noticeAsJson($notice)
 144     {
 145         // FIXME: this code should be abstracted to a neutral third
 146         // party, like Notice::asJson(). I'm not sure of the ethics
 147         // of refactoring from within a plugin, so I'm just abusing
 148         // the TwitterApiAction method. Don't do this unless you're me!
 149
 150         require_once(INSTALLDIR.'/lib/twitterapi.php');
 151
 152         $act = new TwitterApiAction('/dev/null');
 153
 154         $arr = $act->twitter_status_array($notice, true);
 155         $arr['url'] = $notice->bestUrl();
 156         $arr['html'] = htmlspecialchars($notice->rendered);
 157         $arr['source'] = htmlspecialchars($arr['source']);
 158
 159         if (!empty($notice->reply_to)) {
 160             $reply_to = Notice::staticGet('id', $notice->reply_to);
 161             if (!empty($reply_to)) {
 162                 $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
 163             }
 164             $reply_to = null;
 165         }
 166
 167         $profile = $notice->getProfile();
 168         $arr['user']['profile_url'] = $profile->profileurl;
 169
 170         return $arr;
 171     }
 172
 173     function getNoticeTags($notice)
 174     {
 175         $tags = null;
 176
 177         $nt = new Notice_tag();
 178         $nt->notice_id = $notice->id;
 179
 180         if ($nt->find()) {
 181             $tags = array();
 182             while ($nt->fetch()) {
 183                 $tags[] = $nt->tag;
 184             }
 185         }
 186
 187         $nt->free();
 188         $nt = null;
 189
 190         return $tags;
 191     }
 192
 193     // Push this up to Plugin
 194
 195     function log($level, $msg)
 196     {
 197         common_log($level, get_class($this) . ': '.$msg);
 198     }
 199
 200     function _getScripts()
 201     {
 202         return array('plugins/Realtime/realtimeupdate.js',
 203                      'plugins/Realtime/json2.js');
 204     }
 205
 206     function _updateInitialize($timeline, $user_id)
 207     {
 208         return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\"); ";
 209     }
 210
 211     function _connect()
 212     {
 213     }
 214
 215     function _publish($timeline, $json)
 216     {
 217     }
 218
 219     function _disconnect()
 220     {
 221     }
 222
 223     function _pathToChannel($path)
 224     {
 225         return '';
 226     }
 227 }