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
41 * fixed: the debugger would fail sending a request with ISO-8859-1 payload (it missed the character set declaration)
43 * fixed: the server would fail to decode a request with ISO-8859-1 payload and character set declaration in the xml prologue only
45 * fixed: the client would fail to decode a response with ISO-8859-1 payload and character set declaration in the xml prologue only
47 * fixed: the function decode_xml() would not decode an xml with character set declaration in the xml prologue
49 * improved: echo all debug messages even when there are characters in them which php deems in a wrong encoding
50 (this is visible e.g. in the debugger)
53 XML-RPC for PHP version 3.0.0 - 2014/6/15
55 This release corrects all bugs that have been reported and successfully reproduced since
58 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.
60 It also is the first release to be installable via composer.
62 See the Changelog file or the pdf docs for a complete list of changes.
65 XML-RPC for PHP version 3.0.0 beta - 2009/09/05
67 This is the first release of the library to only support PHP 5.
68 Some legacy code has been removed, and support for features such as exceptions
69 and dateTime objects introduced.
71 The "beta" tag is meant to indicate the fact that the refactoring has been more widespread
72 than in precedent releases and that more changes are likely to be introduced with time -
73 the library is still considered to be production quality.
75 * improved: removed all usage of php functions deprecated in php 5.3, usage of assign-by-ref when creating new objects etc...
76 * improved: add support for the <ex:nil/> tag used by the apache library, both in input and output
77 * improved: add support for dateTime objects in both in php_xmlrpc_encode and as parameter for constructor of xmlrpcval
78 * improved: add support for timestamps as parameter for constructor of xmlrpcval
79 * improved: add option 'dates_as_objects' to php_xmlrpc_decode to return dateTime objects for xmlrpc datetimes
80 * improved: add new method SetCurlOptions to xmrlpc_client to allow extra flexibility in tweaking http config, such as explicitly binding to an ip address
81 * improved: add new method SetUserAgent to xmrlpc_client to to allow having different user-agent http headers
82 * 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
83 * improved: allow servers in 'xmlrpcvals' mode to also register plain php functions by defining them in the dispatch map with an added option
84 * improved: catch exceptions thrown during execution of php functions exposed as methods by the server
85 * fixed: bad encoding if same object is encoded twice using php_xmlrpc_encode
88 XML-RPC for PHP version 2.2.2 - 2009/03/16
90 This release corrects all bugs that have been reported and sucesfully reproduced since
92 Regardless of the intimidating message about dropping PHP 4 support, it still does
93 support that ancient, broken and insecure platform.
96 * fixed: php warning when receiving 'false' in a bool value
97 * fixed: improve robustness of the debugger when parsing weird results from non-compliant servers
98 * fixed: format floating point values using the correct decimal separator even when php locale is set to one that uses comma
99 * 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)
100 * fixed: be more tolerant in detection of charset in http headers
101 * fixed: fix encoding of UTF8 chars outside of the BMP plane
102 * fixed: fix detection of zlib.output_compression
103 * improved: allow the add_to_map server method to add docs for single params too
104 * improved: added the possibility to wrap for exposure as xmlrpc methods plain php class methods, object methods and even whole classes
107 XML-RPC for PHP version 2.2.1 - 2008/03/06
109 This release corrects all bugs that have been reported and sucesfully reproduced.
110 It is the last release of the library that will support PHP 4.
112 * fixed: work around bug in php 5.2.2 which broke support of HTTP_RAW_POST_DATA
113 * fixed: is_dir parameter of setCaCertificate() method is reversed
114 * fixed: a php warning in xmlrpc_client creator method
115 * fixed: parsing of '1e+1' as valid float
116 * fixed: allow errorlevel 3 to work when prev. error handler was a static method
117 * fixed: usage of client::setcookie() for multiple cookies in non-ssl mode
118 * improved: support for CP1252 charset is not part or the library but almost possible
119 * improved: more info when curl is enabled and debug mode is on
122 XML-RPC for PHP version 2.2 - 2007/02/25
124 This release corrects a couple of bugs and adds a few minor features.
126 * fixed: debugger errors on php installs with magic_quotes_gpc on
127 * fixed: support for https connections via proxy
128 * fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects
129 * improved: slightly faster encoding of data which is internally UTF-8
130 * improved: debugger always generates a 'null' id for jsonrpc if user omits it
131 * new: debugger can take advantage of a graphical value builder
132 (it has to be downloaded separately, as part of jsxmlrpc package)
133 * new: support for the <NIL/> xmlrpc extension
134 * new: server support for the system.getCapabilities xmlrpc extension
135 * new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault
138 XML-RPC for PHP version 2.1 - 2006/08/28
140 This release corrects quite a few bugs and adds some interesting new features.
141 There is a minor security enhancement and overall speedup too.
143 It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.
144 Please note that 404pl1 is NOT supported, and has not been since 2.0.
146 *** PLEASE READ CAREFULLY BELOW ***
148 CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:
150 The wrap_php_function and wrap_xmlrpc_method functions have been moved out of
151 the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.
152 You will have to include() / require() it in your scripts if you have been using
155 For increased security, the automatic rebuilding of php object instances out of
156 received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be
157 optionally reenabled).
159 The constructor of xmlrpcval() values has seen major changes, and it will not
160 throw a php warning anymore when invoked using an unknown xmlrpc type: the
161 error will only be written to php error log. Also new xmlrpcval('true', 'boolean')
162 is not supported anymore.
166 The new function php_xmlrpc_decode_xml() will take the xml representation of
167 either an xmlrpc request, response or single value and return the corresponding
168 php-xmlrpc object instance.
170 Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more
171 options to fine tune their behaviour, including one to return the php code to
172 be saved and later used as standalone php script.
174 A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the
175 methods exposed by a remote xmlrpc server into a php class.
177 Lib internals have been modified to provide better support for grafting extra
178 functionality on top of it. Stay tuned for future releases of the EXTRAS package.
180 Last but not least a new file has been added: verify_compat.php, to help users
181 diagnose the level of compliance of the current php install with the library.
185 * fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80
186 * fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_
187 * fixed bug: wrong handling of 'deflate' http encoding, both server and client side
188 * fixed bug: sending compressed responses when php output compression is enabled was not working
189 * fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values
190 * fixed bug: non-ascii chars used in struct element names where not being encoded correctly
191 * restored compatibility with php 4.0.5 (for those poor souls still stuck on it)
192 * server->service() now returns either the payload or xmlrpcresp instance
193 * server->add_to_map() now accepts methods with no param definitions
194 * added new function: php_xmlrpc_decode_xml()
195 * added new function: wrap_xmlrpc_server()
196 * major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()
197 * documentation for single parameters of exposed methods can be added to the dispatch map
198 (and turned into html docs in conjunction with a future release of the extras package)
199 * full response payload is saved into xmlrpcresp object for further debugging
200 * stricter parsing of incoming xmlrpc messages: two more invalid cases are now detected
201 (double data element inside array and struct/array after scalar inside value element)
202 * debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)
203 * debugger has better support for being activated via a single GET call (for integration into other tools?)
204 * more logging of errors in a lot of situations
205 * javadoc documentation of lib files almost complete
206 * the usual amount of new testcases in the testsuite
207 * many performance tweaks and code cleanups
208 * added foundation for emulating the API of the xmlrpc extension (extras package needed)
211 XML-RPC for PHP version 2.0 - 2006/04/24
213 I'm pleased to announce XML-RPC for PHP version 2.0, final.
215 With respect to the last release candidate, this release corrects a few small
216 bugs and adds a couple of new features: more authentication options (digest and
217 ntlm for servers, ntlm for proxies, and some https custom certificates stuff);
218 all the examples have been reviewed and some demo files added,
219 including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc
220 client is a browser); the server logs more warning messages for incorrect situations;
221 both client and server are more tolerant of commonly-found mistakes.
222 The debugger has been upgraded to reflect the new client capabilities.
226 * fixed bug: method xmlrpcval::structmemexists($value) would not work
227 * fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that
228 has return_type=phpvals
229 * fixed bug: in case of call to client::multicall without fallback and server error
230 * fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset
231 * fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii
232 chars where found when decoding
233 * new: client can use NTLM and Digest authentication methods for https and http 1.1
234 connections; authentication to proxy can be set to NTLM, too
235 * new: server tolerates user functions returning a single xmlrpcval object instead
237 * new: server does more checks for presence and correct return type of user
238 coded method handling functions, and logs inconsistencies to php error log
239 * new: client method SetCaCertificate($cert, $is_dir) to validate server against
240 * new: both server and client tolerate receiving 'true' and 'false' for bool values
241 (which btw are not valid according to the xmlrpc spec)
244 XML-RPC for PHP version 2.0RC3 - 2006/01/22
246 This release corrects a few bugs and adds some interesting new features.
247 It has been tested with PHP up to 4.4.2 and 5.1.2.
249 * fixed bug: server not recognizing clients that declare support for http compression
250 * fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding
252 * fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce
254 * new: let the server accept 'class::method' syntax in the dispatch map
255 * new: php_xmlrpc_decode() can decode xmlrpcmessage objects
256 * new: both client and server can specify a charset to be used for serializing
257 values instead of the default 'US-ASCII+xml-entities-for-other-characters'.
258 Values allowed: ISO-8859-1 and UTF-8
259 * new: the server object can register 'plain' php functions instead of functions
260 that accept a single parameter of type xmlrpcmsg. Faster, uses less memory
261 (but comes with minor drawbacks as well, read the manual for more details)
262 * new: client::setDebug(2) can be used to have the request payload printed to
263 screen before being sent
264 * new: server::service($data) lets user parse data other than POST body, for
265 easier testing / subclassing
266 * changed: framework-generated debug messages are sent back by the server base64
267 encoded, to avoid any charset/xml compatibility problem
270 The usual refactoring of a lot of (private) methods has taken place, with new
271 parameters added to some functions.
272 Javadoc documentation has been improved a lot.
273 The HTML documentation has been shuffled around a bit, hoping to give it a more
274 logical organization.
276 The experimental support for the JSON protocol has been removed, and will be
277 packaged as a separate download with some extra very interesting stuff (human
278 readable auto-generated documentation, anyone?).
281 XML-RPC for PHP version 2.0RC2 - 2005/11/22
283 This release corrects a few bugs and adds basically one new method for better
286 * fixed two bugs that prevented xmlrpc calls to take place over https
287 * fixed two bugs that prevented proper recognition of xml character set
288 when it was declared inside the xml prologue
289 * added xmlrpc_client::setKey($key, $keypass) method, to allow using client
290 side certificates for https connections
291 * fixed bug that prevented proper serialization of string xmlrpcvals when
292 $xmlrpc_internalencoding was set to UTF-8
293 * fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)
294 * correctly set cookies/http headers into xmlrpcresp objects even when the
295 send() method call fails for some reason
296 * added a benchmark file in the testsuite directory
298 A couple of (private/protected) methods have been refactored, as well as a
299 couple of extra parameters added to some (private) functions - this has no
300 impact on the public API and should be of interest primarily to people extending
301 / subclassing the lib.
303 There is also new, PARTIAL support for the JSON-RPC protocol, implemented in
304 two files in the extras dir (more info about json-rpc at http://json-rpc.org)
307 XML-RPC for PHP version 2.0RC1 - 2005/10/03
309 I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.
311 This release introduces so many new features it is almost impossible to list them
312 here, making the library finally on pair with, if not more advanced than, any other
313 similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).
314 No, really, trust me.
316 The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of
317 a couple of compatibility classes (code taken from PEAR php_compat package).
319 The placement of files and directories in the distribution has been deeply modified,
320 in the hope of making it more clear, now that the file count has increased.
321 I hope you find it easy.
323 Support for "advanced" HTTP features such as cookies, proxies and keep-alives has
326 It is now much easier to convert between xmlrpcval objects and php values, and
327 in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods
328 for all cases, except when encoding base64 data.
330 Two new (experimental) functions have been added, allowing automagic conversion
331 of a php function into an xmlrpc method to be exposed and vice-versa.
333 PHP objects can be now automatically serialized as xmlrpc struct values and
334 correctly deserialized on the other end of the transmission, provided that the
335 same class definition is present on both sides and no object members are of
338 A lot of the existing class methods have been overloaded with extra parameters
339 or new functionality, and a few added ex-novo, making usage easier than ever.
341 A complete debugger solution is included in the distribution. It needs a web server
342 to run (a freely available version of the same debugger is accessible online, it
343 can be found at http://phpxmlrpc.sourceforge.net).
345 For a more detailed list of changes, please read carefully chapter 2 of the
346 included documentation, or, even better, take a look at the source code, which
347 is commented in javadoc style quite a bit.
350 XML-RPC for PHP version 1.2 - 2005/08/14
352 This removes all use of eval(), which is a potential security problem.
353 All users are encouraged to upgrade as soon as possible.
354 As of this release we are no longer php3-compatible.
357 XML-RPC for PHP version 1.1.1 - 2005/06/30
359 This is a security vulnerability fix release.
360 All users are invited to upgrade as soon as possible.
363 XML-RPC for PHP version 1.1 - 2005/05/03
365 I'm pleased to announce XML-RPC for PHP version 1.1
366 It's taken two years to get to the this point, but here we are, finally.
368 This is a bugfix and maintenance release. No major new features have been added.
369 All known bugs have been ironed out, unless fixing would have meant breaking
371 The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main
372 development platform (and some warnings will be emitted when running PHP5).
374 Noteworthy changes include:
376 * do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5
377 * fixed the unicode/charset problems that have been plaguing the lib for years
378 * proper parsing of int and float values prepended with zeroes or the '+' char
379 * accept float values in exponential notation
380 * configurable http user-agent string
381 * use the same timeout on client socket reads as used for connecting
382 * more explicative error messages in xmlrpcresponse in many cases
383 * much more tolerant parsing of malformed http responses from xmlrpc servers
384 * fixed memleak that prevented the client to be used in never-ending scripts
385 * parse bigger xmlrpc messages without crashing (1MB in size or more)
386 * be tolerant to xmlrpc responses generated on public servers that add
387 javascript advertising at the end of hosted content
388 * the lib generates quite a few less PHP warnings during standard operation
390 This is the last release that will support PHP 3.
391 The next release will include better support for PHP 5 and (possibly) a slew of
394 The changelog is available at:
395 http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup
397 Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project
398 pages at http://sourceforge.net/projects/phpxmlrpc/
401 XML-RPC for PHP version 1.0
403 I'm pleased to announce XML-RPC for PHP version 1.0 (final). It's taken
404 two years to get to the 1.0 point, but here we are, finally. The major change
405 is re-licensing with the BSD open source license, a move from the custom
406 license previously used.
408 After this release I expect to move the project to SourceForge and find
409 another primary maintainer for the code. More details will follow to the
412 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
414 Comprehensive documentation is available in the distribution, but you
415 can also browse it at http://xmlrpc.usefulinc.com/doc/
417 Bugfixes in this release include:
419 * Small fixes and tidying up.
421 New features include:
423 * experimental support for SSL via the curl extensions to PHP. Needs
424 PHP 4.0.2 or greater, but not PHP 4.0.6 which has broken SSL support.
426 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
428 Please report bugs to the XML-RPC PHP mailing list, of which more details are
429 available at http://xmlrpc.usefulinc.com/list.html, or to
430 <xmlrpc@usefulinc.com>.
433 XML-RPC for PHP version 1.0 beta 9
435 I'm pleased to announce XML-RPC for PHP version 1.0 beta 9. This is
436 is largely a bugfix release.
438 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
440 Comprehensive documentation is available in the distribution, but you
441 can also browse it at http://xmlrpc.usefulinc.com/doc/
443 Bugfixes in this release include:
445 * Fixed string handling bug where characters between a </string>
446 and </value> tag were not ignored.
448 * Added in support for PHP's native boolean type.
450 New features include:
452 * new getval() method (experimental only) which has support for
453 recreating nested arrays.
454 * fledgling unit test suite
455 * server.php has support for basic interop test suite
457 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
459 Please test this as hard as possible and report bugs to the XML-RPC PHP
460 mailing list, of which more details are available at
461 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
464 XML-RPC for PHP version 1.0 beta 8
466 I'm pleased to announce XML-RPC for PHP version 1.0 beta 8.
468 This release fixes several bugs and adds a couple of new helper
469 functions. The most critical change in this release is that you can no
470 longer print debug info in comments inside a server method -- you must
471 now use the new xmlrpc_debugmsg() function.
473 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
475 Comprehensive documentation is available in the distribution, but you
476 can also browse it at http://xmlrpc.usefulinc.com/doc/
478 Bugfixes in this release include:
480 * fixed whitespace handling in values
481 * correct sending of Content-length from the server
483 New features include:
485 * xmlrpc_debugmsg() method allows sending of debug info in comments in
486 the return payload from a server
488 * xmlrpc_encode() and xmlrpc_decode() translate between xmlrpcval
489 objects and PHP language arrays. They aren't suitable for all
490 datatypes, but can speed up coding in simple scenarios. Thanks to Dan
493 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
495 Please test this as hard as possible and report bugs to the XML-RPC PHP
496 mailing list, of which more details are available at
497 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
500 XML-RPC for PHP version 1.0 beta 7
502 I'm pleased to announce XML-RPC for PHP version 1.0 beta 7. This is
503 fixes some critical bugs that crept in. If it shows itself to be stable
504 then it'll become the 1.0 release.
506 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
508 Comprehensive documentation is available in the distribution, but you
509 can also browse it at http://xmlrpc.usefulinc.com/doc/
511 Bugfixes in this release include:
513 * Passing of booleans should now work as expected
514 * Dollar signs and backslashes in strings should pass OK
515 * addScalar() now works properly to append to array vals
517 New features include:
519 * Added support for HTTP Basic authorization through the
520 xmlrpc_client::setCredentials method.
522 * Added test script and method for verifying correct passing of
525 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
527 Please test this as hard as possible and report bugs to the XML-RPC PHP
528 mailing list, of which more details are available at
529 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
532 XML-RPC for PHP version 1.0 beta 6
534 I'm pleased to announce XML-RPC for PHP version 1.0 beta 6. This is the
535 final beta before the 1.0 release.
537 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
539 Comprehensive documentation is available in the distribution, but you
540 can also browse it at http://xmlrpc.usefulinc.com/doc/
542 New features in this release include:
544 * Perl and Python test programs for the demo server
545 * Proper fault generation on a non-"200 OK" response from a remote host
546 * Bugfixed base64 decoding
547 * ISO8601 helper routines for translation to and from UNIX timestamps
548 * reorganization of code to allow eventual integration of alternative
551 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
553 Please test this as hard as possible and report bugs to the XML-RPC PHP
554 mailing list, of which more details are available at
555 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.