cvs: pear /HTML_AJAX/AJAX JSON.php Server.php

From: Date: Thu, 18 Aug 2005 13:17:10 +0000
Subject: cvs: pear /HTML_AJAX/AJAX JSON.php Server.php
Groups: php.pear.cvs 
Request: Send a blank email to pear-cvs+get-34124@lists.php.net to get a copy of this message
davidc Thu Aug 18 09:17:10 2005 EDT Added files: /pear/HTML_AJAX/AJAX JSON.php Server.php Log: Main HTML_AJAX files.

http://cvs.php.net/co.php/pear/HTML_AJAX/AJAX/JSON.php?r=1.1&p=1 Index: pear/HTML_AJAX/AJAX/JSON.php +++ pear/HTML_AJAX/AJAX/JSON.php <?php // +----------------------------------------------------------------------+ // | PHP version 4 | // +----------------------------------------------------------------------+ // | Copyright (c) 2005 Michal Migurski | // +----------------------------------------------------------------------+ // | This source file is subject to version 3.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available through the world-wide-web at the following url: | // | http://www.php.net/license/3_0.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Michal Migurski, mike-json[at]teczno[dot]com | // | with contributions from: | // | Matt Knapp, mdknapp[at]gmail[dot]com | // | Brett Stimmerman, brettstimmerman[at]gmail[dot]com | // +----------------------------------------------------------------------+ // // $Id: JSON.php,v 1.1 2005/08/18 13:17:10 davidc Exp $ /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ define('HTML_AJAX_JSON_SLICE', 1); define('HTML_AJAX_JSON_IN_STR', 2); define('HTML_AJAX_JSON_IN_ARR', 4); define('HTML_AJAX_JSON_IN_OBJ', 8); define('HTML_AJAX_JSON_IN_CMT', 16); define('HTML_AJAX_JSON_LOOSE_TYPE', 10); define('HTML_AJAX_JSON_STRICT_TYPE', 11); /** HTML_AJAX_JSON * Conversion to and from HTML_AJAX_JSON format. * See http://json.org for details. * * note all strings should be in ASCII or UTF-8 format! */ class HTML_AJAX_JSON { /** function HTML_AJAX_JSON * constructor * * @param use int object behavior: when encoding or decoding, * be loose or strict about object/array usage * * possible values: * HTML_AJAX_JSON_STRICT_TYPE - strict typing, default * "{...}" syntax creates objects in decode * HTML_AJAX_JSON_LOOSE_TYPE - loose typing * "{...}" syntax creates associative arrays in decode */ function HTML_AJAX_JSON($use=HTML_AJAX_JSON_STRICT_TYPE) { $this->use = $use; } /** function encode * encode an arbitrary variable into HTML_AJAX_JSON format * * @param var mixed any number, boolean, string, array, or object to be encoded. * see argument 1 to HTML_AJAX_JSON() above for array-parsing behavior. * if var is a strng, note that encode() always expects it * to be in ASCII or UTF-8 format! * * @return string HTML_AJAX_JSON string representation of input var */ function encode($var) { switch(gettype($var)) { case 'boolean': return $var ? 'true' : 'false'; case 'NULL': return 'null'; case 'integer': return sprintf('%d', $var); case 'double': case 'float': return sprintf('%f', $var); case 'string': // STRINGS ARE EXPECTED TO BE IN ASCII OR UTF-8 FORMAT $ascii = ''; $strlen_var = strlen($var); for($c = 0; $c < $strlen_var; $c++) { $ord_var_c = ord($var{$c}); if($ord_var_c == 0x08) { $ascii .= '\b'; } elseif($ord_var_c == 0x09) { $ascii .= '\t'; } elseif($ord_var_c == 0x0A) { $ascii .= '\n'; } elseif($ord_var_c == 0x0C) { $ascii .= '\f'; } elseif($ord_var_c == 0x0D) { $ascii .= '\r'; } elseif(($ord_var_c == 0x22) || ($ord_var_c == 0x2F) || ($ord_var_c == 0x5C)) { $ascii .= '\\'.$var{$c}; // double quote, slash, slosh } elseif(($ord_var_c >= 0x20) && ($ord_var_c <= 0x7F)) { // characters U-00000000 - U-0000007F (same as ASCII) $ascii .= $var{$c}; // most normal ASCII chars } elseif(($ord_var_c & 0xE0) == 0xC0) { // characters U-00000080 - U-000007FF, mask 110XXXXX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $char = pack('C*', $ord_var_c, ord($var{$c+1})); $c+=1; $ascii .= sprintf('\u%04s', bin2hex(mb_convert_encoding($char, 'UTF-16', 'UTF-8'))); } elseif(($ord_var_c & 0xF0) == 0xE0) { // characters U-00000800 - U-0000FFFF, mask 1110XXXX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $char = pack('C*', $ord_var_c, ord($var{$c+1}), ord($var{$c+2})); $c+=2; $ascii .= sprintf('\u%04s', bin2hex(mb_convert_encoding($char, 'UTF-16', 'UTF-8'))); } elseif(($ord_var_c & 0xF8) == 0xF0) { // characters U-00010000 - U-001FFFFF, mask 11110XXX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $char = pack('C*', $ord_var_c, ord($var{$c+1}), ord($var{$c+2}), ord($var{$c+3})); $c+=3; $ascii .= sprintf('\u%04s', bin2hex(mb_convert_encoding($char, 'UTF-16', 'UTF-8'))); } elseif(($ord_var_c & 0xFC) == 0xF8) { // characters U-00200000 - U-03FFFFFF, mask 111110XX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $char = pack('C*', $ord_var_c, ord($var{$c+1}), ord($var{$c+2}), ord($var{$c+3}), ord($var{$c+4})); $c+=4; $ascii .= sprintf('\u%04s', bin2hex(mb_convert_encoding($char, 'UTF-16', 'UTF-8'))); } elseif(($ord_var_c & 0xFE) == 0xFC) { // characters U-04000000 - U-7FFFFFFF, mask 1111110X, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $char = pack('C*', $ord_var_c, ord($var{$c+1}), ord($var{$c+2}), ord($var{$c+3}), ord($var{$c+4}), ord($var{$c+5})); $c+=5; $ascii .= sprintf('\u%04s', bin2hex(mb_convert_encoding($char, 'UTF-16', 'UTF-8'))); } } return sprintf('"%s"', $ascii); case 'array': // As per HTML_AJAX_JSON spec if any array key is not an integer we must treat the the whole array as an object. // We also try to catch a sparsely populated associative array with numeric keys here because some JS // engines will create an array with empty indexes up to max_index which can cause memory issues // and because the keys, which may be relevant, will be remapped otherwise. // // As per the ECMA and HTML_AJAX_JSON specification an object may have any string as a property. Unfortunately due to a // hole in the ECMA specification if the key is a ECMA reserved word or starts with a digit the parameter is only // accessible using ECMAScript's bracket notation. // treat as a HTML_AJAX_JSON object if(is_array($var) && (array_keys($var) !== range(0, sizeof($var) - 1))) return sprintf('{%s}', join(',', array_map(array($this, 'name_value'), array_keys($var), array_values($var)))); // treat it like a regular array return sprintf('[%s]', join(',', array_map(array($this, 'encode'), $var))); case 'object': $vars = get_object_vars($var); return sprintf('{%s}', join(',', array_map(array($this, 'name_value'), array_keys($vars), array_values($vars)))); default: return ''; } } /** function enc * alias for encode() */ function enc($var) { return $this->encode($var); } /** function name_value * array-walking function for use in generating HTML_AJAX_JSON-formatted name-value pairs * * @param name string name of key to use * @param value mixed reference to an array element to be encoded * * @return string HTML_AJAX_JSON-formatted name-value pair, like '"name":value' */ function name_value($name, $value) { return (sprintf("%s:%s", $this->encode(strval($name)), $this->encode($value))); } /** function reduce_string * reduce a string by removing leading and trailing comments and whitespace * * @param str string string value to strip of comments and whitespace * * @return string string value stripped of comments and whitespace */ function reduce_string($str) { $str = preg_replace('#^\s*//(.+)$#m', '', $str); // eliminate single line comments in '// ...' form $str = preg_replace('#^\s*/\*(.+)\*/#Us', '', $str); // eliminate multi-line comments in '/* ... */' form, at start of string $str = preg_replace('#/\*(.+)\*/\s*$#Us', '', $str); // eliminate multi-line comments in '/* ... */' form, at end of string $str = trim($str); // eliminate extraneous space return $str; } /** function decode * decode a HTML_AJAX_JSON string into appropriate variable * * @param str string HTML_AJAX_JSON-formatted string * * @return mixed number, boolean, string, array, or object * corresponding to given HTML_AJAX_JSON input string. * see argument 1 to HTML_AJAX_JSON() above for object-output behavior. * note that decode() always returns strings * in ASCII or UTF-8 format! */ function decode($str) { $str = $this->reduce_string($str); switch(strtolower($str)) { case 'true': return true; case 'false': return false; case 'null': return null; default: if(is_numeric($str)) { // Lookie-loo, it's a number // return (float)$str; // This would work on its own, but I'm trying to be good about returning integers where appropriate return ((float)$str == (integer)$str) ? (integer)$str : (float)$str; } elseif(preg_match('/^".+"$/s', $str) || preg_match('/^\'.+\'$/s', $str)) { // STRINGS RETURNED IN UTF-8 FORMAT $delim = substr($str, 0, 1); $chrs = substr($str, 1, -1); $utf8 = ''; $strlen_chrs = strlen($chrs); for($c = 0; $c < $strlen_chrs; $c++) { $substr_chrs_c_2 = substr($chrs, $c, 2); $ord_chrs_c = ord($chrs{$c}); if($substr_chrs_c_2 == '\b') { $utf8 .= chr(0x08); $c+=1; } elseif($substr_chrs_c_2 == '\t') { $utf8 .= chr(0x09); $c+=1; } elseif($substr_chrs_c_2 == '\n') { $utf8 .= chr(0x0A); $c+=1; } elseif($substr_chrs_c_2 == '\f') { $utf8 .= chr(0x0C); $c+=1; } elseif($substr_chrs_c_2 == '\r') { $utf8 .= chr(0x0D); $c+=1; } elseif(($delim == '"') && (($substr_chrs_c_2 == '\\"') || ($substr_chrs_c_2 == '\\\\') || ($substr_chrs_c_2 == '\\/'))) { $utf8 .= $chrs{++$c}; } elseif(($delim == "'") && (($substr_chrs_c_2 == '\\\'') || ($substr_chrs_c_2 == '\\\\') || ($substr_chrs_c_2 == '\\/'))) { $utf8 .= $chrs{++$c}; } elseif(preg_match('/\\\u[0-9A-F]{4}/i', substr($chrs, $c, 6))) { // single, escaped unicode character $utf16 = chr(hexdec(substr($chrs, ($c+2), 2))) . chr(hexdec(substr($chrs, ($c+4), 2))); $utf8 .= mb_convert_encoding($utf16, 'UTF-8', 'UTF-16'); $c+=5; } elseif(($ord_chrs_c >= 0x20) && ($ord_chrs_c <= 0x7F)) { $utf8 .= $chrs{$c}; } elseif(($ord_chrs_c & 0xE0) == 0xC0) { // characters U-00000080 - U-000007FF, mask 110XXXXX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $utf8 .= substr($chrs, $c, 2); $c += 1; } elseif(($ord_chrs_c & 0xF0) == 0xE0) { // characters U-00000800 - U-0000FFFF, mask 1110XXXX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $utf8 .= substr($chrs, $c, 3); $c += 2; } elseif(($ord_chrs_c & 0xF8) == 0xF0) { // characters U-00010000 - U-001FFFFF, mask 11110XXX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $utf8 .= substr($chrs, $c, 4); $c += 3; } elseif(($ord_chrs_c & 0xFC) == 0xF8) { // characters U-00200000 - U-03FFFFFF, mask 111110XX, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $utf8 .= substr($chrs, $c, 5); $c += 4; } elseif(($ord_chrs_c & 0xFE) == 0xFC) { // characters U-04000000 - U-7FFFFFFF, mask 1111110X, see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 $utf8 .= substr($chrs, $c, 6); $c += 5; } } return $utf8; } elseif(preg_match('/^\[.*\]$/s', $str) || preg_match('/^{.*}$/s', $str)) { // array, or object notation if($str{0} == '[') { $stk = array(HTML_AJAX_JSON_IN_ARR); $arr = array(); } else { if($this->use == HTML_AJAX_JSON_LOOSE_TYPE) { $stk = array(HTML_AJAX_JSON_IN_OBJ); $obj = array(); } else { $stk = array(HTML_AJAX_JSON_IN_OBJ); $obj = new stdClass(); } } array_push($stk, array('what' => HTML_AJAX_JSON_SLICE, 'where' => 0, 'delim' => false)); $chrs = substr($str, 1, -1); $chrs = $this->reduce_string($chrs); if($chrs == '') { if(reset($stk) == HTML_AJAX_JSON_IN_ARR) { return $arr; } else { return $obj; } } //print("\nparsing {$chrs}\n"); $strlen_chrs = strlen($chrs); for($c = 0; $c <= $strlen_chrs; $c++) { $top = end($stk); $substr_chrs_c_2 = substr($chrs, $c, 2); if(($c == $strlen_chrs) || (($chrs{$c} == ',') && ($top['what'] == HTML_AJAX_JSON_SLICE))) { // found a comma that is not inside a string, array, etc., OR we've reached the end of the character list $slice = substr($chrs, $top['where'], ($c - $top['where'])); array_push($stk, array('what' => HTML_AJAX_JSON_SLICE, 'where' => ($c + 1), 'delim' => false)); //print("Found split at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); if(reset($stk) == HTML_AJAX_JSON_IN_ARR) { // we are in an array, so just push an element onto the stack array_push($arr, $this->decode($slice)); } elseif(reset($stk) == HTML_AJAX_JSON_IN_OBJ) { // we are in an object, so figure out the property name and set an element in an associative array, for now if(preg_match('/^\s*(["\'].*[^\\\]["\'])\s*:\s*(\S.*),?$/Uis', $slice, $parts)) { // "name":value pair $key = $this->decode($parts[1]); $val = $this->decode($parts[2]); if($this->use == HTML_AJAX_JSON_LOOSE_TYPE) { $obj[$key] = $val; } else { $obj->$key = $val; } } elseif(preg_match('/^\s*(\w+)\s*:\s*(\S.*),?$/Uis', $slice, $parts)) { // name:value pair, where name is unquoted $key = $parts[1]; $val = $this->decode($parts[2]); if($this->use == HTML_AJAX_JSON_LOOSE_TYPE) { $obj[$key] = $val; } else { $obj->$key = $val; } } } } elseif((($chrs{$c} == '"') || ($chrs{$c} == "'")) && ($top['what'] != HTML_AJAX_JSON_IN_STR)) { // found a quote, and we are not inside a string array_push($stk, array('what' => HTML_AJAX_JSON_IN_STR, 'where' => $c, 'delim' => $chrs{$c})); //print("Found start of string at {$c}\n"); } elseif(($chrs{$c} == $top['delim']) && ($top['what'] == HTML_AJAX_JSON_IN_STR) && (($chrs{$c - 1} != "\\") || ($chrs{$c - 1} == "\\" && $chrs{$c - 2} == "\\"))) { // found a quote, we're in a string, and it's not escaped array_pop($stk); //print("Found end of string at {$c}: ".substr($chrs, $top['where'], (1 + 1 + $c - $top['where']))."\n"); } elseif(($chrs{$c} == '[') && in_array($top['what'], array(HTML_AJAX_JSON_SLICE, HTML_AJAX_JSON_IN_ARR, HTML_AJAX_JSON_IN_OBJ))) { // found a left-bracket, and we are in an array, object, or slice array_push($stk, array('what' => HTML_AJAX_JSON_IN_ARR, 'where' => $c, 'delim' => false)); //print("Found start of array at {$c}\n"); } elseif(($chrs{$c} == ']') && ($top['what'] == HTML_AJAX_JSON_IN_ARR)) { // found a right-bracket, and we're in an array array_pop($stk); //print("Found end of array at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); } elseif(($chrs{$c} == '{') && in_array($top['what'], array(HTML_AJAX_JSON_SLICE, HTML_AJAX_JSON_IN_ARR, HTML_AJAX_JSON_IN_OBJ))) { // found a left-brace, and we are in an array, object, or slice array_push($stk, array('what' => HTML_AJAX_JSON_IN_OBJ, 'where' => $c, 'delim' => false)); //print("Found start of object at {$c}\n"); } elseif(($chrs{$c} == '}') && ($top['what'] == HTML_AJAX_JSON_IN_OBJ)) { // found a right-brace, and we're in an object array_pop($stk); //print("Found end of object at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); } elseif(($substr_chrs_c_2 == '/*') && in_array($top['what'], array(HTML_AJAX_JSON_SLICE, HTML_AJAX_JSON_IN_ARR, HTML_AJAX_JSON_IN_OBJ))) { // found a comment start, and we are in an array, object, or slice array_push($stk, array('what' => HTML_AJAX_JSON_IN_CMT, 'where' => $c, 'delim' => false)); $c++; //print("Found start of comment at {$c}\n"); } elseif(($substr_chrs_c_2 == '*/') && ($top['what'] == HTML_AJAX_JSON_IN_CMT)) { // found a comment end, and we're in one now array_pop($stk); $c++; for($i = $top['where']; $i <= $c; $i++) $chrs = substr_replace($chrs, ' ', $i, 1); //print("Found end of comment at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); } } if(reset($stk) == HTML_AJAX_JSON_IN_ARR) { return $arr; } elseif(reset($stk) == HTML_AJAX_JSON_IN_OBJ) { return $obj; } } } } /** function dec * alias for decode() */ function dec($var) { return $this->decode($var); } } ?> http://cvs.php.net/co.php/pear/HTML_AJAX/AJAX/Server.php?r=1.1&p=1 Index: pear/HTML_AJAX/AJAX/Server.php +++ pear/HTML_AJAX/AJAX/Server.php <?php /** * OO AJAX Implementation for PHP * * LICENSE: This source file is subject to version 3.0 of the PHP license * that is available through the world-wide-web at the following URI: * http://www.php.net/license/3_0.txt. If you did not receive a copy of * the PHP License and are unable to obtain it through the web, please * send a note to license@php.net so we can mail you a copy immediately. * * @category HTML * @package AJAX * @author Joshua Eichorn <josh@bluga.net> * @copyright 2005 Joshua Eichorn * @license http://www.php.net/license/3_0.txt PHP License 3.0 * @version Release: @package_version@ */ /** * Require the main AJAX library */ require_once 'HTML/AJAX.php'; /** * Class for creating an external AJAX server * * Can be used in 2 different modes, registerClass mode where you create an instance of the server and add the classes that will be registered * and then run handle request * * Or you can extend it and add init{className} methods for each class you want to export * * Client js generation is exposed through 2 _GET params client and stub * Setting the _GET param client to `all` will give you all the js classes needed * Setting the _GET param stub to `all` will give you stubs of all registered classes, you can also set it too just 1 class * * @category HTML * @package AJAX * @author Joshua Eichorn <josh@bluga.net> * @copyright 2005 Joshua Eichorn * @license http://www.php.net/license/3_0.txt PHP License 3.0 * @version Release: @package_version@ * @link http://pear.php.net/package/PackageName * @todo Decide if a syntax is needed to generate 2 stubs at once */ class HTML_AJAX_Server { /** * Client options array if set to true the code looks at _GET * @var bool|array */ var $options = true; /** * HTML_AJAX instance * @var HTML_AJAX */ var $ajax; /** * Set to true if your extending the server to add init{className methods} * @var boolean */ var $initMethods = false; /** * Location on filesystem of client javascript library * var false|string if false the default pear data dir location is used */ var $clientJsLocation = false; /** * Constructor creates the HTML_AJAX instance * * @todo: verify that PHP_SELF always does what we want */ function HTML_AJAX_Server() { $this->ajax =& new HTML_AJAX(); $this->ajax->serverUrl = $_SERVER['PHP_SELF']; } /** * Handle a client request, either generating a client or having HTML_AJAX handle the request * * @return string generated client or ajax response */ function handleRequest() { if ($this->options == true) { $this->_loadOptions(); } if (!isset($_GET['c'])) { return $this->generateClient(); } else { $this->_init($_GET['c']); return $this->ajax->handleRequest(); } } /** * Register method passthrough to HTML_AJAX * * @see HTML_AJAX::registerClass for docs */ function registerClass(&$instance, $exportedName = false, $exportedMethods = false) { $this->ajax->registerClass($instance,$exportedName,$exportedMethods); } /** * Generate client js * * @todo Add Http_Cache type functionality so the client will cache the js */ function generateClient() { header('Content-Type: text/javascript'); if ($this->options['stub'] === 'all') { if ($this->initMethods) { $this->_initAll(); } echo $this->ajax->generateJavaScriptClient($this->options['stub']); } else { if ($this->options['stub'] !== false) { $this->_init($this->options['stub']); echo $this->ajax->generateClassStub($this->options['stub']); } } $library = strtolower($this->options['client']); switch($library) { case 'all': case 'html_ajax': $this->_readFile($this->clientJsLocation()."HTML_AJAX.js"); break; case 'json': $this->_readFile($this->clientJsLocation()."JSON.js"); break; case 'request': $this->_readFile($this->clientJsLocation()."Request.js"); break; case 'main': $this->_readFile($this->clientJsLocation()."Main.js"); break; case 'httpclient': $this->_readFile($this->clientJsLocation()."HttpClient.js"); break; case 'dispatcher': $this->_readFile($this->clientJsLocation()."Dispatcher.js"); break; case false: break; default: echo "alert('Unknown javascript library: $library');"; break; } } /** * Run readfile on input with basic error checking * * @param string $file file to read * @access private */ function _readFile($file) { if (file_exists($file)) { readfile($file); } else { echo "alert('Unable to find javascript file: $file');"; } } /** * Get the location of the client js * To override the default pear datadir location set $this->clientJsLocation * * @return string */ function clientJsLocation() { if (!$this->clientJsLocation) { return '@data-dir@'.DIRECTORY_SEPARATOR.'HTML_AJAX'.DIRECTORY_SEPARATOR.'js'.DIRECTORY_SEPARATOR; } else { return $this->clientJsLocationRoot; } } /** * Load options from _GET * * @access private * @todo Is this preg_replace a good enough security check? */ function _loadOptions() { $this->options = array('client'=>false,'stub'=>false); if (isset($_GET['client'])) { $this->options['client'] = $_GET['client']; } if (isset($_GET['stub'])) { $stub = trim(preg_replace('/[^A-Za-z_0-9]/','',$_GET['stub'])); if (!empty($stub)) { $this->options['stub'] = $stub; } else { $this->options['stub'] = false; } } } /** * Run every init method on the class * * @access private */ function _initAll() { $methods = get_class_methods(get_class($this)); foreach($methods as $method) { if (substr($method,0,4) == 'init') { $this->$method(); } } } /** * Init one class * * @param string $className * @access private * @todo error handling if the method doesn't exist */ function _init($className) { $m = "init$className"; if (is_callable(array(&$this,$m))) { $this->$m(); } } } /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ ?>
« previous php.pear.cvs (#34124) next »