+-----------------------------------------------------------------------+
| program/include/rcube_json_output.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2008-2010, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: $
+ $Id: rcube_json_output.php 5227 2011-09-16 17:54:07Z thomasb $
*/
*/
class rcube_json_output
{
+ /**
+ * Stores configuration object.
+ *
+ * @var rcube_config
+ */
private $config;
private $charset = RCMAIL_CHARSET;
- private $env = array();
private $texts = array();
private $commands = array();
private $callbacks = array();
private $message = null;
+ public $browser;
+ public $env = array();
public $type = 'js';
public $ajax_call = true;
-
-
+
+
/**
* Constructor
*/
- public function __construct($task)
+ public function __construct($task=null)
{
- $this->config = rcmail::get_instance()->config;
+ $this->config = rcmail::get_instance()->config;
+ $this->browser = new rcube_browser();
}
-
-
+
+
/**
* Set environment variable
*
- * @param string Property name
- * @param mixed Property value
+ * @param string $name Property name
+ * @param mixed $value Property value
*/
public function set_env($name, $value)
{
$this->env[$name] = $value;
}
-
+
+
/**
* Issue command to set page title
*
- * @param string New page title
+ * @param string $title New page title
*/
public function set_pagetitle($title)
{
- $name = $this->config->get('product_name');
+ if ($this->config->get('devel_mode') && !empty($_SESSION['username']))
+ $name = $_SESSION['username'];
+ else
+ $name = $this->config->get('product_name');
+
$this->command('set_pagetitle', empty($name) ? $title : $name.' :: '.$title);
}
+
/**
* @ignore
*/
/**
* Register a template object handler
*
- * @param string Object name
- * @param string Function name to call
+ * @param string $obj Object name
+ * @param string $func Function name to call
* @return void
*/
public function add_handler($obj, $func)
// ignore
}
+
/**
* Register a list of template object handlers
*
- * @param array Hash array with object=>handler pairs
+ * @param array $arr Hash array with object=>handler pairs
* @return void
*/
public function add_handlers($arr)
{
// ignore
}
-
-
+
+
/**
* Call a client method
*
public function command()
{
$cmd = func_get_args();
-
+
if (strpos($cmd[0], 'plugin.') === 0)
$this->callbacks[] = $cmd;
else
$this->commands[] = $cmd;
}
-
-
+
+
/**
* Add a localized label to the client environment
*/
$args = func_get_args();
if (count($args) == 1 && is_array($args[0]))
$args = $args[0];
-
+
foreach ($args as $name) {
$this->texts[$name] = rcube_label($name);
}
}
-
+
/**
* Invoke display_message command
*
- * @param string Message to display
- * @param string Message type [notice|confirm|error]
- * @param array Key-value pairs to be replaced in localized text
- * @param boolean Override last set message
+ * @param string $message Message to display
+ * @param string $type Message type [notice|confirm|error]
+ * @param array $vars Key-value pairs to be replaced in localized text
+ * @param boolean $override Override last set message
+ * @param int $timeout Message displaying time in seconds
* @uses self::command()
*/
- public function show_message($message, $type='notice', $vars=null, $override=true)
+ public function show_message($message, $type='notice', $vars=null, $override=true, $timeout=0)
{
if ($override || !$this->message) {
+ if (rcube_label_exists($message)) {
+ if (!empty($vars))
+ $vars = array_map('Q', $vars);
+ $msgtext = rcube_label(array('name' => $message, 'vars' => $vars));
+ }
+ else
+ $msgtext = $message;
+
$this->message = $message;
- $this->command(
- 'display_message',
- rcube_label(array('name' => $message, 'vars' => $vars)),
- $type
- );
+ $this->command('display_message', $msgtext, $type, $timeout * 1000);
}
}
-
+
+
/**
* Delete all stored env variables and commands
*/
$this->texts = array();
$this->commands = array();
}
-
+
+
/**
* Redirect to a certain url
*
- * @param mixed Either a string with the action or url parameters as key-value pairs
+ * @param mixed $p Either a string with the action or url parameters as key-value pairs
+ * @param int $delay Delay in seconds
* @see rcmail::url()
*/
public function redirect($p = array(), $delay = 1)
$this->remote_response("window.setTimeout(\"location.href='{$location}'\", $delay);");
exit;
}
-
-
+
+
/**
* Send an AJAX response to the client.
*/
$this->remote_response();
exit;
}
-
-
+
+
/**
* Send an AJAX response with executable JS code
*
- * @param string Additional JS code
+ * @param string $add Additional JS code
* @param boolean True if output buffer should be flushed
* @return void
* @deprecated
$s_header_sent = true;
send_nocacheing_headers();
header('Content-Type: text/plain; charset=' . $this->get_charset());
- print '/** ajax response ['.date('d/M/Y h:i:s O')."] **/\n";
}
// unset default env vars
unset($this->env['task'], $this->env['action'], $this->env['comm_path']);
$rcmail = rcmail::get_instance();
- $response = array('action' => $rcmail->action, 'unlock' => (bool)$_REQUEST['_unlock']);
-
+ $response['action'] = $rcmail->action;
+
+ if ($unlock = get_input_value('_unlock', RCUBE_INPUT_GPC)) {
+ $response['unlock'] = $unlock;
+ }
+
if (!empty($this->env))
- $response['env'] = $this->env;
-
+ $response['env'] = $this->env;
+
if (!empty($this->texts))
- $response['texts'] = $this->texts;
+ $response['texts'] = $this->texts;
// send function calls
$response['exec'] = $this->get_js_commands() . $add;
-
+
if (!empty($this->callbacks))
- $response['callbacks'] = $this->callbacks;
+ $response['callbacks'] = $this->callbacks;
echo json_serialize($response);
}
-
-
+
+
/**
* Return executable javascript code for all registered commands
*
private function get_js_commands()
{
$out = '';
-
+
foreach ($this->commands as $i => $args) {
$method = array_shift($args);
foreach ($args as $i => $arg) {
return $out;
}
}
-
-
projects / roundcube.git / blobdiff