- Updated JS and PHP egw_json code

- Added array_stripslashes() to common_functions.inc.php
- Added json handler (json.php)

json.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * eGroupWare - JSON gateway
+ *
+ * @link http://www.egroupware.org
+ * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
+ * @package api
+ * @subpackage ajax
+ * @author Andreas Stoeckel
+ * @version $Id$
+ */
+
+require_once('./phpgwapi/inc/class.egw_json.inc.php');
+
+/**
+ * Exception handler for xajax, return the message (and trace, if enabled) as alert() to the user
+ *
+ * Does NOT return!
+ *
+ * @param Exception $e
+ */
+function ajax_exception_handler(Exception $e)
+{
+	//Exceptions should be returned
+}
+
+// set our own exception handler, to not get the html from eGW's default one
+set_exception_handler('ajax_exception_handler');
+
+if (isset($_GET['menuaction']))
+{
+	if (strpos($_GET['menuaction'],'::') !== false && strpos($_GET['menuaction'],'.') === false)	// static method name app_something::method
+	{
+		@list($className,$functionName,$handler) = explode('::',$_GET['menuaction']);
+		list($appName) = explode('_',$className);
+	}
+	else
+	{
+		@list($appName, $className, $functionName, $handler) = explode('.',$_GET['menuaction']);
+	}
+	//error_log("xajax.php: appName=$appName, className=$className, functionName=$functionName, handler=$handler");
+
+	$GLOBALS['egw_info'] = array(
+		'flags' => array(
+			'currentapp'			=> $appName,
+			'noheader'		=> True,
+			'disable_Template_class'	=> True,
+			'autocreate_session_callback' => 'xajax_redirect',
+			'no_exception_handler' => true,	// we already installed our own
+			'no_dla_update' => $appName == 'notifications',	// otherwise session never time out
+		)
+	);
+	include('./header.inc.php');
+
+
+	//Create a new json handler
+	$json = new egw_json_request();
+
+	//Check whether the request data is set
+	$json->parseRequest($_GET['menuaction'], (array)$_POST['json_data']);
+	exit;
+}
+
+throw new Exception($_SERVER['PHP_SELF'] . "Invalid AJAX JSON Request");
+
+

phpgwapi/inc/class.egw_json.inc.php

@@ -4,10 +4,10 @@
  *
  * @link http://www.egroupware.org
  * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
- * @package api
+ * @package api$request['menuaction'], $parameters
  * @subpackage ajax
  * @author Andreas Stoeckel
- * @version $Id:$
+ * @version $Id$
  */
 
 /* Class which handles JSON requests to the server */
@@ -18,33 +18,99 @@ class egw_json_request
 	@param string $input_data is the RAW input data as it was received from the client
 	@param callback $callback(string $menuaction, array $parameters) called when a valid request has been received. The result of the callback function will be returned by parseRequest
 	@returns NULL if parsing the request failed, or the result of the callback function if the request has been successfully decoded.*/
-	public function parseRequest($input_data, $callback)
+	public function parseRequest($menuaction, $input_data)
 	{
-		//Decode the JSON input data into associative arrays		
-		if ($json = json_decode(stripslashes($input_data), true))
+		if (empty($input_data))
 		{
-			//Get the request array
-			if (isset($json['request']))
+			$this->handleRequest($menuaction, array());
+ 		}
+		else
+		{
+			//Decode the JSON input data into associative arrays		
+			if ($json = json_decode(stripslashes($input_data[0]), true))
 			{
-				$request = $json['request'];
-				
-				//Check whether the "menuaction" string exists
-				if (isset($request['menuaction']))
+				//Get the request array
+				if (isset($json['request']))
 				{
+					$request = $json['request'];
+				
 					//Check whether any parameters were supplied along with the request
 					$parameters = array();
 					if (isset($request['parameters']))
-						$parameters = $request['parameters'];
+						$parameters = array_stripslashes($request['parameters']);
 
 					//Call the supplied callback function along with the menuaction and the passed parameters
-					return call_user_func($callback, $request['menuaction'], $parameters);
+					$this->handleRequest($menuaction, $parameters);
 				}
 			}
-		}
+		}	
 
 		return NULL;
 	}
 
