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