YetiForceCompany / YetiForceCRM

libraries/restler/restler.php

Indentation +1293 added lines, -1293 removed lines

@@ -16,877 +16,877 @@ 
  */
 class Restler
 {
-    // ==================================================================
-    //
-    // Public variables
-    //
-    // ------------------------------------------------------------------
-
-    const VERSION = '2.2.1';
-
-    /**
-     * URL of the currently mapped service
-     * @var string
-     */
-    public $url;
-
-    /**
-     * Http request method of the current request.
-     * Any value between [GET, PUT, POST, DELETE]
-     * @var string
-     */
-    public $request_method;
-
-    /**
-     * Requested data format. Instance of the current format class
-     * which implements the iFormat interface
-     * @var iFormat
-     * @example jsonFormat, xmlFormat, yamlFormat etc
-     */
-    public $request_format;
-
-    /**
-     * Data sent to the service
-     * @var array
-     */
-    public $request_data = array();
-
-    /**
-     * Used in production mode to store the URL Map to disk
-     * @var string
-     */
-    public $cache_dir;
-
-    /**
-     * base directory to locate format and auth files
-     * @var string
-     */
-    public $base_dir;
-
-    /**
-     * Name of an iRespond implementation class
-     * @var string
-     */
-    public $response = 'DefaultResponse';
-
-    /**
-     * Response data format. Instance of the current format class
-     * which implements the iFormat interface
-     * @var iFormat
-     * @example jsonFormat, xmlFormat, yamlFormat etc
-     */
-    public $response_format;
-
-    // ==================================================================
-    //
-    // Private & Protected variables
-    //
-    // ------------------------------------------------------------------
-
-    /**
-     * When set to false, it will run in debug mode and parse the
-     * class files every time to map it to the URL
-     * @var boolean
-     */
-    protected $production_mode;
-
-    /**
-     * Associated array that maps urls to their respective class and method
-     * @var array
-     */
-    protected $routes = array();
-
-    /**
-     * Associated array that maps formats to their respective format class name
-     * @var array
-     */
-    protected $format_map = array();
-
-    /**
-     * Instance of the current api service class
-     * @var object
-     */
-    protected $service_class_instance;
-
-    /**
-     * Name of the api method being called
-     * @var string
-     */
-    protected $service_method;
-
-    /**
-     * list of authentication classes
-     * @var array
-     */
-    protected $auth_classes = array();
-
-    /**
-     * list of error handling classes
-     * @var array
-     */
-    protected $error_classes = array();
-
-    /**
-     * HTTP status codes
-     * @var array
-     */
-    private $codes = array(
-        100 => 'Continue',
-        101 => 'Switching Protocols',
-        200 => 'OK',
-        201 => 'Created',
-        202 => 'Accepted',
-        203 => 'Non-Authoritative Information',
-        204 => 'No Content',
-        205 => 'Reset Content',
-        206 => 'Partial Content',
-        300 => 'Multiple Choices',
-        301 => 'Moved Permanently',
-        302 => 'Found',
-        303 => 'See Other',
-        304 => 'Not Modified',
-        305 => 'Use Proxy',
-        306 => '(Unused)',
-        307 => 'Temporary Redirect',
-        400 => 'Bad Request',
-        401 => 'Unauthorized',
-        402 => 'Payment Required',
-        403 => 'Forbidden',
-        404 => 'Not Found',
-        405 => 'Method Not Allowed',
-        406 => 'Not Acceptable',
-        407 => 'Proxy Authentication Required',
-        408 => 'Request Timeout',
-        409 => 'Conflict',
-        410 => 'Gone',
-        411 => 'Length Required',
-        412 => 'Precondition Failed',
-        413 => 'Request Entity Too Large',
-        414 => 'Request-URI Too Long',
-        415 => 'Unsupported Media Type',
-        416 => 'Requested Range Not Satisfiable',
-        417 => 'Expectation Failed',
-        500 => 'Internal Server Error',
-        501 => 'Not Implemented',
-        502 => 'Bad Gateway',
-        503 => 'Service Unavailable',
-        504 => 'Gateway Timeout',
-        505 => 'HTTP Version Not Supported'
-    );
-
-    /**
-     * Caching of url map is enabled or not
-     * @var boolean
-     */
-    protected $cached;
-
-    // ==================================================================
-    //
-    // Public functions
-    //
-    // ------------------------------------------------------------------
-
-
-    /**
-     * Constructor
-     * @param boolean $production_mode When set to false, it will run in
-     * debug mode and parse the class files every time to map it to the URL
-     */
-    public function __construct($production_mode = false)
-    {
-        $this->production_mode = $production_mode;
-        $this->cache_dir = getcwd();
-        $this->base_dir = RESTLER_PATH;
-    }
-
-
-    /**
-     * Store the url map cache if needed
-     */
-    public function __destruct()
-    {
-        if ($this->production_mode && !($this->cached)) {
-            $this->saveCache();
-        }
-    }
-
-
-    /**
-     * Use it in production mode to refresh the url map cache
-     */
-    public function refreshCache()
-    {
-        $this->routes = array();
-        $this->cached = false;
-    }
-
-
-    /**
-     * Call this method and pass all the formats that should be
-     * supported by the API. Accepts multiple parameters
-     * @param string class name of the format class that implements iFormat
-     * @example $restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);
-     */
-    public function setSupportedFormats()
-    {
-        $args = func_get_args();
-        $extensions = array();
-        foreach ($args as $class_name) {
-            if (!is_string($class_name) || !class_exists($class_name)) {
-                throw new Exception("$class_name is not a vaild Format Class.");
-            }
-            $obj = new $class_name;
-            if (!($obj instanceof iFormat)) {
-                throw new Exception('Invalid format class; must implement '
-                    . 'iFormat interface');
-            }
-            foreach ($obj->getMIMEMap() as $extension => $mime) {
-                if (!isset($this->format_map[$extension])) {
-                    $this->format_map[$extension] = $class_name;
-                }
-                $mime = explode(',', $mime);
-                if (!is_array($mime)) {
-                    $mime = array($mime);
-                }
-                foreach ($mime as $value) {
-                    if (!isset($this->format_map[$value])) {
-                        $this->format_map[$value] = $class_name;
-                    }
-                }
-                $extensions[".$extension"] = true;
-            }
-        }
-        $this->format_map['default'] = $args[0];
-        $this->format_map['extensions'] = array_keys($extensions);
-    }
-
-
-    /**
-     * Add api classes throgh this method. All the public methods
-     * that do not start with _ (underscore) will be  will be exposed
-     * as the public api by default.
-     *
-     * All the protected methods that do not start with _ (underscore)
-     * will exposed as protected api which will require authentication
-     * @param string $class name of the service class
-     * @param string $basePath optional url prefix for mapping, uses
-     * lowercase version of the class name when not specified
-     * @throws Exception when supplied with invalid class name
-     */
-    public function addAPIClass($class_name, $base_path = null)
-    {
-        if (!class_exists($class_name)) {
-            throw new Exception("API class $class_name is missing.");
-        }
-        $this->loadCache();
-        if (!$this->cached) {
-            if (is_null($base_path)) {
-                $base_path = strtolower($class_name);
-                $index = strrpos($class_name, '\\');
-                if ($index !== false) {
-                    $base_path = substr($base_path, $index + 1);
-                }
-            } else {
-                $base_path = trim($base_path, '/');
-            }
-            if (strlen($base_path) > 0) {
-                $base_path .= '/';
-            }
-            $this->generateMap($class_name, $base_path);
-        }
-    }
-
-
-    /**
-     * protected methods will need atleast one authentication class to be set
-     * in order to allow that method to be executed
-     * @param string $class_name of the authentication class
-     * @param string $base_path optional url prefix for mapping
-     */
-    public function addAuthenticationClass($class_name, $base_path = null)
-    {
-        $this->auth_classes[] = $class_name;
-        $this->addAPIClass($class_name, $base_path);
-    }
-
-
-    /**
-     * Add class for custom error handling
-     * @param string $class_name of the error handling class
-     */
-    public function addErrorClass($class_name)
-    {
-        $this->error_classes[] = $class_name;
-    }
-
-
-    /**
-     * Convenience method to respond with an error message
-     * @param int $statusCode http error code
-     * @param string $errorMessage optional custom error message
-     */
-    public function handleError($status_code, $error_message = null)
-    {
-        $method = "handle$status_code";
-        $handled = false;
-        foreach ($this->error_classes as $class_name) {
-            if (method_exists($class_name, $method)) {
-                $obj = new $class_name();
-                $obj->restler = $this;
-                $obj->$method();
-                $handled = true;
-            }
-        }
-        if ($handled) {
-            return;
-        }
-        $message = $this->codes[$status_code]
-            . (!$error_message ? '' : ': ' . $error_message);
-        $this->setStatus($status_code);
-        $responder = new $this->response();
-        $responder->restler = $this;
-        $this->sendData($responder->__formatError($status_code, $message));
-    }
-
-
-    /**
-     * An initialize function to allow use of the restler error generation 
-     * functions for pre-processing and pre-routing of requests.
-     */
-    public function init()
-    {
-        if (empty($this->format_map)) {
-            $this->setSupportedFormats('JsonFormat');
-        }
-        $this->url = $this->getPath();
-        $this->request_method = $this->getRequestMethod();
-        $this->response_format = $this->getResponseFormat();
-        $this->request_format = $this->getRequestFormat();
-        if (is_null($this->request_format)) {
-            $this->request_format = $this->response_format;
-        }
-        if ($this->request_method == 'PUT' || $this->request_method == 'POST') {
-            $this->request_data = $this->getRequestData();
-        }
-    }
-
-
-    /**
-     * Main function for processing the api request
-     * and return the response
-     * @throws Exception when the api service class is missing
-     * @throws RestException to send error response
-     */
-    public function handle()
-    {
-        $this->init();
-        $o = $this->mapUrlToMethod();
-
-        if (!isset($o->class_name)) {
-            $this->handleError(404);
-        } else {
-            try {
-                if ($o->method_flag) {
-                    $auth_method = '__isAuthenticated';
-                    if (!count($this->auth_classes)) {
-                        throw new RestException(401);
-                    }
-                    foreach ($this->auth_classes as $auth_class) {
-                        $auth_obj = new $auth_class();
-                        $auth_obj->restler = $this;
-                        $this->applyClassMetadata($auth_class, $auth_obj, $o);
-                        if (!method_exists($auth_obj, $auth_method)) {
-                            throw new RestException(401, 'Authentication Class '
-                                . 'should implement iAuthenticate');
-                        } else if (!$auth_obj->$auth_method()) {
-                            throw new RestException(401);
-                        }
-                    }
-                }
-                $this->applyClassMetadata(get_class($this->request_format),
-                    $this->request_format, $o);
-                $pre_process = '_' . $this->request_format->getExtension() . '_'
-                    . $o->method_name;
-                $this->service_method = $o->method_name;
-                if ($o->method_flag == 2) {
-                    $o = unprotect($o);
-                }
-                $object = $this->service_class_instance = new $o->class_name();
-                $object->restler = $this;
-                if (method_exists($o->class_name, $pre_process)) {
-                    call_user_func_array(
-                        array($object, $pre_process), $o->arguments
-                    );
-                }
-                switch ($o->method_flag) {
-                    case 3:
-                        $reflection_method = new ReflectionMethod($object,
-                                $o->method_name);
-                        $reflection_method->setAccessible(true);
-                        $result = $reflection_method->invokeArgs($object,
-                            $o->arguments);
-                        break;
-                    case 2:
-                    case 1:
-                    default:
-                        $result = call_user_func_array(array(
-                            $object,
-                            $o->method_name), $o->arguments
-                        );
-                        break;
-                }
-            } catch (RestException $e) {
-                $this->handleError($e->getCode(), $e->getMessage());
-            }
-        }
-        $responder = new $this->response();
-        $responder->restler = $this;
-        $this->applyClassMetadata($this->response, $responder, $o);
-        if (isset($result) && $result !== null) {
-            $result = $responder->__formatResponse($result);
-            $this->sendData($result);
-        }
-    }
-
-
-    /**
-     * Encodes the response in the prefered format
-     * and sends back
-     * @param $data array php data
-     */
-    public function sendData($data)
-    {
-        $data = $this->response_format->encode($data, 
-            !($this->production_mode)
-        );
-        $post_process = '_' . $this->service_method . '_'
-            . $this->response_format->getExtension();
-        if (isset($this->service_class_instance)
-            && method_exists($this->service_class_instance, $post_process)
-        ) {
-            $data = call_user_func(array($this->service_class_instance,
-                $post_process), $data);
-        }
-        header("Cache-Control: no-cache, must-revalidate");
-        header("Expires: 0");
-        header('Content-Type: ' . $this->response_format->getMIME());
-        //.'; charset=utf-8');
-        header("X-Powered-By: Luracast Restler v" . Restler::VERSION);
+	// ==================================================================
+	//
+	// Public variables
+	//
+	// ------------------------------------------------------------------
+
+	const VERSION = '2.2.1';
+
+	/**
+	 * URL of the currently mapped service
+	 * @var string
+	 */
+	public $url;
+
+	/**
+	 * Http request method of the current request.
+	 * Any value between [GET, PUT, POST, DELETE]
+	 * @var string
+	 */
+	public $request_method;
+
+	/**
+	 * Requested data format. Instance of the current format class
+	 * which implements the iFormat interface
+	 * @var iFormat
+	 * @example jsonFormat, xmlFormat, yamlFormat etc
+	 */
+	public $request_format;
+
+	/**
+	 * Data sent to the service
+	 * @var array
+	 */
+	public $request_data = array();
+
+	/**
+	 * Used in production mode to store the URL Map to disk
+	 * @var string
+	 */
+	public $cache_dir;
+
+	/**
+	 * base directory to locate format and auth files
+	 * @var string
+	 */
+	public $base_dir;
+
+	/**
+	 * Name of an iRespond implementation class
+	 * @var string
+	 */
+	public $response = 'DefaultResponse';
+
+	/**
+	 * Response data format. Instance of the current format class
+	 * which implements the iFormat interface
+	 * @var iFormat
+	 * @example jsonFormat, xmlFormat, yamlFormat etc
+	 */
+	public $response_format;
+
+	// ==================================================================
+	//
+	// Private & Protected variables
+	//
+	// ------------------------------------------------------------------
+
+	/**
+	 * When set to false, it will run in debug mode and parse the
+	 * class files every time to map it to the URL
+	 * @var boolean
+	 */
+	protected $production_mode;
+
+	/**
+	 * Associated array that maps urls to their respective class and method
+	 * @var array
+	 */
+	protected $routes = array();
+
+	/**
+	 * Associated array that maps formats to their respective format class name
+	 * @var array
+	 */
+	protected $format_map = array();
+
+	/**
+	 * Instance of the current api service class
+	 * @var object
+	 */
+	protected $service_class_instance;
+
+	/**
+	 * Name of the api method being called
+	 * @var string
+	 */
+	protected $service_method;
+
+	/**
+	 * list of authentication classes
+	 * @var array
+	 */
+	protected $auth_classes = array();
+
+	/**
+	 * list of error handling classes
+	 * @var array
+	 */
+	protected $error_classes = array();
+
+	/**
+	 * HTTP status codes
+	 * @var array
+	 */
+	private $codes = array(
+		100 => 'Continue',
+		101 => 'Switching Protocols',
+		200 => 'OK',
+		201 => 'Created',
+		202 => 'Accepted',
+		203 => 'Non-Authoritative Information',
+		204 => 'No Content',
+		205 => 'Reset Content',
+		206 => 'Partial Content',
+		300 => 'Multiple Choices',
+		301 => 'Moved Permanently',
+		302 => 'Found',
+		303 => 'See Other',
+		304 => 'Not Modified',
+		305 => 'Use Proxy',
+		306 => '(Unused)',
+		307 => 'Temporary Redirect',
+		400 => 'Bad Request',
+		401 => 'Unauthorized',
+		402 => 'Payment Required',
+		403 => 'Forbidden',
+		404 => 'Not Found',
+		405 => 'Method Not Allowed',
+		406 => 'Not Acceptable',
+		407 => 'Proxy Authentication Required',
+		408 => 'Request Timeout',
+		409 => 'Conflict',
+		410 => 'Gone',
+		411 => 'Length Required',
+		412 => 'Precondition Failed',
+		413 => 'Request Entity Too Large',
+		414 => 'Request-URI Too Long',
+		415 => 'Unsupported Media Type',
+		416 => 'Requested Range Not Satisfiable',
+		417 => 'Expectation Failed',
+		500 => 'Internal Server Error',
+		501 => 'Not Implemented',
+		502 => 'Bad Gateway',
+		503 => 'Service Unavailable',
+		504 => 'Gateway Timeout',
+		505 => 'HTTP Version Not Supported'
+	);
+
+	/**
+	 * Caching of url map is enabled or not
+	 * @var boolean
+	 */
+	protected $cached;
+
+	// ==================================================================
+	//
+	// Public functions
+	//
+	// ------------------------------------------------------------------
+
+
+	/**
+	 * Constructor
+	 * @param boolean $production_mode When set to false, it will run in
+	 * debug mode and parse the class files every time to map it to the URL
+	 */
+	public function __construct($production_mode = false)
+	{
+		$this->production_mode = $production_mode;
+		$this->cache_dir = getcwd();
+		$this->base_dir = RESTLER_PATH;
+	}
+
+
+	/**
+	 * Store the url map cache if needed
+	 */
+	public function __destruct()
+	{
+		if ($this->production_mode && !($this->cached)) {
+			$this->saveCache();
+		}
+	}
+
+
+	/**
+	 * Use it in production mode to refresh the url map cache
+	 */
+	public function refreshCache()
+	{
+		$this->routes = array();
+		$this->cached = false;
+	}
+
+
+	/**
+	 * Call this method and pass all the formats that should be
+	 * supported by the API. Accepts multiple parameters
+	 * @param string class name of the format class that implements iFormat
+	 * @example $restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);
+	 */
+	public function setSupportedFormats()
+	{
+		$args = func_get_args();
+		$extensions = array();
+		foreach ($args as $class_name) {
+			if (!is_string($class_name) || !class_exists($class_name)) {
+				throw new Exception("$class_name is not a vaild Format Class.");
+			}
+			$obj = new $class_name;
+			if (!($obj instanceof iFormat)) {
+				throw new Exception('Invalid format class; must implement '
+					. 'iFormat interface');
+			}
+			foreach ($obj->getMIMEMap() as $extension => $mime) {
+				if (!isset($this->format_map[$extension])) {
+					$this->format_map[$extension] = $class_name;
+				}
+				$mime = explode(',', $mime);
+				if (!is_array($mime)) {
+					$mime = array($mime);
+				}
+				foreach ($mime as $value) {
+					if (!isset($this->format_map[$value])) {
+						$this->format_map[$value] = $class_name;
+					}
+				}
+				$extensions[".$extension"] = true;
+			}
+		}
+		$this->format_map['default'] = $args[0];
+		$this->format_map['extensions'] = array_keys($extensions);
+	}
+
+
+	/**
+	 * Add api classes throgh this method. All the public methods
+	 * that do not start with _ (underscore) will be  will be exposed
+	 * as the public api by default.
+	 *
+	 * All the protected methods that do not start with _ (underscore)
+	 * will exposed as protected api which will require authentication
+	 * @param string $class name of the service class
+	 * @param string $basePath optional url prefix for mapping, uses
+	 * lowercase version of the class name when not specified
+	 * @throws Exception when supplied with invalid class name
+	 */
+	public function addAPIClass($class_name, $base_path = null)
+	{
+		if (!class_exists($class_name)) {
+			throw new Exception("API class $class_name is missing.");
+		}
+		$this->loadCache();
+		if (!$this->cached) {
+			if (is_null($base_path)) {
+				$base_path = strtolower($class_name);
+				$index = strrpos($class_name, '\\');
+				if ($index !== false) {
+					$base_path = substr($base_path, $index + 1);
+				}
+			} else {
+				$base_path = trim($base_path, '/');
+			}
+			if (strlen($base_path) > 0) {
+				$base_path .= '/';
+			}
+			$this->generateMap($class_name, $base_path);
+		}
+	}
+
+
+	/**
+	 * protected methods will need atleast one authentication class to be set
+	 * in order to allow that method to be executed
+	 * @param string $class_name of the authentication class
+	 * @param string $base_path optional url prefix for mapping
+	 */
+	public function addAuthenticationClass($class_name, $base_path = null)
+	{
+		$this->auth_classes[] = $class_name;
+		$this->addAPIClass($class_name, $base_path);
+	}
+
+
+	/**
+	 * Add class for custom error handling
+	 * @param string $class_name of the error handling class
+	 */
+	public function addErrorClass($class_name)
+	{
+		$this->error_classes[] = $class_name;
+	}
+
+
+	/**
+	 * Convenience method to respond with an error message
+	 * @param int $statusCode http error code
+	 * @param string $errorMessage optional custom error message
+	 */
+	public function handleError($status_code, $error_message = null)
+	{
+		$method = "handle$status_code";
+		$handled = false;
+		foreach ($this->error_classes as $class_name) {
+			if (method_exists($class_name, $method)) {
+				$obj = new $class_name();
+				$obj->restler = $this;
+				$obj->$method();
+				$handled = true;
+			}
+		}
+		if ($handled) {
+			return;
+		}
+		$message = $this->codes[$status_code]
+			. (!$error_message ? '' : ': ' . $error_message);
+		$this->setStatus($status_code);
+		$responder = new $this->response();
+		$responder->restler = $this;
+		$this->sendData($responder->__formatError($status_code, $message));
+	}
+
+
+	/**
+	 * An initialize function to allow use of the restler error generation 
+	 * functions for pre-processing and pre-routing of requests.
+	 */
+	public function init()
+	{
+		if (empty($this->format_map)) {
+			$this->setSupportedFormats('JsonFormat');
+		}
+		$this->url = $this->getPath();
+		$this->request_method = $this->getRequestMethod();
+		$this->response_format = $this->getResponseFormat();
+		$this->request_format = $this->getRequestFormat();
+		if (is_null($this->request_format)) {
+			$this->request_format = $this->response_format;
+		}
+		if ($this->request_method == 'PUT' || $this->request_method == 'POST') {
+			$this->request_data = $this->getRequestData();
+		}
+	}
+
+
+	/**
+	 * Main function for processing the api request
+	 * and return the response
+	 * @throws Exception when the api service class is missing
+	 * @throws RestException to send error response
+	 */
+	public function handle()
+	{
+		$this->init();
+		$o = $this->mapUrlToMethod();
+
+		if (!isset($o->class_name)) {
+			$this->handleError(404);
+		} else {
+			try {
+				if ($o->method_flag) {
+					$auth_method = '__isAuthenticated';
+					if (!count($this->auth_classes)) {
+						throw new RestException(401);
+					}
+					foreach ($this->auth_classes as $auth_class) {
+						$auth_obj = new $auth_class();
+						$auth_obj->restler = $this;
+						$this->applyClassMetadata($auth_class, $auth_obj, $o);
+						if (!method_exists($auth_obj, $auth_method)) {
+							throw new RestException(401, 'Authentication Class '
+								. 'should implement iAuthenticate');
+						} else if (!$auth_obj->$auth_method()) {
+							throw new RestException(401);
+						}
+					}
+				}
+				$this->applyClassMetadata(get_class($this->request_format),
+					$this->request_format, $o);
+				$pre_process = '_' . $this->request_format->getExtension() . '_'
+					. $o->method_name;
+				$this->service_method = $o->method_name;
+				if ($o->method_flag == 2) {
+					$o = unprotect($o);
+				}
+				$object = $this->service_class_instance = new $o->class_name();
+				$object->restler = $this;
+				if (method_exists($o->class_name, $pre_process)) {
+					call_user_func_array(
+						array($object, $pre_process), $o->arguments
+					);
+				}
+				switch ($o->method_flag) {
+					case 3:
+						$reflection_method = new ReflectionMethod($object,
+								$o->method_name);
+						$reflection_method->setAccessible(true);
+						$result = $reflection_method->invokeArgs($object,
+							$o->arguments);
+						break;
+					case 2:
+					case 1:
+					default:
+						$result = call_user_func_array(array(
+							$object,
+							$o->method_name), $o->arguments
+						);
+						break;
+				}
+			} catch (RestException $e) {
+				$this->handleError($e->getCode(), $e->getMessage());
+			}
+		}
+		$responder = new $this->response();
+		$responder->restler = $this;
+		$this->applyClassMetadata($this->response, $responder, $o);
+		if (isset($result) && $result !== null) {
+			$result = $responder->__formatResponse($result);
+			$this->sendData($result);
+		}
+	}
+
+
+	/**
+	 * Encodes the response in the prefered format
+	 * and sends back
+	 * @param $data array php data
+	 */
+	public function sendData($data)
+	{
+		$data = $this->response_format->encode($data, 
+			!($this->production_mode)
+		);
+		$post_process = '_' . $this->service_method . '_'
+			. $this->response_format->getExtension();
+		if (isset($this->service_class_instance)
+			&& method_exists($this->service_class_instance, $post_process)
+		) {
+			$data = call_user_func(array($this->service_class_instance,
+				$post_process), $data);
+		}
+		header("Cache-Control: no-cache, must-revalidate");
+		header("Expires: 0");
+		header('Content-Type: ' . $this->response_format->getMIME());
+		//.'; charset=utf-8');
+		header("X-Powered-By: Luracast Restler v" . Restler::VERSION);
 		if($this->production_mode){
 			die($data);
 		}else{
 			echo $data;
 		}
-    }
-
-
-    /**
-     * Sets the HTTP response status
-     * @param int $code response code
-     */
-    public function setStatus($code)
-    {
-        header("{$_SERVER['SERVER_PROTOCOL']} $code " . 
-            $this->codes[strval($code)]);
-    }
-
-
-    /**
-     * Compare two strings and remove the common
-     * sub string from the first string and return it
-     * @param string $first
-     * @param string $second
-     * @param string $char optional, set it as
-     * blank string for char by char comparison
-     * @return string
-     */
-    public function removeCommonPath($first, $second, $char = '/')
-    {
-        $first = explode($char, $first);
-        $second = explode($char, $second);
-        while (count($second)) {
-            if ($first[0] == $second[0]) {
-                array_shift($first);
-            } else {
-                break;
-            }
-            array_shift($second);
-        }
-        return implode($char, $first);
-    }
-
-
-    /**
-     * Save cache to file
-     */
-    public function saveCache()
-    {
-        $file = $this->cache_dir . '/routes.php';
-        $s = '$o=array();' . PHP_EOL;
-        foreach ($this->routes as $key => $value) {
-            $s .= PHP_EOL . PHP_EOL . PHP_EOL . 
-                "############### $key ###############" . PHP_EOL . PHP_EOL;
-            $s .= '$o[\'' . $key . '\']=array();';
-            foreach ($value as $ke => $va) {
-                $s .= PHP_EOL . PHP_EOL . "#==== $key $ke" . PHP_EOL . PHP_EOL;
-                $s .= '$o[\'' . $key . '\'][\'' . $ke . '\']=' . str_replace(
-                        PHP_EOL, PHP_EOL . "\t", var_export($va, true)
-                    ) . ';';
-            }
-        }
-        $s .= PHP_EOL . 'return $o;';
-        $r = @file_put_contents($file, "<?php $s");
-        @chmod($file, 0777);
-        if ($r === false) {
-            throw new Exception(
-                "The cache directory located at '$this->cache_dir' needs to "
-                . "have the permissions set to read/write/execute for everyone"
-                . " in order to save cache and improve performance.");
-        }
-    }
-
-    // ==================================================================
-    //
-    // Protected functions
-    //
-    // ------------------------------------------------------------------
-
-
-    /**
-     * Parses the requst url and get the api path
-     * @return string api path
-     */
-    protected function getPath()
-    {
-        $path = urldecode($this->removeCommonPath($_SERVER['REQUEST_URI'],
-                $_SERVER['SCRIPT_NAME']));
-        $path = preg_replace('/(\/*\?.*$)|(\/$)/', '', $path);
-        $path = str_replace($this->format_map['extensions'], '', $path);
-        return $path;
-    }
-
-
-    /**
-     * Parses the request to figure out the http request type
-     * @return string which will be one of the following
-     * [GET, POST, PUT, DELETE]
-     * @example GET
-     */
-    protected function getRequestMethod()
-    {
-        $method = $_SERVER['REQUEST_METHOD'];
-        if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {
-            $method = $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'];
-        }
-        //support for HEAD request
-        if ($method == 'HEAD') {
-            $method = 'GET';
-        }
-        return $method;
-    }
-
-
-    /**
-     * Parses the request to figure out format of the request data
-     * @return iFormat any class that implements iFormat
-     * @example JsonFormat
-     */
-    protected function getRequestFormat()
-    {
-        $format = null;
-        //check if client has sent any information on request format
-        if (isset($_SERVER['CONTENT_TYPE'])) {
-            $mime = explode(';', $_SERVER['CONTENT_TYPE']);
-            $mime = $mime[0];
-            if ($mime == UrlEncodedFormat::MIME) {
-                $format = new UrlEncodedFormat();
-            } else {
-                if (isset($this->format_map[$mime])) {
-                    $format = $this->format_map[$mime];
-                    $format = is_string($format) ? new $format : $format;
-                    $format->setMIME($mime);
-                }
-            }
-        }
-        return $format;
-    }
-
-
-    /**
-     * Parses the request to figure out the best format for response
-     * @return iFormat any class that implements iFormat
-     * @example JsonFormat
-     */
-    protected function getResponseFormat()
-    {
-        //check if client has specified an extension
-        /**
-         * @var iFormat
-         */
-        $format = null;
-        $extensions = explode('.',
-            parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));
-        while ($extensions) {
-            $extension = array_pop($extensions);
-            $extension = explode('/', $extension);
-            $extension = array_shift($extension);
-            if ($extension && isset($this->format_map[$extension])) {
-                $format = $this->format_map[$extension];
-                $format = is_string($format) ? new $format : $format;
-                $format->setExtension($extension);
-                return $format;
-            }
-        }
-        //check if client has sent list of accepted data formats
-        if (isset($_SERVER['HTTP_ACCEPT'])) {
-            $acceptList = array();
-            $accepts = explode(',', strtolower($_SERVER['HTTP_ACCEPT']));
-            if (!is_array($accepts)) {
-                $accepts = array($accepts);
-            }
-            foreach ($accepts as $pos => $accept) {
-                $parts = explode(';q=', trim($accept));
-                $type = array_shift($parts);
-                $quality = count($parts) ? 
-                    floatval(array_shift($parts)) : 
-                    (1000 - $pos) / 1000;
-                $acceptList[$type] = $quality;
-            }
-            arsort($acceptList);
-            foreach ($acceptList as $accept => $quality) {
-                if (isset($this->format_map[$accept])) {
-                    $format = $this->format_map[$accept];
-                    $format = is_string($format) ? new $format : $format;
-                    $format->setMIME($accept);
-                    // Tell cache content is based on Accept header
-                    header("Vary: Accept"); 
-                    return $format;
-                }
-            }
-        } else {
-            // RFC 2616: If no Accept header field is
-            // present, then it is assumed that the
-            // client accepts all media types.
-            $_SERVER['HTTP_ACCEPT'] = '*/*';
-        }
-        if (strpos($_SERVER['HTTP_ACCEPT'], '*') !== false) {
-            if (strpos($_SERVER['HTTP_ACCEPT'], 'application/*') !== false) {
-                $format = new JsonFormat;
-            } else if (strpos($_SERVER['HTTP_ACCEPT'], 'text/*') !== false) {
-                $format = new XmlFormat;
-            } else if (strpos($_SERVER['HTTP_ACCEPT'], '*/*') !== false) {
-                $format = new $this->format_map['default'];
-            }
-        }
-        if (empty($format)) {
-            // RFC 2616: If an Accept header field is present, and if the 
-            // server cannot send a response which is acceptable according to 
-            // the combined Accept field value, then the server SHOULD send 
-            // a 406 (not acceptable) response.
-            header('HTTP/1.1 406 Not Acceptable');
-            die('406 Not Acceptable: The server was unable to ' . 
-                    'negotiate content for this request.');
-        } else {
-            // Tell cache content is based ot Accept header
-            header("Vary: Accept"); 
-            return $format;
-        }
-    }
-
-
-    /**
-     * Parses the request data and returns it
-     * @return array php data
-     */
-    protected function getRequestData()
-    {
-        try {
-            $r = file_get_contents('php://input');
-            if (is_null($r)) {
-                return $_GET;
-            }
-            $r = $this->request_format->decode($r);
-            return is_null($r) ? array() : $r;
-        } catch (RestException $e) {
-            $this->handleError($e->getCode(), $e->getMessage());
-        }
-    }
-
-
-    protected function mapUrlToMethod()
-    {
-        if (!isset($this->routes[$this->request_method])) {
-            return array();
-        }
-        $urls = $this->routes[$this->request_method];
-        if (!$urls) {
-            return array();
-        }
-
-        $found = false;
-        $this->request_data += $_GET;
-        $params = array('request_data' => $this->request_data);
-        $params += $this->request_data;
-        $lc = strtolower($this->url);
-        foreach ($urls as $url => $call) {
-            $call = (object) $call;
-            if (strstr($url, ':')) {
-                $regex = preg_replace('/\\\:([^\/]+)/', '(?P<$1>[^/]+)',
-                    preg_quote($url));
-                if (preg_match(":^$regex$:i", $this->url, $matches)) {
-                    foreach ($matches as $arg => $match) {
-                        if (isset($call->arguments[$arg])) {
-                            //flog("$arg => $match $args[$arg]");
-                            $params[$arg] = $match;
-                        }
-                    }
-                    $found = true;
-                    break;
-                }
-            } else if ($url == $lc) {
-                $found = true;
-                break;
-            }
-        }
-        if ($found) {
-            $p = $call->defaults;
-            foreach ($call->arguments as $key => $value) {
-                if (isset($params[$key])) {
-                    $p[$value] = $params[$key];
-                }
-            }
-            $call->arguments = $p;
-            return $call;
-        }
-    }
-
-
-    /**
-     * Apply static and non-static properties defined in
-     * the method information anotation
-     * @param String $class_name
-     * @param Object $instance instance of that class
-     * @param Object $method_info method information and metadata
-     */
-    protected function applyClassMetadata($class_name, $instance, $method_info)
-    {
-        if (isset($method_info->metadata[$class_name])
-            && is_array($method_info->metadata[$class_name])
-        ) {
-            foreach ($method_info->metadata[$class_name] as
-                    $property => $value) {
-                if (property_exists($class_name, $property)) {
-                    $reflection_property = 
-                        new ReflectionProperty($class_name, $property);
-                    $reflection_property->setValue($instance, $value);
-                }
-            }
-        }
-    }
-
-
-    protected function loadCache()
-    {
-        if ($this->cached !== null) {
-            return;
-        }
-        $file = $this->cache_dir . '/routes.php';
-        $this->cached = false;
-
-        if ($this->production_mode) {
-            if (file_exists($file)) {
-                $routes = include($file);
-            }
-            if (isset($routes) && is_array($routes)) {
-                $this->routes = $routes;
-                $this->cached = true;
-            }
-        } else {
-            //@unlink($this->cache_dir . "/$name.php");
-        }
-    }
-
-
-    /**
-     * Generates cachable url to method mapping
-     * @param string $class_name
-     * @param string $base_path
-     */
-    protected function generateMap($class_name, $base_path = '')
-    {
-        $reflection = new ReflectionClass($class_name);
-        $class_metadata = parse_doc($reflection->getDocComment());
-        $methods = $reflection->getMethods(
-            ReflectionMethod::IS_PUBLIC + ReflectionMethod::IS_PROTECTED
-        );
-        foreach ($methods as $method) {
-            $doc = $method->getDocComment();
-            $arguments = array();
-            $defaults = array();
-            $metadata = $class_metadata + parse_doc($doc);
-            $params = $method->getParameters();
-            $position = 0;
-            foreach ($params as $param) {
-                $arguments[$param->getName()] = $position;
-                $defaults[$position] = $param->isDefaultValueAvailable() ? 
-                    $param->getDefaultValue() : null;
-                $position++;
-            }
-            $method_flag = $method->isProtected() ? 
-                (isRestlerCompatibilityModeEnabled() ? 2 : 3) : 
-                (isset($metadata['protected']) ? 1 : 0);
-
-            //take note of the order
-            $call = array(
-                'class_name' => $class_name,
-                'method_name' => $method->getName(),
-                'arguments' => $arguments,
-                'defaults' => $defaults,
-                'metadata' => $metadata,
-                'method_flag' => $method_flag
-            );
-            $method_url = strtolower($method->getName());
-            if (preg_match_all(
-                '/@url\s+(GET|POST|PUT|DELETE|HEAD|OPTIONS)[ \t]*\/?(\S*)/s',
-                    $doc, $matches, PREG_SET_ORDER)
-            ) {
-                foreach ($matches as $match) {
-                    $http_method = $match[1];
-                    $url = rtrim($base_path . $match[2], '/');
-                    $this->routes[$http_method][$url] = $call;
-                }
-            } elseif ($method_url[0] != '_') { 
-                //not prefixed with underscore
-                // no configuration found so use convention
-                if (preg_match_all('/^(GET|POST|PUT|DELETE|HEAD|OPTIONS)/i',
-                        $method_url, $matches)
-                ) {
-                    $http_method = strtoupper($matches[0][0]);
-                    $method_url = substr($method_url, strlen($http_method));
-                } else {
-                    $http_method = 'GET';
-                }
-                $url = $base_path
-                    . ($method_url == 'index' || $method_url == 'default' ? '' :
-                        $method_url);
-                $url = rtrim($url, '/');
-                $this->routes[$http_method][$url] = $call;
-                foreach ($params as $param) {
-                    if ($param->getName() == 'request_data') {
-                        break;
-                    }
-                    $url .= $url == '' ? ':' : '/:';
-                    $url .= $param->getName();
-                    $this->routes[$http_method][$url] = $call;
-                }
-            }
-        }
-    }
+	}
+
+
+	/**
+	 * Sets the HTTP response status
+	 * @param int $code response code
+	 */
+	public function setStatus($code)
+	{
+		header("{$_SERVER['SERVER_PROTOCOL']} $code " . 
+			$this->codes[strval($code)]);
+	}
+
+
+	/**
+	 * Compare two strings and remove the common
+	 * sub string from the first string and return it
+	 * @param string $first
+	 * @param string $second
+	 * @param string $char optional, set it as
+	 * blank string for char by char comparison
+	 * @return string
+	 */
+	public function removeCommonPath($first, $second, $char = '/')
+	{
+		$first = explode($char, $first);
+		$second = explode($char, $second);
+		while (count($second)) {
+			if ($first[0] == $second[0]) {
+				array_shift($first);
+			} else {
+				break;
+			}
+			array_shift($second);
+		}
+		return implode($char, $first);
+	}
+
+
+	/**
+	 * Save cache to file
+	 */
+	public function saveCache()
+	{
+		$file = $this->cache_dir . '/routes.php';
+		$s = '$o=array();' . PHP_EOL;
+		foreach ($this->routes as $key => $value) {
+			$s .= PHP_EOL . PHP_EOL . PHP_EOL . 
+				"############### $key ###############" . PHP_EOL . PHP_EOL;
+			$s .= '$o[\'' . $key . '\']=array();';
+			foreach ($value as $ke => $va) {
+				$s .= PHP_EOL . PHP_EOL . "#==== $key $ke" . PHP_EOL . PHP_EOL;
+				$s .= '$o[\'' . $key . '\'][\'' . $ke . '\']=' . str_replace(
+						PHP_EOL, PHP_EOL . "\t", var_export($va, true)
+					) . ';';
+			}
+		}
+		$s .= PHP_EOL . 'return $o;';
+		$r = @file_put_contents($file, "<?php $s");
+		@chmod($file, 0777);
+		if ($r === false) {
+			throw new Exception(
+				"The cache directory located at '$this->cache_dir' needs to "
+				. "have the permissions set to read/write/execute for everyone"
+				. " in order to save cache and improve performance.");
+		}
+	}
+
+	// ==================================================================
+	//
+	// Protected functions
+	//
+	// ------------------------------------------------------------------
+
+
+	/**
+	 * Parses the requst url and get the api path
+	 * @return string api path
+	 */
+	protected function getPath()
+	{
+		$path = urldecode($this->removeCommonPath($_SERVER['REQUEST_URI'],
+				$_SERVER['SCRIPT_NAME']));
+		$path = preg_replace('/(\/*\?.*$)|(\/$)/', '', $path);
+		$path = str_replace($this->format_map['extensions'], '', $path);
+		return $path;
+	}
+
+
+	/**
+	 * Parses the request to figure out the http request type
+	 * @return string which will be one of the following
+	 * [GET, POST, PUT, DELETE]
+	 * @example GET
+	 */
+	protected function getRequestMethod()
+	{
+		$method = $_SERVER['REQUEST_METHOD'];
+		if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {
+			$method = $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'];
+		}
+		//support for HEAD request
+		if ($method == 'HEAD') {
+			$method = 'GET';
+		}
+		return $method;
+	}
+
+
+	/**
+	 * Parses the request to figure out format of the request data
+	 * @return iFormat any class that implements iFormat
+	 * @example JsonFormat
+	 */
+	protected function getRequestFormat()
+	{
+		$format = null;
+		//check if client has sent any information on request format
+		if (isset($_SERVER['CONTENT_TYPE'])) {
+			$mime = explode(';', $_SERVER['CONTENT_TYPE']);
+			$mime = $mime[0];
+			if ($mime == UrlEncodedFormat::MIME) {
+				$format = new UrlEncodedFormat();
+			} else {
+				if (isset($this->format_map[$mime])) {
+					$format = $this->format_map[$mime];
+					$format = is_string($format) ? new $format : $format;
+					$format->setMIME($mime);
+				}
+			}
+		}
+		return $format;
+	}
+
+
+	/**
+	 * Parses the request to figure out the best format for response
+	 * @return iFormat any class that implements iFormat
+	 * @example JsonFormat
+	 */
+	protected function getResponseFormat()
+	{
+		//check if client has specified an extension
+		/**
+		 * @var iFormat
+		 */
+		$format = null;
+		$extensions = explode('.',
+			parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));
+		while ($extensions) {
+			$extension = array_pop($extensions);
+			$extension = explode('/', $extension);
+			$extension = array_shift($extension);
+			if ($extension && isset($this->format_map[$extension])) {
+				$format = $this->format_map[$extension];
+				$format = is_string($format) ? new $format : $format;
+				$format->setExtension($extension);
+				return $format;
+			}
+		}
+		//check if client has sent list of accepted data formats
+		if (isset($_SERVER['HTTP_ACCEPT'])) {
+			$acceptList = array();
+			$accepts = explode(',', strtolower($_SERVER['HTTP_ACCEPT']));
+			if (!is_array($accepts)) {
+				$accepts = array($accepts);
+			}
+			foreach ($accepts as $pos => $accept) {
+				$parts = explode(';q=', trim($accept));
+				$type = array_shift($parts);
+				$quality = count($parts) ? 
+					floatval(array_shift($parts)) : 
+					(1000 - $pos) / 1000;
+				$acceptList[$type] = $quality;
+			}
+			arsort($acceptList);
+			foreach ($acceptList as $accept => $quality) {
+				if (isset($this->format_map[$accept])) {
+					$format = $this->format_map[$accept];
+					$format = is_string($format) ? new $format : $format;
+					$format->setMIME($accept);
+					// Tell cache content is based on Accept header
+					header("Vary: Accept"); 
+					return $format;
+				}
+			}
+		} else {
+			// RFC 2616: If no Accept header field is
+			// present, then it is assumed that the
+			// client accepts all media types.
+			$_SERVER['HTTP_ACCEPT'] = '*/*';
+		}
+		if (strpos($_SERVER['HTTP_ACCEPT'], '*') !== false) {
+			if (strpos($_SERVER['HTTP_ACCEPT'], 'application/*') !== false) {
+				$format = new JsonFormat;
+			} else if (strpos($_SERVER['HTTP_ACCEPT'], 'text/*') !== false) {
+				$format = new XmlFormat;
+			} else if (strpos($_SERVER['HTTP_ACCEPT'], '*/*') !== false) {
+				$format = new $this->format_map['default'];
+			}
+		}
+		if (empty($format)) {
+			// RFC 2616: If an Accept header field is present, and if the 
+			// server cannot send a response which is acceptable according to 
+			// the combined Accept field value, then the server SHOULD send 
+			// a 406 (not acceptable) response.
+			header('HTTP/1.1 406 Not Acceptable');
+			die('406 Not Acceptable: The server was unable to ' . 
+					'negotiate content for this request.');
+		} else {
+			// Tell cache content is based ot Accept header
+			header("Vary: Accept"); 
+			return $format;
+		}
+	}
+
+
+	/**
+	 * Parses the request data and returns it
+	 * @return array php data
+	 */
+	protected function getRequestData()
+	{
+		try {
+			$r = file_get_contents('php://input');
+			if (is_null($r)) {
+				return $_GET;
+			}
+			$r = $this->request_format->decode($r);
+			return is_null($r) ? array() : $r;
+		} catch (RestException $e) {
+			$this->handleError($e->getCode(), $e->getMessage());
+		}
+	}
+
+
+	protected function mapUrlToMethod()
+	{
+		if (!isset($this->routes[$this->request_method])) {
+			return array();
+		}
+		$urls = $this->routes[$this->request_method];
+		if (!$urls) {
+			return array();
+		}
+
+		$found = false;
+		$this->request_data += $_GET;
+		$params = array('request_data' => $this->request_data);
+		$params += $this->request_data;
+		$lc = strtolower($this->url);
+		foreach ($urls as $url => $call) {
+			$call = (object) $call;
+			if (strstr($url, ':')) {
+				$regex = preg_replace('/\\\:([^\/]+)/', '(?P<$1>[^/]+)',
+					preg_quote($url));
+				if (preg_match(":^$regex$:i", $this->url, $matches)) {
+					foreach ($matches as $arg => $match) {
+						if (isset($call->arguments[$arg])) {
+							//flog("$arg => $match $args[$arg]");
+							$params[$arg] = $match;
+						}
+					}
+					$found = true;
+					break;
+				}
+			} else if ($url == $lc) {
+				$found = true;
+				break;
+			}
+		}
+		if ($found) {
+			$p = $call->defaults;
+			foreach ($call->arguments as $key => $value) {
+				if (isset($params[$key])) {
+					$p[$value] = $params[$key];
+				}
+			}
+			$call->arguments = $p;
+			return $call;
+		}
+	}
+
+
+	/**
+	 * Apply static and non-static properties defined in
+	 * the method information anotation
+	 * @param String $class_name
+	 * @param Object $instance instance of that class
+	 * @param Object $method_info method information and metadata
+	 */
+	protected function applyClassMetadata($class_name, $instance, $method_info)
+	{
+		if (isset($method_info->metadata[$class_name])
+			&& is_array($method_info->metadata[$class_name])
+		) {
+			foreach ($method_info->metadata[$class_name] as
+					$property => $value) {
+				if (property_exists($class_name, $property)) {
+					$reflection_property = 
+						new ReflectionProperty($class_name, $property);
+					$reflection_property->setValue($instance, $value);
+				}
+			}
+		}
+	}
+
+
+	protected function loadCache()
+	{
+		if ($this->cached !== null) {
+			return;
+		}
+		$file = $this->cache_dir . '/routes.php';
+		$this->cached = false;
+
+		if ($this->production_mode) {
+			if (file_exists($file)) {
+				$routes = include($file);
+			}
+			if (isset($routes) && is_array($routes)) {
+				$this->routes = $routes;
+				$this->cached = true;
+			}
+		} else {
+			//@unlink($this->cache_dir . "/$name.php");
+		}
+	}
+
+
+	/**
+	 * Generates cachable url to method mapping
+	 * @param string $class_name
+	 * @param string $base_path
+	 */
+	protected function generateMap($class_name, $base_path = '')
+	{
+		$reflection = new ReflectionClass($class_name);
+		$class_metadata = parse_doc($reflection->getDocComment());
+		$methods = $reflection->getMethods(
+			ReflectionMethod::IS_PUBLIC + ReflectionMethod::IS_PROTECTED
+		);
+		foreach ($methods as $method) {
+			$doc = $method->getDocComment();
+			$arguments = array();
+			$defaults = array();
+			$metadata = $class_metadata + parse_doc($doc);
+			$params = $method->getParameters();
+			$position = 0;
+			foreach ($params as $param) {
+				$arguments[$param->getName()] = $position;
+				$defaults[$position] = $param->isDefaultValueAvailable() ? 
+					$param->getDefaultValue() : null;
+				$position++;
+			}
+			$method_flag = $method->isProtected() ? 
+				(isRestlerCompatibilityModeEnabled() ? 2 : 3) : 
+				(isset($metadata['protected']) ? 1 : 0);
+
+			//take note of the order
+			$call = array(
+				'class_name' => $class_name,
+				'method_name' => $method->getName(),
+				'arguments' => $arguments,
+				'defaults' => $defaults,
+				'metadata' => $metadata,
+				'method_flag' => $method_flag
+			);
+			$method_url = strtolower($method->getName());
+			if (preg_match_all(
+				'/@url\s+(GET|POST|PUT|DELETE|HEAD|OPTIONS)[ \t]*\/?(\S*)/s',
+					$doc, $matches, PREG_SET_ORDER)
+			) {
+				foreach ($matches as $match) {
+					$http_method = $match[1];
+					$url = rtrim($base_path . $match[2], '/');
+					$this->routes[$http_method][$url] = $call;
+				}
+			} elseif ($method_url[0] != '_') { 
+				//not prefixed with underscore
+				// no configuration found so use convention
+				if (preg_match_all('/^(GET|POST|PUT|DELETE|HEAD|OPTIONS)/i',
+						$method_url, $matches)
+				) {
+					$http_method = strtoupper($matches[0][0]);
+					$method_url = substr($method_url, strlen($http_method));
+				} else {
+					$http_method = 'GET';
+				}
+				$url = $base_path
+					. ($method_url == 'index' || $method_url == 'default' ? '' :
+						$method_url);
+				$url = rtrim($url, '/');
+				$this->routes[$http_method][$url] = $call;
+				foreach ($params as $param) {
+					if ($param->getName() == 'request_data') {
+						break;
+					}
+					$url .= $url == '' ? ':' : '/:';
+					$url .= $param->getName();
+					$this->routes[$http_method][$url] = $call;
+				}
+			}
+		}
+	}
 
 }
 
 if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-    require_once 'compat.php';
