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