+	public function handleRequest($menuaction, $parameters)
+	{
+		if (strpos($menuaction,'::') !== false && strpos($menuaction,'.') === false)	// static method name app_something::method
+		{
+			@list($className,$functionName,$handler) = explode('::',$menuaction);
+			list($appName) = explode('_',$className);
+		}
+		else
+		{
+			@list($appName, $className, $functionName, $handler) = explode('.',$menuaction);
+		}
+		error_log("xajax.php: appName=$appName, className=$className, functionName=$functionName, handler=$handler");
+
+		switch($handler)
+		{
+/*			case '/etemplate/process_exec':
+				$menuaction = $appName.'.'.$className.'.'.$functionName;
+				$appName = $className = 'etemplate';
+				$functionName = 'process_exec';
+				$menuaction = 'etemplate.etemplate.process_exec';
+
+				$argList = array(
+					$argList[0]['etemplate_exec_id'],
+					$argList[0]['submit_button'],
+					$argList[0],
+					'xajaxResponse',
+				);
+				//error_log("xajax_doXMLHTTP() /etemplate/process_exec handler: arg0='$menuaction', menuaction='$_GET[menuaction]'");
+				break;*/
+			case 'etemplate':	// eg. ajax code in an eTemplate widget
+				$menuaction = ($appName = 'etemplate').'.'.$className.'.'.$functionName;
+				break;
+			case 'template':
+				$menuaction = $appName.'.'.$className.'.'.$functionName;
+				list($template) = explode('_', $className);
+				break;
+		}
+
+		if(substr($className,0,4) != 'ajax' && substr($className,-4) != 'ajax' &&
+			$menuaction != 'etemplate.etemplate.process_exec' && substr($functionName,0,4) != 'ajax' ||
+			!preg_match('/^[A-Za-z0-9_]+(\.[A-Za-z0-9_]+\.|::)[A-Za-z0-9_]+$/',$menuaction))
+		{
+			// stopped for security reasons
+			error_log($_SERVER['PHP_SELF']. ' stopped for security reason. '.$menuaction.' is not valid. class- or function-name must start with ajax!!!');
+			// send message also to the user
+			throw new Exception($_SERVER['PHP_SELF']. ' stopped for security reason. '.$menuaction.' is not valid. class- or function-name must start with ajax!!!');
+			exit;
+		}
+
+		if (isset($template))
+		{
+			require_once(EGW_SERVER_ROOT.'/phpgwapi/templates/'.$template.'/class.'.$className.'.inc.php');
+			$ajaxClass = new $className;
+		}
+		else
+		{
+			$ajaxClass = CreateObject($appName.'.'.$className);		
+		}
+		
+		$parameters = translation::convert($parameters, 'utf-8');
+
+		call_user_func_array(array($ajaxClass, $functionName), $parameters);
+	}
 }
 
 class egw_json_response
@@ -57,6 +123,31 @@ class egw_json_response
 	function is called */
 	protected $responseArray = array();
 
