wip revive and split off doc generatin toolchain
[plcapi.git] / NEWS
1 XML-RPC for PHP version 4.6.0 - 2021/12/9
2
3 * fixed: compatibility with php 8.1
4
5 * improved: when encoding utf8 text into us-ascii xml, use character entity references for characters number 0-31
6   (ascii non printable characters), as we were already doing when encoding iso-8859-1 text into us-ascii xml
7
8 * new: method `Server::getDispatchMap()`. Useful for non-child classes which want to f.e. introspect the server
9
10 * new: increase flexibility in class composition by adopting a Dependency Injection (...ish) pattern:
11   it is now possible to swap out the Logger, XMLParser and Charset classes with similar ones of your own making.
12   Example code:
13       // 1. create an instance of a custom character encoder
14       // $myCharsetEncoder = ...
15       // 2. then use it while serializing a Request:
16       Request::setCharsetEncoder($myCharsetEncoder);
17       $request->serialize($funkyCharset);
18
19 * new: method `XMLParser::parse()` acquired a 4th argument
20
21 * new: method `Wrapper::wrapPhpClass` allows to customize the names of the phpxmlrpc methods by stripping the original
22   class name and accompanying namespace and replace it with a user-defined prefix, via option `replace_class_name`
23
24 * new: `Response` constructor gained a 4th argument
25
26 * deprecated: properties `Response::hdrs`, `Response::_cookies`, `Response::raw_data`. Use `Response::httpResponse()` instead.
27   That method returns an array which also holds the http response's status code - useful in case of http errors.
28
29 * deprecated: method `Request::createPayload`. Use `Request::serialize` instead
30
31 * deprecated: property `Request::httpResponse`
32
33 * improved: `Http::parseResponseHeaders` now throws a more specific exception in case of http errors
34
35 * improved: Continuous Integration is now running on Github Actions instead of Travis
36
37
38 XML-RPC for PHP version 4.5.2 - 2021/1/11
39
40 * improved: better phpdocs in the the php code generated by the Wrapper class
41
42 * improved: debugger favicon and page title when used from the phpjsonrpc library
43
44 * fixed: allow `Encoder::decode` to properly support different target character sets for polyfill-xmlrpc decode functions
45
46 * improved: allow usage of 'epivals' for the 'parameters_type' member of methods definitions in the Server dispatch map
47
48
49 XML-RPC for PHP version 4.5.1 - 2021/1/3
50
51 * improved: made it easier to subclass the Helper\Charset class by allowing `instance` to use late static binding
52
53 * fixed: reinstated access to xmlrpc_server->dmap (for users of the v3 API)
54
55 * fixed: method `xmlrpc_encode_entitites` (for users of the v3 API)
56
57 * improved: split the code of the demo server in multiple files, describing better the purpose of each
58
59
60 XML-RPC for PHP version 4.5.0 - 2020/12/31
61
62 * new: it is now possible to control the precision used when serializing DOUBLE values via usage of
63   `PhpXmlRpc::$xmlpc_double_precision`
64
65 * fixed: `Encoder::encode` would not correctly encode DateTime and DateTimeImmutable objects
66
67 * improvements to to the Helper\Date class in rejecting invalid date strings
68
69 * improvements to the Wrapper class in identifying required arguments types from source code phpdoc: support 'array[]',
70   'DateTime' and 'DateTimeImmutable'
71
72 * improvements to the support of the XMLRPC extension emulation (now provided by the phpxmlrpc/polyfill-xmlrpc package)
73
74 * minor improvements to the Charset helper: it now loads character set conversion  tables on demand, leading to
75   slightly lower memory usage and faster execution time when using UTF8 everywhere.
76   NB: take care if you have subclassed it!
77
78 * new method: `Server::isSyscall` - mostly of use to Server subclasses and friend classes such as introspectors
79
80 * internal method `XMLParser::xmlrpc_ee` now accepts 3 states for its 3rd parameter instead of a bool
81
82 * improvements in the inline phpdoc: tagged many methods and class member as reserved for internal usage only
83
84 * minor improvements in the debugger to allow easier integration of phpxmlrpc/jsonrpc and friends
85
86 * reorganized the test suite to be more manageable
87
88 * removed obsolete files from the 'extras' folder; updated and moved to the 'demo' folders the perl and python
89   client scripts; moved benchmark.php and verify_compat.php to the 'extras' folder
90
91
92 XML-RPC for PHP version 4.4.3 - 2020/12/17
93
94 * fixed: compatibility with PHP 8.0 (fixes to the debugger, to the server's 'system.methodHelp' method and to the
95   PhpXmlRpc\Wrapper class).
96   Note that method `Value::structeach` has not been removed from the API, but it is _not_ supported when running
97   on PHP 8.0 or later - in that case it will always throw an Error.
98
99 * improvements to the test stack: it is now possible to run it via Docker besides Travis; avoid using _any_ external
100   server when running tests; run Travis tests also on php 8.0; bump PHPUnit versions in use
101
102
103 XML-RPC for PHP version 4.4.2 - 2020/3/4
104
105 * fixed: `client->setCookie()` bug: cookie values that contain spaces are now properly encoded in a way that gets them
106   decoded back to spaces on the receiving end if the server running on php 7.4 (or does RFC-compliant cookie decoding).
107   Beforehand we were encoding spaces to '+' characters.
108
109
110 XML-RPC for PHP version 4.4.1 - 2019/7/29
111
112 * fixed: allow handling huge xml messages (>=10MB) (issue #71)
113
114 * improved: make it easier to overtake the library's usage of `error_log`
115
116
117 XML-RPC for PHP version 4.3.2 - 2019/5/27
118
119 * fixed: remove one php 7.2 warning when using the v3 api
120
121 * improved: the Travis tests are now run with all php versions from 5.6 to 7.3. We dropped tests with php 5.3, 5.4 and 5.5
122
123
124 XML-RPC for PHP version 4.3.1 - 2018/1/20
125
126 * fixed: error when using https in non-curl mode
127
128 * fixed: compatibility of tests with php 7.2
129
130 * fixed: html injection in sample code
131
132 * fixed: warnings emitted by the *legacy* server in xmlrpcs.inc
133
134 * fixed: encoding of php variables of type 'resource' when using xmlrpc_encode in php-compatibility mode
135
136 * fixed: bad html tag in sample code
137
138 * improved: text of error messages
139
140
141 XML-RPC for PHP version 4.3.0 - 2017/11/6
142
143 * fixed: compatibility with Basic/Digest/NTLM auth when using client in cURL mode (issue #58)
144
145 * improved: added unit tests for Basic and Digest http auth. Also improved tests suite
146
147 * new: allow to force usage of curl for http 1.0 calls, as well as plain socket for https calls, via the method
148     `Client::setUseCurl()`
149
150
151 XML-RPC for PHP version 4.2.2 - 2017/10/15
152
153 * fixed: compatibility with Lighttpd target servers when using client in cURL mode and request body size > 1024 bytes (issue #56)
154
155
156 XML-RPC for PHP version 4.2.1 - 2017/9/3
157
158 * fixed: compatibility with php 7.2 (issue #55)
159
160
161 XML-RPC for PHP version 4.2.0 - 2017/6/30
162
163 * improved: allow also DateTimeImmutable objects to be detected as a date when encoding
164
165
166 XML-RPC for PHP version 4.1.1 - 2016/10/1
167
168 * fixed: error in server class: undefined function php_xmlrpc_encode (only triggered when not using the compatibility
169     shim with old versions)
170
171
172 XML-RPC for PHP version 4.1.0 - 2016/6/26
173
174 * improved: Added support for receiving <I8> and <EX:I8> integers, sending <I8>
175
176     If php is compiled in 32 bit mode, and an i8 int is received from a 3rd party, and error will be emitted.
177     Integers sent from the library to 3rd parties can be encoded using the i8 tag, but default to using 'int' by default;
178     the developer will have to create values as i8 explicitly if needed.
179     The library does *not* check if an outgoing integer is too big to fit in 4 bytes and convert it to an i8 automatically.
180
181
182 XML-RPC for PHP version 4.0.1 - 2016/3/27
183
184 * improved: all of the API documentation has been moved out of the manual and into the source code phpdoc comments
185
186 * fixed: when the internal character set is set to UTF-8 and the client sends requests (or the server responses), too
187   many characters were encoded as numeric entities, whereas some, like åäö, needed not not be
188
189 * fixed: the 'valtyp' property of Response was not present in all cases; the ValType property had been added by error
190   and has been removed
191
192
193 XML-RPC for PHP version 4.0.0 - 2016/1/20
194
195 This release does away with the past and starts a transition to modern-world php.
196
197 Code has been heavily refactored, taking care to preserve backwards compatibility as much as possible,
198 but some breackage is to be expected.
199
200 The minimum required php version has been increased to 5.3, even though we strongly urge you to use
201 more recent versions.
202
203 PLEASE READ CAREFULLY THE NOTES BELOW to insure a smooth upgrade.
204
205 * new: introduction of namespaces and full OOP.
206
207   All php classes have been renamed and moved to separate files.
208   Class autoloading can now be done in accord with the PSR-4 standard.
209   All global variables and global functions have been removed.
210   Iterating over xmlrpc value objects is now easier thank to support for ArrayAccess and Traversable interfaces.
211
212   Backward compatibility is maintained via lib/xmlrpc.inc, lib/xmlrpcs.inc and lib/xmlrpc_wrappers.inc.
213   For more details, head on to doc/api_changes_v4.md
214
215 * changed: the default character encoding delivered from the library to your code is now utf8.
216   It can be changed at any time setting a value to PhpXmlRpc\PhpXmlRpc::$xmlrpc_internalencoding
217
218 * improved: the library now accepts requests/responses sent using other character sets than UTF-8/ISO-8859-1/ASCII.
219   This only works when the mbstring php extension is enabled.
220
221 * improved: no need to call anymore $client->setSSLVerifyHost(2) to silence a curl warning when using https
222   with recent curl builds
223
224 * improved: the xmlrpcval class now supports the interfaces Countable and IteratorAggregate
225
226 * improved: a specific option allows users to decide the version of SSL to use for https calls.
227   This is useful f.e. for the testing suite, when the server target of calls has no proper ssl certificate,
228   and the cURL extension has been compiled with GnuTLS (such as on Travis VMs)
229
230 * improved: the function wrap_php_function() now can be used to wrap closures (it is now a method btw)
231
232 * improved: all wrap_something() functions now return a closure by default instead of a function name
233
234 * improved: debug messages are not html-escaped any more when executing from the command line
235
236 * improved: the library is now tested using Travis ( https://travis-ci.org/ ).
237   Tests are executed using all php versions from 5.3 to 7.2; code-coverage information
238   is generated using php 5.6 and uploaded to both Code Coverage and Scrutinizer online services
239
240 * improved: phpunit is now installed via composer, not bundled anymore
241
242 * improved: when phpunit is used to generate code-coverage data, the code executed server-side is accounted for
243
244 * improved: the test suite has basic checks for the debugger and demo files
245
246 * improved: more tests in the test suite
247
248 * fixed: the server would not reset the user-set debug messages between subsequent service() calls
249
250 * fixed: the server would not reset previous php error handlers when an exception was thrown by user code and
251   exception_handling set to 2
252
253 * fixed: the server would fail to decode a request with ISO-8859-1 payload and character set declaration in the xml
254   prolog only
255
256 * fixed: the client would fail to decode a response with ISO-8859-1 payload and character set declaration in the xml
257   prolog only
258
259 * fixed: the function decode_xml() would not decode an xml with character set declaration in the xml prolog
260
261 * fixed: the client can now successfully call methods using ISO-8859-1 or UTF-8 characters in their name
262
263 * fixed: the debugger would fail sending a request with ISO-8859-1 payload (it missed the character set declaration).
264   It would have a hard time coping with ISO-8859-1 in other fields, such as e.g. the remote method name
265
266 * fixed: the debugger would generate a bad payload via the 'load method synopsis' button for signatures containing NULL
267   or undefined parameters
268
269 * fixed: the debugger would generate a bad payload via the 'load method synopsis' button for methods with multiple
270   signatures
271
272 * improved: the debugger is displayed using UTF-8, making it more useful to debug any kind of service
273
274 * improved: echo all debug messages even when there are characters in them which php deems to be in a wrong encoding;
275   previously those messages would just disappear (this is visible e.g. in the debugger)
276
277 * changed: debug info handling
278     - at debug level 1, the rebuilt php objects are not dumped to screen (server-side already did that)
279     - at debug level 1, curl communication info are not dumped to screen
280     - at debug level 1, the tests echo payloads of failures; at debug level 2 all payloads
281
282 * improved: makefiles have been replaced with a php_based pakefile
283
284 * improved: the source for the manual is stored in asciidoc format, which can be displayed natively by GitHub
285   with nice html formatting. Also the HTML version generated by hand and bundled in tarballs is much nicer
286   to look at than previous versions
287
288 * improved: all php code is now formatted according to the PSR-2 standard
289
290
291 XML-RPC for PHP version 3.0.0 - 2014/6/15
292
293 This release corrects all bugs that have been reported and successfully reproduced since
294 version 3.0.0 beta.
295
296 The requirements have increased to php 5.1.0 - which is still way older than what you should be running for any serious
297 purpose, really.
298
299 It also is the first release to be installable via composer.
300
301 See the Changelog file or the pdf docs for a complete list of changes.
302
303
304 XML-RPC for PHP version 3.0.0 beta - 2009/09/05
305
306 This is the first release of the library to only support PHP 5.
307 Some legacy code has been removed, and support for features such as exceptions
308 and dateTime objects introduced.
309
310 The "beta" tag is meant to indicate the fact that the refactoring has been more widespread
311 than in precedent releases and that more changes are likely to be introduced with time -
312 the library is still considered to be production quality.
313
314 * improved: removed all usage of php functions deprecated in php 5.3, usage of assign-by-ref when creating new objects
315   etc...
316 * improved: add support for the <ex:nil/> tag used by the apache library, both in input and output
317 * improved: add support for dateTime objects in both in php_xmlrpc_encode and as parameter for constructor of xmlrpcval
318 * improved: add support for timestamps as parameter for constructor of xmlrpcval
319 * improved: add option 'dates_as_objects' to php_xmlrpc_decode to return dateTime objects for xmlrpc datetimes
320 * improved: add new method SetCurlOptions to xmrlpc_client to allow extra flexibility in tweaking http config, such as
321   explicitly binding to an ip address
322 * improved: add new method SetUserAgent to xmrlpc_client to to allow having different user-agent http headers
323 * improved: add a new member variable in server class to allow fine-tuning of the encoding of returned values when the
324   server is in 'phpvals' mode
325 * improved: allow servers in 'xmlrpcvals' mode to also register plain php functions by defining them in the dispatch map
326   with an added option
327 * improved: catch exceptions thrown during execution of php functions exposed as methods by the server
328 * fixed: bad encoding if same object is encoded twice using php_xmlrpc_encode
329
330
331 XML-RPC for PHP version 2.2.2 - 2009/03/16
332
333 This release corrects all bugs that have been reported and sucesfully reproduced since
334 version 2.2.1.
335 Regardless of the intimidating message about dropping PHP 4 support, it still does
336 support that ancient, broken and insecure platform.
337
338
339 * fixed: php warning when receiving 'false' in a bool value
340 * fixed: improve robustness of the debugger when parsing weird results from non-compliant servers
341 * fixed: format floating point values using the correct decimal separator even when php locale is set to one that uses
342   comma
343 * fixed: use feof() to test if socket connections are to be closed instead of the number of bytes read (rare bug when
344   communicating with some servers)
345 * fixed: be more tolerant in detection of charset in http headers
346 * fixed: fix encoding of UTF8 chars outside of the BMP plane
347 * fixed: fix detection of zlib.output_compression
348 * improved: allow the add_to_map server method to add docs for single params too
349 * improved: added the possibility to wrap for exposure as xmlrpc methods plain php class methods, object methods and
350   even whole classes
351
352
353 XML-RPC for PHP version 2.2.1 - 2008/03/06
354
355 This release corrects all bugs that have been reported and sucesfully reproduced.
356 It is the last release of the library that will support PHP 4.
357
358 * fixed: work around bug in php 5.2.2 which broke support of HTTP_RAW_POST_DATA
359 * fixed: is_dir parameter of setCaCertificate() method is reversed
360 * fixed: a php warning in xmlrpc_client creator method
361 * fixed: parsing of '1e+1' as valid float
362 * fixed: allow errorlevel 3 to work when prev. error handler was a static method
363 * fixed: usage of client::setcookie() for multiple cookies in non-ssl mode
364 * improved: support for CP1252 charset is not part or the library but almost possible
365 * improved: more info when curl is enabled and debug mode is on
366
367
368 XML-RPC for PHP version 2.2 - 2007/02/25
369
370 This release corrects a couple of bugs and adds a few minor features.
371
372 * fixed: debugger errors on php installs with magic_quotes_gpc on
373 * fixed: support for https connections via proxy
374 * fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects
375 * improved: slightly faster encoding of data which is internally UTF-8
376 * improved: debugger always generates a 'null' id for jsonrpc if user omits it
377 * new: debugger can take advantage of a graphical value builder
378   (it has to be downloaded separately, as part of jsxmlrpc package)
379 * new: support for the <NIL/> xmlrpc extension
380 * new: server support for the system.getCapabilities xmlrpc extension
381 * new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault
382
383
384 XML-RPC for PHP version 2.1 - 2006/08/28
385
386 This release corrects quite a few bugs and adds some interesting new features.
387 There is a minor security enhancement and overall speedup too.
388
389 It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.
390 Please note that 404pl1 is NOT supported, and has not been since 2.0.
391
392 *** PLEASE READ CAREFULLY BELOW ***
393
394 CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:
395
396 The wrap_php_function and wrap_xmlrpc_method functions have been moved out of
397 the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.
398 You will have to include() / require() it in your scripts if you have been using
399 those functions.
400
401 For increased security, the automatic rebuilding of php object instances out of
402 received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be
403 optionally reenabled).
404
405 The constructor of xmlrpcval() values has seen major changes, and it will not
406 throw a php warning anymore when invoked using an unknown xmlrpc type: the
407 error will only be written to php error log. Also new xmlrpcval('true', 'boolean')
408 is not supported anymore.
409
410 MAJOR IMPROVEMENTS:
411
412 The new function php_xmlrpc_decode_xml() will take the xml representation of
413 either an xmlrpc request, response or single value and return the corresponding
414 php-xmlrpc object instance.
415
416 Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more
417 options to fine tune their behaviour, including one to return the php code to
418 be saved and later used as standalone php script.
419
420 A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the
421 methods exposed by a remote xmlrpc server into a php class.
422
423 Lib internals have been modified to provide better support for grafting extra
424 functionality on top of it. Stay tuned for future releases of the EXTRAS package.
425
426 Last but not least a new file has been added: verify_compat.php, to help users
427 diagnose the level of compliance of the current php install with the library.
428
429 CHANGELOG IN DETAIL:
430
431 * fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80
432 * fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_
433 * fixed bug: wrong handling of 'deflate' http encoding, both server and client side
434 * fixed bug: sending compressed responses when php output compression is enabled was not working
435 * fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values
436 * fixed bug: non-ascii chars used in struct element names where not being encoded correctly
437 * restored compatibility with php 4.0.5 (for those poor souls still stuck on it)
438 * server->service() now returns either the payload or xmlrpcresp instance
439 * server->add_to_map() now accepts methods with no param definitions
440 * added new function: php_xmlrpc_decode_xml()
441 * added new function: wrap_xmlrpc_server()
442 * major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()
443 * documentation for single parameters of exposed methods can be added to the dispatch map
444   (and turned into html docs in conjunction with a future release of the extras package)
445 * full response payload is saved into xmlrpcresp object for further debugging
446 * stricter parsing of incoming xmlrpc messages: two more invalid cases are now detected
447   (double data element inside array and struct/array after scalar inside value element)
448 * debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)
449 * debugger has better support for being activated via a single GET call (for integration into other tools?)
450 * more logging of errors in a lot of situations
451 * javadoc documentation of lib files almost complete
452 * the usual amount of new testcases in the testsuite
453 * many performance tweaks and code cleanups
454 * added foundation for emulating the API of the xmlrpc extension (extras package needed)
455
456
457 XML-RPC for PHP version 2.0 - 2006/04/24
458
459 I'm pleased to announce XML-RPC for PHP version 2.0, final.
460
461 With respect to the last release candidate, this release corrects a few small
462 bugs and adds a couple of new features: more authentication options (digest and
463 ntlm for servers, ntlm for proxies, and some https custom certificates stuff);
464 all the examples have been reviewed and some demo files added,
465 including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc
466 client is a browser); the server logs more warning messages for incorrect situations;
467 both client and server are more tolerant of commonly-found mistakes.
468 The debugger has been upgraded to reflect the new client capabilities.
469
470 In greater detail:
471
472 * fixed bug: method xmlrpcval::structmemexists($value) would not work
473 * fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that
474   has return_type=phpvals
475 * fixed bug: in case of call to client::multicall without fallback and server error
476 * fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset
477 * fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii
478   chars where found when decoding
479 * new: client can use NTLM and Digest authentication methods for https and http 1.1
480   connections; authentication to proxy can be set to NTLM, too
481 * new: server tolerates user functions returning a single xmlrpcval object instead
482   of an xmlrpcresp
483 * new: server does more checks for presence and correct return type of user
484   coded method handling functions, and logs inconsistencies to php error log
485 * new: client method SetCaCertificate($cert, $is_dir) to validate server against
486 * new: both server and client tolerate receiving 'true' and 'false' for bool values
487   (which btw are not valid according to the xmlrpc spec)
488
489
490 XML-RPC for PHP version 2.0RC3 - 2006/01/22
491
492 This release corrects a few bugs and adds some interesting new features.
493 It has been tested with PHP up to 4.4.2 and 5.1.2.
494
495 * fixed bug: server not recognizing clients that declare support for http compression
496 * fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding
497   set to UTF-8
498 * fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce
499   invalid xml-rpc
500 * new: let the server accept 'class::method' syntax in the dispatch map
501 * new: php_xmlrpc_decode() can decode xmlrpcmessage objects
502 * new: both client and server can specify a charset to be used for serializing
503   values instead of the default 'US-ASCII+xml-entities-for-other-characters'.
504   Values allowed: ISO-8859-1 and UTF-8
505 * new: the server object can register 'plain' php functions instead of functions
506   that accept a single parameter of type xmlrpcmsg. Faster, uses less memory
507   (but comes with minor drawbacks as well, read the manual for more details)
508 * new: client::setDebug(2) can be used to have the request payload printed to
509   screen before being sent
510 * new: server::service($data) lets user parse data other than POST body, for
511   easier testing / subclassing
512 * changed: framework-generated debug messages are sent back by the server base64
513   encoded, to avoid any charset/xml compatibility problem
514 * other minor fixes
515
516 The usual refactoring of a lot of (private) methods has taken place, with new
517 parameters added to some functions.
518 Javadoc documentation has been improved a lot.
519 The HTML documentation has been shuffled around a bit, hoping to give it a more
520 logical organization.
521
522 The experimental support for the JSON protocol has been removed, and will be
523 packaged as a separate download with some extra very interesting stuff (human
524 readable auto-generated documentation, anyone?).
525
526
527 XML-RPC for PHP version 2.0RC2 - 2005/11/22
528
529 This release corrects a few bugs and adds basically one new method for better
530 HTTPS support:
531
532  * fixed two bugs that prevented xmlrpc calls to take place over https
533  * fixed two bugs that prevented proper recognition of xml character set
534    when it was declared inside the xml prologue
535  * added xmlrpc_client::setKey($key, $keypass) method, to allow using client
536    side certificates for https connections
537  * fixed bug that prevented proper serialization of string xmlrpcvals when
538    $xmlrpc_internalencoding was set to UTF-8
539  * fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)
540  * correctly set cookies/http headers into xmlrpcresp objects even when the
541    send() method call fails for some reason
542  * added a benchmark file in the testsuite directory
543
544 A couple of (private/protected) methods have been refactored, as well as a
545 couple of extra parameters added to some (private) functions - this has no
546 impact on the public API and should be of interest primarily to people extending
547 / subclassing the lib.
548
549 There is also new, PARTIAL support for the JSON-RPC protocol, implemented in
550 two files in the extras dir (more info about json-rpc at http://json-rpc.org)
551
552
553 XML-RPC for PHP version 2.0RC1 - 2005/10/03
554
555 I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.
556
557 This release introduces so many new features it is almost impossible to list them
558 here, making the library finally on pair with, if not more advanced than, any other
559 similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).
560 No, really, trust me.
561
562 The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of
563 a couple of compatibility classes (code taken from PEAR php_compat package).
564
565 The placement of files and directories in the distribution has been deeply modified,
566 in the hope of making it more clear, now that the file count has increased.
567 I hope you find it easy.
568
569 Support for "advanced" HTTP features such as cookies, proxies and keep-alives has
570 been added at last.
571
572 It is now much easier to convert between xmlrpcval objects and php values, and
573 in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods
574 for all cases, except when encoding base64 data.
575
576 Two new (experimental) functions have been added, allowing automagic conversion
577 of a php function into an xmlrpc method to be exposed and vice-versa.
578
579 PHP objects can be now automatically serialized as xmlrpc struct values and
580 correctly deserialized on the other end of the transmission, provided that the
581 same class definition is present on both sides and no object members are of
582 type resource.
583
584 A lot of the existing class methods have been overloaded with extra parameters
585 or new functionality, and a few added ex-novo, making usage easier than ever.
586
587 A complete debugger solution is included in the distribution. It needs a web server
588 to run (a freely available version of the same debugger is accessible online, it
589 can be found at http://phpxmlrpc.sourceforge.net).
590
591 For a more detailed list of changes, please read carefully chapter 2 of the
592 included documentation, or, even better, take a look at the source code, which
593 is commented in javadoc style quite a bit.
594
595
596 XML-RPC for PHP version 1.2 - 2005/08/14
597
598 This removes all use of eval(), which is a potential security problem.
599 All users are encouraged to upgrade as soon as possible.
600 As of this release we are no longer php3-compatible.
601
602
603 XML-RPC for PHP version 1.1.1 - 2005/06/30
604
605 This is a security vulnerability fix release.
606 All users are invited to upgrade as soon as possible.
607
608
609 XML-RPC for PHP version 1.1 - 2005/05/03
610
611 I'm pleased to announce XML-RPC for PHP version 1.1
612 It's taken two years to get to the this point, but here we are, finally.
613
614 This is a bugfix and maintenance release. No major new features have been added.
615 All known bugs have been ironed out, unless fixing would have meant breaking
616 the API.
617 The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main
618 development platform (and some warnings will be emitted when running PHP5).
619
620 Noteworthy changes include:
621
622  * do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5
623  * fixed the unicode/charset problems that have been plaguing the lib for years
624  * proper parsing of int and float values prepended with zeroes or the '+' char
625  * accept float values in exponential notation
626  * configurable http user-agent string
627  * use the same timeout on client socket reads as used for connecting
628  * more explicative error messages in xmlrpcresponse in many cases
629  * much more tolerant parsing of malformed http responses from xmlrpc servers
630  * fixed memleak that prevented the client to be used in never-ending scripts
631  * parse bigger xmlrpc messages without crashing (1MB in size or more)
632  * be tolerant to xmlrpc responses generated on public servers that add
633    javascript advertising at the end of hosted content
634  * the lib generates quite a few less PHP warnings during standard operation
635
636 This is the last release that will support PHP 3.
637 The next release will include better support for PHP 5 and (possibly) a slew of
638 new features.
639
640 The changelog is available at:
641 http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup
642
643 Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project
644 pages at http://sourceforge.net/projects/phpxmlrpc/
645
646
647 XML-RPC for PHP version 1.0
648
649 I'm pleased to announce XML-RPC for PHP version 1.0 (final). It's taken
650 two years to get to the 1.0 point, but here we are, finally.  The major change
651 is re-licensing with the BSD open source license, a move from the custom
652 license previously used.
653
654 After this release I expect to move the project to SourceForge and find
655 another primary maintainer for the code.  More details will follow to the
656 mailing list.
657
658 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
659
660 Comprehensive documentation is available in the distribution, but you
661 can also browse it at http://xmlrpc.usefulinc.com/doc/
662
663 Bugfixes in this release include:
664
665  * Small fixes and tidying up.
666
667 New features include:
668
669  * experimental support for SSL via the curl extensions to PHP.  Needs
670    PHP 4.0.2 or greater, but not PHP 4.0.6 which has broken SSL support.
671
672 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
673
674 Please report bugs to the XML-RPC PHP mailing list, of which more details are
675 available at http://xmlrpc.usefulinc.com/list.html, or to
676 <xmlrpc@usefulinc.com>.
677
678
679 XML-RPC for PHP version 1.0 beta 9
680
681 I'm pleased to announce XML-RPC for PHP version 1.0 beta 9. This is
682 is largely a bugfix release.
683
684 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
685
686 Comprehensive documentation is available in the distribution, but you
687 can also browse it at http://xmlrpc.usefulinc.com/doc/
688
689 Bugfixes in this release include:
690
691  * Fixed string handling bug where characters between a </string>
692    and </value> tag were not ignored.
693
694  * Added in support for PHP's native boolean type.
695
696 New features include:
697
698  * new getval() method (experimental only) which has support for
699    recreating nested arrays.
700  * fledgling unit test suite
701  * server.php has support for basic interop test suite
702
703 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
704
705 Please test this as hard as possible and report bugs to the XML-RPC PHP
706 mailing list, of which more details are available at
707 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
708
709
710 XML-RPC for PHP version 1.0 beta 8
711
712 I'm pleased to announce XML-RPC for PHP version 1.0 beta 8.
713
714 This release fixes several bugs and adds a couple of new helper
715 functions. The most critical change in this release is that you can no
716 longer print debug info in comments inside a server method -- you must
717 now use the new xmlrpc_debugmsg() function.
718
719 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
720
721 Comprehensive documentation is available in the distribution, but you
722 can also browse it at http://xmlrpc.usefulinc.com/doc/
723
724 Bugfixes in this release include:
725
726  * fixed whitespace handling in values
727  * correct sending of Content-length from the server
728
729 New features include:
730
731  * xmlrpc_debugmsg() method allows sending of debug info in comments in
732    the return payload from a server
733
734  * xmlrpc_encode() and xmlrpc_decode() translate between xmlrpcval
735    objects and PHP language arrays. They aren't suitable for all
736    datatypes, but can speed up coding in simple scenarios. Thanks to Dan
737    Libby for these.
738
739 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
740
741 Please test this as hard as possible and report bugs to the XML-RPC PHP
742 mailing list, of which more details are available at
743 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
744
745
746 XML-RPC for PHP version 1.0 beta 7
747
748 I'm pleased to announce XML-RPC for PHP version 1.0 beta 7. This is
749 fixes some critical bugs that crept in. If it shows itself to be stable
750 then it'll become the 1.0 release.
751
752 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
753
754 Comprehensive documentation is available in the distribution, but you
755 can also browse it at http://xmlrpc.usefulinc.com/doc/
756
757 Bugfixes in this release include:
758
759  * Passing of booleans should now work as expected
760  * Dollar signs and backslashes in strings should pass OK
761  * addScalar() now works properly to append to array vals
762
763 New features include:
764
765  * Added support for HTTP Basic authorization through the
766    xmlrpc_client::setCredentials method.
767
768  * Added test script and method for verifying correct passing of
769    booleans
770
771 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
772
773 Please test this as hard as possible and report bugs to the XML-RPC PHP
774 mailing list, of which more details are available at
775 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.
776
777
778 XML-RPC for PHP version 1.0 beta 6
779
780 I'm pleased to announce XML-RPC for PHP version 1.0 beta 6. This is the
781 final beta before the 1.0 release.
782
783 It can be downloaded from http://xmlrpc.usefulinc.com/php.html
784
785 Comprehensive documentation is available in the distribution, but you
786 can also browse it at http://xmlrpc.usefulinc.com/doc/
787
788 New features in this release include:
789
790  * Perl and Python test programs for the demo server
791  * Proper fault generation on a non-"200 OK" response from a remote host
792  * Bugfixed base64 decoding
793  * ISO8601 helper routines for translation to and from UNIX timestamps
794  * reorganization of code to allow eventual integration of alternative
795    transports
796
797 The changelog is available at: http://xmlrpc.usefulinc.com/ChangeLog.txt
798
799 Please test this as hard as possible and report bugs to the XML-RPC PHP
800 mailing list, of which more details are available at
801 http://xmlrpc.usefulinc.com/list.html, or to <xmlrpc@usefulinc.com>.