3 * StatusNet, the distributed open-source microblogging tool
5 * Superclass for plugins that do "real time" updates of timelines using Ajax
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.
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.
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/>.
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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * Superclass for plugin to do realtime updates
37 * Based on experience with the Comet and Meteor plugins,
38 * this superclass extracts out some of the common functionality
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/
47 class RealtimePlugin extends Plugin
49 protected $replyurl = null;
50 protected $favorurl = null;
51 protected $deleteurl = null;
54 * When it's time to initialize the plugin, calculate and
55 * pass the URLs we need.
58 function onInitializePlugin()
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'));
68 function onEndShowScripts($action)
70 $timeline = $this->_getTimeline($action);
72 // If there's not a timeline on this page,
75 if (empty($timeline)) {
79 $base = $action->selfUrl();
80 if (mb_strstr($base, '?')) {
81 $url = $base . '&realtime=1';
83 $url = $base . '?realtime=1';
86 $scripts = $this->_getScripts();
88 foreach ($scripts as $script) {
89 $action->script($script);
92 $user = common_current_user();
94 if (!empty($user->id)) {
100 if ($action->boolean('realtime')) {
101 $realtimeUI = ' RealtimeUpdate.initPopupWindow();';
104 $pluginPath = common_path('plugins/Realtime/');
105 $realtimeUI = ' RealtimeUpdate.initActions("'.$url.'", "'.$timeline.'", "'. $pluginPath .'");';
108 $action->elementStart('script', array('type' => 'text/javascript'));
110 $script = ' $(document).ready(function() { '.
112 $this->_updateInitialize($timeline, $user_id).
114 $action->raw($script);
116 $action->elementEnd('script');
121 function onEndShowStatusNetStyles($action)
123 $action->cssLink(common_path('plugins/Realtime/realtimeupdate.css'),
124 null, 'screen, projection, tv');
128 function onHandleQueuedNotice($notice)
132 // Add to the author's timeline
134 $user = User::staticGet('id', $notice->profile_id);
137 $paths[] = array('showstream', $user->nickname);
140 // Add to the public timeline
142 if ($notice->is_local ||
143 ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
144 $paths[] = array('public');
147 // Add to the tags timeline
149 $tags = $this->getNoticeTags($notice);
152 foreach ($tags as $tag) {
153 $paths[] = array('tag', $tag);
157 // Add to inbox timelines
160 $inbox = new Notice_inbox();
161 $inbox->notice_id = $notice->id;
163 if ($inbox->find()) {
164 while ($inbox->fetch()) {
165 $user = User::staticGet('id', $inbox->user_id);
166 $paths[] = array('all', $user->nickname);
170 // Add to the replies timeline
172 $reply = new Reply();
173 $reply->notice_id = $notice->id;
175 if ($reply->find()) {
176 while ($reply->fetch()) {
177 $user = User::staticGet('id', $reply->profile_id);
179 $paths[] = array('replies', $user->nickname);
184 // Add to the group timeline
187 $gi = new Group_inbox();
188 $gi->notice_id = $notice->id;
191 while ($gi->fetch()) {
192 $ug = User_group::staticGet('id', $gi->group_id);
193 $paths[] = array('showgroup', $ug->nickname);
197 if (count($paths) > 0) {
199 $json = $this->noticeAsJson($notice);
203 foreach ($paths as $path) {
204 $timeline = $this->_pathToChannel($path);
205 $this->_publish($timeline, $json);
208 $this->_disconnect();
214 function onStartShowBody($action)
216 $realtime = $action->boolean('realtime');
221 $action->elementStart('body',
222 (common_current_user()) ? array('id' => $action->trimmed('action'),
223 'class' => 'user_in')
224 : array('id' => $action->trimmed('action')));
226 // XXX hack to deal with JS that tries to get the
227 // root url from page output
229 $action->elementStart('address');
230 $action->element('a', array('class' => 'url',
231 'href' => common_local_url('public')),
233 $action->elementEnd('address');
235 if (common_logged_in()) {
236 $action->showNoticeForm();
239 $action->showContentBlock();
240 $action->showScripts();
241 $action->elementEnd('body');
242 return false; // No default processing
245 function noticeAsJson($notice)
247 // FIXME: this code should be abstracted to a neutral third
248 // party, like Notice::asJson(). I'm not sure of the ethics
249 // of refactoring from within a plugin, so I'm just abusing
250 // the ApiAction method. Don't do this unless you're me!
252 require_once(INSTALLDIR.'/lib/api.php');
254 $act = new ApiAction('/dev/null');
256 $arr = $act->twitterStatusArray($notice, true);
257 $arr['url'] = $notice->bestUrl();
258 $arr['html'] = htmlspecialchars($notice->rendered);
259 $arr['source'] = htmlspecialchars($arr['source']);
261 if (!empty($notice->reply_to)) {
262 $reply_to = Notice::staticGet('id', $notice->reply_to);
263 if (!empty($reply_to)) {
264 $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
269 $profile = $notice->getProfile();
270 $arr['user']['profile_url'] = $profile->profileurl;
275 function getNoticeTags($notice)
279 $nt = new Notice_tag();
280 $nt->notice_id = $notice->id;
284 while ($nt->fetch()) {
295 // Push this up to Plugin
297 function log($level, $msg)
299 common_log($level, get_class($this) . ': '.$msg);
302 function _getScripts()
304 return array('plugins/Realtime/realtimeupdate.js',
305 'plugins/Realtime/json2.js');
308 function _updateInitialize($timeline, $user_id)
310 return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\"); ";
317 function _publish($timeline, $json)
321 function _disconnect()
325 function _pathToChannel($path)
330 function _getTimeline($action)
335 $action_name = $action->trimmed('action');
337 switch ($action_name) {
339 $path = array('public');
342 $tag = $action->trimmed('tag');
344 $path = array('tag', $tag);
351 $nickname = common_canonical_nickname($action->trimmed('nickname'));
352 if (!empty($nickname)) {
353 $path = array($action_name, $nickname);
361 $timeline = $this->_pathToChannel($path);