* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
-
class RealtimePlugin extends Plugin
{
- protected $replyurl = null;
- protected $favorurl = null;
- protected $deleteurl = null;
+ protected $showurl = null;
/**
* When it's time to initialize the plugin, calculate and
* pass the URLs we need.
*/
-
function onInitializePlugin()
{
- $this->replyurl = common_local_url('newnotice');
- $this->favorurl = common_local_url('favor');
// FIXME: need to find a better way to pass this pattern in
- $this->deleteurl = common_local_url('deletenotice',
+ $this->showurl = common_local_url('shownotice',
array('notice' => '0000000000'));
return true;
}
+ function onCheckSchema()
+ {
+ $schema = Schema::get();
+ $schema->ensureTable('realtime_channel', Realtime_channel::schemaDef());
+ return true;
+ }
+
+ function onAutoload($cls)
+ {
+ $dir = dirname(__FILE__);
+
+ switch ($cls)
+ {
+ case 'KeepalivechannelAction':
+ case 'ClosechannelAction':
+ include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
+ return false;
+ case 'Realtime_channel':
+ include_once $dir.'/'.$cls.'.php';
+ return false;
+ default:
+ return true;
+ }
+ }
+
+ /**
+ * Hook for RouterInitialized event.
+ *
+ * @param Net_URL_Mapper $m path-to-action mapper
+ * @return boolean hook return
+ */
+ function onRouterInitialized($m)
+ {
+ $m->connect('main/channel/:channelkey/keepalive',
+ array('action' => 'keepalivechannel'),
+ array('channelkey' => '[a-z0-9]{32}'));
+ $m->connect('main/channel/:channelkey/close',
+ array('action' => 'closechannel'),
+ array('channelkey' => '[a-z0-9]{32}'));
+ return true;
+ }
+
function onEndShowScripts($action)
{
- $timeline = $this->_getTimeline($action);
+ $channel = $this->_getChannel($action);
+
+ if (empty($channel)) {
+ return true;
+ }
+
+ $timeline = $this->_pathToChannel(array($channel->channel_key));
// If there's not a timeline on this page,
// just return true
$realtimeUI = ' RealtimeUpdate.initPopupWindow();';
}
else {
- $iconurl = common_path('plugins/Realtime/icon_external.gif');
- $realtimeUI = ' RealtimeUpdate.addPopup("'.$url.'", "'.$timeline.'", "'. $iconurl .'");';
+ $pluginPath = common_path('plugins/Realtime/');
+ $keepalive = common_local_url('keepalivechannel', array('channelkey' => $channel->channel_key));
+ $close = common_local_url('closechannel', array('channelkey' => $channel->channel_key));
+ $realtimeUI = ' RealtimeUpdate.initActions('.json_encode($url).', '.json_encode($timeline).', '.json_encode($pluginPath).', '.json_encode($keepalive).', '.json_encode($close).'); ';
}
- $action->elementStart('script', array('type' => 'text/javascript'));
-
$script = ' $(document).ready(function() { '.
$realtimeUI.
- $this->_updateInitialize($timeline, $user_id).
+ $this->_updateInitialize($timeline, $user_id).
'}); ';
- $action->raw($script);
+ $action->inlineScript($script);
- $action->elementEnd('script');
+ return true;
+ }
+ function onEndShowStatusNetStyles($action)
+ {
+ $action->cssLink(Plugin::staticPath('Realtime', 'realtimeupdate.css'),
+ null,
+ 'screen, projection, tv');
return true;
}
- function onEndNoticeSave($notice)
+ function onHandleQueuedNotice($notice)
{
$paths = array();
// Add to the author's timeline
+ try {
+ $profile = $notice->getProfile();
+ } catch (Exception $e) {
+ $this->log(LOG_ERR, $e->getMessage());
+ return true;
+ }
+
$user = User::staticGet('id', $notice->profile_id);
if (!empty($user)) {
- $paths[] = array('showstream', $user->nickname);
+ $paths[] = array('showstream', $user->nickname, null);
}
// Add to the public timeline
- if ($notice->is_local ||
- ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
- $paths[] = array('public');
+ if ($notice->is_local == Notice::LOCAL_PUBLIC ||
+ ($notice->is_local == Notice::REMOTE && !common_config('public', 'localonly'))) {
+ $paths[] = array('public', null, null);
}
// Add to the tags timeline
if (!empty($tags)) {
foreach ($tags as $tag) {
- $paths[] = array('tag', $tag);
+ $paths[] = array('tag', $tag, null);
}
}
// Add to inbox timelines
// XXX: do a join
- $inbox = new Notice_inbox();
- $inbox->notice_id = $notice->id;
+ $ni = $notice->whoGets();
- if ($inbox->find()) {
- while ($inbox->fetch()) {
- $user = User::staticGet('id', $inbox->user_id);
- $paths[] = array('all', $user->nickname);
- }
+ foreach (array_keys($ni) as $user_id) {
+ $user = User::staticGet('id', $user_id);
+ $paths[] = array('all', $user->nickname, null);
}
// Add to the replies timeline
while ($reply->fetch()) {
$user = User::staticGet('id', $reply->profile_id);
if (!empty($user)) {
- $paths[] = array('replies', $user->nickname);
+ $paths[] = array('replies', $user->nickname, null);
}
}
}
if ($gi->find()) {
while ($gi->fetch()) {
$ug = User_group::staticGet('id', $gi->group_id);
- $paths[] = array('showgroup', $ug->nickname);
+ $paths[] = array('showgroup', $ug->nickname, null);
}
}
$this->_connect();
+ // XXX: We should probably fan-out here and do a
+ // new queue item for each path
+
foreach ($paths as $path) {
- $timeline = $this->_pathToChannel($path);
- $this->_publish($timeline, $json);
+
+ list($action, $arg1, $arg2) = $path;
+
+ $channels = Realtime_channel::getAllChannels($action, $arg1, $arg2);
+
+ foreach ($channels as $channel) {
+
+ // XXX: We should probably fan-out here and do a
+ // new queue item for each user/path combo
+
+ if (is_null($channel->user_id)) {
+ $profile = null;
+ } else {
+ $profile = Profile::staticGet('id', $channel->user_id);
+ }
+ if ($notice->inScope($profile)) {
+ $timeline = $this->_pathToChannel(array($channel->channel_key));
+ $this->_publish($timeline, $json);
+ }
+ }
}
$this->_disconnect();
$action->elementStart('body',
(common_current_user()) ? array('id' => $action->trimmed('action'),
- 'class' => 'user_in')
- : array('id' => $action->trimmed('action')));
+ 'class' => 'user_in realtime-popup')
+ : array('id' => $action->trimmed('action'),
+ 'class'=> 'realtime-popup'));
// XXX hack to deal with JS that tries to get the
// root url from page output
$action->elementStart('address');
+
+ if (common_config('singleuser', 'enabled')) {
+ $user = User::singleUser();
+ $url = common_local_url('showstream', array('nickname' => $user->nickname));
+ } else {
+ $url = common_local_url('public');
+ }
+
$action->element('a', array('class' => 'url',
- 'href' => common_local_url('public')),
+ 'href' => $url),
'');
- $action->elementEnd('address');
- if (common_logged_in()) {
- $action->showNoticeForm();
- }
+ $action->elementEnd('address');
$action->showContentBlock();
$action->showScripts();
// of refactoring from within a plugin, so I'm just abusing
// the ApiAction method. Don't do this unless you're me!
- require_once(INSTALLDIR.'/lib/api.php');
-
$act = new ApiAction('/dev/null');
$arr = $act->twitterStatusArray($notice, true);
$arr['url'] = $notice->bestUrl();
$arr['html'] = htmlspecialchars($notice->rendered);
$arr['source'] = htmlspecialchars($arr['source']);
-
- if (!empty($notice->reply_to)) {
- $reply_to = Notice::staticGet('id', $notice->reply_to);
- if (!empty($reply_to)) {
- $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
- }
- $reply_to = null;
- }
+ $arr['conversation_url'] = $this->getConversationUrl($notice);
$profile = $notice->getProfile();
$arr['user']['profile_url'] = $profile->profileurl;
+ // Add needed repeat data
+
+ if (!empty($notice->repeat_of)) {
+ $original = Notice::staticGet('id', $notice->repeat_of);
+ if (!empty($original)) {
+ $arr['retweeted_status']['url'] = $original->bestUrl();
+ $arr['retweeted_status']['html'] = htmlspecialchars($original->rendered);
+ $arr['retweeted_status']['source'] = htmlspecialchars($original->source);
+ $originalProfile = $original->getProfile();
+ $arr['retweeted_status']['user']['profile_url'] = $originalProfile->profileurl;
+ $arr['retweeted_status']['conversation_url'] = $this->getConversationUrl($original);
+ }
+ $original = null;
+ }
+
return $arr;
}
return $tags;
}
- // Push this up to Plugin
-
- function log($level, $msg)
+ function getConversationUrl($notice)
{
- common_log($level, get_class($this) . ': '.$msg);
+ $convurl = null;
+
+ if ($notice->hasConversation()) {
+ $conv = Conversation::staticGet(
+ 'id',
+ $notice->conversation
+ );
+ $convurl = $conv->uri;
+
+ if(empty($convurl)) {
+ $msg = sprintf( "Could not find Conversation ID %d to make 'in context'"
+ . "link for Notice ID %d.",
+ $notice->conversation,
+ $notice->id
+ );
+
+ common_log(LOG_WARNING, $msg);
+ } else {
+ $convurl .= '#notice-' . $notice->id;
+ }
+ }
+
+ return $convurl;
}
function _getScripts()
{
- return array('plugins/Realtime/realtimeupdate.js',
- 'plugins/Realtime/json2.js');
+ if (common_config('site', 'minify')) {
+ $js = 'realtimeupdate.min.js';
+ } else {
+ $js = 'realtimeupdate.js';
+ }
+ return array(Plugin::staticPath('Realtime', $js));
+ }
+
+ /**
+ * Export any i18n messages that need to be loaded at runtime...
+ *
+ * @param Action $action
+ * @param array $messages
+ *
+ * @return boolean hook return value
+ */
+ function onEndScriptMessages($action, &$messages)
+ {
+ // TRANS: Text label for realtime view "play" button, usually replaced by an icon.
+ $messages['realtime_play'] = _m('BUTTON', 'Play');
+ // TRANS: Tooltip for realtime view "play" button.
+ $messages['realtime_play_tooltip'] = _m('TOOLTIP', 'Play');
+ // TRANS: Text label for realtime view "pause" button
+ $messages['realtime_pause'] = _m('BUTTON', 'Pause');
+ // TRANS: Tooltip for realtime view "pause" button
+ $messages['realtime_pause_tooltip'] = _m('TOOLTIP', 'Pause');
+ // TRANS: Text label for realtime view "popup" button, usually replaced by an icon.
+ $messages['realtime_popup'] = _m('BUTTON', 'Pop up');
+ // TRANS: Tooltip for realtime view "popup" button.
+ $messages['realtime_popup_tooltip'] = _m('TOOLTIP', 'Pop up in a window');
+
+ return true;
}
function _updateInitialize($timeline, $user_id)
{
- return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\"); ";
+ return "RealtimeUpdate.init($user_id, \"$this->showurl\"); ";
}
function _connect()
return '';
}
+
function _getTimeline($action)
{
- $path = null;
+ $channel = $this->_getChannel($action);
+ if (empty($channel)) {
+ return null;
+ }
+
+ return $this->_pathToChannel(array($channel->channel_key));
+ }
+
+ function _getChannel($action)
+ {
$timeline = null;
+ $arg1 = null;
+ $arg2 = null;
$action_name = $action->trimmed('action');
+ // FIXME: lists
+ // FIXME: search (!)
+ // FIXME: profile + tag
+
switch ($action_name) {
case 'public':
- $path = array('public');
+ // no arguments
break;
case 'tag':
$tag = $action->trimmed('tag');
if (!empty($tag)) {
- $path = array('tag', $tag);
+ $arg1 = $tag;
+ } else {
+ $this->log(LOG_NOTICE, "Unexpected 'tag' action without tag argument");
+ return null;
}
break;
case 'showstream':
case 'showgroup':
$nickname = common_canonical_nickname($action->trimmed('nickname'));
if (!empty($nickname)) {
- $path = array($action_name, $nickname);
+ $arg1 = $nickname;
+ } else {
+ $this->log(LOG_NOTICE, "Unexpected $action_name action without nickname argument.");
+ return null;
}
break;
default:
- break;
+ return null;
}
- if (!empty($path)) {
- $timeline = $this->_pathToChannel($path);
- }
+ $user = common_current_user();
+
+ $user_id = (!empty($user)) ? $user->id : null;
+
+ $channel = Realtime_channel::getChannel($user_id,
+ $action_name,
+ $arg1,
+ $arg2);
- return $timeline;
+ return $channel;
+ }
+
+ function onStartReadWriteTables(&$alwaysRW, &$rwdb)
+ {
+ $alwaysRW[] = 'realtime_channel';
+ return true;
}
}