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 $replyurl = null;
49 protected $favorurl = null;
50 protected $deleteurl = null;
53 * When it's time to initialize the plugin, calculate and
54 * pass the URLs we need.
57 function onInitializePlugin()
59 $this->replyurl = common_local_url('newnotice');
60 $this->favorurl = common_local_url('favor');
61 $this->repeaturl = common_local_url('repeat');
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('.json_encode($url).', '.json_encode($timeline).', '. json_encode($pluginPath).');';
108 $script = ' $(document).ready(function() { '.
110 $this->_updateInitialize($timeline, $user_id).
112 $action->inlineScript($script);
117 function onEndShowStatusNetStyles($action)
119 $action->cssLink(Plugin::staticPath('Realtime', 'realtimeupdate.css'),
121 'screen, projection, tv');
125 function onHandleQueuedNotice($notice)
129 // Add to the author's timeline
131 $user = User::staticGet('id', $notice->profile_id);
134 $paths[] = array('showstream', $user->nickname);
137 // Add to the public timeline
139 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
140 ($notice->is_local == Notice::REMOTE_OMB && !common_config('public', 'localonly'))) {
141 $paths[] = array('public');
144 // Add to the tags timeline
146 $tags = $this->getNoticeTags($notice);
149 foreach ($tags as $tag) {
150 $paths[] = array('tag', $tag);
154 // Add to inbox timelines
157 $ni = $notice->whoGets();
159 foreach (array_keys($ni) as $user_id) {
160 $user = User::staticGet('id', $user_id);
161 $paths[] = array('all', $user->nickname);
164 // Add to the replies timeline
166 $reply = new Reply();
167 $reply->notice_id = $notice->id;
169 if ($reply->find()) {
170 while ($reply->fetch()) {
171 $user = User::staticGet('id', $reply->profile_id);
173 $paths[] = array('replies', $user->nickname);
178 // Add to the group timeline
181 $gi = new Group_inbox();
182 $gi->notice_id = $notice->id;
185 while ($gi->fetch()) {
186 $ug = User_group::staticGet('id', $gi->group_id);
187 $paths[] = array('showgroup', $ug->nickname);
191 if (count($paths) > 0) {
193 $json = $this->noticeAsJson($notice);
197 foreach ($paths as $path) {
198 $timeline = $this->_pathToChannel($path);
199 $this->_publish($timeline, $json);
202 $this->_disconnect();
208 function onStartShowBody($action)
210 $realtime = $action->boolean('realtime');
215 $action->elementStart('body',
216 (common_current_user()) ? array('id' => $action->trimmed('action'),
217 'class' => 'user_in realtime-popup')
218 : array('id' => $action->trimmed('action'),
219 'class'=> 'realtime-popup'));
221 // XXX hack to deal with JS that tries to get the
222 // root url from page output
224 $action->elementStart('address');
225 $action->element('a', array('class' => 'url',
226 'href' => common_local_url('public')),
228 $action->elementEnd('address');
230 if (common_logged_in()) {
231 $action->showNoticeForm();
234 $action->showContentBlock();
235 $action->showScripts();
236 $action->elementEnd('body');
237 return false; // No default processing
240 function noticeAsJson($notice)
242 // FIXME: this code should be abstracted to a neutral third
243 // party, like Notice::asJson(). I'm not sure of the ethics
244 // of refactoring from within a plugin, so I'm just abusing
245 // the ApiAction method. Don't do this unless you're me!
247 $act = new ApiAction('/dev/null');
249 $arr = $act->twitterStatusArray($notice, true);
250 $arr['url'] = $notice->bestUrl();
251 $arr['html'] = htmlspecialchars($notice->rendered);
252 $arr['source'] = htmlspecialchars($arr['source']);
253 $arr['conversation_url'] = $this->getConversationUrl($notice);
255 $profile = $notice->getProfile();
256 $arr['user']['profile_url'] = $profile->profileurl;
258 // Add needed repeat data
260 if (!empty($notice->repeat_of)) {
261 $original = Notice::staticGet('id', $notice->repeat_of);
262 if (!empty($original)) {
263 $arr['retweeted_status']['url'] = $original->bestUrl();
264 $arr['retweeted_status']['html'] = htmlspecialchars($original->rendered);
265 $arr['retweeted_status']['source'] = htmlspecialchars($original->source);
266 $originalProfile = $original->getProfile();
267 $arr['retweeted_status']['user']['profile_url'] = $originalProfile->profileurl;
268 $arr['retweeted_status']['conversation_url'] = $this->getConversationUrl($original);
276 function getNoticeTags($notice)
280 $nt = new Notice_tag();
281 $nt->notice_id = $notice->id;
285 while ($nt->fetch()) {
296 function getConversationUrl($notice)
300 if ($notice->hasConversation()) {
301 $conv = Conversation::staticGet(
303 $notice->conversation
305 $convurl = $conv->uri;
307 if(empty($convurl)) {
309 "Couldn't find Conversation ID %d to make 'in context'"
310 . "link for Notice ID %d",
311 $notice->conversation,
315 common_log(LOG_WARNING, $msg);
317 $convurl .= '#notice-' . $notice->id;
324 function _getScripts()
326 return array(Plugin::staticPath('Realtime', 'realtimeupdate.min.js'));
330 * Export any i18n messages that need to be loaded at runtime...
332 * @param Action $action
333 * @param array $messages
335 * @return boolean hook return value
337 function onEndScriptMessages($action, &$messages)
339 // TRANS: Text label for realtime view "play" button, usually replaced by an icon.
340 $messages['realtime_play'] = _m('BUTTON', 'Play');
341 // TRANS: Tooltip for realtime view "play" button.
342 $messages['realtime_play_tooltip'] = _m('TOOLTIP', 'Play');
343 // TRANS: Text label for realtime view "pause" button
344 $messages['realtime_pause'] = _m('BUTTON', 'Pause');
345 // TRANS: Tooltip for realtime view "pause" button
346 $messages['realtime_pause_tooltip'] = _m('TOOLTIP', 'Pause');
347 // TRANS: Text label for realtime view "popup" button, usually replaced by an icon.
348 $messages['realtime_popup'] = _m('BUTTON', 'Pop up');
349 // TRANS: Tooltip for realtime view "popup" button.
350 $messages['realtime_popup_tooltip'] = _m('TOOLTIP', 'Pop up in a window');
355 function _updateInitialize($timeline, $user_id)
357 return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->repeaturl\", \"$this->deleteurl\"); ";
364 function _publish($timeline, $json)
368 function _disconnect()
372 function _pathToChannel($path)
377 function _getTimeline($action)
382 $action_name = $action->trimmed('action');
384 switch ($action_name) {
386 $path = array('public');
389 $tag = $action->trimmed('tag');
391 $path = array('tag', $tag);
398 $nickname = common_canonical_nickname($action->trimmed('nickname'));
399 if (!empty($nickname)) {
400 $path = array($action_name, $nickname);
408 $timeline = $this->_pathToChannel($path);