1 XML-RPC for PHP version 4.0.0 - 2015/Y/Z
3 This release does away with the past and starts a transition to modern-world php.
5 Code has been heavily refactored, taking care to preserve backwards compatibility as much as possible,
6 but some breackage is to be expected.
8 The minimum required php version has been increased to 5.3, even though we strongly urge you to use
11 PLEASE READ CAREFULLY THE NOTES BELOW to insure a smooth upgrade.
13 * new: introduction of namespaces.
15 All php classes have been renamed and moved to separate files.
16 Class autoloading can now be done in accord with the PSR-4 standard.
17 Backward compatibility is maintained via lib/xmlrpc.inc, lib/xmlrpcs.inc and lib/xmlrpc_wrappers.inc.
18 For more details, head on to doc/api_changes_v4.md
20 * improved: all php code is now formatted according to the PSR-2 standard
22 * improved: no need to call anymore $client->setSSLVerifyHost(2) to silence a curl warning when using https
23 with recent curl builds
25 * improved: debug messages are not html-escaped any more when executing from the command line
27 * improved: a specific option allows users to decide the version of SSL to use for https calls.
28 This is useful f.e. for the testing suite, when the server target of calls has no proper ssl certificate,
29 and the cURL extension has been compiled with GnuTLS (such as on Travis VMs)
31 * improved: the library is now tested using Travis ( https://travis-ci.org/ ).
32 Tests are executed using all php versions from 5.3 to 7.0 nightly, plus HHVM; code-coverage information
33 is generated using php 5.6 and uploaded to both Code Coverage and Scrutinizer online services
35 * improved: phpunit is now installed via composer, not bundled anymore
37 * improved: when phpunit is used to generate code-coverage data, the code executed server-side is accounted for
39 * improved: the testsuite has basic checks for the debugger and demo files
42 XML-RPC for PHP version 3.0.0 - 2014/6/15
44 This release corrects all bugs that have been reported and successfully reproduced since
47 The requirements have increased to php 5.1.0 - which is still way older than what you should be running for any serious purpose, really.
49 It also is the first release to be installable via composer.
51 See the Changelog file or the pdf docs for a complete list of changes.
54 XML-RPC for PHP version 3.0.0 beta - 2009/09/05
56 This is the first release of the library to only support PHP 5.
57 Some legacy code has been removed, and support for features such as exceptions
58 and dateTime objects introduced.
60 The "beta" tag is meant to indicate the fact that the refactoring has been more widespread
61 than in precedent releases and that more changes are likely to be introduced with time -
62 the library is still considered to be production quality.
64 * improved: removed all usage of php functions deprecated in php 5.3, usage of assign-by-ref when creating new objects etc...
65 * improved: add support for the <ex:nil/> tag used by the apache library, both in input and output
66 * improved: add support for dateTime objects in both in php_xmlrpc_encode and as parameter for constructor of xmlrpcval
67 * improved: add support for timestamps as parameter for constructor of xmlrpcval
68 * improved: add option 'dates_as_objects' to php_xmlrpc_decode to return dateTime objects for xmlrpc datetimes
69 * improved: add new method SetCurlOptions to xmrlpc_client to allow extra flexibility in tweaking http config, such as explicitly binding to an ip address
70 * improved: add new method SetUserAgent to xmrlpc_client to to allow having different user-agent http headers
71 * improved: add a new member variable in server class to allow fine-tuning of the encoding of returned values when the server is in 'phpvals' mode
72 * improved: allow servers in 'xmlrpcvals' mode to also register plain php functions by defining them in the dispatch map with an added option
73 * improved: catch exceptions thrown during execution of php functions exposed as methods by the server
74 * fixed: bad encoding if same object is encoded twice using php_xmlrpc_encode
77 XML-RPC for PHP version 2.2.2 - 2009/03/16
79 This release corrects all bugs that have been reported and sucesfully reproduced since
81 Regardless of the intimidating message about dropping PHP 4 support, it still does
82 support that ancient, broken and insecure platform.
85 * fixed: php warning when receiving 'false' in a bool value
86 * fixed: improve robustness of the debugger when parsing weird results from non-compliant servers
87 * fixed: format floating point values using the correct decimal separator even when php locale is set to one that uses comma
88 * fixed: use feof() to test if socket connections are to be closed instead of the number of bytes read (rare bug when communicating with some servers)
89 * fixed: be more tolerant in detection of charset in http headers
90 * fixed: fix encoding of UTF8 chars outside of the BMP plane
91 * fixed: fix detection of zlib.output_compression
92 * improved: allow the add_to_map server method to add docs for single params too
93 * improved: added the possibility to wrap for exposure as xmlrpc methods plain php class methods, object methods and even whole classes
96 XML-RPC for PHP version 2.2.1 - 2008/03/06
98 This release corrects all bugs that have been reported and sucesfully reproduced.
99 It is the last release of the library that will support PHP 4.
101 * fixed: work around bug in php 5.2.2 which broke support of HTTP_RAW_POST_DATA
102 * fixed: is_dir parameter of setCaCertificate() method is reversed
103 * fixed: a php warning in xmlrpc_client creator method
104 * fixed: parsing of '1e+1' as valid float
105 * fixed: allow errorlevel 3 to work when prev. error handler was a static method
106 * fixed: usage of client::setcookie() for multiple cookies in non-ssl mode
107 * improved: support for CP1252 charset is not part or the library but almost possible
108 * improved: more info when curl is enabled and debug mode is on
111 XML-RPC for PHP version 2.2 - 2007/02/25
113 This release corrects a couple of bugs and adds a few minor features.
115 * fixed: debugger errors on php installs with magic_quotes_gpc on
116 * fixed: support for https connections via proxy
117 * fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects
118 * improved: slightly faster encoding of data which is internally UTF-8
119 * improved: debugger always generates a 'null' id for jsonrpc if user omits it
120 * new: debugger can take advantage of a graphical value builder
121 (it has to be downloaded separately, as part of jsxmlrpc package)
122 * new: support for the <NIL/> xmlrpc extension
123 * new: server support for the system.getCapabilities xmlrpc extension
124 * new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault
127 XML-RPC for PHP version 2.1 - 2006/08/28
129 This release corrects quite a few bugs and adds some interesting new features.
130 There is a minor security enhancement and overall speedup too.
132 It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.
133 Please note that 404pl1 is NOT supported, and has not been since 2.0.
135 *** PLEASE READ CAREFULLY BELOW ***
137 CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:
139 The wrap_php_function and wrap_xmlrpc_method functions have been moved out of
140 the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.
141 You will have to include() / require() it in your scripts if you have been using
144 For increased security, the automatic rebuilding of php object instances out of
145 received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be
146 optionally reenabled).
148 The constructor of xmlrpcval() values has seen major changes, and it will not
149 throw a php warning anymore when invoked using an unknown xmlrpc type: the
150 error will only be written to php error log. Also new xmlrpcval('true', 'boolean')
151 is not supported anymore.
155 The new function php_xmlrpc_decode_xml() will take the xml representation of
156 either an xmlrpc request, response or single value and return the corresponding
157 php-xmlrpc object instance.
159 Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more
160 options to fine tune their behaviour, including one to return the php code to
161 be saved and later used as standalone php script.
163 A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the
164 methods exposed by a remote xmlrpc server into a php class.
166 Lib internals have been modified to provide better support for grafting extra
167 functionality on top of it. Stay tuned for future releases of the EXTRAS package.
169 Last but not least a new file has been added: verify_compat.php, to help users
170 diagnose the level of compliance of the current php install with the library.
174 * fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80
175 * fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_
176 * fixed bug: wrong handling of 'deflate' http encoding, both server and client side
177 * fixed bug: sending compressed responses when php output compression is enabled was not working
178 * fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values
179 * fixed bug: non-ascii chars used in struct element names where not being encoded correctly
180 * restored compatibility with php 4.0.5 (for those poor souls still stuck on it)
181 * server->service() now returns either the payload or xmlrpcresp instance
182 * server->add_to_map() now accepts methods with no param definitions
183 * added new function: php_xmlrpc_decode_xml()
184 * added new function: wrap_xmlrpc_server()
185 * major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()
186 * documentation for single parameters of exposed methods can be added to the dispatch map
187 (and turned into html docs in conjunction with a future release of the extras package)
188 * full response payload is saved into xmlrpcresp object for further debugging
189 * stricter parsing of incoming xmlrpc messages: two more invalid cases are now detected
190 (double data element inside array and struct/array after scalar inside value element)
191 * debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)
192 * debugger has better support for being activated via a single GET call (for integration into other tools?)
193 * more logging of errors in a lot of situations
194 * javadoc documentation of lib files almost complete
195 * the usual amount of new testcases in the testsuite
196 * many performance tweaks and code cleanups
197 * added foundation for emulating the API of the xmlrpc extension (extras package needed)
200 XML-RPC for PHP version 2.0 - 2006/04/24
202 I'm pleased to announce XML-RPC for PHP version 2.0, final.
204 With respect to the last release candidate, this release corrects a few small
205 bugs and adds a couple of new features: more authentication options (digest and
206 ntlm for servers, ntlm for proxies, and some https custom certificates stuff);
207 all the examples have been reviewed and some demo files added,
208 including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc
209 client is a browser); the server logs more warning messages for incorrect situations;
210 both client and server are more tolerant of commonly-found mistakes.
211 The debugger has been upgraded to reflect the new client capabilities.
215 * fixed bug: method xmlrpcval::structmemexists($value) would not work
216 * fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that
217 has return_type=phpvals
218 * fixed bug: in case of call to client::multicall without fallback and server error
219 * fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset
220 * fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii
221 chars where found when decoding
222 * new: client can use NTLM and Digest authentication methods for https and http 1.1
223 connections; authentication to proxy can be set to NTLM, too
224 * new: server tolerates user functions returning a single xmlrpcval object instead
226 * new: server does more checks for presence and correct return type of user
227 coded method handling functions, and logs inconsistencies to php error log
228 * new: client method SetCaCertificate($cert, $is_dir) to validate server against
229 * new: both server and client tolerate receiving 'true' and 'false' for bool values
230 (which btw are not valid according to the xmlrpc spec)
233 XML-RPC for PHP version 2.0RC3 - 2006/01/22
235 This release corrects a few bugs and adds some interesting new features.
236 It has been tested with PHP up to 4.4.2 and 5.1.2.
238 * fixed bug: server not recognizing clients that declare support for http compression
239 * fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding
241 * fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce
243 * new: let the server accept 'class::method' syntax in the dispatch map
244 * new: php_xmlrpc_decode() can decode xmlrpcmessage objects
245 * new: both client and server can specify a charset to be used for serializing
246 values instead of the default 'US-ASCII+xml-entities-for-other-characters'.
247 Values allowed: ISO-8859-1 and UTF-8
248 * new: the server object can register 'plain' php functions instead of functions
249 that accept a single parameter of type xmlrpcmsg. Faster, uses less memory
250 (but comes with minor drawbacks as well, read the manual for more details)
251 * new: client::setDebug(2) can be used to have the request payload printed to
252 screen before being sent
253 * new: server::service($data) lets user parse data other than POST body, for
254 easier testing / subclassing
255 * changed: framework-generated debug messages are sent back by the server base64
256 encoded, to avoid any charset/xml compatibility problem
259 The usual refactoring of a lot of (private) methods has taken place, with new
260 parameters added to some functions.
261 Javadoc documentation has been improved a lot.
262 The HTML documentation has been shuffled around a bit, hoping to give it a more
263 logical organization.
265 The experimental support for the JSON protocol has been removed, and will be
266 packaged as a separate download with some extra very interesting stuff (human
267 readable auto-generated documentation, anyone?).
270 XML-RPC for PHP version 2.0RC2 - 2005/11/22
272 This release corrects a few bugs and adds basically one new method for better
275 * fixed two bugs that prevented xmlrpc calls to take place over https
276 * fixed two bugs that prevented proper recognition of xml character set
277 when it was declared inside the xml prologue
278 * added xmlrpc_client::setKey($key, $keypass) method, to allow using client
279 side certificates for https connections
280 * fixed bug that prevented proper serialization of string xmlrpcvals when
281 $xmlrpc_internalencoding was set to UTF-8
282 * fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)
283 * correctly set cookies/http headers into xmlrpcresp objects even when the
284 send() method call fails for some reason
285 * added a benchmark file in the testsuite directory
287 A couple of (private/protected) methods have been refactored, as well as a
288 couple of extra parameters added to some (private) functions - this has no
289 impact on the public API and should be of interest primarily to people extending
290 / subclassing the lib.
292 There is also new, PARTIAL support for the JSON-RPC protocol, implemented in
293 two files in the extras dir (more info about json-rpc at http://json-rpc.org)
296 XML-RPC for PHP version 2.0RC1 - 2005/10/03
298 I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.
300 This release introduces so many new features it is almost impossible to list them
301 here, making the library finally on pair with, if not more advanced than, any other
302 similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).
303 No, really, trust me.
305 The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of
306 a couple of compatibility classes (code taken from PEAR php_compat package).
308 The placement of files and directories in the distribution has been deeply modified,
309 in the hope of making it more clear, now that the file count has increased.
310 I hope you find it easy.
312 Support for "advanced" HTTP features such as cookies, proxies and keep-alives has
315 It is now much easier to convert between xmlrpcval objects and php values, and
316 in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods
317 for all cases, except when encoding base64 data.
319 Two new (experimental) functions have been added, allowing automagic conversion
320 of a php function into an xmlrpc method to be exposed and vice-versa.
322 PHP objects can be now automatically serialized as xmlrpc struct values and
323 correctly deserialized on the other end of the transmission, provided that the
324 same class definition is present on both sides and no object members are of
327 A lot of the existing class methods have been overloaded with extra parameters
328 or new functionality, and a few added ex-novo, making usage easier than ever.
330 A complete debugger solution is included in the distribution. It needs a web server
331 to run (a freely available version of the same debugger is accessible online, it
332 can be found at http://phpxmlrpc.sourceforge.net).
334 For a more detailed list of changes, please read carefully chapter 2 of the
335 included documentation, or, even better, take a look at the source code, which
336 is commented in javadoc style quite a bit.
339 XML-RPC for PHP version 1.2 - 2005/08/14
341 This removes all use of eval(), which is a potential security problem.
342 All users are encouraged to upgrade as soon as possible.
343 As of this release we are no longer php3-compatible.
346 XML-RPC for PHP version 1.1.1 - 2005/06/30
348 This is a security vulnerability fix release.
349 All users are invited to upgrade as soon as possible.
352 XML-RPC for PHP version 1.1 - 2005/05/03
354 I'm pleased to announce XML-RPC for PHP version 1.1
355 It's taken two years to get to the this point, but here we are, finally.
357 This is a bugfix and maintenance release. No major new features have been added.
358 All known bugs have been ironed out, unless fixing would have meant breaking
360 The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main
361 development platform (and some warnings will be emitted when running PHP5).
363 Noteworthy changes include:
365 * do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5
366 * fixed the unicode/charset problems that have been plaguing the lib for years
367 * proper parsing of int and float values prepended with zeroes or the '+' char
368 * accept float values in exponential notation
369 * configurable http user-agent string
370 * use the same timeout on client socket reads as used for connecting
371 * more explicative error messages in xmlrpcresponse in many cases
372 * much more tolerant parsing of malformed http responses from xmlrpc servers
373 * fixed memleak that prevented the client to be used in never-ending scripts
374 * parse bigger xmlrpc messages without crashing (1MB in size or more)
375 * be tolerant to xmlrpc responses generated on public servers that add
376 javascript advertising at the end of hosted content
377 * the lib generates quite a few less PHP warnings during standard operation
379 This is the last release that will support PHP 3.
380 The next release will include better support for PHP 5 and (possibly) a slew of
383 The changelog is available at:
384 http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup
386 Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project
387 pages at http://sourceforge.net/projects/phpxmlrpc/
390 XML-RPC for PHP version 1.0
392 I'm pleased to announce XML-RPC for PHP version 1.0 (final). It's taken
393 two years to get to the 1.0 point, but here we are, finally. The major change
394 is re-licensing with the BSD open source license, a move from the custom
395 license previously used.
397 After this release I expect to move the project to SourceForge and find
398 another primary maintainer for the code. More details will follow to the
401 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
403 Comprehensive documentation is available in the distribution, but you
404 can also browse it at http://xmlrpc.usefulinc.com/doc/
406 Bugfixes in this release include:
408 * Small fixes and tidying up.
410 New features include:
412 * experimental support for SSL via the curl extensions to PHP. Needs
413 PHP 4.0.2 or greater, but not PHP 4.0.6 which has broken SSL support.
415 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
417 Please report bugs to the XML-RPC PHP mailing list, of which more details are
418 available at http://xmlrpc.usefulinc.com/list.html, or to
419 <xmlrpc@usefulinc.com>.
422 XML-RPC for PHP version 1.0 beta 9
424 I'm pleased to announce XML-RPC for PHP version 1.0 beta 9. This is
425 is largely a bugfix release.
427 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
429 Comprehensive documentation is available in the distribution, but you
430 can also browse it at http://xmlrpc.usefulinc.com/doc/
432 Bugfixes in this release include:
434 * Fixed string handling bug where characters between a </string>
435 and </value> tag were not ignored.
437 * Added in support for PHP's native boolean type.
439 New features include:
441 * new getval() method (experimental only) which has support for
442 recreating nested arrays.
443 * fledgling unit test suite
444 * server.php has support for basic interop test suite
446 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
448 Please test this as hard as possible and report bugs to the XML-RPC PHP
449 mailing list, of which more details are available at
450 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
453 XML-RPC for PHP version 1.0 beta 8
455 I'm pleased to announce XML-RPC for PHP version 1.0 beta 8.
457 This release fixes several bugs and adds a couple of new helper
458 functions. The most critical change in this release is that you can no
459 longer print debug info in comments inside a server method -- you must
460 now use the new xmlrpc_debugmsg() function.
462 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
464 Comprehensive documentation is available in the distribution, but you
465 can also browse it at http://xmlrpc.usefulinc.com/doc/
467 Bugfixes in this release include:
469 * fixed whitespace handling in values
470 * correct sending of Content-length from the server
472 New features include:
474 * xmlrpc_debugmsg() method allows sending of debug info in comments in
475 the return payload from a server
477 * xmlrpc_encode() and xmlrpc_decode() translate between xmlrpcval
478 objects and PHP language arrays. They aren't suitable for all
479 datatypes, but can speed up coding in simple scenarios. Thanks to Dan
482 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
484 Please test this as hard as possible and report bugs to the XML-RPC PHP
485 mailing list, of which more details are available at
486 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
489 XML-RPC for PHP version 1.0 beta 7
491 I'm pleased to announce XML-RPC for PHP version 1.0 beta 7. This is
492 fixes some critical bugs that crept in. If it shows itself to be stable
493 then it'll become the 1.0 release.
495 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
497 Comprehensive documentation is available in the distribution, but you
498 can also browse it at http://xmlrpc.usefulinc.com/doc/
500 Bugfixes in this release include:
502 * Passing of booleans should now work as expected
503 * Dollar signs and backslashes in strings should pass OK
504 * addScalar() now works properly to append to array vals
506 New features include:
508 * Added support for HTTP Basic authorization through the
509 xmlrpc_client::setCredentials method.
511 * Added test script and method for verifying correct passing of
514 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
516 Please test this as hard as possible and report bugs to the XML-RPC PHP
517 mailing list, of which more details are available at
518 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
521 XML-RPC for PHP version 1.0 beta 6
523 I'm pleased to announce XML-RPC for PHP version 1.0 beta 6. This is the
524 final beta before the 1.0 release.
526 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
528 Comprehensive documentation is available in the distribution, but you
529 can also browse it at http://xmlrpc.usefulinc.com/doc/
531 New features in this release include:
533 * Perl and Python test programs for the demo server
534 * Proper fault generation on a non-"200 OK" response from a remote host
535 * Bugfixed base64 decoding
536 * ISO8601 helper routines for translation to and from UNIX timestamps
537 * reorganization of code to allow eventual integration of alternative
540 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
542 Please test this as hard as possible and report bugs to the XML-RPC PHP
543 mailing list, of which more details are available at
544 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.