[Summary view] [Print] [Text view]

   1  XML-RPC for PHP version 2.2 - 2007/02/25
   2  
   3  This release corrects a couple of bugs and adds a few minor features.
   4  
   5  * fixed: debugger errors on php installs with magic_quotes_gpc on
   6  * fixed: support for https connections via proxy
   7  * fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects
   8  * improved: slightly faster encoding of data which is internally UTF-8
   9  * improved: debugger always generates a 'null' id for jsonrpc if user omits it
  10  * new: debugger can take advantage of a graphical value builder
  11    (it has to be downloaded separately, as part of jsxmlrpc package)
  12  * new: support for the <NIL/> xmlrpc extension
  13  * new: server support for the system.getCapabilities xmlrpc extension
  14  * new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault
  15  
  16  
  17  XML-RPC for PHP version 2.1 - 2006/08/28
  18  
  19  This release corrects quite a few bugs and adds some interesting new features.
  20  There is a minor security enhancement and overall speedup too.
  21  
  22  It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.
  23  Please note that 404pl1 is NOT supported, and has not been since 2.0.
  24  
  25  *** PLASE READ CAREFULLY BELOW ***
  26  
  27  CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:
  28  
  29  The wrap_php_function and wrap_xmlrpc_method functions have been moved out of
  30  the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.
  31  You will have to include() / require() it in your scripts if you have been using
  32  those functions.
  33  
  34  For increased security, the automatic rebuilding of php object instances out of
  35  received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be
  36  optionally reenabled).
  37  
  38  The constructor of xmlrpcval() values has seen major changes, and it will not
  39  throw a php warning anymore when invoked using an unknown xmlrpc type: the
  40  error will only be written to php error log. Also new xmlrpcval('true', 'boolean')
  41  is not supported anymore.
  42  
  43  MAJOR IMPROVEMENTS:
  44  
  45  The new function php_xmlrpc_decode_xml() will take the xml representation of
  46  either an xmlrpc request, response or single value and return the corresponding
  47  php-xmlrpc object instance.
  48  
  49  Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more
  50  options to fine tune their behaviour, including one to return the php code to
  51  be saved and later used as standalone php script.
  52  
  53  A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the
  54  methods exposed by a remote xmlrpc server into a php class.
  55  
  56  Lib internals have been modified to provide better support for grafting extra
  57  functionality on top of it. Stay tuned for future releases of the EXTRAS package.
  58  
  59  Last but not least a new file has been added: verify_compat.php, to help users
  60  diagnose the level of compliance of the current php install with the library.
  61  
  62  CHANGELOG IN DETAIL:
  63  
  64  * fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80
  65  * fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_
  66  * fixed bug: wrong handling of 'deflate' http encoding, both server and client side
  67  * fixed bug: sending compressed responses when php output compression is enabled was not working
  68  * fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values
  69  * fixed bug: non-ascii chars used in struct element names where not being encoded correctly
  70  * restored compatibility with php 4.0.5 (for those poor souls still stuck on it)
  71  * server->service() now returns either the payload or xmlrpcresp instance
  72  * server->add_to_map() now accepts methods with no param definitions
  73  * added new function: php_xmlrpc_decode_xml()
  74  * added new function: wrap_xmlrpc_server()
  75  * major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()
  76  * documentation for single parameters of exposed methods can be added to the dispatch map
  77    (and turned into html docs in conjunction with a future release of the extras package)
  78  * full response payload is saved into xmlrpcresp object for further debugging
  79  * stricter parsing of incmoing xmlrpc messages: two more invalid cases are now detected
  80    (double data element inside array and struct/array after scalar inside value element)
  81  * debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)
  82  * debugger has better support for being activated via a single GET call (for integration into other tools?)
  83  * more logging of errors in a lot of situations
  84  * javadoc documentation of lib files almost complete
  85  * the usual amount of new testcases in the testsuite
  86  * many performance tweaks and code cleanups
  87  * added foundation for emulating the API of the xmlrpc extension (extras package needed)
  88  
  89  
  90  XML-RPC for PHP version 2.0 - 2006/04/24
  91  
  92  I'm pleased to announce XML-RPC for PHP version 2.0, final.
  93  
  94  With respect to the last release candidate, this release corrects a few small
  95  bugs and adds a couple of new features: more authentication options (digest and
  96  ntlm for servers, ntlm for proxies, and some https custom certificates stuff);
  97  all the examples have been reviewed and some demo files added,
  98  including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc
  99  client is a browser); the server logs more warning messages for incorrect situations;
 100  both client and server are more tolerant of commonly-found mistakes.
 101  The debugger has been upgraded to reflect the new client capabilities.
 102  
 103  In greater detail:
 104  
 105  * fixed bug: method xmlrpcval::structmemexists($value) would not work
 106  * fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that
 107    has return_type=phpvals
 108  * fixed bug: in case of call to client::multicall without fallback and server error
 109  * fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset
 110  * fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii
 111    chars where found when decoding
 112  * new: client can use NTLM and Digest authentication methods for https and http 1.1
 113    connections; authentication to proxy can be set to NTLM, too
 114  * new: server tolerates user functions returning a single xmlrpcval object instead
 115    of an xmlrpcresp
 116  * new: server does more checks for presence and correct return type of user
 117    coded method handling functions, and logs inconsistencies to php error log
 118  * new: client method SetCaCertificate($cert, $is_dir) to validate server against
 119  * new: both server and client tolerate receiving 'true' and 'false' for bool values
 120    (which btw are not valid according to the xmlrpc spec)
 121  
 122  
 123  XML-RPC for PHP version 2.0RC3 - 2006/01/22
 124  
 125  This release corrects a few bugs and adds some interesting new features.
 126  It has been tested with PHP up to 4.4.2 and 5.1.2.
 127  
 128  * fixed bug: server not recognizing clients that declare support for http compression
 129  * fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding
 130    set to UTF-8
 131  * fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce
 132    invalid xml-rpc
 133  * new: let the server accept 'class::method' syntax in the dispatch map
 134  * new: php_xmlrpc_decode() can decode xmlrpcmessage objects
 135  * new: both client and server can specify a charset to be used for serializing
 136    values instead of the default 'US-ASCII+xml-entities-for-other-characters'.
 137    Values allowed: ISO-8859-1 and UTF-8
 138  * new: the server object can register 'plain' php functions instead of functions
 139    that accept a single parameter of type xmlrpcmsg. Faster, uses less memory
 140    (but comes with minor drawbacks as well, read the manual for more details)
 141  * new: client::setDebug(2) can be used to have the request payload printed to
 142    screen before being sent
 143  * new: server::service($data) lets user parse data other than POST body, for
 144    easier testing / subclassing
 145  * changed: framework-generated debug messages are sent back by the server base64
 146    encoded, to avoid any charset/xml compatibility problem
 147  * other minor fixes
 148  
 149  The usual refactoring of a lot of (private) methods has taken place, with new
 150  parameters added to some functions.
 151  Javadoc documentation has been improved a lot.
 152  The HTML documentation has been shuffled around a bit, hoping to give it a more
 153  logical organization.
 154  
 155  The experimental support for the JSON protocol has been removed, and will be
 156  packaged as a separate download with some extra very interesting stuff (human
 157  readable auto-generated documentation, anyone?).
 158  
 159  
 160  XML-RPC for PHP version 2.0RC2 - 2005/11/22
 161  
 162  This release corrects a few bugs and adds basically one new method for better
 163  HTTPS support:
 164  
 165   * fixed two bugs that prevented xmlrpc calls to take place over https
 166   * fixed two bugs that prevented proper recognition of xml character set
 167     when it was declared inside the xml prologue
 168   * added xmlrpc_client::setKey($key, $keypass) method, to allow using client
 169     side certificates for https connections
 170   * fixed bug that prevented proper serialization of string xmlrpcvals when
 171     $xmlrpc_internalencoding was set to UTF-8
 172   * fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)
 173   * correctly set cookies/http headers into xmlrpcresp objects even when the
 174     sned() method call fails for some reason
 175   * added a benchmark file in the testsuite directory
 176  
 177  A couple of (private/protected) methods have been refactored, as well as a
 178  couple of extra parameters added to some (private) functions - this has no
 179  impact on the public API and should be of interest primarily to people extending
 180  / subclassing the lib.
 181  
 182  There is also new, PARTIAL support for the JSON-RPC protocol, implemented in
 183  two files in the extras dir (more info about json-rpc at http://json-rpc.org)
 184  
 185  
 186  XML-RPC for PHP version 2.0RC1 - 2005/10/03
 187  
 188  I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.
 189  
 190  This release introduces so many new features it is almost impossible to list them
 191  here, making the library finally on pair with, if not more advanced than, any other
 192  similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).
 193  No, really, trust me.
 194  
 195  The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of
 196  a couple of compatibility classes (code taken from PEAR php_compat package).
 197  
 198  The placement of files and directories in the distribution has been deeply modified,
 199  in the hope of making it more clear, now that the file count has increased.
 200  I hope you find it easy.
 201  
 202  Support for "advanced" HTTP features such as cookies, proxies and keep-alives has
 203  been added at last.
 204  
 205  It is now much easier to convert between xmlrpcval objects and php values, and
 206  in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods
 207  for all cases, except when encoding base64 data.
 208  
 209  Two new (experimental) functions have been added, allowing automagic conversion
 210  of a php function into an xmlrpc method to be exposed and vice-versa.
 211  
 212  PHP objects can be now automatically serialized as xmlrpc struct values and
 213  correctly deserialized on the other end of the transmission, provided that the
 214  same class definition is present on both sides and no object members are of
 215  type resource.
 216  
 217  A lot of the existing class methods have been overloaded with extra parameters
 218  or new functionality, and a few added ex-novo, making usage easier than ever.
 219  
 220  A complete debugger solution is included in the distribution. It needs a web server
 221  to run (a freely available version of the same debugger is accessible online, it
 222  can be found at http://phpxmlrpc.sourceforge.net).
 223  
 224  For a more detailed list of changes, please read carefully chapter 2 of the
 225  included documentation, or, even better, take a look at the source code, which
 226  is commented in javadoc style quite a bit.
 227  
 228  
 229  XML-RPC for PHP version 1.2 - 2005/08/14
 230  
 231  This removes all use of eval(), which is a potential security problem.
 232  All users are encouraged to upgrade as soon as possible.
 233  As of this release we are no longer php3-compatible.
 234  
 235  
 236  XML-RPC for PHP version 1.1.1 - 2005/06/30
 237  
 238  This is a security vulnerability fix release.
 239  All users are invited to upgrade as soon as possible.
 240  
 241  
 242  XML-RPC for PHP version 1.1 - 2005/05/03
 243  
 244  I'm pleased to announce XML-RPC for PHP version 1.1
 245  It's taken two years to get to the this point, but here we are, finally.
 246  
 247  This is a bugfix and maintenance release. No major new features have been added.
 248  All known bugs have been ironed out, unless fixing would have meant breaking
 249  the API.
 250  The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main
 251  development platform (and some warnings will be emitted when runnning PHP5).
 252  
 253  Notheworthy changes include:
 254  
 255   * do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5
 256   * fixed the unicode/charset problems that have been plaguing the lib for years
 257   * proper parsing of int and float values prepended with zeroes or the '+' char
 258   * accept float values in exponential notation
 259   * configurable http user-agent string
 260   * use the same timeout on client socket reads as used for connecting
 261   * more explicative error messages in xmlrpcresponse in many cases
 262   * much more tolerant parsing of malformed http responses from xmlrpc servers
 263   * fixed memleak that prevented the client to be used in never-ending scripts
 264   * parse bigger xmlrpc messages without crashing (1MB in size or more)
 265   * be tolerant to xmlrpc responses generated on public servers that add
 266     javascript advertising at the end of hosted content
 267   * the lib generates quite a few less PHP warnings during standard operation
 268  
 269  This is the last release that will support PHP 3.
 270  The next release will include better support for PHP 5 and (possibly) a slew of
 271  new features.
 272  
 273  The changelog is available at:
 274  http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup
 275  
 276  Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project
 277  pages at http://sourceforge.net/projects/phpxmlrpc/