gnu-social/lib/modules/Realtime/RealtimePlugin.php

515 lines
15 KiB
PHP
Raw Normal View History

2009-07-13 14:58:52 +01:00
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
2009-07-13 14:58:52 +01:00
/**
2009-07-14 20:26:39 +01:00
* Superclass for plugins that do "real time" updates of timelines using Ajax
2009-07-13 14:58:52 +01:00
*
* @category Plugin
* @package GNUsocial
2009-08-25 23:29:56 +01:00
* @author Evan Prodromou <evan@status.net>
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2009-2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2009-07-13 14:58:52 +01:00
*/
defined('GNUSOCIAL') || die();
2009-07-13 14:58:52 +01:00
/**
2009-07-14 20:26:39 +01:00
* Superclass for plugin to do realtime updates
*
* Based on experience with the Comet and Meteor plugins,
* this superclass extracts out some of the common functionality
2009-07-13 14:58:52 +01:00
*
* Currently depends on the Favorite module.
*
2009-07-13 14:58:52 +01:00
* @category Plugin
* @package GNUsocial
2009-08-25 23:29:56 +01:00
* @author Evan Prodromou <evan@status.net>
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2009-07-13 14:58:52 +01:00
*/
2009-07-14 20:26:39 +01:00
class RealtimePlugin extends Plugin
2009-07-13 14:58:52 +01:00
{
protected $showurl = null;
2009-07-13 14:58:52 +01:00
/**
* When it's time to initialize the plugin, calculate and
* pass the URLs we need.
*/
public function onInitializePlugin()
2009-07-13 14:58:52 +01:00
{
2009-07-14 20:26:39 +01:00
// FIXME: need to find a better way to pass this pattern in
$this->showurl = common_local_url(
'shownotice',
['notice' => '0000000000']
);
return true;
2009-07-13 14:58:52 +01:00
}
public function onCheckSchema()
2011-07-08 22:52:07 +01:00
{
$schema = Schema::get();
$schema->ensureTable('realtime_channel', Realtime_channel::schemaDef());
return true;
}
/**
* Hook for RouterInitialized event.
*
* @param URLMapper $m path-to-action mapper
* @return bool hook return
* @throws Exception
*/
public function onRouterInitialized(URLMapper $m)
{
$m->connect(
'main/channel/:channelkey/keepalive',
['action' => 'keepalivechannel'],
['channelkey' => '[a-z0-9]{32}']
);
$m->connect(
'main/channel/:channelkey/close',
['action' => 'closechannel'],
['channelkey' => '[a-z0-9]{32}']
);
return true;
}
public function onEndShowScripts(Action $action)
2009-07-13 14:58:52 +01:00
{
$channel = $this->_getChannel($action);
if (empty($channel)) {
return true;
}
$timeline = $this->_pathToChannel([$channel->channel_key]);
2009-07-13 14:58:52 +01:00
// If there's not a timeline on this page,
// just return true
if (empty($timeline)) {
return true;
2009-07-13 14:58:52 +01:00
}
2009-09-23 20:24:12 +01:00
$base = $action->selfUrl();
2009-09-24 04:04:25 +01:00
if (mb_strstr($base, '?')) {
2009-09-23 20:24:12 +01:00
$url = $base . '&realtime=1';
} else {
$url = $base . '?realtime=1';
}
2009-07-14 20:26:39 +01:00
$scripts = $this->_getScripts();
2009-07-13 14:58:52 +01:00
foreach ($scripts as $script) {
2010-01-28 03:50:08 +00:00
$action->script($script);
2009-07-13 14:58:52 +01:00
}
$user = common_current_user();
if (!empty($user->id)) {
$user_id = $user->id;
} else {
$user_id = 0;
}
2009-09-24 04:04:25 +01:00
if ($action->boolean('realtime')) {
$realtimeUI = ' RealtimeUpdate.initPopupWindow();';
} else {
$pluginPath = common_path('plugins/Realtime/');
$keepalive = common_local_url('keepalivechannel', ['channelkey' => $channel->channel_key]);
$close = common_local_url('closechannel', ['channelkey' => $channel->channel_key]);
2011-07-30 13:17:57 +01:00
$realtimeUI = ' RealtimeUpdate.initActions('.json_encode($url).', '.json_encode($timeline).', '.json_encode($pluginPath).', '.json_encode($keepalive).', '.json_encode($close).'); ';
}
$script = ' $(document).ready(function() { '.
$realtimeUI.
$this->_updateInitialize($timeline, $user_id).
'}); ';
$action->inlineScript($script);
2009-07-13 14:58:52 +01:00
return true;
}
public function onEndShowStylesheets(Action $action)
{
$urlpath = self::staticPath(
str_replace('Plugin', '', __CLASS__),
'css/realtimeupdate.css'
);
$action->cssLink($urlpath, null, 'screen, projection, tv');
return true;
}
2009-07-13 14:58:52 +01:00
public function onHandleQueuedNotice(Notice $notice)
2009-07-13 14:58:52 +01:00
{
$paths = [];
2009-07-13 14:58:52 +01:00
2009-09-23 22:28:14 +01:00
// Add to the author's timeline
try {
$profile = $notice->getProfile();
} catch (Exception $e) {
$this->log(LOG_ERR, $e->getMessage());
return true;
}
try {
$user = $profile->getUser();
$paths[] = ['showstream', $user->nickname, null];
} catch (NoSuchUserException $e) {
// We really should handle the remote profile views too
$user = null;
2009-09-23 22:28:14 +01:00
}
// Add to the public timeline
2009-07-13 14:58:52 +01:00
$is_local = intval($notice->is_local);
if ($is_local === Notice::LOCAL_PUBLIC ||
($is_local === Notice::REMOTE && !common_config('public', 'localonly'))) {
$paths[] = ['public', null, null];
2009-07-13 14:58:52 +01:00
}
2009-09-23 22:28:14 +01:00
// Add to the tags timeline
2009-07-13 14:58:52 +01:00
$tags = $this->getNoticeTags($notice);
if (!empty($tags)) {
foreach ($tags as $tag) {
$paths[] = ['tag', $tag, null];
2009-07-13 14:58:52 +01:00
}
}
2009-09-23 22:28:14 +01:00
// Add to inbox timelines
// XXX: do a join
2010-01-09 21:56:54 +00:00
$ni = $notice->whoGets();
2009-09-23 22:28:14 +01:00
2010-01-09 21:56:54 +00:00
foreach (array_keys($ni) as $user_id) {
$user = User::getKV('id', $user_id);
$paths[] = ['all', $user->getNickname(), null];
2009-09-23 22:28:14 +01:00
}
// Add to the replies timeline
$reply = new Reply();
$reply->notice_id = $notice->id;
if ($reply->find()) {
while ($reply->fetch()) {
$user = User::getKV('id', $reply->profile_id);
2009-09-23 22:28:14 +01:00
if (!empty($user)) {
$paths[] = ['replies', $user->getNickname(), null];
2009-09-23 22:28:14 +01:00
}
}
}
// Add to the group timeline
// XXX: join
$gi = new Group_inbox();
$gi->notice_id = $notice->id;
if ($gi->find()) {
while ($gi->fetch()) {
$ug = User_group::getKV('id', $gi->group_id);
$paths[] = ['showgroup', $ug->getNickname(), null];
2009-09-23 22:28:14 +01:00
}
}
if (count($paths) > 0) {
2009-07-13 14:58:52 +01:00
$json = $this->noticeAsJson($notice);
2009-07-14 20:26:39 +01:00
$this->_connect();
// XXX: We should probably fan-out here and do a
// new queue item for each path
2009-07-13 14:58:52 +01:00
foreach ($paths as $path) {
list($action, $arg1, $arg2) = $path;
$channels = Realtime_channel::getAllChannels($action, $arg1, $arg2);
$this->log(LOG_INFO, sprintf(
_("%d candidate channels for notice %d"),
count($channels),
$notice->id
));
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::getKV('id', $channel->user_id);
}
if ($notice->inScope($profile)) {
$this->log(
LOG_INFO,
sprintf(
_m("Delivering notice %d to channel (%s, %s, %s) for user '%s'"),
$notice->id,
$channel->action,
$channel->arg1,
$channel->arg2,
($profile ? $profile->getNickname() : '<public>')
)
);
$timeline = $this->_pathToChannel([$channel->channel_key]);
$this->_publish($timeline, $json);
}
}
2009-07-13 14:58:52 +01:00
}
2009-07-14 20:26:39 +01:00
$this->_disconnect();
2009-07-13 14:58:52 +01:00
}
return true;
}
public function onStartShowBody(Action $action)
{
$realtime = $action->boolean('realtime');
if (!$realtime) {
return true;
}
$action->elementStart(
'body',
(common_current_user() ? [
'id' => $action->trimmed('action'),
'class' => 'user_in realtime-popup',
] : [
'id' => $action->trimmed('action'),
'class'=> 'realtime-popup',
])
);
2009-09-23 19:58:42 +01:00
// XXX hack to deal with JS that tries to get the
// root url from page output
2009-09-24 04:04:25 +01:00
2009-09-23 19:58:42 +01:00
$action->elementStart('address');
2011-09-18 18:03:12 +01:00
if (common_config('singleuser', 'enabled')) {
$user = User::singleUser();
$url = common_local_url('showstream', ['nickname' => $user->nickname]);
2011-09-18 18:03:12 +01:00
} else {
$url = common_local_url('public');
}
$action->element(
'a',
['class' => 'url',
'href' => $url],
''
);
2011-09-18 18:03:12 +01:00
2009-09-23 19:58:42 +01:00
$action->elementEnd('address');
$action->showContentBlock();
$action->showScripts();
$action->elementEnd('body');
return false; // No default processing
}
public function noticeAsJson(Notice $notice)
2009-07-13 14:58:52 +01:00
{
// FIXME: this code should be abstracted to a neutral third
// party, like Notice::asJson(). I'm not sure of the ethics
// of refactoring from within a plugin, so I'm just abusing
// the ApiAction method. Don't do this unless you're me!
2009-07-13 14:58:52 +01:00
$act = new ApiAction('/dev/null');
2009-07-13 14:58:52 +01:00
$arr = $act->twitterStatusArray($notice, true);
$arr['url'] = $notice->getUrl(true);
$arr['html'] = htmlspecialchars($notice->getRendered());
2009-07-13 14:58:52 +01:00
$arr['source'] = htmlspecialchars($arr['source']);
$arr['conversation_url'] = $notice->getConversationUrl();
2009-07-13 14:58:52 +01:00
$profile = $notice->getProfile();
$arr['user']['profile_url'] = $profile->profileurl;
2009-12-15 20:47:37 +00:00
// Add needed repeat data
if (!empty($notice->repeat_of)) {
$original = Notice::getKV('id', $notice->repeat_of);
if ($original instanceof Notice) {
$arr['retweeted_status']['url'] = $original->getUrl(true);
$arr['retweeted_status']['html'] = htmlspecialchars($original->getRendered());
2009-12-15 20:47:37 +00:00
$arr['retweeted_status']['source'] = htmlspecialchars($original->source);
$originalProfile = $original->getProfile();
$arr['retweeted_status']['user']['profile_url'] = $originalProfile->profileurl;
$arr['retweeted_status']['conversation_url'] = $original->getConversationUrl();
2009-12-15 20:47:37 +00:00
}
unset($original);
2009-12-15 20:47:37 +00:00
}
2009-07-13 14:58:52 +01:00
return $arr;
}
public function getNoticeTags(Notice $notice)
2009-07-13 14:58:52 +01:00
{
$tags = null;
$nt = new Notice_tag();
$nt->notice_id = $notice->id;
if ($nt->find()) {
$tags = [];
2009-07-13 14:58:52 +01:00
while ($nt->fetch()) {
$tags[] = $nt->tag;
}
}
$nt->free();
$nt = null;
return $tags;
}
public function _getScripts(): array
2009-07-14 20:26:39 +01:00
{
$urlpath = self::staticPath(
str_replace('Plugin', '', __CLASS__),
'js/realtimeupdate.js'
);
return [$urlpath];
2009-07-14 20:26:39 +01:00
}
/**
* Export any i18n messages that need to be loaded at runtime...
*
* @param Action $action
* @param array $messages
*
* @return bool hook return value
* @throws Exception
*/
public function onEndScriptMessages(Action $action, array &$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;
}
public function _updateInitialize($timeline, int $user_id)
2009-07-14 20:26:39 +01:00
{
return "RealtimeUpdate.init($user_id, \"$this->showurl\"); ";
2009-07-14 20:26:39 +01:00
}
public function _connect()
2009-07-14 20:26:39 +01:00
{
}
public function _publish($timeline, $json)
2009-07-14 20:26:39 +01:00
{
}
public function _disconnect()
2009-07-14 20:26:39 +01:00
{
}
public function _pathToChannel(array $path): string
{
return '';
}
public function _getTimeline(Action $action)
{
$channel = $this->_getChannel($action);
if (empty($channel)) {
return null;
}
return $this->_pathToChannel([$channel->channel_key]);
}
public function _getChannel(Action $action)
{
$timeline = null;
$arg1 = null;
$arg2 = null;
2009-09-23 22:28:14 +01:00
$action_name = $action->trimmed('action');
// FIXME: lists
// FIXME: search (!)
// FIXME: profile + tag
2009-09-23 22:28:14 +01:00
switch ($action_name) {
case 'public':
// no arguments
break;
case 'tag':
$tag = $action->trimmed('tag');
if (!empty($tag)) {
$arg1 = $tag;
} else {
$this->log(LOG_NOTICE, "Unexpected 'tag' action without tag argument");
return null;
}
break;
2009-09-23 22:28:14 +01:00
case 'showstream':
case 'all':
case 'replies':
case 'showgroup':
$nickname = common_canonical_nickname($action->trimmed('nickname'));
if (!empty($nickname)) {
$arg1 = $nickname;
} else {
$this->log(LOG_NOTICE, "Unexpected $action_name action without nickname argument.");
return null;
2009-09-23 22:28:14 +01:00
}
break;
default:
return null;
}
$user = common_current_user();
$user_id = (!empty($user)) ? $user->id : null;
$channel = Realtime_channel::getChannel(
$user_id,
$action_name,
$arg1,
$arg2
);
return $channel;
}
public function onStartReadWriteTables(&$alwaysRW, &$rwdb)
{
$alwaysRW[] = 'realtime_channel';
return true;
}
2009-07-13 14:58:52 +01:00
}