+	private static $response = null;
+
+	public static function get()
+	{
+		if (!isset(self::$response))
+		{
+			self::$response = new egw_json_response();
+		}
+		return self::$response;
+	}
+
+	/* Private function used to send the HTTP header of the JSON response */
+	private function sendHeader()
+	{
+		//Send the character encoding header
+		header('content-type: application/json; charset='.translation::charset());
+	}
+
+	/* Privade function which is used to send the result via HTTP */
+	private function sendResult()
+	{
+		$this->sendHeader();
+		echo $this->getJSON();
+	}
+
 	/* Adds any type of data to the response array */
 	protected function addGeneric($key, $data)
 	{
@@ -68,7 +159,7 @@ class egw_json_response
 	/* Adds a "data" response to the json response. This function may only be called once
 	for a single JSON response object.
 	@param object/array/string $data can be of any data type and will be added JSON Encoded to your response.*/
-	public function addData($data)
+	public function data($data)
 	{
 		/* Only allow adding the data response once */
 		if (!$this->hasData)
@@ -86,7 +177,7 @@ class egw_json_response
 	the text supplied here with the JavaScript function "alert".
 	@param string $message contains the actual message being sent to the client.
 	@param string $details (optional) can be used to inform the user on the client side about additional details about the error. This might be information how the error can be resolved/why it was raised or simply some debug data.*/
-	public function addAlert($message, $details = '')
+	public function alert($message, $details = '')
 	{
 		if (is_string($message) && is_string($details))
 		{
@@ -103,7 +194,7 @@ class egw_json_response
 	/* Allows you to add a generic java script to the response which will be executed upon the request gets received. Deprecated.
 	@deprecated
 	@param string $script the script code which should be executed upon receiving*/	
-	public function addScript($script)
+	public function script($script)
 	{
 		if (is_string($script))
 		{
@@ -120,7 +211,7 @@ class egw_json_response
 	@param string $id the identifier of the html element in which the assign shall take place
 	@param string $key the key in the html element which should be modified when the assign takes place.
 	@param string $value the value which should be assigned to the given key*/
-	public function addAssign($id, $key, $value)
+	public function assign($id, $key, $value)
 	{
 		if (is_string($id) && is_string($key) && (is_string($value) || is_numeric($value)))
 		{
@@ -142,4 +233,9 @@ class egw_json_response
 		$res['response'] = $this->responseArray;
 		return json_encode($res, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP);
 	}
+
+	public function __destruct()
+	{
+		$this->sendResult();
+	}
 }

phpgwapi/inc/common_functions.inc.php

@@ -14,6 +14,25 @@
  * @version $Id$
  */
 
+/**
+* applies stripslashes recursivly on each element of an array
+*
+* @param array &$var
+* @return array
+*/
+function array_stripslashes($var)
+{
+	if (!is_array($var))
+	{
+		return stripslashes($var);
+	}
+	foreach($var as $key => $val)
+	{
+		$var[$key] = is_array($val) ? array_stripslashes($val) : stripslashes($val);
+	}
+	return $var;
+}
+
 /**
  * Return the number of bytes of a string, independent of mbstring.func_overload
  * AND the availability of mbstring

phpgwapi/js/egw_json.js

@@ -51,10 +51,9 @@ egw_json_request.prototype.sendRequest = function(_async, _callback, _sender)
 	//Assemble the actual request string
 	var request  = '{';
 	request += '"request":{';
-	request += '"menuaction":"' + this.menuaction + '"';
 	if (this.parameters)
 	{
-		request += ',"parameters":[';
+		request += '"parameters":[';
 		for (var i = 0; i < this.parameters.length; i++)
 		{
 			if (i > 0)
@@ -71,7 +70,7 @@ egw_json_request.prototype.sendRequest = function(_async, _callback, _sender)
 	request_obj.json_data = request;
 
 	//Send the request via the jquery AJAX interface to the server
-	$.ajax({url: this.url,
+	$.ajax({url: this.url + '?menuaction=' + this.menuaction,
 		async: is_async,
 		context: this,
 		data: request_obj,
@@ -122,7 +121,10 @@ egw_json_request.prototype.handleResponse = function(data, textStatus, XMLHttpRe
 					break;
 				case 'data':
 					//Callback the caller in order to allow him to handle the data
-					this.callback.call(this.sender, data.response[i].data);
+					if (this.callback)
+					{
+						this.callback.call(this.sender, data.response[i].data);
+					}
 					hasResponse = true;
 					break;
 				case 'script':