- fix year in copyrights notices

[plcapi.git] / NEWS

XML-RPC for PHP version 2.2.2 - 2009/03/16\r
\r
This release corrects all bugs that have been reported and sucesfully reproduced since\r
version 2.2.1.\r
Regardless of the intimitading message about dropping PHP 4 support, it still does\r
support that ancient, broken and insecure platform.\r
\r
* fixed: php warning when receiving 'false' in a bool value\r
* fixed: improve robustness of the debugger when parsing weird results from non-compliant servers\r
* fixed: format floating point values using the correct decimal separator even when php locale is set to one that uses comma\r
* 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)\r
* fixed: be more tolerant in detection of charset in http headers\r
* fixed: fix encoding of UTF8 chars outside of the BMP plane\r
* fixed: fix detection of zlib.output_compression\r
* improved: allow the add_to_map server method to add docs for single params too\r
* improved: added the possibility to wrap for exposure as xmlrpc        methods plain php class methods, object methods and even whole classes\r
\r
\r
XML-RPC for PHP version 2.2.1 - 2008/03/06\r
\r
This release corrects all bugs that have been reported and sucesfully reproduced.\r
It is the last release of the library that will support PHP 4.\r
\r
* fixed: work aroung bug in php 5.2.2 which broke support of HTTP_RAW_POST_DATA\r
* fixed: is_dir parameter of setCaCertificate() method is reversed\r
* fixed: a php warning in xmlrpc_client creator method\r
* fixed: parsing of '1e+1' as valid float\r
* fixed: allow errorlevel 3 to work when prev. error handler was a static method\r
* fixed: usage of client::setcookie() for multiple cookies in non-ssl mode\r
* improved: support for CP1252 charset is not part or the library but almost possible\r
* improved: more info when curl is enabled and debug mode is on\r
\r
\r
XML-RPC for PHP version 2.2 - 2007/02/25\r
\r
This release corrects a couple of bugs and adds a few minor features.\r
\r
* fixed: debugger errors on php installs with magic_quotes_gpc on\r
* fixed: support for https connections via proxy\r
* fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects\r
* improved: slightly faster encoding of data which is internally UTF-8\r
* improved: debugger always generates a 'null' id for jsonrpc if user omits it\r
* new: debugger can take advantage of a graphical value builder\r
  (it has to be downloaded separately, as part of jsxmlrpc package)\r
* new: support for the <NIL/> xmlrpc extension\r
* new: server support for the system.getCapabilities xmlrpc extension\r
* new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault\r
\r
\r
XML-RPC for PHP version 2.1 - 2006/08/28\r
\r
This release corrects quite a few bugs and adds some interesting new features.\r
There is a minor security enhancement and overall speedup too.\r
\r
It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.\r
Please note that 404pl1 is NOT supported, and has not been since 2.0.\r
\r
*** PLASE READ CAREFULLY BELOW ***\r
\r
CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:\r
\r
The wrap_php_function and wrap_xmlrpc_method functions have been moved out of\r
the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.\r
You will have to include() / require() it in your scripts if you have been using\r
those functions.\r
\r
For increased security, the automatic rebuilding of php object instances out of\r
received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be\r
optionally reenabled).\r
\r
The constructor of xmlrpcval() values has seen major changes, and it will not\r
throw a php warning anymore when invoked using an unknown xmlrpc type: the\r
error will only be written to php error log. Also new xmlrpcval('true', 'boolean')\r
is not supported anymore.\r
\r
MAJOR IMPROVEMENTS:\r
\r
The new function php_xmlrpc_decode_xml() will take the xml representation of\r
either an xmlrpc request, response or single value and return the corresponding\r
php-xmlrpc object instance.\r
\r
Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more\r
options to fine tune their behaviour, including one to return the php code to\r
be saved and later used as standalone php script.\r
\r
A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the\r
methods exposed by a remote xmlrpc server into a php class.\r
\r
Lib internals have been modified to provide better support for grafting extra\r
functionality on top of it. Stay tuned for future releases of the EXTRAS package.\r
\r
Last but not least a new file has been added: verify_compat.php, to help users\r
diagnose the level of compliance of the current php install with the library.\r
\r
CHANGELOG IN DETAIL:\r
\r
* fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80\r
* fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_\r
* fixed bug: wrong handling of 'deflate' http encoding, both server and client side\r
* fixed bug: sending compressed responses when php output compression is enabled was not working\r
* fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values\r
* fixed bug: non-ascii chars used in struct element names where not being encoded correctly\r
* restored compatibility with php 4.0.5 (for those poor souls still stuck on it)\r
* server->service() now returns either the payload or xmlrpcresp instance\r
* server->add_to_map() now accepts methods with no param definitions\r
* added new function: php_xmlrpc_decode_xml()\r
* added new function: wrap_xmlrpc_server()\r
* major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()\r
* documentation for single parameters of exposed methods can be added to the dispatch map\r
  (and turned into html docs in conjunction with a future release of the extras package)\r
