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