2009-07-13 14:58:52 +01:00
|
|
|
<?php
|
|
|
|
/**
|
2009-08-25 23:29:56 +01:00
|
|
|
* StatusNet, the distributed open-source microblogging tool
|
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
|
|
|
*
|
|
|
|
* PHP version 5
|
|
|
|
*
|
|
|
|
* LICENCE: This program 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.
|
|
|
|
*
|
|
|
|
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
* @category Plugin
|
2009-08-25 23:29:56 +01:00
|
|
|
* @package StatusNet
|
|
|
|
* @author Evan Prodromou <evan@status.net>
|
|
|
|
* @copyright 2009 StatusNet, Inc.
|
2009-07-13 14:58:52 +01:00
|
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
2009-08-25 23:29:56 +01:00
|
|
|
* @link http://status.net/
|
2009-07-13 14:58:52 +01:00
|
|
|
*/
|
|
|
|
|
2009-08-26 15:41:36 +01:00
|
|
|
if (!defined('STATUSNET') && !defined('LACONICA')) {
|
2009-07-13 14:58:52 +01:00
|
|
|
exit(1);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
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
|
|
|
*
|
|
|
|
* @category Plugin
|
2009-08-25 23:29:56 +01:00
|
|
|
* @package StatusNet
|
|
|
|
* @author Evan Prodromou <evan@status.net>
|
2009-07-13 14:58:52 +01:00
|
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
2009-08-25 23:29:56 +01:00
|
|
|
* @link http://status.net/
|
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
|
|
|
{
|
2009-07-14 20:26:39 +01:00
|
|
|
protected $replyurl = null;
|
|
|
|
protected $favorurl = null;
|
|
|
|
protected $deleteurl = null;
|
2009-07-13 14:58:52 +01:00
|
|
|
|
2009-07-14 20:26:39 +01:00
|
|
|
function onInitializePlugin()
|
2009-07-13 14:58:52 +01:00
|
|
|
{
|
2009-07-14 20:26:39 +01:00
|
|
|
$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',
|
|
|
|
array('notice' => '0000000000'));
|
2009-07-13 14:58:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function onEndShowScripts($action)
|
|
|
|
{
|
2009-07-15 20:30:33 +01:00
|
|
|
$path = null;
|
2009-07-13 14:58:52 +01:00
|
|
|
|
2009-09-20 16:14:46 +01:00
|
|
|
$a = $action->trimmed('action');
|
|
|
|
|
|
|
|
switch ($a) {
|
|
|
|
case 'public': case 'all': case 'replies': case 'showstream':
|
|
|
|
$path = array($a);
|
|
|
|
break;
|
|
|
|
case 'tag':
|
|
|
|
$tag = $action->trimmed('tag');
|
|
|
|
if (!empty($tag)) {
|
|
|
|
$path = array('tag', $tag);
|
|
|
|
} else {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
2009-07-13 14:58:52 +01:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2009-07-15 20:30:33 +01:00
|
|
|
$timeline = $this->_pathToChannel($path);
|
|
|
|
|
2009-07-14 20:26:39 +01:00
|
|
|
$scripts = $this->_getScripts();
|
2009-07-13 14:58:52 +01:00
|
|
|
|
|
|
|
foreach ($scripts as $script) {
|
2009-08-06 01:15:00 +01: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;
|
|
|
|
}
|
|
|
|
|
|
|
|
$action->elementStart('script', array('type' => 'text/javascript'));
|
2009-09-21 19:30:22 +01:00
|
|
|
$action->raw('
|
|
|
|
<!--
|
|
|
|
$(document).ready(function() {
|
|
|
|
' . $this->_updateInitialize($timeline, $user_id) . '
|
|
|
|
});
|
|
|
|
-->
|
|
|
|
');
|
2009-07-13 14:58:52 +01:00
|
|
|
$action->elementEnd('script');
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
function onEndNoticeSave($notice)
|
|
|
|
{
|
2009-07-15 20:30:33 +01:00
|
|
|
$paths = array();
|
2009-07-13 14:58:52 +01:00
|
|
|
|
2009-09-20 16:14:46 +01:00
|
|
|
// TODO: Replies timeline
|
2009-07-13 14:58:52 +01:00
|
|
|
|
|
|
|
if ($notice->is_local ||
|
|
|
|
($notice->is_local == 0 && !common_config('public', 'localonly'))) {
|
2009-09-20 16:14:46 +01:00
|
|
|
foreach (array('public', 'all', 'replies', 'showstream') as $a) {
|
|
|
|
$paths[] = array($a);
|
|
|
|
}
|
2009-07-13 14:58:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$tags = $this->getNoticeTags($notice);
|
|
|
|
|
|
|
|
if (!empty($tags)) {
|
|
|
|
foreach ($tags as $tag) {
|
2009-07-15 20:30:33 +01:00
|
|
|
$paths[] = array('tag', $tag);
|
2009-07-13 14:58:52 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-07-15 20:30:33 +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();
|
2009-07-13 14:58:52 +01:00
|
|
|
|
2009-07-15 20:30:33 +01:00
|
|
|
foreach ($paths as $path) {
|
|
|
|
$timeline = $this->_pathToChannel($path);
|
2009-07-14 20:26:39 +01:00
|
|
|
$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;
|
|
|
|
}
|
|
|
|
|
|
|
|
function noticeAsJson($notice)
|
|
|
|
{
|
|
|
|
// 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 TwitterApiAction method. Don't do this unless you're me!
|
|
|
|
|
|
|
|
require_once(INSTALLDIR.'/lib/twitterapi.php');
|
|
|
|
|
|
|
|
$act = new TwitterApiAction('/dev/null');
|
|
|
|
|
|
|
|
$arr = $act->twitter_status_array($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;
|
|
|
|
}
|
|
|
|
|
|
|
|
$profile = $notice->getProfile();
|
|
|
|
$arr['user']['profile_url'] = $profile->profileurl;
|
|
|
|
|
|
|
|
return $arr;
|
|
|
|
}
|
|
|
|
|
|
|
|
function getNoticeTags($notice)
|
|
|
|
{
|
|
|
|
$tags = null;
|
|
|
|
|
|
|
|
$nt = new Notice_tag();
|
|
|
|
$nt->notice_id = $notice->id;
|
|
|
|
|
|
|
|
if ($nt->find()) {
|
|
|
|
$tags = array();
|
|
|
|
while ($nt->fetch()) {
|
|
|
|
$tags[] = $nt->tag;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$nt->free();
|
|
|
|
$nt = null;
|
|
|
|
|
|
|
|
return $tags;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Push this up to Plugin
|
|
|
|
|
|
|
|
function log($level, $msg)
|
|
|
|
{
|
|
|
|
common_log($level, get_class($this) . ': '.$msg);
|
|
|
|
}
|
2009-07-14 20:26:39 +01:00
|
|
|
|
|
|
|
function _getScripts()
|
|
|
|
{
|
2009-08-06 01:15:00 +01:00
|
|
|
return array('plugins/Realtime/realtimeupdate.js',
|
|
|
|
'plugins/Realtime/json2.js');
|
2009-07-14 20:26:39 +01:00
|
|
|
}
|
|
|
|
|
2009-07-14 20:39:02 +01:00
|
|
|
function _updateInitialize($timeline, $user_id)
|
2009-07-14 20:26:39 +01:00
|
|
|
{
|
2009-07-14 22:06:29 +01:00
|
|
|
return "RealtimeUpdate.init($user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\"); ";
|
2009-07-14 20:26:39 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
function _connect()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2009-07-14 20:39:02 +01:00
|
|
|
function _publish($timeline, $json)
|
2009-07-14 20:26:39 +01:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
function _disconnect()
|
|
|
|
{
|
|
|
|
}
|
2009-07-15 20:30:33 +01:00
|
|
|
|
|
|
|
function _pathToChannel($path)
|
|
|
|
{
|
|
|
|
return '';
|
|
|
|
}
|
2009-07-13 14:58:52 +01:00
|
|
|
}
|