+	require_once 'compat.php';
 }
 
 // ==================================================================
@@ -910,10 +910,10 @@ 
 {
 
 
-    public function __construct($http_status_code, $error_message = null)
-    {
-        parent::__construct($error_message, $http_status_code);
-    }
+	public function __construct($http_status_code, $error_message = null)
+	{
+		parent::__construct($error_message, $http_status_code);
+	}
 
 }
 
@@ -931,21 +931,21 @@ 
 {
 
 
-    /**
-     * Result of an api call is passed to this method
-     * to create a standard structure for the data
-     * @param unknown_type $result can be a primitive or array or object
-     */
-    public function __formatResponse($result);
+	/**
+	 * Result of an api call is passed to this method
+	 * to create a standard structure for the data
+	 * @param unknown_type $result can be a primitive or array or object
+	 */
+	public function __formatResponse($result);
 
 
-    /**
-     * When the api call results in RestException this method
-     * will be called to return the error message
-     * @param int $status_code
-     * @param String $message
-     */
-    public function __formatError($status_code, $message);
+	/**
+	 * When the api call results in RestException this method
+	 * will be called to return the error message
+	 * @param int $status_code
+	 * @param String $message
+	 */
+	public function __formatError($status_code, $message);
 }
 
 /**
@@ -962,21 +962,21 @@ 
 {
 
 
-    public function __formatResponse($result)
-    {
-        return $result;
-    }
+	public function __formatResponse($result)
+	{
+		return $result;
+	}
 
 
-    public function __formatError($statusCode, $message)
-    {
-        return array(
-            'error' => array(
-                'code' => $statusCode,
-                'message' => $message
-            )
-        );
-    }
+	public function __formatError($statusCode, $message)
+	{
+		return array(
+			'error' => array(
+				'code' => $statusCode,
+				'message' => $message
+			)
+		);
+	}
 
 }
 
@@ -994,11 +994,11 @@ 
 {
 
 
-    /**
-     * Auth function that is called when a protected method is requested
-     * @return boolean true or false
-     */
-    public function __isAuthenticated();
+	/**
+	 * Auth function that is called when a protected method is requested
+	 * @return boolean true or false
+	 */
+	public function __isAuthenticated();
 }
 
 /**
@@ -1016,60 +1016,60 @@ 
 {
 
 
-    /**
-     * Get Extension => MIME type mappings as an associative array
-     * @return array list of mime strings for the format
-     * @example array('json'=>'application/json');
-     */
-    public function getMIMEMap();
+	/**
+	 * Get Extension => MIME type mappings as an associative array
+	 * @return array list of mime strings for the format
+	 * @example array('json'=>'application/json');
+	 */
+	public function getMIMEMap();
 
 
-    /**
-     * Set the selected MIME type
-     * @param string $mime MIME type
-     */
-    public function setMIME($mime);
+	/**
+	 * Set the selected MIME type
+	 * @param string $mime MIME type
+	 */
+	public function setMIME($mime);
 
 
-    /**
-     * Get selected MIME type
-     */
-    public function getMIME();
+	/**
+	 * Get selected MIME type
+	 */
+	public function getMIME();
 
 
-    /**
-     * Set the selected file extension
-     * @param string $extension file extension
-     */
-    public function setExtension($extension);
+	/**
+	 * Set the selected file extension
+	 * @param string $extension file extension
+	 */
+	public function setExtension($extension);
 
 
-    /**
-     * Get the selected file extension
-     * @return string file extension
-     */
-    public function getExtension();
+	/**
+	 * Get the selected file extension
+	 * @return string file extension
+	 */
+	public function getExtension();
 
 
-    /**
-     * Encode the given data in the format
-     * @param array $data resulting data that needs to
-     * be encoded in the given format
-     * @param boolean $human_readable set to true when restler
-     * is not running in production mode. Formatter has to
-     * make the encoded output more human readable
-     * @return string encoded string
-     */
-    public function encode($data, $human_readable = false);
+	/**
+	 * Encode the given data in the format
+	 * @param array $data resulting data that needs to
+	 * be encoded in the given format
+	 * @param boolean $human_readable set to true when restler
+	 * is not running in production mode. Formatter has to
+	 * make the encoded output more human readable
+	 * @return string encoded string
+	 */
+	public function encode($data, $human_readable = false);
 
 
-    /**
-     * Decode the given data from the format
-     * @param string $data data sent from client to
-     * the api in the given format.
-     * @return array associative array of the parsed data
-     */
-    public function decode($data);
+	/**
+	 * Decode the given data from the format
+	 * @param string $data data sent from client to
+	 * the api in the given format.
+	 * @return array associative array of the parsed data
+	 */
+	public function decode($data);
 }
 
 /**
@@ -1085,57 +1085,57 @@ 
 class UrlEncodedFormat implements iFormat
 {
 
-    const MIME = 'application/x-www-form-urlencoded';
-    const EXTENSION = 'post';
+	const MIME = 'application/x-www-form-urlencoded';
+	const EXTENSION = 'post';
 
 
-    public function getMIMEMap()
-    {
-        return array(self::EXTENSION => self::MIME);
-    }
+	public function getMIMEMap()
+	{
+		return array(self::EXTENSION => self::MIME);
+	}
 
 
-    public function getMIME()
-    {
-        return self::MIME;
-    }
+	public function getMIME()
+	{
+		return self::MIME;
+	}
 
 
-    public function getExtension()
-    {
-        return self::EXTENSION;
-    }
+	public function getExtension()
+	{
+		return self::EXTENSION;
+	}
 
 
-    public function setMIME($mime)
-    {
-        //do nothing
-    }
+	public function setMIME($mime)
+	{
+		//do nothing
+	}
 
 
-    public function setExtension($extension)
-    {
-        //do nothing
-    }
+	public function setExtension($extension)
+	{
+		//do nothing
+	}
 
 
-    public function encode($data, $human_readable = false)
-    {
-        return http_build_query($data);
-    }
+	public function encode($data, $human_readable = false)
+	{
+		return http_build_query($data);
+	}
 
 
-    public function decode($data)
-    {
-        parse_str($data, $r);
-        return $r;
-    }
+	public function decode($data)
+	{
+		parse_str($data, $r);
+		return $r;
+	}
 
 
-    public function __toString()
-    {
-        return $this->getExtension();
-    }
+	public function __toString()
+	{
+		return $this->getExtension();
+	}
 
 }
 
@@ -1152,158 +1152,158 @@ 
 class JsonFormat implements iFormat
 {
 
-    const MIME = 'application/json,application/javascript';
-
-    static $mime = 'application/json';
-
-    const EXTENSION = 'json';
-
-
-    public function getMIMEMap()
-    {
-        return array(self::EXTENSION => self::MIME);
-    }
-
-
-    public function getMIME()
-    {
-        return self::$mime;
-    }
-
-
-    public function getExtension()
-    {
-        return self::EXTENSION;
-    }
-
-
-    public function setMIME($mime)
-    {
-        self::$mime = $mime;
-    }
-
-
-    public function setExtension($extension)
-    {
-        //do nothing
-    }
-
-
-    public function encode($data, $human_readable = false)
-    {
-        return $human_readable ? 
-            $this->json_format(json_encode(object_to_array($data))) : 
-            json_encode(object_to_array($data));
-    }
-
-
-    public function decode($data)
-    {
-        $decoded = json_decode($data);
-        if (function_exists('json_last_error')) {
-            $message = '';
-            switch (json_last_error()) {
-                case JSON_ERROR_NONE:
-                    return object_to_array($decoded);
-                    break;
-                case JSON_ERROR_DEPTH:
-                    $message = 'maximum stack depth exceeded';
-                    break;
-                case JSON_ERROR_STATE_MISMATCH:
-                    $message = 'underflow or the modes mismatch';
-                    break;
-                case JSON_ERROR_CTRL_CHAR:
-                    $message = 'unexpected control character found';
-                    break;
-                case JSON_ERROR_SYNTAX:
-                    $message = 'malformed JSON';
-                    break;
-                case JSON_ERROR_UTF8:
-                    $message = 'malformed UTF-8 characters, '.
-                        'possibly incorrectly encoded';
-                    break;
-                default:
-                    $message = 'unknown error';
-                    break;
-            }
-            throw new RestException(400, 'Error parsing JSON, ' . $message);
-        } else if (strlen($data) && $decoded === null || $decoded === $data) {
-            throw new RestException(400, 'Error parsing JSON');
-        }
-        return object_to_array($decoded);
-    }
-
-
-    /**
-     * Pretty print JSON string
-     * @param string $json
-     * @return string formated json
-     */
-    private function json_format($json)
-    {
-        $tab = "  ";
-        $new_json = "";
-        $indent_level = 0;
-        $in_string = false;
-        $len = strlen($json);
-
-        for ($c = 0; $c < $len; $c++) {
-            $char = $json[$c];
-            switch ($char) {
-                case '{':
-                case '[':
-                    if (!$in_string) {
-                        $new_json .= $char . "\n" .
-                            str_repeat($tab, $indent_level + 1);
-                        $indent_level++;
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case '}':
-                case ']':
-                    if (!$in_string) {
-                        $indent_level--;
-                        $new_json .= "\n" . str_repeat($tab, $indent_level) 
-                            . $char;
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case ',':
-                    if (!$in_string) {
-                        $new_json .= ",\n" . str_repeat($tab, $indent_level);
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case ':':
-                    if (!$in_string) {
-                        $new_json .= ": ";
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case '"':
-                    if ($c == 0) {
-                        $in_string = true;
-                    } else if ($c > 0 && $json[$c - 1] != '\\') {
-                        $in_string = !$in_string;
-                    }
-                default:
-                    $new_json .= $char;
-                    break;
-            }
-        }
-
-        return $new_json;
-    }
-
-
-    public function __toString()
-    {
-        return $this->getExtension();
-    }
+	const MIME = 'application/json,application/javascript';
+
+	static $mime = 'application/json';
+
+	const EXTENSION = 'json';
+
+
+	public function getMIMEMap()
+	{
+		return array(self::EXTENSION => self::MIME);
+	}
+
+
+	public function getMIME()
+	{
+		return self::$mime;
+	}
+
+
+	public function getExtension()
+	{
+		return self::EXTENSION;
+	}
+
+
+	public function setMIME($mime)
+	{
+		self::$mime = $mime;
+	}
+
+
+	public function setExtension($extension)
+	{
+		//do nothing
+	}
+
+
+	public function encode($data, $human_readable = false)
+	{
+		return $human_readable ? 
+			$this->json_format(json_encode(object_to_array($data))) : 
+			json_encode(object_to_array($data));
+	}
+
+
+	public function decode($data)
+	{
+		$decoded = json_decode($data);
+		if (function_exists('json_last_error')) {
+			$message = '';
+			switch (json_last_error()) {
+				case JSON_ERROR_NONE:
+					return object_to_array($decoded);
+					break;
+				case JSON_ERROR_DEPTH:
+					$message = 'maximum stack depth exceeded';
+					break;
+				case JSON_ERROR_STATE_MISMATCH:
+					$message = 'underflow or the modes mismatch';
+					break;
+				case JSON_ERROR_CTRL_CHAR:
+					$message = 'unexpected control character found';
+					break;
+				case JSON_ERROR_SYNTAX:
+					$message = 'malformed JSON';
+					break;
+				case JSON_ERROR_UTF8:
+					$message = 'malformed UTF-8 characters, '.
+						'possibly incorrectly encoded';
+					break;
+				default:
+					$message = 'unknown error';
+					break;
+			}
+			throw new RestException(400, 'Error parsing JSON, ' . $message);
+		} else if (strlen($data) && $decoded === null || $decoded === $data) {
+			throw new RestException(400, 'Error parsing JSON');
+		}
+		return object_to_array($decoded);
+	}
+
+
+	/**
+	 * Pretty print JSON string
+	 * @param string $json
+	 * @return string formated json
+	 */
+	private function json_format($json)
+	{
+		$tab = "  ";
+		$new_json = "";
+		$indent_level = 0;
+		$in_string = false;
+		$len = strlen($json);
+
+		for ($c = 0; $c < $len; $c++) {
+			$char = $json[$c];
+			switch ($char) {
+				case '{':
+				case '[':
+					if (!$in_string) {
+						$new_json .= $char . "\n" .
+							str_repeat($tab, $indent_level + 1);
+						$indent_level++;
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case '}':
+				case ']':
+					if (!$in_string) {
+						$indent_level--;
+						$new_json .= "\n" . str_repeat($tab, $indent_level) 
+							. $char;
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case ',':
+					if (!$in_string) {
+						$new_json .= ",\n" . str_repeat($tab, $indent_level);
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case ':':
+					if (!$in_string) {
+						$new_json .= ": ";
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case '"':
+					if ($c == 0) {
+						$in_string = true;
+					} else if ($c > 0 && $json[$c - 1] != '\\') {
+						$in_string = !$in_string;
+					}
+				default:
+					$new_json .= $char;
+					break;
+			}
+		}
+
+		return $new_json;
+	}
+
+
+	public function __toString()
+	{
+		return $this->getExtension();
+	}
 
 }
 
@@ -1321,123 +1321,123 @@ 
 class DocParser
 {
 
-    private $params = array();
-
-
-    public function parse($doc = '')
-    {
-        if ($doc == '') {
-            return $this->params;
-        }
-        //Get the comment
-        if (preg_match('#^/\*\*(.*)\*/#s', $doc, $comment) === false) {
-            return $this->params;
-        }
-        $comment = trim($comment[1]);
-        //Get all the lines and strip the * from the first character
-        if (preg_match_all('#^\s*\*(.*)#m', $comment, $lines) === false) {
-            return $this->params;
-        }
-        $this->parseLines($lines[1]);
-        return $this->params;
-    }
-
-
-    private function parseLines($lines)
-    {
-        foreach ($lines as $line) {
-            $parsedLine = $this->parseLine($line); //Parse the line
-
-            if ($parsedLine === false && !isset($this->params['description'])) {
-                if (isset($desc)) {
-                    //Store the first line in the short description
-                    $this->params['description'] = implode(PHP_EOL, $desc);
-                }
-                $desc = array();
-            } else if ($parsedLine !== false) {
-                $desc[] = $parsedLine; //Store the line in the long description
-            }
-        }
-        $desc = implode(' ', $desc);
-        if (!empty($desc)) {
-            $this->params['long_description'] = $desc;
-        }
-    }
-
-
-    private function parseLine($line)
-    {
-        //trim the whitespace from the line
-        $line = trim($line);
-
-        if (empty($line)) {
-            return false; //Empty line
-        }
-
-        if (strpos($line, '@') === 0) {
-            if (strpos($line, ' ') > 0) {
-                //Get the parameter name
-                $param = substr($line, 1, strpos($line, ' ') - 1);
-                $value = substr($line, strlen($param) + 2); //Get the value
-            } else {
-                $param = substr($line, 1);
-                $value = '';
-            }
-            //Parse the line and return false if the parameter is valid
-            if ($this->setParam($param, $value)) {
-                return false;
-            }
-        }
-        return $line;
-    }
-
-
-    private function setParam($param, $value)
-    {
-        if ($param == 'param' || $param == 'return') {
-            $value = $this->formatParamOrReturn($value);
-        }
-        if ($param == 'class') {
-            list($param, $value) = $this->formatClass($value);
-        }
-
-        if (empty($this->params[$param])) {
-            $this->params[$param] = $value;
-        } else if ($param == 'param') {
-            $arr = array($this->params[$param], $value);
-            $this->params[$param] = $arr;
-        } else {
-            $this->params[$param] = $value + $this->params[$param];
-        }
-        return true;
-    }
-
-
-    private function formatClass($value)
-    {
-        $r = preg_split("[\(|\)]", $value);
-        if (count($r) > 1) {
-            $param = $r[0];
-            parse_str($r[1], $value);
-            foreach ($value as $key => $val) {
-                $val = explode(',', $val);
-                if (count($val) > 1) {
-                    $value[$key] = $val;
-                }
-            }
-        } else {
-            $param = 'Unknown';
-        }
-        return array($param, $value);
-    }
-
-
-    private function formatParamOrReturn($string)
-    {
-        $pos = strpos($string, ' ');
-        $type = substr($string, 0, $pos);
-        return '(' . $type . ')' . substr($string, $pos + 1);
-    }
+	private $params = array();
+
+
+	public function parse($doc = '')
+	{
+		if ($doc == '') {
+			return $this->params;
+		}
+		//Get the comment
+		if (preg_match('#^/\*\*(.*)\*/#s', $doc, $comment) === false) {
+			return $this->params;
+		}
+		$comment = trim($comment[1]);
+		//Get all the lines and strip the * from the first character
+		if (preg_match_all('#^\s*\*(.*)#m', $comment, $lines) === false) {
+			return $this->params;
+		}
+		$this->parseLines($lines[1]);
+		return $this->params;
+	}
+
+
+	private function parseLines($lines)
+	{
+		foreach ($lines as $line) {
+			$parsedLine = $this->parseLine($line); //Parse the line
+
+			if ($parsedLine === false && !isset($this->params['description'])) {
+				if (isset($desc)) {
+					//Store the first line in the short description
+					$this->params['description'] = implode(PHP_EOL, $desc);
+				}
+				$desc = array();
+			} else if ($parsedLine !== false) {
+				$desc[] = $parsedLine; //Store the line in the long description
+			}
+		}
+		$desc = implode(' ', $desc);
+		if (!empty($desc)) {
+			$this->params['long_description'] = $desc;
+		}
+	}
+
+
+	private function parseLine($line)
+	{
+		//trim the whitespace from the line
+		$line = trim($line);
+
+		if (empty($line)) {
+			return false; //Empty line
+		}
+
+		if (strpos($line, '@') === 0) {
+			if (strpos($line, ' ') > 0) {
+				//Get the parameter name
+				$param = substr($line, 1, strpos($line, ' ') - 1);
+				$value = substr($line, strlen($param) + 2); //Get the value
+			} else {
+				$param = substr($line, 1);
+				$value = '';
+			}
+			//Parse the line and return false if the parameter is valid
+			if ($this->setParam($param, $value)) {
+				return false;
+			}
+		}
+		return $line;
+	}
+
+
+	private function setParam($param, $value)
+	{
+		if ($param == 'param' || $param == 'return') {
+			$value = $this->formatParamOrReturn($value);
+		}
+		if ($param == 'class') {
+			list($param, $value) = $this->formatClass($value);
+		}
+
+		if (empty($this->params[$param])) {
+			$this->params[$param] = $value;
+		} else if ($param == 'param') {
+			$arr = array($this->params[$param], $value);
+			$this->params[$param] = $arr;
+		} else {
+			$this->params[$param] = $value + $this->params[$param];
+		}
+		return true;
+	}
+
+
+	private function formatClass($value)
+	{
+		$r = preg_split("[\(|\)]", $value);
+		if (count($r) > 1) {
+			$param = $r[0];
+			parse_str($r[1], $value);
+			foreach ($value as $key => $val) {
+				$val = explode(',', $val);
+				if (count($val) > 1) {
+					$value[$key] = $val;
+				}
+			}
+		} else {
+			$param = 'Unknown';
+		}
+		return array($param, $value);
+	}
+
+
+	private function formatParamOrReturn($string)
+	{
+		$pos = strpos($string, ' ');
+		$type = substr($string, 0, $pos);
+		return '(' . $type . ')' . substr($string, $pos + 1);
+	}
 
 }
 
@@ -1450,30 +1450,30 @@ 
 
 function parse_doc($php_doc_comment)
 {
-    $p = new DocParser();
-    return $p->parse($php_doc_comment);
+	$p = new DocParser();
+	return $p->parse($php_doc_comment);
 
-    $p = new Parser($php_doc_comment);
-    return $p;
+	$p = new Parser($php_doc_comment);
+	return $p;
 
-    $php_doc_comment = preg_replace(
-        "/(^[\\s]*\\/\\*\\*)
+	$php_doc_comment = preg_replace(
+		"/(^[\\s]*\\/\\*\\*)
         |(^[\\s]\\*\\/)
         |(^[\\s]*\\*?\\s)
         |(^[\\s]*)
         |(^[\\t]*)/ixm",
-        "", $php_doc_comment);
-    $php_doc_comment = str_replace("\r", "", $php_doc_comment);
-    $php_doc_comment = preg_replace("/([\\t])+/", "\t", $php_doc_comment);
-    return explode("\n", $php_doc_comment);
-
-    $php_doc_comment = trim(preg_replace('/\r?\n *\* */', ' ', 
-            $php_doc_comment));
-    return $php_doc_comment;
-
-    preg_match_all('/@([a-z]+)\s+(.*?)\s*(?=$|@[a-z]+\s)/s', $php_doc_comment,
-        $matches);
-    return array_combine($matches[1], $matches[2]);
+		"", $php_doc_comment);
+	$php_doc_comment = str_replace("\r", "", $php_doc_comment);
+	$php_doc_comment = preg_replace("/([\\t])+/", "\t", $php_doc_comment);
+	return explode("\n", $php_doc_comment);
+
+	$php_doc_comment = trim(preg_replace('/\r?\n *\* */', ' ', 
+			$php_doc_comment));
+	return $php_doc_comment;
+
+	preg_match_all('/@([a-z]+)\s+(.*?)\s*(?=$|@[a-z]+\s)/s', $php_doc_comment,
+		$matches);
+	return array_combine($matches[1], $matches[2]);
 }
 
 
@@ -1492,21 +1492,21 @@ 
  */
 function object_to_array($object, $utf_encode = false)
 {
-    if (is_array($object)
-        || (is_object($object)
-        && !($object instanceof JsonSerializable))
-    ) {
-        $array = array();
-        foreach ($object as $key => $value) {
-            $value = object_to_array($value, $utf_encode);
-            if ($utf_encode && is_string($value)) {
-                $value = utf8_encode($value);
-            }
-            $array[$key] = $value;
-        }
-        return $array;
-    }
-    return $object;
+	if (is_array($object)
+		|| (is_object($object)
+		&& !($object instanceof JsonSerializable))
+	) {
+		$array = array();
+		foreach ($object as $key => $value) {
+			$value = object_to_array($value, $utf_encode);
+			if ($utf_encode && is_string($value)) {
+				$value = utf8_encode($value);
+			}
+			$array[$key] = $value;
+		}
+		return $array;
+	}
+	return $object;
 }
 
 
@@ -1516,21 +1516,21 @@ 
  */
 function autoload_formats($class_name)
 {
-    $class_name = strtolower($class_name);
+	$class_name = strtolower($class_name);
 	
-    $file = RESTLER_PATH . "../../../api/mobile_services/$class_name.php";
-    if (file_exists($file)) {
-        require_once ($file);
-    } else {
+	$file = RESTLER_PATH . "../../../api/mobile_services/$class_name.php";
+	if (file_exists($file)) {
+		require_once ($file);
+	} else {
 		$file = RESTLER_PATH . "/../../api/mobile_services/$class_name.php";
-        if (file_exists($file)) {
-            require_once ($file);
-        } elseif (file_exists(RESTLER_PATH . "/../api/mobile_services/$class_name.php")) {
-            require_once ("/../api/mobile_services/$class_name.php");
-        } elseif (file_exists("$class_name.php")) {
-            require_once ("$class_name.php");
-        }
-    }
+		if (file_exists($file)) {
+			require_once ($file);
+		} elseif (file_exists(RESTLER_PATH . "/../api/mobile_services/$class_name.php")) {
+			require_once ("/../api/mobile_services/$class_name.php");
+		} elseif (file_exists("$class_name.php")) {
+			require_once ("$class_name.php");
+		}
+	}
 }
 
 // ==================================================================
@@ -1547,10 +1547,10 @@ 
 if (!function_exists('isRestlerCompatibilityModeEnabled')) {
 
 
-    function isRestlerCompatibilityModeEnabled()
-    {
-        return false;
-    }
+	function isRestlerCompatibilityModeEnabled()
+	{
+		return false;
+	}
 
 }
 define('RESTLER_PATH', dirname(__FILE__));

libraries/SabreDAV/VObject/Parser/MimeDir.php

Indentation +645 added lines, -645 removed lines

@@ -24,328 +24,328 @@ 
  */
 class MimeDir extends Parser {
 
-    /**
-     * The input stream.
-     *
-     * @var resource
-     */
-    protected $input;
-
-    /**
-     * Root component.
-     *
-     * @var Component
-     */
-    protected $root;
-
-    /**
-     * By default all input will be assumed to be UTF-8.
-     *
-     * However, both iCalendar and vCard might be encoded using different
-     * character sets. The character set is usually set in the mime-type.
-     *
-     * If this is the case, use setEncoding to specify that a different
-     * encoding will be used. If this is set, the parser will automatically
-     * convert all incoming data to UTF-8.
-     *
-     * @var string
-     */
-    protected $charset = 'UTF-8';
-
-    /**
-     * The list of character sets we support when decoding.
-     *
-     * This would be a const expression but for now we need to support PHP 5.5
-     */
-    protected static $SUPPORTED_CHARSETS = [
-        'UTF-8',
-        'ISO-8859-1',
-        'Windows-1252',
-    ];
-
-    /**
-     * Parses an iCalendar or vCard file.
-     *
-     * Pass a stream or a string. If null is parsed, the existing buffer is
-     * used.
-     *
-     * @param string|resource|null $input
-     * @param int $options
-     *
-     * @return Sabre\VObject\Document
-     */
-    public function parse($input = null, $options = 0) {
-
-        $this->root = null;
-
-        if (!is_null($input)) {
-            $this->setInput($input);
-        }
-
-        if (0 !== $options) {
-            $this->options = $options;
-        }
-
-        $this->parseDocument();
-
-        return $this->root;
-
-    }
-
-    /**
-     * By default all input will be assumed to be UTF-8.
-     *
-     * However, both iCalendar and vCard might be encoded using different
-     * character sets. The character set is usually set in the mime-type.
-     *
-     * If this is the case, use setEncoding to specify that a different
-     * encoding will be used. If this is set, the parser will automatically
-     * convert all incoming data to UTF-8.
-     *
-     * @param string $charset
-     */
-    public function setCharset($charset) {
-
-        if (!in_array($charset, self::$SUPPORTED_CHARSETS)) {
-            throw new \InvalidArgumentException('Unsupported encoding. (Supported encodings: ' . implode(', ', self::$SUPPORTED_CHARSETS) . ')');
-        }
-        $this->charset = $charset;
-
-    }
-
-    /**
-     * Sets the input buffer. Must be a string or stream.
-     *
-     * @param resource|string $input
-     *
-     * @return void
-     */
-    public function setInput($input) {
-
-        // Resetting the parser
-        $this->lineIndex = 0;
-        $this->startLine = 0;
-
-        if (is_string($input)) {
-            // Convering to a stream.
-            $stream = fopen('php://temp', 'r+');
-            fwrite($stream, $input);
-            rewind($stream);
-            $this->input = $stream;
-        } elseif (is_resource($input)) {
-            $this->input = $input;
-        } else {
-            throw new \InvalidArgumentException('This parser can only read from strings or streams.');
-        }
-
-    }
-
-    /**
-     * Parses an entire document.
-     *
-     * @return void
-     */
-    protected function parseDocument() {
-
-        $line = $this->readLine();
-
-        // BOM is ZERO WIDTH NO-BREAK SPACE (U+FEFF).
-        // It's 0xEF 0xBB 0xBF in UTF-8 hex.
-        if (3 <= strlen($line)
-            && ord($line[0]) === 0xef
-            && ord($line[1]) === 0xbb
-            && ord($line[2]) === 0xbf) {
-            $line = substr($line, 3);
-        }
-
-        switch (strtoupper($line)) {
-            case 'BEGIN:VCALENDAR' :
-                $class = VCalendar::$componentMap['VCALENDAR'];
-                break;
-            case 'BEGIN:VCARD' :
-                $class = VCard::$componentMap['VCARD'];
-                break;
-            default :
-                throw new ParseException('This parser only supports VCARD and VCALENDAR files');
-        }
-
-        $this->root = new $class([], false);
-
-        while (true) {
-
-            // Reading until we hit END:
-            $line = $this->readLine();
-            if (strtoupper(substr($line, 0, 4)) === 'END:') {
-                break;
-            }
-            $result = $this->parseLine($line);
-            if ($result) {
-                $this->root->add($result);
-            }
-
-        }
-
-        $name = strtoupper(substr($line, 4));
-        if ($name !== $this->root->name) {
-            throw new ParseException('Invalid MimeDir file. expected: "END:' . $this->root->name . '" got: "END:' . $name . '"');
-        }
-
-    }
-
-    /**
-     * Parses a line, and if it hits a component, it will also attempt to parse
-     * the entire component.
-     *
-     * @param string $line Unfolded line
-     *
-     * @return Node
-     */
-    protected function parseLine($line) {
-
-        // Start of a new component
-        if (strtoupper(substr($line, 0, 6)) === 'BEGIN:') {
-
-            $component = $this->root->createComponent(substr($line, 6), [], false);
-
-            while (true) {
-
-                // Reading until we hit END:
-                $line = $this->readLine();
-                if (strtoupper(substr($line, 0, 4)) === 'END:') {
-                    break;
-                }
-                $result = $this->parseLine($line);
-                if ($result) {
-                    $component->add($result);
-                }
-
-            }
-
-            $name = strtoupper(substr($line, 4));
-            if ($name !== $component->name) {
-                throw new ParseException('Invalid MimeDir file. expected: "END:' . $component->name . '" got: "END:' . $name . '"');
-            }
-
-            return $component;
-
-        } else {
-
-            // Property reader
-            $property = $this->readProperty($line);
-            if (!$property) {
-                // Ignored line
-                return false;
-            }
-            return $property;
-
-        }
-
-    }
-
-    /**
-     * We need to look ahead 1 line every time to see if we need to 'unfold'
-     * the next line.
-     *
-     * If that was not the case, we store it here.
-     *
-     * @var null|string
-     */
-    protected $lineBuffer;
-
-    /**
-     * The real current line number.
-     */
-    protected $lineIndex = 0;
-
-    /**
-     * In the case of unfolded lines, this property holds the line number for
-     * the start of the line.
-     *
-     * @var int
-     */
-    protected $startLine = 0;
-
-    /**
-     * Contains a 'raw' representation of the current line.
-     *
-     * @var string
-     */
-    protected $rawLine;
-
-    /**
-     * Reads a single line from the buffer.
-     *
-     * This method strips any newlines and also takes care of unfolding.
-     *
-     * @throws \Sabre\VObject\EofException
-     *
-     * @return string
-     */
-    protected function readLine() {
-
-        if (!is_null($this->lineBuffer)) {
-            $rawLine = $this->lineBuffer;
-            $this->lineBuffer = null;
-        } else {
-            do {
-                $eof = feof($this->input);
-
-                $rawLine = fgets($this->input);
-
-                if ($eof || (feof($this->input) && $rawLine === false)) {
-                    throw new EofException('End of document reached prematurely');
-                }
-                if ($rawLine === false) {
-                    throw new ParseException('Error reading from input stream');
-                }
-                $rawLine = rtrim($rawLine, "\r\n");
-            } while ($rawLine === ''); // Skipping empty lines
-            $this->lineIndex++;
-        }
-        $line = $rawLine;
-
-        $this->startLine = $this->lineIndex;
-
-        // Looking ahead for folded lines.
-        while (true) {
-
-            $nextLine = rtrim(fgets($this->input), "\r\n");
-            $this->lineIndex++;
-            if (!$nextLine) {
-                break;
-            }
-            if ($nextLine[0] === "\t" || $nextLine[0] === " ") {
-                $line .= substr($nextLine, 1);
-                $rawLine .= "\n " . substr($nextLine, 1);
-            } else {
-                $this->lineBuffer = $nextLine;
-                break;
-            }
-
-        }
-        $this->rawLine = $rawLine;
-        return $line;
-
-    }
-
-    /**
-     * Reads a property or component from a line.
-     *
-     * @return void
-     */
-    protected function readProperty($line) {
-
-        if ($this->options & self::OPTION_FORGIVING) {
-            $propNameToken = 'A-Z0-9\-\._\\/';
-        } else {
-            $propNameToken = 'A-Z0-9\-\.';
-        }
-
-        $paramNameToken = 'A-Z0-9\-';
-        $safeChar = '^";:,';
-        $qSafeChar = '^"';
-
-        $regex = "/
+	/**
+	 * The input stream.
+	 *
+	 * @var resource
+	 */
+	protected $input;
+
+	/**
+	 * Root component.
+	 *
+	 * @var Component
+	 */
+	protected $root;
+
+	/**
+	 * By default all input will be assumed to be UTF-8.
+	 *
+	 * However, both iCalendar and vCard might be encoded using different
+	 * character sets. The character set is usually set in the mime-type.
+	 *
+	 * If this is the case, use setEncoding to specify that a different
+	 * encoding will be used. If this is set, the parser will automatically
+	 * convert all incoming data to UTF-8.
+	 *
+	 * @var string
+	 */
+	protected $charset = 'UTF-8';
+
+	/**
+	 * The list of character sets we support when decoding.
+	 *
+	 * This would be a const expression but for now we need to support PHP 5.5
+	 */
+	protected static $SUPPORTED_CHARSETS = [
+		'UTF-8',
+		'ISO-8859-1',
+		'Windows-1252',
+	];
+
+	/**
+	 * Parses an iCalendar or vCard file.
+	 *
+	 * Pass a stream or a string. If null is parsed, the existing buffer is
+	 * used.
+	 *
+	 * @param string|resource|null $input
+	 * @param int $options
+	 *
+	 * @return Sabre\VObject\Document
+	 */
+	public function parse($input = null, $options = 0) {
+
+		$this->root = null;
+
+		if (!is_null($input)) {
+			$this->setInput($input);
+		}
+
+		if (0 !== $options) {
+			$this->options = $options;
+		}
+
+		$this->parseDocument();
+
+		return $this->root;
+
+	}
+
+	/**
+	 * By default all input will be assumed to be UTF-8.
+	 *
+	 * However, both iCalendar and vCard might be encoded using different
+	 * character sets. The character set is usually set in the mime-type.
+	 *
+	 * If this is the case, use setEncoding to specify that a different
+	 * encoding will be used. If this is set, the parser will automatically
+	 * convert all incoming data to UTF-8.
+	 *
+	 * @param string $charset
+	 */
+	public function setCharset($charset) {
+
+		if (!in_array($charset, self::$SUPPORTED_CHARSETS)) {
+			throw new \InvalidArgumentException('Unsupported encoding. (Supported encodings: ' . implode(', ', self::$SUPPORTED_CHARSETS) . ')');
+		}
+		$this->charset = $charset;
+
+	}
+
+	/**
+	 * Sets the input buffer. Must be a string or stream.
+	 *
+	 * @param resource|string $input
+	 *
+	 * @return void
+	 */
+	public function setInput($input) {
+
+		// Resetting the parser
+		$this->lineIndex = 0;
+		$this->startLine = 0;
+
+		if (is_string($input)) {
+			// Convering to a stream.
+			$stream = fopen('php://temp', 'r+');
+			fwrite($stream, $input);
+			rewind($stream);
+			$this->input = $stream;
+		} elseif (is_resource($input)) {
+			$this->input = $input;
+		} else {
+			throw new \InvalidArgumentException('This parser can only read from strings or streams.');
+		}
+
+	}
+
+	/**
+	 * Parses an entire document.
+	 *
+	 * @return void
+	 */
+	protected function parseDocument() {
+
+		$line = $this->readLine();
+
+		// BOM is ZERO WIDTH NO-BREAK SPACE (U+FEFF).
+		// It's 0xEF 0xBB 0xBF in UTF-8 hex.
+		if (3 <= strlen($line)
+			&& ord($line[0]) === 0xef
+			&& ord($line[1]) === 0xbb
+			&& ord($line[2]) === 0xbf) {
+			$line = substr($line, 3);
+		}
+
+		switch (strtoupper($line)) {
+			case 'BEGIN:VCALENDAR' :
+				$class = VCalendar::$componentMap['VCALENDAR'];
+				break;
+			case 'BEGIN:VCARD' :
+				$class = VCard::$componentMap['VCARD'];
+				break;
+			default :
+				throw new ParseException('This parser only supports VCARD and VCALENDAR files');
+		}
+
+		$this->root = new $class([], false);
+
+		while (true) {
+
+			// Reading until we hit END:
+			$line = $this->readLine();
+			if (strtoupper(substr($line, 0, 4)) === 'END:') {
+				break;
+			}
+			$result = $this->parseLine($line);
+			if ($result) {
+				$this->root->add($result);
+			}
+
+		}
+
+		$name = strtoupper(substr($line, 4));
+		if ($name !== $this->root->name) {
+			throw new ParseException('Invalid MimeDir file. expected: "END:' . $this->root->name . '" got: "END:' . $name . '"');
+		}
+
+	}
+
+	/**
+	 * Parses a line, and if it hits a component, it will also attempt to parse
+	 * the entire component.
+	 *
+	 * @param string $line Unfolded line
+	 *
+	 * @return Node
+	 */
+	protected function parseLine($line) {
+
+		// Start of a new component
+		if (strtoupper(substr($line, 0, 6)) === 'BEGIN:') {
+
+			$component = $this->root->createComponent(substr($line, 6), [], false);
+
+			while (true) {
+
+				// Reading until we hit END:
+				$line = $this->readLine();
+				if (strtoupper(substr($line, 0, 4)) === 'END:') {
+					break;
+				}
+				$result = $this->parseLine($line);
+				if ($result) {
+					$component->add($result);
+				}
+
+			}
+
+			$name = strtoupper(substr($line, 4));
+			if ($name !== $component->name) {
+				throw new ParseException('Invalid MimeDir file. expected: "END:' . $component->name . '" got: "END:' . $name . '"');
+			}
+
+			return $component;
+
+		} else {
+
+			// Property reader
+			$property = $this->readProperty($line);
+			if (!$property) {
+				// Ignored line
+				return false;
+			}
+			return $property;
+
+		}
+
+	}
+
+	/**
+	 * We need to look ahead 1 line every time to see if we need to 'unfold'
+	 * the next line.
+	 *
+	 * If that was not the case, we store it here.
+	 *
+	 * @var null|string
+	 */
+	protected $lineBuffer;
+
+	/**
+	 * The real current line number.
+	 */
+	protected $lineIndex = 0;
+
+	/**
+	 * In the case of unfolded lines, this property holds the line number for
+	 * the start of the line.
+	 *
+	 * @var int
+	 */
+	protected $startLine = 0;
+
+	/**
+	 * Contains a 'raw' representation of the current line.
+	 *
+	 * @var string
+	 */
+	protected $rawLine;
+
+	/**
+	 * Reads a single line from the buffer.
+	 *
+	 * This method strips any newlines and also takes care of unfolding.
+	 *
+	 * @throws \Sabre\VObject\EofException
+	 *
+	 * @return string
+	 */
+	protected function readLine() {
+
+		if (!is_null($this->lineBuffer)) {
+			$rawLine = $this->lineBuffer;
+			$this->lineBuffer = null;
+		} else {
+			do {
+				$eof = feof($this->input);
+
+				$rawLine = fgets($this->input);
+
+				if ($eof || (feof($this->input) && $rawLine === false)) {
+					throw new EofException('End of document reached prematurely');
+				}
+				if ($rawLine === false) {
+					throw new ParseException('Error reading from input stream');
+				}
+				$rawLine = rtrim($rawLine, "\r\n");
+			} while ($rawLine === ''); // Skipping empty lines
+			$this->lineIndex++;
+		}
+		$line = $rawLine;
+
+		$this->startLine = $this->lineIndex;
+
+		// Looking ahead for folded lines.
+		while (true) {
+
+			$nextLine = rtrim(fgets($this->input), "\r\n");
+			$this->lineIndex++;
+			if (!$nextLine) {
+				break;
+			}
+			if ($nextLine[0] === "\t" || $nextLine[0] === " ") {
+				$line .= substr($nextLine, 1);
+				$rawLine .= "\n " . substr($nextLine, 1);
+			} else {
+				$this->lineBuffer = $nextLine;
+				break;
+			}
+
+		}
+		$this->rawLine = $rawLine;
+		return $line;
+
+	}
+
+	/**
+	 * Reads a property or component from a line.
+	 *
+	 * @return void
+	 */
+	protected function readProperty($line) {
+
+		if ($this->options & self::OPTION_FORGIVING) {
+			$propNameToken = 'A-Z0-9\-\._\\/';
+		} else {
+			$propNameToken = 'A-Z0-9\-\.';
+		}
+
+		$paramNameToken = 'A-Z0-9\-';
+		$safeChar = '^";:,';
+		$qSafeChar = '^"';
+
+		$regex = "/
             ^(?P<name> [$propNameToken]+ ) (?=[;:])        # property name
             |
             (?<=:)(?P<propValue> .+)$                      # property value
@@ -358,338 +358,338 @@ 
             ) (?=[;:,])
             /xi";
 
-        preg_match_all($regex, $line, $matches,  PREG_SET_ORDER);
-
-        $property = [
-            'name'       => null,
-            'parameters' => [],
-            'value'      => null
-        ];
-
-        $lastParam = null;
-
-        /**
-         * Looping through all the tokens.
-         *
-         * Note that we are looping through them in reverse order, because if a
-         * sub-pattern matched, the subsequent named patterns will not show up
-         * in the result.
-         */
-        foreach ($matches as $match) {
-
-            if (isset($match['paramValue'])) {
-                if ($match['paramValue'] && $match['paramValue'][0] === '"') {
-                    $value = substr($match['paramValue'], 1, -1);
-                } else {
-                    $value = $match['paramValue'];
-                }
-
-                $value = $this->unescapeParam($value);
-
-                if (is_null($lastParam)) {
-                    throw new ParseException('Invalid Mimedir file. Line starting at ' . $this->startLine . ' did not follow iCalendar/vCard conventions');
-                }
-                if (is_null($property['parameters'][$lastParam])) {
-                    $property['parameters'][$lastParam] = $value;
-                } elseif (is_array($property['parameters'][$lastParam])) {
-                    $property['parameters'][$lastParam][] = $value;
-                } else {
-                    $property['parameters'][$lastParam] = [
-                        $property['parameters'][$lastParam],
-                        $value
-                    ];
-                }
-                continue;
-            }
-            if (isset($match['paramName'])) {
-                $lastParam = strtoupper($match['paramName']);
-                if (!isset($property['parameters'][$lastParam])) {
-                    $property['parameters'][$lastParam] = null;
-                }
-                continue;
-            }
-            if (isset($match['propValue'])) {
-                $property['value'] = $match['propValue'];
-                continue;
-            }
-            if (isset($match['name']) && $match['name']) {
-                $property['name'] = strtoupper($match['name']);
-                continue;
-            }
-
-            // @codeCoverageIgnoreStart
-            throw new \LogicException('This code should not be reachable');
-            // @codeCoverageIgnoreEnd
-
-        }
-
-        if (is_null($property['value'])) {
-            $property['value'] = '';
-        }
-        if (!$property['name']) {
-            if ($this->options & self::OPTION_IGNORE_INVALID_LINES) {
-                return false;
-            }
-            throw new ParseException('Invalid Mimedir file. Line starting at ' . $this->startLine . ' did not follow iCalendar/vCard conventions');
-        }
-
-        // vCard 2.1 states that parameters may appear without a name, and only
-        // a value. We can deduce the value based on it's name.
-        //
-        // Our parser will get those as parameters without a value instead, so
-        // we're filtering these parameters out first.
-        $namedParameters = [];
-        $namelessParameters = [];
-
-        foreach ($property['parameters'] as $name => $value) {
-            if (!is_null($value)) {
-                $namedParameters[$name] = $value;
-            } else {
-                $namelessParameters[] = $name;
-            }
-        }
-
-        $propObj = $this->root->createProperty($property['name'], null, $namedParameters);
-
-        foreach ($namelessParameters as $namelessParameter) {
-            $propObj->add(null, $namelessParameter);
-        }
-
-        if (strtoupper($propObj['ENCODING']) === 'QUOTED-PRINTABLE') {
-            $propObj->setQuotedPrintableValue($this->extractQuotedPrintableValue());
-        } else {
-            $charset = $this->charset;
-            if ($this->root->getDocumentType() === Document::VCARD21 && isset($propObj['CHARSET'])) {
-                // vCard 2.1 allows the character set to be specified per property.
-                $charset = (string)$propObj['CHARSET'];
-            }
-            switch ($charset) {
-                case 'UTF-8' :
-                    break;
-                case 'ISO-8859-1' :
-                    $property['value'] = utf8_encode($property['value']);
-                    break;
-                case 'Windows-1252' :
-                    $property['value'] = mb_convert_encoding($property['value'], 'UTF-8', $charset);
-                    break;
-                default :
-                    throw new ParseException('Unsupported CHARSET: ' . $propObj['CHARSET']);
-            }
-            $propObj->setRawMimeDirValue($property['value']);
-        }
-
-        return $propObj;
-
-    }
-
-    /**
-     * Unescapes a property value.
-     *
-     * vCard 2.1 says:
-     *   * Semi-colons must be escaped in some property values, specifically
-     *     ADR, ORG and N.
-     *   * Semi-colons must be escaped in parameter values, because semi-colons
-     *     are also use to separate values.
-     *   * No mention of escaping backslashes with another backslash.
-     *   * newlines are not escaped either, instead QUOTED-PRINTABLE is used to
-     *     span values over more than 1 line.
-     *
-     * vCard 3.0 says:
-     *   * (rfc2425) Backslashes, newlines (\n or \N) and comma's must be
-     *     escaped, all time time.
-     *   * Comma's are used for delimeters in multiple values
-     *   * (rfc2426) Adds to to this that the semi-colon MUST also be escaped,
-     *     as in some properties semi-colon is used for separators.
-     *   * Properties using semi-colons: N, ADR, GEO, ORG
-     *   * Both ADR and N's individual parts may be broken up further with a
-     *     comma.
-     *   * Properties using commas: NICKNAME, CATEGORIES
-     *
-     * vCard 4.0 (rfc6350) says:
-     *   * Commas must be escaped.
-     *   * Semi-colons may be escaped, an unescaped semi-colon _may_ be a
-     *     delimiter, depending on the property.
-     *   * Backslashes must be escaped
-     *   * Newlines must be escaped as either \N or \n.
-     *   * Some compound properties may contain multiple parts themselves, so a
-     *     comma within a semi-colon delimited property may also be unescaped
-     *     to denote multiple parts _within_ the compound property.
-     *   * Text-properties using semi-colons: N, ADR, ORG, CLIENTPIDMAP.
-     *   * Text-properties using commas: NICKNAME, RELATED, CATEGORIES, PID.
-     *
-     * Even though the spec says that commas must always be escaped, the
-     * example for GEO in Section 6.5.2 seems to violate this.
-     *
-     * iCalendar 2.0 (rfc5545) says:
-     *   * Commas or semi-colons may be used as delimiters, depending on the
-     *     property.
-     *   * Commas, semi-colons, backslashes, newline (\N or \n) are always
-     *     escaped, unless they are delimiters.
-     *   * Colons shall not be escaped.
-     *   * Commas can be considered the 'default delimiter' and is described as
-     *     the delimiter in cases where the order of the multiple values is
-     *     insignificant.
-     *   * Semi-colons are described as the delimiter for 'structured values'.
-     *     They are specifically used in Semi-colons are used as a delimiter in
-     *     REQUEST-STATUS, RRULE, GEO and EXRULE. EXRULE is deprecated however.
-     *
-     * Now for the parameters
-     *
-     * If delimiter is not set (null) this method will just return a string.
-     * If it's a comma or a semi-colon the string will be split on those
-     * characters, and always return an array.
-     *
-     * @param string $input
-     * @param string $delimiter
-     *
-     * @return string|string[]
-     */
-    static function unescapeValue($input, $delimiter = ';') {
-
-        $regex = '#  (?: (\\\\ (?: \\\\ | N | n | ; | , ) )';
-        if ($delimiter) {
-            $regex .= ' | (' . $delimiter . ')';
-        }
-        $regex .= ') #x';
-
-        $matches = preg_split($regex, $input, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
-
-        $resultArray = [];
-        $result = '';
-
-        foreach ($matches as $match) {
-
-            switch ($match) {
-                case '\\\\' :
-                    $result .= '\\';
-                    break;
-                case '\N' :
-                case '\n' :
-                    $result .= "\n";
-                    break;
-                case '\;' :
-                    $result .= ';';
-                    break;
-                case '\,' :
-                    $result .= ',';
-                    break;
-                case $delimiter :
-                    $resultArray[] = $result;
-                    $result = '';
-                    break;
-                default :
-                    $result .= $match;
-                    break;
-
-            }
-
-        }
-
-        $resultArray[] = $result;
-        return $delimiter ? $resultArray : $result;
-
-    }
-
-    /**
-     * Unescapes a parameter value.
-     *
-     * vCard 2.1:
-     *   * Does not mention a mechanism for this. In addition, double quotes
-     *     are never used to wrap values.
-     *   * This means that parameters can simply not contain colons or
-     *     semi-colons.
-     *
-     * vCard 3.0 (rfc2425, rfc2426):
-     *   * Parameters _may_ be surrounded by double quotes.
-     *   * If this is not the case, semi-colon, colon and comma may simply not
-     *     occur (the comma used for multiple parameter values though).
-     *   * If it is surrounded by double-quotes, it may simply not contain
-     *     double-quotes.
-     *   * This means that a parameter can in no case encode double-quotes, or
-     *     newlines.
-     *
-     * vCard 4.0 (rfc6350)
-     *   * Behavior seems to be identical to vCard 3.0
-     *
-     * iCalendar 2.0 (rfc5545)
-     *   * Behavior seems to be identical to vCard 3.0
-     *
-     * Parameter escaping mechanism (rfc6868) :
-     *   * This rfc describes a new way to escape parameter values.
-     *   * New-line is encoded as ^n
-     *   * ^ is encoded as ^^.
-     *   * " is encoded as ^'
-     *
-     * @param string $input
-     *
-     * @return void
-     */
-    private function unescapeParam($input) {
-
-        return
-            preg_replace_callback(
-                '#(\^(\^|n|\'))#',
-                function($matches) {
-                    switch ($matches[2]) {
-                        case 'n' :
-                            return "\n";
-                        case '^' :
-                            return '^';
-                        case '\'' :
-                            return '"';
-
-                    // @codeCoverageIgnoreStart
-                    }
-                    // @codeCoverageIgnoreEnd
-                },
-                $input
-            );
-    }
-
-    /**
-     * Gets the full quoted printable value.
-     *
-     * We need a special method for this, because newlines have both a meaning
-     * in vCards, and in QuotedPrintable.
-     *
-     * This method does not do any decoding.
-     *
-     * @return string
-     */
-    private function extractQuotedPrintableValue() {
-
-        // We need to parse the raw line again to get the start of the value.
-        //
-        // We are basically looking for the first colon (:), but we need to
-        // skip over the parameters first, as they may contain one.
-        $regex = '/^
+		preg_match_all($regex, $line, $matches,  PREG_SET_ORDER);
+
+		$property = [
+			'name'       => null,
+			'parameters' => [],
+			'value'      => null
+		];
+
+		$lastParam = null;
+
+		/**
+		 * Looping through all the tokens.
+		 *
+		 * Note that we are looping through them in reverse order, because if a
+		 * sub-pattern matched, the subsequent named patterns will not show up
+		 * in the result.
+		 */
+		foreach ($matches as $match) {
+
+			if (isset($match['paramValue'])) {
+				if ($match['paramValue'] && $match['paramValue'][0] === '"') {
+					$value = substr($match['paramValue'], 1, -1);
+				} else {
+					$value = $match['paramValue'];
+				}
+
+				$value = $this->unescapeParam($value);
+
+				if (is_null($lastParam)) {
+					throw new ParseException('Invalid Mimedir file. Line starting at ' . $this->startLine . ' did not follow iCalendar/vCard conventions');
+				}
+				if (is_null($property['parameters'][$lastParam])) {
+					$property['parameters'][$lastParam] = $value;
+				} elseif (is_array($property['parameters'][$lastParam])) {
+					$property['parameters'][$lastParam][] = $value;
+				} else {
+					$property['parameters'][$lastParam] = [
+						$property['parameters'][$lastParam],
+						$value
+					];
+				}
+				continue;
+			}
+			if (isset($match['paramName'])) {
+				$lastParam = strtoupper($match['paramName']);
+				if (!isset($property['parameters'][$lastParam])) {
+					$property['parameters'][$lastParam] = null;
+				}
+				continue;
+			}
+			if (isset($match['propValue'])) {
+				$property['value'] = $match['propValue'];
+				continue;
+			}
+			if (isset($match['name']) && $match['name']) {
+				$property['name'] = strtoupper($match['name']);
+				continue;
+			}
+
+			// @codeCoverageIgnoreStart
+			throw new \LogicException('This code should not be reachable');
+			// @codeCoverageIgnoreEnd
+
+		}
+
+		if (is_null($property['value'])) {
+			$property['value'] = '';
+		}
+		if (!$property['name']) {
+			if ($this->options & self::OPTION_IGNORE_INVALID_LINES) {
+				return false;
+			}
+			throw new ParseException('Invalid Mimedir file. Line starting at ' . $this->startLine . ' did not follow iCalendar/vCard conventions');
+		}
+
+		// vCard 2.1 states that parameters may appear without a name, and only
+		// a value. We can deduce the value based on it's name.
+		//
+		// Our parser will get those as parameters without a value instead, so
+		// we're filtering these parameters out first.
+		$namedParameters = [];
+		$namelessParameters = [];
+
+		foreach ($property['parameters'] as $name => $value) {
+			if (!is_null($value)) {
+				$namedParameters[$name] = $value;
+			} else {
+				$namelessParameters[] = $name;
+			}
+		}
+
+		$propObj = $this->root->createProperty($property['name'], null, $namedParameters);
+
+		foreach ($namelessParameters as $namelessParameter) {
+			$propObj->add(null, $namelessParameter);
+		}
+
+		if (strtoupper($propObj['ENCODING']) === 'QUOTED-PRINTABLE') {
+			$propObj->setQuotedPrintableValue($this->extractQuotedPrintableValue());
+		} else {
+			$charset = $this->charset;
+			if ($this->root->getDocumentType() === Document::VCARD21 && isset($propObj['CHARSET'])) {
+				// vCard 2.1 allows the character set to be specified per property.
+				$charset = (string)$propObj['CHARSET'];
+			}
+			switch ($charset) {
+				case 'UTF-8' :
+					break;
+				case 'ISO-8859-1' :
+					$property['value'] = utf8_encode($property['value']);
+					break;
+				case 'Windows-1252' :
+					$property['value'] = mb_convert_encoding($property['value'], 'UTF-8', $charset);
+					break;
+				default :
+					throw new ParseException('Unsupported CHARSET: ' . $propObj['CHARSET']);
+			}
+			$propObj->setRawMimeDirValue($property['value']);
+		}
+
+		return $propObj;
+
+	}
+
+	/**
+	 * Unescapes a property value.
+	 *
+	 * vCard 2.1 says:
+	 *   * Semi-colons must be escaped in some property values, specifically
+	 *     ADR, ORG and N.
+	 *   * Semi-colons must be escaped in parameter values, because semi-colons
+	 *     are also use to separate values.
+	 *   * No mention of escaping backslashes with another backslash.
+	 *   * newlines are not escaped either, instead QUOTED-PRINTABLE is used to
+	 *     span values over more than 1 line.
+	 *
+	 * vCard 3.0 says:
+	 *   * (rfc2425) Backslashes, newlines (\n or \N) and comma's must be
+	 *     escaped, all time time.
+	 *   * Comma's are used for delimeters in multiple values
+	 *   * (rfc2426) Adds to to this that the semi-colon MUST also be escaped,
+	 *     as in some properties semi-colon is used for separators.
+	 *   * Properties using semi-colons: N, ADR, GEO, ORG
+	 *   * Both ADR and N's individual parts may be broken up further with a
+	 *     comma.
+	 *   * Properties using commas: NICKNAME, CATEGORIES
+	 *
+	 * vCard 4.0 (rfc6350) says:
+	 *   * Commas must be escaped.
+	 *   * Semi-colons may be escaped, an unescaped semi-colon _may_ be a
+	 *     delimiter, depending on the property.
+	 *   * Backslashes must be escaped
+	 *   * Newlines must be escaped as either \N or \n.
+	 *   * Some compound properties may contain multiple parts themselves, so a
+	 *     comma within a semi-colon delimited property may also be unescaped
+	 *     to denote multiple parts _within_ the compound property.
+	 *   * Text-properties using semi-colons: N, ADR, ORG, CLIENTPIDMAP.
+	 *   * Text-properties using commas: NICKNAME, RELATED, CATEGORIES, PID.
+	 *
+	 * Even though the spec says that commas must always be escaped, the
+	 * example for GEO in Section 6.5.2 seems to violate this.
+	 *
+	 * iCalendar 2.0 (rfc5545) says:
+	 *   * Commas or semi-colons may be used as delimiters, depending on the
+	 *     property.
+	 *   * Commas, semi-colons, backslashes, newline (\N or \n) are always
+	 *     escaped, unless they are delimiters.
+	 *   * Colons shall not be escaped.
+	 *   * Commas can be considered the 'default delimiter' and is described as
+	 *     the delimiter in cases where the order of the multiple values is
+	 *     insignificant.
+	 *   * Semi-colons are described as the delimiter for 'structured values'.
+	 *     They are specifically used in Semi-colons are used as a delimiter in
+	 *     REQUEST-STATUS, RRULE, GEO and EXRULE. EXRULE is deprecated however.
+	 *
+	 * Now for the parameters
+	 *
+	 * If delimiter is not set (null) this method will just return a string.
+	 * If it's a comma or a semi-colon the string will be split on those
+	 * characters, and always return an array.
+	 *
+	 * @param string $input
+	 * @param string $delimiter
+	 *
+	 * @return string|string[]
+	 */
+	static function unescapeValue($input, $delimiter = ';') {
+
+		$regex = '#  (?: (\\\\ (?: \\\\ | N | n | ; | , ) )';
+		if ($delimiter) {
+			$regex .= ' | (' . $delimiter . ')';
+		}
+		$regex .= ') #x';
+
+		$matches = preg_split($regex, $input, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
+
+		$resultArray = [];
+		$result = '';
+
+		foreach ($matches as $match) {
+
+			switch ($match) {
+				case '\\\\' :
+					$result .= '\\';
+					break;
+				case '\N' :
+				case '\n' :
+					$result .= "\n";
+					break;
+				case '\;' :
+					$result .= ';';
+					break;
+				case '\,' :
+					$result .= ',';
+					break;
+				case $delimiter :
+					$resultArray[] = $result;
+					$result = '';
+					break;
+				default :
+					$result .= $match;
+					break;
+
+			}
+
+		}
+
+		$resultArray[] = $result;
+		return $delimiter ? $resultArray : $result;
+
+	}
+
+	/**
+	 * Unescapes a parameter value.
+	 *
+	 * vCard 2.1:
+	 *   * Does not mention a mechanism for this. In addition, double quotes
+	 *     are never used to wrap values.
+	 *   * This means that parameters can simply not contain colons or
+	 *     semi-colons.
+	 *
+	 * vCard 3.0 (rfc2425, rfc2426):
+	 *   * Parameters _may_ be surrounded by double quotes.
+	 *   * If this is not the case, semi-colon, colon and comma may simply not
+	 *     occur (the comma used for multiple parameter values though).
+	 *   * If it is surrounded by double-quotes, it may simply not contain
+	 *     double-quotes.
+	 *   * This means that a parameter can in no case encode double-quotes, or
+	 *     newlines.
+	 *
+	 * vCard 4.0 (rfc6350)
+	 *   * Behavior seems to be identical to vCard 3.0
+	 *
+	 * iCalendar 2.0 (rfc5545)
+	 *   * Behavior seems to be identical to vCard 3.0
+	 *
+	 * Parameter escaping mechanism (rfc6868) :
+	 *   * This rfc describes a new way to escape parameter values.
+	 *   * New-line is encoded as ^n
+	 *   * ^ is encoded as ^^.
+	 *   * " is encoded as ^'
+	 *
+	 * @param string $input
+	 *
+	 * @return void
+	 */
+	private function unescapeParam($input) {
+
+		return
+			preg_replace_callback(
+				'#(\^(\^|n|\'))#',
+				function($matches) {
+					switch ($matches[2]) {
+						case 'n' :
+							return "\n";
+						case '^' :
+							return '^';
+						case '\'' :
+							return '"';
+
+					// @codeCoverageIgnoreStart
+					}
+					// @codeCoverageIgnoreEnd
+				},
+				$input
+			);
+	}
+
+	/**
+	 * Gets the full quoted printable value.
+	 *
+	 * We need a special method for this, because newlines have both a meaning
+	 * in vCards, and in QuotedPrintable.
+	 *
+	 * This method does not do any decoding.
+	 *
+	 * @return string
+	 */
+	private function extractQuotedPrintableValue() {
+
+		// We need to parse the raw line again to get the start of the value.
+		//
+		// We are basically looking for the first colon (:), but we need to
+		// skip over the parameters first, as they may contain one.
+		$regex = '/^
             (?: [^:])+ # Anything but a colon
             (?: "[^"]")* # A parameter in double quotes
             : # start of the value we really care about
             (.*)$
         /xs';
 
-        preg_match($regex, $this->rawLine, $matches);
+		preg_match($regex, $this->rawLine, $matches);
 
-        $value = $matches[1];
-        // Removing the first whitespace character from every line. Kind of
-        // like unfolding, but we keep the newline.
-        $value = str_replace("\n ", "\n", $value);
+		$value = $matches[1];
+		// Removing the first whitespace character from every line. Kind of
+		// like unfolding, but we keep the newline.
+		$value = str_replace("\n ", "\n", $value);
 
-        // Microsoft products don't always correctly fold lines, they may be
-        // missing a whitespace. So if 'forgiving' is turned on, we will take
-        // those as well.
-        if ($this->options & self::OPTION_FORGIVING) {
-            while (substr($value, -1) === '=') {
-                // Reading the line
-                $this->readLine();
-                // Grabbing the raw form
-                $value .= "\n" . $this->rawLine;
-            }
-        }
+		// Microsoft products don't always correctly fold lines, they may be
+		// missing a whitespace. So if 'forgiving' is turned on, we will take
+		// those as well.
+		if ($this->options & self::OPTION_FORGIVING) {
+			while (substr($value, -1) === '=') {
+				// Reading the line
+				$this->readLine();
+				// Grabbing the raw form
+				$value .= "\n" . $this->rawLine;
+			}
+		}
 
-        return $value;
+		return $value;
 
-    }
+	}
 
 }

libraries/htmlpurifier/library/HTMLPurifier/UnitConverter.php

Indentation +295 added lines, -295 removed lines

@@ -7,301 +7,301 @@
 class HTMLPurifier_UnitConverter
 {
 
-    const ENGLISH = 1;
-    const METRIC = 2;
-    const DIGITAL = 3;
-
-    /**
-     * Units information array. Units are grouped into measuring systems
-     * (English, Metric), and are assigned an integer representing
-     * the conversion factor between that unit and the smallest unit in
-     * the system. Numeric indexes are actually magical constants that
-     * encode conversion data from one system to the next, with a O(n^2)
-     * constraint on memory (this is generally not a problem, since
-     * the number of measuring systems is small.)
-     */
-    protected static $units = array(
-        self::ENGLISH => array(
-            'px' => 3, // This is as per CSS 2.1 and Firefox. Your mileage may vary
-            'pt' => 4,
-            'pc' => 48,
-            'in' => 288,
-            self::METRIC => array('pt', '0.352777778', 'mm'),
-        ),
-        self::METRIC => array(
-            'mm' => 1,
-            'cm' => 10,
-            self::ENGLISH => array('mm', '2.83464567', 'pt'),
-        ),
-    );
-
-    /**
-     * Minimum bcmath precision for output.
-     * @type int
-     */
-    protected $outputPrecision;
-
-    /**
-     * Bcmath precision for internal calculations.
-     * @type int
-     */
-    protected $internalPrecision;
-
-    /**
-     * Whether or not BCMath is available.
-     * @type bool
-     */
-    private $bcmath;
-
-    public function __construct($output_precision = 4, $internal_precision = 10, $force_no_bcmath = false)
-    {
-        $this->outputPrecision = $output_precision;
-        $this->internalPrecision = $internal_precision;
-        $this->bcmath = !$force_no_bcmath && function_exists('bcmul');
-    }
-
-    /**
-     * Converts a length object of one unit into another unit.
-     * @param HTMLPurifier_Length $length
-     *      Instance of HTMLPurifier_Length to convert. You must validate()
-     *      it before passing it here!
-     * @param string $to_unit
-     *      Unit to convert to.
-     * @return HTMLPurifier_Length|bool
-     * @note
-     *      About precision: This conversion function pays very special
-     *      attention to the incoming precision of values and attempts
-     *      to maintain a number of significant figure. Results are
-     *      fairly accurate up to nine digits. Some caveats:
-     *          - If a number is zero-padded as a result of this significant
-     *            figure tracking, the zeroes will be eliminated.
-     *          - If a number contains less than four sigfigs ($outputPrecision)
-     *            and this causes some decimals to be excluded, those
-     *            decimals will be added on.
-     */
-    public function convert($length, $to_unit)
-    {
-        if (!$length->isValid()) {
-            return false;
-        }
-
-        $n = $length->getN();
-        $unit = $length->getUnit();
-
-        if ($n === '0' || $unit === false) {
-            return new HTMLPurifier_Length('0', false);
-        }
-
-        $state = $dest_state = false;
-        foreach (self::$units as $k => $x) {
-            if (isset($x[$unit])) {
-                $state = $k;
-            }
-            if (isset($x[$to_unit])) {
-                $dest_state = $k;
-            }
-        }
-        if (!$state || !$dest_state) {
-            return false;
-        }
-
-        // Some calculations about the initial precision of the number;
-        // this will be useful when we need to do final rounding.
-        $sigfigs = $this->getSigFigs($n);
-        if ($sigfigs < $this->outputPrecision) {
-            $sigfigs = $this->outputPrecision;
-        }
-
-        // BCMath's internal precision deals only with decimals. Use
-        // our default if the initial number has no decimals, or increase
-        // it by how ever many decimals, thus, the number of guard digits
-        // will always be greater than or equal to internalPrecision.
-        $log = (int)floor(log(abs($n), 10));
-        $cp = ($log < 0) ? $this->internalPrecision - $log : $this->internalPrecision; // internal precision
-
-        for ($i = 0; $i < 2; $i++) {
-
-            // Determine what unit IN THIS SYSTEM we need to convert to
-            if ($dest_state === $state) {
-                // Simple conversion
-                $dest_unit = $to_unit;
-            } else {
-                // Convert to the smallest unit, pending a system shift
-                $dest_unit = self::$units[$state][$dest_state][0];
-            }
-
-            // Do the conversion if necessary
-            if ($dest_unit !== $unit) {
-                $factor = $this->div(self::$units[$state][$unit], self::$units[$state][$dest_unit], $cp);
-                $n = $this->mul($n, $factor, $cp);
-                $unit = $dest_unit;
-            }
-
-            // Output was zero, so bail out early. Shouldn't ever happen.
-            if ($n === '') {
-                $n = '0';
-                $unit = $to_unit;
-                break;
-            }
-
-            // It was a simple conversion, so bail out
-            if ($dest_state === $state) {
-                break;
-            }
-
-            if ($i !== 0) {
-                // Conversion failed! Apparently, the system we forwarded
-                // to didn't have this unit. This should never happen!
-                return false;
-            }
-
-            // Pre-condition: $i == 0
-
-            // Perform conversion to next system of units
-            $n = $this->mul($n, self::$units[$state][$dest_state][1], $cp);
-            $unit = self::$units[$state][$dest_state][2];
-            $state = $dest_state;
-
-            // One more loop around to convert the unit in the new system.
-
-        }
-
-        // Post-condition: $unit == $to_unit
-        if ($unit !== $to_unit) {
-            return false;
-        }
-
-        // Useful for debugging:
-        // "<pre>n";
-        // "$n\nsigfigs = $sigfigs\nnew_log = $new_log\nlog = $log\nrp = $rp\n</pre>\n";
-
-        $n = $this->round($n, $sigfigs);
-        if (strpos($n, '.') !== false) {
-            $n = rtrim($n, '0');
-        }
-        $n = rtrim($n, '.');
-
-        return new HTMLPurifier_Length($n, $unit);
-    }
-
-    /**
-     * Returns the number of significant figures in a string number.
-     * @param string $n Decimal number
-     * @return int number of sigfigs
-     */
-    public function getSigFigs($n)
-    {
-        $n = ltrim($n, '0+-');
-        $dp = strpos($n, '.'); // decimal position
-        if ($dp === false) {
-            $sigfigs = strlen(rtrim($n, '0'));
-        } else {
-            $sigfigs = strlen(ltrim($n, '0.')); // eliminate extra decimal character
-            if ($dp !== 0) {
-                $sigfigs--;
-            }
-        }
-        return $sigfigs;
-    }
-
-    /**
-     * Adds two numbers, using arbitrary precision when available.
-     * @param string $s1
-     * @param string $s2
-     * @param int $scale
-     * @return string
-     */
-    private function add($s1, $s2, $scale)
-    {
-        if ($this->bcmath) {
-            return bcadd($s1, $s2, $scale);
-        } else {
-            return $this->scale((float)$s1 + (float)$s2, $scale);
-        }
-    }
-
-    /**
-     * Multiples two numbers, using arbitrary precision when available.
-     * @param string $s1
-     * @param string $s2
-     * @param int $scale
-     * @return string
-     */
-    private function mul($s1, $s2, $scale)
-    {
-        if ($this->bcmath) {
-            return bcmul($s1, $s2, $scale);
-        } else {
-            return $this->scale((float)$s1 * (float)$s2, $scale);
-        }
-    }
-
-    /**
-     * Divides two numbers, using arbitrary precision when available.
-     * @param string $s1
-     * @param string $s2
-     * @param int $scale
-     * @return string
-     */
-    private function div($s1, $s2, $scale)
-    {
-        if ($this->bcmath) {
-            return bcdiv($s1, $s2, $scale);
-        } else {
-            return $this->scale((float)$s1 / (float)$s2, $scale);
-        }
-    }
-
-    /**
-     * Rounds a number according to the number of sigfigs it should have,
-     * using arbitrary precision when available.
-     * @param float $n
-     * @param int $sigfigs
-     * @return string
-     */
-    private function round($n, $sigfigs)
-    {
-        $new_log = (int)floor(log(abs($n), 10)); // Number of digits left of decimal - 1
-        $rp = $sigfigs - $new_log - 1; // Number of decimal places needed
-        $neg = $n < 0 ? '-' : ''; // Negative sign
-        if ($this->bcmath) {
-            if ($rp >= 0) {
-                $n = bcadd($n, $neg . '0.' . str_repeat('0', $rp) . '5', $rp + 1);
-                $n = bcdiv($n, '1', $rp);
-            } else {
-                // This algorithm partially depends on the standardized
-                // form of numbers that comes out of bcmath.
-                $n = bcadd($n, $neg . '5' . str_repeat('0', $new_log - $sigfigs), 0);
-                $n = substr($n, 0, $sigfigs + strlen($neg)) . str_repeat('0', $new_log - $sigfigs + 1);
-            }
-            return $n;
-        } else {
-            return $this->scale(round($n, $sigfigs - $new_log - 1), $rp + 1);
-        }
-    }
-
-    /**
-     * Scales a float to $scale digits right of decimal point, like BCMath.
-     * @param float $r
-     * @param int $scale
-     * @return string
-     */
-    private function scale($r, $scale)
-    {
-        if ($scale < 0) {
-            // The f sprintf type doesn't support negative numbers, so we
-            // need to cludge things manually. First get the string.
-            $r = sprintf('%.0f', (float)$r);
-            // Due to floating point precision loss, $r will more than likely
-            // look something like 4652999999999.9234. We grab one more digit
-            // than we need to precise from $r and then use that to round
-            // appropriately.
-            $precise = (string)round(substr($r, 0, strlen($r) + $scale), -1);
-            // Now we return it, truncating the zero that was rounded off.
-            return substr($precise, 0, -1) . str_repeat('0', -$scale + 1);
-        }
-        return sprintf('%.' . $scale . 'f', (float)$r);
-    }
+	const ENGLISH = 1;
+	const METRIC = 2;
+	const DIGITAL = 3;
+
+	/**
+	 * Units information array. Units are grouped into measuring systems
+	 * (English, Metric), and are assigned an integer representing
+	 * the conversion factor between that unit and the smallest unit in
+	 * the system. Numeric indexes are actually magical constants that
+	 * encode conversion data from one system to the next, with a O(n^2)
+	 * constraint on memory (this is generally not a problem, since
+	 * the number of measuring systems is small.)
+	 */
+	protected static $units = array(
+		self::ENGLISH => array(
+			'px' => 3, // This is as per CSS 2.1 and Firefox. Your mileage may vary
+			'pt' => 4,
+			'pc' => 48,
+			'in' => 288,
+			self::METRIC => array('pt', '0.352777778', 'mm'),
+		),
+		self::METRIC => array(
+			'mm' => 1,
+			'cm' => 10,
+			self::ENGLISH => array('mm', '2.83464567', 'pt'),
+		),
+	);
+
+	/**
+	 * Minimum bcmath precision for output.
+	 * @type int
+	 */
+	protected $outputPrecision;
+
+	/**
+	 * Bcmath precision for internal calculations.
+	 * @type int
+	 */
+	protected $internalPrecision;
+
+	/**
+	 * Whether or not BCMath is available.
+	 * @type bool
+	 */
+	private $bcmath;
+
+	public function __construct($output_precision = 4, $internal_precision = 10, $force_no_bcmath = false)
+	{
+		$this->outputPrecision = $output_precision;
+		$this->internalPrecision = $internal_precision;
+		$this->bcmath = !$force_no_bcmath && function_exists('bcmul');
+	}
+
+	/**
+	 * Converts a length object of one unit into another unit.
+	 * @param HTMLPurifier_Length $length
+	 *      Instance of HTMLPurifier_Length to convert. You must validate()
+	 *      it before passing it here!
+	 * @param string $to_unit
+	 *      Unit to convert to.
+	 * @return HTMLPurifier_Length|bool
+	 * @note
+	 *      About precision: This conversion function pays very special
+	 *      attention to the incoming precision of values and attempts
+	 *      to maintain a number of significant figure. Results are
+	 *      fairly accurate up to nine digits. Some caveats:
+	 *          - If a number is zero-padded as a result of this significant
+	 *            figure tracking, the zeroes will be eliminated.
+	 *          - If a number contains less than four sigfigs ($outputPrecision)
+	 *            and this causes some decimals to be excluded, those
+	 *            decimals will be added on.
+	 */
+	public function convert($length, $to_unit)
+	{
+		if (!$length->isValid()) {
+			return false;
+		}
+
+		$n = $length->getN();
+		$unit = $length->getUnit();
+
+		if ($n === '0' || $unit === false) {
+			return new HTMLPurifier_Length('0', false);
+		}
+
+		$state = $dest_state = false;
+		foreach (self::$units as $k => $x) {
+			if (isset($x[$unit])) {
+				$state = $k;
+			}
+			if (isset($x[$to_unit])) {
+				$dest_state = $k;
+			}
+		}
+		if (!$state || !$dest_state) {
+			return false;
+		}
+
+		// Some calculations about the initial precision of the number;
+		// this will be useful when we need to do final rounding.
+		$sigfigs = $this->getSigFigs($n);
+		if ($sigfigs < $this->outputPrecision) {
+			$sigfigs = $this->outputPrecision;
+		}
+
+		// BCMath's internal precision deals only with decimals. Use
+		// our default if the initial number has no decimals, or increase
+		// it by how ever many decimals, thus, the number of guard digits
+		// will always be greater than or equal to internalPrecision.
+		$log = (int)floor(log(abs($n), 10));
+		$cp = ($log < 0) ? $this->internalPrecision - $log : $this->internalPrecision; // internal precision
+
+		for ($i = 0; $i < 2; $i++) {
+
+			// Determine what unit IN THIS SYSTEM we need to convert to
+			if ($dest_state === $state) {
+				// Simple conversion
+				$dest_unit = $to_unit;
+			} else {
+				// Convert to the smallest unit, pending a system shift
+				$dest_unit = self::$units[$state][$dest_state][0];
+			}
+
+			// Do the conversion if necessary
+			if ($dest_unit !== $unit) {
+				$factor = $this->div(self::$units[$state][$unit], self::$units[$state][$dest_unit], $cp);
+				$n = $this->mul($n, $factor, $cp);
+				$unit = $dest_unit;
+			}
+
+			// Output was zero, so bail out early. Shouldn't ever happen.
+			if ($n === '') {
+				$n = '0';
+				$unit = $to_unit;
+				break;
+			}
+
+			// It was a simple conversion, so bail out
+			if ($dest_state === $state) {
+				break;
+			}
+
+			if ($i !== 0) {
+				// Conversion failed! Apparently, the system we forwarded
+				// to didn't have this unit. This should never happen!
+				return false;
+			}
+
+			// Pre-condition: $i == 0
+
+			// Perform conversion to next system of units
+			$n = $this->mul($n, self::$units[$state][$dest_state][1], $cp);
+			$unit = self::$units[$state][$dest_state][2];
+			$state = $dest_state;
+
+			// One more loop around to convert the unit in the new system.
+
+		}
+
+		// Post-condition: $unit == $to_unit
+		if ($unit !== $to_unit) {
+			return false;
+		}
+
+		// Useful for debugging:
+		// "<pre>n";
+		// "$n\nsigfigs = $sigfigs\nnew_log = $new_log\nlog = $log\nrp = $rp\n</pre>\n";
+
+		$n = $this->round($n, $sigfigs);
+		if (strpos($n, '.') !== false) {
+			$n = rtrim($n, '0');
+		}
+		$n = rtrim($n, '.');
+
+		return new HTMLPurifier_Length($n, $unit);
+	}
+
+	/**
+	 * Returns the number of significant figures in a string number.
+	 * @param string $n Decimal number
+	 * @return int number of sigfigs
+	 */
+	public function getSigFigs($n)
+	{
+		$n = ltrim($n, '0+-');
+		$dp = strpos($n, '.'); // decimal position
+		if ($dp === false) {
+			$sigfigs = strlen(rtrim($n, '0'));
+		} else {
+			$sigfigs = strlen(ltrim($n, '0.')); // eliminate extra decimal character
+			if ($dp !== 0) {
+				$sigfigs--;
+			}
+		}
+		return $sigfigs;
+	}
+
+	/**
+	 * Adds two numbers, using arbitrary precision when available.
+	 * @param string $s1
+	 * @param string $s2
+	 * @param int $scale
+	 * @return string
+	 */
+	private function add($s1, $s2, $scale)
+	{
+		if ($this->bcmath) {
+			return bcadd($s1, $s2, $scale);
+		} else {
+			return $this->scale((float)$s1 + (float)$s2, $scale);
+		}
+	}
+
+	/**
+	 * Multiples two numbers, using arbitrary precision when available.
+	 * @param string $s1
+	 * @param string $s2
+	 * @param int $scale
+	 * @return string
+	 */
+	private function mul($s1, $s2, $scale)
+	{
+		if ($this->bcmath) {
+			return bcmul($s1, $s2, $scale);
+		} else {
+			return $this->scale((float)$s1 * (float)$s2, $scale);
+		}
+	}
+
+	/**
+	 * Divides two numbers, using arbitrary precision when available.
+	 * @param string $s1
+	 * @param string $s2
+	 * @param int $scale
+	 * @return string
+	 */
+	private function div($s1, $s2, $scale)
+	{
+		if ($this->bcmath) {
+			return bcdiv($s1, $s2, $scale);
+		} else {
+			return $this->scale((float)$s1 / (float)$s2, $scale);
+		}
+	}
+
+	/**
+	 * Rounds a number according to the number of sigfigs it should have,
+	 * using arbitrary precision when available.
+	 * @param float $n
+	 * @param int $sigfigs
+	 * @return string
+	 */
+	private function round($n, $sigfigs)
+	{
+		$new_log = (int)floor(log(abs($n), 10)); // Number of digits left of decimal - 1
+		$rp = $sigfigs - $new_log - 1; // Number of decimal places needed
+		$neg = $n < 0 ? '-' : ''; // Negative sign
+		if ($this->bcmath) {
+			if ($rp >= 0) {
+				$n = bcadd($n, $neg . '0.' . str_repeat('0', $rp) . '5', $rp + 1);
+				$n = bcdiv($n, '1', $rp);
+			} else {
+				// This algorithm partially depends on the standardized
+				// form of numbers that comes out of bcmath.
+				$n = bcadd($n, $neg . '5' . str_repeat('0', $new_log - $sigfigs), 0);
+				$n = substr($n, 0, $sigfigs + strlen($neg)) . str_repeat('0', $new_log - $sigfigs + 1);
+			}
+			return $n;
+		} else {
+			return $this->scale(round($n, $sigfigs - $new_log - 1), $rp + 1);
+		}
+	}
+
+	/**
+	 * Scales a float to $scale digits right of decimal point, like BCMath.
+	 * @param float $r
+	 * @param int $scale
+	 * @return string
+	 */
+	private function scale($r, $scale)
+	{
+		if ($scale < 0) {
+			// The f sprintf type doesn't support negative numbers, so we
+			// need to cludge things manually. First get the string.
+			$r = sprintf('%.0f', (float)$r);
+			// Due to floating point precision loss, $r will more than likely
+			// look something like 4652999999999.9234. We grab one more digit
+			// than we need to precise from $r and then use that to round
+			// appropriately.
+			$precise = (string)round(substr($r, 0, strlen($r) + $scale), -1);
+			// Now we return it, truncating the zero that was rounded off.
+			return substr($precise, 0, -1) . str_repeat('0', -$scale + 1);
+		}
+		return sprintf('%.' . $scale . 'f', (float)$r);
+	}
 }
 
 // vim: et sw=4 sts=4