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/
46 class RealtimePlugin extends Plugin
48 protected $showurl = null;
51 * When it's time to initialize the plugin, calculate and
52 * pass the URLs we need.
54 function onInitializePlugin()
56 // FIXME: need to find a better way to pass this pattern in
57 $this->showurl = common_local_url('shownotice',
58 array('notice' => '0000000000'));
62 function onCheckSchema()
64 $schema = Schema::get();
65 $schema->ensureTable('realtime_channel', Realtime_channel::schemaDef());
69 function onAutoload($cls)
71 $dir = dirname(__FILE__);
75 case 'KeepalivechannelAction':
76 case 'ClosechannelAction':
77 include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
79 case 'Realtime_channel':
80 include_once $dir.'/'.$cls.'.php';
88 * Hook for RouterInitialized event.
90 * @param Net_URL_Mapper $m path-to-action mapper
91 * @return boolean hook return
93 function onRouterInitialized($m)
95 $m->connect('main/channel/:channelkey/keepalive',
96 array('action' => 'keepalivechannel'),
97 array('channelkey' => '[a-z0-9]{32}'));
98 $m->connect('main/channel/:channelkey/close',
99 array('action' => 'closechannel'),
100 array('channelkey' => '[a-z0-9]{32}'));
104 function onEndShowScripts($action)
106 $channel = $this->_getChannel($action);
108 if (empty($channel)) {
112 $timeline = $this->_pathToChannel(array($channel->channel_key));
114 // If there's not a timeline on this page,
117 if (empty($timeline)) {
121 $base = $action->selfUrl();
122 if (mb_strstr($base, '?')) {
123 $url = $base . '&realtime=1';
125 $url = $base . '?realtime=1';
128 $scripts = $this->_getScripts();
130 foreach ($scripts as $script) {
131 $action->script($script);
134 $user = common_current_user();
136 if (!empty($user->id)) {
137 $user_id = $user->id;
142 if ($action->boolean('realtime')) {
143 $realtimeUI = ' RealtimeUpdate.initPopupWindow();';
146 $pluginPath = common_path('plugins/Realtime/');
147 $keepalive = common_local_url('keepalivechannel', array('channelkey' => $channel->channel_key));
148 $close = common_local_url('closechannel', array('channelkey' => $channel->channel_key));
149 $realtimeUI = ' RealtimeUpdate.initActions('.json_encode($url).', '.json_encode($timeline).', '.json_encode($pluginPath).', '.json_encode($keepalive).', '.json_encode($close).'); ';
152 $script = ' $(document).ready(function() { '.
154 $this->_updateInitialize($timeline, $user_id).
156 $action->inlineScript($script);
161 function onEndShowStatusNetStyles($action)
163 $action->cssLink(Plugin::staticPath('Realtime', 'realtimeupdate.css'),
165 'screen, projection, tv');
169 function onHandleQueuedNotice($notice)
173 // Add to the author's timeline
175 $user = User::staticGet('id', $notice->profile_id);
178 $paths[] = array('showstream', $user->nickname, null);
181 // Add to the public timeline
183 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
184 ($notice->is_local == Notice::REMOTE_OMB && !common_config('public', 'localonly'))) {
185 $paths[] = array('public', null, null);
188 // Add to the tags timeline
190 $tags = $this->getNoticeTags($notice);
193 foreach ($tags as $tag) {
194 $paths[] = array('tag', $tag, null);
198 // Add to inbox timelines
201 $ni = $notice->whoGets();
203 foreach (array_keys($ni) as $user_id) {
204 $user = User::staticGet('id', $user_id);
205 $paths[] = array('all', $user->nickname, null);
208 // Add to the replies timeline
210 $reply = new Reply();
211 $reply->notice_id = $notice->id;
213 if ($reply->find()) {
214 while ($reply->fetch()) {
215 $user = User::staticGet('id', $reply->profile_id);
217 $paths[] = array('replies', $user->nickname, null);
222 // Add to the group timeline
225 $gi = new Group_inbox();
226 $gi->notice_id = $notice->id;
229 while ($gi->fetch()) {
230 $ug = User_group::staticGet('id', $gi->group_id);
231 $paths[] = array('showgroup', $ug->nickname, null);
235 if (count($paths) > 0) {
237 $json = $this->noticeAsJson($notice);
241 // XXX: We should probably fan-out here and do a
242 // new queue item for each path
244 foreach ($paths as $path) {
246 list($action, $arg1, $arg2) = $path;
248 $channels = Realtime_channel::getAllChannels($action, $arg1, $arg2);
250 foreach ($channels as $channel) {
252 // XXX: We should probably fan-out here and do a
253 // new queue item for each user/path combo
255 if (is_null($channel->user_id)) {
258 $profile = Profile::staticGet('id', $channel->user_id);
260 if ($notice->inScope($profile)) {
261 $timeline = $this->_pathToChannel(array($channel->channel_key));
262 $this->_publish($timeline, $json);
267 $this->_disconnect();
273 function onStartShowBody($action)
275 $realtime = $action->boolean('realtime');
280 $action->elementStart('body',
281 (common_current_user()) ? array('id' => $action->trimmed('action'),
282 'class' => 'user_in realtime-popup')
283 : array('id' => $action->trimmed('action'),
284 'class'=> 'realtime-popup'));
286 // XXX hack to deal with JS that tries to get the
287 // root url from page output
289 $action->elementStart('address');
290 $action->element('a', array('class' => 'url',
291 'href' => common_local_url('public')),
293 $action->elementEnd('address');
295 $action->showContentBlock();
296 $action->showScripts();
297 $action->elementEnd('body');
298 return false; // No default processing
301 function noticeAsJson($notice)
303 // FIXME: this code should be abstracted to a neutral third
304 // party, like Notice::asJson(). I'm not sure of the ethics
305 // of refactoring from within a plugin, so I'm just abusing
306 // the ApiAction method. Don't do this unless you're me!
308 $act = new ApiAction('/dev/null');
310 $arr = $act->twitterStatusArray($notice, true);
311 $arr['url'] = $notice->bestUrl();
312 $arr['html'] = htmlspecialchars($notice->rendered);
313 $arr['source'] = htmlspecialchars($arr['source']);
314 $arr['conversation_url'] = $this->getConversationUrl($notice);
316 $profile = $notice->getProfile();
317 $arr['user']['profile_url'] = $profile->profileurl;
319 // Add needed repeat data
321 if (!empty($notice->repeat_of)) {
322 $original = Notice::staticGet('id', $notice->repeat_of);
323 if (!empty($original)) {
324 $arr['retweeted_status']['url'] = $original->bestUrl();
325 $arr['retweeted_status']['html'] = htmlspecialchars($original->rendered);
326 $arr['retweeted_status']['source'] = htmlspecialchars($original->source);
327 $originalProfile = $original->getProfile();
328 $arr['retweeted_status']['user']['profile_url'] = $originalProfile->profileurl;
329 $arr['retweeted_status']['conversation_url'] = $this->getConversationUrl($original);
337 function getNoticeTags($notice)
341 $nt = new Notice_tag();
342 $nt->notice_id = $notice->id;
346 while ($nt->fetch()) {
357 function getConversationUrl($notice)
361 if ($notice->hasConversation()) {
362 $conv = Conversation::staticGet(
364 $notice->conversation
366 $convurl = $conv->uri;
368 if(empty($convurl)) {
369 $msg = sprintf( _m("Could not find Conversation ID %d to make 'in context'"
370 . "link for Notice ID %d.",
371 $notice->conversation,
375 common_log(LOG_WARNING, $msg);
377 $convurl .= '#notice-' . $notice->id;
384 function _getScripts()
386 if (common_config('site', 'minify')) {
387 $js = 'realtimeupdate.min.js';
389 $js = 'realtimeupdate.js';
391 return array(Plugin::staticPath('Realtime', $js));
395 * Export any i18n messages that need to be loaded at runtime...
397 * @param Action $action
398 * @param array $messages
400 * @return boolean hook return value
402 function onEndScriptMessages($action, &$messages)
404 // TRANS: Text label for realtime view "play" button, usually replaced by an icon.
405 $messages['realtime_play'] = _m('BUTTON', 'Play');
406 // TRANS: Tooltip for realtime view "play" button.
407 $messages['realtime_play_tooltip'] = _m('TOOLTIP', 'Play');
408 // TRANS: Text label for realtime view "pause" button
409 $messages['realtime_pause'] = _m('BUTTON', 'Pause');
410 // TRANS: Tooltip for realtime view "pause" button
411 $messages['realtime_pause_tooltip'] = _m('TOOLTIP', 'Pause');
412 // TRANS: Text label for realtime view "popup" button, usually replaced by an icon.
413 $messages['realtime_popup'] = _m('BUTTON', 'Pop up');
414 // TRANS: Tooltip for realtime view "popup" button.
415 $messages['realtime_popup_tooltip'] = _m('TOOLTIP', 'Pop up in a window');
420 function _updateInitialize($timeline, $user_id)
422 return "RealtimeUpdate.init($user_id, \"$this->showurl\"); ";
429 function _publish($timeline, $json)
433 function _disconnect()
437 function _pathToChannel($path)
443 function _getTimeline($action)
445 $channel = $this->_getChannel($action);
446 if (empty($channel)) {
450 return $this->_pathToChannel(array($channel->channel_key));
453 function _getChannel($action)
459 $action_name = $action->trimmed('action');
463 // FIXME: profile + tag
465 switch ($action_name) {
470 $tag = $action->trimmed('tag');
474 $this->log(LOG_NOTICE, "Unexpected 'tag' action without tag argument");
482 $nickname = common_canonical_nickname($action->trimmed('nickname'));
483 if (!empty($nickname)) {
486 $this->log(LOG_NOTICE, "Unexpected $action_name action without nickname argument.");
494 $user = common_current_user();
496 $user_id = (!empty($user)) ? $user->id : null;
498 $channel = Realtime_channel::getChannel($user_id,
506 function onStartReadWriteTables(&$alwaysRW, &$rwdb)
508 $alwaysRW[] = 'realtime_channel';