* full response payload is saved into xmlrpcresp object for further debugging\r
* stricter parsing of incmoing xmlrpc messages: two more invalid cases are now detected\r
  (double data element inside array and struct/array after scalar inside value element)\r
* debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)\r
* debugger has better support for being activated via a single GET call (for integration into other tools?)\r
* more logging of errors in a lot of situations\r
* javadoc documentation of lib files almost complete\r
* the usual amount of new testcases in the testsuite\r
* many performance tweaks and code cleanups\r
* added foundation for emulating the API of the xmlrpc extension (extras package needed)\r
\r
\r
XML-RPC for PHP version 2.0 - 2006/04/24\r
\r
I'm pleased to announce XML-RPC for PHP version 2.0, final.\r
\r
With respect to the last release candidate, this release corrects a few small\r
bugs and adds a couple of new features: more authentication options (digest and\r
ntlm for servers, ntlm for proxies, and some https custom certificates stuff);\r
all the examples have been reviewed and some demo files added,\r
including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc\r
client is a browser); the server logs more warning messages for incorrect situations;\r
both client and server are more tolerant of commonly-found mistakes.\r
The debugger has been upgraded to reflect the new client capabilities.\r
\r
In greater detail:\r
\r
* fixed bug: method xmlrpcval::structmemexists($value) would not work\r
* fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that\r
  has return_type=phpvals\r
* fixed bug: in case of call to client::multicall without fallback and server error\r
* fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset\r
* fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii\r
  chars where found when decoding\r
* new: client can use NTLM and Digest authentication methods for https and http 1.1\r
  connections; authentication to proxy can be set to NTLM, too\r
* new: server tolerates user functions returning a single xmlrpcval object instead\r
  of an xmlrpcresp\r
* new: server does more checks for presence and correct return type of user\r
  coded method handling functions, and logs inconsistencies to php error log\r
* new: client method SetCaCertificate($cert, $is_dir) to validate server against\r
* new: both server and client tolerate receiving 'true' and 'false' for bool values\r
  (which btw are not valid according to the xmlrpc spec)\r
\r
\r
XML-RPC for PHP version 2.0RC3 - 2006/01/22\r
\r
This release corrects a few bugs and adds some interesting new features.\r
It has been tested with PHP up to 4.4.2 and 5.1.2.\r
\r
* fixed bug: server not recognizing clients that declare support for http compression\r
* fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding\r
  set to UTF-8\r
* fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce\r
  invalid xml-rpc\r
* new: let the server accept 'class::method' syntax in the dispatch map\r
* new: php_xmlrpc_decode() can decode xmlrpcmessage objects\r
* new: both client and server can specify a charset to be used for serializing\r
  values instead of the default 'US-ASCII+xml-entities-for-other-characters'.\r
  Values allowed: ISO-8859-1 and UTF-8\r
* new: the server object can register 'plain' php functions instead of functions\r
  that accept a single parameter of type xmlrpcmsg. Faster, uses less memory\r
  (but comes with minor drawbacks as well, read the manual for more details)\r
* new: client::setDebug(2) can be used to have the request payload printed to\r
  screen before being sent\r
* new: server::service($data) lets user parse data other than POST body, for\r
  easier testing / subclassing\r
* changed: framework-generated debug messages are sent back by the server base64\r
  encoded, to avoid any charset/xml compatibility problem\r
* other minor fixes\r
\r
The usual refactoring of a lot of (private) methods has taken place, with new\r
parameters added to some functions.\r
Javadoc documentation has been improved a lot.\r
The HTML documentation has been shuffled around a bit, hoping to give it a more\r
logical organization.\r
\r
The experimental support for the JSON protocol has been removed, and will be\r
packaged as a separate download with some extra very interesting stuff (human\r
readable auto-generated documentation, anyone?).\r
\r
\r
XML-RPC for PHP version 2.0RC2 - 2005/11/22\r
\r
This release corrects a few bugs and adds basically one new method for better\r
HTTPS support:\r
\r
 * fixed two bugs that prevented xmlrpc calls to take place over https\r
 * fixed two bugs that prevented proper recognition of xml character set\r
   when it was declared inside the xml prologue\r
 * added xmlrpc_client::setKey($key, $keypass) method, to allow using client\r
   side certificates for https connections\r
 * fixed bug that prevented proper serialization of string xmlrpcvals when\r
   $xmlrpc_internalencoding was set to UTF-8\r
 * fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)\r
 * correctly set cookies/http headers into xmlrpcresp objects even when the\r
   sned() method call fails for some reason\r
 * added a benchmark file in the testsuite directory\r
