- changelog update
[plcapi.git] / NEWS
1 XML-RPC for PHP version 3.0.0 - 2010/xx/yy\r
2 \r
3 This release corrects all bugs that have been reported and sucesfully reproduced since\r
4 version 3.0.0 beta\r
5 \r
6 XML-RPC for PHP version 3.0.0 beta - 2009/09/05\r
7 \r
8 This is the first release of the library to only support PHP 5.\r
9 Some legacy code has been removed, and support for features such as exceptions\r
10 and dateTime objects introduced.\r
11 \r
12 The "beta" tag is meant to indicate the fact that the refactoring has been more widespread\r
13 than in precedent releases and that more changes are likely to be introduced with time -\r
14 the library is still considered to be production quality.\r
15 \r
16 * improved: removed all usage of php functions deprecated in php 5.3, usage of assign-by-ref when creating new objects etc...\r
17 * improved: add support for the <ex:nil/> tag used by the apache library, both in input and output\r
18 * improved: add support for dateTime objects in both in php_xmlrpc_encode and as parameter for constructor of xmlrpcval\r
19 * improved: add support for timestamps as parameter for constructor of xmlrpcval\r
20 * improved: add option 'dates_as_objects' to php_xmlrpc_decode to return dateTime objects for xmlrpc datetimes\r
21 * improved: add new method SetCurlOptions to xmrlpc_client to allow extra flexibility in tweaking http config, such as explicitly binding to an ip address\r
22 * improved: add new method SetUserAgent to xmrlpc_client to to allow having different user-agent http headers\r
23 * 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\r
24 * improved: allow servers in 'xmlrpcvals' mode to also register plain php functions by defining them in the dispatch map with an added option\r
25 * improved: catch exceptions thrown during execution of php functions exposed as methods by the server\r
26 * fixed: bad encoding if same object is encoded twice using php_xmlrpc_encode\r
27 \r
28 \r
29 XML-RPC for PHP version 2.2.2 - 2009/03/16\r
30 \r
31 This release corrects all bugs that have been reported and sucesfully reproduced since\r
32 version 2.2.1.\r
33 Regardless of the intimidating message about dropping PHP 4 support, it still does\r
34 support that ancient, broken and insecure platform.\r
35 \r
36 \r
37 * fixed: php warning when receiving 'false' in a bool value\r
38 * fixed: improve robustness of the debugger when parsing weird results from non-compliant servers\r
39 * fixed: format floating point values using the correct decimal separator even when php locale is set to one that uses comma\r
40 * 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
41 * fixed: be more tolerant in detection of charset in http headers\r
42 * fixed: fix encoding of UTF8 chars outside of the BMP plane\r
43 * fixed: fix detection of zlib.output_compression\r
44 * improved: allow the add_to_map server method to add docs for single params too\r
45 * improved: added the possibility to wrap for exposure as xmlrpc        methods plain php class methods, object methods and even whole classes\r
46 \r
47 \r
48 XML-RPC for PHP version 2.2.1 - 2008/03/06\r
49 \r
50 This release corrects all bugs that have been reported and sucesfully reproduced.\r
51 It is the last release of the library that will support PHP 4.\r
52 \r
53 * fixed: work aroung bug in php 5.2.2 which broke support of HTTP_RAW_POST_DATA\r
54 * fixed: is_dir parameter of setCaCertificate() method is reversed\r
55 * fixed: a php warning in xmlrpc_client creator method\r
56 * fixed: parsing of '1e+1' as valid float\r
57 * fixed: allow errorlevel 3 to work when prev. error handler was a static method\r
58 * fixed: usage of client::setcookie() for multiple cookies in non-ssl mode\r
59 * improved: support for CP1252 charset is not part or the library but almost possible\r
60 * improved: more info when curl is enabled and debug mode is on\r
61 \r
62 \r
63 XML-RPC for PHP version 2.2 - 2007/02/25\r
64 \r
65 This release corrects a couple of bugs and adds a few minor features.\r
66 \r
67 * fixed: debugger errors on php installs with magic_quotes_gpc on\r
68 * fixed: support for https connections via proxy\r
69 * fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects\r
70 * improved: slightly faster encoding of data which is internally UTF-8\r
71 * improved: debugger always generates a 'null' id for jsonrpc if user omits it\r
72 * new: debugger can take advantage of a graphical value builder\r
73   (it has to be downloaded separately, as part of jsxmlrpc package)\r
74 * new: support for the <NIL/> xmlrpc extension\r
75 * new: server support for the system.getCapabilities xmlrpc extension\r
76 * new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault\r
77 \r
78 \r
79 XML-RPC for PHP version 2.1 - 2006/08/28\r
80 \r
81 This release corrects quite a few bugs and adds some interesting new features.\r
82 There is a minor security enhancement and overall speedup too.\r
83 \r
84 It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.\r
85 Please note that 404pl1 is NOT supported, and has not been since 2.0.\r
86 \r
87 *** PLASE READ CAREFULLY BELOW ***\r
88 \r
89 CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:\r
90 \r
91 The wrap_php_function and wrap_xmlrpc_method functions have been moved out of\r
92 the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.\r
93 You will have to include() / require() it in your scripts if you have been using\r
94 those functions.\r
95 \r
96 For increased security, the automatic rebuilding of php object instances out of\r
97 received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be\r
98 optionally reenabled).\r
99 \r
100 The constructor of xmlrpcval() values has seen major changes, and it will not\r
101 throw a php warning anymore when invoked using an unknown xmlrpc type: the\r
102 error will only be written to php error log. Also new xmlrpcval('true', 'boolean')\r
103 is not supported anymore.\r
104 \r
105 MAJOR IMPROVEMENTS:\r
106 \r
107 The new function php_xmlrpc_decode_xml() will take the xml representation of\r
108 either an xmlrpc request, response or single value and return the corresponding\r
109 php-xmlrpc object instance.\r
110 \r
111 Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more\r
112 options to fine tune their behaviour, including one to return the php code to\r
113 be saved and later used as standalone php script.\r
114 \r
115 A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the\r
116 methods exposed by a remote xmlrpc server into a php class.\r
117 \r
118 Lib internals have been modified to provide better support for grafting extra\r
119 functionality on top of it. Stay tuned for future releases of the EXTRAS package.\r
120 \r
121 Last but not least a new file has been added: verify_compat.php, to help users\r
122 diagnose the level of compliance of the current php install with the library.\r
123 \r
124 CHANGELOG IN DETAIL:\r
125 \r
126 * fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80\r
127 * fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_\r
128 * fixed bug: wrong handling of 'deflate' http encoding, both server and client side\r
129 * fixed bug: sending compressed responses when php output compression is enabled was not working\r
130 * fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values\r
131 * fixed bug: non-ascii chars used in struct element names where not being encoded correctly\r
132 * restored compatibility with php 4.0.5 (for those poor souls still stuck on it)\r
133 * server->service() now returns either the payload or xmlrpcresp instance\r
134 * server->add_to_map() now accepts methods with no param definitions\r
135 * added new function: php_xmlrpc_decode_xml()\r
136 * added new function: wrap_xmlrpc_server()\r
137 * major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()\r
138 * documentation for single parameters of exposed methods can be added to the dispatch map\r
139   (and turned into html docs in conjunction with a future release of the extras package)\r
140 * full response payload is saved into xmlrpcresp object for further debugging\r
141 * stricter parsing of incmoing xmlrpc messages: two more invalid cases are now detected\r
142   (double data element inside array and struct/array after scalar inside value element)\r
143 * debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)\r
144 * debugger has better support for being activated via a single GET call (for integration into other tools?)\r
145 * more logging of errors in a lot of situations\r
146 * javadoc documentation of lib files almost complete\r
147 * the usual amount of new testcases in the testsuite\r
148 * many performance tweaks and code cleanups\r
149 * added foundation for emulating the API of the xmlrpc extension (extras package needed)\r
150 \r
151 \r
152 XML-RPC for PHP version 2.0 - 2006/04/24\r
153 \r
154 I'm pleased to announce XML-RPC for PHP version 2.0, final.\r
155 \r
156 With respect to the last release candidate, this release corrects a few small\r
157 bugs and adds a couple of new features: more authentication options (digest and\r
158 ntlm for servers, ntlm for proxies, and some https custom certificates stuff);\r
159 all the examples have been reviewed and some demo files added,\r
160 including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc\r
161 client is a browser); the server logs more warning messages for incorrect situations;\r
162 both client and server are more tolerant of commonly-found mistakes.\r
163 The debugger has been upgraded to reflect the new client capabilities.\r
164 \r
165 In greater detail:\r
166 \r
167 * fixed bug: method xmlrpcval::structmemexists($value) would not work\r
168 * fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that\r
169   has return_type=phpvals\r
170 * fixed bug: in case of call to client::multicall without fallback and server error\r
171 * fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset\r
172 * fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii\r
173   chars where found when decoding\r
174 * new: client can use NTLM and Digest authentication methods for https and http 1.1\r
175   connections; authentication to proxy can be set to NTLM, too\r
176 * new: server tolerates user functions returning a single xmlrpcval object instead\r
177   of an xmlrpcresp\r
178 * new: server does more checks for presence and correct return type of user\r
179   coded method handling functions, and logs inconsistencies to php error log\r
180 * new: client method SetCaCertificate($cert, $is_dir) to validate server against\r
181 * new: both server and client tolerate receiving 'true' and 'false' for bool values\r
182   (which btw are not valid according to the xmlrpc spec)\r
183 \r
184 \r
185 XML-RPC for PHP version 2.0RC3 - 2006/01/22\r
186 \r
187 This release corrects a few bugs and adds some interesting new features.\r
188 It has been tested with PHP up to 4.4.2 and 5.1.2.\r
189 \r
190 * fixed bug: server not recognizing clients that declare support for http compression\r
191 * fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding\r
192   set to UTF-8\r
193 * fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce\r
194   invalid xml-rpc\r
195 * new: let the server accept 'class::method' syntax in the dispatch map\r
196 * new: php_xmlrpc_decode() can decode xmlrpcmessage objects\r
197 * new: both client and server can specify a charset to be used for serializing\r
198   values instead of the default 'US-ASCII+xml-entities-for-other-characters'.\r
199   Values allowed: ISO-8859-1 and UTF-8\r
200 * new: the server object can register 'plain' php functions instead of functions\r
201   that accept a single parameter of type xmlrpcmsg. Faster, uses less memory\r
202   (but comes with minor drawbacks as well, read the manual for more details)\r
203 * new: client::setDebug(2) can be used to have the request payload printed to\r
204   screen before being sent\r
205 * new: server::service($data) lets user parse data other than POST body, for\r
206   easier testing / subclassing\r
207 * changed: framework-generated debug messages are sent back by the server base64\r
208   encoded, to avoid any charset/xml compatibility problem\r
209 * other minor fixes\r
210 \r
211 The usual refactoring of a lot of (private) methods has taken place, with new\r
212 parameters added to some functions.\r
213 Javadoc documentation has been improved a lot.\r
214 The HTML documentation has been shuffled around a bit, hoping to give it a more\r
215 logical organization.\r
216 \r
217 The experimental support for the JSON protocol has been removed, and will be\r
218 packaged as a separate download with some extra very interesting stuff (human\r
219 readable auto-generated documentation, anyone?).\r
220 \r
221 \r
222 XML-RPC for PHP version 2.0RC2 - 2005/11/22\r
223 \r
224 This release corrects a few bugs and adds basically one new method for better\r
225 HTTPS support:\r
226 \r
227  * fixed two bugs that prevented xmlrpc calls to take place over https\r
228  * fixed two bugs that prevented proper recognition of xml character set\r
229    when it was declared inside the xml prologue\r
230  * added xmlrpc_client::setKey($key, $keypass) method, to allow using client\r
231    side certificates for https connections\r
232  * fixed bug that prevented proper serialization of string xmlrpcvals when\r
233    $xmlrpc_internalencoding was set to UTF-8\r
234  * fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)\r
235  * correctly set cookies/http headers into xmlrpcresp objects even when the\r
236    sned() method call fails for some reason\r
237  * added a benchmark file in the testsuite directory\r
238 \r
239 A couple of (private/protected) methods have been refactored, as well as a\r
240 couple of extra parameters added to some (private) functions - this has no\r
241 impact on the public API and should be of interest primarily to people extending\r
242 / subclassing the lib.\r
243 \r
244 There is also new, PARTIAL support for the JSON-RPC protocol, implemented in\r
245 two files in the extras dir (more info about json-rpc at http://json-rpc.org)\r
246 \r
247 \r
248 XML-RPC for PHP version 2.0RC1 - 2005/10/03\r
249 \r
250 I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.\r
251 \r
252 This release introduces so many new features it is almost impossible to list them\r
253 here, making the library finally on pair with, if not more advanced than, any other\r
254 similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).\r
255 No, really, trust me.\r
256 \r
257 The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of\r
258 a couple of compatibility classes (code taken from PEAR php_compat package).\r
259 \r
260 The placement of files and directories in the distribution has been deeply modified,\r
261 in the hope of making it more clear, now that the file count has increased.\r
262 I hope you find it easy.\r
263 \r
264 Support for "advanced" HTTP features such as cookies, proxies and keep-alives has\r
265 been added at last.\r
266 \r
267 It is now much easier to convert between xmlrpcval objects and php values, and\r
268 in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods\r
269 for all cases, except when encoding base64 data.\r
270 \r
271 Two new (experimental) functions have been added, allowing automagic conversion\r
272 of a php function into an xmlrpc method to be exposed and vice-versa.\r
273 \r
274 PHP objects can be now automatically serialized as xmlrpc struct values and\r
275 correctly deserialized on the other end of the transmission, provided that the\r
276 same class definition is present on both sides and no object members are of\r
277 type resource.\r
278 \r
279 A lot of the existing class methods have been overloaded with extra parameters\r
280 or new functionality, and a few added ex-novo, making usage easier than ever.\r
281 \r
282 A complete debugger solution is included in the distribution. It needs a web server\r
283 to run (a freely available version of the same debugger is accessible online, it\r
284 can be found at http://phpxmlrpc.sourceforge.net).\r
285 \r
286 For a more detailed list of changes, please read carefully chapter 2 of the\r
287 included documentation, or, even better, take a look at the source code, which\r
288 is commented in javadoc style quite a bit.\r
289 \r
290 \r
291 XML-RPC for PHP version 1.2 - 2005/08/14\r
292 \r
293 This removes all use of eval(), which is a potential security problem.\r
294 All users are encouraged to upgrade as soon as possible.\r
295 As of this release we are no longer php3-compatible.\r
296 \r
297 \r
298 XML-RPC for PHP version 1.1.1 - 2005/06/30\r
299 \r
300 This is a security vulnerability fix release.\r
301 All users are invited to upgrade as soon as possible.\r
302 \r
303 \r
304 XML-RPC for PHP version 1.1 - 2005/05/03\r
305 \r
306 I'm pleased to announce XML-RPC for PHP version 1.1\r
307 It's taken two years to get to the this point, but here we are, finally.\r
308 \r
309 This is a bugfix and maintenance release. No major new features have been added.\r
310 All known bugs have been ironed out, unless fixing would have meant breaking\r
311 the API.\r
312 The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main\r
313 development platform (and some warnings will be emitted when runnning PHP5).\r
314 \r
315 Notheworthy changes include:\r
316 \r
317  * do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5\r
318  * fixed the unicode/charset problems that have been plaguing the lib for years\r
319  * proper parsing of int and float values prepended with zeroes or the '+' char\r
320  * accept float values in exponential notation\r
321  * configurable http user-agent string\r
322  * use the same timeout on client socket reads as used for connecting\r
323  * more explicative error messages in xmlrpcresponse in many cases\r
324  * much more tolerant parsing of malformed http responses from xmlrpc servers\r
325  * fixed memleak that prevented the client to be used in never-ending scripts\r
326  * parse bigger xmlrpc messages without crashing (1MB in size or more)\r
327  * be tolerant to xmlrpc responses generated on public servers that add\r
328    javascript advertising at the end of hosted content\r
329  * the lib generates quite a few less PHP warnings during standard operation\r
330 \r
331 This is the last release that will support PHP 3.\r
332 The next release will include better support for PHP 5 and (possibly) a slew of\r
333 new features.\r
334 \r
335 The changelog is available at:\r
336 http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup\r
337 \r
338 Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project\r
339 pages at http://sourceforge.net/projects/phpxmlrpc/\r