plugins/Realtime/RealtimePlugin.php

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