\r
A couple of (private/protected) methods have been refactored, as well as a\r
couple of extra parameters added to some (private) functions - this has no\r
impact on the public API and should be of interest primarily to people extending\r
/ subclassing the lib.\r
\r
There is also new, PARTIAL support for the JSON-RPC protocol, implemented in\r
two files in the extras dir (more info about json-rpc at http://json-rpc.org)\r
\r
\r
XML-RPC for PHP version 2.0RC1 - 2005/10/03\r
\r
I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.\r
\r
This release introduces so many new features it is almost impossible to list them\r
here, making the library finally on pair with, if not more advanced than, any other\r
similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).\r
No, really, trust me.\r
\r
The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of\r
a couple of compatibility classes (code taken from PEAR php_compat package).\r
\r
The placement of files and directories in the distribution has been deeply modified,\r
in the hope of making it more clear, now that the file count has increased.\r
I hope you find it easy.\r
\r
Support for "advanced" HTTP features such as cookies, proxies and keep-alives has\r
been added at last.\r
\r
It is now much easier to convert between xmlrpcval objects and php values, and\r
in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods\r
for all cases, except when encoding base64 data.\r
\r
Two new (experimental) functions have been added, allowing automagic conversion\r
of a php function into an xmlrpc method to be exposed and vice-versa.\r
\r
PHP objects can be now automatically serialized as xmlrpc struct values and\r
correctly deserialized on the other end of the transmission, provided that the\r
same class definition is present on both sides and no object members are of\r
type resource.\r
\r
A lot of the existing class methods have been overloaded with extra parameters\r
or new functionality, and a few added ex-novo, making usage easier than ever.\r
\r
A complete debugger solution is included in the distribution. It needs a web server\r
to run (a freely available version of the same debugger is accessible online, it\r
can be found at http://phpxmlrpc.sourceforge.net).\r
\r
For a more detailed list of changes, please read carefully chapter 2 of the\r
included documentation, or, even better, take a look at the source code, which\r
is commented in javadoc style quite a bit.\r
\r
\r
XML-RPC for PHP version 1.2 - 2005/08/14\r
\r
This removes all use of eval(), which is a potential security problem.\r
All users are encouraged to upgrade as soon as possible.\r
As of this release we are no longer php3-compatible.\r
\r
\r
XML-RPC for PHP version 1.1.1 - 2005/06/30\r
\r
This is a security vulnerability fix release.\r
All users are invited to upgrade as soon as possible.\r
\r
\r
XML-RPC for PHP version 1.1 - 2005/05/03\r
\r
I'm pleased to announce XML-RPC for PHP version 1.1\r
It's taken two years to get to the this point, but here we are, finally.\r
\r
This is a bugfix and maintenance release. No major new features have been added.\r
All known bugs have been ironed out, unless fixing would have meant breaking\r
the API.\r
The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main\r
development platform (and some warnings will be emitted when runnning PHP5).\r
\r
Notheworthy changes include:\r
\r
 * do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5\r
 * fixed the unicode/charset problems that have been plaguing the lib for years\r
 * proper parsing of int and float values prepended with zeroes or the '+' char\r
 * accept float values in exponential notation\r
 * configurable http user-agent string\r
 * use the same timeout on client socket reads as used for connecting\r
 * more explicative error messages in xmlrpcresponse in many cases\r
 * much more tolerant parsing of malformed http responses from xmlrpc servers\r
 * fixed memleak that prevented the client to be used in never-ending scripts\r
 * parse bigger xmlrpc messages without crashing (1MB in size or more)\r
 * be tolerant to xmlrpc responses generated on public servers that add\r
   javascript advertising at the end of hosted content\r
 * the lib generates quite a few less PHP warnings during standard operation\r
\r
This is the last release that will support PHP 3.\r
The next release will include better support for PHP 5 and (possibly) a slew of\r
new features.\r
\r
The changelog is available at:\r
http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup\r
\r
Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project\r
pages at http://sourceforge.net/projects/phpxmlrpc/\r