mirror of
https://github.com/ACSPRI/queXS
synced 2024-04-02 12:12:16 +00:00
Added a backport of Limesurvey CI Remote Control 2 functionality for adding a response.
Can be used to insert a new response into a questionnaire via XML-RPC Added xmlrpc package from: http://phpxmlrpc.sourceforge.net (new BSD licence compatible with GPL)
This commit is contained in:
azammitdcarf
1487
include/limesurvey/admin/classes/xmlrpc/Changelog
Normal file
1487
include/limesurvey/admin/classes/xmlrpc/Changelog
Normal file
File diff suppressed because it is too large
Load Diff
124
include/limesurvey/admin/classes/xmlrpc/Makefile
Normal file
124
include/limesurvey/admin/classes/xmlrpc/Makefile
Normal file
@@ -0,0 +1,124 @@
|
||||
# Makefile for phpxmlrpc library
|
||||
# $Id: Makefile,v 1.37 2008/03/06 22:37:19 ggiunta Exp $
|
||||
|
||||
### USER EDITABLE VARS ###
|
||||
|
||||
# path to PHP executable, preferably CLI version
|
||||
PHP=/usr/local/bin/php
|
||||
|
||||
# path were xmlrpc lib files will be copied to
|
||||
PHPINCLUDEDIR=/usr/local/lib/php
|
||||
|
||||
# mkdir is a thorny beast under windows: make sure we can not use the cmd version, running eg. "make MKDIR=mkdir.exe"
|
||||
MKDIR=mkdir
|
||||
|
||||
#find too
|
||||
FIND=find
|
||||
|
||||
|
||||
#### DO NOT TOUCH FROM HERE ONWARDS ###
|
||||
|
||||
# recover version number from code
|
||||
# thanks to Firman Pribadi for unix command line help
|
||||
# on unix shells lasts char should be \\2/g )
|
||||
export VERSION=$(shell egrep "\$GLOBALS *\[ *'xmlrpcVersion' *\] *= *'" lib/xmlrpc.inc | sed -r s/"(.*= *' *)([0-9a-zA-Z.-]+)(.*)"/\2/g )
|
||||
|
||||
LIBFILES=lib/xmlrpc.inc lib/xmlrpcs.inc lib/xmlrpc_wrappers.inc lib/compat/*.php
|
||||
|
||||
EXTRAFILES=extras/test.pl \
|
||||
extras/test.py \
|
||||
extras/rsakey.pem \
|
||||
extras/workspace.testPhpServer.fttb
|
||||
|
||||
DEMOFILES=demo/vardemo.php \
|
||||
demo/demo1.txt \
|
||||
demo/demo2.txt \
|
||||
demo/demo3.txt
|
||||
|
||||
DEMOSFILES=demo/server/discuss.php \
|
||||
demo/server/server.php \
|
||||
demo/server/proxy.php
|
||||
|
||||
DEMOCFILES=demo/client/agesort.php \
|
||||
demo/client/client.php \
|
||||
demo/client/comment.php \
|
||||
demo/client/introspect.php \
|
||||
demo/client/mail.php \
|
||||
demo/client/simple_call.php \
|
||||
demo/client/which.php \
|
||||
demo/client/wrap.php \
|
||||
demo/client/zopetest.php
|
||||
|
||||
TESTFILES=test/testsuite.php \
|
||||
test/benchmark.php \
|
||||
test/parse_args.php \
|
||||
test/phpunit.php \
|
||||
test/verify_compat.php \
|
||||
test/PHPUnit/*.php
|
||||
|
||||
INFOFILES=Changelog \
|
||||
Makefile \
|
||||
NEWS \
|
||||
README
|
||||
|
||||
DEBUGGERFILES=debugger/index.php \
|
||||
debugger/action.php \
|
||||
debugger/common.php \
|
||||
debugger/controller.php
|
||||
|
||||
|
||||
all: install
|
||||
|
||||
install:
|
||||
cd lib && cp ${LIBFILES} ${PHPINCLUDEDIR}
|
||||
@echo Lib files have been copied to ${PHPINCLUDEDIR}
|
||||
cd doc && $(MAKE) install
|
||||
|
||||
test:
|
||||
cd test && ${PHP} -q testsuite.php
|
||||
|
||||
|
||||
### the following targets are to be used for library development ###
|
||||
|
||||
# make tag target: tag existing working copy as release in cvs.
|
||||
# todo: convert dots in underscore in $VERSION
|
||||
tag:
|
||||
cvs -q tag -p release_${VERSION}
|
||||
|
||||
dist: xmlrpc-${VERSION}.zip xmlrpc-${VERSION}.tar.gz
|
||||
|
||||
xmlrpc-${VERSION}.zip xmlrpc-${VERSION}.tar.gz: ${LIBFILES} ${DEBUGGERFILES} ${INFOFILES} ${TESTFILES} ${EXTRAFILES} ${DEMOFILES} ${DEMOSFILES} ${DEMOCFILES}
|
||||
@echo ---${VERSION}---
|
||||
rm -rf xmlrpc-${VERSION}
|
||||
${MKDIR} xmlrpc-${VERSION}
|
||||
${MKDIR} xmlrpc-${VERSION}/demo
|
||||
${MKDIR} xmlrpc-${VERSION}/demo/client
|
||||
${MKDIR} xmlrpc-${VERSION}/demo/server
|
||||
${MKDIR} xmlrpc-${VERSION}/test
|
||||
${MKDIR} xmlrpc-${VERSION}/test/PHPUnit
|
||||
${MKDIR} xmlrpc-${VERSION}/extras
|
||||
${MKDIR} xmlrpc-${VERSION}/lib
|
||||
${MKDIR} xmlrpc-${VERSION}/lib/compat
|
||||
${MKDIR} xmlrpc-${VERSION}/debugger
|
||||
cp --parents ${DEMOFILES} xmlrpc-${VERSION}
|
||||
cp --parents ${DEMOCFILES} xmlrpc-${VERSION}
|
||||
cp --parents ${DEMOSFILES} xmlrpc-${VERSION}
|
||||
cp --parents ${TESTFILES} xmlrpc-${VERSION}
|
||||
cp --parents ${EXTRAFILES} xmlrpc-${VERSION}
|
||||
cp --parents ${LIBFILES} xmlrpc-${VERSION}
|
||||
cp --parents ${DEBUGGERFILES} xmlrpc-${VERSION}
|
||||
cp ${INFOFILES} xmlrpc-${VERSION}
|
||||
cd doc && $(MAKE) dist
|
||||
# on unix shells last char should be \;
|
||||
${FIND} xmlrpc-${VERSION} -type f ! -name "*.fttb" ! -name "*.pdf" ! -name "*.gif" -exec dos2unix {} ;
|
||||
-rm xmlrpc-${VERSION}.zip xmlrpc-${VERSION}.tar.gz
|
||||
tar -cvf xmlrpc-${VERSION}.tar xmlrpc-${VERSION}
|
||||
gzip xmlrpc-${VERSION}.tar
|
||||
zip -r xmlrpc-${VERSION}.zip xmlrpc-${VERSION}
|
||||
|
||||
doc:
|
||||
cd doc && $(MAKE) doc
|
||||
|
||||
clean:
|
||||
rm -rf xmlrpc-${VERSION} xmlrpc-${VERSION}.zip xmlrpc-${VERSION}.tar.gz
|
||||
cd doc && $(MAKE) clean
|
||||
310
include/limesurvey/admin/classes/xmlrpc/NEWS
Normal file
310
include/limesurvey/admin/classes/xmlrpc/NEWS
Normal file
@@ -0,0 +1,310 @@
|
||||
XML-RPC for PHP version 2.2.2 - 2008/03/16
|
||||
|
||||
This release corrects all bugs that have been reported and sucesfully reproduced since
|
||||
version 2.2.1.
|
||||
Regardless of the intimitading message about dropping PHP 4 support, it still does
|
||||
support that ancient, broken and insecure platform.
|
||||
|
||||
* fixed: php warning when receiving 'false' in a bool value
|
||||
* fixed: improve robustness of the debugger when parsing weird results from non-compliant servers
|
||||
* fixed: format floating point values using the correct decimal separator even when php locale is set to one that uses comma
|
||||
* 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)
|
||||
* fixed: be more tolerant in detection of charset in http headers
|
||||
* fixed: fix encoding of UTF8 chars outside of the BMP plane
|
||||
* fixed: fix detection of zlib.output_compression
|
||||
* improved: allow the add_to_map server method to add docs for single params too
|
||||
* improved: added the possibility to wrap for exposure as xmlrpc methods plain php class methods, object methods and even whole classes
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.2.1 - 2008/03/06
|
||||
|
||||
This release corrects all bugs that have been reported and sucesfully reproduced.
|
||||
It is the last release of the library that will support PHP 4.
|
||||
|
||||
* fixed: work aroung bug in php 5.2.2 which broke support of HTTP_RAW_POST_DATA
|
||||
* fixed: is_dir parameter of setCaCertificate() method is reversed
|
||||
* fixed: a php warning in xmlrpc_client creator method
|
||||
* fixed: parsing of '1e+1' as valid float
|
||||
* fixed: allow errorlevel 3 to work when prev. error handler was a static method
|
||||
* fixed: usage of client::setcookie() for multiple cookies in non-ssl mode
|
||||
* improved: support for CP1252 charset is not part or the library but almost possible
|
||||
* improved: more info when curl is enabled and debug mode is on
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.2 - 2007/02/25
|
||||
|
||||
This release corrects a couple of bugs and adds a few minor features.
|
||||
|
||||
* fixed: debugger errors on php installs with magic_quotes_gpc on
|
||||
* fixed: support for https connections via proxy
|
||||
* fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects
|
||||
* improved: slightly faster encoding of data which is internally UTF-8
|
||||
* improved: debugger always generates a 'null' id for jsonrpc if user omits it
|
||||
* new: debugger can take advantage of a graphical value builder
|
||||
(it has to be downloaded separately, as part of jsxmlrpc package)
|
||||
* new: support for the <NIL/> xmlrpc extension
|
||||
* new: server support for the system.getCapabilities xmlrpc extension
|
||||
* new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.1 - 2006/08/28
|
||||
|
||||
This release corrects quite a few bugs and adds some interesting new features.
|
||||
There is a minor security enhancement and overall speedup too.
|
||||
|
||||
It has been tested with PHP 4.0.5 up to 4.4.4 and 5.1.5.
|
||||
Please note that 404pl1 is NOT supported, and has not been since 2.0.
|
||||
|
||||
*** PLASE READ CAREFULLY BELOW ***
|
||||
|
||||
CHANGES THAT MIGHT AFFECT DEPLOYED APPLICATIONS:
|
||||
|
||||
The wrap_php_function and wrap_xmlrpc_method functions have been moved out of
|
||||
the base library file xmlrpc.inc into a file of their own: xmlrpc_wrappers.inc.
|
||||
You will have to include() / require() it in your scripts if you have been using
|
||||
those functions.
|
||||
|
||||
For increased security, the automatic rebuilding of php object instances out of
|
||||
received xmlrpc structs in wrap_xmlrpc_method() has been disabled (but it can be
|
||||
optionally reenabled).
|
||||
|
||||
The constructor of xmlrpcval() values has seen major changes, and it will not
|
||||
throw a php warning anymore when invoked using an unknown xmlrpc type: the
|
||||
error will only be written to php error log. Also new xmlrpcval('true', 'boolean')
|
||||
is not supported anymore.
|
||||
|
||||
MAJOR IMPROVEMENTS:
|
||||
|
||||
The new function php_xmlrpc_decode_xml() will take the xml representation of
|
||||
either an xmlrpc request, response or single value and return the corresponding
|
||||
php-xmlrpc object instance.
|
||||
|
||||
Both wrap_php_function() and wrap_xmlrpc_method() functions accept many more
|
||||
options to fine tune their behaviour, including one to return the php code to
|
||||
be saved and later used as standalone php script.
|
||||
|
||||
A new function wrap_xmlrpc_server() has been added, to wrap all (or some) of the
|
||||
methods exposed by a remote xmlrpc server into a php class.
|
||||
|
||||
Lib internals have been modified to provide better support for grafting extra
|
||||
functionality on top of it. Stay tuned for future releases of the EXTRAS package.
|
||||
|
||||
Last but not least a new file has been added: verify_compat.php, to help users
|
||||
diagnose the level of compliance of the current php install with the library.
|
||||
|
||||
CHANGELOG IN DETAIL:
|
||||
|
||||
* fixed bug 1311927: client not playing nice with some proxy/firewall on ports != 80
|
||||
* fixed bug 1334340: all ereg_ functions have been replaced with corresponding preg_
|
||||
* fixed bug: wrong handling of 'deflate' http encoding, both server and client side
|
||||
* fixed bug: sending compressed responses when php output compression is enabled was not working
|
||||
* fixed bug: addarray() and addstruct() where not returning 1 when adding data to already initialized values
|
||||
* fixed bug: non-ascii chars used in struct element names where not being encoded correctly
|
||||
* restored compatibility with php 4.0.5 (for those poor souls still stuck on it)
|
||||
* server->service() now returns either the payload or xmlrpcresp instance
|
||||
* server->add_to_map() now accepts methods with no param definitions
|
||||
* added new function: php_xmlrpc_decode_xml()
|
||||
* added new function: wrap_xmlrpc_server()
|
||||
* major improvements and security enhancements to wrap_php_function() and wrap_xmlrpc_method()
|
||||
* documentation for single parameters of exposed methods can be added to the dispatch map
|
||||
(and turned into html docs in conjunction with a future release of the extras package)
|
||||
* full response payload is saved into xmlrpcresp object for further debugging
|
||||
* stricter parsing of incmoing xmlrpc messages: two more invalid cases are now detected
|
||||
(double data element inside array and struct/array after scalar inside value element)
|
||||
* debugger can now generate code that wraps a remote method into php function (works for jsonrpc, too)
|
||||
* debugger has better support for being activated via a single GET call (for integration into other tools?)
|
||||
* more logging of errors in a lot of situations
|
||||
* javadoc documentation of lib files almost complete
|
||||
* the usual amount of new testcases in the testsuite
|
||||
* many performance tweaks and code cleanups
|
||||
* added foundation for emulating the API of the xmlrpc extension (extras package needed)
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.0 - 2006/04/24
|
||||
|
||||
I'm pleased to announce XML-RPC for PHP version 2.0, final.
|
||||
|
||||
With respect to the last release candidate, this release corrects a few small
|
||||
bugs and adds a couple of new features: more authentication options (digest and
|
||||
ntlm for servers, ntlm for proxies, and some https custom certificates stuff);
|
||||
all the examples have been reviewed and some demo files added,
|
||||
including a ready-made xmlrpc proxy (useful e.g. for ajax calls, when the xmlrpc
|
||||
client is a browser); the server logs more warning messages for incorrect situations;
|
||||
both client and server are more tolerant of commonly-found mistakes.
|
||||
The debugger has been upgraded to reflect the new client capabilities.
|
||||
|
||||
In greater detail:
|
||||
|
||||
* fixed bug: method xmlrpcval::structmemexists($value) would not work
|
||||
* fixed bug: wrap_xmlrpc_method would fail if invoked with a client object that
|
||||
has return_type=phpvals
|
||||
* fixed bug: in case of call to client::multicall without fallback and server error
|
||||
* fixed bug: recursive serialization of xmlrpcvals loosing specified UTF8 charset
|
||||
* fixed bug: serializing to ISO-8859-1 with php 5 would raise an error if non-ascii
|
||||
chars where found when decoding
|
||||
* new: client can use NTLM and Digest authentication methods for https and http 1.1
|
||||
connections; authentication to proxy can be set to NTLM, too
|
||||
* new: server tolerates user functions returning a single xmlrpcval object instead
|
||||
of an xmlrpcresp
|
||||
* new: server does more checks for presence and correct return type of user
|
||||
coded method handling functions, and logs inconsistencies to php error log
|
||||
* new: client method SetCaCertificate($cert, $is_dir) to validate server against
|
||||
* new: both server and client tolerate receiving 'true' and 'false' for bool values
|
||||
(which btw are not valid according to the xmlrpc spec)
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.0RC3 - 2006/01/22
|
||||
|
||||
This release corrects a few bugs and adds some interesting new features.
|
||||
It has been tested with PHP up to 4.4.2 and 5.1.2.
|
||||
|
||||
* fixed bug: server not recognizing clients that declare support for http compression
|
||||
* fixed bug: serialization of new xmlrpcval (8, 'string') when internal encoding
|
||||
set to UTF-8
|
||||
* fixed bug: serialization of new xmlrpcval ('hello', 'int') would produce
|
||||
invalid xml-rpc
|
||||
* new: let the server accept 'class::method' syntax in the dispatch map
|
||||
* new: php_xmlrpc_decode() can decode xmlrpcmessage objects
|
||||
* new: both client and server can specify a charset to be used for serializing
|
||||
values instead of the default 'US-ASCII+xml-entities-for-other-characters'.
|
||||
Values allowed: ISO-8859-1 and UTF-8
|
||||
* new: the server object can register 'plain' php functions instead of functions
|
||||
that accept a single parameter of type xmlrpcmsg. Faster, uses less memory
|
||||
(but comes with minor drawbacks as well, read the manual for more details)
|
||||
* new: client::setDebug(2) can be used to have the request payload printed to
|
||||
screen before being sent
|
||||
* new: server::service($data) lets user parse data other than POST body, for
|
||||
easier testing / subclassing
|
||||
* changed: framework-generated debug messages are sent back by the server base64
|
||||
encoded, to avoid any charset/xml compatibility problem
|
||||
* other minor fixes
|
||||
|
||||
The usual refactoring of a lot of (private) methods has taken place, with new
|
||||
parameters added to some functions.
|
||||
Javadoc documentation has been improved a lot.
|
||||
The HTML documentation has been shuffled around a bit, hoping to give it a more
|
||||
logical organization.
|
||||
|
||||
The experimental support for the JSON protocol has been removed, and will be
|
||||
packaged as a separate download with some extra very interesting stuff (human
|
||||
readable auto-generated documentation, anyone?).
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.0RC2 - 2005/11/22
|
||||
|
||||
This release corrects a few bugs and adds basically one new method for better
|
||||
HTTPS support:
|
||||
|
||||
* fixed two bugs that prevented xmlrpc calls to take place over https
|
||||
* fixed two bugs that prevented proper recognition of xml character set
|
||||
when it was declared inside the xml prologue
|
||||
* added xmlrpc_client::setKey($key, $keypass) method, to allow using client
|
||||
side certificates for https connections
|
||||
* fixed bug that prevented proper serialization of string xmlrpcvals when
|
||||
$xmlrpc_internalencoding was set to UTF-8
|
||||
* fixed bug in xmlrpc_server::echoInput() (and marked method as deprecated)
|
||||
* correctly set cookies/http headers into xmlrpcresp objects even when the
|
||||
sned() method call fails for some reason
|
||||
* added a benchmark file in the testsuite directory
|
||||
|
||||
A couple of (private/protected) methods have been refactored, as well as a
|
||||
couple of extra parameters added to some (private) functions - this has no
|
||||
impact on the public API and should be of interest primarily to people extending
|
||||
/ subclassing the lib.
|
||||
|
||||
There is also new, PARTIAL support for the JSON-RPC protocol, implemented in
|
||||
two files in the extras dir (more info about json-rpc at http://json-rpc.org)
|
||||
|
||||
|
||||
XML-RPC for PHP version 2.0RC1 - 2005/10/03
|
||||
|
||||
I'm pleased to announce XML-RPC for PHP version 2.0, release candidate 1.
|
||||
|
||||
This release introduces so many new features it is almost impossible to list them
|
||||
here, making the library finally on pair with, if not more advanced than, any other
|
||||
similar offer (e.g. the PEAR XMLRPC package or the Incutio IXR library).
|
||||
No, really, trust me.
|
||||
|
||||
The minimum supported PHP version is now 4.2 - natively - or 4.0.4pl1 - by usage of
|
||||
a couple of compatibility classes (code taken from PEAR php_compat package).
|
||||
|
||||
The placement of files and directories in the distribution has been deeply modified,
|
||||
in the hope of making it more clear, now that the file count has increased.
|
||||
I hope you find it easy.
|
||||
|
||||
Support for "advanced" HTTP features such as cookies, proxies and keep-alives has
|
||||
been added at last.
|
||||
|
||||
It is now much easier to convert between xmlrpcval objects and php values, and
|
||||
in fact php_xmlrpc_encode and php_xmlrpc_decode are now the recommended methods
|
||||
for all cases, except when encoding base64 data.
|
||||
|
||||
Two new (experimental) functions have been added, allowing automagic conversion
|
||||
of a php function into an xmlrpc method to be exposed and vice-versa.
|
||||
|
||||
PHP objects can be now automatically serialized as xmlrpc struct values and
|
||||
correctly deserialized on the other end of the transmission, provided that the
|
||||
same class definition is present on both sides and no object members are of
|
||||
type resource.
|
||||
|
||||
A lot of the existing class methods have been overloaded with extra parameters
|
||||
or new functionality, and a few added ex-novo, making usage easier than ever.
|
||||
|
||||
A complete debugger solution is included in the distribution. It needs a web server
|
||||
to run (a freely available version of the same debugger is accessible online, it
|
||||
can be found at http://phpxmlrpc.sourceforge.net).
|
||||
|
||||
For a more detailed list of changes, please read carefully chapter 2 of the
|
||||
included documentation, or, even better, take a look at the source code, which
|
||||
is commented in javadoc style quite a bit.
|
||||
|
||||
|
||||
XML-RPC for PHP version 1.2 - 2005/08/14
|
||||
|
||||
This removes all use of eval(), which is a potential security problem.
|
||||
All users are encouraged to upgrade as soon as possible.
|
||||
As of this release we are no longer php3-compatible.
|
||||
|
||||
|
||||
XML-RPC for PHP version 1.1.1 - 2005/06/30
|
||||
|
||||
This is a security vulnerability fix release.
|
||||
All users are invited to upgrade as soon as possible.
|
||||
|
||||
|
||||
XML-RPC for PHP version 1.1 - 2005/05/03
|
||||
|
||||
I'm pleased to announce XML-RPC for PHP version 1.1
|
||||
It's taken two years to get to the this point, but here we are, finally.
|
||||
|
||||
This is a bugfix and maintenance release. No major new features have been added.
|
||||
All known bugs have been ironed out, unless fixing would have meant breaking
|
||||
the API.
|
||||
The code has been tested with PHP 3, 4 and 5, even tough PHP 4 is the main
|
||||
development platform (and some warnings will be emitted when runnning PHP5).
|
||||
|
||||
Notheworthy changes include:
|
||||
|
||||
* do not clash any more with the EPI xmlrpc extension bundled with PHP 4 and 5
|
||||
* fixed the unicode/charset problems that have been plaguing the lib for years
|
||||
* proper parsing of int and float values prepended with zeroes or the '+' char
|
||||
* accept float values in exponential notation
|
||||
* configurable http user-agent string
|
||||
* use the same timeout on client socket reads as used for connecting
|
||||
* more explicative error messages in xmlrpcresponse in many cases
|
||||
* much more tolerant parsing of malformed http responses from xmlrpc servers
|
||||
* fixed memleak that prevented the client to be used in never-ending scripts
|
||||
* parse bigger xmlrpc messages without crashing (1MB in size or more)
|
||||
* be tolerant to xmlrpc responses generated on public servers that add
|
||||
javascript advertising at the end of hosted content
|
||||
* the lib generates quite a few less PHP warnings during standard operation
|
||||
|
||||
This is the last release that will support PHP 3.
|
||||
The next release will include better support for PHP 5 and (possibly) a slew of
|
||||
new features.
|
||||
|
||||
The changelog is available at:
|
||||
http://cvs.sourceforge.net/viewcvs.py/phpxmlrpc/xmlrpc/ChangeLog?view=markup
|
||||
|
||||
Please report bugs to the XML-RPC PHP mailing list or to the sourceforge project
|
||||
pages at http://sourceforge.net/projects/phpxmlrpc/
|
||||
13
include/limesurvey/admin/classes/xmlrpc/README
Normal file
13
include/limesurvey/admin/classes/xmlrpc/README
Normal file
@@ -0,0 +1,13 @@
|
||||
NAME: XMLRPC FOR PHP
|
||||
|
||||
DESCRIPTION: A php library for building xmlrpc clients and servers
|
||||
|
||||
|
||||
|
||||
HTML documentation can be found in the doc/ directory.
|
||||
|
||||
Recent changes in the ChangeLog
|
||||
|
||||
Use of this software is subject to the terms in doc/index.html
|
||||
|
||||
The passphrase for the rsakey.pem certificate is 'test'.
|
||||
527
include/limesurvey/admin/classes/xmlrpc/debugger/action.php
Normal file
527
include/limesurvey/admin/classes/xmlrpc/debugger/action.php
Normal file
@@ -0,0 +1,527 @@
|
||||
<?php
|
||||
/**
|
||||
* @version $Id: action.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @author Gaetano Giunta
|
||||
* @copyright (C) 2005-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*
|
||||
* @todo switch params for http compression from 0,1,2 to values to be used directly
|
||||
* @todo use ob_start to catch debug info and echo it AFTER method call results?
|
||||
* @todo be smarter in creating client stub for proxy/auth cases: only set appropriate property of client obj
|
||||
**/
|
||||
|
||||
?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>XMLRPC Debugger</title>
|
||||
<meta name="robots" content="index,nofollow" />
|
||||
<style type="text/css">
|
||||
<!--
|
||||
body {border-top: 1px solid gray; padding: 1em; font-family: Verdana, Arial, Helvetica; font-size: 8pt;}
|
||||
h3 {font-size: 9.5pt;}
|
||||
h2 {font-size: 12pt;}
|
||||
.dbginfo {padding: 1em; background-color: #EEEEEE; border: 1px dashed silver; font-family: monospace;}
|
||||
#response {padding: 1em; margin-top: 1em; background-color: #DDDDDD; border: 1px solid gray; white-space: pre; font-family: monospace;}
|
||||
table {padding: 2px; margin-top: 1em;}
|
||||
th {background-color: navy; color: white; padding: 0.5em;}
|
||||
td {padding: 0.5em; font-family: monospace;}
|
||||
td form {margin: 0;}
|
||||
.oddrow {background-color: #EEEEEE;}
|
||||
.evidence {color: blue;}
|
||||
#phpcode { background-color: #EEEEEE; padding: 1em; margin-top: 1em;}
|
||||
-->
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<?php
|
||||
|
||||
include(getcwd().'/common.php');
|
||||
if ($action)
|
||||
{
|
||||
|
||||
// make sure the script waits long enough for the call to complete...
|
||||
if ($timeout)
|
||||
set_time_limit($timeout+10);
|
||||
|
||||
include('xmlrpc.inc');
|
||||
if ($wstype == 1)
|
||||
{
|
||||
@include('jsonrpc.inc');
|
||||
if (!class_exists('jsonrpc_client'))
|
||||
{
|
||||
die('Error: to debug the jsonrpc protocol the jsonrpc.inc file is needed');
|
||||
}
|
||||
$clientclass = 'jsonrpc_client';
|
||||
$msgclass = 'jsonrpcmsg';
|
||||
$protoname = 'JSONRPC';
|
||||
}
|
||||
else
|
||||
{
|
||||
$clientclass = 'xmlrpc_client';
|
||||
$msgclass = 'xmlrpcmsg';
|
||||
$protoname = 'XMLRPC';
|
||||
}
|
||||
|
||||
if ($port != "")
|
||||
{
|
||||
$client =& new $clientclass($path, $host, $port);
|
||||
$server = "$host:$port$path";
|
||||
} else {
|
||||
$client =& new $clientclass($path, $host);
|
||||
$server = "$host$path";
|
||||
}
|
||||
if ($protocol == 2)
|
||||
{
|
||||
$server = 'https://'.$server;
|
||||
}
|
||||
else
|
||||
{
|
||||
$server = 'http://'.$server;
|
||||
}
|
||||
if ($proxy != '') {
|
||||
$pproxy = split(':', $proxy);
|
||||
if (count($pproxy) > 1)
|
||||
$pport = $pproxy[1];
|
||||
else
|
||||
$pport = 8080;
|
||||
$client->setProxy($pproxy[0], $pport, $proxyuser, $proxypwd);
|
||||
}
|
||||
|
||||
if ($protocol == 2)
|
||||
{
|
||||
$client->setSSLVerifyPeer($verifypeer);
|
||||
$client->setSSLVerifyHost($verifyhost);
|
||||
if ($cainfo)
|
||||
{
|
||||
$client->setCaCertificate($cainfo);
|
||||
}
|
||||
$httpprotocol = 'https';
|
||||
}
|
||||
else if ($protocol == 1)
|
||||
$httpprotocol = 'http11';
|
||||
else
|
||||
$httpprotocol = 'http';
|
||||
|
||||
if ($username)
|
||||
$client->setCredentials($username, $password, $authtype);
|
||||
|
||||
$client->setDebug($debug);
|
||||
|
||||
switch ($requestcompression) {
|
||||
case 0:
|
||||
$client->request_compression = '';
|
||||
break;
|
||||
case 1:
|
||||
$client->request_compression = 'gzip';
|
||||
break;
|
||||
case 2:
|
||||
$client->request_compression = 'deflate';
|
||||
break;
|
||||
}
|
||||
|
||||
switch ($responsecompression) {
|
||||
case 0:
|
||||
$client->accepted_compression = '';
|
||||
break;
|
||||
case 1:
|
||||
$client->accepted_compression = array('gzip');
|
||||
break;
|
||||
case 2:
|
||||
$client->accepted_compression = array('deflate');
|
||||
break;
|
||||
case 3:
|
||||
$client->accepted_compression = array('gzip', 'deflate');
|
||||
break;
|
||||
}
|
||||
|
||||
$cookies = explode(',', $clientcookies);
|
||||
foreach ($cookies as $cookie)
|
||||
{
|
||||
if (strpos($cookie, '='))
|
||||
{
|
||||
$cookie = explode('=', $cookie);
|
||||
$client->setCookie(trim($cookie[0]), trim(@$cookie[1]));
|
||||
}
|
||||
}
|
||||
|
||||
$msg = array();
|
||||
switch ($action) {
|
||||
|
||||
case 'wrap':
|
||||
@include('xmlrpc_wrappers.inc');
|
||||
if (!function_exists('build_remote_method_wrapper_code'))
|
||||
{
|
||||
die('Error: to enable creation of method stubs the xmlrpc_wrappers.inc file is needed');
|
||||
}
|
||||
// fall thru intentionally
|
||||
case 'describe':
|
||||
case 'wrap':
|
||||
$msg[0] =& new $msgclass('system.methodHelp', null, $id);
|
||||
$msg[0]->addparam(new xmlrpcval($method));
|
||||
$msg[1] =& new $msgclass('system.methodSignature', null, $id+1);
|
||||
$msg[1]->addparam(new xmlrpcval($method));
|
||||
$actionname = 'Description of method "'.$method.'"';
|
||||
break;
|
||||
case 'list':
|
||||
$msg[0] =& new $msgclass('system.listMethods', null, $id);
|
||||
$actionname = 'List of available methods';
|
||||
break;
|
||||
case 'execute':
|
||||
if (!payload_is_safe($payload))
|
||||
die("Tsk tsk tsk, please stop it or I will have to call in the cops!");
|
||||
$msg[0] =& new $msgclass($method, null, $id);
|
||||
// hack! build xml payload by hand
|
||||
if ($wstype == 1)
|
||||
{
|
||||
$msg[0]->payload = "{\n".
|
||||
'"method": "' . $method . "\",\n\"params\": [" .
|
||||
$payload .
|
||||
"\n],\n\"id\": ";
|
||||
// fix: if user gave an empty string, use NULL, or we'll break json syntax
|
||||
if ($id == "")
|
||||
{
|
||||
$msg[0]->payload .= "null\n}";
|
||||
}
|
||||
else
|
||||
{
|
||||
if (is_numeric($id) || $id == 'false' || $id == 'true' || $id == 'null')
|
||||
{
|
||||
$msg[0]->payload .= "$id\n}";
|
||||
}
|
||||
else
|
||||
{
|
||||
$msg[0]->payload .= "\"$id\"\n}";
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
$msg[0]->payload = $msg[0]->xml_header() .
|
||||
'<methodName>' . $method . "</methodName>\n<params>" .
|
||||
$payload .
|
||||
"</params>\n" . $msg[0]->xml_footer();
|
||||
$actionname = 'Execution of method '.$method;
|
||||
break;
|
||||
default: // give a warning
|
||||
$actionname = '[ERROR: unknown action] "'.$action.'"';
|
||||
}
|
||||
|
||||
// Before calling execute, echo out brief description of action taken + date and time ???
|
||||
// this gives good user feedback for long-running methods...
|
||||
echo '<h2>'.htmlspecialchars($actionname).' on server '.htmlspecialchars($server)." ...</h2>\n";
|
||||
flush();
|
||||
|
||||
$response = null;
|
||||
// execute method(s)
|
||||
if ($debug)
|
||||
echo '<div class="dbginfo"><h2>Debug info:</h2>'; /// @todo use ob_start instead
|
||||
$resp = array();
|
||||
$mtime = explode(' ',microtime());
|
||||
$time = (float)$mtime[0] + (float)$mtime[1];
|
||||
foreach ($msg as $message)
|
||||
{
|
||||
// catch errors: for older xmlrpc libs, send does not return by ref
|
||||
@$response =& $client->send($message, $timeout, $httpprotocol);
|
||||
$resp[] = $response;
|
||||
if (!$response || $response->faultCode())
|
||||
break;
|
||||
}
|
||||
$mtime = explode(' ',microtime());
|
||||
$time = (float)$mtime[0] + (float)$mtime[1] - $time;
|
||||
if ($debug)
|
||||
echo "</div>\n";
|
||||
|
||||
if ($response)
|
||||
{
|
||||
|
||||
if ($response->faultCode())
|
||||
{
|
||||
// call failed! echo out error msg!
|
||||
//echo '<h2>'.htmlspecialchars($actionname).' on server '.htmlspecialchars($server).'</h2>';
|
||||
echo "<h3>$protoname call FAILED!</h3>\n";
|
||||
echo "<p>Fault code: [" . htmlspecialchars($response->faultCode()) .
|
||||
"] Reason: '" . htmlspecialchars($response->faultString()) . "'</p>\n";
|
||||
echo (strftime("%d/%b/%Y:%H:%M:%S\n"));
|
||||
}
|
||||
else
|
||||
{
|
||||
// call succeeded: parse results
|
||||
//echo '<h2>'.htmlspecialchars($actionname).' on server '.htmlspecialchars($server).'</h2>';
|
||||
printf ("<h3>%s call(s) OK (%.2f secs.)</h3>\n", $protoname, $time);
|
||||
echo (strftime("%d/%b/%Y:%H:%M:%S\n"));
|
||||
|
||||
switch ($action)
|
||||
{
|
||||
case 'list':
|
||||
|
||||
$v = $response->value();
|
||||
if ($v->kindOf()=="array")
|
||||
{
|
||||
$max = $v->arraysize();
|
||||
echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
|
||||
echo "<thead>\n<tr><th>Method</th><th>Description</th></tr>\n</thead>\n<tbody>\n";
|
||||
for($i=0; $i < $max; $i++)
|
||||
{
|
||||
$rec = $v->arraymem($i);
|
||||
if ($i%2) $class=' class="oddrow"'; else $class = ' class="evenrow"';
|
||||
echo ("<tr><td$class>".htmlspecialchars($rec->scalarval())."</td><td$class><form action=\"controller.php\" method=\"get\" target=\"frmcontroller\">".
|
||||
"<input type=\"hidden\" name=\"host\" value=\"".htmlspecialchars($host)."\" />".
|
||||
"<input type=\"hidden\" name=\"port\" value=\"".htmlspecialchars($port)."\" />".
|
||||
"<input type=\"hidden\" name=\"path\" value=\"".htmlspecialchars($path)."\" />".
|
||||
"<input type=\"hidden\" name=\"id\" value=\"".htmlspecialchars($id)."\" />".
|
||||
"<input type=\"hidden\" name=\"debug\" value=\"$debug\" />".
|
||||
"<input type=\"hidden\" name=\"username\" value=\"".htmlspecialchars($username)."\" />".
|
||||
"<input type=\"hidden\" name=\"password\" value=\"".htmlspecialchars($password)."\" />".
|
||||
"<input type=\"hidden\" name=\"authtype\" value=\"$authtype\" />".
|
||||
"<input type=\"hidden\" name=\"verifyhost\" value=\"$verifyhost\" />".
|
||||
"<input type=\"hidden\" name=\"verifypeer\" value=\"$verifypeer\" />".
|
||||
"<input type=\"hidden\" name=\"cainfo\" value=\"".htmlspecialchars($cainfo)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxy\" value=\"".htmlspecialchars($proxy)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxyuser\" value=\"".htmlspecialchars($proxyuser)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxypwd\" value=\"".htmlspecialchars($proxypwd)."\" />".
|
||||
"<input type=\"hidden\" name=\"responsecompression\" value=\"$responsecompression\" />".
|
||||
"<input type=\"hidden\" name=\"requestcompression\" value=\"$requestcompression\" />".
|
||||
"<input type=\"hidden\" name=\"clientcookies\" value=\"".htmlspecialchars($clientcookies)."\" />".
|
||||
"<input type=\"hidden\" name=\"protocol\" value=\"$protocol\" />".
|
||||
"<input type=\"hidden\" name=\"timeout\" value=\"".htmlspecialchars($timeout)."\" />".
|
||||
"<input type=\"hidden\" name=\"method\" value=\"".$rec->scalarval()."\" />".
|
||||
"<input type=\"hidden\" name=\"wstype\" value=\"$wstype\" />".
|
||||
"<input type=\"hidden\" name=\"action\" value=\"describe\" />".
|
||||
"<input type=\"hidden\" name=\"run\" value=\"now\" />".
|
||||
"<input type=\"submit\" value=\"Describe\" /></form></td>");
|
||||
//echo("</tr>\n");
|
||||
|
||||
// generate lo scheletro per il method payload per eventuali test
|
||||
//$methodpayload="<methodCall>\n<methodName>".$rec->scalarval()."</methodName>\n<params>\n<param><value></value></param>\n</params>\n</methodCall>";
|
||||
|
||||
/*echo ("<form action=\"{$_SERVER['PHP_SELF']}\" method=\"get\"><td>".
|
||||
"<input type=\"hidden\" name=\"host\" value=\"$host\" />".
|
||||
"<input type=\"hidden\" name=\"port\" value=\"$port\" />".
|
||||
"<input type=\"hidden\" name=\"path\" value=\"$path\" />".
|
||||
"<input type=\"hidden\" name=\"method\" value=\"".$rec->scalarval()."\" />".
|
||||
"<input type=\"hidden\" name=\"methodpayload\" value=\"$payload\" />".
|
||||
"<input type=\"hidden\" name=\"action\" value=\"execute\" />".
|
||||
"<input type=\"submit\" value=\"Test\" /></td></form>");*/
|
||||
echo("</tr>\n");
|
||||
}
|
||||
echo "</tbody>\n</table>";
|
||||
}
|
||||
break;
|
||||
|
||||
case 'describe':
|
||||
|
||||
$r1 = $resp[0]->value();
|
||||
$r2 = $resp[1]->value();
|
||||
|
||||
echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
|
||||
echo "<thead>\n<tr><th>Method</th><th>".htmlspecialchars($method)."</th><th> </th><th> </th></tr>\n</thead>\n<tbody>\n";
|
||||
$desc = htmlspecialchars($r1->scalarval());
|
||||
if ($desc == "")
|
||||
$desc = "-";
|
||||
echo "<tr><td class=\"evenrow\">Description</td><td colspan=\"3\" class=\"evenrow\">$desc</td></tr>\n";
|
||||
$payload="";
|
||||
$alt_payload="";
|
||||
if ($r2->kindOf()!="array")
|
||||
echo "<tr><td class=\"oddrow\">Signature</td><td class=\"oddrow\">Unknown</td><td class=\"oddrow\"> </td></tr>\n";
|
||||
else
|
||||
{
|
||||
for($i=0; $i < $r2->arraysize(); $i++)
|
||||
{
|
||||
if ($i+1%2) $class=' class="oddrow"'; else $class = ' class="evenrow"';
|
||||
echo "<tr><td$class>Signature ".($i+1)."</td><td$class>";
|
||||
$x = $r2->arraymem($i);
|
||||
if ($x->kindOf()=="array")
|
||||
{
|
||||
$ret = $x->arraymem(0);
|
||||
echo "<code>OUT: " . htmlspecialchars($ret->scalarval()) . "<br />IN: (";
|
||||
if ($x->arraysize() > 1)
|
||||
{
|
||||
for($k = 1; $k < $x->arraysize(); $k++)
|
||||
{
|
||||
$y = $x->arraymem($k);
|
||||
echo $y->scalarval();
|
||||
if ($wstype != 1)
|
||||
{
|
||||
$payload = $payload . '<param><value><'.htmlspecialchars($y->scalarval()).'></'.htmlspecialchars($y->scalarval())."></value></param>\n";
|
||||
}
|
||||
$alt_payload .= $y->scalarval();
|
||||
if ($k < $x->arraysize()-1)
|
||||
{
|
||||
$alt_payload .= ';';
|
||||
echo ", ";
|
||||
}
|
||||
}
|
||||
}
|
||||
echo ")</code>";
|
||||
}
|
||||
else
|
||||
{
|
||||
echo 'Unknown';
|
||||
}
|
||||
echo '</td>';
|
||||
//bottone per testare questo metodo
|
||||
//$payload="<methodCall>\n<methodName>$method</methodName>\n<params>\n$payload</params>\n</methodCall>";
|
||||
echo "<td$class><form action=\"controller.php\" target=\"frmcontroller\" method=\"get\">".
|
||||
"<input type=\"hidden\" name=\"host\" value=\"".htmlspecialchars($host)."\" />".
|
||||
"<input type=\"hidden\" name=\"port\" value=\"".htmlspecialchars($port)."\" />".
|
||||
"<input type=\"hidden\" name=\"path\" value=\"".htmlspecialchars($path)."\" />".
|
||||
"<input type=\"hidden\" name=\"id\" value=\"".htmlspecialchars($id)."\" />".
|
||||
"<input type=\"hidden\" name=\"debug\" value=\"$debug\" />".
|
||||
"<input type=\"hidden\" name=\"username\" value=\"".htmlspecialchars($username)."\" />".
|
||||
"<input type=\"hidden\" name=\"password\" value=\"".htmlspecialchars($password)."\" />".
|
||||
"<input type=\"hidden\" name=\"authtype\" value=\"$authtype\" />".
|
||||
"<input type=\"hidden\" name=\"verifyhost\" value=\"$verifyhost\" />".
|
||||
"<input type=\"hidden\" name=\"verifypeer\" value=\"$verifypeer\" />".
|
||||
"<input type=\"hidden\" name=\"cainfo\" value=\"".htmlspecialchars($cainfo)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxy\" value=\"".htmlspecialchars($proxy)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxyuser\" value=\"".htmlspecialchars($proxyuser)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxypwd\" value=\"".htmlspecialchars($proxypwd)."\" />".
|
||||
"<input type=\"hidden\" name=\"responsecompression\" value=\"$responsecompression\" />".
|
||||
"<input type=\"hidden\" name=\"requestcompression\" value=\"$requestcompression\" />".
|
||||
"<input type=\"hidden\" name=\"clientcookies\" value=\"".htmlspecialchars($clientcookies)."\" />".
|
||||
"<input type=\"hidden\" name=\"protocol\" value=\"$protocol\" />".
|
||||
"<input type=\"hidden\" name=\"timeout\" value=\"".htmlspecialchars($timeout)."\" />".
|
||||
"<input type=\"hidden\" name=\"method\" value=\"".htmlspecialchars($method)."\" />".
|
||||
"<input type=\"hidden\" name=\"methodpayload\" value=\"".htmlspecialchars($payload)."\" />".
|
||||
"<input type=\"hidden\" name=\"altmethodpayload\" value=\"".htmlspecialchars($alt_payload)."\" />".
|
||||
"<input type=\"hidden\" name=\"wstype\" value=\"$wstype\" />".
|
||||
"<input type=\"hidden\" name=\"action\" value=\"execute\" />";
|
||||
if ($wstype != 1)
|
||||
echo "<input type=\"submit\" value=\"Load method synopsis\" />";
|
||||
echo "</form></td>\n";
|
||||
|
||||
echo "<td$class><form action=\"controller.php\" target=\"frmcontroller\" method=\"get\">".
|
||||
"<input type=\"hidden\" name=\"host\" value=\"".htmlspecialchars($host)."\" />".
|
||||
"<input type=\"hidden\" name=\"port\" value=\"".htmlspecialchars($port)."\" />".
|
||||
"<input type=\"hidden\" name=\"path\" value=\"".htmlspecialchars($path)."\" />".
|
||||
"<input type=\"hidden\" name=\"id\" value=\"".htmlspecialchars($id)."\" />".
|
||||
"<input type=\"hidden\" name=\"debug\" value=\"$debug\" />".
|
||||
"<input type=\"hidden\" name=\"username\" value=\"".htmlspecialchars($username)."\" />".
|
||||
"<input type=\"hidden\" name=\"password\" value=\"".htmlspecialchars($password)."\" />".
|
||||
"<input type=\"hidden\" name=\"authtype\" value=\"$authtype\" />".
|
||||
"<input type=\"hidden\" name=\"verifyhost\" value=\"$verifyhost\" />".
|
||||
"<input type=\"hidden\" name=\"verifypeer\" value=\"$verifypeer\" />".
|
||||
"<input type=\"hidden\" name=\"cainfo\" value=\"".htmlspecialchars($cainfo)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxy\" value=\"".htmlspecialchars($proxy)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxyuser\" value=\"".htmlspecialchars($proxyuser)."\" />".
|
||||
"<input type=\"hidden\" name=\"proxypwd\" value=\"".htmlspecialchars($proxypwd)."\" />".
|
||||
"<input type=\"hidden\" name=\"responsecompression\" value=\"$responsecompression\" />".
|
||||
"<input type=\"hidden\" name=\"requestcompression\" value=\"$requestcompression\" />".
|
||||
"<input type=\"hidden\" name=\"clientcookies\" value=\"".htmlspecialchars($clientcookies)."\" />".
|
||||
"<input type=\"hidden\" name=\"protocol\" value=\"$protocol\" />".
|
||||
"<input type=\"hidden\" name=\"timeout\" value=\"".htmlspecialchars($timeout)."\" />".
|
||||
"<input type=\"hidden\" name=\"method\" value=\"".htmlspecialchars($method)."\" />".
|
||||
"<input type=\"hidden\" name=\"methodsig\" value=\"".$i."\" />".
|
||||
"<input type=\"hidden\" name=\"methodpayload\" value=\"".htmlspecialchars($payload)."\" />".
|
||||
"<input type=\"hidden\" name=\"altmethodpayload\" value=\"".htmlspecialchars($alt_payload)."\" />".
|
||||
"<input type=\"hidden\" name=\"wstype\" value=\"$wstype\" />".
|
||||
"<input type=\"hidden\" name=\"run\" value=\"now\" />".
|
||||
"<input type=\"hidden\" name=\"action\" value=\"wrap\" />".
|
||||
"<input type=\"submit\" value=\"Generate method call stub code\" />";
|
||||
echo "</form></td></tr>\n";
|
||||
|
||||
}
|
||||
}
|
||||
echo "</tbody>\n</table>";
|
||||
|
||||
break;
|
||||
|
||||
case 'wrap':
|
||||
$r1 = $resp[0]->value();
|
||||
$r2 = $resp[1]->value();
|
||||
if ($r2->kindOf()!="array" || $r2->arraysize() <= $methodsig)
|
||||
echo "Error: signature unknown\n";
|
||||
else
|
||||
{
|
||||
$mdesc = $r1->scalarval();
|
||||
$msig = php_xmlrpc_decode($r2);
|
||||
$msig = $msig[$methodsig];
|
||||
$proto = $protocol == 2 ? 'https' : $protocol == 1 ? 'http11' : '';
|
||||
if ($proxy == '' && $username == '' && !$requestcompression && !$responsecompression &&
|
||||
$clientcookies == '')
|
||||
{
|
||||
$opts = 0; // simple client copy in stub code
|
||||
}
|
||||
else
|
||||
{
|
||||
$opts = 1; // complete client copy in stub code
|
||||
}
|
||||
if ($wstype == 1)
|
||||
{
|
||||
$prefix = 'jsonrpc';
|
||||
}
|
||||
else
|
||||
{
|
||||
$prefix = 'xmlrpc';
|
||||
}
|
||||
//$code = wrap_xmlrpc_method($client, $method, $methodsig, 0, $proto, '', $opts);
|
||||
$code = build_remote_method_wrapper_code($client, $method, str_replace('.', '_', $prefix.'_'.$method), $msig, $mdesc, $timeout, $proto, $opts, $prefix);
|
||||
//if ($code)
|
||||
//{
|
||||
echo "<div id=\"phpcode\">\n";
|
||||
highlight_string("<?php\n".$code['docstring'].$code['source'].'?>');
|
||||
echo "\n</div>";
|
||||
//}
|
||||
//else
|
||||
//{
|
||||
// echo 'Error while building php code stub...';
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
case 'execute':
|
||||
echo '<div id="response"><h2>Response:</h2>'.htmlspecialchars($response->serialize()).'</div>';
|
||||
break;
|
||||
|
||||
default: // give a warning
|
||||
}
|
||||
} // if !$response->faultCode()
|
||||
} // if $response
|
||||
}
|
||||
else
|
||||
{
|
||||
// no action taken yet: give some instructions on debugger usage
|
||||
?>
|
||||
|
||||
<h3>Instructions on usage of the debugger:</h3>
|
||||
<ol>
|
||||
<li>Run a 'list available methods' action against desired server</li>
|
||||
<li>If list of methods appears, click on 'describe method' for desired method</li>
|
||||
<li>To run method: click on 'load method synopsis' for desired method. This will load a skeleton for method call parameters in the form above. Complete all xmlrpc values with appropriate data and click 'Execute'</li>
|
||||
</ol>
|
||||
<?php
|
||||
if (!extension_loaded('curl'))
|
||||
{
|
||||
echo "<p class=\"evidence\">You will need to enable the CURL extension to use the HTTPS and HTTP 1.1 transports</p>\n";
|
||||
}
|
||||
?>
|
||||
|
||||
<h3>Example:</h3>
|
||||
<p>
|
||||
Server Address: phpxmlrpc.sourceforge.net<br/>
|
||||
Path: /server.php
|
||||
</p>
|
||||
|
||||
<h3>Notice:</h3>
|
||||
<p>all usernames and passwords entered on the above form will be written to the web server logs of this server. Use with care.</p>
|
||||
|
||||
<h3>Changelog</h3>
|
||||
<ul>
|
||||
<li>2007-02-20: add visual editor for method payload; allow strings, bools as jsonrpc msg id</li>
|
||||
<li>2006-06-26: support building php code stub for calling remote methods</li>
|
||||
<li>2006-05-25: better support for long running queries; check for no-curl installs</li>
|
||||
<li>2006-05-02: added support for JSON-RPC. Note that many interesting json-rpc features are not implemented yet, such as notifications or multicall.</li>
|
||||
<li>2006-04-22: added option for setting custom CA certs to verify peer with in SSLmode</li>
|
||||
<li>2006-03-05: added option for setting Basic/Digest/NTLM auth type</li>
|
||||
<li>2006-01-18: added option echoing to screen xmlrpc request before sending it ('More' debug)</li>
|
||||
<li>2005-10-01: added option for setting cookies to be sent to server</li>
|
||||
<li>2005-08-07: added switches for compression of requests and responses and http 1.1</li>
|
||||
<li>2005-06-27: fixed possible security breach in parsing malformed xml</li>
|
||||
<li>2005-06-24: fixed error with calling methods having parameters...</li>
|
||||
</ul>
|
||||
<?php
|
||||
}
|
||||
?>
|
||||
</body>
|
||||
</html>
|
||||
135
include/limesurvey/admin/classes/xmlrpc/debugger/common.php
Normal file
135
include/limesurvey/admin/classes/xmlrpc/debugger/common.php
Normal file
@@ -0,0 +1,135 @@
|
||||
<?php
|
||||
/**
|
||||
* @version $Id: common.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @author Gaetano Giunta
|
||||
* @copyright (C) 2005-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*
|
||||
* @todo switch params for http compression from 0,1,2 to values to be used directly
|
||||
* @todo do some more sanitization of received parameters
|
||||
*/
|
||||
|
||||
// work around magic quotes
|
||||
if (get_magic_quotes_gpc())
|
||||
{
|
||||
function stripslashes_deep($value)
|
||||
{
|
||||
$value = is_array($value) ?
|
||||
array_map('stripslashes_deep', $value) :
|
||||
stripslashes($value);
|
||||
|
||||
return $value;
|
||||
}
|
||||
$_GET = array_map('stripslashes_deep', $_GET);
|
||||
}
|
||||
|
||||
|
||||
if ( isset( $_GET['usepost'] ) && $_GET['usepost'] === 'true' )
|
||||
{
|
||||
$_GET = $_POST;
|
||||
}
|
||||
|
||||
// recover input parameters
|
||||
$debug = false;
|
||||
$protocol = 0;
|
||||
$run = false;
|
||||
$wstype = 0;
|
||||
$id = '';
|
||||
if (isset($_GET['action']))
|
||||
{
|
||||
if (isset($_GET['wstype']) && $_GET['wstype'] == '1')
|
||||
{
|
||||
$wstype = 1;
|
||||
if (isset($_GET['id']))
|
||||
$id = $_GET['id'];
|
||||
}
|
||||
$host = isset($_GET['host']) ? $_GET['host'] : 'localhost'; // using '' will trigger an xmlrpc error...
|
||||
if (isset($_GET['protocol']) && ($_GET['protocol'] == '1' || $_GET['protocol'] == '2'))
|
||||
$protocol = $_GET['protocol'];
|
||||
if (strpos($host, 'http://') === 0)
|
||||
$host = substr($host, 7);
|
||||
else if (strpos($host, 'https://') === 0)
|
||||
{
|
||||
$host = substr($host, 8);
|
||||
$protocol = 2;
|
||||
}
|
||||
$port = isset($_GET['port']) ? $_GET['port'] : '';
|
||||
$path = isset($_GET['path']) ? $_GET['path'] : '';
|
||||
// in case user forgot initial '/' in xmlrpc server path, add it back
|
||||
if ($path && ($path[0]) != '/')
|
||||
$path = '/'.$path;
|
||||
|
||||
if (isset($_GET['debug']) && ($_GET['debug'] == '1' || $_GET['debug'] == '2'))
|
||||
$debug = $_GET['debug'];
|
||||
|
||||
$verifyhost = (isset($_GET['verifyhost']) && ($_GET['verifyhost'] == '1' || $_GET['verifyhost'] == '2')) ? $_GET['verifyhost'] : 0;
|
||||
if (isset($_GET['verifypeer']) && $_GET['verifypeer'] == '1')
|
||||
$verifypeer = true;
|
||||
else
|
||||
$verifypeer = false;
|
||||
$cainfo= isset($_GET['cainfo']) ? $_GET['cainfo'] : '';
|
||||
$proxy = isset($_GET['proxy']) ? $_GET['proxy'] : 0;
|
||||
if (strpos($proxy, 'http://') === 0)
|
||||
$proxy = substr($proxy, 7);
|
||||
$proxyuser= isset($_GET['proxyuser']) ? $_GET['proxyuser'] : '';
|
||||
$proxypwd = isset($_GET['proxypwd']) ? $_GET['proxypwd'] : '';
|
||||
$timeout = isset($_GET['timeout']) ? $_GET['timeout'] : 0;
|
||||
if (!is_numeric($timeout))
|
||||
$timeout = 0;
|
||||
$action = $_GET['action'];
|
||||
|
||||
$method = isset($_GET['method']) ? $_GET['method'] : '';
|
||||
$methodsig = isset($_GET['methodsig']) ? $_GET['methodsig'] : 0;
|
||||
$payload = isset($_GET['methodpayload']) ? $_GET['methodpayload'] : '';
|
||||
$alt_payload = isset($_GET['altmethodpayload']) ? $_GET['altmethodpayload'] : '';
|
||||
|
||||
if (isset($_GET['run']) && $_GET['run'] == 'now')
|
||||
$run = true;
|
||||
|
||||
$username = isset($_GET['username']) ? $_GET['username'] : '';
|
||||
$password = isset($_GET['password']) ? $_GET['password'] : '';
|
||||
|
||||
$authtype = (isset($_GET['authtype']) && ($_GET['authtype'] == '2' || $_GET['authtype'] == '8')) ? $_GET['authtype'] : 1;
|
||||
|
||||
if (isset($_GET['requestcompression']) && ($_GET['requestcompression'] == '1' || $_GET['requestcompression'] == '2'))
|
||||
$requestcompression = $_GET['requestcompression'];
|
||||
else
|
||||
$requestcompression = 0;
|
||||
if (isset($_GET['responsecompression']) && ($_GET['responsecompression'] == '1' || $_GET['responsecompression'] == '2' || $_GET['responsecompression'] == '3'))
|
||||
$responsecompression = $_GET['responsecompression'];
|
||||
else
|
||||
$responsecompression = 0;
|
||||
|
||||
$clientcookies = isset($_GET['clientcookies']) ? $_GET['clientcookies'] : '';
|
||||
}
|
||||
else
|
||||
{
|
||||
$host = '';
|
||||
$port = '';
|
||||
$path = '';
|
||||
$action = '';
|
||||
$method = '';
|
||||
$methodsig = 0;
|
||||
$payload = '';
|
||||
$alt_payload = '';
|
||||
$username = '';
|
||||
$password = '';
|
||||
$authtype = 1;
|
||||
$verifyhost = 0;
|
||||
$verifypeer = false;
|
||||
$cainfo = '';
|
||||
$proxy = '';
|
||||
$proxyuser = '';
|
||||
$proxypwd = '';
|
||||
$timeout = 0;
|
||||
$requestcompression = 0;
|
||||
$responsecompression = 0;
|
||||
$clientcookies = '';
|
||||
}
|
||||
|
||||
// check input for known XMLRPC attacks against this or other libs
|
||||
function payload_is_safe($input)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
?>
|
||||
321
include/limesurvey/admin/classes/xmlrpc/debugger/controller.php
Normal file
321
include/limesurvey/admin/classes/xmlrpc/debugger/controller.php
Normal file
@@ -0,0 +1,321 @@
|
||||
<?php
|
||||
/**
|
||||
* @version $Id: controller.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @author Gaetano Giunta
|
||||
* @copyright (C) 2005-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*
|
||||
* @todo add links to documentation from every option caption
|
||||
* @todo switch params for http compression from 0,1,2 to values to be used directly
|
||||
* @todo add a little bit more CSS formatting: we broke IE box model getting a width > 100%...
|
||||
* @todo add support for more options, such as ntlm auth to proxy, or request charset encoding
|
||||
*
|
||||
* @todo parse content of payload textarea to be fed to visual editor
|
||||
* @todo add http no-cache headers
|
||||
**/
|
||||
|
||||
include(getcwd().'/common.php');
|
||||
if ($action == '')
|
||||
$action = 'list';
|
||||
|
||||
// relative path to the visual xmlrpc editing dialog
|
||||
$editorpath = '../../javascript/';
|
||||
?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>XMLRPC Debugger</title>
|
||||
<meta name="robots" content="index,nofollow" />
|
||||
<script type="text/javascript" language="Javascript">
|
||||
if (window.name!='frmcontroller')
|
||||
top.location.replace('index.php?run='+escape(self.location));
|
||||
</script>
|
||||
<!-- xmlrpc/jsonrpc base library -->
|
||||
<script type="text/javascript" src="<?php echo $editorpath; ?>xmlrpc_lib.js"></script>
|
||||
<script type="text/javascript" src="<?php echo $editorpath; ?>jsonrpc_lib.js"></script>
|
||||
<style type="text/css">
|
||||
<!--
|
||||
html {overflow: -moz-scrollbars-vertical;}
|
||||
body {padding: 0.5em; background-color: #EEEEEE; font-family: Verdana, Arial, Helvetica; font-size: 8pt;}
|
||||
h1 {font-size: 12pt; margin: 0.5em;}
|
||||
h2 {font-size: 10pt; display: inline; vertical-align: top;}
|
||||
table {border: 1px solid gray; margin-bottom: 0.5em; padding: 0.25em; width: 100%;}
|
||||
#methodpayload {display: inline;}
|
||||
td {vertical-align: top; font-family: Verdana, Arial, Helvetica; font-size: 8pt;}
|
||||
.labelcell {text-align: right;}
|
||||
-->
|
||||
</style>
|
||||
<script language="JavaScript" type="text/javascript">
|
||||
<!--
|
||||
function verifyserver()
|
||||
{
|
||||
if (document.frmaction.host.value == '')
|
||||
{
|
||||
alert('Please insert a server name or address');
|
||||
return false;
|
||||
}
|
||||
if (document.frmaction.path.value == '')
|
||||
document.frmaction.path.value = '/';
|
||||
var action = '';
|
||||
for (counter = 0; counter < document.frmaction.action.length; counter++)
|
||||
if (document.frmaction.action[counter].checked)
|
||||
{
|
||||
action = document.frmaction.action[counter].value;
|
||||
}
|
||||
if (document.frmaction.method.value == '' && (action == 'execute' || action == 'wrap' || action == 'describe'))
|
||||
{
|
||||
alert('Please insert a method name');
|
||||
return false;
|
||||
}
|
||||
if (document.frmaction.authtype.value != '1' && document.frmaction.username.value == '')
|
||||
{
|
||||
alert('No username for authenticating to server: authentication disabled');
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function switchaction()
|
||||
{
|
||||
// reset html layout depending on action to be taken
|
||||
var action = '';
|
||||
for (counter = 0; counter < document.frmaction.action.length; counter++)
|
||||
if (document.frmaction.action[counter].checked)
|
||||
{
|
||||
action = document.frmaction.action[counter].value;
|
||||
}
|
||||
if (action == 'execute')
|
||||
{
|
||||
document.frmaction.methodpayload.disabled = false;
|
||||
displaydialogeditorbtn(true);//if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = false;
|
||||
document.frmaction.method.disabled = false;
|
||||
document.frmaction.methodpayload.rows = 10;
|
||||
}
|
||||
else
|
||||
{
|
||||
document.frmaction.methodpayload.rows = 1;
|
||||
if (action == 'describe' || action == 'wrap')
|
||||
{
|
||||
document.frmaction.methodpayload.disabled = true;
|
||||
displaydialogeditorbtn(false); //if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = true;
|
||||
document.frmaction.method.disabled = false;
|
||||
}
|
||||
else // list
|
||||
{
|
||||
document.frmaction.methodpayload.disabled = true;
|
||||
displaydialogeditorbtn(false); //if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = false;
|
||||
document.frmaction.method.disabled = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function switchssl()
|
||||
{
|
||||
if (document.frmaction.protocol.value != '2')
|
||||
{
|
||||
document.frmaction.verifypeer.disabled = true;
|
||||
document.frmaction.verifyhost.disabled = true;
|
||||
document.frmaction.cainfo.disabled = true;
|
||||
}
|
||||
else
|
||||
{
|
||||
document.frmaction.verifypeer.disabled = false;
|
||||
document.frmaction.verifyhost.disabled = false;
|
||||
document.frmaction.cainfo.disabled = false;
|
||||
}
|
||||
}
|
||||
|
||||
function switchauth()
|
||||
{
|
||||
if (document.frmaction.protocol.value != '0')
|
||||
{
|
||||
document.frmaction.authtype.disabled = false;
|
||||
}
|
||||
else
|
||||
{
|
||||
document.frmaction.authtype.disabled = true;
|
||||
document.frmaction.authtype.value = 1;
|
||||
}
|
||||
}
|
||||
|
||||
function swicthcainfo()
|
||||
{
|
||||
if (document.frmaction.verifypeer.checked == true)
|
||||
{
|
||||
document.frmaction.cainfo.disabled = false;
|
||||
}
|
||||
else
|
||||
{
|
||||
document.frmaction.cainfo.disabled = true;
|
||||
}
|
||||
}
|
||||
|
||||
function switchtransport(is_json)
|
||||
{
|
||||
if (is_json == 0)
|
||||
{
|
||||
document.getElementById("idcell").style.visibility = 'hidden';
|
||||
document.frmjsonrpc.yes.checked = false;
|
||||
document.frmxmlrpc.yes.checked = true;
|
||||
document.frmaction.wstype.value="0";
|
||||
}
|
||||
else
|
||||
{
|
||||
document.getElementById("idcell").style.visibility = 'visible';
|
||||
document.frmjsonrpc.yes.checked = true;
|
||||
document.frmxmlrpc.yes.checked = false;
|
||||
document.frmaction.wstype.value="1";
|
||||
}
|
||||
}
|
||||
|
||||
function displaydialogeditorbtn(show)
|
||||
{
|
||||
if (show && ((typeof base64_decode) == 'function'))
|
||||
{
|
||||
document.getElementById('methodpayloadbtn').innerHTML = '[<a href="#" onclick="activateeditor(); return false;">Edit</a>]';
|
||||
}
|
||||
else
|
||||
{
|
||||
document.getElementById('methodpayloadbtn').innerHTML = '';
|
||||
}
|
||||
}
|
||||
|
||||
function activateeditor()
|
||||
{
|
||||
var url = '<?php echo $editorpath; ?>visualeditor.php?params=<?php echo $alt_payload; ?>';
|
||||
if (document.frmaction.wstype.value == "1")
|
||||
url += '&type=jsonrpc';
|
||||
var wnd = window.open(url, '_blank', 'width=750, height=400, location=0, resizable=1, menubar=0, scrollbars=1');
|
||||
}
|
||||
|
||||
// if javascript version of the lib is found, allow it to send us params
|
||||
function buildparams(base64data)
|
||||
{
|
||||
if (typeof base64_decode == 'function')
|
||||
{
|
||||
if (base64data == '0') // workaround for bug in base64_encode...
|
||||
document.getElementById('methodpayload').value = '';
|
||||
else
|
||||
document.getElementById('methodpayload').value = base64_decode(base64data);
|
||||
}
|
||||
}
|
||||
|
||||
// use GET for ease of refresh, switch to POST when payload is too big to fit in url (in IE: 2048 bytes! see http://support.microsoft.com/kb/q208427/)
|
||||
function switchFormMethod()
|
||||
{
|
||||
/// @todo use a more precise calculation, adding the rest of the fields to the actual generated url lenght
|
||||
if (document.frmaction.methodpayload.value.length > 1536 )
|
||||
{
|
||||
document.frmaction.action = 'action.php?usepost=true';
|
||||
document.frmaction.method = 'post';
|
||||
}
|
||||
}
|
||||
|
||||
//-->
|
||||
</script>
|
||||
</head>
|
||||
<body onload="switchtransport(<?php echo $wstype;?>); switchaction(); switchssl(); switchauth(); swicthcainfo();<?php if ($run) echo ' document.forms[2].submit();'; ?>">
|
||||
<h1>XMLRPC <form name="frmxmlrpc" style="display: inline;" action="."><input name="yes" type="radio" onclick="switchtransport(0);"/></form>
|
||||
/<form name="frmjsonrpc" style="display: inline;" action="."><input name="yes" type="radio" onclick="switchtransport(1);"/></form>JSONRPC Debugger (based on the <a href="http://phpxmlrpc.sourceforge.net">PHP-XMLRPC</a> library)</h1>
|
||||
<form name="frmaction" method="get" action="action.php" target="frmaction" onSubmit="switchFormMethod();"
|
||||
>
|
||||
|
||||
<table id="serverblock">
|
||||
<tr>
|
||||
<td><h2>Target server</h2></td>
|
||||
<td class="labelcell">Address:</td><td><input type="text" name="host" value="<?php echo htmlspecialchars($host); ?>" /></td>
|
||||
<td class="labelcell">Port:</td><td><input type="text" name="port" value="<?php echo htmlspecialchars($port); ?>" size="5" maxlength="5" /></td>
|
||||
<td class="labelcell">Path:</td><td><input type="text" name="path" value="<?php echo htmlspecialchars($path); ?>" /></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table id="actionblock">
|
||||
<tr>
|
||||
<td><h2>Action</h2></td>
|
||||
<td>List available methods<input type="radio" name="action" value="list"<?php if ($action=='list') echo ' checked="checked"'; ?> onclick="switchaction();" /></td>
|
||||
<td>Describe method<input type="radio" name="action" value="describe"<?php if ($action=='describe') echo ' checked="checked"'; ?> onclick="switchaction();" /></td>
|
||||
<td>Execute method<input type="radio" name="action" value="execute"<?php if ($action=='execute') echo ' checked="checked"'; ?> onclick="switchaction();" /></td>
|
||||
<td>Generate stub for method call<input type="radio" name="action" value="wrap"<?php if ($action=='wrap') echo ' checked="checked"'; ?> onclick="switchaction();" /></td>
|
||||
</tr>
|
||||
</table>
|
||||
<input type="hidden" name="methodsig" value="<?php echo htmlspecialchars($methodsig); ?>" />
|
||||
|
||||
<table id="methodblock">
|
||||
<tr>
|
||||
<td><h2>Method</h2></td>
|
||||
<td class="labelcell">Name:</td><td><input type="text" name="method" value="<?php echo htmlspecialchars($method); ?>" /></td>
|
||||
<td class="labelcell">Payload:<br/><div id="methodpayloadbtn"></div></td><td><textarea id="methodpayload" name="methodpayload" rows="1" cols="40"><?php echo htmlspecialchars($payload); ?></textarea></td>
|
||||
<td class="labelcell" id="idcell">Msg id: <input type="text" name="id" size="3" value="<?php echo htmlspecialchars($id); ?>"/></td>
|
||||
<td><input type="hidden" name="wstype" value="<?php echo $wstype;?>" />
|
||||
<input type="submit" value="Execute" onclick="return verifyserver();"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table id="optionsblock">
|
||||
<tr>
|
||||
<td><h2>Client options</h2></td>
|
||||
<td class="labelcell">Show debug info:</td><td><select name="debug">
|
||||
<option value="0"<?php if ($debug == 0) echo ' selected="selected"'; ?>>No</option>
|
||||
<option value="1"<?php if ($debug == 1) echo ' selected="selected"'; ?>>Yes</option>
|
||||
<option value="2"<?php if ($debug == 2) echo ' selected="selected"'; ?>>More</option>
|
||||
</select>
|
||||
</td>
|
||||
<td class="labelcell">Timeout:</td><td><input type="text" name="timeout" size="3" value="<?php if ($timeout > 0) echo $timeout; ?>" /></td>
|
||||
<td class="labelcell">Protocol:</td><td><select name="protocol" onchange="switchssl(); switchauth(); swicthcainfo();">
|
||||
<option value="0"<?php if ($protocol == 0) echo ' selected="selected"'; ?>>HTTP 1.0</option>
|
||||
<option value="1"<?php if ($protocol == 1) echo ' selected="selected"'; ?>>HTTP 1.1</option>
|
||||
<option value="2"<?php if ($protocol == 2) echo ' selected="selected"'; ?>>HTTPS</option>
|
||||
</select></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="labelcell">AUTH:</td>
|
||||
<td class="labelcell">Username:</td><td><input type="text" name="username" value="<?php echo htmlspecialchars($username); ?>" /></td>
|
||||
<td class="labelcell">Pwd:</td><td><input type="password" name="password" value="<?php echo htmlspecialchars($password); ?>" /></td>
|
||||
<td class="labelcell">Type</td><td><select name="authtype">
|
||||
<option value="1"<?php if ($authtype == 1) echo ' selected="selected"'; ?>>Basic</option>
|
||||
<option value="2"<?php if ($authtype == 2) echo ' selected="selected"'; ?>>Digest</option>
|
||||
<option value="8"<?php if ($authtype == 8) echo ' selected="selected"'; ?>>NTLM</option>
|
||||
</select></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="labelcell">SSL:</td>
|
||||
<td class="labelcell">Verify Host's CN:</td><td><select name="verifyhost">
|
||||
<option value="0"<?php if ($verifyhost == 0) echo ' selected="selected"'; ?>>No</option>
|
||||
<option value="1"<?php if ($verifyhost == 1) echo ' selected="selected"'; ?>>Check CN existance</option>
|
||||
<option value="2"<?php if ($verifyhost == 2) echo ' selected="selected"'; ?>>Check CN match</option>
|
||||
</select></td>
|
||||
<td class="labelcell">Verify Cert:</td><td><input type="checkbox" value="1" name="verifypeer" onclick="swicthcainfo();"<?php if ($verifypeer) echo ' checked="checked"'; ?> /></td>
|
||||
<td class="labelcell">CA Cert file:</td><td><input type="text" name="cainfo" value="<?php echo htmlspecialchars($cainfo); ?>" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="labelcell">PROXY:</td>
|
||||
<td class="labelcell">Server:</td><td><input type="text" name="proxy" value="<?php echo htmlspecialchars($proxy); ?>" /></td>
|
||||
<td class="labelcell">Proxy user:</td><td><input type="text" name="proxyuser" value="<?php echo htmlspecialchars($proxyuser); ?>" /></td>
|
||||
<td class="labelcell">Proxy pwd:</td><td><input type="password" name="proxypwd" value="<?php echo htmlspecialchars($proxypwd); ?>" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="labelcell">COMPRESSION:</td>
|
||||
<td class="labelcell">Request:</td><td><select name="requestcompression">
|
||||
<option value="0"<?php if ($requestcompression == 0) echo ' selected="selected"'; ?>>None</option>
|
||||
<option value="1"<?php if ($requestcompression == 1) echo ' selected="selected"'; ?>>Gzip</option>
|
||||
<option value="2"<?php if ($requestcompression == 2) echo ' selected="selected"'; ?>>Deflate</option>
|
||||
</select></td>
|
||||
<td class="labelcell">Response:</td><td><select name="responsecompression">
|
||||
<option value="0"<?php if ($responsecompression == 0) echo ' selected="selected"'; ?>>None</option>
|
||||
<option value="1"<?php if ($responsecompression == 1) echo ' selected="selected"'; ?>>Gzip</option>
|
||||
<option value="2"<?php if ($responsecompression == 2) echo ' selected="selected"'; ?>>Deflate</option>
|
||||
<option value="3"<?php if ($responsecompression == 3) echo ' selected="selected"'; ?>>Any</option>
|
||||
</select></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="labelcell">COOKIES:</td>
|
||||
<td colspan="4" class="labelcell"><input type="text" name="clientcookies" size="80" value="<?php echo htmlspecialchars($clientcookies); ?>" /></td>
|
||||
<td colspan="2">Format: 'cookie1=value1, cookie2=value2'</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</form>
|
||||
</body>
|
||||
</html>
|
||||
21
include/limesurvey/admin/classes/xmlrpc/debugger/index.php
Normal file
21
include/limesurvey/admin/classes/xmlrpc/debugger/index.php
Normal file
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
// $Id: index.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
$query = '';
|
||||
if (isset($_GET['run']))
|
||||
{
|
||||
$path = parse_url($_GET['run']);
|
||||
if (isset($path['query']))
|
||||
$query = '?'.$path['query'];
|
||||
}
|
||||
?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>XMLRPC Debugger</title>
|
||||
</head>
|
||||
<frameset rows="360,*">
|
||||
<frame name="frmcontroller" src="controller.php<?php echo htmlspecialchars($query); ?>" marginwidth="0" marginheight="0" frameborder="0" />
|
||||
<frame name="frmaction" src="action.php" marginwidth="0" marginheight="0" frameborder="0" />
|
||||
</frameset>
|
||||
</html>
|
||||
@@ -0,0 +1 @@
|
||||
<html><head><title>xmlrpc</title></head><body><h1>Agesort demo</h1><h2>Send an array of 'name' => 'age' pairs to the server that will send it back sorted.</h2><h3>The source code demonstrates basic lib usage, including handling of xmlrpc arrays and structs</h3><p></p><?phpinclude("xmlrpc.inc");$inAr=array("Dave" => 24, "Edd" => 45, "Joe" => 37, "Fred" => 27);reset($inAr);print "This is the input data:<br/><pre>";while (list($key, $val)=each($inAr)) { print $key . ", " . $val . "\n";}print "</pre>";// create parameters from the input array: an xmlrpc array of xmlrpc structs$p=array();foreach($inAr as $key => $val) { $p[]=new xmlrpcval(array("name" => new xmlrpcval($key), "age" => new xmlrpcval($val, "int")), "struct");}$v=new xmlrpcval($p, "array");print "Encoded into xmlrpc format it looks like this: <pre>\n" . htmlentities($v->serialize()). "</pre>\n";// create client and message objects$f=new xmlrpcmsg('examples.sortByAge', array($v));$c=new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80);// set maximum debug level, to have the complete communication printed to screen$c->setDebug(2);// send requestprint "Now sending request (detailed debug info follows)";$r=&$c->send($f);// check response for errors, and take appropriate actionif (!$r->faultCode()) { print "The server gave me these results:<pre>"; $v=$r->value(); $max=$v->arraysize(); for($i=0; $i<$max; $i++) { $rec=$v->arraymem($i); $n=$rec->structmem("name"); $a=$rec->structmem("age"); print htmlspecialchars($n->scalarval()) . ", " . htmlspecialchars($a->scalarval()) . "\n"; } print "<hr/>For nerds: I got this value back<br/><pre>" . htmlentities($r->serialize()). "</pre><hr/>\n";} else { print "An error occurred:<pre>"; print "Code: " . htmlspecialchars($r->faultCode()) . "\nReason: '" . htmlspecialchars($r->faultString()).'\'</pre><hr/>';}?><em>$Id: agesort.php 2 2009-03-16 20:22:51Z ggiunta $</em></body></html>
|
||||
@@ -0,0 +1,54 @@
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<h1>Getstatename demo</h1>
|
||||
<h2>Send a U.S. state number to the server and get back the state name</h2>
|
||||
<h3>The code demonstrates usage of the php_xmlrpc_encode function</h3>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
// Play nice to PHP 5 installations with REGISTER_LONG_ARRAYS off
|
||||
if(!isset($HTTP_POST_VARS) && isset($_POST))
|
||||
{
|
||||
$HTTP_POST_VARS = $_POST;
|
||||
}
|
||||
|
||||
if(isset($HTTP_POST_VARS["stateno"]) && $HTTP_POST_VARS["stateno"]!="")
|
||||
{
|
||||
$stateno=(integer)$HTTP_POST_VARS["stateno"];
|
||||
$f=new xmlrpcmsg('examples.getStateName',
|
||||
array(php_xmlrpc_encode($stateno))
|
||||
);
|
||||
print "<pre>Sending the following request:\n\n" . htmlentities($f->serialize()) . "\n\nDebug info of server data follows...\n\n";
|
||||
$c=new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80);
|
||||
$c->setDebug(1);
|
||||
$r=&$c->send($f);
|
||||
if(!$r->faultCode())
|
||||
{
|
||||
$v=$r->value();
|
||||
print "</pre><br/>State number " . $stateno . " is "
|
||||
. htmlspecialchars($v->scalarval()) . "<br/>";
|
||||
// print "<HR>I got this value back<BR><PRE>" .
|
||||
// htmlentities($r->serialize()). "</PRE><HR>\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
print "An error occurred: ";
|
||||
print "Code: " . htmlspecialchars($r->faultCode())
|
||||
. " Reason: '" . htmlspecialchars($r->faultString()) . "'</pre><br/>";
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$stateno = "";
|
||||
}
|
||||
|
||||
print "<form action=\"client.php\" method=\"POST\">
|
||||
<input name=\"stateno\" value=\"" . $stateno . "\"><input type=\"submit\" value=\"go\" name=\"submit\"></form>
|
||||
<p>Enter a state number to query its name</p>";
|
||||
|
||||
?>
|
||||
<hr/>
|
||||
<em>$Id: client.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
185
include/limesurvey/admin/classes/xmlrpc/demo/client/comment.php
Normal file
185
include/limesurvey/admin/classes/xmlrpc/demo/client/comment.php
Normal file
@@ -0,0 +1,185 @@
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
$mydir="/demo";
|
||||
|
||||
// define some utility functions
|
||||
function bomb() { print "</body></html>"; exit(); }
|
||||
function dispatch($client, $method, $args) {
|
||||
$msg=new xmlrpcmsg($method, $args);
|
||||
$resp=$client->send($msg);
|
||||
if (!$resp) { print "<p>IO error: ".$client->errstr."</p>"; bomb(); }
|
||||
if ($resp->faultCode()) {
|
||||
print "<p>There was an error: " . $resp->faultCode() . " " .
|
||||
$resp->faultString() . "</p>";
|
||||
bomb();
|
||||
}
|
||||
return php_xmlrpc_decode($resp->value());
|
||||
}
|
||||
|
||||
// create client for discussion server
|
||||
$dclient=new xmlrpc_client("${mydir}/discuss.php",
|
||||
"xmlrpc.usefulinc.com", 80);
|
||||
|
||||
// check if we're posting a comment, and send it if so
|
||||
@$storyid=$_POST["storyid"];
|
||||
if ($storyid) {
|
||||
|
||||
|
||||
// print "Returning to " . $HTTP_POST_VARS["returnto"];
|
||||
|
||||
$res=dispatch($dclient, "discuss.addComment",
|
||||
array(new xmlrpcval($storyid),
|
||||
new xmlrpcval(stripslashes
|
||||
(@$_POST["name"])),
|
||||
new xmlrpcval(stripslashes
|
||||
(@$_POST["commenttext"]))));
|
||||
|
||||
// send the browser back to the originating page
|
||||
Header("Location: ${mydir}/comment.php?catid=" .
|
||||
$_POST["catid"] . "&chanid=" .
|
||||
$_POST["chanid"] . "&oc=" .
|
||||
$_POST["catid"]);
|
||||
exit(0);
|
||||
}
|
||||
|
||||
// now we've got here, we're exploring the story store
|
||||
|
||||
?>
|
||||
<html><head><title>meerkat browser</title></head>
|
||||
<body bgcolor="#ffffff">
|
||||
<h2>Meerkat integration</h2>
|
||||
<?php
|
||||
@$catid=$_GET["catid"];
|
||||
if (@$_GET["oc"]==$catid)
|
||||
@$chanid=$_GET["chanid"];
|
||||
else
|
||||
$chanid=0;
|
||||
|
||||
$client=new xmlrpc_client("/meerkat/xml-rpc/server.php",
|
||||
"www.oreillynet.com", 80);
|
||||
|
||||
if (@$_GET["comment"] &&
|
||||
(!@$_GET["cdone"])) {
|
||||
// we're making a comment on a story,
|
||||
// so display a comment form
|
||||
?>
|
||||
<h3>Make a comment on the story</h3>
|
||||
<form method="post">
|
||||
<p>Your name:<br /><input type="text" size="30" name="name" /></p>
|
||||
<p>Your comment:<br /><textarea rows="5" cols="60"
|
||||
name="commenttext"></textarea></p>
|
||||
<input type="submit" value="Send comment" />
|
||||
<input type="hidden" name="storyid"
|
||||
value="<?php echo @$_GET["comment"];?>" />
|
||||
<input type="hidden" name="chanid"
|
||||
value="<?php echo $chanid; ?>" />
|
||||
<input type="hidden" name="catid"
|
||||
value="<?php echo $catid; ?>" />
|
||||
|
||||
</form>
|
||||
<?php
|
||||
} else {
|
||||
$categories=dispatch($client, "meerkat.getCategories", array());
|
||||
if ($catid)
|
||||
$sources = dispatch($client, "meerkat.getChannelsByCategory",
|
||||
array(new xmlrpcval($catid, "int")));
|
||||
if ($chanid) {
|
||||
$stories = dispatch($client, "meerkat.getItems",
|
||||
array(new xmlrpcval(
|
||||
array(
|
||||
"channel" => new xmlrpcval($chanid, "int"),
|
||||
"ids" => new xmlrpcval(1, "int"),
|
||||
"descriptions" => new xmlrpcval(200, "int"),
|
||||
"num_items" => new xmlrpcval(5, "int"),
|
||||
"dates" => new xmlrpcval(0, "int")
|
||||
), "struct")));
|
||||
}
|
||||
?>
|
||||
<form>
|
||||
<p>Subject area:<br />
|
||||
<select name="catid">
|
||||
<?php
|
||||
if (!$catid)
|
||||
print "<option value=\"0\">Choose a category</option>\n";
|
||||
while(list($k,$v) = each($categories)) {
|
||||
print "<option value=\"" . $v['id'] ."\"";
|
||||
if ($v['id']==$catid) print " selected=\"selected\"";
|
||||
print ">". $v['title'] . "</option>\n";
|
||||
}
|
||||
?>
|
||||
</select></p>
|
||||
<?php
|
||||
if ($catid) {
|
||||
?>
|
||||
<p>News source:<br />
|
||||
<select name="chanid">
|
||||
<?php
|
||||
if (!$chanid)
|
||||
print "<option value=\"0\">Choose a source</option>\n";
|
||||
while(list($k,$v) = each($sources)) {
|
||||
print "<option value=\"" . $v['id'] ."\"";
|
||||
if ($v['id']==$chanid) print "\" selected=\"selected\"";
|
||||
print ">". $v['title'] . "</option>\n";
|
||||
}
|
||||
?>
|
||||
</select>
|
||||
</p>
|
||||
|
||||
<?php
|
||||
} // end if ($catid)
|
||||
?>
|
||||
|
||||
<p><input type="submit" value="Update" /></p>
|
||||
<input type="hidden" name="oc" value="<?php echo $catid; ?>" />
|
||||
</form>
|
||||
|
||||
<?php
|
||||
if ($chanid) {
|
||||
?>
|
||||
|
||||
<h2>Stories available</h2>
|
||||
<table>
|
||||
<?php
|
||||
while(list($k,$v) = each($stories)) {
|
||||
print "<tr>";
|
||||
print "<td><b>" . $v['title'] . "</b><br />";
|
||||
print $v['description'] . "<br />";
|
||||
print "<em><a target=\"_blank\" href=\"" .
|
||||
$v['link'] . "\">Read full story</a> ";
|
||||
print "<a href=\"comment.php?catid=${catid}&chanid=${chanid}&" .
|
||||
"oc=${oc}&comment=" . $v['id'] . "\">Comment on this story</a>";
|
||||
print "</em>";
|
||||
print "</td>";
|
||||
print "</tr>\n";
|
||||
// now look for existing comments
|
||||
$res=dispatch($dclient, "discuss.getComments",
|
||||
array(new xmlrpcval($v['id'])));
|
||||
if (sizeof($res)>0) {
|
||||
print "<tr><td bgcolor=\"#dddddd\"><p><b><i>" .
|
||||
"Comments on this story:</i></b></p>";
|
||||
for($i=0; $i<sizeof($res); $i++) {
|
||||
$s=$res[$i];
|
||||
print "<p><b>From:</b> " . htmlentities($s['name']) . "<br />";
|
||||
print "<b>Comment:</b> " . htmlentities($s['comment']) . "</p>";
|
||||
}
|
||||
print "</td></tr>\n";
|
||||
}
|
||||
print "<tr><td><hr /></td></tr>\n";
|
||||
}
|
||||
?>
|
||||
</table>
|
||||
|
||||
<?php
|
||||
} // end if ($chanid)
|
||||
} // end if comment
|
||||
?>
|
||||
<hr />
|
||||
<p>
|
||||
<a href="http://meerkat.oreillynet.com"><img align="right"
|
||||
src="http://meerkat.oreillynet.com/icons/meerkat-powered.jpg"
|
||||
height="31" width="88" alt="Meerkat powered, yeah!"
|
||||
border="0" hspace="8" /></a>
|
||||
<em>$Id: comment.php 2 2009-03-16 20:22:51Z ggiunta $</em></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,108 @@
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<h1>Introspect demo</h1>
|
||||
<h2>Query server for available methods and their description</h2>
|
||||
<h3>The code demonstrates usage of multicall and introspection methods</h3>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
function display_error($r)
|
||||
{
|
||||
print "An error occurred: ";
|
||||
print "Code: " . $r->faultCode()
|
||||
. " Reason: '" .$r->faultString()."'<br/>";
|
||||
}
|
||||
|
||||
// 'new style' client constuctor
|
||||
$c = new xmlrpc_client("http://phpxmlrpc.sourceforge.net/server.php");
|
||||
print "<h3>methods available at http://" . $c->server . $c->path . "</h3>\n";
|
||||
|
||||
$m = new xmlrpcmsg('system.listMethods');
|
||||
$r =& $c->send($m);
|
||||
if($r->faultCode())
|
||||
{
|
||||
display_error($r);
|
||||
}
|
||||
else
|
||||
{
|
||||
$v=$r->value();
|
||||
for($i=0; $i<$v->arraysize(); $i++)
|
||||
{
|
||||
$mname=$v->arraymem($i);
|
||||
print "<h4>" . $mname->scalarval() . "</h4>\n";
|
||||
|
||||
// build messages first, add params later
|
||||
$m1 = new xmlrpcmsg('system.methodHelp');
|
||||
$m2 = new xmlrpcmsg('system.methodSignature');
|
||||
$val = new xmlrpcval($mname->scalarval(), "string");
|
||||
$m1->addParam($val);
|
||||
$m2->addParam($val);
|
||||
|
||||
// send multiple messages in one pass.
|
||||
// If server does not support multicall, client will fall back to 2 separate calls
|
||||
$ms = array($m1, $m2);
|
||||
$rs =& $c->send($ms);
|
||||
|
||||
if($rs[0]->faultCode())
|
||||
{
|
||||
display_error($rs[0]);
|
||||
}
|
||||
else
|
||||
{
|
||||
$val=$rs[0]->value();
|
||||
$txt=$val->scalarval();
|
||||
if($txt != "")
|
||||
{
|
||||
print "<h4>Documentation</h4><p>${txt}</p>\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
print "<p>No documentation available.</p>\n";
|
||||
}
|
||||
}
|
||||
|
||||
if($rs[1]->faultCode())
|
||||
{
|
||||
display_error($rs[1]);
|
||||
}
|
||||
else
|
||||
{
|
||||
print "<h4>Signature</h4><p>\n";
|
||||
$val = $rs[1]->value();
|
||||
if($val->kindOf()=="array")
|
||||
{
|
||||
for($j=0; $j<$val->arraysize(); $j++)
|
||||
{
|
||||
$x = $val->arraymem($j);
|
||||
$ret = $x->arraymem(0);
|
||||
print "<code>" . $ret->scalarval() . " "
|
||||
. $mname->scalarval() . "(";
|
||||
if($x->arraysize()>1)
|
||||
{
|
||||
for($k=1; $k<$x->arraysize(); $k++)
|
||||
{
|
||||
$y = $x->arraymem($k);
|
||||
print $y->scalarval();
|
||||
if($k < $x->arraysize()-1)
|
||||
{
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
}
|
||||
print ")</code><br/>\n";
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
print "Signature unknown\n";
|
||||
}
|
||||
print "</p>\n";
|
||||
}
|
||||
}
|
||||
}
|
||||
?>
|
||||
<hr/>
|
||||
<em>$Id: introspect.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
71
include/limesurvey/admin/classes/xmlrpc/demo/client/mail.php
Normal file
71
include/limesurvey/admin/classes/xmlrpc/demo/client/mail.php
Normal file
@@ -0,0 +1,71 @@
|
||||
<?php
|
||||
// Allow users to see the source of this file even if PHP is not configured for it
|
||||
if ((isset($HTTP_GET_VARS['showSource']) && $HTTP_GET_VARS['showSource']) ||
|
||||
(isset($_GET['showSource']) && $_GET['showSource']))
|
||||
{ highlight_file(__FILE__); die(); }
|
||||
?>
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<h1>Mail demo</h1>
|
||||
<p>This form enables you to send mail via an XML-RPC server. For public use
|
||||
only the "Userland" server will work (see <a href="http://www.xmlrpc.com/discuss/msgReader$598">Dave Winer's message</a>).
|
||||
When you press <kbd>Send</kbd> this page will reload, showing you the XML-RPC request sent to the host server, the XML-RPC response received and the internal evaluation done by the PHP implementation.</p>
|
||||
<p>You can find the source to this page here: <a href="mail.php?showSource=1">mail.php</a><br/>
|
||||
And the source to a functionally identical mail-by-XML-RPC server in the file <a href="../server/server.php?showSource=1">server.php</a> included with the library (look for the 'mail_send' method)</p>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
// Play nice to PHP 5 installations with REGISTER_LONG_ARRAYS off
|
||||
if (!isset($HTTP_POST_VARS) && isset($_POST))
|
||||
$HTTP_POST_VARS = $_POST;
|
||||
|
||||
if (isset($HTTP_POST_VARS["server"]) && $HTTP_POST_VARS["server"]) {
|
||||
if ($HTTP_POST_VARS["server"]=="Userland") {
|
||||
$XP="/RPC2"; $XS="206.204.24.2";
|
||||
} else {
|
||||
$XP="/xmlrpc/server.php"; $XS="pingu.heddley.com";
|
||||
}
|
||||
$f=new xmlrpcmsg('mail.send');
|
||||
$f->addParam(new xmlrpcval($HTTP_POST_VARS["mailto"]));
|
||||
$f->addParam(new xmlrpcval($HTTP_POST_VARS["mailsub"]));
|
||||
$f->addParam(new xmlrpcval($HTTP_POST_VARS["mailmsg"]));
|
||||
$f->addParam(new xmlrpcval($HTTP_POST_VARS["mailfrom"]));
|
||||
$f->addParam(new xmlrpcval($HTTP_POST_VARS["mailcc"]));
|
||||
$f->addParam(new xmlrpcval($HTTP_POST_VARS["mailbcc"]));
|
||||
$f->addParam(new xmlrpcval("text/plain"));
|
||||
|
||||
$c=new xmlrpc_client($XP, $XS, 80);
|
||||
$c->setDebug(2);
|
||||
$r=&$c->send($f);
|
||||
if (!$r->faultCode()) {
|
||||
print "Mail sent OK<br/>\n";
|
||||
} else {
|
||||
print "<fonr color=\"red\">";
|
||||
print "Mail send failed<br/>\n";
|
||||
print "Fault: ";
|
||||
print "Code: " . htmlspecialchars($r->faultCode()) .
|
||||
" Reason: '" . htmlspecialchars($r->faultString()) . "'<br/>";
|
||||
print "</font><br/>";
|
||||
}
|
||||
}
|
||||
?>
|
||||
<form method="POST">
|
||||
Server <select name="server"><option value="Userland">Userland</option>
|
||||
<option value="UsefulInc">UsefulInc private server</option></select>
|
||||
<hr/>
|
||||
From <input size="60" name="mailfrom" value=""/><br/>
|
||||
<hr/>
|
||||
To <input size="60" name="mailto" value=""/><br/>
|
||||
Cc <input size="60" name="mailcc" value=""/><br/>
|
||||
Bcc <input size="60" name="mailbcc" value=""/><br/>
|
||||
<hr/>
|
||||
Subject <input size="60" name="mailsub" value="A message from xmlrpc"/>
|
||||
<hr/>
|
||||
Body <textarea rows="7" cols="60" name="mailmsg">Your message here</textarea><br/>
|
||||
<input type="Submit" value="Send"/>
|
||||
</form>
|
||||
<hr/>
|
||||
<em>$Id: mail.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,59 @@
|
||||
<?php
|
||||
/**
|
||||
* Helper function for the terminally lazy
|
||||
*
|
||||
* @version $Id: simple_call.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @copyright (c) 2006-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*/
|
||||
|
||||
/**
|
||||
* Takes a client object, a remote method name, and a variable numbers of
|
||||
* php values, and calls the method with the supplied parameters. The
|
||||
* parameters are native php values and the result is an xmlrpcresp object.
|
||||
*
|
||||
* Notes:
|
||||
* The function encodes the received parameters using php_xmlrpc_encode:
|
||||
* the limitations of automatic encoding apply to this function too);
|
||||
*
|
||||
* the type of the value returned by the function can be changed setting
|
||||
* beforehand the 'return_type' member of the client object to 'phpvals' -
|
||||
* see the manual for more details about this capability).
|
||||
*
|
||||
*
|
||||
* @author Toth Istvan
|
||||
*
|
||||
* @param xmlrpc_client client object, properly set up to connect to server
|
||||
* @param string remote function name
|
||||
* @param mixed $parameter1
|
||||
* @param mixed $parameter2
|
||||
* @param mixed $parameter3 ...
|
||||
* @return xmlrpcresp or false on error
|
||||
*/
|
||||
function xmlrpccall_simple()
|
||||
{
|
||||
if(func_num_args() < 2)
|
||||
{
|
||||
// Incorrect
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
$varargs = func_get_args();
|
||||
$client = array_shift($varargs);
|
||||
$remote_function_name = array_shift($varargs);
|
||||
if (!is_a($client, 'xmlrpc_client') || !is_string($remote_function_name))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
$xmlrpcval_array = array();
|
||||
foreach($varargs as $parameter)
|
||||
{
|
||||
$xmlrpcval_array[] = php_xmlrpc_encode($parameter);
|
||||
}
|
||||
|
||||
return $client->send(new xmlrpcmsg($remote_function_name, $xmlrpcval_array));
|
||||
}
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,32 @@
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<h1>Which toolkit demo</h1>
|
||||
<h2>Query server for toolkit information</h2>
|
||||
<h3>The code demonstrates usage of the php_xmlrpc_decode function</h3>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
$f = new xmlrpcmsg('interopEchoTests.whichToolkit', array());
|
||||
$c = new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80);
|
||||
$r = $c->send($f);
|
||||
if(!$r->faultCode())
|
||||
{
|
||||
$v = php_xmlrpc_decode($r->value());
|
||||
print "<pre>";
|
||||
print "name: " . htmlspecialchars($v["toolkitName"]) . "\n";
|
||||
print "version: " . htmlspecialchars($v["toolkitVersion"]) . "\n";
|
||||
print "docs: " . htmlspecialchars($v["toolkitDocsUrl"]) . "\n";
|
||||
print "os: " . htmlspecialchars($v["toolkitOperatingSystem"]) . "\n";
|
||||
print "</pre>";
|
||||
}
|
||||
else
|
||||
{
|
||||
print "An error occurred: ";
|
||||
print "Code: " . htmlspecialchars($r->faultCode()) . " Reason: '" . htmlspecialchars($r->faultString()) . "'\n";
|
||||
}
|
||||
?>
|
||||
<hr/>
|
||||
<em>$Id: which.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
58
include/limesurvey/admin/classes/xmlrpc/demo/client/wrap.php
Normal file
58
include/limesurvey/admin/classes/xmlrpc/demo/client/wrap.php
Normal file
@@ -0,0 +1,58 @@
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<h1>Webservice wrappper demo</h1>
|
||||
<h2>Wrap methods exposed by server into php functions</h2>
|
||||
<h3>The code demonstrates usage of the most automagic client usage possible:<br/>
|
||||
1) client that returns php values instead of xmlrpcval objects<br/>
|
||||
2) wrapping of remote methods into php functions
|
||||
</h3>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
include("xmlrpc_wrappers.inc");
|
||||
|
||||
$c = new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80);
|
||||
$c->return_type = 'phpvals'; // let client give us back php values instead of xmlrpcvals
|
||||
$r =& $c->send(new xmlrpcmsg('system.listMethods'));
|
||||
if($r->faultCode())
|
||||
{
|
||||
echo "<p>Server methods list could not be retrieved: error '".htmlspecialchars($r->faultString())."'</p>\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
$testcase = '';
|
||||
echo "<p>Server methods list retrieved, now wrapping it up...</p>\n<ul>\n";
|
||||
foreach($r->value() as $methodname) // $r->value is an array of strings
|
||||
{
|
||||
// do not wrap remote server system methods
|
||||
if (strpos($methodname, 'system.') !== 0)
|
||||
{
|
||||
$funcname = wrap_xmlrpc_method($c, $methodname);
|
||||
if($funcname)
|
||||
{
|
||||
echo "<li>Remote server method ".htmlspecialchars($methodname)." wrapped into php function ".$funcname."</li>\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
echo "<li>Remote server method ".htmlspecialchars($methodname)." could not be wrapped!</li>\n";
|
||||
}
|
||||
if($methodname == 'examples.getStateName')
|
||||
{
|
||||
$testcase = $funcname;
|
||||
}
|
||||
}
|
||||
}
|
||||
echo "</ul>\n";
|
||||
if($testcase)
|
||||
{
|
||||
echo "Now testing function $testcase: remote method to convert U.S. state number into state name";
|
||||
$statenum = 25;
|
||||
$statename = $testcase($statenum, 2);
|
||||
echo "State number $statenum is ".htmlspecialchars($statename);
|
||||
}
|
||||
}
|
||||
?>
|
||||
<hr/>
|
||||
<em>$Id: wrap.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,31 @@
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<h1>Zope test demo</h1>
|
||||
<h3>The code demonstrates usage of basic authentication to connect to the server</h3>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
$f = new xmlrpcmsg('document_src', array());
|
||||
$c = new xmlrpc_client("/index_html", "pingu.heddley.com", 9080);
|
||||
$c->setCredentials("username", "password");
|
||||
$c->setDebug(2);
|
||||
$r = $c->send($f);
|
||||
if(!$r->faultCode())
|
||||
{
|
||||
$v = $r->value();
|
||||
print "I received:" . htmlspecialchars($v->scalarval()) . "<br/>";
|
||||
print "<hr/>I got this value back<br/>pre>" .
|
||||
htmlentities($r->serialize()). "</pre>\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
print "An error occurred: ";
|
||||
print "Code: " . htmlspecialchars($r->faultCode())
|
||||
. " Reason: '" . ($r->faultString()) . "'<br/>";
|
||||
}
|
||||
?>
|
||||
<hr/>
|
||||
<em>$Id: zopetest.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
36
include/limesurvey/admin/classes/xmlrpc/demo/demo1.txt
Normal file
36
include/limesurvey/admin/classes/xmlrpc/demo/demo1.txt
Normal file
@@ -0,0 +1,36 @@
|
||||
<?xml version="1.0"?>
|
||||
<methodResponse>
|
||||
<params>
|
||||
<param>
|
||||
<value>
|
||||
<struct>
|
||||
<member><name>thearray</name>
|
||||
<value><array>
|
||||
<data>
|
||||
<value><string>ABCDEFHIJ</string></value>
|
||||
<value><int>1234</int></value>
|
||||
<value><boolean>1</boolean></value>
|
||||
</data>
|
||||
</array></value>
|
||||
</member>
|
||||
<member><name>theint</name>
|
||||
<value><int>23</int></value>
|
||||
</member>
|
||||
<member><name>thestring</name>
|
||||
<value><string>foobarwhizz</string></value>
|
||||
</member>
|
||||
<member><name>thestruct</name>
|
||||
<value><struct>
|
||||
<member><name>one</name>
|
||||
<value><int>1</int></value>
|
||||
</member>
|
||||
<member><name>two</name>
|
||||
<value><int>2</int></value>
|
||||
</member>
|
||||
</struct></value>
|
||||
</member>
|
||||
</struct>
|
||||
</value>
|
||||
</param>
|
||||
</params>
|
||||
</methodResponse>
|
||||
8
include/limesurvey/admin/classes/xmlrpc/demo/demo2.txt
Normal file
8
include/limesurvey/admin/classes/xmlrpc/demo/demo2.txt
Normal file
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<methodResponse>
|
||||
<params>
|
||||
<param>
|
||||
<value><string>South Dakota's own</string></value>
|
||||
</param>
|
||||
</params>
|
||||
</methodResponse>
|
||||
17
include/limesurvey/admin/classes/xmlrpc/demo/demo3.txt
Normal file
17
include/limesurvey/admin/classes/xmlrpc/demo/demo3.txt
Normal file
@@ -0,0 +1,17 @@
|
||||
<?xml version="1.0"?>
|
||||
<methodResponse>
|
||||
<fault>
|
||||
<value>
|
||||
<struct>
|
||||
<member>
|
||||
<name>faultCode</name>
|
||||
<value><int>4</int></value>
|
||||
</member>
|
||||
<member>
|
||||
<name>faultString</name>
|
||||
<value><string>Too many parameters.</string></value>
|
||||
</member>
|
||||
</struct>
|
||||
</value>
|
||||
</fault>
|
||||
</methodResponse>
|
||||
124
include/limesurvey/admin/classes/xmlrpc/demo/server/discuss.php
Normal file
124
include/limesurvey/admin/classes/xmlrpc/demo/server/discuss.php
Normal file
@@ -0,0 +1,124 @@
|
||||
<?php
|
||||
// $Id: discuss.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
include("xmlrpc.inc");
|
||||
include("xmlrpcs.inc");
|
||||
|
||||
$addcomment_sig=array(array($xmlrpcInt, $xmlrpcString, $xmlrpcString, $xmlrpcString));
|
||||
|
||||
$addcomment_doc='Adds a comment to an item. The first parameter
|
||||
is the item ID, the second the name of the commenter, and the third
|
||||
is the comment itself. Returns the number of comments against that
|
||||
ID.';
|
||||
|
||||
function addcomment($m)
|
||||
{
|
||||
global $xmlrpcerruser;
|
||||
$err="";
|
||||
// since validation has already been carried out for us,
|
||||
// we know we got exactly 3 string values
|
||||
$n = php_xmlrpc_decode($m);
|
||||
$msgID = $n[0];
|
||||
$name = $n[1];
|
||||
$comment = $n[2];
|
||||
|
||||
$dbh=dba_open("/tmp/comments.db", "c", "db2");
|
||||
if($dbh)
|
||||
{
|
||||
$countID="${msgID}_count";
|
||||
if(dba_exists($countID, $dbh))
|
||||
{
|
||||
$count=dba_fetch($countID, $dbh);
|
||||
}
|
||||
else
|
||||
{
|
||||
$count=0;
|
||||
}
|
||||
// add the new comment in
|
||||
dba_insert($msgID . "_comment_${count}", $comment, $dbh);
|
||||
dba_insert($msgID . "_name_${count}", $name, $dbh);
|
||||
$count++;
|
||||
dba_replace($countID, $count, $dbh);
|
||||
dba_close($dbh);
|
||||
}
|
||||
else
|
||||
{
|
||||
$err="Unable to open comments database.";
|
||||
}
|
||||
// if we generated an error, create an error return response
|
||||
if($err)
|
||||
{
|
||||
return new xmlrpcresp(0, $xmlrpcerruser, $err);
|
||||
}
|
||||
else
|
||||
{
|
||||
// otherwise, we create the right response
|
||||
// with the state name
|
||||
return new xmlrpcresp(new xmlrpcval($count, "int"));
|
||||
}
|
||||
}
|
||||
|
||||
$getcomments_sig=array(array($xmlrpcArray, $xmlrpcString));
|
||||
|
||||
$getcomments_doc='Returns an array of comments for a given ID, which
|
||||
is the sole argument. Each array item is a struct containing name
|
||||
and comment text.';
|
||||
|
||||
function getcomments($m)
|
||||
{
|
||||
global $xmlrpcerruser;
|
||||
$err="";
|
||||
$ra=array();
|
||||
// get the first param
|
||||
if(XMLRPC_EPI_ENABLED == '1')
|
||||
{
|
||||
$msgID=xmlrpc_decode($m->getParam(0));
|
||||
}
|
||||
else
|
||||
{
|
||||
$msgID=php_xmlrpc_decode($m->getParam(0));
|
||||
}
|
||||
$dbh=dba_open("/tmp/comments.db", "r", "db2");
|
||||
if($dbh)
|
||||
{
|
||||
$countID="${msgID}_count";
|
||||
if(dba_exists($countID, $dbh))
|
||||
{
|
||||
$count=dba_fetch($countID, $dbh);
|
||||
for($i=0; $i<$count; $i++)
|
||||
{
|
||||
$name=dba_fetch("${msgID}_name_${i}", $dbh);
|
||||
$comment=dba_fetch("${msgID}_comment_${i}", $dbh);
|
||||
// push a new struct onto the return array
|
||||
$ra[] = array(
|
||||
"name" => $name,
|
||||
"comment" => $comment
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
// if we generated an error, create an error return response
|
||||
if($err)
|
||||
{
|
||||
return new xmlrpcresp(0, $xmlrpcerruser, $err);
|
||||
}
|
||||
else
|
||||
{
|
||||
// otherwise, we create the right response
|
||||
// with the state name
|
||||
return new xmlrpcresp(php_xmlrpc_encode($ra));
|
||||
}
|
||||
}
|
||||
|
||||
$s = new xmlrpc_server(array(
|
||||
"discuss.addComment" => array(
|
||||
"function" => "addcomment",
|
||||
"signature" => $addcomment_sig,
|
||||
"docstring" => $addcomment_doc
|
||||
),
|
||||
"discuss.getComments" => array(
|
||||
"function" => "getcomments",
|
||||
"signature" => $getcomments_sig,
|
||||
"docstring" => $getcomments_doc
|
||||
)
|
||||
));
|
||||
?>
|
||||
@@ -0,0 +1,86 @@
|
||||
<?php
|
||||
/**
|
||||
* XMLRPC server acting as proxy for requests to other servers
|
||||
* (useful e.g. for ajax-originated calls that can only connect back to
|
||||
* the originating server)
|
||||
*
|
||||
* @version $Id: proxy.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @author Gaetano Giunta
|
||||
* @copyright (C) 2006-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*/
|
||||
|
||||
include("xmlrpc.inc");
|
||||
include("xmlrpcs.inc");
|
||||
|
||||
/**
|
||||
* Forward an xmlrpc request to another server, and return to client the response received.
|
||||
* @param xmlrpcmsg $m (see method docs below for a description of the expected parameters)
|
||||
* @return xmlrpcresp
|
||||
*/
|
||||
function forward_request($m)
|
||||
{
|
||||
// create client
|
||||
$timeout = 0;
|
||||
$url = php_xmlrpc_decode($m->getParam(0));
|
||||
$c = new xmlrpc_client($url);
|
||||
if ($m->getNumParams() > 3)
|
||||
{
|
||||
// we have to set some options onto the client.
|
||||
// Note that if we do not untaint the received values, warnings might be generated...
|
||||
$options = php_xmlrpc_decode($m->getParam(3));
|
||||
foreach($options as $key => $val)
|
||||
{
|
||||
switch($key)
|
||||
{
|
||||
case 'Cookie':
|
||||
break;
|
||||
case 'Credentials':
|
||||
break;
|
||||
case 'RequestCompression':
|
||||
$c->setRequestCompression($val);
|
||||
break;
|
||||
case 'SSLVerifyHost':
|
||||
$c->setSSLVerifyHost($val);
|
||||
break;
|
||||
case 'SSLVerifyPeer':
|
||||
$c->setSSLVerifyPeer($val);
|
||||
break;
|
||||
case 'Timeout':
|
||||
$timeout = (integer) $val;
|
||||
break;
|
||||
} // switch
|
||||
}
|
||||
}
|
||||
|
||||
// build call for remote server
|
||||
/// @todo find a weay to forward client info (such as IP) to server, either
|
||||
/// - as xml comments in the payload, or
|
||||
/// - using std http header conventions, such as X-forwarded-for...
|
||||
$method = php_xmlrpc_decode($m->getParam(1));
|
||||
$pars = $m->getParam(2);
|
||||
$m = new xmlrpcmsg($method);
|
||||
for ($i = 0; $i < $pars->arraySize(); $i++)
|
||||
{
|
||||
$m->addParam($pars->arraymem($i));
|
||||
}
|
||||
|
||||
// add debug info into response we give back to caller
|
||||
xmlrpc_debugmsg("Sending to server $url the payload: ".$m->serialize());
|
||||
return $c->send($m, $timeout);
|
||||
}
|
||||
|
||||
// run the server
|
||||
$server = new xmlrpc_server(
|
||||
array(
|
||||
'xmlrpcproxy.call' => array(
|
||||
'function' => 'forward_request',
|
||||
'signature' => array(
|
||||
array('mixed', 'string', 'string', 'array'),
|
||||
array('mixed', 'string', 'string', 'array', 'stuct'),
|
||||
),
|
||||
'docstring' => 'forwards xmlrpc calls to remote servers. Returns remote method\'s response. Accepts params: remote server url (might include basic auth credentials), method name, array of params, and (optionally) a struct containing call options'
|
||||
)
|
||||
)
|
||||
);
|
||||
?>
|
||||
837
include/limesurvey/admin/classes/xmlrpc/demo/server/server.php
Normal file
837
include/limesurvey/admin/classes/xmlrpc/demo/server/server.php
Normal file
@@ -0,0 +1,837 @@
|
||||
<?php
|
||||
/**
|
||||
* Demo server for xmlrpc library.
|
||||
*
|
||||
* Implements a lot of webservices, including a suite of services used for
|
||||
* interoperability testing (validator1 methods), and some whose only purpose
|
||||
* is to be used for unit-testing the library.
|
||||
*
|
||||
* Please do not copy this file verbatim into your production server.
|
||||
*
|
||||
* @version $Id: server.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
**/
|
||||
|
||||
// give user a chance to see the source for this server instead of running the services
|
||||
if ($_SERVER['REQUEST_METHOD'] != 'POST' && isset($_GET['showSource']))
|
||||
{
|
||||
highlight_file(__FILE__);
|
||||
die();
|
||||
}
|
||||
|
||||
include("xmlrpc.inc");
|
||||
include("xmlrpcs.inc");
|
||||
include("xmlrpc_wrappers.inc");
|
||||
|
||||
/**
|
||||
* Used to test usage of object methods in dispatch maps and in wrapper code
|
||||
*/
|
||||
class xmlrpc_server_methods_container
|
||||
{
|
||||
/*
|
||||
* Method used to test logging of php warnings generated by user functions.
|
||||
*/
|
||||
function phpwarninggenerator($m)
|
||||
{
|
||||
$a = $b; // this triggers a warning in E_ALL mode, since $b is undefined
|
||||
return new xmlrpcresp(new xmlrpcval(1, 'boolean'));
|
||||
}
|
||||
|
||||
/**
|
||||
* a PHP version of the state-number server. Send me an integer and i'll sell you a state
|
||||
* @param integer $s
|
||||
* @return string
|
||||
* */
|
||||
function findstate($s)
|
||||
{
|
||||
return inner_findstate($s);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// a PHP version
|
||||
// of the state-number server
|
||||
// send me an integer and i'll sell you a state
|
||||
|
||||
$stateNames = array(
|
||||
"Alabama", "Alaska", "Arizona", "Arkansas", "California",
|
||||
"Colorado", "Columbia", "Connecticut", "Delaware", "Florida",
|
||||
"Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas",
|
||||
"Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan",
|
||||
"Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada",
|
||||
"New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina",
|
||||
"North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island",
|
||||
"South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont",
|
||||
"Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming"
|
||||
);
|
||||
|
||||
$findstate_sig=array(array($xmlrpcString, $xmlrpcInt));
|
||||
$findstate_doc='When passed an integer between 1 and 51 returns the
|
||||
name of a US state, where the integer is the index of that state name
|
||||
in an alphabetic order.';
|
||||
|
||||
|
||||
function findstate($m)
|
||||
{
|
||||
global $xmlrpcerruser, $stateNames;
|
||||
$err="";
|
||||
// get the first param
|
||||
$sno=$m->getParam(0);
|
||||
|
||||
// param must be there and of the correct type: server object does the
|
||||
// validation for us
|
||||
|
||||
// extract the value of the state number
|
||||
$snv=$sno->scalarval();
|
||||
// look it up in our array (zero-based)
|
||||
if (isset($stateNames[$snv-1]))
|
||||
{
|
||||
$sname=$stateNames[$snv-1];
|
||||
}
|
||||
else
|
||||
{
|
||||
// not, there so complain
|
||||
$err="I don't have a state for the index '" . $snv . "'";
|
||||
}
|
||||
|
||||
// if we generated an error, create an error return response
|
||||
if ($err)
|
||||
{
|
||||
return new xmlrpcresp(0, $xmlrpcerruser, $err);
|
||||
}
|
||||
else
|
||||
{
|
||||
// otherwise, we create the right response
|
||||
// with the state name
|
||||
return new xmlrpcresp(new xmlrpcval($sname));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Inner code of the state-number server.
|
||||
* Used to test auto-registration of PHP funcions as xmlrpc methods.
|
||||
* @param integer $stateno the state number
|
||||
* @return string the name of the state (or error descrption)
|
||||
*/
|
||||
function inner_findstate($stateno)
|
||||
{
|
||||
global $stateNames;
|
||||
if (isset($stateNames[$stateno-1]))
|
||||
{
|
||||
return $stateNames[$stateno-1];
|
||||
}
|
||||
else
|
||||
{
|
||||
// not, there so complain
|
||||
return "I don't have a state for the index '" . $stateno . "'";
|
||||
}
|
||||
}
|
||||
$findstate2_sig = wrap_php_function('inner_findstate');
|
||||
|
||||
$findstate3_sig = wrap_php_function(array('xmlrpc_server_methods_container', 'findstate'));
|
||||
|
||||
$obj = new xmlrpc_server_methods_container();
|
||||
|
||||
$findstate4_sig = wrap_php_function(array($obj, 'findstate'));
|
||||
|
||||
$addtwo_sig=array(array($xmlrpcInt, $xmlrpcInt, $xmlrpcInt));
|
||||
$addtwo_doc='Add two integers together and return the result';
|
||||
function addtwo($m)
|
||||
{
|
||||
$s=$m->getParam(0);
|
||||
$t=$m->getParam(1);
|
||||
return new xmlrpcresp(new xmlrpcval($s->scalarval()+$t->scalarval(),"int"));
|
||||
}
|
||||
|
||||
$addtwodouble_sig=array(array($xmlrpcDouble, $xmlrpcDouble, $xmlrpcDouble));
|
||||
$addtwodouble_doc='Add two doubles together and return the result';
|
||||
function addtwodouble($m)
|
||||
{
|
||||
$s=$m->getParam(0);
|
||||
$t=$m->getParam(1);
|
||||
return new xmlrpcresp(new xmlrpcval($s->scalarval()+$t->scalarval(),"double"));
|
||||
}
|
||||
|
||||
$stringecho_sig=array(array($xmlrpcString, $xmlrpcString));
|
||||
$stringecho_doc='Accepts a string parameter, returns the string.';
|
||||
function stringecho($m)
|
||||
{
|
||||
// just sends back a string
|
||||
$s=$m->getParam(0);
|
||||
$v = $s->scalarval();
|
||||
return new xmlrpcresp(new xmlrpcval($s->scalarval()));
|
||||
}
|
||||
|
||||
$echoback_sig=array(array($xmlrpcString, $xmlrpcString));
|
||||
$echoback_doc='Accepts a string parameter, returns the entire incoming payload';
|
||||
function echoback($m)
|
||||
{
|
||||
// just sends back a string with what i got
|
||||
// sent to me, just escaped, that's all
|
||||
//
|
||||
// $m is an incoming message
|
||||
$s="I got the following message:\n" . $m->serialize();
|
||||
return new xmlrpcresp(new xmlrpcval($s));
|
||||
}
|
||||
|
||||
$echosixtyfour_sig=array(array($xmlrpcString, $xmlrpcBase64));
|
||||
$echosixtyfour_doc='Accepts a base64 parameter and returns it decoded as a string';
|
||||
function echosixtyfour($m)
|
||||
{
|
||||
// accepts an encoded value, but sends it back
|
||||
// as a normal string. this is to test base64 encoding
|
||||
// is working as expected
|
||||
$incoming=$m->getParam(0);
|
||||
return new xmlrpcresp(new xmlrpcval($incoming->scalarval(), "string"));
|
||||
}
|
||||
|
||||
$bitflipper_sig=array(array($xmlrpcArray, $xmlrpcArray));
|
||||
$bitflipper_doc='Accepts an array of booleans, and returns them inverted';
|
||||
function bitflipper($m)
|
||||
{
|
||||
global $xmlrpcArray;
|
||||
|
||||
$v=$m->getParam(0);
|
||||
$sz=$v->arraysize();
|
||||
$rv=new xmlrpcval(array(), $xmlrpcArray);
|
||||
|
||||
for($j=0; $j<$sz; $j++)
|
||||
{
|
||||
$b=$v->arraymem($j);
|
||||
if ($b->scalarval())
|
||||
{
|
||||
$rv->addScalar(false, "boolean");
|
||||
}
|
||||
else
|
||||
{
|
||||
$rv->addScalar(true, "boolean");
|
||||
}
|
||||
}
|
||||
|
||||
return new xmlrpcresp($rv);
|
||||
}
|
||||
|
||||
// Sorting demo
|
||||
//
|
||||
// send me an array of structs thus:
|
||||
//
|
||||
// Dave 35
|
||||
// Edd 45
|
||||
// Fred 23
|
||||
// Barney 37
|
||||
//
|
||||
// and I'll return it to you in sorted order
|
||||
|
||||
function agesorter_compare($a, $b)
|
||||
{
|
||||
global $agesorter_arr;
|
||||
|
||||
// don't even ask me _why_ these come padded with
|
||||
// hyphens, I couldn't tell you :p
|
||||
$a=ereg_replace("-", "", $a);
|
||||
$b=ereg_replace("-", "", $b);
|
||||
|
||||
if ($agesorter_arr[$a]==$agesorter[$b])
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
return ($agesorter_arr[$a] > $agesorter_arr[$b]) ? -1 : 1;
|
||||
}
|
||||
|
||||
$agesorter_sig=array(array($xmlrpcArray, $xmlrpcArray));
|
||||
$agesorter_doc='Send this method an array of [string, int] structs, eg:
|
||||
<pre>
|
||||
Dave 35
|
||||
Edd 45
|
||||
Fred 23
|
||||
Barney 37
|
||||
</pre>
|
||||
And the array will be returned with the entries sorted by their numbers.
|
||||
';
|
||||
function agesorter($m)
|
||||
{
|
||||
global $agesorter_arr, $xmlrpcerruser, $s;
|
||||
|
||||
xmlrpc_debugmsg("Entering 'agesorter'");
|
||||
// get the parameter
|
||||
$sno=$m->getParam(0);
|
||||
// error string for [if|when] things go wrong
|
||||
$err="";
|
||||
// create the output value
|
||||
$v=new xmlrpcval();
|
||||
$agar=array();
|
||||
|
||||
if (isset($sno) && $sno->kindOf()=="array")
|
||||
{
|
||||
$max=$sno->arraysize();
|
||||
// TODO: create debug method to print can work once more
|
||||
// print "<!-- found $max array elements -->\n";
|
||||
for($i=0; $i<$max; $i++)
|
||||
{
|
||||
$rec=$sno->arraymem($i);
|
||||
if ($rec->kindOf()!="struct")
|
||||
{
|
||||
$err="Found non-struct in array at element $i";
|
||||
break;
|
||||
}
|
||||
// extract name and age from struct
|
||||
$n=$rec->structmem("name");
|
||||
$a=$rec->structmem("age");
|
||||
// $n and $a are xmlrpcvals,
|
||||
// so get the scalarval from them
|
||||
$agar[$n->scalarval()]=$a->scalarval();
|
||||
}
|
||||
|
||||
$agesorter_arr=$agar;
|
||||
// hack, must make global as uksort() won't
|
||||
// allow us to pass any other auxilliary information
|
||||
uksort($agesorter_arr, agesorter_compare);
|
||||
$outAr=array();
|
||||
while (list( $key, $val ) = each( $agesorter_arr ) )
|
||||
{
|
||||
// recreate each struct element
|
||||
$outAr[]=new xmlrpcval(array("name" =>
|
||||
new xmlrpcval($key),
|
||||
"age" =>
|
||||
new xmlrpcval($val, "int")), "struct");
|
||||
}
|
||||
// add this array to the output value
|
||||
$v->addArray($outAr);
|
||||
}
|
||||
else
|
||||
{
|
||||
$err="Must be one parameter, an array of structs";
|
||||
}
|
||||
|
||||
if ($err)
|
||||
{
|
||||
return new xmlrpcresp(0, $xmlrpcerruser, $err);
|
||||
}
|
||||
else
|
||||
{
|
||||
return new xmlrpcresp($v);
|
||||
}
|
||||
}
|
||||
|
||||
// signature and instructions, place these in the dispatch
|
||||
// map
|
||||
$mail_send_sig=array(array(
|
||||
$xmlrpcBoolean, $xmlrpcString, $xmlrpcString,
|
||||
$xmlrpcString, $xmlrpcString, $xmlrpcString,
|
||||
$xmlrpcString, $xmlrpcString
|
||||
));
|
||||
|
||||
$mail_send_doc='mail.send(recipient, subject, text, sender, cc, bcc, mimetype)<br/>
|
||||
recipient, cc, and bcc are strings, comma-separated lists of email addresses, as described above.<br/>
|
||||
subject is a string, the subject of the message.<br/>
|
||||
sender is a string, it\'s the email address of the person sending the message. This string can not be
|
||||
a comma-separated list, it must contain a single email address only.<br/>
|
||||
text is a string, it contains the body of the message.<br/>
|
||||
mimetype, a string, is a standard MIME type, for example, text/plain.
|
||||
';
|
||||
// WARNING; this functionality depends on the sendmail -t option
|
||||
// it may not work with Windows machines properly; particularly
|
||||
// the Bcc option. Sneak on your friends at your own risk!
|
||||
function mail_send($m)
|
||||
{
|
||||
global $xmlrpcerruser, $xmlrpcBoolean;
|
||||
$err="";
|
||||
|
||||
$mTo=$m->getParam(0);
|
||||
$mSub=$m->getParam(1);
|
||||
$mBody=$m->getParam(2);
|
||||
$mFrom=$m->getParam(3);
|
||||
$mCc=$m->getParam(4);
|
||||
$mBcc=$m->getParam(5);
|
||||
$mMime=$m->getParam(6);
|
||||
|
||||
if ($mTo->scalarval()=="")
|
||||
{
|
||||
$err="Error, no 'To' field specified";
|
||||
}
|
||||
|
||||
if ($mFrom->scalarval()=="")
|
||||
{
|
||||
$err="Error, no 'From' field specified";
|
||||
}
|
||||
|
||||
$msghdr="From: " . $mFrom->scalarval() . "\n";
|
||||
$msghdr.="To: ". $mTo->scalarval() . "\n";
|
||||
|
||||
if ($mCc->scalarval()!="")
|
||||
{
|
||||
$msghdr.="Cc: " . $mCc->scalarval(). "\n";
|
||||
}
|
||||
if ($mBcc->scalarval()!="")
|
||||
{
|
||||
$msghdr.="Bcc: " . $mBcc->scalarval(). "\n";
|
||||
}
|
||||
if ($mMime->scalarval()!="")
|
||||
{
|
||||
$msghdr.="Content-type: " . $mMime->scalarval() . "\n";
|
||||
}
|
||||
$msghdr.="X-Mailer: XML-RPC for PHP mailer 1.0";
|
||||
|
||||
if ($err=="")
|
||||
{
|
||||
if (!mail("",
|
||||
$mSub->scalarval(),
|
||||
$mBody->scalarval(),
|
||||
$msghdr))
|
||||
{
|
||||
$err="Error, could not send the mail.";
|
||||
}
|
||||
}
|
||||
|
||||
if ($err)
|
||||
{
|
||||
return new xmlrpcresp(0, $xmlrpcerruser, $err);
|
||||
}
|
||||
else
|
||||
{
|
||||
return new xmlrpcresp(new xmlrpcval("true", $xmlrpcBoolean));
|
||||
}
|
||||
}
|
||||
|
||||
$getallheaders_sig=array(array($xmlrpcStruct));
|
||||
$getallheaders_doc='Returns a struct containing all the HTTP headers received with the request. Provides limited functionality with IIS';
|
||||
function getallheaders_xmlrpc($m)
|
||||
{
|
||||
global $xmlrpcerruser;
|
||||
if (function_exists('getallheaders'))
|
||||
{
|
||||
return new xmlrpcresp(php_xmlrpc_encode(getallheaders()));
|
||||
}
|
||||
else
|
||||
{
|
||||
$headers = array();
|
||||
// IIS: poor man's version of getallheaders
|
||||
foreach ($_SERVER as $key => $val)
|
||||
if (strpos($key, 'HTTP_') === 0)
|
||||
{
|
||||
$key = ucfirst(str_replace('_', '-', strtolower(substr($key, 5))));
|
||||
$headers[$key] = $val;
|
||||
}
|
||||
return new xmlrpcresp(php_xmlrpc_encode($headers));
|
||||
}
|
||||
}
|
||||
|
||||
$setcookies_sig=array(array($xmlrpcInt, $xmlrpcStruct));
|
||||
$setcookies_doc='Sends to client a response containing a single \'1\' digit, and sets to it http cookies as received in the request (array of structs describing a cookie)';
|
||||
function setcookies($m)
|
||||
{
|
||||
$m = $m->getParam(0);
|
||||
while(list($name,$value) = $m->structeach())
|
||||
{
|
||||
$cookiedesc = php_xmlrpc_decode($value);
|
||||
setcookie($name, @$cookiedesc['value'], @$cookiedesc['expires'], @$cookiedesc['path'], @$cookiedesc['domain'], @$cookiedesc['secure']);
|
||||
}
|
||||
return new xmlrpcresp(new xmlrpcval(1, 'int'));
|
||||
}
|
||||
|
||||
$getcookies_sig=array(array($xmlrpcStruct));
|
||||
$getcookies_doc='Sends to client a response containing all http cookies as received in the request (as struct)';
|
||||
function getcookies($m)
|
||||
{
|
||||
return new xmlrpcresp(php_xmlrpc_encode($_COOKIE));
|
||||
}
|
||||
|
||||
$v1_arrayOfStructs_sig=array(array($xmlrpcInt, $xmlrpcArray));
|
||||
$v1_arrayOfStructs_doc='This handler takes a single parameter, an array of structs, each of which contains at least three elements named moe, larry and curly, all <i4>s. Your handler must add all the struct elements named curly and return the result.';
|
||||
function v1_arrayOfStructs($m)
|
||||
{
|
||||
$sno=$m->getParam(0);
|
||||
$numcurly=0;
|
||||
for($i=0; $i<$sno->arraysize(); $i++)
|
||||
{
|
||||
$str=$sno->arraymem($i);
|
||||
$str->structreset();
|
||||
while(list($key,$val)=$str->structeach())
|
||||
{
|
||||
if ($key=="curly")
|
||||
{
|
||||
$numcurly+=$val->scalarval();
|
||||
}
|
||||
}
|
||||
}
|
||||
return new xmlrpcresp(new xmlrpcval($numcurly, "int"));
|
||||
}
|
||||
|
||||
$v1_easyStruct_sig=array(array($xmlrpcInt, $xmlrpcStruct));
|
||||
$v1_easyStruct_doc='This handler takes a single parameter, a struct, containing at least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.';
|
||||
function v1_easyStruct($m)
|
||||
{
|
||||
$sno=$m->getParam(0);
|
||||
$moe=$sno->structmem("moe");
|
||||
$larry=$sno->structmem("larry");
|
||||
$curly=$sno->structmem("curly");
|
||||
$num=$moe->scalarval() + $larry->scalarval() + $curly->scalarval();
|
||||
return new xmlrpcresp(new xmlrpcval($num, "int"));
|
||||
}
|
||||
|
||||
$v1_echoStruct_sig=array(array($xmlrpcStruct, $xmlrpcStruct));
|
||||
$v1_echoStruct_doc='This handler takes a single parameter, a struct. Your handler must return the struct.';
|
||||
function v1_echoStruct($m)
|
||||
{
|
||||
$sno=$m->getParam(0);
|
||||
return new xmlrpcresp($sno);
|
||||
}
|
||||
|
||||
$v1_manyTypes_sig=array(array(
|
||||
$xmlrpcArray, $xmlrpcInt, $xmlrpcBoolean,
|
||||
$xmlrpcString, $xmlrpcDouble, $xmlrpcDateTime,
|
||||
$xmlrpcBase64
|
||||
));
|
||||
$v1_manyTypes_doc='This handler takes six parameters, and returns an array containing all the parameters.';
|
||||
function v1_manyTypes($m)
|
||||
{
|
||||
return new xmlrpcresp(new xmlrpcval(array(
|
||||
$m->getParam(0),
|
||||
$m->getParam(1),
|
||||
$m->getParam(2),
|
||||
$m->getParam(3),
|
||||
$m->getParam(4),
|
||||
$m->getParam(5)),
|
||||
"array"
|
||||
));
|
||||
}
|
||||
|
||||
$v1_moderateSizeArrayCheck_sig=array(array($xmlrpcString, $xmlrpcArray));
|
||||
$v1_moderateSizeArrayCheck_doc='This handler takes a single parameter, which is an array containing between 100 and 200 elements. Each of the items is a string, your handler must return a string containing the concatenated text of the first and last elements.';
|
||||
function v1_moderateSizeArrayCheck($m)
|
||||
{
|
||||
$ar=$m->getParam(0);
|
||||
$sz=$ar->arraysize();
|
||||
$first=$ar->arraymem(0);
|
||||
$last=$ar->arraymem($sz-1);
|
||||
return new xmlrpcresp(new xmlrpcval($first->scalarval() .
|
||||
$last->scalarval(), "string"));
|
||||
}
|
||||
|
||||
$v1_simpleStructReturn_sig=array(array($xmlrpcStruct, $xmlrpcInt));
|
||||
$v1_simpleStructReturn_doc='This handler takes one parameter, and returns a struct containing three elements, times10, times100 and times1000, the result of multiplying the number by 10, 100 and 1000.';
|
||||
function v1_simpleStructReturn($m)
|
||||
{
|
||||
$sno=$m->getParam(0);
|
||||
$v=$sno->scalarval();
|
||||
return new xmlrpcresp(new xmlrpcval(array(
|
||||
"times10" => new xmlrpcval($v*10, "int"),
|
||||
"times100" => new xmlrpcval($v*100, "int"),
|
||||
"times1000" => new xmlrpcval($v*1000, "int")),
|
||||
"struct"
|
||||
));
|
||||
}
|
||||
|
||||
$v1_nestedStruct_sig=array(array($xmlrpcInt, $xmlrpcStruct));
|
||||
$v1_nestedStruct_doc='This handler takes a single parameter, a struct, that models a daily calendar. At the top level, there is one struct for each year. Each year is broken down into months, and months into days. Most of the days are empty in the struct you receive, but the entry for April 1, 2000 contains a least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.';
|
||||
function v1_nestedStruct($m)
|
||||
{
|
||||
$sno=$m->getParam(0);
|
||||
|
||||
$twoK=$sno->structmem("2000");
|
||||
$april=$twoK->structmem("04");
|
||||
$fools=$april->structmem("01");
|
||||
$curly=$fools->structmem("curly");
|
||||
$larry=$fools->structmem("larry");
|
||||
$moe=$fools->structmem("moe");
|
||||
return new xmlrpcresp(new xmlrpcval($curly->scalarval() + $larry->scalarval() + $moe->scalarval(), "int"));
|
||||
}
|
||||
|
||||
$v1_countTheEntities_sig=array(array($xmlrpcStruct, $xmlrpcString));
|
||||
$v1_countTheEntities_doc='This handler takes a single parameter, a string, that contains any number of predefined entities, namely <, >, & \' and ".<BR>Your handler must return a struct that contains five fields, all numbers: ctLeftAngleBrackets, ctRightAngleBrackets, ctAmpersands, ctApostrophes, ctQuotes.';
|
||||
function v1_countTheEntities($m)
|
||||
{
|
||||
$sno=$m->getParam(0);
|
||||
$str=$sno->scalarval();
|
||||
$gt=0; $lt=0; $ap=0; $qu=0; $amp=0;
|
||||
for($i=0; $i<strlen($str); $i++)
|
||||
{
|
||||
$c=substr($str, $i, 1);
|
||||
switch($c)
|
||||
{
|
||||
case ">":
|
||||
$gt++;
|
||||
break;
|
||||
case "<":
|
||||
$lt++;
|
||||
break;
|
||||
case "\"":
|
||||
$qu++;
|
||||
break;
|
||||
case "'":
|
||||
$ap++;
|
||||
break;
|
||||
case "&":
|
||||
$amp++;
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
return new xmlrpcresp(new xmlrpcval(array(
|
||||
"ctLeftAngleBrackets" => new xmlrpcval($lt, "int"),
|
||||
"ctRightAngleBrackets" => new xmlrpcval($gt, "int"),
|
||||
"ctAmpersands" => new xmlrpcval($amp, "int"),
|
||||
"ctApostrophes" => new xmlrpcval($ap, "int"),
|
||||
"ctQuotes" => new xmlrpcval($qu, "int")),
|
||||
"struct"
|
||||
));
|
||||
}
|
||||
|
||||
// trivial interop tests
|
||||
// http://www.xmlrpc.com/stories/storyReader$1636
|
||||
|
||||
$i_echoString_sig=array(array($xmlrpcString, $xmlrpcString));
|
||||
$i_echoString_doc="Echoes string.";
|
||||
|
||||
$i_echoStringArray_sig=array(array($xmlrpcArray, $xmlrpcArray));
|
||||
$i_echoStringArray_doc="Echoes string array.";
|
||||
|
||||
$i_echoInteger_sig=array(array($xmlrpcInt, $xmlrpcInt));
|
||||
$i_echoInteger_doc="Echoes integer.";
|
||||
|
||||
$i_echoIntegerArray_sig=array(array($xmlrpcArray, $xmlrpcArray));
|
||||
$i_echoIntegerArray_doc="Echoes integer array.";
|
||||
|
||||
$i_echoFloat_sig=array(array($xmlrpcDouble, $xmlrpcDouble));
|
||||
$i_echoFloat_doc="Echoes float.";
|
||||
|
||||
$i_echoFloatArray_sig=array(array($xmlrpcArray, $xmlrpcArray));
|
||||
$i_echoFloatArray_doc="Echoes float array.";
|
||||
|
||||
$i_echoStruct_sig=array(array($xmlrpcStruct, $xmlrpcStruct));
|
||||
$i_echoStruct_doc="Echoes struct.";
|
||||
|
||||
$i_echoStructArray_sig=array(array($xmlrpcArray, $xmlrpcArray));
|
||||
$i_echoStructArray_doc="Echoes struct array.";
|
||||
|
||||
$i_echoValue_doc="Echoes any value back.";
|
||||
$i_echoValue_sig=array(array($xmlrpcValue, $xmlrpcValue));
|
||||
|
||||
$i_echoBase64_sig=array(array($xmlrpcBase64, $xmlrpcBase64));
|
||||
$i_echoBase64_doc="Echoes base64.";
|
||||
|
||||
$i_echoDate_sig=array(array($xmlrpcDateTime, $xmlrpcDateTime));
|
||||
$i_echoDate_doc="Echoes dateTime.";
|
||||
|
||||
function i_echoParam($m)
|
||||
{
|
||||
$s=$m->getParam(0);
|
||||
return new xmlrpcresp($s);
|
||||
}
|
||||
|
||||
function i_echoString($m) { return i_echoParam($m); }
|
||||
function i_echoInteger($m) { return i_echoParam($m); }
|
||||
function i_echoFloat($m) { return i_echoParam($m); }
|
||||
function i_echoStruct($m) { return i_echoParam($m); }
|
||||
function i_echoStringArray($m) { return i_echoParam($m); }
|
||||
function i_echoIntegerArray($m) { return i_echoParam($m); }
|
||||
function i_echoFloatArray($m) { return i_echoParam($m); }
|
||||
function i_echoStructArray($m) { return i_echoParam($m); }
|
||||
function i_echoValue($m) { return i_echoParam($m); }
|
||||
function i_echoBase64($m) { return i_echoParam($m); }
|
||||
function i_echoDate($m) { return i_echoParam($m); }
|
||||
|
||||
$i_whichToolkit_sig=array(array($xmlrpcStruct));
|
||||
$i_whichToolkit_doc="Returns a struct containing the following strings: toolkitDocsUrl, toolkitName, toolkitVersion, toolkitOperatingSystem.";
|
||||
|
||||
function i_whichToolkit($m)
|
||||
{
|
||||
global $xmlrpcName, $xmlrpcVersion,$SERVER_SOFTWARE;
|
||||
$ret=array(
|
||||
"toolkitDocsUrl" => "http://phpxmlrpc.sourceforge.net/",
|
||||
"toolkitName" => $xmlrpcName,
|
||||
"toolkitVersion" => $xmlrpcVersion,
|
||||
"toolkitOperatingSystem" => isset ($SERVER_SOFTWARE) ? $SERVER_SOFTWARE : $_SERVER['SERVER_SOFTWARE']
|
||||
);
|
||||
return new xmlrpcresp ( php_xmlrpc_encode($ret));
|
||||
}
|
||||
|
||||
$o=new xmlrpc_server_methods_container;
|
||||
$a=array(
|
||||
"examples.getStateName" => array(
|
||||
"function" => "findstate",
|
||||
"signature" => $findstate_sig,
|
||||
"docstring" => $findstate_doc
|
||||
),
|
||||
"examples.sortByAge" => array(
|
||||
"function" => "agesorter",
|
||||
"signature" => $agesorter_sig,
|
||||
"docstring" => $agesorter_doc
|
||||
),
|
||||
"examples.addtwo" => array(
|
||||
"function" => "addtwo",
|
||||
"signature" => $addtwo_sig,
|
||||
"docstring" => $addtwo_doc
|
||||
),
|
||||
"examples.addtwodouble" => array(
|
||||
"function" => "addtwodouble",
|
||||
"signature" => $addtwodouble_sig,
|
||||
"docstring" => $addtwodouble_doc
|
||||
),
|
||||
"examples.stringecho" => array(
|
||||
"function" => "stringecho",
|
||||
"signature" => $stringecho_sig,
|
||||
"docstring" => $stringecho_doc
|
||||
),
|
||||
"examples.echo" => array(
|
||||
"function" => "echoback",
|
||||
"signature" => $echoback_sig,
|
||||
"docstring" => $echoback_doc
|
||||
),
|
||||
"examples.decode64" => array(
|
||||
"function" => "echosixtyfour",
|
||||
"signature" => $echosixtyfour_sig,
|
||||
"docstring" => $echosixtyfour_doc
|
||||
),
|
||||
"examples.invertBooleans" => array(
|
||||
"function" => "bitflipper",
|
||||
"signature" => $bitflipper_sig,
|
||||
"docstring" => $bitflipper_doc
|
||||
),
|
||||
"examples.generatePHPWarning" => array(
|
||||
"function" => array($o, "phpwarninggenerator")
|
||||
//'function' => 'xmlrpc_server_methods_container::phpwarninggenerator'
|
||||
),
|
||||
"examples.getallheaders" => array(
|
||||
"function" => 'getallheaders_xmlrpc',
|
||||
"signature" => $getallheaders_sig,
|
||||
"docstring" => $getallheaders_doc
|
||||
),
|
||||
"examples.setcookies" => array(
|
||||
"function" => 'setcookies',
|
||||
"signature" => $setcookies_sig,
|
||||
"docstring" => $setcookies_doc
|
||||
),
|
||||
"examples.getcookies" => array(
|
||||
"function" => 'getcookies',
|
||||
"signature" => $getcookies_sig,
|
||||
"docstring" => $getcookies_doc
|
||||
),
|
||||
"mail.send" => array(
|
||||
"function" => "mail_send",
|
||||
"signature" => $mail_send_sig,
|
||||
"docstring" => $mail_send_doc
|
||||
),
|
||||
"validator1.arrayOfStructsTest" => array(
|
||||
"function" => "v1_arrayOfStructs",
|
||||
"signature" => $v1_arrayOfStructs_sig,
|
||||
"docstring" => $v1_arrayOfStructs_doc
|
||||
),
|
||||
"validator1.easyStructTest" => array(
|
||||
"function" => "v1_easyStruct",
|
||||
"signature" => $v1_easyStruct_sig,
|
||||
"docstring" => $v1_easyStruct_doc
|
||||
),
|
||||
"validator1.echoStructTest" => array(
|
||||
"function" => "v1_echoStruct",
|
||||
"signature" => $v1_echoStruct_sig,
|
||||
"docstring" => $v1_echoStruct_doc
|
||||
),
|
||||
"validator1.manyTypesTest" => array(
|
||||
"function" => "v1_manyTypes",
|
||||
"signature" => $v1_manyTypes_sig,
|
||||
"docstring" => $v1_manyTypes_doc
|
||||
),
|
||||
"validator1.moderateSizeArrayCheck" => array(
|
||||
"function" => "v1_moderateSizeArrayCheck",
|
||||
"signature" => $v1_moderateSizeArrayCheck_sig,
|
||||
"docstring" => $v1_moderateSizeArrayCheck_doc
|
||||
),
|
||||
"validator1.simpleStructReturnTest" => array(
|
||||
"function" => "v1_simpleStructReturn",
|
||||
"signature" => $v1_simpleStructReturn_sig,
|
||||
"docstring" => $v1_simpleStructReturn_doc
|
||||
),
|
||||
"validator1.nestedStructTest" => array(
|
||||
"function" => "v1_nestedStruct",
|
||||
"signature" => $v1_nestedStruct_sig,
|
||||
"docstring" => $v1_nestedStruct_doc
|
||||
),
|
||||
"validator1.countTheEntities" => array(
|
||||
"function" => "v1_countTheEntities",
|
||||
"signature" => $v1_countTheEntities_sig,
|
||||
"docstring" => $v1_countTheEntities_doc
|
||||
),
|
||||
"interopEchoTests.echoString" => array(
|
||||
"function" => "i_echoString",
|
||||
"signature" => $i_echoString_sig,
|
||||
"docstring" => $i_echoString_doc
|
||||
),
|
||||
"interopEchoTests.echoStringArray" => array(
|
||||
"function" => "i_echoStringArray",
|
||||
"signature" => $i_echoStringArray_sig,
|
||||
"docstring" => $i_echoStringArray_doc
|
||||
),
|
||||
"interopEchoTests.echoInteger" => array(
|
||||
"function" => "i_echoInteger",
|
||||
"signature" => $i_echoInteger_sig,
|
||||
"docstring" => $i_echoInteger_doc
|
||||
),
|
||||
"interopEchoTests.echoIntegerArray" => array(
|
||||
"function" => "i_echoIntegerArray",
|
||||
"signature" => $i_echoIntegerArray_sig,
|
||||
"docstring" => $i_echoIntegerArray_doc
|
||||
),
|
||||
"interopEchoTests.echoFloat" => array(
|
||||
"function" => "i_echoFloat",
|
||||
"signature" => $i_echoFloat_sig,
|
||||
"docstring" => $i_echoFloat_doc
|
||||
),
|
||||
"interopEchoTests.echoFloatArray" => array(
|
||||
"function" => "i_echoFloatArray",
|
||||
"signature" => $i_echoFloatArray_sig,
|
||||
"docstring" => $i_echoFloatArray_doc
|
||||
),
|
||||
"interopEchoTests.echoStruct" => array(
|
||||
"function" => "i_echoStruct",
|
||||
"signature" => $i_echoStruct_sig,
|
||||
"docstring" => $i_echoStruct_doc
|
||||
),
|
||||
"interopEchoTests.echoStructArray" => array(
|
||||
"function" => "i_echoStructArray",
|
||||
"signature" => $i_echoStructArray_sig,
|
||||
"docstring" => $i_echoStructArray_doc
|
||||
),
|
||||
"interopEchoTests.echoValue" => array(
|
||||
"function" => "i_echoValue",
|
||||
"signature" => $i_echoValue_sig,
|
||||
"docstring" => $i_echoValue_doc
|
||||
),
|
||||
"interopEchoTests.echoBase64" => array(
|
||||
"function" => "i_echoBase64",
|
||||
"signature" => $i_echoBase64_sig,
|
||||
"docstring" => $i_echoBase64_doc
|
||||
),
|
||||
"interopEchoTests.echoDate" => array(
|
||||
"function" => "i_echoDate",
|
||||
"signature" => $i_echoDate_sig,
|
||||
"docstring" => $i_echoDate_doc
|
||||
),
|
||||
"interopEchoTests.whichToolkit" => array(
|
||||
"function" => "i_whichToolkit",
|
||||
"signature" => $i_whichToolkit_sig,
|
||||
"docstring" => $i_whichToolkit_doc
|
||||
)
|
||||
);
|
||||
|
||||
if ($findstate2_sig)
|
||||
$a['examples.php.getStateName'] = $findstate2_sig;
|
||||
|
||||
if ($findstate3_sig)
|
||||
$a['examples.php2.getStateName'] = $findstate3_sig;
|
||||
|
||||
if ($findstate4_sig)
|
||||
$a['examples.php3.getStateName'] = $findstate4_sig;
|
||||
|
||||
$s=new xmlrpc_server($a, false);
|
||||
$s->setdebug(3);
|
||||
$s->compress_response = true;
|
||||
|
||||
// out-of-band information: let the client manipulate the server operations.
|
||||
// we do this to help the testsuite script: do not reproduce in production!
|
||||
if (isset($_GET['RESPONSE_ENCODING']))
|
||||
$s->response_charset_encoding = $_GET['RESPONSE_ENCODING'];
|
||||
|
||||
$s->service();
|
||||
// that should do all we need!
|
||||
?>
|
||||
93
include/limesurvey/admin/classes/xmlrpc/demo/vardemo.php
Normal file
93
include/limesurvey/admin/classes/xmlrpc/demo/vardemo.php
Normal file
@@ -0,0 +1,93 @@
|
||||
<html>
|
||||
<head><title>xmlrpc</title></head>
|
||||
<body>
|
||||
<?php
|
||||
include("xmlrpc.inc");
|
||||
|
||||
$f = new xmlrpcmsg('examples.getStateName');
|
||||
|
||||
print "<h3>Testing value serialization</h3>\n";
|
||||
|
||||
$v = new xmlrpcval(23, "int");
|
||||
print "<PRE>" . htmlentities($v->serialize()) . "</PRE>";
|
||||
$v = new xmlrpcval("What are you saying? >> << &&");
|
||||
print "<PRE>" . htmlentities($v->serialize()) . "</PRE>";
|
||||
|
||||
$v = new xmlrpcval(array(
|
||||
new xmlrpcval("ABCDEFHIJ"),
|
||||
new xmlrpcval(1234, 'int'),
|
||||
new xmlrpcval(1, 'boolean')),
|
||||
"array"
|
||||
);
|
||||
|
||||
print "<PRE>" . htmlentities($v->serialize()) . "</PRE>";
|
||||
|
||||
$v = new xmlrpcval(
|
||||
array(
|
||||
"thearray" => new xmlrpcval(
|
||||
array(
|
||||
new xmlrpcval("ABCDEFHIJ"),
|
||||
new xmlrpcval(1234, 'int'),
|
||||
new xmlrpcval(1, 'boolean'),
|
||||
new xmlrpcval(0, 'boolean'),
|
||||
new xmlrpcval(true, 'boolean'),
|
||||
new xmlrpcval(false, 'boolean')
|
||||
),
|
||||
"array"
|
||||
),
|
||||
"theint" => new xmlrpcval(23, 'int'),
|
||||
"thestring" => new xmlrpcval("foobarwhizz"),
|
||||
"thestruct" => new xmlrpcval(
|
||||
array(
|
||||
"one" => new xmlrpcval(1, 'int'),
|
||||
"two" => new xmlrpcval(2, 'int')
|
||||
),
|
||||
"struct"
|
||||
)
|
||||
),
|
||||
"struct"
|
||||
);
|
||||
|
||||
print "<PRE>" . htmlentities($v->serialize()) . "</PRE>";
|
||||
|
||||
$w = new xmlrpcval(array($v, new xmlrpcval("That was the struct!")), "array");
|
||||
|
||||
print "<PRE>" . htmlentities($w->serialize()) . "</PRE>";
|
||||
|
||||
$w = new xmlrpcval("Mary had a little lamb,
|
||||
Whose fleece was white as snow,
|
||||
And everywhere that Mary went
|
||||
the lamb was sure to go.
|
||||
|
||||
Mary had a little lamb
|
||||
She tied it to a pylon
|
||||
Ten thousand volts went down its back
|
||||
And turned it into nylon", "base64"
|
||||
);
|
||||
print "<PRE>" . htmlentities($w->serialize()) . "</PRE>";
|
||||
print "<PRE>Value of base64 string is: '" . $w->scalarval() . "'</PRE>";
|
||||
|
||||
$f->method('');
|
||||
$f->addParam(new xmlrpcval("41", "int"));
|
||||
|
||||
print "<h3>Testing request serialization</h3>\n";
|
||||
$op = $f->serialize();
|
||||
print "<PRE>" . htmlentities($op) . "</PRE>";
|
||||
|
||||
print "<h3>Testing ISO date format</h3><pre>\n";
|
||||
|
||||
$t = time();
|
||||
$date = iso8601_encode($t);
|
||||
print "Now is $t --> $date\n";
|
||||
print "Or in UTC, that is " . iso8601_encode($t, 1) . "\n";
|
||||
$tb = iso8601_decode($date);
|
||||
print "That is to say $date --> $tb\n";
|
||||
print "Which comes out at " . iso8601_encode($tb) . "\n";
|
||||
print "Which was the time in UTC at " . iso8601_decode($date, 1) . "\n";
|
||||
|
||||
print "</pre>\n";
|
||||
?>
|
||||
<hr/>
|
||||
<em>$Id: vardemo.php 2 2009-03-16 20:22:51Z ggiunta $</em>
|
||||
</body>
|
||||
</html>
|
||||
80
include/limesurvey/admin/classes/xmlrpc/doc/Makefile
Normal file
80
include/limesurvey/admin/classes/xmlrpc/doc/Makefile
Normal file
@@ -0,0 +1,80 @@
|
||||
# $Id: Makefile,v 1.13 2008/03/07 13:01:55 ggiunta Exp $
|
||||
|
||||
### USER EDITABLE VARS ###
|
||||
|
||||
WEB=/var/www/xmlrpc/doc
|
||||
|
||||
MKDIR=mkdir
|
||||
|
||||
PHP=php
|
||||
|
||||
FOP=fop
|
||||
|
||||
PHPDOC=phpdoc
|
||||
|
||||
|
||||
#### DO NOT TOUCH FROM HERE ONWARDS ###
|
||||
|
||||
install:
|
||||
${MKDIR} -p ${WEB}
|
||||
cp *.html ${WEB}
|
||||
cp *.css ${WEB}
|
||||
cp *.gif ${WEB}
|
||||
@echo HTML version of the manual has been installed to ${WEB}
|
||||
|
||||
|
||||
### the following targets are to be used for library development ###
|
||||
|
||||
doc: out/index.html xmlrpc_php.pdf javadoc-out/index.html
|
||||
|
||||
# tools currently used in building docs: php 5 with xsl extension, apache fop, phpdocumentor
|
||||
# alternatives include doxygen, jade, saxon, xsltproc etc...
|
||||
|
||||
out/index.html xmlrpc_php.pdf: xmlrpc_php.xml
|
||||
-${MKDIR} out
|
||||
# Jade cmd yet to be rebuilt, starting from xml file and putting output in ./out dir, e.g.
|
||||
# jade -t xml -d custom.dsl xmlrpc_php.xml
|
||||
#
|
||||
# convertdoc command for xmlmind xxe editor
|
||||
# convertdoc docb.toHTML xmlrpc_php.xml -u out
|
||||
#
|
||||
# saxon + xerces xml parser + saxon extensions + xslthl: adds a little syntax highligting
|
||||
# (bold and italics only, no color) for php source examples...
|
||||
# java \
|
||||
# -classpath c:\programmi\saxon\saxon.jar\;c:\programmi\saxon\xslthl.jar\;c:\programmi\xerces\xercesImpl.jar\;C:\htdocs\xmlrpc_cvs\docbook-xsl\extensions\saxon65.jar \
|
||||
# -Djavax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl \
|
||||
# -Djavax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl \
|
||||
# -Dxslthl.config=file:///c:/htdocs/xmlrpc_cvs/docbook-xsl/highlighting/xslthl-config.xml \
|
||||
# com.icl.saxon.StyleSheet -o xmlrpc_php.fo.xml xmlrpc_php.xml custom.fo.xsl use.extensions=1
|
||||
#
|
||||
# custom php script that does the xslt magic
|
||||
${PHP} convert.php xmlrpc_php.xml custom.xsl out/
|
||||
# post process html files to highlight php code samples
|
||||
${PHP} highlight.php out
|
||||
# convert to fo and then to pdf using apache fop
|
||||
${PHP} convert.php xmlrpc_php.xml custom.fo.xsl xmlrpc_php.fo.xml
|
||||
${FOP} xmlrpc_php.fo.xml xmlrpc_php.pdf
|
||||
# -rm xmlrpc_php.fo.xml
|
||||
|
||||
javadoc-out/index.html: ../lib/xmlrpc.inc ../lib/xmlrpcs.inc ../lib/xmlrpc_wrappers.inc
|
||||
# generate docs out of javadoc via doxygen
|
||||
# doxygen phpxmlrpc.dox
|
||||
#
|
||||
# generate docs out of javadoc via phpdocumentor
|
||||
${PHPDOC} -f ../lib/xmlrpc.inc,../lib/xmlrpcs.inc,../lib/xmlrpc_wrappers.inc -t javadoc-out -ti PHP-XMLRPC -o HTML:frames:default -s
|
||||
|
||||
dist: doc
|
||||
${MKDIR} -p ../xmlrpc-${VERSION}/doc
|
||||
-cp out/*.html ../xmlrpc-${VERSION}/doc
|
||||
-cp out/*.css ../xmlrpc-${VERSION}/doc
|
||||
-cp out/*.gif ../xmlrpc-${VERSION}/doc
|
||||
-cp out/*.pdf ../xmlrpc-${VERSION}/doc
|
||||
cp xmlrpc_php.xml ../xmlrpc-${VERSION}/doc
|
||||
cp xmlrpc_php.pdf ../xmlrpc-${VERSION}/doc
|
||||
cp Makefile ../xmlrpc-${VERSION}/doc
|
||||
|
||||
clean:
|
||||
-rm -f out/*.html
|
||||
-rm -rf javadoc-out
|
||||
-rm xmlrpc_php.fo.xml
|
||||
-rm xmlrpc_php.pdf
|
||||
8
include/limesurvey/admin/classes/xmlrpc/doc/apa.html
Normal file
8
include/limesurvey/admin/classes/xmlrpc/doc/apa.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix A. Integration with the PHP xmlrpc extension</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch12s09.html" title="Does the library support using cookies / http sessions?" /><link rel="next" href="apb.html" title="Appendix B. Substitution of the PHP xmlrpc extension" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix A. Integration with the PHP xmlrpc extension</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s09.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apb.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="integration"></a>Appendix A. Integration with the PHP xmlrpc extension</h2></div></div></div><p>To be documented more...</p><p>In short: for the fastest execution possible, you can enable the php
|
||||
native xmlrpc extension, and use it in conjunction with phpxmlrpc. The
|
||||
following code snippet gives an example of such integration</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"></span><span style="color: #FF8000">/*** client side ***/<br /></span><span style="color: #0000BB">$c </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://phpxmlrpc.sourceforge.net/server.php'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// tell the client to return raw xml as response value<br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">return_type </span><span style="color: #007700">= </span><span style="color: #DD0000">'xml'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// let the native xmlrpc extension take care of encoding request parameters<br /></span><span style="color: #0000BB">$r </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(</span><span style="color: #0000BB">xmlrpc_encode_request</span><span style="color: #007700">(</span><span style="color: #DD0000">'examples.getStateName'</span><span style="color: #007700">, </span><span style="color: #0000BB">$_POST</span><span style="color: #007700">[</span><span style="color: #DD0000">'stateno'</span><span style="color: #007700">]));<br /><br />if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">())<br /> </span><span style="color: #FF8000">// HTTP transport error<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">'Got error '</span><span style="color: #007700">.</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">();<br />else<br />{<br /> </span><span style="color: #FF8000">// HTTP request OK, but XML returned from server not parsed yet<br /> </span><span style="color: #0000BB">$v </span><span style="color: #007700">= </span><span style="color: #0000BB">xmlrpc_decode</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">());<br /> </span><span style="color: #FF8000">// check if we got a valid xmlrpc response from server<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$v </span><span style="color: #007700">=== </span><span style="color: #0000BB">NULL</span><span style="color: #007700">)<br /> echo </span><span style="color: #DD0000">'Got invalid response'</span><span style="color: #007700">;<br /> else<br /> </span><span style="color: #FF8000">// check if server sent a fault response<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">xmlrpc_is_fault</span><span style="color: #007700">(</span><span style="color: #0000BB">$v</span><span style="color: #007700">))<br /> echo </span><span style="color: #DD0000">'Got xmlrpc fault '</span><span style="color: #007700">.</span><span style="color: #0000BB">$v</span><span style="color: #007700">[</span><span style="color: #DD0000">'faultCode'</span><span style="color: #007700">];<br /> else<br /> echo</span><span style="color: #DD0000">'Got response: '</span><span style="color: #007700">.</span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$v</span><span style="color: #007700">);<br />}</span>
|
||||
</span>
|
||||
</code></pre></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s09.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apb.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Does the library support using cookies / http sessions? </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix B. Substitution of the PHP xmlrpc extension</td></tr></table></div></body></html>
|
||||
12
include/limesurvey/admin/classes/xmlrpc/doc/apb.html
Normal file
12
include/limesurvey/admin/classes/xmlrpc/doc/apb.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix B. Substitution of the PHP xmlrpc extension</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="apa.html" title="Appendix A. Integration with the PHP xmlrpc extension" /><link rel="next" href="apc.html" title="Appendix C. 'Enough of xmlrpcvals!': new style library usage" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix B. Substitution of the PHP xmlrpc extension</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apa.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apc.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="substitution"></a>Appendix B. Substitution of the PHP xmlrpc extension</h2></div></div></div><p>Yet another interesting situation is when you are using a ready-made
|
||||
php application, that provides support for the XMLRPC protocol via the
|
||||
native php xmlrpc extension, but the extension is not available on your
|
||||
php install (e.g. because of shared hosting constraints).</p><p>Since version 2.1, the PHP-XMLRPC library provides a compatibility
|
||||
layer that aims to be 100% compliant with the xmlrpc extension API. This
|
||||
means that any code written to run on the extension should obtain the
|
||||
exact same results, albeit using more resources and a longer processing
|
||||
time, using the PHP-XMLRPC library and the extension compatibility module.
|
||||
The module is part of the EXTRAS package, available as a separate download
|
||||
from the sourceforge.net website, since version 0.2</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apa.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apc.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix A. Integration with the PHP xmlrpc extension </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix C. 'Enough of xmlrpcvals!': new style library usage</td></tr></table></div></body></html>
|
||||
5
include/limesurvey/admin/classes/xmlrpc/doc/apc.html
Normal file
5
include/limesurvey/admin/classes/xmlrpc/doc/apc.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix C. 'Enough of xmlrpcvals!': new style library usage</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="apb.html" title="Appendix B. Substitution of the PHP xmlrpc extension" /><link rel="next" href="apd.html" title="Appendix D. Usage of the debugger" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix C. 'Enough of xmlrpcvals!': new style library usage</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apb.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apd.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="enough"></a>Appendix C. 'Enough of xmlrpcvals!': new style library usage</h2></div></div></div><p>To be documented...</p><p>In the meantime, see docs about xmlrpc_client::return_type and
|
||||
xmlrpc_server::functions_parameters_types, as well as php_xmlrpc_encode,
|
||||
php_xmlrpc_decode and php_xmlrpc_decode_xml</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apb.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apd.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix B. Substitution of the PHP xmlrpc extension </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix D. Usage of the debugger</td></tr></table></div></body></html>
|
||||
24
include/limesurvey/admin/classes/xmlrpc/doc/apd.html
Normal file
24
include/limesurvey/admin/classes/xmlrpc/doc/apd.html
Normal file
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix D. Usage of the debugger</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="apc.html" title="Appendix C. 'Enough of xmlrpcvals!': new style library usage" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Usage of the debugger</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apc.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="debugger"></a>Appendix D. Usage of the debugger</h2></div></div></div><p>A webservice debugger is included in the library to help during
|
||||
development and testing.</p><p>The interface should be self-explicative enough to need little
|
||||
documentation.</p><div align="center"><img src="debugger.gif" align="middle" /></div><p>The most useful feature of the debugger is without doubt the "Show
|
||||
debug info" option. It allows to have a screen dump of the complete http
|
||||
communication between client and server, including the http headers as
|
||||
well as the request and response payloads, and is invaluable when
|
||||
troubleshooting problems with charset encoding, authentication or http
|
||||
compression.</p><p>The debugger can take advantage of the JSONRPC library extension, to
|
||||
allow debugging of JSON-RPC webservices, and of the JS-XMLRPC library
|
||||
visual editor to allow easy mouse-driven construction of the payload for
|
||||
remote methods. Both components have to be downloaded separately from the
|
||||
sourceforge.net web pages and copied to the debugger directory to enable
|
||||
the extra functionality:</p><div class="itemizedlist"><ul type="disc"><li><p>to enable jsonrpc functionality, download the PHP-XMLRPC
|
||||
EXTRAS package, and copy the file <code class="filename">jsonrpc.inc</code>
|
||||
either to the same directory as the debugger or somewhere in your
|
||||
php include path</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>to enable the visual value editing dialog, download the
|
||||
JS-XMLRPC library, and copy somewhere in the web root files
|
||||
<code class="filename">visualeditor.php</code>,
|
||||
<code class="filename">visualeditor.css</code> and the folders
|
||||
<code class="filename">yui</code> and <code class="filename">img</code>. Then edit the
|
||||
debugger file <code class="filename">controller.php</code> and set
|
||||
appropriately the variable <code class="varname">$editorpath</code>.</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apc.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Appendix C. 'Enough of xmlrpcvals!': new style library usage </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|
||||
10
include/limesurvey/admin/classes/xmlrpc/doc/ch01.html
Normal file
10
include/limesurvey/admin/classes/xmlrpc/doc/ch01.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 1. Introduction</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="index.html" title="XML-RPC for PHP" /><link rel="next" href="ch02.html" title="Chapter 2. What's new" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch01.html#id530427">Acknowledgements</a></span></dt></dl></div><p>XML-RPC is a format devised by <a class="ulink" href="http://www.userland.com/" target="_top">Userland Software</a> for achieving
|
||||
remote procedure call via XML using HTTP as the transport. XML-RPC has its
|
||||
own web site, <a class="ulink" href="http://www.xmlrpc.com/" target="_top">www.xmlrpc.com</a></p><p>This collection of PHP classes provides a framework for writing
|
||||
XML-RPC clients and servers in PHP.</p><p>Main goals of the project are ease of use, flexibility and
|
||||
completeness.</p><p>The original author is Edd Dumbill of <a class="ulink" href="http://usefulinc.com/" target="_top">Useful Information Company</a>. As of the
|
||||
1.0 stable release, the project has been opened to wider involvement and
|
||||
moved to <a class="ulink" href="http://phpxmlrpc.sourceforge.net/" target="_top">SourceForge</a>.</p><p>A list of XML-RPC implementations for other languages such as Perl
|
||||
and Python can be found on the <a class="ulink" href="http://www.xmlrpc.com/" target="_top">www.xmlrpc.com</a> site.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id530427"></a>Acknowledgements</h2></div></div></div><p>Daniel E. Baumann</p><p>James Bercegay</p><p>Leon Blackwell</p><p>Stephane Bortzmeyer</p><p>Daniel Convissor</p><p>Geoffrey T. Dairiki</p><p>Stefan Esser</p><p>James Flemer</p><p>Ernst de Haan</p><p>Tom Knight</p><p>Axel Kollmorgen</p><p>Peter Kocks</p><p>Daniel Krippner</p><p>S. Kuip</p><p>A. Lambert</p><p>Dan Libby</p><p>Arnaud Limbourg</p><p>Ernest MacDougal Campbell III</p><p>Lukasz Mach</p><p>Kjartan Mannes</p><p>Ben Margolin</p><p>Nicolay Mausz</p><p>Justin Miller</p><p>Jan Pfeifer</p><p>Giancarlo Pinerolo</p><p>Peter Russel</p><p>Viliam Simko</p><p>Douglas Squirrel</p><p>Idan Sofer</p><p>Anatoly Techtonik</p><p>Eric van der Vlist</p><p>Christian Wenz</p><p>Jim Winstead</p><p>Przemyslaw Wroblewski</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">XML-RPC for PHP </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 2. What's new</td></tr></table></div></body></html>
|
||||
20
include/limesurvey/admin/classes/xmlrpc/doc/ch02.html
Normal file
20
include/limesurvey/admin/classes/xmlrpc/doc/ch02.html
Normal file
@@ -0,0 +1,20 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 2. What's new</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch01.html" title="Chapter 1. Introduction" /><link rel="next" href="ch02s02.html" title="2.2.1" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. What's new</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch02s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="news"></a>Chapter 2. What's new</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch02.html#id530725">2.2.2</a></span></dt><dt><span class="sect1"><a href="ch02s02.html">2.2.1</a></span></dt><dt><span class="sect1"><a href="ch02s03.html">2.2</a></span></dt><dt><span class="sect1"><a href="ch02s04.html">2.1</a></span></dt><dt><span class="sect1"><a href="ch02s05.html">2.0 final</a></span></dt><dt><span class="sect1"><a href="ch02s06.html">2.0 Release candidate 3</a></span></dt><dt><span class="sect1"><a href="ch02s07.html">2.0 Release candidate 2</a></span></dt><dt><span class="sect1"><a href="ch02s08.html">2.0 Release candidate 1</a></span></dt></dl></div><p><span class="emphasis"><em>Note:</em></span> not all items the following list have
|
||||
(yet) been fully documented, and some might not be present in any other
|
||||
chapter in the manual. To find a more detailed description of new
|
||||
functions and methods please take a look at the source code of the
|
||||
library, which is quite thoroughly commented in javadoc-like form.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id530725"></a>2.2.2</h2></div></div></div><p><span class="emphasis"><em>Note:</em></span> this might the last release of the
|
||||
library that will support PHP 4. Future releases (if any) should target
|
||||
php 5.0 as minimum supported version.</p><div class="itemizedlist"><ul type="disc"><li><p>fixed: encoding of utf-8 characters outside of the BMP
|
||||
plane</p></li><li><p>fixed: character set declarations surrounded by double
|
||||
quotes were not recognized in http headers</p></li><li><p>fixed: be more tolerant in detection of charset in http
|
||||
headers</p></li><li><p>fixed: fix detection of zlib.output_compression</p></li><li><p>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)</p></li><li><p>fixed: format floating point values using the correct
|
||||
decimal separator even when php locale is set to one that uses
|
||||
comma</p></li><li><p>fixed: improve robustness of the debugger when parsing weird
|
||||
results from non-compliant servers</p></li><li><p>php warning when receiving 'false' in a bool value</p></li><li><p>improved: allow the add_to_map server method to add docs for
|
||||
single params too</p></li><li><p>improved: added the possibility to wrap for exposure as
|
||||
xmlrpc methods plain php class methods, object methods and even
|
||||
whole classes</p></li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch02s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. Introduction </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.2.1</td></tr></table></div></body></html>
|
||||
9
include/limesurvey/admin/classes/xmlrpc/doc/ch02s02.html
Normal file
9
include/limesurvey/admin/classes/xmlrpc/doc/ch02s02.html
Normal file
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.2.1</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02.html" title="Chapter 2. What's new" /><link rel="next" href="ch02s03.html" title="2.2" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.2.1</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch02s03.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id530832"></a>2.2.1</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>fixed: work aroung bug in php 5.2.2 which broke support of
|
||||
HTTP_RAW_POST_DATA</p></li><li><p>fixed: is_dir parameter of setCaCertificate() method is
|
||||
reversed</p></li><li><p>fixed: a php warning in xmlrpc_client creator method</p></li><li><p>fixed: parsing of '1e+1' as valid float</p></li><li><p>fixed: allow errorlevel 3 to work when prev. error handler was
|
||||
a static method</p></li><li><p>fixed: usage of client::setcookie() for multiple cookies in
|
||||
non-ssl mode</p></li><li><p>improved: support for CP1252 charset is not part or the
|
||||
library but almost possible</p></li><li><p>improved: more info when curl is enabled and debug mode is
|
||||
on</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. What's new </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.2</td></tr></table></div></body></html>
|
||||
12
include/limesurvey/admin/classes/xmlrpc/doc/ch02s03.html
Normal file
12
include/limesurvey/admin/classes/xmlrpc/doc/ch02s03.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.2</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02s02.html" title="2.2.1" /><link rel="next" href="ch02s04.html" title="2.1" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.2</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch02s04.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id530910"></a>2.2</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>fixed: debugger errors on php installs with magic_quotes_gpc
|
||||
on</p></li><li><p>fixed: support for https connections via proxy</p></li><li><p>fixed: wrap_xmlrpc_method() generated code failed to properly
|
||||
encode php objects</p></li><li><p>improved: slightly faster encoding of data which is internally
|
||||
UTF-8</p></li><li><p>improved: debugger always generates a 'null' id for jsonrpc if
|
||||
user omits it</p></li><li><p>new: debugger can take advantage of a graphical value builder
|
||||
(it has to be downloaded separately, as part of jsxmlrpc package.
|
||||
See Appendix D for more details)</p></li><li><p>new: support for the <NIL/> xmlrpc extension. see below
|
||||
for more details</p></li><li><p>new: server support for the system.getCapabilities xmlrpc
|
||||
extension</p></li><li><p>new: <code class="function"><a class="link" href="ch09.html#wrap_xmlrpc_method">wrap_xmlrpc_method()</a></code>
|
||||
accepts two new options: debug and return_on_fault</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.2.1 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.1</td></tr></table></div></body></html>
|
||||
49
include/limesurvey/admin/classes/xmlrpc/doc/ch02s04.html
Normal file
49
include/limesurvey/admin/classes/xmlrpc/doc/ch02s04.html
Normal file
@@ -0,0 +1,49 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.1</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02s03.html" title="2.2" /><link rel="next" href="ch02s05.html" title="2.0 final" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.1</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s03.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch02s05.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id531007"></a>2.1</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>The <code class="function">wrap_php_function</code> and
|
||||
<code class="function">wrap_xmlrpc_method</code> functions have been moved
|
||||
out of the base library file <code class="filename">xmlrpc.inc</code> into
|
||||
a file of their own: <code class="filename">xmlrpc_wrappers.inc</code>. You
|
||||
will have to include() / require() it in your scripts if you have
|
||||
been using those functions. For increased security, the automatic
|
||||
rebuilding of php object instances out of received xmlrpc structs
|
||||
in <code class="function">wrap_xmlrpc_method()</code> has been disabled
|
||||
(but it can be optionally re-enabled). Both
|
||||
<code class="function">wrap_php_function()</code> and
|
||||
<code class="function">wrap_xmlrpc_method()</code> functions accept many
|
||||
more options to fine tune their behaviour, including one to return
|
||||
the php code to be saved and later used as standalone php
|
||||
script</p></li><li><p>The constructor of xmlrpcval() values has seen some internal
|
||||
changes, and it will not throw a php warning anymore when invoked
|
||||
using an unknown xmlrpc type: the error will only be written to
|
||||
php error log. Also <code class="code">new xmlrpcval('true', 'boolean')</code>
|
||||
is not supported anymore</p></li><li><p>The new function
|
||||
<code class="function">php_xmlrpc_decode_xml()</code> will take the xml
|
||||
representation of either an xmlrpc request, response or single
|
||||
value and return the corresponding php-xmlrpc object
|
||||
instance</p></li><li><p>A new function <code class="function">wrap_xmlrpc_server()</code>has
|
||||
been added, to wrap all (or some) of the methods exposed by a
|
||||
remote xmlrpc server into a php class</p></li><li><p>A new file has been added:
|
||||
<code class="filename">verify_compat.php</code>, to help users diagnose the
|
||||
level of compliance of their php installation with the
|
||||
library</p></li><li><p>Restored compatibility with php 4.0.5 (for those poor souls
|
||||
still stuck on it)</p></li><li><p>Method <code class="methodname">xmlrpc_server->service()</code>
|
||||
now returns a value: either the response payload or xmlrpcresp
|
||||
object instance</p></li><li><p>Method
|
||||
<code class="methodname">xmlrpc_server->add_to_map()</code> now
|
||||
accepts xmlrpc methods with no param definitions</p></li><li><p>Documentation for single parameters of exposed methods can
|
||||
be added to the dispatch map (and turned into html docs in
|
||||
conjunction with a future release of the 'extras' package)</p></li><li><p>Full response payload is saved into xmlrpcresp object for
|
||||
further debugging</p></li><li><p>The debugger can now generate code that wraps a remote
|
||||
method into a php function (works for jsonrpc, too); it also has
|
||||
better support for being activated via a single GET call (e.g. for
|
||||
integration into other tools)</p></li><li><p>Stricter parsing of incoming xmlrpc messages: two more
|
||||
invalid cases are now detected (double <code class="literal">data</code>
|
||||
element inside <code class="literal">array</code> and
|
||||
<code class="literal">struct</code>/<code class="literal">array</code> after scalar
|
||||
inside <code class="literal">value</code> element)</p></li><li><p>More logging of errors in a lot of situations</p></li><li><p>Javadoc documentation of lib files (almost) complete</p></li><li><p>Many performance tweaks and code cleanups, plus the usual
|
||||
crop of bugs fixed (see NEWS file for complete list of
|
||||
bugs)</p></li><li><p>Lib internals have been modified to provide better support
|
||||
for grafting extra functionality on top of it. Stay tuned for
|
||||
future releases of the EXTRAS package (or go read Appendix
|
||||
B)...</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.2 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.0 final</td></tr></table></div></body></html>
|
||||
11
include/limesurvey/admin/classes/xmlrpc/doc/ch02s05.html
Normal file
11
include/limesurvey/admin/classes/xmlrpc/doc/ch02s05.html
Normal file
@@ -0,0 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.0 final</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02s04.html" title="2.1" /><link rel="next" href="ch02s06.html" title="2.0 Release candidate 3" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.0 final</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s04.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch02s06.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id531253"></a>2.0 final</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Added to the client class the possibility to use Digest and
|
||||
NTLM authentication methods (when using the CURL library) for
|
||||
connecting to servers and NTLM for connecting to proxies</p></li><li><p>Added to the client class the possibility to specify
|
||||
alternate certificate files/directories for authenticating the
|
||||
peer with when using HTTPS communication</p></li><li><p>Reviewed all examples and added a new demo file, containing
|
||||
a proxy to forward xmlrpc requests to other servers (useful e.g.
|
||||
for ajax coding)</p></li><li><p>The debugger has been upgraded to reflect the new client
|
||||
capabilities</p></li><li><p>All known bugs have been squashed, and the lib is more
|
||||
tolerant than ever of commonly-found mistakes</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.1 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.0 Release candidate 3</td></tr></table></div></body></html>
|
||||
14
include/limesurvey/admin/classes/xmlrpc/doc/ch02s06.html
Normal file
14
include/limesurvey/admin/classes/xmlrpc/doc/ch02s06.html
Normal file
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.0 Release candidate 3</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02s05.html" title="2.0 final" /><link rel="next" href="ch02s07.html" title="2.0 Release candidate 2" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.0 Release candidate 3</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s05.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch02s07.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id531315"></a>2.0 Release candidate 3</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Added to server class the property
|
||||
<span class="property">functions_parameters_type</span>, that allows the
|
||||
server to register plain php functions as xmlrpc methods (i.e.
|
||||
functions that do not take an xmlrpcmsg object as unique
|
||||
param)</p></li><li><p>let server and client objects serialize calls using a
|
||||
specified character set encoding for the produced xml instead of
|
||||
US-ASCII (ISO-8859-1 and UTF-8 supported)</p></li><li><p>let php_xmlrpc_decode accept xmlrpcmsg objects as valid
|
||||
input</p></li><li><p>'class::method' syntax is now accepted in the server
|
||||
dispatch map</p></li><li><p><code class="function">xmlrpc_clent::SetDebug()</code> accepts
|
||||
integer values instead of a boolean value, with debugging level 2
|
||||
adding to the information printed to screen the complete client
|
||||
request</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s05.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.0 final </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.0 Release candidate 2</td></tr></table></div></body></html>
|
||||
13
include/limesurvey/admin/classes/xmlrpc/doc/ch02s07.html
Normal file
13
include/limesurvey/admin/classes/xmlrpc/doc/ch02s07.html
Normal file
@@ -0,0 +1,13 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.0 Release candidate 2</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02s06.html" title="2.0 Release candidate 3" /><link rel="next" href="ch02s08.html" title="2.0 Release candidate 1" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.0 Release candidate 2</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s06.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch02s08.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id531385"></a>2.0 Release candidate 2</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Added a new property of the client object:
|
||||
<code class="code">xmlrpc_client->return_type</code>, indicating whether
|
||||
calls to the send() method will return xmlrpcresp objects whose
|
||||
value() is an xmlrpcval object, a php value (automatically
|
||||
decoded) or the raw xml received from the server.</p></li><li><p>Added in the extras dir. two new library file:
|
||||
<code class="filename">jsonrpc.inc</code> and
|
||||
<code class="filename">jsonrpcs.inc</code> containing new classes that
|
||||
implement support for the json-rpc protocol (alpha quality
|
||||
code)</p></li><li><p>Added a new client method: <code class="code">setKey($key,
|
||||
$keypass)</code> to be used in HTTPS connections</p></li><li><p>Added a new file containing some benchmarks in the testsuite
|
||||
directory</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s06.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s08.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.0 Release candidate 3 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.0 Release candidate 1</td></tr></table></div></body></html>
|
||||
78
include/limesurvey/admin/classes/xmlrpc/doc/ch02s08.html
Normal file
78
include/limesurvey/admin/classes/xmlrpc/doc/ch02s08.html
Normal file
@@ -0,0 +1,78 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2.0 Release candidate 1</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch02.html" title="Chapter 2. What's new" /><link rel="prev" href="ch02s07.html" title="2.0 Release candidate 2" /><link rel="next" href="ch03.html" title="Chapter 3. System Requirements" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.0 Release candidate 1</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s07.html">Prev</a> </td><th width="60%" align="center">Chapter 2. What's new</th><td width="20%" align="right"> <a accesskey="n" href="ch03.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id531455"></a>2.0 Release candidate 1</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Support for HTTP proxies (new method:
|
||||
<code class="code">xmlrpc_client::setProxy()</code>)</p></li><li><p>Support HTTP compression of both requests and responses.
|
||||
Clients can specify what kind of compression they accept for
|
||||
responses between deflate/gzip/any, and whether to compress the
|
||||
requests. Servers by default compress responses to clients that
|
||||
explicitly declare support for compression (new methods:
|
||||
<code class="code">xmlrpc_client::setAcceptedCompression()</code>,
|
||||
<code class="code">xmlrpc_client::setRequestCompression()</code>). Note that the
|
||||
ZLIB php extension needs to be enabled in PHP to support
|
||||
compression.</p></li><li><p>Implement HTTP 1.1 connections, but only if CURL is enabled
|
||||
(added an extra parameter to
|
||||
<code class="code">xmlrpc_client::xmlrpc_client</code> to set the desired HTTP
|
||||
protocol at creation time and a new supported value for the last
|
||||
parameter of <code class="code">xmlrpc_client::send</code>, which now can be
|
||||
safely omitted if it has been specified at creation time)</p><p>With PHP versions greater than 4.3.8 keep-alives are enabled
|
||||
by default for HTTP 1.1 connections. This should yield faster
|
||||
execution times when making multiple calls in sequence to the same
|
||||
xml-rpc server from a single client.</p></li><li><p>Introduce support for cookies. Cookies to be sent to the
|
||||
server with a request can be set using
|
||||
<code class="code">xmlrpc_client::setCookie()</code>, while cookies received from
|
||||
the server are found in <code class="code">xmlrpcresp::cookies()</code>. It is
|
||||
left to the user to check for validity of received cookies and
|
||||
decide whether they apply to successive calls or not.</p></li><li><p>Better support for detecting different character set encodings
|
||||
of xml-rpc requests and responses: both client and server objects
|
||||
will correctly detect the charset encoding of received xml, and use
|
||||
an appropriate xml parser.</p><p>Supported encodings are US-ASCII, UTF-8 and ISO-8859-1.</p></li><li><p>Added one new xmlrpcmsg constructor syntax, allowing usage of
|
||||
a single string with the complete URL of the target server</p></li><li><p>Convert xml-rpc boolean values into native php values instead
|
||||
of 0 and 1</p></li><li><p>Force the <code class="code">php_xmlrpc_encode</code> function to properly
|
||||
encode numerically indexed php arrays into xml-rpc arrays
|
||||
(numerically indexed php arrays always start with a key of 0 and
|
||||
increment keys by values of 1)</p></li><li><p>Prevent the <code class="code">php_xmlrpc_encode</code> function from
|
||||
further re-encoding any objects of class <code class="code">xmlrpcval</code> that
|
||||
are passed to it. This allows to call the function with arguments
|
||||
consisting of mixed php values / xmlrpcval objects.</p></li><li><p>Allow a server to NOT respond to system.* method calls
|
||||
(setting the <code class="code">$server->allow_system_funcs</code>
|
||||
property).</p></li><li><p>Implement a new xmlrpcval method to determine if a value of
|
||||
type struct has a member of a given name without having to loop
|
||||
trough all members: <code class="code">xmlrpcval::structMemExists()</code></p></li><li><p>Expand methods <code class="code">xmlrpcval::addArray</code>,
|
||||
<code class="code">addScalar</code> and <code class="code">addStruct</code> allowing extra php
|
||||
values to be added to xmlrpcval objects already formed.</p></li><li><p>Let the <code class="code">xmlrpc_client::send</code> method accept an XML
|
||||
string for sending instead of an xmlrpcmsg object, to facilitate
|
||||
debugging and integration with the php native xmlrpc
|
||||
extension</p></li><li><p>Extend the <code class="code">php_xmlrpc_encode</code> and
|
||||
<code class="code">php_xmlrpc_decode</code> functions to allow serialization and
|
||||
rebuilding of PHP objects. To successfully rebuild a serialized
|
||||
object, the object class must be defined in the deserializing end of
|
||||
the transfer. Note that object members of type resource will be
|
||||
deserialized as NULL values.</p><p>Note that his has been implemented adding a "php_class"
|
||||
attribute to xml representation of xmlrpcval of STRUCT type, which,
|
||||
strictly speaking, breaks the xml-rpc spec. Other xmlrpc
|
||||
implementations are supposed to ignore such an attribute (unless
|
||||
they implement a brain-dead custom xml parser...), so it should be
|
||||
safe enabling it in heterogeneous environments. The activation of
|
||||
this feature is done by usage of an option passed as second
|
||||
parameter to both <code class="code">php_xmlrpc_encode</code> and
|
||||
<code class="code">php_xmlrpc_decode</code>.</p></li><li><p>Extend the <code class="code">php_xmlrpc_encode</code> function to allow
|
||||
automatic serialization of iso8601-conforming php strings as
|
||||
datetime.iso8601 xmlrpcvals, by usage of an optional
|
||||
parameter</p></li><li><p>Added an automatic stub code generator for converting xmlrpc
|
||||
methods to php functions and vice-versa.</p><p>This is done via two new functions:
|
||||
<code class="code">wrap_php_function</code> and <code class="code">wrap_xmlrpc_method</code>,
|
||||
and has many caveats, with php being a typeless language and
|
||||
all...</p><p>With PHP versions lesser than 5.0.3 wrapping of php functions
|
||||
into xmlrpc methods is not supported yet.</p></li><li><p>Allow object methods to be used in server dispatch map</p></li><li><p>Added a complete debugger solution, in the
|
||||
<code class="filename">debugger</code> folder</p></li><li><p>Added configurable server-side debug messages, controlled by
|
||||
the new method <code class="code">xmlrpc_server::SetDebug()</code>. At level 0,
|
||||
no debug messages are sent to the client; level 1 is the same as the
|
||||
old behaviour; at level 2 a lot more info is echoed back to the
|
||||
client, regarding the received call; at level 3 all warnings raised
|
||||
during server processing are trapped (this prevents breaking the xml
|
||||
to be echoed back to the client) and added to the debug info sent
|
||||
back to the client</p></li><li><p>New XML parsing code, yields smaller memory footprint and
|
||||
faster execution times, not to mention complete elimination of the
|
||||
dreaded <code class="filename">eval()</code> construct, so prone to code
|
||||
injection exploits</p></li><li><p>Rewritten most of the error messages, making text more
|
||||
explicative</p></li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s07.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.0 Release candidate 2 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. System Requirements</td></tr></table></div></body></html>
|
||||
17
include/limesurvey/admin/classes/xmlrpc/doc/ch03.html
Normal file
17
include/limesurvey/admin/classes/xmlrpc/doc/ch03.html
Normal file
@@ -0,0 +1,17 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 3. System Requirements</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch02s08.html" title="2.0 Release candidate 1" /><link rel="next" href="ch04.html" title="Chapter 4. Files in the distribution" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. System Requirements</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s08.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch04.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="requirements"></a>Chapter 3. System Requirements</h2></div></div></div><p>The library has been designed with goals of scalability and backward
|
||||
compatibility. As such, it supports a wide range of PHP installs. Note
|
||||
that not all features of the lib are available in every
|
||||
configuration.</p><p>The <span class="emphasis"><em>minimum supported</em></span> PHP version is
|
||||
4.2.</p><p>A compatibility layer is provided that allows the code to run on PHP
|
||||
4.0.5 and 4.1. Note that if you are stuck on those platforms, we suggest
|
||||
you upgrade as soon as possible.</p><p>Automatic generation of xml-rpc methods from php functions is only
|
||||
supported with PHP version 5.0.3 and later (note that the lib will
|
||||
generate some warnings with PHP 5 in strict error reporting mode).</p><p>If you wish to use SSL or HTTP 1.1 to communicate with remote
|
||||
servers, you need the "curl" extension compiled into your PHP
|
||||
installation. This is available in PHP 4.0.2 and greater, although 4.0.6
|
||||
has a bug preventing SSL working, and versions prior to 4.3.8 do not
|
||||
support streamlining multiple requests using HTTP Keep-Alive.</p><p>The "xmlrpc" native extension is not required to be compiled into
|
||||
your PHP installation, but if it is, there will be no interference with
|
||||
the operation of this library.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s08.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.0 Release candidate 1 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 4. Files in the distribution</td></tr></table></div></body></html>
|
||||
35
include/limesurvey/admin/classes/xmlrpc/doc/ch04.html
Normal file
35
include/limesurvey/admin/classes/xmlrpc/doc/ch04.html
Normal file
@@ -0,0 +1,35 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 4. Files in the distribution</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch03.html" title="Chapter 3. System Requirements" /><link rel="next" href="ch05.html" title="Chapter 5. Known bugs and limitations" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Files in the distribution</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch03.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch05.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="manifest"></a>Chapter 4. Files in the distribution</h2></div></div></div><div class="glosslist"><dl><dt>lib/xmlrpc.inc</dt><dd><p>the XML-RPC classes. <code class="function">include()</code> this in
|
||||
your PHP files to use the classes.</p></dd><dt>lib/xmlrpcs.inc</dt><dd><p>the XML-RPC server class. <code class="function">include()</code> this
|
||||
in addition to xmlrpc.inc to get server functionality</p></dd><dt>lib/xmlrpc_wrappers.inc</dt><dd><p>helper functions to "automagically" convert plain php
|
||||
functions to xmlrpc services and vice versa</p></dd><dt>lib/compat/array_key_exists.php, lib/compat/is_a.php,
|
||||
lib/compat/is_scalar.php, lib/compat/var_export.php,
|
||||
lib/compat/vesrions_compare.php</dt><dd><p>compatibility functions: these files implement the
|
||||
compatibility layer needed to run the library with PHP versions 4.0
|
||||
and 4.1</p></dd><dt>demo/server/proxy.php</dt><dd><p>a sample server implementing xmlrpc proxy
|
||||
functionality.</p></dd><dt>demo/server/server.php</dt><dd><p>a sample server hosting various demo functions, as well as a
|
||||
full suite of functions used for interoperability testing. It is
|
||||
used by testsuite.php (see below) for unit testing the library, and
|
||||
is not to be copied literally into your production servers</p></dd><dt>demo/client/client.php, demo/client/agesort.php,
|
||||
demo/client/which.php</dt><dd><p>client code to exercise some of the functions in server.php,
|
||||
including the <code class="function">interopEchoTests.whichToolkit</code>
|
||||
method.</p></dd><dt>demo/client/wrap.php</dt><dd><p>client code to illustrate 'wrapping' of remote methods into
|
||||
php functions.</p></dd><dt>demo/client/introspect.php</dt><dd><p>client code to illustrate usage of introspection capabilities
|
||||
offered by server.php.</p></dd><dt>demo/client/mail.php</dt><dd><p>client code to illustrate usage of an xmlrpc-to-email gateway
|
||||
using Dave Winer's XML-RPC server at userland.com.</p></dd><dt>demo/client/zopetest.php</dt><dd><p>example client code that queries an xmlrpc server built in
|
||||
Zope.</p></dd><dt>demo/vardemo.php</dt><dd><p>examples of how to construct xmlrpcval types</p></dd><dt>demo/demo1.txt, demo/demo2.txt, demo/demo3.txt</dt><dd><p>XML-RPC responses captured in a file for testing purposes (you
|
||||
can use these to test the
|
||||
<code class="function">xmlrpcmsg->parseResponse()</code> method).</p></dd><dt>demo/server/discuss.php,
|
||||
demo/client/comment.php</dt><dd><p>Software used in the PHP chapter of <a class="xref" href="ch06s02.html" title="The Jellyfish Book">The Jellyfish Book</a> to provide a comment server and allow the
|
||||
attachment of comments to stories from Meerkat's data store.</p></dd><dt>test/testsuite.php, test/parse_args.php</dt><dd><p>A unit test suite for this software package. If you do
|
||||
development on this software, please consider submitting tests for
|
||||
this suite.</p></dd><dt>test/benchmark.php</dt><dd><p>A (very limited) benchmarking suite for this software package.
|
||||
If you do development on this software, please consider submitting
|
||||
benchmarks for this suite.</p></dd><dt>test/phpunit.php, test/PHPUnit/*.php</dt><dd><p>An (incomplete) version PEAR's unit test framework for PHP.
|
||||
The complete package can be found at <a class="ulink" href="http://pear.php.net/package/PHPUnit" target="_top">http://pear.php.net/package/PHPUnit</a></p></dd><dt>test/verify_compat.php</dt><dd><p>Script designed to help the user to verify the level of
|
||||
compatibility of the library with the current php install</p></dd><dt>extras/test.pl, extras/test.py</dt><dd><p>Perl and Python programs to exercise server.php to test that
|
||||
some of the methods work.</p></dd><dt>extras/workspace.testPhpServer.fttb</dt><dd><p>Frontier scripts to exercise the demo server. Thanks to Dave
|
||||
Winer for permission to include these. See <a class="ulink" href="http://www.xmlrpc.com/discuss/msgReader$853" target="_top">Dave's
|
||||
announcement of these.</a></p></dd><dt>extras/rsakey.pem</dt><dd><p>A test certificate key for the SSL support, which can be used
|
||||
to generate dummy certificates. It has the passphrase "test."</p></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. System Requirements </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 5. Known bugs and limitations</td></tr></table></div></body></html>
|
||||
28
include/limesurvey/admin/classes/xmlrpc/doc/ch05.html
Normal file
28
include/limesurvey/admin/classes/xmlrpc/doc/ch05.html
Normal file
@@ -0,0 +1,28 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 5. Known bugs and limitations</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch04.html" title="Chapter 4. Files in the distribution" /><link rel="next" href="ch06.html" title="Chapter 6. Support" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Known bugs and limitations</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch06.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="bugs"></a>Chapter 5. Known bugs and limitations</h2></div></div></div><p>This started out as a bare framework. Many "nice" bits haven't been
|
||||
put in yet. Specifically, very little type validation or coercion has been
|
||||
put in. PHP being a loosely-typed language, this is going to have to be
|
||||
done explicitly (in other words: you can call a lot of library functions
|
||||
passing them arguments of the wrong type and receive an error message only
|
||||
much further down the code, where it will be difficult to
|
||||
understand).</p><p>dateTime.iso8601 is supported opaquely. It can't be done natively as
|
||||
the XML-RPC specification explicitly forbids passing of timezone
|
||||
specifiers in ISO8601 format dates. You can, however, use the <a class="xref" href="ch09.html#iso8601encode" title="iso8601_encode">iso8601_encode()</a> and <a class="xref" href="ch09.html#iso8601decode" title="iso8601_decode">iso8601_decode()</a> functions
|
||||
to do the encoding and decoding for you.</p><p>Very little HTTP response checking is performed (e.g. HTTP redirects
|
||||
are not followed and the Content-Length HTTP header, mandated by the
|
||||
xml-rpc spec, is not validated); cookie support still involves quite a bit
|
||||
of coding on the part of the user.</p><p>If a specific character set encoding other than US-ASCII, ISO-8859-1
|
||||
or UTF-8 is received in the HTTP header or XML prologue of xml-rpc request
|
||||
or response messages then it will be ignored for the moment, and the
|
||||
content will be parsed as if it had been encoded using the charset defined
|
||||
by <a class="xref" href="ch08s02.html#xmlrpc-defencoding" title="xmlrpc_defencoding">xmlrpc_defencoding</a></p><p>Very large floating point numbers are serialized using exponential
|
||||
notation, even though the spec explicitly forbids this behaviour. This
|
||||
will not be a problem if this library is used on both ends of the
|
||||
communication, but might cause problems with other implementations.</p><p>Support for receiving from servers version 1 cookies (i.e.
|
||||
conforming to RFC 2965) is quite incomplete, and might cause unforeseen
|
||||
errors.</p><p>A PHP warning will be generated in many places when using
|
||||
<code class="filename">xmlrpc.inc</code> and <code class="filename">xmlrpcs.inc</code> with
|
||||
PHP 5 in strict error reporting mode. The simplest workaround to this
|
||||
problem is to lower the <em class="parameter"><code>error_reporting</code></em> level in
|
||||
php.ini.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 4. Files in the distribution </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 6. Support</td></tr></table></div></body></html>
|
||||
15
include/limesurvey/admin/classes/xmlrpc/doc/ch06.html
Normal file
15
include/limesurvey/admin/classes/xmlrpc/doc/ch06.html
Normal file
@@ -0,0 +1,15 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 6. Support</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch05.html" title="Chapter 5. Known bugs and limitations" /><link rel="next" href="ch06s02.html" title="The Jellyfish Book" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. Support</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch05.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch06s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="support"></a>Chapter 6. Support</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch06.html#id532511">Online Support</a></span></dt><dt><span class="sect1"><a href="ch06s02.html">The Jellyfish Book</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id532511"></a>Online Support</h2></div></div></div><p>XML-RPC for PHP is offered "as-is" without any warranty or
|
||||
commitment to support. However, informal advice and help is available
|
||||
via the XML-RPC for PHP website and mailing list and from
|
||||
XML-RPC.com.</p><div class="itemizedlist"><ul type="disc"><li><p>The <span class="emphasis"><em>XML-RPC for PHP</em></span> development is hosted
|
||||
on <a class="ulink" href="http://phpxmlrpc.sourceforge.net" target="_top">phpxmlrpc.sourceforge.net</a>.
|
||||
Bugs, feature requests and patches can be posted to the <a class="ulink" href="http://sourceforge.net/projects/phpxmlrpc" target="_top">project's
|
||||
website</a>.</p></li><li><p>The <span class="emphasis"><em>PHP XML-RPC interest mailing list</em></span> is
|
||||
run by the author. More details <a class="ulink" href="http://lists.gnomehack.com/mailman/listinfo/phpxmlrpc" target="_top">can be
|
||||
found here</a>.</p></li><li><p>For more general XML-RPC questions, there is a Yahoo! Groups
|
||||
<a class="ulink" href="http://groups.yahoo.com/group/xml-rpc/" target="_top">XML-RPC mailing
|
||||
list</a>.</p></li><li><p>The <a class="ulink" href="http://www.xmlrpc.com/discuss" target="_top">XML-RPC.com</a> discussion
|
||||
group is a useful place to get help with using XML-RPC. This group
|
||||
is also gatewayed into the Yahoo! Groups mailing list.</p></li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch05.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch06s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Known bugs and limitations </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> The Jellyfish Book</td></tr></table></div></body></html>
|
||||
11
include/limesurvey/admin/classes/xmlrpc/doc/ch06s02.html
Normal file
11
include/limesurvey/admin/classes/xmlrpc/doc/ch06s02.html
Normal file
@@ -0,0 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Jellyfish Book</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch06.html" title="Chapter 6. Support" /><link rel="prev" href="ch06.html" title="Chapter 6. Support" /><link rel="next" href="ch07.html" title="Chapter 7. Class documentation" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The Jellyfish Book</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch06.html">Prev</a> </td><th width="60%" align="center">Chapter 6. Support</th><td width="20%" align="right"> <a accesskey="n" href="ch07.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="jellyfish"></a>The Jellyfish Book</h2></div></div></div><div align="right"><table border="0" summary="manufactured viewport for HTML img" cellspacing="0" cellpadding="0" width="145"><tr style="height: 190px"><td align="right"><img src="progxmlrpc.s.gif" align="right" width="145" /></td></tr></table></div><p>Together with Simon St.Laurent and Joe
|
||||
Johnston, Edd Dumbill wrote a book on XML-RPC for O'Reilly and
|
||||
Associates on XML-RPC. It features a rather fetching jellyfish on the
|
||||
cover.</p><p>Complete details of the book are <a class="ulink" href="http://www.oreilly.com/catalog/progxmlrpc/" target="_top">available from
|
||||
O'Reilly's web site.</a></p><p>Edd is responsible for the chapter on PHP, which includes a worked
|
||||
example of creating a forum server, and hooking it up the O'Reilly's
|
||||
<a class="ulink" href="http://meerkat.oreillynet.com/" target="_top">Meerkat</a> service in
|
||||
order to allow commenting on news stories from around the Web.</p><p>If you've benefited from the effort that has been put into writing
|
||||
this software, then please consider buying the book!</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch06.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch06.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 6. Support </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 7. Class documentation</td></tr></table></div></body></html>
|
||||
105
include/limesurvey/admin/classes/xmlrpc/doc/ch07.html
Normal file
105
include/limesurvey/admin/classes/xmlrpc/doc/ch07.html
Normal file
@@ -0,0 +1,105 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 7. Class documentation</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch06s02.html" title="The Jellyfish Book" /><link rel="next" href="ch07s02.html" title="xmlrpcmsg" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 7. Class documentation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch06s02.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch07s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="apidocs"></a>Chapter 7. Class documentation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch07.html#xmlrpcval">xmlrpcval</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07.html#id532737">Notes on types</a></span></dt><dt><span class="sect2"><a href="ch07.html#xmlrpcval-creation">Creation</a></span></dt><dt><span class="sect2"><a href="ch07.html#xmlrpcval-methods">Methods</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s02.html">xmlrpcmsg</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s02.html#id533915">Creation</a></span></dt><dt><span class="sect2"><a href="ch07s02.html#id534023">Methods</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s03.html">xmlrpc_client</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s03.html#id534351">Creation</a></span></dt><dt><span class="sect2"><a href="ch07s03.html#id534519">Methods</a></span></dt><dt><span class="sect2"><a href="ch07s03.html#id535945">Variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s04.html">xmlrpcresp</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s04.html#id536087">Creation</a></span></dt><dt><span class="sect2"><a href="ch07s04.html#id536184">Methods</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s05.html">xmlrpc_server</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s05.html#id536404">Method handler functions</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536497">The dispatch map</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#signatures">Method signatures</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536731">Delaying the server response</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536813">Modifying the server behaviour</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536919">Fault reporting</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id537184">'New style' servers</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="xmlrpcval"></a>xmlrpcval</h2></div></div></div><p>This is where a lot of the hard work gets done. This class enables
|
||||
the creation and encapsulation of values for XML-RPC.</p><p>Ensure you've read the XML-RPC spec at <a class="ulink" href="http://www.xmlrpc.com/stories/storyReader$7" target="_top">http://www.xmlrpc.com/stories/storyReader$7</a>
|
||||
before reading on as it will make things clearer.</p><p>The <code class="classname">xmlrpcval</code> class can store arbitrarily
|
||||
complicated values using the following types: <code class="literal">i4 int boolean
|
||||
string double dateTime.iso8601 base64 array struct</code>. You should
|
||||
refer to the <a class="ulink" href="http://www.xmlrpc.com/spec" target="_top">spec</a> for
|
||||
more information on what each of these types mean.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id532737"></a>Notes on types</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id532743"></a>int</h4></div></div></div><p>The type <code class="classname">i4</code> is accepted as a synonym
|
||||
for <code class="classname">int</code> when creating xmlrpcval objects. The
|
||||
xml parsing code will always convert <code class="classname">i4</code> to
|
||||
<code class="classname">int</code>: <code class="classname">int</code> is regarded
|
||||
by this implementation as the canonical name for this type.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id532778"></a>base64</h4></div></div></div><p>Base 64 encoding is performed transparently to the caller when
|
||||
using this type. Decoding is also transparent. Therefore you ought
|
||||
to consider it as a "binary" data type, for use when you want to
|
||||
pass data that is not 7-bit clean.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id532794"></a>boolean</h4></div></div></div><p>The php values <code class="literal">true</code> and
|
||||
<code class="literal">1</code> map to <code class="literal">true</code>. All other
|
||||
values (including the empty string) are converted to
|
||||
<code class="literal">false</code>.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id532823"></a>string</h4></div></div></div><p>Characters <, >, ', ", &, are encoded using their
|
||||
entity reference as &lt; &gt; &apos; &quot; and
|
||||
&amp; All other characters outside of the ASCII range are
|
||||
encoded using their character reference representation (e.g.
|
||||
&#200 for é). The XML-RPC spec recommends only encoding
|
||||
<code class="literal">< &</code> but this implementation goes further,
|
||||
for reasons explained by <a class="ulink" href="http://www.w3.org/TR/REC-xml#syntax" target="_top">the XML 1.0
|
||||
recommendation</a>. In particular, using character reference
|
||||
representation has the advantage of producing XML that is valid
|
||||
independently of the charset encoding assumed.</p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="xmlrpcval-creation"></a>Creation</h3></div></div></div><p>The constructor is the normal way to create an
|
||||
<code class="classname">xmlrpcval</code>. The constructor can take these
|
||||
forms:</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcvalnew
|
||||
<b class="fsfunc">xmlrpcval</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcvalnew
|
||||
<b class="fsfunc">xmlrpcval</b>(</code></td><td>string<var class="pdparam">$stringVal</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcvalnew
|
||||
<b class="fsfunc">xmlrpcval</b>(</code></td><td>mixed<var class="pdparam">$scalarVal</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$scalartyp</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcvalnew
|
||||
<b class="fsfunc">xmlrpcval</b>(</code></td><td>array<var class="pdparam">$arrayVal</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$arraytyp</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>The first constructor creates an empty value, which must be
|
||||
altered using the methods <code class="function">addScalar</code>,
|
||||
<code class="function">addArray</code> or <code class="function">addStruct</code> before
|
||||
it can be used.</p><p>The second constructor creates a simple string value.</p><p>The third constructor is used to create a scalar value. The
|
||||
second parameter must be a name of an XML-RPC type. Valid types are:
|
||||
"<code class="literal">int</code>", "<code class="literal">boolean</code>",
|
||||
"<code class="literal">string</code>", "<code class="literal">double</code>",
|
||||
"<code class="literal">dateTime.iso8601</code>",
|
||||
"<code class="literal">base64</code>".</p><p>Examples:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$myInt </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcvalue</span><span style="color: #007700">(</span><span style="color: #0000BB">1267</span><span style="color: #007700">, </span><span style="color: #DD0000">"int"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$myString </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcvalue</span><span style="color: #007700">(</span><span style="color: #DD0000">"Hello, World!"</span><span style="color: #007700">, </span><span style="color: #DD0000">"string"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$myBool </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcvalue</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"boolean"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$myString2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcvalue</span><span style="color: #007700">(</span><span style="color: #0000BB">1.24</span><span style="color: #007700">, </span><span style="color: #DD0000">"string"</span><span style="color: #007700">); </span><span style="color: #FF8000">// note: this will serialize a php float value as xmlrpc string</span>
|
||||
</span>
|
||||
</code></pre><p>The fourth constructor form can be used to compose complex
|
||||
XML-RPC values. The first argument is either a simple array in the
|
||||
case of an XML-RPC <code class="classname">array</code> or an associative
|
||||
array in the case of a <code class="classname">struct</code>. The elements of
|
||||
the array <span class="emphasis"><em>must be <code class="classname">xmlrpcval</code> objects
|
||||
themselves</em></span>.</p><p>The second parameter must be either "<code class="literal">array</code>"
|
||||
or "<code class="literal">struct</code>".</p><p>Examples:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$myArray </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(<br /> array(<br /> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"Tom"</span><span style="color: #007700">),<br /> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"Dick"</span><span style="color: #007700">),<br /> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"Harry"</span><span style="color: #007700">)<br /> ),<br /> </span><span style="color: #DD0000">"array"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// recursive struct<br /></span><span style="color: #0000BB">$myStruct </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(<br /> array(<br /> </span><span style="color: #DD0000">"name" </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"Tom"</span><span style="color: #007700">, </span><span style="color: #DD0000">"string"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"age" </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #0000BB">34</span><span style="color: #007700">, </span><span style="color: #DD0000">"int"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"address" </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(<br /> array(<br /> </span><span style="color: #DD0000">"street" </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"Fifht Ave"</span><span style="color: #007700">, </span><span style="color: #DD0000">"string"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"city" </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"NY"</span><span style="color: #007700">, </span><span style="color: #DD0000">"string"</span><span style="color: #007700">)<br /> ), <br /> </span><span style="color: #DD0000">"struct"</span><span style="color: #007700">)<br /> ), <br /> </span><span style="color: #DD0000">"struct"</span><span style="color: #007700">);</span>
|
||||
</span>
|
||||
</code></pre><p>See the file <code class="literal">vardemo.php</code> in this distribution
|
||||
for more examples.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="xmlrpcval-methods"></a>Methods</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533138"></a>addScalar</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">addScalar</b>(</code></td><td>string<var class="pdparam">$stringVal</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">addScalar</b>(</code></td><td>mixed<var class="pdparam">$scalarVal</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$scalartyp</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>If <em class="parameter"><code>$val</code></em> is an empty
|
||||
<code class="classname">xmlrpcval</code> this method makes it a scalar
|
||||
value, and sets that value.</p><p>If <em class="parameter"><code>$val</code></em> is already a scalar value, then
|
||||
no more scalars can be added and <code class="literal">0</code> is
|
||||
returned.</p><p>If <em class="parameter"><code>$val</code></em> is an xmlrpcval of type array,
|
||||
the php value <em class="parameter"><code>$scalarval</code></em> is added as its last
|
||||
element.</p><p>If all went OK, <code class="literal">1</code> is returned, otherwise
|
||||
<code class="literal">0</code>.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533247"></a>addArray</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">addArray</b>(</code></td><td>array<var class="pdparam">$arrayVal</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>The argument is a simple (numerically indexed) array. The
|
||||
elements of the array <span class="emphasis"><em>must be
|
||||
<code class="classname">xmlrpcval</code> objects
|
||||
themselves</em></span>.</p><p>Turns an empty <code class="classname">xmlrpcval</code> into an
|
||||
<code class="classname">array</code> with contents as specified by
|
||||
<em class="parameter"><code>$arrayVal</code></em>.</p><p>If <em class="parameter"><code>$val</code></em> is an xmlrpcval of type array,
|
||||
the elements of <em class="parameter"><code>$arrayVal</code></em> are appended to the
|
||||
existing ones.</p><p>See the fourth constructor form for more information.</p><p>If all went OK, <code class="literal">1</code> is returned, otherwise
|
||||
<code class="literal">0</code>.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533339"></a>addStruct</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">addStruct</b>(</code></td><td>array<var class="pdparam">$assocArrayVal</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>The argument is an associative array. The elements of the
|
||||
array <span class="emphasis"><em>must be <code class="classname">xmlrpcval</code> objects
|
||||
themselves</em></span>.</p><p>Turns an empty <code class="classname">xmlrpcval</code> into a
|
||||
<code class="classname">struct</code> with contents as specified by
|
||||
<em class="parameter"><code>$assocArrayVal</code></em>.</p><p>If <em class="parameter"><code>$val</code></em> is an xmlrpcval of type struct,
|
||||
the elements of <em class="parameter"><code>$arrayVal</code></em> are merged with the
|
||||
existing ones.</p><p>See the fourth constructor form for more information.</p><p>If all went OK, <code class="literal">1</code> is returned, otherwise
|
||||
<code class="literal">0</code>.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533431"></a>kindOf</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">kindOf</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns a string containing "struct", "array" or "scalar"
|
||||
describing the base type of the value. If it returns "undef" it
|
||||
means that the value hasn't been initialised.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533463"></a>serialize</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">serialize</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns a string containing the XML-RPC representation of this
|
||||
value.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533493"></a>scalarVal</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">mixed<b class="fsfunc">scalarVal</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>If <code class="function">$val->kindOf() == "scalar"</code>, this
|
||||
method returns the actual PHP-language value of the scalar (base 64
|
||||
decoding is automatically handled here).</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533529"></a>scalarTyp</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">scalarTyp</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>If <code class="function">$val->kindOf() == "scalar"</code>, this
|
||||
method returns a string denoting the type of the scalar. As
|
||||
mentioned before, <code class="literal">i4</code> is always coerced to
|
||||
<code class="literal">int</code>.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533573"></a>arrayMem</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval<b class="fsfunc">arrayMem</b>(</code></td><td>int<var class="pdparam">$n</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>If <code class="function">$val->kindOf() == "array"</code>, returns
|
||||
the <em class="parameter"><code>$n</code></em>th element in the array represented by
|
||||
the value <em class="parameter"><code>$val</code></em>. The value returned is an
|
||||
<code class="classname">xmlrpcval</code> object.</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"></span><span style="color: #FF8000">// iterating over values of an array object<br /></span><span style="color: #007700">for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">arraySize</span><span style="color: #007700">(); </span><span style="color: #0000BB">$i</span><span style="color: #007700">++)<br />{<br /> </span><span style="color: #0000BB">$v </span><span style="color: #007700">= </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">arrayMem</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Element $i of the array is of type "</span><span style="color: #007700">.</span><span style="color: #0000BB">$v</span><span style="color: #007700">-></span><span style="color: #0000BB">kindOf</span><span style="color: #007700">();<br />}</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533639"></a>arraySize</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">arraySize</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>If <em class="parameter"><code>$val</code></em> is an
|
||||
<code class="classname">array</code>, returns the number of elements in that
|
||||
array.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533677"></a>structMem</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval<b class="fsfunc">structMem</b>(</code></td><td>string<var class="pdparam">$memberName</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>If <code class="function">$val->kindOf() == "struct"</code>, returns
|
||||
the element called <em class="parameter"><code>$memberName</code></em> from the
|
||||
struct represented by the value <em class="parameter"><code>$val</code></em>. The
|
||||
value returned is an <code class="classname">xmlrpcval</code> object.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id533731"></a>structEach</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">array<b class="fsfunc">structEach</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns the next (key, value) pair from the struct, when
|
||||
<em class="parameter"><code>$val</code></em> is a struct.
|
||||
<em class="parameter"><code>$value</code></em> is an xmlrpcval itself. See also <a class="xref" href="ch07.html#structreset" title="structReset">structreset()</a>.</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"></span><span style="color: #FF8000">// iterating over all values of a struct object<br /></span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">structreset</span><span style="color: #007700">();<br />while (list(</span><span style="color: #0000BB">$key</span><span style="color: #007700">, </span><span style="color: #0000BB">$v</span><span style="color: #007700">) = </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">structEach</span><span style="color: #007700">())<br />{<br /> echo </span><span style="color: #DD0000">"Element $key of the struct is of type "</span><span style="color: #007700">.</span><span style="color: #0000BB">$v</span><span style="color: #007700">-></span><span style="color: #0000BB">kindOf</span><span style="color: #007700">();<br />}</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="structreset"></a>structReset</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">structReset</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Resets the internal pointer for
|
||||
<code class="function">structEach()</code> to the beginning of the struct,
|
||||
where <em class="parameter"><code>$val</code></em> is a struct.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="structmemexists"></a>structMemExists</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">bool<b class="fsfunc">structMemExsists</b>(</code></td><td>string<var class="pdparam">$memberName</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns <code class="constant">TRUE</code> or
|
||||
<code class="constant">FALSE</code> depending on whether a member of the
|
||||
given name exists in the struct.</p></div></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch06s02.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch07s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The Jellyfish Book </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> xmlrpcmsg</td></tr></table></div></body></html>
|
||||
35
include/limesurvey/admin/classes/xmlrpc/doc/ch07s02.html
Normal file
35
include/limesurvey/admin/classes/xmlrpc/doc/ch07s02.html
Normal file
@@ -0,0 +1,35 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>xmlrpcmsg</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch07.html" title="Chapter 7. Class documentation" /><link rel="prev" href="ch07.html" title="Chapter 7. Class documentation" /><link rel="next" href="ch07s03.html" title="xmlrpc_client" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">xmlrpcmsg</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07.html">Prev</a> </td><th width="60%" align="center">Chapter 7. Class documentation</th><td width="20%" align="right"> <a accesskey="n" href="ch07s03.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="xmlrpcmsg"></a>xmlrpcmsg</h2></div></div></div><p>This class provides a representation for a request to an XML-RPC
|
||||
server. A client sends an <code class="classname">xmlrpcmsg</code> to a server,
|
||||
and receives back an <code class="classname">xmlrpcresp</code> (see <a class="xref" href="ch07s03.html#xmlrpc-client-send" title="send">xmlrpc_client->send</a>).</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id533915"></a>Creation</h3></div></div></div><p>The constructor takes the following forms:</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcmsgnew
|
||||
<b class="fsfunc">xmlrpcmsg</b>(</code></td><td>string<var class="pdparam">$methodName</var>, </td></tr><tr><td> </td><td>array<var class="pdparam">$parameterArray</var>null<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Where <em class="parameter"><code>methodName</code></em> is a string indicating
|
||||
the name of the method you wish to invoke, and
|
||||
<em class="parameter"><code>parameterArray</code></em> is a simple php
|
||||
<code class="classname">Array</code> of <code class="classname">xmlrpcval</code>
|
||||
objects. Here's an example message to the <span class="emphasis"><em>US state
|
||||
name</em></span> server:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$msg </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcmsg</span><span style="color: #007700">(</span><span style="color: #DD0000">"examples.getStateName"</span><span style="color: #007700">, array(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #0000BB">23</span><span style="color: #007700">, </span><span style="color: #DD0000">"int"</span><span style="color: #007700">)));</span>
|
||||
</span>
|
||||
</code></pre><p>This example requests the name of state number 23. For more
|
||||
information on <code class="classname">xmlrpcval</code> objects, see <a class="xref" href="ch07.html#xmlrpcval" title="xmlrpcval">xmlrpcval</a>.</p><p>Note that the <em class="parameter"><code>parameterArray</code></em> parameter is
|
||||
optional and can be omitted for methods that take no input parameters
|
||||
or if you plan to add parameters one by one.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id534023"></a>Methods</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534030"></a>addParam</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">bool<b class="fsfunc">addParam</b>(</code></td><td>xmlrpcval<var class="pdparam">$xmlrpcVal</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Adds the <code class="classname">xmlrpcval</code>
|
||||
<em class="parameter"><code>xmlrpcVal</code></em> to the parameter list for this
|
||||
method call. Returns TRUE or FALSE on error.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534074"></a>getNumParams</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">getNumParams</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns the number of parameters attached to this
|
||||
message.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534102"></a>getParam</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval<b class="fsfunc">getParam</b>(</code></td><td>int<var class="pdparam">$n</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Gets the <em class="parameter"><code>n</code></em>th parameter in the message
|
||||
(with the index zero-based). Use this method in server
|
||||
implementations to retrieve the values sent by the client.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534143"></a>method</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">method</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">method</b>(</code></td><td>string<var class="pdparam">$methName</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Gets or sets the method contained in the XML-RPC
|
||||
message.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534191"></a>parseResponse</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcresp<b class="fsfunc">parseResponse</b>(</code></td><td>string<var class="pdparam">$xmlString</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Given an incoming XML-RPC server response contained in the
|
||||
string <em class="parameter"><code>$xmlString</code></em>, this method constructs an
|
||||
<code class="classname">xmlrpcresp</code> response object and returns it,
|
||||
setting error codes as appropriate (see <a class="xref" href="ch07s03.html#xmlrpc-client-send" title="send">xmlrpc_client->send</a>).</p><p>This method processes any HTTP/MIME headers it finds.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534247"></a>parseResponseFile</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcresp<b class="fsfunc">parseResponseFile</b>(</code></td><td>file handle
|
||||
resource<var class="pdparam">$fileHandle</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Given an incoming XML-RPC server response on the open file
|
||||
handle <em class="parameter"><code>fileHandle</code></em>, this method reads all the
|
||||
data it finds and passes it to
|
||||
<code class="function">parseResponse.</code></p><p>This method is useful to construct responses from pre-prepared
|
||||
files (see files <code class="literal">demo1.txt, demo2.txt, demo3.txt</code>
|
||||
in this distribution). It processes any HTTP headers it finds, and
|
||||
does not close the file handle.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534303"></a>serialize</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string
|
||||
<b class="fsfunc">serialize</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns the an XML string representing the XML-RPC
|
||||
message.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch07.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch07s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 7. Class documentation </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> xmlrpc_client</td></tr></table></div></body></html>
|
||||
189
include/limesurvey/admin/classes/xmlrpc/doc/ch07s03.html
Normal file
189
include/limesurvey/admin/classes/xmlrpc/doc/ch07s03.html
Normal file
@@ -0,0 +1,189 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>xmlrpc_client</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch07.html" title="Chapter 7. Class documentation" /><link rel="prev" href="ch07s02.html" title="xmlrpcmsg" /><link rel="next" href="ch07s04.html" title="xmlrpcresp" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">xmlrpc_client</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07s02.html">Prev</a> </td><th width="60%" align="center">Chapter 7. Class documentation</th><td width="20%" align="right"> <a accesskey="n" href="ch07s04.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="xmlrpc-client"></a>xmlrpc_client</h2></div></div></div><p>This is the basic class used to represent a client of an XML-RPC
|
||||
server.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id534351"></a>Creation</h3></div></div></div><p>The constructor accepts one of two possible syntaxes:</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpc_clientnew
|
||||
<b class="fsfunc">xmlrpc_client</b>(</code></td><td>string<var class="pdparam">$server_url</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpc_clientnew
|
||||
<b class="fsfunc">xmlrpc_client</b>(</code></td><td>string<var class="pdparam">$server_path</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$server_hostname</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$server_port</var>80, </td></tr><tr><td> </td><td>string<var class="pdparam">$transport</var>'http'<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Here are a couple of usage examples of the first form:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://phpxmlrpc.sourceforge.net/server.php"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$another_client </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">"https://james:bond@secret.service.com:4443/xmlrpcserver?agent=007"</span><span style="color: #007700">);</span>
|
||||
</span>
|
||||
</code></pre><p>The second syntax does not allow to express a username and
|
||||
password to be used for basic HTTP authorization as in the second
|
||||
example above, but instead it allows to choose whether xmlrpc calls
|
||||
will be made using the HTTP 1.0 or 1.1 protocol.</p><p>Here's another example client set up to query Userland's XML-RPC
|
||||
server at <span class="emphasis"><em>betty.userland.com</em></span>:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">"/RPC2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"betty.userland.com"</span><span style="color: #007700">, </span><span style="color: #0000BB">80</span><span style="color: #007700">);</span>
|
||||
</span>
|
||||
</code></pre><p>The <em class="parameter"><code>server_port</code></em> parameter is optional,
|
||||
and if omitted will default to 80 when using HTTP and 443 when using
|
||||
HTTPS (see the <a class="xref" href="ch07s03.html#xmlrpc-client-send" title="send">xmlrpc_client->send</a> method
|
||||
below).</p><p>The <em class="parameter"><code>transport</code></em> parameter is optional, and
|
||||
if omitted will default to 'http'. Allowed values are either
|
||||
'<span class="symbol">http'</span>, '<span class="symbol">https</span>' or
|
||||
'<span class="symbol">http11'</span>. Its value can be overridden with every call
|
||||
to the <code class="methodname">send</code> method. See the
|
||||
<code class="methodname">send</code> method below for more details about the
|
||||
meaning of the different values.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id534519"></a>Methods</h3></div></div></div><p>This class supports the following methods.</p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="xmlrpc-client-send"></a>send</h4></div></div></div><p>This method takes the forms:</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcresp<b class="fsfunc">send</b>(</code></td><td>xmlrpcmsg<var class="pdparam">$xmlrpc_message</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$timeout</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$transport</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">array<b class="fsfunc">send</b>(</code></td><td>array<var class="pdparam">$xmlrpc_messages</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$timeout</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$transport</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcresp<b class="fsfunc">send</b>(</code></td><td>string<var class="pdparam">$xml_payload</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$timeout</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$transport</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Where <em class="parameter"><code>xmlrpc_message</code></em> is an instance of
|
||||
<code class="classname">xmlrpcmsg</code> (see <a class="xref" href="ch07s02.html" title="xmlrpcmsg">xmlrpcmsg</a>),
|
||||
and <em class="parameter"><code>response</code></em> is an instance of
|
||||
<code class="classname">xmlrpcresp</code> (see <a class="xref" href="ch07s04.html" title="xmlrpcresp">xmlrpcresp</a>).</p><p><em class="parameter"><code>If xmlrpc_messages</code></em> is an array of
|
||||
message instances, <code class="code">responses</code> will be an array of
|
||||
response instances. The client will try to make use of a single
|
||||
<code class="code">system.multicall</code> xml-rpc method call to forward to the
|
||||
server all the messages in a single HTTP round trip, unless
|
||||
<code class="code">$client->no_multicall</code> has been previously set to
|
||||
<code class="code">TRUE</code> (see the multicall method below), in which case
|
||||
many consecutive xmlrpc requests will be sent.</p><p>The third syntax allows to build by hand (or any other means)
|
||||
a complete xmlrpc request message, and send it to the server.
|
||||
<em class="parameter"><code>xml_payload</code></em> should be a string containing the
|
||||
complete xml representation of the request. It is e.g. useful when,
|
||||
for maximal speed of execution, the request is serialized into a
|
||||
string using the native php xmlrpc functions (see <a class="ulink" href="http://www.php.net/xmlrpc" target="_top">the php manual on
|
||||
xmlrpc</a>).</p><p>The <em class="parameter"><code>timeout</code></em> is optional, and will be
|
||||
set to <code class="literal">0</code> (wait for platform-specific predefined
|
||||
timeout) if omitted. This timeout value is passed to
|
||||
<code class="function">fsockopen()</code>. It is also used for detecting
|
||||
server timeouts during communication (i.e. if the server does not
|
||||
send anything to the client for <em class="parameter"><code>timeout</code></em>
|
||||
seconds, the connection will be closed).</p><p>The <em class="parameter"><code>transport</code></em> parameter is optional,
|
||||
and if omitted will default to the transport set using instance
|
||||
creator or 'http' if omitted. The only other valid values are
|
||||
'https', which will use an SSL HTTP connection to connect to the
|
||||
remote server, and 'http11'. Note that your PHP must have the "curl"
|
||||
extension compiled in order to use both these features. Note that
|
||||
when using SSL you should normally set your port number to 443,
|
||||
unless the SSL server you are contacting runs at any other
|
||||
port.</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>PHP 4.0.6 has a bug which prevents SSL working.</p></div><p>In addition to low-level errors, the XML-RPC server you were
|
||||
querying may return an error in the
|
||||
<code class="classname">xmlrpcresp</code> object. See <a class="xref" href="ch07s04.html" title="xmlrpcresp">xmlrpcresp</a> for details of how to handle these
|
||||
errors.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="multicall"></a>multiCall</h4></div></div></div><p>This method takes the form:</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">array<b class="fsfunc">multiCall</b>(</code></td><td>array<var class="pdparam">$messages</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$timeout</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$transport</var>, </td></tr><tr><td> </td><td>bool<var class="pdparam">$fallback</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method is used to boxcar many method calls in a single
|
||||
xml-rpc request. It will try first to make use of the
|
||||
<code class="code">system.multicall</code> xml-rpc method call, and fall back to
|
||||
executing many separate requests if the server returns any
|
||||
error.</p><p><em class="parameter"><code>msgs</code></em> is an array of
|
||||
<code class="classname">xmlrpcmsg</code> objects (see <a class="xref" href="ch07s02.html" title="xmlrpcmsg">xmlrpcmsg</a>), and <em class="parameter"><code>response</code></em> is an
|
||||
array of <code class="classname">xmlrpcresp</code> objects (see <a class="xref" href="ch07s04.html" title="xmlrpcresp">xmlrpcresp</a>).</p><p>The <em class="parameter"><code>timeout</code></em> and
|
||||
<em class="parameter"><code>transport</code></em> parameters are optional, and behave
|
||||
as in the <code class="methodname">send</code> method above.</p><p>The <em class="parameter"><code>fallback</code></em> parameter is optional, and
|
||||
defaults to <code class="constant">TRUE</code>. When set to
|
||||
<code class="constant">FALSE</code> it will prevent the client to try using
|
||||
many single method calls in case of failure of the first multicall
|
||||
request. It should be set only when the server is known to support
|
||||
the multicall extension.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id534946"></a>setAcceptedCompression</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setAcceptedCompression</b>(</code></td><td>string<var class="pdparam">$compressionmethod</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method defines whether the client will accept compressed
|
||||
xml payload forming the bodies of the xmlrpc responses received from
|
||||
servers. Note that enabling reception of compressed responses merely
|
||||
adds some standard http headers to xmlrpc requests. It is up to the
|
||||
xmlrpc server to return compressed responses when receiving such
|
||||
requests. Allowed values for
|
||||
<em class="parameter"><code>compressionmethod</code></em> are: 'gzip', 'deflate',
|
||||
'any' or null (with any meaning either gzip or deflate).</p><p>This requires the "zlib" extension to be enabled in your php
|
||||
install. If it is, by default <code class="classname">xmlrpc_client</code>
|
||||
instances will enable reception of compressed content.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535008"></a>setCaCertificate</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setCaCertificate</b>(</code></td><td>string<var class="pdparam">$certificate</var>, </td></tr><tr><td> </td><td>bool<var class="pdparam">$is_dir</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method sets an optional certificate to be used in
|
||||
SSL-enabled communication to validate a remote server with (when the
|
||||
<em class="parameter"><code>server_method</code></em> is set to 'https' in the
|
||||
client's construction or in the send method and
|
||||
<code class="methodname">SetSSLVerifypeer</code> has been set to
|
||||
<code class="constant">TRUE</code>).</p><p>The <em class="parameter"><code>certificate</code></em> parameter must be the
|
||||
filename of a PEM formatted certificate, or a directory containing
|
||||
multiple certificate files. The <em class="parameter"><code>is_dir</code></em>
|
||||
parameter defaults to <code class="constant">FALSE</code>, set it to
|
||||
<code class="constant">TRUE</code> to specify that
|
||||
<em class="parameter"><code>certificate</code></em> indicates a directory instead of
|
||||
a single file.</p><p>This requires the "curl" extension to be compiled into your
|
||||
installation of PHP. For more details see the man page for the
|
||||
<code class="function">curl_setopt</code> function.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535107"></a>setCertificate</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setCertificate</b>(</code></td><td>string<var class="pdparam">$certificate</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$passphrase</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method sets the optional certificate and passphrase used
|
||||
in SSL-enabled communication with a remote server (when the
|
||||
<em class="parameter"><code>server_method</code></em> is set to 'https' in the
|
||||
client's construction or in the send method).</p><p>The <em class="parameter"><code>certificate</code></em> parameter must be the
|
||||
filename of a PEM formatted certificate. The
|
||||
<em class="parameter"><code>passphrase</code></em> parameter must contain the
|
||||
password required to use the certificate.</p><p>This requires the "curl" extension to be compiled into your
|
||||
installation of PHP. For more details see the man page for the
|
||||
<code class="function">curl_setopt</code> function.</p><p>Note: to retrieve information about the client certificate on
|
||||
the server side, you will need to look into the environment
|
||||
variables which are set up by the webserver. Different webservers
|
||||
will typically set up different variables.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535191"></a>setCookie</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setCookie</b>(</code></td><td>string<var class="pdparam">$name</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$value</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$path</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$domain</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$port</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method sets a cookie that will be sent to the xmlrpc
|
||||
server along with every further request (useful e.g. for keeping
|
||||
session info outside of the xml-rpc payload).</p><p><em class="parameter"><code>$value</code></em> is optional, and defaults to
|
||||
null.</p><p><em class="parameter"><code>$path, $domain and $port</code></em> are optional,
|
||||
and will be omitted from the cookie header if unspecified. Note that
|
||||
setting any of these values will turn the cookie into a 'version 1'
|
||||
cookie, that might not be fully supported by the server (see RFC2965
|
||||
for more details).</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535278"></a>setCredentials</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setCredentials</b>(</code></td><td>string<var class="pdparam">$username</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$password</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$authtype</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method sets the username and password for authorizing the
|
||||
client to a server. With the default (HTTP) transport, this
|
||||
information is used for HTTP Basic authorization. Note that username
|
||||
and password can also be set using the class constructor. With HTTP
|
||||
1.1 and HTTPS transport, NTLM and Digest authentication protocols
|
||||
are also supported. To enable them use the constants
|
||||
<code class="constant">CURLAUTH_DIGEST</code> and
|
||||
<code class="constant">CURLAUTH_NTLM</code> as values for the authtype
|
||||
parameter.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535344"></a>setDebug</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setDebug</b>(</code></td><td>int<var class="pdparam">$debugLvl</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p><em class="parameter"><code>debugLvl</code></em> is either <code class="literal">0,
|
||||
1</code> or 2 depending on whether you require the client to
|
||||
print debugging information to the browser. The default is not to
|
||||
output this information (0).</p><p>The debugging information at level 1includes the raw data
|
||||
returned from the XML-RPC server it was querying (including bot HTTP
|
||||
headers and the full XML payload), and the PHP value the client
|
||||
attempts to create to represent the value returned by the server. At
|
||||
level2, the complete payload of the xmlrpc request is also printed,
|
||||
before being sent t the server.</p><p>This option can be very useful when debugging servers as it
|
||||
allows you to see exactly what the client sends and the server
|
||||
returns.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535398"></a>setKey</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setKey</b>(</code></td><td>int<var class="pdparam">$key</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$keypass</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method sets the optional certificate key and passphrase
|
||||
used in SSL-enabled communication with a remote server (when the
|
||||
<em class="parameter"><code>transport</code></em> is set to 'https' in the client's
|
||||
construction or in the send method).</p><p>This requires the "curl" extension to be compiled into your
|
||||
installation of PHP. For more details see the man page for the
|
||||
<code class="function">curl_setopt</code> function.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535458"></a>setProxy</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setProxy</b>(</code></td><td>string<var class="pdparam">$proxyhost</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$proxyport</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$proxyusername</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$proxypassword</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$authtype</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method enables calling servers via an HTTP proxy. The
|
||||
<em class="parameter"><code>proxyusername</code></em>,<em class="parameter"><code>
|
||||
proxypassword</code></em> and <em class="parameter"><code>authtype</code></em>
|
||||
parameters are optional. <em class="parameter"><code>Authtype</code></em> defaults to
|
||||
<code class="constant">CURLAUTH_BASIC</code> (Basic authentication protocol);
|
||||
the only other valid value is the constant
|
||||
<code class="constant">CURLAUTH_NTLM</code>, and has effect only when the
|
||||
client uses the HTTP 1.1 protocol.</p><p>NB: CURL versions before 7.11.10 cannot use a proxy to
|
||||
communicate with https servers.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id530136"></a>setRequestCompression</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setRequestCompression</b>(</code></td><td>string<var class="pdparam">$compressionmethod</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method defines whether the xml payload forming the
|
||||
request body will be sent to the server in compressed format, as per
|
||||
the HTTP specification. This is particularly useful for large
|
||||
request parameters and over slow network connections. Allowed values
|
||||
for <em class="parameter"><code>compressionmethod</code></em> are: 'gzip', 'deflate',
|
||||
'any' or null (with any meaning either gzip or deflate). Note that
|
||||
there is no automatic fallback mechanism in place for errors due to
|
||||
servers not supporting receiving compressed request bodies, so make
|
||||
sure that the particular server you are querying does accept
|
||||
compressed requests before turning it on.</p><p>This requires the "zlib" extension to be enabled in your php
|
||||
install.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535844"></a>setSSLVerifyHost</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setSSLVerifyHost</b>(</code></td><td>int<var class="pdparam">$i</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method defines whether connections made to XML-RPC
|
||||
backends via HTTPS should verify the remote host's SSL certificate's
|
||||
common name (CN). By default, only the existence of a CN is checked.
|
||||
<em class="parameter"><code><em class="parameter"><code>$i</code></em></code></em> should be an
|
||||
integer value; 0 to not check the CN at all, 1 to merely check for
|
||||
its existence, and 2 to check that the CN on the certificate matches
|
||||
the hostname that is being connected to.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535891"></a>setSSLVerifyPeer</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">setSSLVerifyPeer</b>(</code></td><td>bool<var class="pdparam">$i</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>This method defines whether connections made to XML-RPC
|
||||
backends via HTTPS should verify the remote host's SSL certificate,
|
||||
and cause the connection to fail if the cert verification fails.
|
||||
<em class="parameter"><code><em class="parameter"><code>$i</code></em></code></em> should be a boolean
|
||||
value. Default value: <code class="constant">TRUE</code>. To specify custom
|
||||
SSL certificates to validate the server with, use the
|
||||
<code class="methodname">setCaCertificate</code> method.</p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id535945"></a>Variables</h3></div></div></div><p>NB: direct manipulation of these variables is only recommended
|
||||
for advanced users.</p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535957"></a>no_multicall</h4></div></div></div><p>This member variable determines whether the multicall() method
|
||||
will try to take advantage of the system.multicall xmlrpc method to
|
||||
dispatch to the server an array of requests in a single http
|
||||
roundtrip or simply execute many consecutive http calls. Defaults to
|
||||
FALSE, but it will be enabled automatically on the first failure of
|
||||
execution of system.multicall.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id535975"></a>request_charset_encoding</h4></div></div></div><p>This is the charset encoding that will be used for serializing
|
||||
request sent by the client.</p><p>If defaults to NULL, which means using US-ASCII and encoding
|
||||
all characters outside of the ASCII range using their xml character
|
||||
entity representation (this has the benefit that line end characters
|
||||
will not be mangled in the transfer, a CR-LF will be preserved as
|
||||
well as a singe LF).</p><p>Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1'</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="return-type"></a>return_type</h4></div></div></div><p>This member variable determines whether the value returned
|
||||
inside an xmlrpcresp object as results of calls to the send() and
|
||||
multicall() methods will be an xmlrpcval object, a plain php value
|
||||
or a raw xml string. Allowed values are 'xmlrpcvals' (the default),
|
||||
'phpvals' and 'xml'. To allow the user to differentiate between a
|
||||
correct and a faulty response, fault responses will be returned as
|
||||
xmlrpcresp objects in any case. Note that the 'phpvals' setting will
|
||||
yield faster execution times, but some of the information from the
|
||||
original response will be lost. It will be e.g. impossible to tell
|
||||
whether a particular php string value was sent by the server as an
|
||||
xmlrpc string or base64 value.</p><p>Example usage:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">"phpxmlrpc.sourceforge.net/server"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">return_type </span><span style="color: #007700">= </span><span style="color: #DD0000">'phpvals'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$message </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcmsg</span><span style="color: #007700">(</span><span style="color: #DD0000">"examples.getStateName"</span><span style="color: #007700">, array(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #0000BB">23</span><span style="color: #007700">, </span><span style="color: #DD0000">"int"</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$resp </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(</span><span style="color: #0000BB">$message</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">()) echo </span><span style="color: #DD0000">'KO. Error: '</span><span style="color: #007700">.</span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">faultString</span><span style="color: #007700">(); else echo </span><span style="color: #DD0000">'OK: got '</span><span style="color: #007700">.</span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">();</span>
|
||||
</span>
|
||||
</code></pre><p>For more details about usage of the 'xml' value, see Appendix
|
||||
A.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch07.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch07s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">xmlrpcmsg </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> xmlrpcresp</td></tr></table></div></body></html>
|
||||
33
include/limesurvey/admin/classes/xmlrpc/doc/ch07s04.html
Normal file
33
include/limesurvey/admin/classes/xmlrpc/doc/ch07s04.html
Normal file
@@ -0,0 +1,33 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>xmlrpcresp</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch07.html" title="Chapter 7. Class documentation" /><link rel="prev" href="ch07s03.html" title="xmlrpc_client" /><link rel="next" href="ch07s05.html" title="xmlrpc_server" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">xmlrpcresp</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07s03.html">Prev</a> </td><th width="60%" align="center">Chapter 7. Class documentation</th><td width="20%" align="right"> <a accesskey="n" href="ch07s05.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="xmlrpcresp"></a>xmlrpcresp</h2></div></div></div><p>This class is used to contain responses to XML-RPC requests. A
|
||||
server method handler will construct an
|
||||
<code class="classname">xmlrpcresp</code> and pass it as a return value. This
|
||||
same value will be returned by the result of an invocation of the
|
||||
<code class="function">send</code> method of the
|
||||
<code class="classname">xmlrpc_client</code> class.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536087"></a>Creation</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcrespnew
|
||||
<b class="fsfunc">xmlrpcresp</b>(</code></td><td>xmlrpcval<var class="pdparam">$xmlrpcval</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcrespnew
|
||||
<b class="fsfunc">xmlrpcresp</b>(</code></td><td><var class="pdparam">0</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$errcode</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$err_string</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>The first syntax is used when execution has happened without
|
||||
difficulty: <em class="parameter"><code>$xmlrpcval</code></em> is an
|
||||
<code class="classname">xmlrpcval</code> value with the result of the method
|
||||
execution contained in it. Alternatively it can be a string containing
|
||||
the xml serialization of the single xml-rpc value result of method
|
||||
execution.</p><p>The second type of constructor is used in case of failure.
|
||||
<em class="parameter"><code>errcode</code></em> and <em class="parameter"><code>err_string</code></em>
|
||||
are used to provide indication of what has gone wrong. See <a class="xref" href="ch07s05.html" title="xmlrpc_server">xmlrpc_server</a> for more information on passing error
|
||||
codes.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536184"></a>Methods</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536190"></a>faultCode</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">faultCode</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns the integer fault code return from the XML-RPC
|
||||
response. A zero value indicates success, any other value indicates
|
||||
a failure response.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536221"></a>faultString</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">faultString</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns the human readable explanation of the fault indicated
|
||||
by <code class="function">$resp->faultCode</code>().</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536256"></a>value</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval<b class="fsfunc">value</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns an <code class="classname">xmlrpcval</code> object containing
|
||||
the return value sent by the server. If the response's
|
||||
<code class="function">faultCode</code> is non-zero then the value returned
|
||||
by this method should not be used (it may not even be an
|
||||
object).</p><p>Note: if the xmlrpcresp instance in question has been created
|
||||
by an <code class="classname">xmlrpc_client</code> object whose
|
||||
<code class="varname">return_type</code> was set to 'phpvals', then a plain
|
||||
php value will be returned instead of an
|
||||
<code class="classname">xmlrpcval</code> object. If the
|
||||
<code class="varname">return_type</code> was set to 'xml', an xml string will
|
||||
be returned (see the return_type member var above for more
|
||||
details).</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536324"></a>serialize</h4></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">serialize</b>(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns an XML string representation of the response (xml
|
||||
prologue not included).</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch07.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch07s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">xmlrpc_client </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> xmlrpc_server</td></tr></table></div></body></html>
|
||||
184
include/limesurvey/admin/classes/xmlrpc/doc/ch07s05.html
Normal file
184
include/limesurvey/admin/classes/xmlrpc/doc/ch07s05.html
Normal file
@@ -0,0 +1,184 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>xmlrpc_server</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch07.html" title="Chapter 7. Class documentation" /><link rel="prev" href="ch07s04.html" title="xmlrpcresp" /><link rel="next" href="ch08.html" title="Chapter 8. Global variables" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">xmlrpc_server</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07s04.html">Prev</a> </td><th width="60%" align="center">Chapter 7. Class documentation</th><td width="20%" align="right"> <a accesskey="n" href="ch08.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="xmlrpc-server"></a>xmlrpc_server</h2></div></div></div><p>The implementation of this class has been kept as simple to use as
|
||||
possible. The constructor for the server basically does all the work.
|
||||
Here's a minimal example:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"> </span><span style="color: #007700">function </span><span style="color: #0000BB">foo </span><span style="color: #007700">(</span><span style="color: #0000BB">$xmlrpcmsg</span><span style="color: #007700">) {<br /> ...<br /> return new </span><span style="color: #0000BB">xmlrpcresp</span><span style="color: #007700">(</span><span style="color: #0000BB">$some_xmlrpc_val</span><span style="color: #007700">);<br /> }<br /><br /> class </span><span style="color: #0000BB">bar </span><span style="color: #007700">{<br /> function </span><span style="color: #0000BB">foobar</span><span style="color: #007700">(</span><span style="color: #0000BB">$xmlrpcmsg</span><span style="color: #007700">) {<br /> ...<br /> return new </span><span style="color: #0000BB">xmlrpcresp</span><span style="color: #007700">(</span><span style="color: #0000BB">$some_xmlrpc_val</span><span style="color: #007700">);<br /> }<br /> }<br /><br /> </span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">(<br /> array(<br /> </span><span style="color: #DD0000">"examples.myFunc1" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"function" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"examples.myFunc2" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"function" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"bar::foobar"</span><span style="color: #007700">),<br /> ));</span>
|
||||
</span>
|
||||
</code></pre><p>This performs everything you need to do with a server. The single
|
||||
constructor argument is an associative array from xmlrpc method names to
|
||||
php function names. The incoming request is parsed and dispatched to the
|
||||
relevant php function, which is responsible for returning a
|
||||
<code class="classname">xmlrpcresp</code> object, that will be serialized back
|
||||
to the caller.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536404"></a>Method handler functions</h3></div></div></div><p>Both php functions and class methods can be registered as xmlrpc
|
||||
method handlers.</p><p>The synopsis of a method handler function is:</p><pre class="synopsis">xmlrpcresp $resp = function (xmlrpcmsg $msg)</pre><p>No text should be echoed 'to screen' by the handler function, or
|
||||
it will break the xml response sent back to the client. This applies
|
||||
also to error and warning messages that PHP prints to screen unless
|
||||
the appropriate parameters have been set in the php.in file. Another
|
||||
way to prevent echoing of errors inside the response and facilitate
|
||||
debugging is to use the server SetDebug method with debug level 3 (see
|
||||
below).</p><p>Note that if you implement a method with a name prefixed by
|
||||
<code class="code">system.</code> the handler function will be invoked by the
|
||||
server with two parameters, the first being the server itself and the
|
||||
second being the <code class="classname">xmlrpcmsg</code> object.</p><p>The same php function can be registered as handler of multiple
|
||||
xmlrpc methods.</p><p>Here is a more detailed example of what the handler function
|
||||
<code class="function">foo</code> may do:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"> </span><span style="color: #007700">function </span><span style="color: #0000BB">foo </span><span style="color: #007700">(</span><span style="color: #0000BB">$xmlrpcmsg</span><span style="color: #007700">) {<br /> global </span><span style="color: #0000BB">$xmlrpcerruser</span><span style="color: #007700">; </span><span style="color: #FF8000">// import user errcode base value<br /><br /> </span><span style="color: #0000BB">$meth </span><span style="color: #007700">= </span><span style="color: #0000BB">$xmlrpcmsg</span><span style="color: #007700">-></span><span style="color: #0000BB">method</span><span style="color: #007700">(); </span><span style="color: #FF8000">// retrieve method name<br /> </span><span style="color: #0000BB">$par </span><span style="color: #007700">= </span><span style="color: #0000BB">$xmlrpcmsg</span><span style="color: #007700">-></span><span style="color: #0000BB">getParam</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// retrieve value of first parameter - assumes at least one param received<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">$par</span><span style="color: #007700">-></span><span style="color: #0000BB">scalarval</span><span style="color: #007700">(); </span><span style="color: #FF8000">// decode value of first parameter - assumes it is a scalar value<br /><br /> </span><span style="color: #007700">...<br /><br /> if (</span><span style="color: #0000BB">$err</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// this is an error condition<br /> </span><span style="color: #007700">return new </span><span style="color: #0000BB">xmlrpcresp</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcerruser</span><span style="color: #007700">+</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #FF8000">// user error 1<br /> </span><span style="color: #DD0000">"There's a problem, Captain"</span><span style="color: #007700">);<br /> } else {<br /> </span><span style="color: #FF8000">// this is a successful value being returned<br /> </span><span style="color: #007700">return new </span><span style="color: #0000BB">xmlrpcresp</span><span style="color: #007700">(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">"All's fine!"</span><span style="color: #007700">, </span><span style="color: #DD0000">"string"</span><span style="color: #007700">));<br /> }<br /> }</span>
|
||||
</span>
|
||||
</code></pre><p>See <code class="filename">server.php</code> in this distribution for
|
||||
more examples of how to do this.</p><p>Since release 2.0RC3 there is a new, even simpler way of
|
||||
registering php functions with the server. See section 5.7
|
||||
below</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536497"></a>The dispatch map</h3></div></div></div><p>The first argument to the <code class="function">xmlrpc_server</code>
|
||||
constructor is an array, called the <span class="emphasis"><em>dispatch map</em></span>.
|
||||
In this array is the information the server needs to service the
|
||||
XML-RPC methods you define.</p><p>The dispatch map takes the form of an associative array of
|
||||
associative arrays: the outer array has one entry for each method, the
|
||||
key being the method name. The corresponding value is another
|
||||
associative array, which can have the following members:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="function"><code class="literal">function</code></code> - this
|
||||
entry is mandatory. It must be either a name of a function in the
|
||||
global scope which services the XML-RPC method, or an array
|
||||
containing an instance of an object and a static method name (for
|
||||
static class methods the 'class::method' syntax is also
|
||||
supported).</p></li><li><p><code class="function"><code class="literal">signature</code></code> - this
|
||||
entry is an array containing the possible signatures (see <a class="xref" href="ch07s05.html#signatures" title="Method signatures">Signatures</a>) for the method. If this entry is present
|
||||
then the server will check that the correct number and type of
|
||||
parameters have been sent for this method before dispatching
|
||||
it.</p></li><li><p><code class="function"><code class="literal">docstring</code></code> - this
|
||||
entry is a string containing documentation for the method. The
|
||||
documentation may contain HTML markup.</p></li><li><p><code class="literal">signature_docs</code> - this entry can be used
|
||||
to provide documentation for the single parameters. It must match
|
||||
in structure the 'signature' member. By default, only the
|
||||
<code class="classname">documenting_xmlrpc_server</code> class in the
|
||||
extras package will take advantage of this, since the
|
||||
"system.methodHelp" protocol does not support documenting method
|
||||
parameters individually.</p></li></ul></div><p>Look at the <code class="filename">server.php</code> example in the
|
||||
distribution to see what a dispatch map looks like.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="signatures"></a>Method signatures</h3></div></div></div><p>A signature is a description of a method's return type and its
|
||||
parameter types. A method may have more than one signature.</p><p>Within a server's dispatch map, each method has an array of
|
||||
possible signatures. Each signature is an array of types. The first
|
||||
entry is the return type. For instance, the method </p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"><?php string examples</span><span style="color: #007700">.</span><span style="color: #0000BB">getStateName</span><span style="color: #007700">(int)</span>
|
||||
</span>
|
||||
</code></pre><p> has the signature </p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"><?php </span><span style="color: #007700">array(</span><span style="color: #0000BB">$xmlrpcString</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcInt</span><span style="color: #007700">)</span>
|
||||
</span>
|
||||
</code></pre><p> and, assuming that it is the only possible signature for the
|
||||
method, it might be used like this in server creation: </p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$findstate_sig </span><span style="color: #007700">= array(array(</span><span style="color: #0000BB">$xmlrpcString</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcInt</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$findstate_doc </span><span style="color: #007700">= </span><span style="color: #DD0000">'When passed an integer between 1 and 51 returns the<br />name of a US state, where the integer is the index of that state name<br />in an alphabetic order.'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">( array(<br /> </span><span style="color: #DD0000">"examples.getStateName" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"function" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"findstate"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"signature" </span><span style="color: #007700">=> </span><span style="color: #0000BB">$findstate_sig</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"docstring" </span><span style="color: #007700">=> </span><span style="color: #0000BB">$findstate_doc<br /> </span><span style="color: #007700">)));</span>
|
||||
</span>
|
||||
</code></pre><p>Note that method signatures do not allow to check nested
|
||||
parameters, e.g. the number, names and types of the members of a
|
||||
struct param cannot be validated.</p><p>If a method that you want to expose has a definite number of
|
||||
parameters, but each of those parameters could reasonably be of
|
||||
multiple types, the array of acceptable signatures will easily grow
|
||||
into a combinatorial explosion. To avoid such a situation, the lib
|
||||
defines the global var <code class="varname">$xmlrpcValue</code>, which can be
|
||||
used in method signatures as a placeholder for 'any xmlrpc
|
||||
type':</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$echoback_sig </span><span style="color: #007700">= array(array(</span><span style="color: #0000BB">$xmlrpcValue</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcValue</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$findstate_doc </span><span style="color: #007700">= </span><span style="color: #DD0000">'Echoes back to the client the received value, regardless of its type'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">( array(<br /> </span><span style="color: #DD0000">"echoBack" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"function" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"echoback"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"signature" </span><span style="color: #007700">=> </span><span style="color: #0000BB">$echoback_sig</span><span style="color: #007700">, </span><span style="color: #FF8000">// this sig guarantees that the method handler will be called with one and only one parameter<br /> </span><span style="color: #DD0000">"docstring" </span><span style="color: #007700">=> </span><span style="color: #0000BB">$echoback_doc<br /> </span><span style="color: #007700">)));</span>
|
||||
</span>
|
||||
</code></pre><p>Methods <code class="methodname">system.listMethods</code>,
|
||||
<code class="methodname">system.methodHelp</code>,
|
||||
<code class="methodname">system.methodSignature</code> and
|
||||
<code class="methodname">system.multicall</code> are already defined by the
|
||||
server, and should not be reimplemented (see Reserved Methods
|
||||
below).</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536731"></a>Delaying the server response</h3></div></div></div><p>You may want to construct the server, but for some reason not
|
||||
fulfill the request immediately (security verification, for instance).
|
||||
If you omit to pass to the constructor the dispatch map or pass it a
|
||||
second argument of <code class="literal">0</code> this will have the desired
|
||||
effect. You can then use the <code class="function">service()</code> method of
|
||||
the server class to service the request. For example:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">(</span><span style="color: #0000BB">$myDispMap</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// second parameter = 0 prevents automatic servicing of request<br /><br />// ... some code that does other stuff here<br /><br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">service</span><span style="color: #007700">();</span>
|
||||
</span>
|
||||
</code></pre><p>Note that the <code class="methodname">service</code> method will print
|
||||
the complete result payload to screen and send appropriate HTTP
|
||||
headers back to the client, but also return the response object. This
|
||||
permits further manipulation of the response.</p><p>To prevent the server from sending HTTP headers back to the
|
||||
client, you can pass a second parameter with a value of
|
||||
<code class="literal">TRUE</code> to the <code class="methodname">service</code>
|
||||
method. In this case, the response payload will be returned instead of
|
||||
the response object.</p><p>Xmlrpc requests retrieved by other means than HTTP POST bodies
|
||||
can also be processed. For example:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">(); </span><span style="color: #FF8000">// not passing a dispatch map prevents automatic servicing of request<br /><br />// ... some code that does other stuff here, including setting dispatch map into server object<br /><br /></span><span style="color: #0000BB">$resp </span><span style="color: #007700">= </span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">service</span><span style="color: #007700">(</span><span style="color: #0000BB">$xmlrpc_request_body</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">); </span><span style="color: #FF8000">// parse a variable instead of POST body, retrieve response payload<br /><br />// ... some code that does other stuff with xml response $resp here</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536813"></a>Modifying the server behaviour</h3></div></div></div><p>A couple of methods / class variables are available to modify
|
||||
the behaviour of the server. The only way to take advantage of their
|
||||
existence is by usage of a delayed server response (see above)</p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536827"></a>setDebug()</h4></div></div></div><p>This function controls weather the server is going to echo
|
||||
debugging messages back to the client as comments in response body.
|
||||
Valid values: 0,1,2,3, with 1 being the default. At level 0, no
|
||||
debug info is returned to the client. At level 2, the complete
|
||||
client request is added to the response, as part of the xml
|
||||
comments. At level 3, a new PHP error handler is set when executing
|
||||
user functions exposed as server methods, and all non-fatal errors
|
||||
are trapped and added as comments into the response.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536838"></a>allow_system_funcs</h4></div></div></div><p>Default_value: TRUE. When set to FALSE, disables support for
|
||||
<code class="methodname">System.xxx</code> functions in the server. It
|
||||
might be useful e.g. if you do not wish the server to respond to
|
||||
requests to <code class="methodname">System.ListMethods</code>.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536860"></a>compress_response</h4></div></div></div><p>When set to TRUE, enables the server to take advantage of HTTP
|
||||
compression, otherwise disables it. Responses will be transparently
|
||||
compressed, but only when an xmlrpc-client declares its support for
|
||||
compression in the HTTP headers of the request.</p><p>Note that the ZLIB php extension must be installed for this to
|
||||
work. If it is, <code class="varname">compress_response</code> will default to
|
||||
TRUE.</p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id536887"></a>response_charset_encoding</h4></div></div></div><p>Charset encoding to be used for response (only affects string
|
||||
values).</p><p>If it can, the server will convert the generated response from
|
||||
internal_encoding to the intended one.</p><p>Valid values are: a supported xml encoding (only UTF-8 and
|
||||
ISO-8859-1 at present, unless mbstring is enabled), null (leave
|
||||
charset unspecified in response and convert output stream to
|
||||
US_ASCII), 'default' (use xmlrpc library default as specified in
|
||||
xmlrpc.inc, convert output stream if needed), or 'auto' (use
|
||||
client-specified charset encoding or same as request if request
|
||||
headers do not specify it (unless request is US-ASCII: then use
|
||||
library default anyway).</p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id536919"></a>Fault reporting</h3></div></div></div><p>Fault codes for your servers should start at the value indicated
|
||||
by the global <code class="literal">$xmlrpcerruser</code> + 1.</p><p>Standard errors returned by the server include:</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">1</code> <span>Unknown method</span></span></dt><dd><p>Returned if the server was asked to dispatch a method it
|
||||
didn't know about</p></dd><dt><span class="term"><code class="literal">2</code> <span>Invalid return
|
||||
payload</span></span></dt><dd><p>This error is actually generated by the client, not
|
||||
server, code, but signifies that a server returned something it
|
||||
couldn't understand. A more detailed error report is sometimes
|
||||
added onto the end of the phrase above.</p></dd><dt><span class="term"><code class="literal">3</code> <span>Incorrect
|
||||
parameters</span></span></dt><dd><p>This error is generated when the server has signature(s)
|
||||
defined for a method, and the parameters passed by the client do
|
||||
not match any of signatures.</p></dd><dt><span class="term"><code class="literal">4</code> <span>Can't introspect: method
|
||||
unknown</span></span></dt><dd><p>This error is generated by the builtin
|
||||
<code class="function">system.*</code> methods when any kind of
|
||||
introspection is attempted on a method undefined by the
|
||||
server.</p></dd><dt><span class="term"><code class="literal">5</code> <span>Didn't receive 200 OK from
|
||||
remote server</span></span></dt><dd><p>This error is generated by the client when a remote server
|
||||
doesn't return HTTP/1.1 200 OK in response to a request. A more
|
||||
detailed error report is added onto the end of the phrase
|
||||
above.</p></dd><dt><span class="term"><code class="literal">6</code> <span>No data received from
|
||||
server</span></span></dt><dd><p>This error is generated by the client when a remote server
|
||||
returns HTTP/1.1 200 OK in response to a request, but no
|
||||
response body follows the HTTP headers.</p></dd><dt><span class="term"><code class="literal">7</code> <span>No SSL support compiled
|
||||
in</span></span></dt><dd><p>This error is generated by the client when trying to send
|
||||
a request with HTTPS and the CURL extension is not available to
|
||||
PHP.</p></dd><dt><span class="term"><code class="literal">8</code> <span>CURL error</span></span></dt><dd><p>This error is generated by the client when trying to send
|
||||
a request with HTTPS and the HTTPS communication fails.</p></dd><dt><span class="term"><code class="literal">9-14</code> <span>multicall
|
||||
errors</span></span></dt><dd><p>These errors are generated by the server when something
|
||||
fails inside a system.multicall request.</p></dd><dt><span class="term"><code class="literal">100-</code> <span>XML parse
|
||||
errors</span></span></dt><dd><p>Returns 100 plus the XML parser error code for the fault
|
||||
that occurred. The <code class="function">faultString</code> returned
|
||||
explains where the parse error was in the incoming XML
|
||||
stream.</p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537184"></a>'New style' servers</h3></div></div></div><p>In the same spirit of simplification that inspired the
|
||||
<code class="varname">xmlrpc_client::return_type</code> class variable, a new
|
||||
class variable has been added to the server class:
|
||||
<code class="varname">functions_parameters_type</code>. When set to 'phpvals',
|
||||
the functions registered in the server dispatch map will be called
|
||||
with plain php values as parameters, instead of a single xmlrpcmsg
|
||||
instance parameter. The return value of those functions is expected to
|
||||
be a plain php value, too. An example is worth a thousand
|
||||
words:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"> </span><span style="color: #007700">function </span><span style="color: #0000BB">foo</span><span style="color: #007700">(</span><span style="color: #0000BB">$usr_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$out_lang</span><span style="color: #007700">=</span><span style="color: #DD0000">'en'</span><span style="color: #007700">) {<br /> global </span><span style="color: #0000BB">$xmlrpcerruser</span><span style="color: #007700">;<br /><br /> ...<br /><br /> if (</span><span style="color: #0000BB">$someErrorCondition</span><span style="color: #007700">)<br /> return new </span><span style="color: #0000BB">xmlrpcresp</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcerruser</span><span style="color: #007700">+</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">'DOH!'</span><span style="color: #007700">);<br /> else<br /> return array(<br /> </span><span style="color: #DD0000">'name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Joe'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'age' </span><span style="color: #007700">=> </span><span style="color: #0000BB">27</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'picture' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #0000BB">$picOfTheGuy</span><span style="color: #007700">), </span><span style="color: #DD0000">'base64'</span><span style="color: #007700">)<br /> );<br /> }<br /><br /> </span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">(<br /> array(<br /> </span><span style="color: #DD0000">"examples.myFunc" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"function" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"bar::foobar"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"signature" </span><span style="color: #007700">=> array(<br /> array(</span><span style="color: #0000BB">$xmlrpcString</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcInt</span><span style="color: #007700">),<br /> array(</span><span style="color: #0000BB">$xmlrpcString</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcInt</span><span style="color: #007700">, </span><span style="color: #0000BB">$xmlrpcString</span><span style="color: #007700">)<br /> )<br /> )<br /> ), </span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">functions_parameters_type </span><span style="color: #007700">= </span><span style="color: #DD0000">'phpvals'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">service</span><span style="color: #007700">();</span>
|
||||
</span>
|
||||
</code></pre><p>There are a few things to keep in mind when using this
|
||||
simplified syntax:</p><p>to return an xmlrpc error, the method handler function must
|
||||
return an instance of xmlrpcresp. There is no other way for the server
|
||||
to know when an error response should be served to the client;</p><p>to return a base64 value, the method handler function must
|
||||
encode it on its own, creating an instance of an xmlrpcval
|
||||
object;</p><p>the method handler function cannot determine the name of the
|
||||
xmlrpc method it is serving, unlike standard handler functions that
|
||||
can retrieve it from the message object;</p><p>when receiving nested parameters, the method handler function
|
||||
has no way to distinguish a php string that was sent as base64 value
|
||||
from one that was sent as a string value;</p><p>this has a direct consequence on the support of
|
||||
system.multicall: a method whose signature contains datetime or base64
|
||||
values will not be available to multicall calls;</p><p>last but not least, the direct parsing of xml to php values is
|
||||
much faster than using xmlrpcvals, and allows the library to handle
|
||||
much bigger messages without allocating all available server memory or
|
||||
smashing PHP recursive call stack.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07s04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch07.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch08.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">xmlrpcresp </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 8. Global variables</td></tr></table></div></body></html>
|
||||
21
include/limesurvey/admin/classes/xmlrpc/doc/ch08.html
Normal file
21
include/limesurvey/admin/classes/xmlrpc/doc/ch08.html
Normal file
@@ -0,0 +1,21 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 8. Global variables</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch07s05.html" title="xmlrpc_server" /><link rel="next" href="ch08s02.html" title="Variables whose value can be modified" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 8. Global variables</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07s05.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch08s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="globalvars"></a>Chapter 8. Global variables</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch08.html#id537293">"Constant" variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch08.html#id537299">$xmlrpcerruser</a></span></dt><dt><span class="sect2"><a href="ch08.html#id537324">$xmlrpcI4, $xmlrpcInt, $xmlrpcBoolean, $xmlrpcDouble,
|
||||
$xmlrpcString, $xmlrpcDateTime, $xmlrpcBase64, $xmlrpcArray,
|
||||
$xmlrpcStruct, $xmlrpcValue, $xmlrpcNull</a></span></dt><dt><span class="sect2"><a href="ch08.html#id537349">$xmlrpcTypes, $xmlrpc_valid_parents, $xmlrpcerr, $xmlrpcstr,
|
||||
$xmlrpcerrxml, $xmlrpc_backslash, $_xh, $xml_iso88591_Entities,
|
||||
$xmlEntities, $xmlrpcs_capabilities</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch08s02.html">Variables whose value can be modified</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch08s02.html#xmlrpc-defencoding">xmlrpc_defencoding</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537432">xmlrpc_internalencoding</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537504">xmlrpcName</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537530">xmlrpcVersion</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537557">xmlrpc_null_extension</a></span></dt></dl></dd></dl></div><p>Many global variables are defined in the xmlrpc.inc file. Some of
|
||||
those are meant to be used as constants (and modifying their value might
|
||||
cause unpredictable behaviour), while some others can be modified in your
|
||||
php scripts to alter the behaviour of the xml-rpc client and
|
||||
server.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id537293"></a>"Constant" variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537299"></a>$xmlrpcerruser</h3></div></div></div><p><code class="fieldsynopsis"><span class="varname">$xmlrpcerruser </span><span class="initializer">= 800</span>;</code>The minimum value for errors reported by user
|
||||
implemented XML-RPC servers. Error numbers lower than that are
|
||||
reserved for library usage.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537324"></a>$xmlrpcI4, $xmlrpcInt, $xmlrpcBoolean, $xmlrpcDouble,
|
||||
$xmlrpcString, $xmlrpcDateTime, $xmlrpcBase64, $xmlrpcArray,
|
||||
$xmlrpcStruct, $xmlrpcValue, $xmlrpcNull</h3></div></div></div><p>For convenience the strings representing the XML-RPC types have
|
||||
been encoded as global variables:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$xmlrpcI4</span><span style="color: #007700">=</span><span style="color: #DD0000">"i4"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcInt</span><span style="color: #007700">=</span><span style="color: #DD0000">"int"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcBoolean</span><span style="color: #007700">=</span><span style="color: #DD0000">"boolean"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcDouble</span><span style="color: #007700">=</span><span style="color: #DD0000">"double"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcString</span><span style="color: #007700">=</span><span style="color: #DD0000">"string"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcDateTime</span><span style="color: #007700">=</span><span style="color: #DD0000">"dateTime.iso8601"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcBase64</span><span style="color: #007700">=</span><span style="color: #DD0000">"base64"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcArray</span><span style="color: #007700">=</span><span style="color: #DD0000">"array"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcStruct</span><span style="color: #007700">=</span><span style="color: #DD0000">"struct"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcValue</span><span style="color: #007700">=</span><span style="color: #DD0000">"undefined"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$xmlrpcNull</span><span style="color: #007700">=</span><span style="color: #DD0000">"null"</span><span style="color: #007700">;</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537349"></a>$xmlrpcTypes, $xmlrpc_valid_parents, $xmlrpcerr, $xmlrpcstr,
|
||||
$xmlrpcerrxml, $xmlrpc_backslash, $_xh, $xml_iso88591_Entities,
|
||||
$xmlEntities, $xmlrpcs_capabilities</h3></div></div></div><p>Reserved for internal usage.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07s05.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch08s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">xmlrpc_server </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Variables whose value can be modified</td></tr></table></div></body></html>
|
||||
39
include/limesurvey/admin/classes/xmlrpc/doc/ch08s02.html
Normal file
39
include/limesurvey/admin/classes/xmlrpc/doc/ch08s02.html
Normal file
@@ -0,0 +1,39 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Variables whose value can be modified</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch08.html" title="Chapter 8. Global variables" /><link rel="prev" href="ch08.html" title="Chapter 8. Global variables" /><link rel="next" href="ch09.html" title="Chapter 9. Helper functions" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Variables whose value can be modified</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch08.html">Prev</a> </td><th width="60%" align="center">Chapter 8. Global variables</th><td width="20%" align="right"> <a accesskey="n" href="ch09.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id537364"></a>Variables whose value can be modified</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="xmlrpc-defencoding"></a>xmlrpc_defencoding</h3></div></div></div><code class="fieldsynopsis"><span class="varname">$xmlrpc_defencoding </span><span class="initializer">= "UTF8"</span>;</code><p>This variable defines the character set encoding that will be
|
||||
used by the xml-rpc client and server to decode the received messages,
|
||||
when a specific charset declaration is not found (in the messages sent
|
||||
non-ascii chars are always encoded using character references, so that
|
||||
the produced xml is valid regardless of the charset encoding
|
||||
assumed).</p><p>Allowed values: <code class="literal">"UTF8"</code>,
|
||||
<code class="literal">"ISO-8859-1"</code>, <code class="literal">"ASCII".</code></p><p>Note that the appropriate RFC actually mandates that XML
|
||||
received over HTTP without indication of charset encoding be treated
|
||||
as US-ASCII, but many servers and clients 'in the wild' violate the
|
||||
standard, and assume the default encoding is UTF-8.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537432"></a>xmlrpc_internalencoding</h3></div></div></div><p><code class="fieldsynopsis"><span class="varname">$xmlrpc_internalencoding </span><span class="initializer">= "ISO-8859-1"</span>;</code>This variable defines the character set encoding
|
||||
that the library uses to transparently encode into valid XML the
|
||||
xml-rpc values created by the user and to re-encode the received
|
||||
xml-rpc values when it passes them to the PHP application. It only
|
||||
affects xml-rpc values of string type. It is a separate value from
|
||||
xmlrpc_defencoding, allowing e.g. to send/receive xml messages encoded
|
||||
on-the-wire in US-ASCII and process them as UTF-8. It defaults to the
|
||||
character set used internally by PHP (unless you are running an
|
||||
MBString-enabled installation), so you should change it only in
|
||||
special situations, if e.g. the string values exchanged in the xml-rpc
|
||||
messages are directly inserted into / fetched from a database
|
||||
configured to return UTF8 encoded strings to PHP. Example
|
||||
usage:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"></span><span style="color: #007700"><?</span><span style="color: #0000BB">php<br /><br /></span><span style="color: #007700">include(</span><span style="color: #DD0000">'xmlrpc.inc'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$xmlrpc_internalencoding </span><span style="color: #007700">= </span><span style="color: #DD0000">'UTF-8'</span><span style="color: #007700">; </span><span style="color: #FF8000">// this has to be set after the inclusion above<br /></span><span style="color: #0000BB">$v </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">'κόÏμε'</span><span style="color: #007700">); </span><span style="color: #FF8000">// This xmlrpc value will be correctly serialized as the greek word 'kosme'</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537504"></a>xmlrpcName</h3></div></div></div><p><code class="fieldsynopsis"><span class="varname">$xmlrpcName </span><span class="initializer">= "XML-RPC for PHP"</span>;</code>The string representation of the name of the XML-RPC
|
||||
for PHP library. It is used by the client for building the User-Agent
|
||||
HTTP header that is sent with every request to the server. You can
|
||||
change its value if you need to customize the User-Agent
|
||||
string.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537530"></a>xmlrpcVersion</h3></div></div></div><p><code class="fieldsynopsis"><span class="varname">$xmlrpcVersion </span><span class="initializer">= "2.2"</span>;</code>The string representation of the version number of
|
||||
the XML-RPC for PHP library in use. It is used by the client for
|
||||
building the User-Agent HTTP header that is sent with every request to
|
||||
the server. You can change its value if you need to customize the
|
||||
User-Agent string.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id537557"></a>xmlrpc_null_extension</h3></div></div></div><p>When set to <code class="constant">TRUE</code>, the lib will enable
|
||||
support for the <NIL/> xmlrpc value, as per the extension to the
|
||||
standard proposed here. This means that <NIL/> tags will be
|
||||
parsed as valid xmlrpc, and the corresponding xmlrpcvals will return
|
||||
"null" for <code class="methodname">scalarTyp()</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch08.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch08.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch09.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 8. Global variables </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 9. Helper functions</td></tr></table></div></body></html>
|
||||
28
include/limesurvey/admin/classes/xmlrpc/doc/ch09.html
Normal file
28
include/limesurvey/admin/classes/xmlrpc/doc/ch09.html
Normal file
@@ -0,0 +1,28 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 9. Helper functions</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch08s02.html" title="Variables whose value can be modified" /><link rel="next" href="ch09s02.html" title="Easy use with nested PHP values" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 9. Helper functions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch08s02.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch09s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="helpers"></a>Chapter 9. Helper functions</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch09.html#id537600">Date functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09.html#iso8601encode">iso8601_encode</a></span></dt><dt><span class="sect2"><a href="ch09.html#iso8601decode">iso8601_decode</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s02.html">Easy use with nested PHP values</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s02.html#phpxmlrpcdecode">php_xmlrpc_decode</a></span></dt><dt><span class="sect2"><a href="ch09s02.html#phpxmlrpcencode">php_xmlrpc_encode</a></span></dt><dt><span class="sect2"><a href="ch09s02.html#id538134">php_xmlrpc_decode_xml</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s03.html">Automatic conversion of php functions into xmlrpc methods (and
|
||||
vice versa)</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s03.html#id538228">wrap_xmlrpc_method</a></span></dt><dt><span class="sect2"><a href="ch09s03.html#wrap_php_function">wrap_php_function</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s04.html">Functions removed from the library</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s04.html#xmlrpcdecode">xmlrpc_decode</a></span></dt><dt><span class="sect2"><a href="ch09s04.html#xmlrpcencode">xmlrpc_encode</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s05.html">Debugging aids</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s05.html#id538826">xmlrpc_debugmsg</a></span></dt></dl></dd></dl></div><p>XML-RPC for PHP contains some helper functions which you can use to
|
||||
make processing of XML-RPC requests easier.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id537600"></a>Date functions</h2></div></div></div><p>The XML-RPC specification has this to say on dates:</p><div class="blockquote"><blockquote class="blockquote"><p><a id="wrap_xmlrpc_method"></a>Don't assume a timezone. It should be
|
||||
specified by the server in its documentation what assumptions it makes
|
||||
about timezones.</p></blockquote></div><p>Unfortunately, this means that date processing isn't
|
||||
straightforward. Although XML-RPC uses ISO 8601 format dates, it doesn't
|
||||
use the timezone specifier.</p><p>We strongly recommend that in every case where you pass dates in
|
||||
XML-RPC calls, you use UTC (GMT) as your timezone. Most computer
|
||||
languages include routines for handling GMT times natively, and you
|
||||
won't have to translate between timezones.</p><p>For more information about dates, see <a class="ulink" href="http://www.uic.edu/year2000/datefmt.html" target="_top">ISO 8601: The Right
|
||||
Format for Dates</a>, which has a handy link to a PDF of the ISO
|
||||
8601 specification. Note that XML-RPC uses exactly one of the available
|
||||
representations: CCYYMMDDTHH:MM:SS.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="iso8601encode"></a>iso8601_encode</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">iso8601_encode</b>(</code></td><td>string<var class="pdparam">$time_t</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$utc</var>0<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns an ISO 8601 formatted date generated from the UNIX
|
||||
timestamp <em class="parameter"><code>$time_t</code></em>, as returned by the PHP
|
||||
function <code class="function">time()</code>.</p><p>The argument <em class="parameter"><code>$utc</code></em> can be omitted, in
|
||||
which case it defaults to <code class="literal">0</code>. If it is set to
|
||||
<code class="literal">1</code>, then the function corrects the time passed in
|
||||
for UTC. Example: if you're in the GMT-6:00 timezone and set
|
||||
<em class="parameter"><code>$utc</code></em>, you will receive a date representation
|
||||
six hours ahead of your local time.</p><p>The included demo program <code class="filename">vardemo.php</code>
|
||||
includes a demonstration of this function.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="iso8601decode"></a>iso8601_decode</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int<b class="fsfunc">iso8601_decode</b>(</code></td><td>string<var class="pdparam">$isoString</var>, </td></tr><tr><td> </td><td>int<var class="pdparam">$utc</var>0<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns a UNIX timestamp from an ISO 8601 encoded time and date
|
||||
string passed in. If <em class="parameter"><code>$utc</code></em> is
|
||||
<code class="literal">1</code> then <em class="parameter"><code>$isoString</code></em> is assumed
|
||||
to be in the UTC timezone, and thus the result is also UTC: otherwise,
|
||||
the timezone is assumed to be your local timezone and you receive a
|
||||
local timestamp.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch08s02.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch09s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Variables whose value can be modified </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Easy use with nested PHP values</td></tr></table></div></body></html>
|
||||
64
include/limesurvey/admin/classes/xmlrpc/doc/ch09s02.html
Normal file
64
include/limesurvey/admin/classes/xmlrpc/doc/ch09s02.html
Normal file
@@ -0,0 +1,64 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Easy use with nested PHP values</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch09.html" title="Chapter 9. Helper functions" /><link rel="prev" href="ch09.html" title="Chapter 9. Helper functions" /><link rel="next" href="ch09s03.html" title="Automatic conversion of php functions into xmlrpc methods (and vice versa)" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Easy use with nested PHP values</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch09.html">Prev</a> </td><th width="60%" align="center">Chapter 9. Helper functions</th><td width="20%" align="right"> <a accesskey="n" href="ch09s03.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="arrayuse"></a>Easy use with nested PHP values</h2></div></div></div><p>Dan Libby was kind enough to contribute two helper functions that
|
||||
make it easier to translate to and from PHP values. This makes it easier
|
||||
to deal with complex structures. At the moment support is limited to
|
||||
<span class="type">int</span>, <span class="type">double</span>, <span class="type">string</span>,
|
||||
<span class="type">array</span>, <span class="type">datetime</span> and <span class="type">struct</span>
|
||||
datatypes; note also that all PHP arrays are encoded as structs, except
|
||||
arrays whose keys are integer numbers starting with 0 and incremented by
|
||||
1.</p><p>These functions reside in <code class="filename">xmlrpc.inc</code>.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="phpxmlrpcdecode"></a>php_xmlrpc_decode</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">mixed<b class="fsfunc">php_xmlrpc_decode</b>(</code></td><td>xmlrpcval<var class="pdparam">$xmlrpc_val</var>, </td></tr><tr><td> </td><td>array<var class="pdparam">$options</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">array<b class="fsfunc">php_xmlrpc_decode</b>(</code></td><td>xmlrpcmsg<var class="pdparam">$xmlrpcmsg_val</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$options</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns a native PHP value corresponding to the values found in
|
||||
the <span class="type">xmlrpcval</span> <em class="parameter"><code>$xmlrpc_val</code></em>,
|
||||
translated into PHP types. Base-64 and datetime values are
|
||||
automatically decoded to strings.</p><p>In the second form, returns an array containing the parameters
|
||||
of the given
|
||||
<em class="parameter"><code><code class="classname">xmlrpcmsg</code>_val</code></em>, decoded
|
||||
to php types.</p><p>The <em class="parameter"><code>options</code></em> parameter is optional. If
|
||||
specified, it must consist of an array of options to be enabled in the
|
||||
decoding process. At the moment the only valid option is
|
||||
<span class="symbol">decode_php_objs</span>. When it is set, php objects that
|
||||
have been converted to xml-rpc structs using the
|
||||
<code class="function">php_xmlrpc_encode</code> function and a corresponding
|
||||
encoding option will be converted back into object values instead of
|
||||
arrays (provided that the class definition is available at
|
||||
reconstruction time).</p><p><span class="emphasis"><em><span class="emphasis"><em>WARNING</em></span>:</em></span> please take
|
||||
extreme care before enabling the <span class="symbol">decode_php_objs</span>
|
||||
option: when php objects are rebuilt from the received xml, their
|
||||
constructor function will be silently invoked. This means that you are
|
||||
allowing the remote end to trigger execution of uncontrolled PHP code
|
||||
on your server, opening the door to code injection exploits. Only
|
||||
enable this option when you have complete trust of the remote
|
||||
server/client.</p><p>Example:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"></span><span style="color: #FF8000">// wrapper to expose an existing php function as xmlrpc method handler<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">foo_wrapper</span><span style="color: #007700">(</span><span style="color: #0000BB">$m</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$params </span><span style="color: #007700">= </span><span style="color: #0000BB">php_xmlrpc_decode</span><span style="color: #007700">(</span><span style="color: #0000BB">$m</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">call_user_func_array</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #0000BB">$params</span><span style="color: #007700">);<br /> return new </span><span style="color: #0000BB">xmlrpcresp</span><span style="color: #007700">(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">)); </span><span style="color: #FF8000">// foo return value will be serialized as string<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">(array(<br /> </span><span style="color: #DD0000">"examples.myFunc1" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"function" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"foo_wrapper"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"signatures" </span><span style="color: #007700">=> ...<br /> )));</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="phpxmlrpcencode"></a>php_xmlrpc_encode</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval<b class="fsfunc">php_xmlrpc_encode</b>(</code></td><td>mixed<var class="pdparam">$phpval</var>, </td></tr><tr><td> </td><td>array<var class="pdparam">$options</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Returns an <span class="type">xmlrpcval</span> object populated with the PHP
|
||||
values in <em class="parameter"><code>$phpval</code></em>. Works recursively on arrays
|
||||
and objects, encoding numerically indexed php arrays into array-type
|
||||
xmlrpcval objects and non numerically indexed php arrays into
|
||||
struct-type xmlrpcval objects. Php objects are encoded into
|
||||
struct-type xmlrpcvals, excepted for php values that are already
|
||||
instances of the xmlrpcval class or descendants thereof, which will
|
||||
not be further encoded. Note that there's no support for encoding php
|
||||
values into base-64 values. Encoding of date-times is optionally
|
||||
carried on on php strings with the correct format.</p><p>The <em class="parameter"><code>options</code></em> parameter is optional. If
|
||||
specified, it must consist of an array of options to be enabled in the
|
||||
encoding process. At the moment the only valid options are
|
||||
<span class="symbol">encode_php_objs</span> and
|
||||
<span class="symbol">auto_dates</span>.</p><p>The first will enable the creation of 'particular' xmlrpcval
|
||||
objects out of php objects, that add a "php_class" xml attribute to
|
||||
their serialized representation. This attribute allows the function
|
||||
php_xmlrpc_decode to rebuild the native php objects (provided that the
|
||||
same class definition exists on both sides of the
|
||||
communication)</p><p>Example:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"></span><span style="color: #FF8000">// the easy way to build a complex xml-rpc struct, showing nested base64 value and datetime values<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">php_xmlrpc_encode</span><span style="color: #007700">(array(<br /> </span><span style="color: #DD0000">'first struct_element: an int' </span><span style="color: #007700">=> </span><span style="color: #0000BB">666</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'second: an array' </span><span style="color: #007700">=> array (</span><span style="color: #DD0000">'apple'</span><span style="color: #007700">, </span><span style="color: #DD0000">'orange'</span><span style="color: #007700">, </span><span style="color: #DD0000">'banana'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'third: a base64 element' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">'hello world'</span><span style="color: #007700">, </span><span style="color: #DD0000">'base64'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'fourth: a datetime' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'20060107T01:53:00'<br /> </span><span style="color: #007700">), array(</span><span style="color: #DD0000">'auto_dates'</span><span style="color: #007700">));</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id538134"></a>php_xmlrpc_decode_xml</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval | xmlrpcresp |
|
||||
xmlrpcmsg<b class="fsfunc">php_xmlrpc_decode_xml</b>(</code></td><td>string<var class="pdparam">$xml</var>, </td></tr><tr><td> </td><td>array<var class="pdparam">$options</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Decodes the xml representation of either an xmlrpc request,
|
||||
response or single value, returning the corresponding php-xmlrpc
|
||||
object, or <code class="literal">FALSE</code> in case of an error.</p><p>The <em class="parameter"><code>options</code></em> parameter is optional. If
|
||||
specified, it must consist of an array of options to be enabled in the
|
||||
decoding process. At the moment, no option is supported.</p><p>Example:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$text </span><span style="color: #007700">= </span><span style="color: #DD0000">'<value><array><data><value>Hello world</value></data></array></value>'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">php_xmlrpc_decode_xml</span><span style="color: #007700">(</span><span style="color: #0000BB">$text</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$val</span><span style="color: #007700">) echo </span><span style="color: #DD0000">'Found a value of type '</span><span style="color: #007700">.</span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">kindOf</span><span style="color: #007700">(); else echo </span><span style="color: #DD0000">'Found invalid xml'</span><span style="color: #007700">;</span>
|
||||
</span>
|
||||
</code></pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch09.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch09.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch09s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 9. Helper functions </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Automatic conversion of php functions into xmlrpc methods (and
|
||||
vice versa)</td></tr></table></div></body></html>
|
||||
103
include/limesurvey/admin/classes/xmlrpc/doc/ch09s03.html
Normal file
103
include/limesurvey/admin/classes/xmlrpc/doc/ch09s03.html
Normal file
@@ -0,0 +1,103 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Automatic conversion of php functions into xmlrpc methods (and vice versa)</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch09.html" title="Chapter 9. Helper functions" /><link rel="prev" href="ch09s02.html" title="Easy use with nested PHP values" /><link rel="next" href="ch09s04.html" title="Functions removed from the library" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Automatic conversion of php functions into xmlrpc methods (and
|
||||
vice versa)</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch09s02.html">Prev</a> </td><th width="60%" align="center">Chapter 9. Helper functions</th><td width="20%" align="right"> <a accesskey="n" href="ch09s04.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id538212"></a>Automatic conversion of php functions into xmlrpc methods (and
|
||||
vice versa)</h2></div></div></div><p>For the extremely lazy coder, helper functions have been added
|
||||
that allow to convert a php function into an xmlrpc method, and a
|
||||
remotely exposed xmlrpc method into a local php function - or a set of
|
||||
methods into a php class. Note that these comes with many caveat.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id538228"></a>wrap_xmlrpc_method</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">wrap_xmlrpc_method</b>(</code></td><td>$client, </td></tr><tr><td> </td><td>$methodname, </td></tr><tr><td> </td><td>$extra_options<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">string<b class="fsfunc">wrap_xmlrpc_method</b>(</code></td><td>$client, </td></tr><tr><td> </td><td>$methodname, </td></tr><tr><td> </td><td>$signum, </td></tr><tr><td> </td><td>$timeout, </td></tr><tr><td> </td><td>$protocol, </td></tr><tr><td> </td><td>$funcname<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Given an xmlrpc server and a method name, creates a php wrapper
|
||||
function that will call the remote method and return results using
|
||||
native php types for both params and results. The generated php
|
||||
function will return an xmlrpcresp object for failed xmlrpc
|
||||
calls.</p><p>The second syntax is deprecated, and is listed here only for
|
||||
backward compatibility.</p><p>The server must support the
|
||||
<code class="methodname">system.methodSignature</code> xmlrpc method call for
|
||||
this function to work.</p><p>The <em class="parameter"><code>client</code></em> param must be a valid
|
||||
xmlrpc_client object, previously created with the address of the
|
||||
target xmlrpc server, and to which the preferred communication options
|
||||
have been set.</p><p>The optional parameters can be passed as array key,value pairs
|
||||
in the <em class="parameter"><code>extra_options</code></em> param.</p><p>The <em class="parameter"><code>signum</code></em> optional param has the purpose
|
||||
of indicating which method signature to use, if the given server
|
||||
method has multiple signatures (defaults to 0).</p><p>The <em class="parameter"><code>timeout</code></em> and
|
||||
<em class="parameter"><code>protocol</code></em> optional params are the same as in the
|
||||
<code class="methodname">xmlrpc_client::send()</code> method.</p><p>If set, the optional <em class="parameter"><code>new_function_name</code></em>
|
||||
parameter indicates which name should be used for the generated
|
||||
function. In case it is not set the function name will be
|
||||
auto-generated.</p><p>If the <code class="literal">return_source</code> optional parameter is
|
||||
set, the function will return the php source code to build the wrapper
|
||||
function, instead of evaluating it (useful to save the code and use it
|
||||
later as stand-alone xmlrpc client).</p><p>If the <code class="literal">encode_php_objs</code> optional parameter is
|
||||
set, instances of php objects later passed as parameters to the newly
|
||||
created function will receive a 'special' treatment that allows the
|
||||
server to rebuild them as php objects instead of simple arrays. Note
|
||||
that this entails using a "slightly augmented" version of the xmlrpc
|
||||
protocol (ie. using element attributes), which might not be understood
|
||||
by xmlrpc servers implemented using other libraries.</p><p>If the <code class="literal">decode_php_objs</code> optional parameter is
|
||||
set, instances of php objects that have been appropriately encoded by
|
||||
the server using a coordinate option will be deserialized as php
|
||||
objects instead of simple arrays (the same class definition should be
|
||||
present server side and client side).</p><p><span class="emphasis"><em>Note that this might pose a security risk</em></span>,
|
||||
since in order to rebuild the object instances their constructor
|
||||
method has to be invoked, and this means that the remote server can
|
||||
trigger execution of unforeseen php code on the client: not really a
|
||||
code injection, but almost. Please enable this option only when you
|
||||
trust the remote server.</p><p>In case of an error during generation of the wrapper function,
|
||||
FALSE is returned, otherwise the name (or source code) of the new
|
||||
function.</p><p>Known limitations: server must support
|
||||
<code class="methodname">system.methodsignature</code> for the wanted xmlrpc
|
||||
method; for methods that expose multiple signatures, only one can be
|
||||
picked; for remote calls with nested xmlrpc params, the caller of the
|
||||
generated php function has to encode on its own the params passed to
|
||||
the php function if these are structs or arrays whose (sub)members
|
||||
include values of type base64.</p><p>Note: calling the generated php function 'might' be slow: a new
|
||||
xmlrpc client is created on every invocation and an xmlrpc-connection
|
||||
opened+closed. An extra 'debug' param is appended to the parameter
|
||||
list of the generated php function, useful for debugging
|
||||
purposes.</p><p>Example usage:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$c </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://phpxmlrpc.sourceforge.net/server.php'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$function </span><span style="color: #007700">= </span><span style="color: #0000BB">wrap_xmlrpc_method</span><span style="color: #007700">(</span><span style="color: #0000BB">$client</span><span style="color: #007700">, </span><span style="color: #DD0000">'examples.getStateName'</span><span style="color: #007700">);<br /><br />if (!</span><span style="color: #0000BB">$function</span><span style="color: #007700">)<br /> die(</span><span style="color: #DD0000">'Cannot introspect remote method'</span><span style="color: #007700">);<br />else {<br /> </span><span style="color: #0000BB">$stateno </span><span style="color: #007700">= </span><span style="color: #0000BB">15</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$statename </span><span style="color: #007700">= </span><span style="color: #0000BB">$function</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">is_a</span><span style="color: #007700">(</span><span style="color: #0000BB">$statename</span><span style="color: #007700">, </span><span style="color: #DD0000">'xmlrpcresp'</span><span style="color: #007700">)) </span><span style="color: #FF8000">// call failed<br /> </span><span style="color: #007700">{<br /> echo </span><span style="color: #DD0000">'Call failed: '</span><span style="color: #007700">.</span><span style="color: #0000BB">$statename</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">().</span><span style="color: #DD0000">'. Calling again with debug on'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$function</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /> }<br /> else<br /> echo </span><span style="color: #DD0000">"OK, state nr. $stateno is $statename"</span><span style="color: #007700">;<br />}</span>
|
||||
</span>
|
||||
</code></pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap_php_function"></a>wrap_php_function</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">array<b class="fsfunc">wrap_php_function</b>(</code></td><td>string<var class="pdparam">$funcname</var>, </td></tr><tr><td> </td><td>string<var class="pdparam">$wrapper_function_name</var>, </td></tr><tr><td> </td><td>array<var class="pdparam">$extra_options</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Given a user-defined PHP function, create a PHP 'wrapper'
|
||||
function that can be exposed as xmlrpc method from an xmlrpc_server
|
||||
object and called from remote clients, and return the appropriate
|
||||
definition to be added to a server's dispatch map.</p><p>The optional <em class="parameter"><code>$wrapper_function_name</code></em>
|
||||
specifies the name that will be used for the auto-generated
|
||||
function.</p><p>Since php is a typeless language, to infer types of input and
|
||||
output parameters, it relies on parsing the javadoc-style comment
|
||||
block associated with the given function. Usage of xmlrpc native types
|
||||
(such as datetime.dateTime.iso8601 and base64) in the docblock @param
|
||||
tag is also allowed, if you need the php function to receive/send data
|
||||
in that particular format (note that base64 encoding/decoding is
|
||||
transparently carried out by the lib, while datetime vals are passed
|
||||
around as strings).</p><p>Known limitations: requires PHP 5.0.3 +; only works for
|
||||
user-defined functions, not for PHP internal functions (reflection
|
||||
does not support retrieving number/type of params for those); the
|
||||
wrapped php function will not be able to programmatically return an
|
||||
xmlrpc error response.</p><p>If the <code class="literal">return_source</code> optional parameter is
|
||||
set, the function will return the php source code to build the wrapper
|
||||
function, instead of evaluating it (useful to save the code and use it
|
||||
later in a stand-alone xmlrpc server). It will be in the stored in the
|
||||
<code class="literal">source</code> member of the returned array.</p><p>If the <code class="literal">suppress_warnings</code> optional parameter
|
||||
is set, any runtime warning generated while processing the
|
||||
user-defined php function will be catched and not be printed in the
|
||||
generated xml response.</p><p>If the <em class="parameter"><code>extra_options</code></em> array contains the
|
||||
<code class="literal">encode_php_objs</code> value, wrapped functions returning
|
||||
php objects will generate "special" xmlrpc responses: when the xmlrpc
|
||||
decoding of those responses is carried out by this same lib, using the
|
||||
appropriate param in php_xmlrpc_decode(), the objects will be
|
||||
rebuilt.</p><p>In short: php objects can be serialized, too (except for their
|
||||
resource members), using this function. Other libs might choke on the
|
||||
very same xml that will be generated in this case (i.e. it has a
|
||||
nonstandard attribute on struct element tags)</p><p>If the <code class="literal">decode_php_objs</code> optional parameter is
|
||||
set, instances of php objects that have been appropriately encoded by
|
||||
the client using a coordinate option will be deserialized and passed
|
||||
to the user function as php objects instead of simple arrays (the same
|
||||
class definition should be present server side and client
|
||||
side).</p><p><span class="emphasis"><em>Note that this might pose a security risk</em></span>,
|
||||
since in order to rebuild the object instances their constructor
|
||||
method has to be invoked, and this means that the remote client can
|
||||
trigger execution of unforeseen php code on the server: not really a
|
||||
code injection, but almost. Please enable this option only when you
|
||||
trust the remote clients.</p><p>Example usage:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"><?php </span><span style="color: #FF8000">/**<br />* State name from state number decoder. NB: do NOT remove this comment block.<br />* @param integer $stateno the state number<br />* @return string the name of the state (or error description)<br />*/<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">findstate</span><span style="color: #007700">(</span><span style="color: #0000BB">$stateno</span><span style="color: #007700">)<br />{<br /> global </span><span style="color: #0000BB">$stateNames</span><span style="color: #007700">;<br /> if (isset(</span><span style="color: #0000BB">$stateNames</span><span style="color: #007700">[</span><span style="color: #0000BB">$stateno</span><span style="color: #007700">-</span><span style="color: #0000BB">1</span><span style="color: #007700">]))<br /> {<br /> return </span><span style="color: #0000BB">$stateNames</span><span style="color: #007700">[</span><span style="color: #0000BB">$stateno</span><span style="color: #007700">-</span><span style="color: #0000BB">1</span><span style="color: #007700">];<br /> }<br /> else<br /> {<br /> return </span><span style="color: #DD0000">"I don't have a state for the index '" </span><span style="color: #007700">. </span><span style="color: #0000BB">$stateno </span><span style="color: #007700">. </span><span style="color: #DD0000">"'"</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #FF8000">// wrap php function, build xmlrpc server<br /></span><span style="color: #0000BB">$methods </span><span style="color: #007700">= array();<br /></span><span style="color: #0000BB">$findstate_sig </span><span style="color: #007700">= </span><span style="color: #0000BB">wrap_php_function</span><span style="color: #007700">(</span><span style="color: #DD0000">'findstate'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$findstate_sig</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'examples.getStateName'</span><span style="color: #007700">] = </span><span style="color: #0000BB">$findstate_sig</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$srv </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_server</span><span style="color: #007700">(</span><span style="color: #0000BB">$methods</span><span style="color: #007700">);</span>
|
||||
</span>
|
||||
</code></pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch09s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch09.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch09s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Easy use with nested PHP values </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Functions removed from the library</td></tr></table></div></body></html>
|
||||
14
include/limesurvey/admin/classes/xmlrpc/doc/ch09s04.html
Normal file
14
include/limesurvey/admin/classes/xmlrpc/doc/ch09s04.html
Normal file
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Functions removed from the library</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch09.html" title="Chapter 9. Helper functions" /><link rel="prev" href="ch09s03.html" title="Automatic conversion of php functions into xmlrpc methods (and vice versa)" /><link rel="next" href="ch09s05.html" title="Debugging aids" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Functions removed from the library</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch09s03.html">Prev</a> </td><th width="60%" align="center">Chapter 9. Helper functions</th><td width="20%" align="right"> <a accesskey="n" href="ch09s05.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="deprecated"></a>Functions removed from the library</h2></div></div></div><p>The following two functions have been deprecated in version 1.1 of
|
||||
the library, and removed in version 2, in order to avoid conflicts with
|
||||
the EPI xml-rpc library, which also defines two functions with the same
|
||||
names.</p><p>To ease the transition to the new naming scheme and avoid breaking
|
||||
existing implementations, the following scheme has been adopted:
|
||||
</p><div class="itemizedlist"><ul type="disc"><li><p>If EPI-XMLRPC is not active in the current PHP installation,
|
||||
the constant <code class="literal">XMLRPC_EPI_ENABLED</code> will be set to
|
||||
<code class="literal">'0'</code></p></li><li><p>If EPI-XMLRPC is active in the current PHP installation, the
|
||||
constant <code class="literal">XMLRPC_EPI_ENABLED</code> will be set to
|
||||
<code class="literal">'1'</code></p></li></ul></div><p>The following documentation is kept for historical
|
||||
reference:</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="xmlrpcdecode"></a>xmlrpc_decode</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">mixed<b class="fsfunc">xmlrpc_decode</b>(</code></td><td>xmlrpcval<var class="pdparam">$xmlrpc_val</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Alias for php_xmlrpc_decode.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="xmlrpcencode"></a>xmlrpc_encode</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">xmlrpcval<b class="fsfunc">xmlrpc_encode</b>(</code></td><td>mixed<var class="pdparam">$phpval</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Alias for php_xmlrpc_encode.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch09s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch09.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch09s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Automatic conversion of php functions into xmlrpc methods (and
|
||||
vice versa) </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Debugging aids</td></tr></table></div></body></html>
|
||||
8
include/limesurvey/admin/classes/xmlrpc/doc/ch09s05.html
Normal file
8
include/limesurvey/admin/classes/xmlrpc/doc/ch09s05.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Debugging aids</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch09.html" title="Chapter 9. Helper functions" /><link rel="prev" href="ch09s04.html" title="Functions removed from the library" /><link rel="next" href="ch10.html" title="Chapter 10. Reserved methods" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Debugging aids</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch09s04.html">Prev</a> </td><th width="60%" align="center">Chapter 9. Helper functions</th><td width="20%" align="right"> <a accesskey="n" href="ch10.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="debugging"></a>Debugging aids</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id538826"></a>xmlrpc_debugmsg</h3></div></div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void<b class="fsfunc">xmlrpc_debugmsg</b>(</code></td><td>string<var class="pdparam">$debugstring</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Sends the contents of <em class="parameter"><code>$debugstring</code></em> in XML
|
||||
comments in the server return payload. If a PHP client has debugging
|
||||
turned on, the user will be able to see server debug
|
||||
information.</p><p>Use this function in your methods so you can pass back
|
||||
diagnostic information. It is only available from
|
||||
<code class="filename">xmlrpcs.inc</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch09s04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch09.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch10.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Functions removed from the library </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 10. Reserved methods</td></tr></table></div></body></html>
|
||||
12
include/limesurvey/admin/classes/xmlrpc/doc/ch10.html
Normal file
12
include/limesurvey/admin/classes/xmlrpc/doc/ch10.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 10. Reserved methods</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch09s05.html" title="Debugging aids" /><link rel="next" href="ch10s02.html" title="system.listMethods" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 10. Reserved methods</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch09s05.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch10s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="reserved"></a>Chapter 10. Reserved methods</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch10.html#id538930">system.getCapabilities</a></span></dt><dt><span class="sect1"><a href="ch10s02.html">system.listMethods</a></span></dt><dt><span class="sect1"><a href="ch10s03.html">system.methodSignature</a></span></dt><dt><span class="sect1"><a href="ch10s04.html">system.methodHelp</a></span></dt><dt><span class="sect1"><a href="ch10s05.html">system.multicall</a></span></dt></dl></div><p>In order to extend the functionality offered by XML-RPC servers
|
||||
without impacting on the protocol, reserved methods are supported in this
|
||||
release.</p><p>All methods starting with <code class="function">system.</code> are
|
||||
considered reserved by the server. PHP for XML-RPC itself provides four
|
||||
special methods, detailed in this chapter.</p><p>Note that all server objects will automatically respond to clients
|
||||
querying these methods, unless the property
|
||||
<span class="property">allow_system_funcs</span> has been set to
|
||||
<code class="constant">false</code> before calling the
|
||||
<code class="methodname">service()</code> method. This might pose a security risk
|
||||
if the server is exposed to public access, e.g. on the internet.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id538930"></a>system.getCapabilities</h2></div></div></div><p></p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch09s05.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch10s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Debugging aids </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> system.listMethods</td></tr></table></div></body></html>
|
||||
6
include/limesurvey/admin/classes/xmlrpc/doc/ch10s02.html
Normal file
6
include/limesurvey/admin/classes/xmlrpc/doc/ch10s02.html
Normal file
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>system.listMethods</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch10.html" title="Chapter 10. Reserved methods" /><link rel="prev" href="ch10.html" title="Chapter 10. Reserved methods" /><link rel="next" href="ch10s03.html" title="system.methodSignature" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">system.listMethods</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch10.html">Prev</a> </td><th width="60%" align="center">Chapter 10. Reserved methods</th><td width="20%" align="right"> <a accesskey="n" href="ch10s03.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id538940"></a>system.listMethods</h2></div></div></div><p>This method may be used to enumerate the methods implemented by
|
||||
the XML-RPC server.</p><p>The <code class="function">system.listMethods</code> method requires no
|
||||
parameters. It returns an array of strings, each of which is the name of
|
||||
a method implemented by the server.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch10.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch10s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 10. Reserved methods </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> system.methodSignature</td></tr></table></div></body></html>
|
||||
19
include/limesurvey/admin/classes/xmlrpc/doc/ch10s03.html
Normal file
19
include/limesurvey/admin/classes/xmlrpc/doc/ch10s03.html
Normal file
@@ -0,0 +1,19 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>system.methodSignature</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch10.html" title="Chapter 10. Reserved methods" /><link rel="prev" href="ch10s02.html" title="system.listMethods" /><link rel="next" href="ch10s04.html" title="system.methodHelp" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">system.methodSignature</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch10s02.html">Prev</a> </td><th width="60%" align="center">Chapter 10. Reserved methods</th><td width="20%" align="right"> <a accesskey="n" href="ch10s04.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sysmethodsig"></a>system.methodSignature</h2></div></div></div><p>This method takes one parameter, the name of a method implemented
|
||||
by the XML-RPC server.</p><p>It returns an array of possible signatures for this method. A
|
||||
signature is an array of types. The first of these types is the return
|
||||
type of the method, the rest are parameters.</p><p>Multiple signatures (i.e. overloading) are permitted: this is the
|
||||
reason that an array of signatures are returned by this method.</p><p>Signatures themselves are restricted to the top level parameters
|
||||
expected by a method. For instance if a method expects one array of
|
||||
structs as a parameter, and it returns a string, its signature is simply
|
||||
"string, array". If it expects three integers, its signature is "string,
|
||||
int, int, int".</p><p>For parameters that can be of more than one type, the "undefined"
|
||||
string is supported.</p><p>If no signature is defined for the method, a not-array value is
|
||||
returned. Therefore this is the way to test for a non-signature, if
|
||||
<em class="parameter"><code>$resp</code></em> below is the response object from a method
|
||||
call to <code class="function">system.methodSignature</code>:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$v </span><span style="color: #007700">= </span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">();<br />if (</span><span style="color: #0000BB">$v</span><span style="color: #007700">-></span><span style="color: #0000BB">kindOf</span><span style="color: #007700">() != </span><span style="color: #DD0000">"array"</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// then the method did not have a signature defined<br /></span><span style="color: #007700">}</span>
|
||||
</span>
|
||||
</code></pre><p>See the <code class="filename">introspect.php</code> demo included in this
|
||||
distribution for an example of using this method.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch10.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch10s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">system.listMethods </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> system.methodHelp</td></tr></table></div></body></html>
|
||||
6
include/limesurvey/admin/classes/xmlrpc/doc/ch10s04.html
Normal file
6
include/limesurvey/admin/classes/xmlrpc/doc/ch10s04.html
Normal file
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>system.methodHelp</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch10.html" title="Chapter 10. Reserved methods" /><link rel="prev" href="ch10s03.html" title="system.methodSignature" /><link rel="next" href="ch10s05.html" title="system.multicall" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">system.methodHelp</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch10s03.html">Prev</a> </td><th width="60%" align="center">Chapter 10. Reserved methods</th><td width="20%" align="right"> <a accesskey="n" href="ch10s05.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sysmethhelp"></a>system.methodHelp</h2></div></div></div><p>This method takes one parameter, the name of a method implemented
|
||||
by the XML-RPC server.</p><p>It returns a documentation string describing the use of that
|
||||
method. If no such string is available, an empty string is
|
||||
returned.</p><p>The documentation string may contain HTML markup.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch10.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch10s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">system.methodSignature </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> system.multicall</td></tr></table></div></body></html>
|
||||
10
include/limesurvey/admin/classes/xmlrpc/doc/ch10s05.html
Normal file
10
include/limesurvey/admin/classes/xmlrpc/doc/ch10s05.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>system.multicall</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch10.html" title="Chapter 10. Reserved methods" /><link rel="prev" href="ch10s04.html" title="system.methodHelp" /><link rel="next" href="ch11.html" title="Chapter 11. Examples" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">system.multicall</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch10s04.html">Prev</a> </td><th width="60%" align="center">Chapter 10. Reserved methods</th><td width="20%" align="right"> <a accesskey="n" href="ch11.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539069"></a>system.multicall</h2></div></div></div><p>This method takes one parameter, an array of 'request' struct
|
||||
types. Each request struct must contain a
|
||||
<em class="parameter"><code>methodName</code></em> member of type string and a
|
||||
<em class="parameter"><code>params</code></em> member of type array, and corresponds to
|
||||
the invocation of the corresponding method.</p><p>It returns a response of type array, with each value of the array
|
||||
being either an error struct (containing the faultCode and faultString
|
||||
members) or the successful response value of the corresponding single
|
||||
method call.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10s04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch10.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch11.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">system.methodHelp </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 11. Examples</td></tr></table></div></body></html>
|
||||
8
include/limesurvey/admin/classes/xmlrpc/doc/ch11.html
Normal file
8
include/limesurvey/admin/classes/xmlrpc/doc/ch11.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 11. Examples</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch10s05.html" title="system.multicall" /><link rel="next" href="ch11s02.html" title="Executing a multicall call" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 11. Examples</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch10s05.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch11s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="examples"></a>Chapter 11. Examples</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch11.html#statename">XML-RPC client: state name query</a></span></dt><dt><span class="sect1"><a href="ch11s02.html">Executing a multicall call</a></span></dt></dl></div><p>The best examples are to be found in the sample files included with
|
||||
the distribution. Some are included here.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="statename"></a>XML-RPC client: state name query</h2></div></div></div><p>Code to get the corresponding state name from a number (1-50) from
|
||||
the demo server available on SourceForge</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB"> $m </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpcmsg</span><span style="color: #007700">(</span><span style="color: #DD0000">'examples.getStateName'</span><span style="color: #007700">,<br /> array(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #0000BB">$HTTP_POST_VARS</span><span style="color: #007700">[</span><span style="color: #DD0000">"stateno"</span><span style="color: #007700">], </span><span style="color: #DD0000">"int"</span><span style="color: #007700">)));<br /> </span><span style="color: #0000BB">$c </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #DD0000">"/server.php"</span><span style="color: #007700">, </span><span style="color: #DD0000">"phpxmlrpc.sourceforge.net"</span><span style="color: #007700">, </span><span style="color: #0000BB">80</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$r </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(</span><span style="color: #0000BB">$m</span><span style="color: #007700">);<br /> if (!</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">$v </span><span style="color: #007700">= </span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">();<br /> print </span><span style="color: #DD0000">"State number " </span><span style="color: #007700">. </span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$HTTP_POST_VARS</span><span style="color: #007700">[</span><span style="color: #DD0000">"stateno"</span><span style="color: #007700">]) . </span><span style="color: #DD0000">" is " </span><span style="color: #007700">.<br /> </span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$v</span><span style="color: #007700">-></span><span style="color: #0000BB">scalarval</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"<BR>"</span><span style="color: #007700">;<br /> print </span><span style="color: #DD0000">"<HR>I got this value back<BR><PRE>" </span><span style="color: #007700">.<br /> </span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">serialize</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"</PRE><HR>\n"</span><span style="color: #007700">;<br /> } else {<br /> print </span><span style="color: #DD0000">"Fault <BR>"</span><span style="color: #007700">;<br /> print </span><span style="color: #DD0000">"Code: " </span><span style="color: #007700">. </span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"<BR>" </span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">"Reason: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">faultString</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"'<BR>"</span><span style="color: #007700">;<br /> }</span>
|
||||
</span>
|
||||
</code></pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10s05.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch11s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">system.multicall </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Executing a multicall call</td></tr></table></div></body></html>
|
||||
3
include/limesurvey/admin/classes/xmlrpc/doc/ch11s02.html
Normal file
3
include/limesurvey/admin/classes/xmlrpc/doc/ch11s02.html
Normal file
@@ -0,0 +1,3 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Executing a multicall call</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch11.html" title="Chapter 11. Examples" /><link rel="prev" href="ch11.html" title="Chapter 11. Examples" /><link rel="next" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Executing a multicall call</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch11.html">Prev</a> </td><th width="60%" align="center">Chapter 11. Examples</th><td width="20%" align="right"> <a accesskey="n" href="ch12.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539155"></a>Executing a multicall call</h2></div></div></div><p>To be documented...</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch11.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch11.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 11. Examples </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 12. Frequently Asked Questions</td></tr></table></div></body></html>
|
||||
21
include/limesurvey/admin/classes/xmlrpc/doc/ch12.html
Normal file
21
include/limesurvey/admin/classes/xmlrpc/doc/ch12.html
Normal file
@@ -0,0 +1,21 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 12. Frequently Asked Questions</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="index.html" title="XML-RPC for PHP" /><link rel="prev" href="ch11s02.html" title="Executing a multicall call" /><link rel="next" href="ch12s02.html" title="Is there any limitation on the size of the requests / responses that can be successfully sent?" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 12. Frequently Asked Questions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch11s02.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch12s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="faq"></a>Chapter 12. Frequently Asked Questions</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch12.html#id539177">How to send custom XML as payload of a method call</a></span></dt><dt><span class="sect1"><a href="ch12s02.html">Is there any limitation on the size of the requests / responses
|
||||
that can be successfully sent?</a></span></dt><dt><span class="sect1"><a href="ch12s03.html">My server (client) returns an error whenever the client (server)
|
||||
returns accented characters</a></span></dt><dt><span class="sect1"><a href="ch12s04.html">My php error log is getting full of "deprecated" errors on
|
||||
different lines of xmlrpc.inc and xmlrpcs.inc</a></span></dt><dt><span class="sect1"><a href="ch12s05.html">How to enable long-lasting method calls</a></span></dt><dt><span class="sect1"><a href="ch12s06.html">My client returns "XML-RPC Fault #2: Invalid return payload:
|
||||
enable debugging to examine incoming payload": what should I do?</a></span></dt><dt><span class="sect1"><a href="ch12s07.html">How can I save to a file the xml of the xmlrpc responses received
|
||||
from servers?</a></span></dt><dt><span class="sect1"><a href="ch12s08.html">Can I use the ms windows character set?</a></span></dt><dt><span class="sect1"><a href="ch12s09.html">Does the library support using cookies / http sessions?</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539177"></a>How to send custom XML as payload of a method call</h2></div></div></div><p>Unfortunately, at the time the XML-RPC spec was designed, support
|
||||
for namespaces in XML was not as ubiquitous as it is now. As a
|
||||
consequence, no support was provided in the protocol for embedding XML
|
||||
elements from other namespaces into an xmlrpc request.</p><p>To send an XML "chunk" as payload of a method call or response,
|
||||
two options are available: either send the complete XML block as a
|
||||
string xmlrpc value, or as a base64 value. Since the '<' character in
|
||||
string values is encoded as '&lt;' in the xml payload of the method
|
||||
call, the XML string will not break the surrounding xmlrpc, unless
|
||||
characters outside of the assumed character set are used. The second
|
||||
method has the added benefits of working independently of the charset
|
||||
encoding used for the xml to be transmitted, and preserving exactly
|
||||
whitespace, whilst incurring in some extra message length and cpu load
|
||||
(for carrying out the base64 encoding/decoding).</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch11s02.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch12s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Executing a multicall call </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Is there any limitation on the size of the requests / responses
|
||||
that can be successfully sent?</td></tr></table></div></body></html>
|
||||
18
include/limesurvey/admin/classes/xmlrpc/doc/ch12s02.html
Normal file
18
include/limesurvey/admin/classes/xmlrpc/doc/ch12s02.html
Normal file
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Is there any limitation on the size of the requests / responses that can be successfully sent?</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="next" href="ch12s03.html" title="My server (client) returns an error whenever the client (server) returns accented characters" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Is there any limitation on the size of the requests / responses
|
||||
that can be successfully sent?</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s03.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539226"></a>Is there any limitation on the size of the requests / responses
|
||||
that can be successfully sent?</h2></div></div></div><p>Yes. But I have no hard figure to give; it most likely will depend
|
||||
on the version of PHP in usage and its configuration.</p><p>Keep in mind that this library is not optimized for speed nor for
|
||||
memory usage. Better alternatives exist when there are strict
|
||||
requirements on throughput or resource usage, such as the php native
|
||||
xmlrpc extension (see the PHP manual for more information).</p><p>Keep in mind also that HTTP is probably not the best choice in
|
||||
such a situation, and XML is a deadly enemy. CSV formatted data over
|
||||
socket would be much more efficient.</p><p>If you really need to move a massive amount of data around, and
|
||||
you are crazy enough to do it using phpxmlrpc, your best bet is to
|
||||
bypass usage of the xmlrpcval objects, at least in the decoding phase,
|
||||
and have the server (or client) object return to the calling function
|
||||
directly php values (see <code class="varname">xmlrpc_client::return_type</code>
|
||||
and <code class="varname">xmlrpc_server::functions_parameters_type</code> for more
|
||||
details).</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 12. Frequently Asked Questions </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> My server (client) returns an error whenever the client (server)
|
||||
returns accented characters</td></tr></table></div></body></html>
|
||||
7
include/limesurvey/admin/classes/xmlrpc/doc/ch12s03.html
Normal file
7
include/limesurvey/admin/classes/xmlrpc/doc/ch12s03.html
Normal file
@@ -0,0 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>My server (client) returns an error whenever the client (server) returns accented characters</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s02.html" title="Is there any limitation on the size of the requests / responses that can be successfully sent?" /><link rel="next" href="ch12s04.html" title="My php error log is getting full of "deprecated" errors on different lines of xmlrpc.inc and xmlrpcs.inc" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">My server (client) returns an error whenever the client (server)
|
||||
returns accented characters</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s02.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s04.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539275"></a>My server (client) returns an error whenever the client (server)
|
||||
returns accented characters</h2></div></div></div><p>To be documented...</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Is there any limitation on the size of the requests / responses
|
||||
that can be successfully sent? </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> My php error log is getting full of "deprecated" errors on
|
||||
different lines of xmlrpc.inc and xmlrpcs.inc</td></tr></table></div></body></html>
|
||||
11
include/limesurvey/admin/classes/xmlrpc/doc/ch12s04.html
Normal file
11
include/limesurvey/admin/classes/xmlrpc/doc/ch12s04.html
Normal file
@@ -0,0 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>My php error log is getting full of "deprecated" errors on different lines of xmlrpc.inc and xmlrpcs.inc</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s03.html" title="My server (client) returns an error whenever the client (server) returns accented characters" /><link rel="next" href="ch12s05.html" title="How to enable long-lasting method calls" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">My php error log is getting full of "deprecated" errors on
|
||||
different lines of xmlrpc.inc and xmlrpcs.inc</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s03.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s05.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539289"></a>My php error log is getting full of "deprecated" errors on
|
||||
different lines of xmlrpc.inc and xmlrpcs.inc</h2></div></div></div><p>This happens when the PHP in usage is version 5, and the error
|
||||
reporting level is set to include <code class="constant">E_STRICT</code> errors.
|
||||
Since the main development platform of the library remains (for the time
|
||||
being) PHP 4, there are no plans to fix this asap. The best workaround
|
||||
is to set the error reporting level to <code class="constant">E_ALL ^
|
||||
E_STRICT</code>.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">My server (client) returns an error whenever the client (server)
|
||||
returns accented characters </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> How to enable long-lasting method calls</td></tr></table></div></body></html>
|
||||
5
include/limesurvey/admin/classes/xmlrpc/doc/ch12s05.html
Normal file
5
include/limesurvey/admin/classes/xmlrpc/doc/ch12s05.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>How to enable long-lasting method calls</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s04.html" title="My php error log is getting full of "deprecated" errors on different lines of xmlrpc.inc and xmlrpcs.inc" /><link rel="next" href="ch12s06.html" title="My client returns "XML-RPC Fault #2: Invalid return payload: enable debugging to examine incoming payload": what should I do?" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">How to enable long-lasting method calls</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s04.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s06.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539315"></a>How to enable long-lasting method calls</h2></div></div></div><p>To be documented...</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">My php error log is getting full of "deprecated" errors on
|
||||
different lines of xmlrpc.inc and xmlrpcs.inc </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> My client returns "XML-RPC Fault #2: Invalid return payload:
|
||||
enable debugging to examine incoming payload": what should I do?</td></tr></table></div></body></html>
|
||||
13
include/limesurvey/admin/classes/xmlrpc/doc/ch12s06.html
Normal file
13
include/limesurvey/admin/classes/xmlrpc/doc/ch12s06.html
Normal file
@@ -0,0 +1,13 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>My client returns "XML-RPC Fault #2: Invalid return payload: enable debugging to examine incoming payload": what should I do?</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s05.html" title="How to enable long-lasting method calls" /><link rel="next" href="ch12s07.html" title="How can I save to a file the xml of the xmlrpc responses received from servers?" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">My client returns "XML-RPC Fault #2: Invalid return payload:
|
||||
enable debugging to examine incoming payload": what should I do?</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s05.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s07.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539327"></a>My client returns "XML-RPC Fault #2: Invalid return payload:
|
||||
enable debugging to examine incoming payload": what should I do?</h2></div></div></div><p>The response you are seeing is a default error response that the
|
||||
client object returns to the php application when the server did not
|
||||
respond to the call with a valid xmlrpc response.</p><p>The most likely cause is that you are not using the correct URL
|
||||
when creating the client object, or you do not have appropriate access
|
||||
rights to the web page you are requesting, or some other common http
|
||||
misconfiguration.</p><p>To find out what the server is really returning to your client,
|
||||
you have to enable the debug mode of the client, using
|
||||
$client->setdebug(1);</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s05.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">How to enable long-lasting method calls </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> How can I save to a file the xml of the xmlrpc responses received
|
||||
from servers?</td></tr></table></div></body></html>
|
||||
27
include/limesurvey/admin/classes/xmlrpc/doc/ch12s07.html
Normal file
27
include/limesurvey/admin/classes/xmlrpc/doc/ch12s07.html
Normal file
@@ -0,0 +1,27 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>How can I save to a file the xml of the xmlrpc responses received from servers?</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s06.html" title="My client returns "XML-RPC Fault #2: Invalid return payload: enable debugging to examine incoming payload": what should I do?" /><link rel="next" href="ch12s08.html" title="Can I use the ms windows character set?" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">How can I save to a file the xml of the xmlrpc responses received
|
||||
from servers?</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s06.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s08.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539360"></a>How can I save to a file the xml of the xmlrpc responses received
|
||||
from servers?</h2></div></div></div><p>If what you need is to save the responses received from the server
|
||||
as xml, you have two options:</p><p>1- use the serialize() method on the response object.</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$resp </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(</span><span style="color: #0000BB">$msg</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">())<br /> </span><span style="color: #0000BB">$data_to_be_saved </span><span style="color: #007700">= </span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">serialize</span><span style="color: #007700">();</span>
|
||||
</span>
|
||||
</code></pre><p>Note that this will not be 100% accurate, since the xml generated
|
||||
by the response object can be different from the xml received,
|
||||
especially if there is some character set conversion involved, or such
|
||||
(eg. if you receive an empty string tag as <string/>, serialize()
|
||||
will output <string></string>), or if the server sent back
|
||||
as response something invalid (in which case the xml generated client
|
||||
side using serialize() will correspond to the error response generated
|
||||
internally by the lib).</p><p>2 - set the client object to return the raw xml received instead
|
||||
of the decoded objects:</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">xmlrpc_client</span><span style="color: #007700">(</span><span style="color: #0000BB">$url</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">return_type </span><span style="color: #007700">= </span><span style="color: #DD0000">'xml'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$resp </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(</span><span style="color: #0000BB">$msg</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">())<br /> </span><span style="color: #0000BB">$data_to_be_saved </span><span style="color: #007700">= </span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">();</span>
|
||||
</span>
|
||||
</code></pre><p>Note that using this method the xml response response will not be
|
||||
parsed at all by the library, only the http communication protocol will
|
||||
be checked. This means that xmlrpc responses sent by the server that
|
||||
would have generated an error response on the client (eg. malformed xml,
|
||||
responses that have faultcode set, etc...) now will not be flagged as
|
||||
invalid, and you might end up saving not valid xml but random
|
||||
junk...</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s06.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s08.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">My client returns "XML-RPC Fault #2: Invalid return payload:
|
||||
enable debugging to examine incoming payload": what should I do? </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Can I use the ms windows character set?</td></tr></table></div></body></html>
|
||||
22
include/limesurvey/admin/classes/xmlrpc/doc/ch12s08.html
Normal file
22
include/limesurvey/admin/classes/xmlrpc/doc/ch12s08.html
Normal file
@@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Can I use the ms windows character set?</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s07.html" title="How can I save to a file the xml of the xmlrpc responses received from servers?" /><link rel="next" href="ch12s09.html" title="Does the library support using cookies / http sessions?" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Can I use the ms windows character set?</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s07.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="ch12s09.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539442"></a>Can I use the ms windows character set?</h2></div></div></div><p>If the data your application is using comes from a Microsoft
|
||||
application, there are some chances that the character set used to
|
||||
encode it is CP1252 (the same might apply to data received from an
|
||||
external xmlrpc server/client, but it is quite rare to find xmlrpc
|
||||
toolkits that encode to CP1252 instead of UTF8). It is a character set
|
||||
which is "almost" compatible with ISO 8859-1, but for a few extra
|
||||
characters.</p><p>PHP-XMLRPC only supports the ISO 8859-1 and UTF8 character sets.
|
||||
The net result of this situation is that those extra characters will not
|
||||
be properly encoded, and will be received at the other end of the
|
||||
XML-RPC tranmission as "garbled data". Unfortunately the library cannot
|
||||
provide real support for CP1252 because of limitations in the PHP 4 xml
|
||||
parser. Luckily, we tried our best to support this character set anyway,
|
||||
and, since version 2.2.1, there is some form of support, left commented
|
||||
in the code.</p><p>To properly encode outgoing data that is natively in CP1252, you
|
||||
will have to uncomment all relative code in the file
|
||||
<code class="filename">xmlrpc.inc</code> (you can search for the string "1252"),
|
||||
then set <code class="code">$GLOBALS['xmlrpc_internalencoding']='CP1252';</code>
|
||||
Please note that all incoming data will then be fed to your application
|
||||
as UTF-8 to avoid any potentail data loss.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s07.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s09.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">How can I save to a file the xml of the xmlrpc responses received
|
||||
from servers? </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Does the library support using cookies / http sessions?</td></tr></table></div></body></html>
|
||||
13
include/limesurvey/admin/classes/xmlrpc/doc/ch12s09.html
Normal file
13
include/limesurvey/admin/classes/xmlrpc/doc/ch12s09.html
Normal file
@@ -0,0 +1,13 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Does the library support using cookies / http sessions?</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="up" href="ch12.html" title="Chapter 12. Frequently Asked Questions" /><link rel="prev" href="ch12s08.html" title="Can I use the ms windows character set?" /><link rel="next" href="apa.html" title="Appendix A. Integration with the PHP xmlrpc extension" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Does the library support using cookies / http sessions?</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12s08.html">Prev</a> </td><th width="60%" align="center">Chapter 12. Frequently Asked Questions</th><td width="20%" align="right"> <a accesskey="n" href="apa.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id539485"></a>Does the library support using cookies / http sessions?</h2></div></div></div><p>In short: yes, but a little coding is needed to make it
|
||||
happen.</p><p>The code below uses sessions to e.g. let the client store a value
|
||||
on the server and retrieve it later.</p><pre class="programlisting"><code><span style="color: #000000">
|
||||
<span style="color: #0000BB">$resp </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(new </span><span style="color: #0000BB">xmlrpcmsg</span><span style="color: #007700">(</span><span style="color: #DD0000">'registervalue'</span><span style="color: #007700">, array(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">), new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">'bar'</span><span style="color: #007700">))));<br />if (!</span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">faultCode</span><span style="color: #007700">())<br />{<br /> </span><span style="color: #0000BB">$cookies </span><span style="color: #007700">= </span><span style="color: #0000BB">$resp</span><span style="color: #007700">-></span><span style="color: #0000BB">cookies</span><span style="color: #007700">();<br /> if (</span><span style="color: #0000BB">array_key_exists</span><span style="color: #007700">(</span><span style="color: #DD0000">'PHPSESSID'</span><span style="color: #007700">, </span><span style="color: #0000BB">$cookies</span><span style="color: #007700">)) </span><span style="color: #FF8000">// nb: make sure to use the correct session cookie name<br /> </span><span style="color: #007700">{<br /> </span><span style="color: #0000BB">$session_id </span><span style="color: #007700">= </span><span style="color: #0000BB">$cookies</span><span style="color: #007700">[</span><span style="color: #DD0000">'PHPSESSID'</span><span style="color: #007700">][</span><span style="color: #DD0000">'value'</span><span style="color: #007700">];<br /><br /> </span><span style="color: #FF8000">// do some other stuff here...<br /><br /> </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">setcookie</span><span style="color: #007700">(</span><span style="color: #DD0000">'PHPSESSID'</span><span style="color: #007700">, </span><span style="color: #0000BB">$session_id</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(new </span><span style="color: #0000BB">xmlrpcmsg</span><span style="color: #007700">(</span><span style="color: #DD0000">'getvalue'</span><span style="color: #007700">, array(new </span><span style="color: #0000BB">xmlrpcval</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">)));<br /> }<br />}</span>
|
||||
</span>
|
||||
</code></pre><p>Server-side sessions are handled normally like in any other
|
||||
php application. Please see the php manual for more information about
|
||||
sessions.</p><p>NB: unlike web browsers, not all xmlrpc clients support usage of
|
||||
http cookies. If you have troubles with sessions and control only the
|
||||
server side of the communication, please check with the makers of the
|
||||
xmlrpc client in use.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12s08.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="apa.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Can I use the ms windows character set? </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix A. Integration with the PHP xmlrpc extension</td></tr></table></div></body></html>
|
||||
33
include/limesurvey/admin/classes/xmlrpc/doc/index.html
Normal file
33
include/limesurvey/admin/classes/xmlrpc/doc/index.html
Normal file
@@ -0,0 +1,33 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>XML-RPC for PHP</title><link rel="stylesheet" href="xmlrpc.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /><link rel="home" href="index.html" title="XML-RPC for PHP" /><link rel="next" href="ch01.html" title="Chapter 1. Introduction" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">XML-RPC for PHP</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr /></div><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id530463"></a>XML-RPC for PHP</h1></div><div><h2 class="subtitle">version 2.2.2</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Edd</span> <span class="surname">Dumbill</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Gaetano</span> <span class="surname">Giunta</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Miles</span> <span class="surname">Lott</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Justin R.</span> <span class="surname">Miller</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Andres</span> <span class="surname">Salomon</span></h3></div></div></div><div><p class="copyright">Copyright © 1999,2000,2001 Edd Dumbill, Useful Information Company</p></div><div><div class="legalnotice"><a id="id530557"></a><p>All rights reserved.</p><p>Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:</p><div class="itemizedlist"><ul type="disc"><li><p>Redistributions of source code must retain the above
|
||||
copyright notice, this list of conditions and the following
|
||||
disclaimer.</p></li><li><p>Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following
|
||||
disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.</p></li><li><p>Neither the name of the "XML-RPC for PHP" nor the names of
|
||||
its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written
|
||||
permission.</p></li></ul></div><p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
|
||||
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
||||
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
||||
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p></div></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch01.html#id530427">Acknowledgements</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch02.html">2. What's new</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch02.html#id530725">2.2.2</a></span></dt><dt><span class="sect1"><a href="ch02s02.html">2.2.1</a></span></dt><dt><span class="sect1"><a href="ch02s03.html">2.2</a></span></dt><dt><span class="sect1"><a href="ch02s04.html">2.1</a></span></dt><dt><span class="sect1"><a href="ch02s05.html">2.0 final</a></span></dt><dt><span class="sect1"><a href="ch02s06.html">2.0 Release candidate 3</a></span></dt><dt><span class="sect1"><a href="ch02s07.html">2.0 Release candidate 2</a></span></dt><dt><span class="sect1"><a href="ch02s08.html">2.0 Release candidate 1</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. System Requirements</a></span></dt><dt><span class="chapter"><a href="ch04.html">4. Files in the distribution</a></span></dt><dt><span class="chapter"><a href="ch05.html">5. Known bugs and limitations</a></span></dt><dt><span class="chapter"><a href="ch06.html">6. Support</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch06.html#id532511">Online Support</a></span></dt><dt><span class="sect1"><a href="ch06s02.html">The Jellyfish Book</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Class documentation</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch07.html#xmlrpcval">xmlrpcval</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07.html#id532737">Notes on types</a></span></dt><dt><span class="sect2"><a href="ch07.html#xmlrpcval-creation">Creation</a></span></dt><dt><span class="sect2"><a href="ch07.html#xmlrpcval-methods">Methods</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s02.html">xmlrpcmsg</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s02.html#id533915">Creation</a></span></dt><dt><span class="sect2"><a href="ch07s02.html#id534023">Methods</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s03.html">xmlrpc_client</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s03.html#id534351">Creation</a></span></dt><dt><span class="sect2"><a href="ch07s03.html#id534519">Methods</a></span></dt><dt><span class="sect2"><a href="ch07s03.html#id535945">Variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s04.html">xmlrpcresp</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s04.html#id536087">Creation</a></span></dt><dt><span class="sect2"><a href="ch07s04.html#id536184">Methods</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch07s05.html">xmlrpc_server</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch07s05.html#id536404">Method handler functions</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536497">The dispatch map</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#signatures">Method signatures</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536731">Delaying the server response</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536813">Modifying the server behaviour</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id536919">Fault reporting</a></span></dt><dt><span class="sect2"><a href="ch07s05.html#id537184">'New style' servers</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch08.html">8. Global variables</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch08.html#id537293">"Constant" variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch08.html#id537299">$xmlrpcerruser</a></span></dt><dt><span class="sect2"><a href="ch08.html#id537324">$xmlrpcI4, $xmlrpcInt, $xmlrpcBoolean, $xmlrpcDouble,
|
||||
$xmlrpcString, $xmlrpcDateTime, $xmlrpcBase64, $xmlrpcArray,
|
||||
$xmlrpcStruct, $xmlrpcValue, $xmlrpcNull</a></span></dt><dt><span class="sect2"><a href="ch08.html#id537349">$xmlrpcTypes, $xmlrpc_valid_parents, $xmlrpcerr, $xmlrpcstr,
|
||||
$xmlrpcerrxml, $xmlrpc_backslash, $_xh, $xml_iso88591_Entities,
|
||||
$xmlEntities, $xmlrpcs_capabilities</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch08s02.html">Variables whose value can be modified</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch08s02.html#xmlrpc-defencoding">xmlrpc_defencoding</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537432">xmlrpc_internalencoding</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537504">xmlrpcName</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537530">xmlrpcVersion</a></span></dt><dt><span class="sect2"><a href="ch08s02.html#id537557">xmlrpc_null_extension</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch09.html">9. Helper functions</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch09.html#id537600">Date functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09.html#iso8601encode">iso8601_encode</a></span></dt><dt><span class="sect2"><a href="ch09.html#iso8601decode">iso8601_decode</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s02.html">Easy use with nested PHP values</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s02.html#phpxmlrpcdecode">php_xmlrpc_decode</a></span></dt><dt><span class="sect2"><a href="ch09s02.html#phpxmlrpcencode">php_xmlrpc_encode</a></span></dt><dt><span class="sect2"><a href="ch09s02.html#id538134">php_xmlrpc_decode_xml</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s03.html">Automatic conversion of php functions into xmlrpc methods (and
|
||||
vice versa)</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s03.html#id538228">wrap_xmlrpc_method</a></span></dt><dt><span class="sect2"><a href="ch09s03.html#wrap_php_function">wrap_php_function</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s04.html">Functions removed from the library</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s04.html#xmlrpcdecode">xmlrpc_decode</a></span></dt><dt><span class="sect2"><a href="ch09s04.html#xmlrpcencode">xmlrpc_encode</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch09s05.html">Debugging aids</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch09s05.html#id538826">xmlrpc_debugmsg</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch10.html">10. Reserved methods</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch10.html#id538930">system.getCapabilities</a></span></dt><dt><span class="sect1"><a href="ch10s02.html">system.listMethods</a></span></dt><dt><span class="sect1"><a href="ch10s03.html">system.methodSignature</a></span></dt><dt><span class="sect1"><a href="ch10s04.html">system.methodHelp</a></span></dt><dt><span class="sect1"><a href="ch10s05.html">system.multicall</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch11.html">11. Examples</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch11.html#statename">XML-RPC client: state name query</a></span></dt><dt><span class="sect1"><a href="ch11s02.html">Executing a multicall call</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch12.html">12. Frequently Asked Questions</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch12.html#id539177">How to send custom XML as payload of a method call</a></span></dt><dt><span class="sect1"><a href="ch12s02.html">Is there any limitation on the size of the requests / responses
|
||||
that can be successfully sent?</a></span></dt><dt><span class="sect1"><a href="ch12s03.html">My server (client) returns an error whenever the client (server)
|
||||
returns accented characters</a></span></dt><dt><span class="sect1"><a href="ch12s04.html">My php error log is getting full of "deprecated" errors on
|
||||
different lines of xmlrpc.inc and xmlrpcs.inc</a></span></dt><dt><span class="sect1"><a href="ch12s05.html">How to enable long-lasting method calls</a></span></dt><dt><span class="sect1"><a href="ch12s06.html">My client returns "XML-RPC Fault #2: Invalid return payload:
|
||||
enable debugging to examine incoming payload": what should I do?</a></span></dt><dt><span class="sect1"><a href="ch12s07.html">How can I save to a file the xml of the xmlrpc responses received
|
||||
from servers?</a></span></dt><dt><span class="sect1"><a href="ch12s08.html">Can I use the ms windows character set?</a></span></dt><dt><span class="sect1"><a href="ch12s09.html">Does the library support using cookies / http sessions?</a></span></dt></dl></dd><dt><span class="appendix"><a href="apa.html">A. Integration with the PHP xmlrpc extension</a></span></dt><dt><span class="appendix"><a href="apb.html">B. Substitution of the PHP xmlrpc extension</a></span></dt><dt><span class="appendix"><a href="apc.html">C. 'Enough of xmlrpcvals!': new style library usage</a></span></dt><dt><span class="appendix"><a href="apd.html">D. Usage of the debugger</a></span></dt></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></body></html>
|
||||
BIN
include/limesurvey/admin/classes/xmlrpc/doc/xmlrpc_php.pdf
Normal file
BIN
include/limesurvey/admin/classes/xmlrpc/doc/xmlrpc_php.pdf
Normal file
Binary file not shown.
4115
include/limesurvey/admin/classes/xmlrpc/doc/xmlrpc_php.xml
Normal file
4115
include/limesurvey/admin/classes/xmlrpc/doc/xmlrpc_php.xml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,9 @@
|
||||
-----BEGIN RSA PRIVATE KEY-----
|
||||
MIIBOgIBAAJBAM12w6/J20HMj0V9VC24xPFQG9RKSDt8vmviM+tnc1BgCrzPyF1v
|
||||
3/rWGoWDjkJrE9WFOeqIjJHeEWWT4uKq2ZkCAwEAAQJAZZYJ7Nld+et9DvuHak/H
|
||||
uBRGnjDYA+mKcObXitWMUzk2ZodL8UoCP1J9kKqV8Zp/l2cBZkLo0aWTN94sWkHy
|
||||
rQIhAOhxWxRXSZ4kArIQqZnDG9JgtOAeaaFso/zpxIHpN6OrAiEA4klzl+rUc32/
|
||||
7SDcJYa9j5vehp1jCTnkN+n0rujTM8sCIAGwMRUovSQk5tAcRt8TB7SzdxzZm7LM
|
||||
czR3DjJTW1AZAiEAlYN+svPgJ+cAdwdtLgZXHZoZb8xx8Vik6CTXHPKNCf0CIBQL
|
||||
zF4Qp8/C+gjsXtEZJvhxY7i1luHn6iNwNnE932r3
|
||||
-----END RSA PRIVATE KEY-----
|
||||
52
include/limesurvey/admin/classes/xmlrpc/extras/test.pl
Normal file
52
include/limesurvey/admin/classes/xmlrpc/extras/test.pl
Normal file
@@ -0,0 +1,52 @@
|
||||
#!/usr/local/bin/perl
|
||||
|
||||
use Frontier::Client;
|
||||
|
||||
my $serverURL='http://phpxmlrpc.sourceforge.net/server.php';
|
||||
|
||||
# try the simplest example
|
||||
|
||||
my $client = Frontier::Client->new( 'url' => $serverURL,
|
||||
'debug' => 0, 'encoding' => 'iso-8859-1' );
|
||||
my $resp = $client->call("examples.getStateName", 32);
|
||||
|
||||
print "Got '${resp}'\n";
|
||||
|
||||
# now send a mail to nobody in particular
|
||||
|
||||
$resp = $client->call("mail.send", ("edd", "Test",
|
||||
"Bonjour. Je m'appelle Gérard. Mañana. ", "freddy", "", "",
|
||||
'text/plain; charset="iso-8859-1"'));
|
||||
|
||||
if ($resp->value()) {
|
||||
print "Mail sent OK.\n";
|
||||
} else {
|
||||
print "Error sending mail.\n";
|
||||
}
|
||||
|
||||
# test echoing of characters works fine
|
||||
|
||||
$resp = $client->call("examples.echo", 'Three "blind" mice - ' .
|
||||
"See 'how' they run");
|
||||
print $resp . "\n";
|
||||
|
||||
# test name and age example. this exercises structs and arrays
|
||||
|
||||
$resp = $client->call("examples.sortByAge",
|
||||
[ { 'name' => 'Dave', 'age' => 35},
|
||||
{ 'name' => 'Edd', 'age' => 45 },
|
||||
{ 'name' => 'Fred', 'age' => 23 },
|
||||
{ 'name' => 'Barney', 'age' => 36 } ] );
|
||||
|
||||
my $e;
|
||||
foreach $e (@$resp) {
|
||||
print $$e{'name'} . ", " . $$e{'age'} . "\n";
|
||||
}
|
||||
|
||||
# test base64
|
||||
|
||||
$resp = $client->call("examples.decode64",
|
||||
$client->base64("TWFyeSBoYWQgYSBsaXR0bGUgbGFtYiBTaGUgd" .
|
||||
"GllZCBpdCB0byBhIHB5bG9u"));
|
||||
|
||||
print $resp . "\n";
|
||||
37
include/limesurvey/admin/classes/xmlrpc/extras/test.py
Normal file
37
include/limesurvey/admin/classes/xmlrpc/extras/test.py
Normal file
@@ -0,0 +1,37 @@
|
||||
#!/usr/local/bin/python
|
||||
|
||||
from xmlrpclib import *
|
||||
import sys
|
||||
|
||||
server = Server("http://phpxmlrpc.sourceforge.net/server.php")
|
||||
|
||||
try:
|
||||
print "Got '" + server.examples.getStateName(32) + "'"
|
||||
|
||||
r = server.mail.send("edd", "Test",
|
||||
"Bonjour. Je m'appelle Gérard. Mañana. ", "freddy", "", "",
|
||||
'text/plain; charset="iso-8859-1"')
|
||||
if r:
|
||||
print "Mail sent OK"
|
||||
else:
|
||||
print "Error sending mail"
|
||||
|
||||
|
||||
r = server.examples.echo('Three "blind" mice - ' + "See 'how' they run")
|
||||
print r
|
||||
|
||||
# name/age example. this exercises structs and arrays
|
||||
|
||||
a = [ {'name': 'Dave', 'age': 35}, {'name': 'Edd', 'age': 45 },
|
||||
{'name': 'Fred', 'age': 23}, {'name': 'Barney', 'age': 36 }]
|
||||
r = server.examples.sortByAge(a)
|
||||
print r
|
||||
|
||||
# test base 64
|
||||
b = Binary("Mary had a little lamb She tied it to a pylon")
|
||||
b.encode(sys.stdout)
|
||||
r = server.examples.decode64(b)
|
||||
print r
|
||||
|
||||
except Error, v:
|
||||
print "XML-RPC Error:",v
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
// +----------------------------------------------------------------------+
|
||||
// | PHP Version 4 |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Copyright (c) 1997-2004 The PHP Group |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | This source file is subject to version 3.0 of the PHP license, |
|
||||
// | that is bundled with this package in the file LICENSE, and is |
|
||||
// | available at through the world-wide-web at |
|
||||
// | http://www.php.net/license/3_0.txt. |
|
||||
// | If you did not receive a copy of the PHP license and are unable to |
|
||||
// | obtain it through the world-wide-web, please send a note to |
|
||||
// | license@php.net so we can mail you a copy immediately. |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Authors: Aidan Lister <aidan@php.net> |
|
||||
// +----------------------------------------------------------------------+
|
||||
//
|
||||
// $Id: array_key_exists.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
|
||||
|
||||
/**
|
||||
* Replace array_key_exists()
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_Compat
|
||||
* @link http://php.net/function.array_key_exists
|
||||
* @author Aidan Lister <aidan@php.net>
|
||||
* @version $Revision: 1.1 $
|
||||
* @since PHP 4.1.0
|
||||
* @require PHP 4.0.0 (user_error)
|
||||
*/
|
||||
if (!function_exists('array_key_exists')) {
|
||||
function array_key_exists($key, $search)
|
||||
{
|
||||
if (!is_scalar($key)) {
|
||||
user_error('array_key_exists() The first argument should be either a string or an integer',
|
||||
E_USER_WARNING);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (is_object($search)) {
|
||||
$search = get_object_vars($search);
|
||||
}
|
||||
|
||||
if (!is_array($search)) {
|
||||
user_error('array_key_exists() The second argument should be either an array or an object',
|
||||
E_USER_WARNING);
|
||||
return false;
|
||||
}
|
||||
|
||||
return in_array($key, array_keys($search));
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
47
include/limesurvey/admin/classes/xmlrpc/lib/compat/is_a.php
Normal file
47
include/limesurvey/admin/classes/xmlrpc/lib/compat/is_a.php
Normal file
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
// +----------------------------------------------------------------------+
|
||||
// | PHP Version 4 |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Copyright (c) 1997-2004 The PHP Group |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | This source file is subject to version 3.0 of the PHP license, |
|
||||
// | that is bundled with this package in the file LICENSE, and is |
|
||||
// | available at through the world-wide-web at |
|
||||
// | http://www.php.net/license/3_0.txt. |
|
||||
// | If you did not receive a copy of the PHP license and are unable to |
|
||||
// | obtain it through the world-wide-web, please send a note to |
|
||||
// | license@php.net so we can mail you a copy immediately. |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Authors: Aidan Lister <aidan@php.net> |
|
||||
// +----------------------------------------------------------------------+
|
||||
//
|
||||
// $Id: is_a.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
|
||||
|
||||
/**
|
||||
* Replace function is_a()
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_Compat
|
||||
* @link http://php.net/function.is_a
|
||||
* @author Aidan Lister <aidan@php.net>
|
||||
* @version $Revision: 1.2 $
|
||||
* @since PHP 4.2.0
|
||||
* @require PHP 4.0.0 (user_error) (is_subclass_of)
|
||||
*/
|
||||
if (!function_exists('is_a')) {
|
||||
function is_a($object, $class)
|
||||
{
|
||||
if (!is_object($object)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (get_class($object) == strtolower($class)) {
|
||||
return true;
|
||||
} else {
|
||||
return is_subclass_of($object, $class);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
/**
|
||||
* Replace function is_callable()
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_Compat
|
||||
* @link http://php.net/function.is_callable
|
||||
* @author Gaetano Giunta <giunta.gaetano@sea-aeroportimilano.it>
|
||||
* @version $Id: is_callable.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @since PHP 4.0.6
|
||||
* @require PHP 4.0.0 (true, false, etc...)
|
||||
* @todo add the 3rd parameter syntax...
|
||||
*/
|
||||
if (!function_exists('is_callable')) {
|
||||
function is_callable($var, $syntax_only=false)
|
||||
{
|
||||
if ($syntax_only)
|
||||
{
|
||||
/* from The Manual:
|
||||
* If the syntax_only argument is TRUE the function only verifies
|
||||
* that var might be a function or method. It will only reject simple
|
||||
* variables that are not strings, or an array that does not have a
|
||||
* valid structure to be used as a callback. The valid ones are
|
||||
* supposed to have only 2 entries, the first of which is an object
|
||||
* or a string, and the second a string
|
||||
*/
|
||||
return (is_string($var) || (is_array($var) && count($var) == 2 && is_string(end($var)) && (is_string(reset($var)) || is_object(reset($var)))));
|
||||
}
|
||||
else
|
||||
{
|
||||
if (is_string($var))
|
||||
{
|
||||
return function_exists($var);
|
||||
}
|
||||
else if (is_array($var) && count($var) == 2 && is_string($method = end($var)))
|
||||
{
|
||||
$obj = reset($var);
|
||||
if (is_string($obj))
|
||||
{
|
||||
$methods = get_class_methods($obj);
|
||||
return (bool)(is_array($methods) && in_array(strtolower($method), $methods));
|
||||
}
|
||||
else if (is_object($obj))
|
||||
{
|
||||
return method_exists($obj, $method);
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,38 @@
|
||||
<?php
|
||||
// +----------------------------------------------------------------------+
|
||||
// | PHP Version 4 |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Copyright (c) 1997-2004 The PHP Group |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | This source file is subject to version 3.0 of the PHP license, |
|
||||
// | that is bundled with this package in the file LICENSE, and is |
|
||||
// | available at through the world-wide-web at |
|
||||
// | http://www.php.net/license/3_0.txt. |
|
||||
// | If you did not receive a copy of the PHP license and are unable to |
|
||||
// | obtain it through the world-wide-web, please send a note to |
|
||||
// | license@php.net so we can mail you a copy immediately. |
|
||||
// +----------------------------------------------------------------------+
|
||||
//
|
||||
// $Id: is_scalar.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
|
||||
|
||||
/**
|
||||
* Replace is_scalar()
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_Compat
|
||||
* @link http://php.net/function.is_scalar
|
||||
* @author Gaetano Giunta
|
||||
* @version $Revision: 1.2 $
|
||||
* @since PHP 4.0.5
|
||||
* @require PHP 4 (is_bool)
|
||||
*/
|
||||
if (!function_exists('is_scalar')) {
|
||||
function is_scalar($val)
|
||||
{
|
||||
// Check input
|
||||
return (is_bool($val) || is_int($val) || is_float($val) || is_string($val));
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,105 @@
|
||||
<?php
|
||||
// +----------------------------------------------------------------------+
|
||||
// | PHP Version 4 |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Copyright (c) 1997-2004 The PHP Group |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | This source file is subject to version 3.0 of the PHP license, |
|
||||
// | that is bundled with this package in the file LICENSE, and is |
|
||||
// | available at through the world-wide-web at |
|
||||
// | http://www.php.net/license/3_0.txt. |
|
||||
// | If you did not receive a copy of the PHP license and are unable to |
|
||||
// | obtain it through the world-wide-web, please send a note to |
|
||||
// | license@php.net so we can mail you a copy immediately. |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Authors: Aidan Lister <aidan@php.net> |
|
||||
// +----------------------------------------------------------------------+
|
||||
//
|
||||
// $Id: var_export.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
|
||||
|
||||
/**
|
||||
* Replace var_export()
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_Compat
|
||||
* @link http://php.net/function.var_export
|
||||
* @author Aidan Lister <aidan@php.net>
|
||||
* @version $Revision: 1.2 $
|
||||
* @since PHP 4.2.0
|
||||
* @require PHP 4.0.0 (user_error)
|
||||
*/
|
||||
if (!function_exists('var_export')) {
|
||||
function var_export($array, $return = false, $lvl=0)
|
||||
{
|
||||
// Common output variables
|
||||
$indent = ' ';
|
||||
$doublearrow = ' => ';
|
||||
$lineend = ",\n";
|
||||
$stringdelim = '\'';
|
||||
|
||||
// Check the export isn't a simple string / int
|
||||
if (is_string($array)) {
|
||||
$out = $stringdelim . str_replace('\'', '\\\'', str_replace('\\', '\\\\', $array)) . $stringdelim;
|
||||
} elseif (is_int($array) || is_float($array)) {
|
||||
$out = (string)$array;
|
||||
} elseif (is_bool($array)) {
|
||||
$out = $array ? 'true' : 'false';
|
||||
} elseif (is_null($array)) {
|
||||
$out = 'NULL';
|
||||
} elseif (is_resource($array)) {
|
||||
$out = 'resource';
|
||||
} else {
|
||||
// Begin the array export
|
||||
// Start the string
|
||||
$out = "array (\n";
|
||||
|
||||
// Loop through each value in array
|
||||
foreach ($array as $key => $value) {
|
||||
// If the key is a string, delimit it
|
||||
if (is_string($key)) {
|
||||
$key = str_replace('\'', '\\\'', str_replace('\\', '\\\\', $key));
|
||||
$key = $stringdelim . $key . $stringdelim;
|
||||
}
|
||||
|
||||
$val = var_export($value, true, $lvl+1);
|
||||
// Delimit value
|
||||
/*if (is_array($value)) {
|
||||
// We have an array, so do some recursion
|
||||
// Do some basic recursion while increasing the indent
|
||||
$recur_array = explode($newline, var_export($value, true));
|
||||
$temp_array = array();
|
||||
foreach ($recur_array as $recur_line) {
|
||||
$temp_array[] = $indent . $recur_line;
|
||||
}
|
||||
$recur_array = implode($newline, $temp_array);
|
||||
$value = $newline . $recur_array;
|
||||
} elseif (is_null($value)) {
|
||||
$value = 'NULL';
|
||||
} else {
|
||||
$value = str_replace($find, $replace, $value);
|
||||
$value = $stringdelim . $value . $stringdelim;
|
||||
}*/
|
||||
|
||||
// Piece together the line
|
||||
for ($i = 0; $i < $lvl; $i++)
|
||||
$out .= $indent;
|
||||
$out .= $key . $doublearrow . $val . $lineend;
|
||||
}
|
||||
|
||||
// End our string
|
||||
for ($i = 0; $i < $lvl; $i++)
|
||||
$out .= $indent;
|
||||
$out .= ")";
|
||||
}
|
||||
|
||||
// Decide method of output
|
||||
if ($return === true) {
|
||||
return $out;
|
||||
} else {
|
||||
echo $out;
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,179 @@
|
||||
<?php
|
||||
// +----------------------------------------------------------------------+
|
||||
// | PHP Version 4 |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Copyright (c) 1997-2004 The PHP Group |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | This source file is subject to version 3.0 of the PHP license, |
|
||||
// | that is bundled with this package in the file LICENSE, and is |
|
||||
// | available at through the world-wide-web at |
|
||||
// | http://www.php.net/license/3_0.txt. |
|
||||
// | If you did not receive a copy of the PHP license and are unable to |
|
||||
// | obtain it through the world-wide-web, please send a note to |
|
||||
// | license@php.net so we can mail you a copy immediately. |
|
||||
// +----------------------------------------------------------------------+
|
||||
// | Authors: Philippe Jausions <Philippe.Jausions@11abacus.com> |
|
||||
// | Aidan Lister <aidan@php.net> |
|
||||
// +----------------------------------------------------------------------+
|
||||
//
|
||||
// $Id: version_compare.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
|
||||
|
||||
/**
|
||||
* Replace version_compare()
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_Compat
|
||||
* @link http://php.net/function.version_compare
|
||||
* @author Philippe Jausions <Philippe.Jausions@11abacus.com>
|
||||
* @author Aidan Lister <aidan@php.net>
|
||||
* @version $Revision: 1.1 $
|
||||
* @since PHP 4.1.0
|
||||
* @require PHP 4.0.0 (user_error)
|
||||
*/
|
||||
if (!function_exists('version_compare')) {
|
||||
function version_compare($version1, $version2, $operator = '<')
|
||||
{
|
||||
// Check input
|
||||
if (!is_scalar($version1)) {
|
||||
user_error('version_compare() expects parameter 1 to be string, ' .
|
||||
gettype($version1) . ' given', E_USER_WARNING);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!is_scalar($version2)) {
|
||||
user_error('version_compare() expects parameter 2 to be string, ' .
|
||||
gettype($version2) . ' given', E_USER_WARNING);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!is_scalar($operator)) {
|
||||
user_error('version_compare() expects parameter 3 to be string, ' .
|
||||
gettype($operator) . ' given', E_USER_WARNING);
|
||||
return;
|
||||
}
|
||||
|
||||
// Standardise versions
|
||||
$v1 = explode('.',
|
||||
str_replace('..', '.',
|
||||
preg_replace('/([^0-9\.]+)/', '.$1.',
|
||||
str_replace(array('-', '_', '+'), '.',
|
||||
trim($version1)))));
|
||||
|
||||
$v2 = explode('.',
|
||||
str_replace('..', '.',
|
||||
preg_replace('/([^0-9\.]+)/', '.$1.',
|
||||
str_replace(array('-', '_', '+'), '.',
|
||||
trim($version2)))));
|
||||
|
||||
// Replace empty entries at the start of the array
|
||||
while (empty($v1[0]) && array_shift($v1)) {}
|
||||
while (empty($v2[0]) && array_shift($v2)) {}
|
||||
|
||||
// Release state order
|
||||
// '#' stands for any number
|
||||
$versions = array(
|
||||
'dev' => 0,
|
||||
'alpha' => 1,
|
||||
'a' => 1,
|
||||
'beta' => 2,
|
||||
'b' => 2,
|
||||
'RC' => 3,
|
||||
'#' => 4,
|
||||
'p' => 5,
|
||||
'pl' => 5);
|
||||
|
||||
// Loop through each segment in the version string
|
||||
$compare = 0;
|
||||
for ($i = 0, $x = min(count($v1), count($v2)); $i < $x; $i++) {
|
||||
if ($v1[$i] == $v2[$i]) {
|
||||
continue;
|
||||
}
|
||||
$i1 = $v1[$i];
|
||||
$i2 = $v2[$i];
|
||||
if (is_numeric($i1) && is_numeric($i2)) {
|
||||
$compare = ($i1 < $i2) ? -1 : 1;
|
||||
break;
|
||||
}
|
||||
// We use the position of '#' in the versions list
|
||||
// for numbers... (so take care of # in original string)
|
||||
if ($i1 == '#') {
|
||||
$i1 = '';
|
||||
} elseif (is_numeric($i1)) {
|
||||
$i1 = '#';
|
||||
}
|
||||
if ($i2 == '#') {
|
||||
$i2 = '';
|
||||
} elseif (is_numeric($i2)) {
|
||||
$i2 = '#';
|
||||
}
|
||||
if (isset($versions[$i1]) && isset($versions[$i2])) {
|
||||
$compare = ($versions[$i1] < $versions[$i2]) ? -1 : 1;
|
||||
} elseif (isset($versions[$i1])) {
|
||||
$compare = 1;
|
||||
} elseif (isset($versions[$i2])) {
|
||||
$compare = -1;
|
||||
} else {
|
||||
$compare = 0;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
// If previous loop didn't find anything, compare the "extra" segments
|
||||
if ($compare == 0) {
|
||||
if (count($v2) > count($v1)) {
|
||||
if (isset($versions[$v2[$i]])) {
|
||||
$compare = ($versions[$v2[$i]] < 4) ? 1 : -1;
|
||||
} else {
|
||||
$compare = -1;
|
||||
}
|
||||
} elseif (count($v2) < count($v1)) {
|
||||
if (isset($versions[$v1[$i]])) {
|
||||
$compare = ($versions[$v1[$i]] < 4) ? -1 : 1;
|
||||
} else {
|
||||
$compare = 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Compare the versions
|
||||
if (func_num_args() > 2) {
|
||||
switch ($operator) {
|
||||
case '>':
|
||||
case 'gt':
|
||||
return (bool) ($compare > 0);
|
||||
break;
|
||||
case '>=':
|
||||
case 'ge':
|
||||
return (bool) ($compare >= 0);
|
||||
break;
|
||||
case '<=':
|
||||
case 'le':
|
||||
return (bool) ($compare <= 0);
|
||||
break;
|
||||
case '==':
|
||||
case '=':
|
||||
case 'eq':
|
||||
return (bool) ($compare == 0);
|
||||
break;
|
||||
case '<>':
|
||||
case '!=':
|
||||
case 'ne':
|
||||
return (bool) ($compare != 0);
|
||||
break;
|
||||
case '':
|
||||
case '<':
|
||||
case 'lt':
|
||||
return (bool) ($compare < 0);
|
||||
break;
|
||||
default:
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
return $compare;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
3718
include/limesurvey/admin/classes/xmlrpc/lib/xmlrpc.inc
Normal file
3718
include/limesurvey/admin/classes/xmlrpc/lib/xmlrpc.inc
Normal file
File diff suppressed because it is too large
Load Diff
944
include/limesurvey/admin/classes/xmlrpc/lib/xmlrpc_wrappers.inc
Normal file
944
include/limesurvey/admin/classes/xmlrpc/lib/xmlrpc_wrappers.inc
Normal file
@@ -0,0 +1,944 @@
|
||||
<?php
|
||||
/**
|
||||
* PHP-XMLRPC "wrapper" functions
|
||||
* Generate stubs to transparently access xmlrpc methods as php functions and viceversa
|
||||
*
|
||||
* @version $Id: xmlrpc_wrappers.inc,v 1.13 2008/09/20 01:23:47 ggiunta Exp $
|
||||
* @author Gaetano Giunta
|
||||
* @copyright (C) 2006-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*
|
||||
* @todo separate introspection from code generation for func-2-method wrapping
|
||||
* @todo use some better templating system for code generation?
|
||||
* @todo implement method wrapping with preservation of php objs in calls
|
||||
* @todo when wrapping methods without obj rebuilding, use return_type = 'phpvals' (faster)
|
||||
* @todo implement self-parsing of php code for PHP <= 4
|
||||
*/
|
||||
|
||||
// requires: xmlrpc.inc
|
||||
|
||||
/**
|
||||
* Given a string defining a php type or phpxmlrpc type (loosely defined: strings
|
||||
* accepted come from javadoc blocks), return corresponding phpxmlrpc type.
|
||||
* NB: for php 'resource' types returns empty string, since resources cannot be serialized;
|
||||
* for php class names returns 'struct', since php objects can be serialized as xmlrpc structs
|
||||
* @param string $phptype
|
||||
* @return string
|
||||
*/
|
||||
function php_2_xmlrpc_type($phptype)
|
||||
{
|
||||
switch(strtolower($phptype))
|
||||
{
|
||||
case 'string':
|
||||
return $GLOBALS['xmlrpcString'];
|
||||
case 'integer':
|
||||
case $GLOBALS['xmlrpcInt']: // 'int'
|
||||
case $GLOBALS['xmlrpcI4']:
|
||||
return $GLOBALS['xmlrpcInt'];
|
||||
case 'double':
|
||||
return $GLOBALS['xmlrpcDouble'];
|
||||
case 'boolean':
|
||||
return $GLOBALS['xmlrpcBoolean'];
|
||||
case 'array':
|
||||
return $GLOBALS['xmlrpcArray'];
|
||||
case 'object':
|
||||
return $GLOBALS['xmlrpcStruct'];
|
||||
case $GLOBALS['xmlrpcBase64']:
|
||||
case $GLOBALS['xmlrpcStruct']:
|
||||
return strtolower($phptype);
|
||||
case 'resource':
|
||||
return '';
|
||||
default:
|
||||
if(class_exists($phptype))
|
||||
{
|
||||
return $GLOBALS['xmlrpcStruct'];
|
||||
}
|
||||
else
|
||||
{
|
||||
// unknown: might be any 'extended' xmlrpc type
|
||||
return $GLOBALS['xmlrpcValue'];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a string defining a phpxmlrpc type return corresponding php type.
|
||||
* @param string $xmlrpctype
|
||||
* @return string
|
||||
*/
|
||||
function xmlrpc_2_php_type($xmlrpctype)
|
||||
{
|
||||
switch(strtolower($xmlrpctype))
|
||||
{
|
||||
case 'base64':
|
||||
case 'datetime.iso8601':
|
||||
case 'string':
|
||||
return $GLOBALS['xmlrpcString'];
|
||||
case 'int':
|
||||
case 'i4':
|
||||
return 'integer';
|
||||
case 'struct':
|
||||
case 'array':
|
||||
return 'array';
|
||||
case 'double':
|
||||
return 'float';
|
||||
case 'undefined':
|
||||
return 'mixed';
|
||||
case 'boolean':
|
||||
case 'null':
|
||||
default:
|
||||
// unknown: might be any xmlrpc type
|
||||
return strtolower($xmlrpctype);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a user-defined PHP function, create a PHP 'wrapper' function that can
|
||||
* be exposed as xmlrpc method from an xmlrpc_server object and called from remote
|
||||
* clients (as well as its corresponding signature info).
|
||||
*
|
||||
* Since php is a typeless language, to infer types of input and output parameters,
|
||||
* it relies on parsing the javadoc-style comment block associated with the given
|
||||
* function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)
|
||||
* in the @param tag is also allowed, if you need the php function to receive/send
|
||||
* data in that particular format (note that base64 encoding/decoding is transparently
|
||||
* carried out by the lib, while datetime vals are passed around as strings)
|
||||
*
|
||||
* Known limitations:
|
||||
* - requires PHP 5.0.3 +
|
||||
* - only works for user-defined functions, not for PHP internal functions
|
||||
* (reflection does not support retrieving number/type of params for those)
|
||||
* - functions returning php objects will generate special xmlrpc responses:
|
||||
* when the xmlrpc decoding of those responses is carried out by this same lib, using
|
||||
* the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.
|
||||
* In short: php objects can be serialized, too (except for their resource members),
|
||||
* using this function.
|
||||
* Other libs might choke on the very same xml that will be generated in this case
|
||||
* (i.e. it has a nonstandard attribute on struct element tags)
|
||||
* - usage of javadoc @param tags using param names in a different order from the
|
||||
* function prototype is not considered valid (to be fixed?)
|
||||
*
|
||||
* Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'
|
||||
* php functions (ie. functions not expecting a single xmlrpcmsg obj as parameter)
|
||||
* is by making use of the functions_parameters_type class member.
|
||||
*
|
||||
* @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too
|
||||
* @param string $newfuncname (optional) name for function to be created
|
||||
* @param array $extra_options (optional) array of options for conversion. valid values include:
|
||||
* bool return_source when true, php code w. function definition will be returned, not evaluated
|
||||
* bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
|
||||
* bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
|
||||
* bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked
|
||||
* @return false on error, or an array containing the name of the new php function,
|
||||
* its signature and docs, to be used in the server dispatch map
|
||||
*
|
||||
* @todo decide how to deal with params passed by ref: bomb out or allow?
|
||||
* @todo finish using javadoc info to build method sig if all params are named but out of order
|
||||
* @todo add a check for params of 'resource' type
|
||||
* @todo add some trigger_errors / error_log when returning false?
|
||||
* @todo what to do when the PHP function returns NULL? we are currently returning an empty string value...
|
||||
* @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?
|
||||
* @todo if $newfuncname is empty, we could use create_user_func instead of eval, as it is possibly faster
|
||||
* @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance?
|
||||
*/
|
||||
function wrap_php_function($funcname, $newfuncname='', $extra_options=array())
|
||||
{
|
||||
$buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;
|
||||
$prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';
|
||||
$encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;
|
||||
$decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;
|
||||
$catch_warnings = isset($extra_options['suppress_warnings']) && $extra_options['suppress_warnings'] ? '@' : '';
|
||||
|
||||
if(version_compare(phpversion(), '5.0.3') == -1)
|
||||
{
|
||||
// up to php 5.0.3 some useful reflection methods were missing
|
||||
error_log('XML-RPC: cannot not wrap php functions unless running php version bigger than 5.0.3');
|
||||
return false;
|
||||
}
|
||||
|
||||
$exists = false;
|
||||
if(is_array($funcname))
|
||||
{
|
||||
if(count($funcname) < 2 || (!is_string($funcname[0]) && !is_object($funcname[0])))
|
||||
{
|
||||
error_log('XML-RPC: syntax for function to be wrapped is wrong');
|
||||
return false;
|
||||
}
|
||||
if(is_string($funcname[0]))
|
||||
{
|
||||
$plainfuncname = implode('::', $funcname);
|
||||
}
|
||||
elseif(is_object($funcname[0]))
|
||||
{
|
||||
$plainfuncname = get_class($funcname[0]) . '->' . $funcname[1];
|
||||
}
|
||||
$exists = method_exists($funcname[0], $funcname[1]);
|
||||
}
|
||||
else
|
||||
{
|
||||
$plainfuncname = $funcname;
|
||||
$exists = function_exists($funcname);
|
||||
}
|
||||
|
||||
if(!$exists)
|
||||
{
|
||||
error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
// determine name of new php function
|
||||
if($newfuncname == '')
|
||||
{
|
||||
if(is_array($funcname))
|
||||
{
|
||||
if(is_string($funcname[0]))
|
||||
$xmlrpcfuncname = "{$prefix}_".implode('_', $funcname);
|
||||
else
|
||||
$xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1];
|
||||
}
|
||||
else
|
||||
{
|
||||
$xmlrpcfuncname = "{$prefix}_$funcname";
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$xmlrpcfuncname = $newfuncname;
|
||||
}
|
||||
while($buildit && function_exists($xmlrpcfuncname))
|
||||
{
|
||||
$xmlrpcfuncname .= 'x';
|
||||
}
|
||||
|
||||
// start to introspect PHP code
|
||||
if(is_array($funcname))
|
||||
{
|
||||
$func =& new ReflectionMethod($funcname[0], $funcname[1]);
|
||||
if($func->isPrivate())
|
||||
{
|
||||
error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
if($func->isProtected())
|
||||
{
|
||||
error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
if($func->isConstructor())
|
||||
{
|
||||
error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
if($func->isDestructor())
|
||||
{
|
||||
error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
if($func->isAbstract())
|
||||
{
|
||||
error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
/// @todo add more checks for static vs. nonstatic?
|
||||
}
|
||||
else
|
||||
{
|
||||
$func =& new ReflectionFunction($funcname);
|
||||
}
|
||||
if($func->isInternal())
|
||||
{
|
||||
// Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs
|
||||
// instead of getparameters to fully reflect internal php functions ?
|
||||
error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
|
||||
// retrieve parameter names, types and description from javadoc comments
|
||||
|
||||
// function description
|
||||
$desc = '';
|
||||
// type of return val: by default 'any'
|
||||
$returns = $GLOBALS['xmlrpcValue'];
|
||||
// desc of return val
|
||||
$returnsDocs = '';
|
||||
// type + name of function parameters
|
||||
$paramDocs = array();
|
||||
|
||||
$docs = $func->getDocComment();
|
||||
if($docs != '')
|
||||
{
|
||||
$docs = explode("\n", $docs);
|
||||
$i = 0;
|
||||
foreach($docs as $doc)
|
||||
{
|
||||
$doc = trim($doc, " \r\t/*");
|
||||
if(strlen($doc) && strpos($doc, '@') !== 0 && !$i)
|
||||
{
|
||||
if($desc)
|
||||
{
|
||||
$desc .= "\n";
|
||||
}
|
||||
$desc .= $doc;
|
||||
}
|
||||
elseif(strpos($doc, '@param') === 0)
|
||||
{
|
||||
// syntax: @param type [$name] desc
|
||||
if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches))
|
||||
{
|
||||
if(strpos($matches[1], '|'))
|
||||
{
|
||||
//$paramDocs[$i]['type'] = explode('|', $matches[1]);
|
||||
$paramDocs[$i]['type'] = 'mixed';
|
||||
}
|
||||
else
|
||||
{
|
||||
$paramDocs[$i]['type'] = $matches[1];
|
||||
}
|
||||
$paramDocs[$i]['name'] = trim($matches[2]);
|
||||
$paramDocs[$i]['doc'] = $matches[3];
|
||||
}
|
||||
$i++;
|
||||
}
|
||||
elseif(strpos($doc, '@return') === 0)
|
||||
{
|
||||
// syntax: @return type desc
|
||||
//$returns = preg_split('/\s+/', $doc);
|
||||
if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches))
|
||||
{
|
||||
$returns = php_2_xmlrpc_type($matches[1]);
|
||||
if(isset($matches[2]))
|
||||
{
|
||||
$returnsDocs = $matches[2];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// execute introspection of actual function prototype
|
||||
$params = array();
|
||||
$i = 0;
|
||||
foreach($func->getParameters() as $paramobj)
|
||||
{
|
||||
$params[$i] = array();
|
||||
$params[$i]['name'] = '$'.$paramobj->getName();
|
||||
$params[$i]['isoptional'] = $paramobj->isOptional();
|
||||
$i++;
|
||||
}
|
||||
|
||||
|
||||
// start building of PHP code to be eval'd
|
||||
$innercode = '';
|
||||
$i = 0;
|
||||
$parsvariations = array();
|
||||
$pars = array();
|
||||
$pnum = count($params);
|
||||
foreach($params as $param)
|
||||
{
|
||||
if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name']))
|
||||
{
|
||||
// param name from phpdoc info does not match param definition!
|
||||
$paramDocs[$i]['type'] = 'mixed';
|
||||
}
|
||||
|
||||
if($param['isoptional'])
|
||||
{
|
||||
// this particular parameter is optional. save as valid previous list of parameters
|
||||
$innercode .= "if (\$paramcount > $i) {\n";
|
||||
$parsvariations[] = $pars;
|
||||
}
|
||||
$innercode .= "\$p$i = \$msg->getParam($i);\n";
|
||||
if ($decode_php_objects)
|
||||
{
|
||||
$innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
$innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n";
|
||||
}
|
||||
|
||||
$pars[] = "\$p$i";
|
||||
$i++;
|
||||
if($param['isoptional'])
|
||||
{
|
||||
$innercode .= "}\n";
|
||||
}
|
||||
if($i == $pnum)
|
||||
{
|
||||
// last allowed parameters combination
|
||||
$parsvariations[] = $pars;
|
||||
}
|
||||
}
|
||||
|
||||
$sigs = array();
|
||||
$psigs = array();
|
||||
if(count($parsvariations) == 0)
|
||||
{
|
||||
// only known good synopsis = no parameters
|
||||
$parsvariations[] = array();
|
||||
$minpars = 0;
|
||||
}
|
||||
else
|
||||
{
|
||||
$minpars = count($parsvariations[0]);
|
||||
}
|
||||
|
||||
if($minpars)
|
||||
{
|
||||
// add to code the check for min params number
|
||||
// NB: this check needs to be done BEFORE decoding param values
|
||||
$innercode = "\$paramcount = \$msg->getNumParams();\n" .
|
||||
"if (\$paramcount < $minpars) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" . $innercode;
|
||||
}
|
||||
else
|
||||
{
|
||||
$innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode;
|
||||
}
|
||||
|
||||
$innercode .= "\$np = false;\n";
|
||||
// since there are no closures in php, if we are given an object instance,
|
||||
// we store a pointer to it in a global var...
|
||||
if ( is_array($funcname) && is_object($funcname[0]) )
|
||||
{
|
||||
$GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0];
|
||||
$innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n";
|
||||
$realfuncname = '$obj->'.$funcname[1];
|
||||
}
|
||||
else
|
||||
{
|
||||
$realfuncname = $plainfuncname;
|
||||
}
|
||||
foreach($parsvariations as $pars)
|
||||
{
|
||||
$innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n";
|
||||
// build a 'generic' signature (only use an appropriate return type)
|
||||
$sig = array($returns);
|
||||
$psig = array($returnsDocs);
|
||||
for($i=0; $i < count($pars); $i++)
|
||||
{
|
||||
if (isset($paramDocs[$i]['type']))
|
||||
{
|
||||
$sig[] = php_2_xmlrpc_type($paramDocs[$i]['type']);
|
||||
}
|
||||
else
|
||||
{
|
||||
$sig[] = $GLOBALS['xmlrpcValue'];
|
||||
}
|
||||
$psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : '';
|
||||
}
|
||||
$sigs[] = $sig;
|
||||
$psigs[] = $psig;
|
||||
}
|
||||
$innercode .= "\$np = true;\n";
|
||||
$innercode .= "if (\$np) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else {\n";
|
||||
//$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n";
|
||||
$innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n";
|
||||
if($returns == $GLOBALS['xmlrpcDateTime'] || $returns == $GLOBALS['xmlrpcBase64'])
|
||||
{
|
||||
$innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));";
|
||||
}
|
||||
else
|
||||
{
|
||||
if ($encode_php_objects)
|
||||
$innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n";
|
||||
else
|
||||
$innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n";
|
||||
}
|
||||
// shall we exclude functions returning by ref?
|
||||
// if($func->returnsReference())
|
||||
// return false;
|
||||
$code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}";
|
||||
//print_r($code);
|
||||
if ($buildit)
|
||||
{
|
||||
$allOK = 0;
|
||||
eval($code.'$allOK=1;');
|
||||
// alternative
|
||||
//$xmlrpcfuncname = create_function('$m', $innercode);
|
||||
|
||||
if(!$allOK)
|
||||
{
|
||||
error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// @todo examine if $paramDocs matches $parsvariations and build array for
|
||||
/// usage as method signature, plus put together a nice string for docs
|
||||
|
||||
$ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code);
|
||||
return $ret;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a user-defined PHP class or php object, map its methods onto a list of
|
||||
* PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server
|
||||
* object and called from remote clients (as well as their corresponding signature info).
|
||||
*
|
||||
* @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class
|
||||
* @param array $extra_options see the docs for wrap_php_method for more options
|
||||
* string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance
|
||||
* @return array or false on failure
|
||||
*
|
||||
* @todo get_class_methods will return both static and non-static methods.
|
||||
* we have to differentiate the action, depending on wheter we recived a class name or object
|
||||
*/
|
||||
function wrap_php_class($classname, $extra_options=array())
|
||||
{
|
||||
$methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';
|
||||
$methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto';
|
||||
|
||||
if(version_compare(phpversion(), '5.0.3') == -1)
|
||||
{
|
||||
// up to php 5.0.3 some useful reflection methods were missing
|
||||
error_log('XML-RPC: cannot not wrap php functions unless running php version bigger than 5.0.3');
|
||||
return false;
|
||||
}
|
||||
|
||||
$result = array();
|
||||
$mlist = get_class_methods($classname);
|
||||
foreach($mlist as $mname)
|
||||
{
|
||||
if ($methodfilter == '' || preg_match($methodfilter, $mname))
|
||||
{
|
||||
// echo $mlist."\n";
|
||||
$func =& new ReflectionMethod($classname, $mname);
|
||||
if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract())
|
||||
{
|
||||
if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) ||
|
||||
(!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname)))))
|
||||
{
|
||||
$methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options);
|
||||
if ( $methodwrap )
|
||||
{
|
||||
$result[$methodwrap['function']] = $methodwrap['function'];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Given an xmlrpc client and a method name, register a php wrapper function
|
||||
* that will call it and return results using native php types for both
|
||||
* params and results. The generated php function will return an xmlrpcresp
|
||||
* oject for failed xmlrpc calls
|
||||
*
|
||||
* Known limitations:
|
||||
* - server must support system.methodsignature for the wanted xmlrpc method
|
||||
* - for methods that expose many signatures, only one can be picked (we
|
||||
* could in priciple check if signatures differ only by number of params
|
||||
* and not by type, but it would be more complication than we can spare time)
|
||||
* - nested xmlrpc params: the caller of the generated php function has to
|
||||
* encode on its own the params passed to the php function if these are structs
|
||||
* or arrays whose (sub)members include values of type datetime or base64
|
||||
*
|
||||
* Notes: the connection properties of the given client will be copied
|
||||
* and reused for the connection used during the call to the generated
|
||||
* php function.
|
||||
* Calling the generated php function 'might' be slow: a new xmlrpc client
|
||||
* is created on every invocation and an xmlrpc-connection opened+closed.
|
||||
* An extra 'debug' param is appended to param list of xmlrpc method, useful
|
||||
* for debugging purposes.
|
||||
*
|
||||
* @param xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server
|
||||
* @param string $methodname the xmlrpc method to be mapped to a php function
|
||||
* @param array $extra_options array of options that specify conversion details. valid ptions include
|
||||
* integer signum the index of the method signature to use in mapping (if method exposes many sigs)
|
||||
* integer timeout timeout (in secs) to be used when executing function/calling remote method
|
||||
* string protocol 'http' (default), 'http11' or 'https'
|
||||
* string new_function_name the name of php function to create. If unsepcified, lib will pick an appropriate name
|
||||
* string return_source if true return php code w. function definition instead fo function name
|
||||
* bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
|
||||
* bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
|
||||
* mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values
|
||||
* bool debug set it to 1 or 2 to see debug results of querying server for method synopsis
|
||||
* @return string the name of the generated php function (or false) - OR AN ARRAY...
|
||||
*/
|
||||
function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='')
|
||||
{
|
||||
// mind numbing: let caller use sane calling convention (as per javadoc, 3 params),
|
||||
// OR the 2.0 calling convention (no options) - we really love backward compat, don't we?
|
||||
if (!is_array($extra_options))
|
||||
{
|
||||
$signum = $extra_options;
|
||||
$extra_options = array();
|
||||
}
|
||||
else
|
||||
{
|
||||
$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;
|
||||
$timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;
|
||||
$protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';
|
||||
$newfuncname = isset($extra_options['new_function_name']) ? $extra_options['new_function_name'] : '';
|
||||
}
|
||||
//$encode_php_objects = in_array('encode_php_objects', $extra_options);
|
||||
//$verbatim_client_copy = in_array('simple_client_copy', $extra_options) ? 1 :
|
||||
// in_array('build_class_code', $extra_options) ? 2 : 0;
|
||||
|
||||
$encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;
|
||||
$decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;
|
||||
$simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0;
|
||||
$buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;
|
||||
$prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';
|
||||
if (isset($extra_options['return_on_fault']))
|
||||
{
|
||||
$decode_fault = true;
|
||||
$fault_response = $extra_options['return_on_fault'];
|
||||
}
|
||||
else
|
||||
{
|
||||
$decode_fault = false;
|
||||
$fault_response = '';
|
||||
}
|
||||
$debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0;
|
||||
|
||||
$msgclass = $prefix.'msg';
|
||||
$valclass = $prefix.'val';
|
||||
$decodefunc = 'php_'.$prefix.'_decode';
|
||||
|
||||
$msg =& new $msgclass('system.methodSignature');
|
||||
$msg->addparam(new $valclass($methodname));
|
||||
$client->setDebug($debug);
|
||||
$response =& $client->send($msg, $timeout, $protocol);
|
||||
if($response->faultCode())
|
||||
{
|
||||
error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname);
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
$msig = $response->value();
|
||||
if ($client->return_type != 'phpvals')
|
||||
{
|
||||
$msig = $decodefunc($msig);
|
||||
}
|
||||
if(!is_array($msig) || count($msig) <= $signum)
|
||||
{
|
||||
error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname);
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
// pick a suitable name for the new function, avoiding collisions
|
||||
if($newfuncname != '')
|
||||
{
|
||||
$xmlrpcfuncname = $newfuncname;
|
||||
}
|
||||
else
|
||||
{
|
||||
// take care to insure that methodname is translated to valid
|
||||
// php function name
|
||||
$xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
|
||||
array('_', ''), $methodname);
|
||||
}
|
||||
while($buildit && function_exists($xmlrpcfuncname))
|
||||
{
|
||||
$xmlrpcfuncname .= 'x';
|
||||
}
|
||||
|
||||
$msig = $msig[$signum];
|
||||
$mdesc = '';
|
||||
// if in 'offline' mode, get method description too.
|
||||
// in online mode, favour speed of operation
|
||||
if(!$buildit)
|
||||
{
|
||||
$msg =& new $msgclass('system.methodHelp');
|
||||
$msg->addparam(new $valclass($methodname));
|
||||
$response =& $client->send($msg, $timeout, $protocol);
|
||||
if (!$response->faultCode())
|
||||
{
|
||||
$mdesc = $response->value();
|
||||
if ($client->return_type != 'phpvals')
|
||||
{
|
||||
$mdesc = $mdesc->scalarval();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$results = build_remote_method_wrapper_code($client, $methodname,
|
||||
$xmlrpcfuncname, $msig, $mdesc, $timeout, $protocol, $simple_client_copy,
|
||||
$prefix, $decode_php_objects, $encode_php_objects, $decode_fault,
|
||||
$fault_response);
|
||||
|
||||
//print_r($code);
|
||||
if ($buildit)
|
||||
{
|
||||
$allOK = 0;
|
||||
eval($results['source'].'$allOK=1;');
|
||||
// alternative
|
||||
//$xmlrpcfuncname = create_function('$m', $innercode);
|
||||
if($allOK)
|
||||
{
|
||||
return $xmlrpcfuncname;
|
||||
}
|
||||
else
|
||||
{
|
||||
error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$results['function'] = $xmlrpcfuncname;
|
||||
return $results;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Similar to wrap_xmlrpc_method, but will generate a php class that wraps
|
||||
* all xmlrpc methods exposed by the remote server as own methods.
|
||||
* For more details see wrap_xmlrpc_method.
|
||||
* @param xmlrpc_client $client the client obj all set to query the desired server
|
||||
* @param array $extra_options list of options for wrapped code
|
||||
* @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options)
|
||||
*/
|
||||
function wrap_xmlrpc_server($client, $extra_options=array())
|
||||
{
|
||||
$methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';
|
||||
//$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;
|
||||
$timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;
|
||||
$protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';
|
||||
$newclassname = isset($extra_options['new_class_name']) ? $extra_options['new_class_name'] : '';
|
||||
$encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;
|
||||
$decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;
|
||||
$verbatim_client_copy = isset($extra_options['simple_client_copy']) ? !($extra_options['simple_client_copy']) : true;
|
||||
$buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;
|
||||
$prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';
|
||||
|
||||
$msgclass = $prefix.'msg';
|
||||
//$valclass = $prefix.'val';
|
||||
$decodefunc = 'php_'.$prefix.'_decode';
|
||||
|
||||
$msg =& new $msgclass('system.listMethods');
|
||||
$response =& $client->send($msg, $timeout, $protocol);
|
||||
if($response->faultCode())
|
||||
{
|
||||
error_log('XML-RPC: could not retrieve method list from remote server');
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
$mlist = $response->value();
|
||||
if ($client->return_type != 'phpvals')
|
||||
{
|
||||
$mlist = $decodefunc($mlist);
|
||||
}
|
||||
if(!is_array($mlist) || !count($mlist))
|
||||
{
|
||||
error_log('XML-RPC: could not retrieve meaningful method list from remote server');
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
// pick a suitable name for the new function, avoiding collisions
|
||||
if($newclassname != '')
|
||||
{
|
||||
$xmlrpcclassname = $newclassname;
|
||||
}
|
||||
else
|
||||
{
|
||||
$xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
|
||||
array('_', ''), $client->server).'_client';
|
||||
}
|
||||
while($buildit && class_exists($xmlrpcclassname))
|
||||
{
|
||||
$xmlrpcclassname .= 'x';
|
||||
}
|
||||
|
||||
/// @todo add function setdebug() to new class, to enable/disable debugging
|
||||
$source = "class $xmlrpcclassname\n{\nvar \$client;\n\n";
|
||||
$source .= "function $xmlrpcclassname()\n{\n";
|
||||
$source .= build_client_wrapper_code($client, $verbatim_client_copy, $prefix);
|
||||
$source .= "\$this->client =& \$client;\n}\n\n";
|
||||
$opts = array('simple_client_copy' => 2, 'return_source' => true,
|
||||
'timeout' => $timeout, 'protocol' => $protocol,
|
||||
'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix,
|
||||
'decode_php_objs' => $decode_php_objects
|
||||
);
|
||||
/// @todo build javadoc for class definition, too
|
||||
foreach($mlist as $mname)
|
||||
{
|
||||
if ($methodfilter == '' || preg_match($methodfilter, $mname))
|
||||
{
|
||||
$opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
|
||||
array('_', ''), $mname);
|
||||
$methodwrap = wrap_xmlrpc_method($client, $mname, $opts);
|
||||
if ($methodwrap)
|
||||
{
|
||||
if (!$buildit)
|
||||
{
|
||||
$source .= $methodwrap['docstring'];
|
||||
}
|
||||
$source .= $methodwrap['source']."\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
error_log('XML-RPC: will not create class method to wrap remote method '.$mname);
|
||||
}
|
||||
}
|
||||
}
|
||||
$source .= "}\n";
|
||||
if ($buildit)
|
||||
{
|
||||
$allOK = 0;
|
||||
eval($source.'$allOK=1;');
|
||||
// alternative
|
||||
//$xmlrpcfuncname = create_function('$m', $innercode);
|
||||
if($allOK)
|
||||
{
|
||||
return $xmlrpcclassname;
|
||||
}
|
||||
else
|
||||
{
|
||||
error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => '');
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Given the necessary info, build php code that creates a new function to
|
||||
* invoke a remote xmlrpc method.
|
||||
* Take care that no full checking of input parameters is done to ensure that
|
||||
* valid php code is emitted.
|
||||
* Note: real spaghetti code follows...
|
||||
* @access private
|
||||
*/
|
||||
function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname,
|
||||
$msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc',
|
||||
$decode_php_objects=false, $encode_php_objects=false, $decode_fault=false,
|
||||
$fault_response='')
|
||||
{
|
||||
$code = "function $xmlrpcfuncname (";
|
||||
if ($client_copy_mode < 2)
|
||||
{
|
||||
// client copy mode 0 or 1 == partial / full client copy in emitted code
|
||||
$innercode = build_client_wrapper_code($client, $client_copy_mode, $prefix);
|
||||
$innercode .= "\$client->setDebug(\$debug);\n";
|
||||
$this_ = '';
|
||||
}
|
||||
else
|
||||
{
|
||||
// client copy mode 2 == no client copy in emitted code
|
||||
$innercode = '';
|
||||
$this_ = 'this->';
|
||||
}
|
||||
$innercode .= "\$msg =& new {$prefix}msg('$methodname');\n";
|
||||
|
||||
if ($mdesc != '')
|
||||
{
|
||||
// take care that PHP comment is not terminated unwillingly by method description
|
||||
$mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
$mdesc = "/**\nFunction $xmlrpcfuncname\n";
|
||||
}
|
||||
|
||||
// param parsing
|
||||
$plist = array();
|
||||
$pcount = count($msig);
|
||||
for($i = 1; $i < $pcount; $i++)
|
||||
{
|
||||
$plist[] = "\$p$i";
|
||||
$ptype = $msig[$i];
|
||||
if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' ||
|
||||
$ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null')
|
||||
{
|
||||
// only build directly xmlrpcvals when type is known and scalar
|
||||
$innercode .= "\$p$i =& new {$prefix}val(\$p$i, '$ptype');\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
if ($encode_php_objects)
|
||||
{
|
||||
$innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
$innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i);\n";
|
||||
}
|
||||
}
|
||||
$innercode .= "\$msg->addparam(\$p$i);\n";
|
||||
$mdesc .= '* @param '.xmlrpc_2_php_type($ptype)." \$p$i\n";
|
||||
}
|
||||
if ($client_copy_mode < 2)
|
||||
{
|
||||
$plist[] = '$debug=0';
|
||||
$mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n";
|
||||
}
|
||||
$plist = implode(', ', $plist);
|
||||
$mdesc .= '* @return '.xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n";
|
||||
|
||||
$innercode .= "\$res =& \${$this_}client->send(\$msg, $timeout, '$protocol');\n";
|
||||
if ($decode_fault)
|
||||
{
|
||||
if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false)))
|
||||
{
|
||||
$respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')";
|
||||
}
|
||||
else
|
||||
{
|
||||
$respcode = var_export($fault_response, true);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$respcode = '$res';
|
||||
}
|
||||
if ($decode_php_objects)
|
||||
{
|
||||
$innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));";
|
||||
}
|
||||
else
|
||||
{
|
||||
$innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());";
|
||||
}
|
||||
|
||||
$code = $code . $plist. ") {\n" . $innercode . "\n}\n";
|
||||
|
||||
return array('source' => $code, 'docstring' => $mdesc);
|
||||
}
|
||||
|
||||
/**
|
||||
* Given necessary info, generate php code that will rebuild a client object
|
||||
* Take care that no full checking of input parameters is done to ensure that
|
||||
* valid php code is emitted.
|
||||
* @access private
|
||||
*/
|
||||
function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc')
|
||||
{
|
||||
$code = "\$client =& new {$prefix}_client('".str_replace("'", "\'", $client->path).
|
||||
"', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n";
|
||||
|
||||
// copy all client fields to the client that will be generated runtime
|
||||
// (this provides for future expansion or subclassing of client obj)
|
||||
if ($verbatim_client_copy)
|
||||
{
|
||||
foreach($client as $fld => $val)
|
||||
{
|
||||
if($fld != 'debug' && $fld != 'return_type')
|
||||
{
|
||||
$val = var_export($val, true);
|
||||
$code .= "\$client->$fld = $val;\n";
|
||||
}
|
||||
}
|
||||
}
|
||||
// only make sure that client always returns the correct data type
|
||||
$code .= "\$client->return_type = '{$prefix}vals';\n";
|
||||
//$code .= "\$client->setDebug(\$debug);\n";
|
||||
return $code;
|
||||
}
|
||||
?>
|
||||
1198
include/limesurvey/admin/classes/xmlrpc/lib/xmlrpcs.inc
Normal file
1198
include/limesurvey/admin/classes/xmlrpc/lib/xmlrpcs.inc
Normal file
File diff suppressed because it is too large
Load Diff
400
include/limesurvey/admin/classes/xmlrpc/test/PHPUnit/Assert.php
Normal file
400
include/limesurvey/admin/classes/xmlrpc/test/PHPUnit/Assert.php
Normal file
@@ -0,0 +1,400 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: Assert.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* A set of assert methods.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_Assert {
|
||||
/**
|
||||
* @var boolean
|
||||
* @access private
|
||||
*/
|
||||
var $_looselyTyped = FALSE;
|
||||
|
||||
/**
|
||||
* Asserts that a haystack contains a needle.
|
||||
*
|
||||
* @param mixed
|
||||
* @param mixed
|
||||
* @param string
|
||||
* @access public
|
||||
* @since Method available since Release 1.1.0
|
||||
*/
|
||||
function assertContains($needle, $haystack, $message = '') {
|
||||
if (is_string($needle) && is_string($haystack)) {
|
||||
$this->assertTrue(strpos($haystack, $needle) !== FALSE, $message);
|
||||
}
|
||||
|
||||
else if (is_array($haystack) && !is_object($needle)) {
|
||||
$this->assertTrue(in_array($needle, $haystack), $message);
|
||||
}
|
||||
|
||||
else {
|
||||
$this->fail('Unsupported parameter passed to assertContains().');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a haystack does not contain a needle.
|
||||
*
|
||||
* @param mixed
|
||||
* @param mixed
|
||||
* @param string
|
||||
* @access public
|
||||
* @since Method available since Release 1.1.0
|
||||
*/
|
||||
function assertNotContains($needle, $haystack, $message = '') {
|
||||
if (is_string($needle) && is_string($haystack)) {
|
||||
$this->assertFalse(strpos($haystack, $needle) !== FALSE, $message);
|
||||
}
|
||||
|
||||
else if (is_array($haystack) && !is_object($needle)) {
|
||||
$this->assertFalse(in_array($needle, $haystack), $message);
|
||||
}
|
||||
|
||||
else {
|
||||
$this->fail('Unsupported parameter passed to assertNotContains().');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that two variables are equal.
|
||||
*
|
||||
* @param mixed
|
||||
* @param mixed
|
||||
* @param string
|
||||
* @param mixed
|
||||
* @access public
|
||||
*/
|
||||
function assertEquals($expected, $actual, $message = '', $delta = 0) {
|
||||
if ((is_array($actual) && is_array($expected)) ||
|
||||
(is_object($actual) && is_object($expected))) {
|
||||
if (is_array($actual) && is_array($expected)) {
|
||||
ksort($actual);
|
||||
ksort($expected);
|
||||
}
|
||||
|
||||
if ($this->_looselyTyped) {
|
||||
$actual = $this->_convertToString($actual);
|
||||
$expected = $this->_convertToString($expected);
|
||||
}
|
||||
|
||||
$actual = serialize($actual);
|
||||
$expected = serialize($expected);
|
||||
|
||||
$message = sprintf(
|
||||
'%sexpected %s, actual %s',
|
||||
|
||||
!empty($message) ? $message . ' ' : '',
|
||||
$expected,
|
||||
$actual
|
||||
);
|
||||
|
||||
if ($actual !== $expected) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
elseif (is_numeric($actual) && is_numeric($expected)) {
|
||||
$message = sprintf(
|
||||
'%sexpected %s%s, actual %s',
|
||||
|
||||
!empty($message) ? $message . ' ' : '',
|
||||
$expected,
|
||||
($delta != 0) ? ('+/- ' . $delta) : '',
|
||||
$actual
|
||||
);
|
||||
|
||||
if (!($actual >= ($expected - $delta) && $actual <= ($expected + $delta))) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
else {
|
||||
$message = sprintf(
|
||||
'%sexpected %s, actual %s',
|
||||
|
||||
!empty($message) ? $message . ' ' : '',
|
||||
$expected,
|
||||
$actual
|
||||
);
|
||||
|
||||
if ($actual !== $expected) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that two variables reference the same object.
|
||||
* This requires the Zend Engine 2 to work.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @param string
|
||||
* @access public
|
||||
* @deprecated
|
||||
*/
|
||||
function assertSame($expected, $actual, $message = '') {
|
||||
if (!version_compare(phpversion(), '5.0.0', '>=')) {
|
||||
$this->fail('assertSame() only works with PHP >= 5.0.0.');
|
||||
}
|
||||
|
||||
if ((is_object($expected) || is_null($expected)) &&
|
||||
(is_object($actual) || is_null($actual))) {
|
||||
$message = sprintf(
|
||||
'%sexpected two variables to reference the same object',
|
||||
|
||||
!empty($message) ? $message . ' ' : ''
|
||||
);
|
||||
|
||||
if ($expected !== $actual) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
} else {
|
||||
$this->fail('Unsupported parameter passed to assertSame().');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that two variables do not reference the same object.
|
||||
* This requires the Zend Engine 2 to work.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @param string
|
||||
* @access public
|
||||
* @deprecated
|
||||
*/
|
||||
function assertNotSame($expected, $actual, $message = '') {
|
||||
if (!version_compare(phpversion(), '5.0.0', '>=')) {
|
||||
$this->fail('assertNotSame() only works with PHP >= 5.0.0.');
|
||||
}
|
||||
|
||||
if ((is_object($expected) || is_null($expected)) &&
|
||||
(is_object($actual) || is_null($actual))) {
|
||||
$message = sprintf(
|
||||
'%sexpected two variables to reference different objects',
|
||||
|
||||
!empty($message) ? $message . ' ' : ''
|
||||
);
|
||||
|
||||
if ($expected === $actual) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
} else {
|
||||
$this->fail('Unsupported parameter passed to assertNotSame().');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a variable is not NULL.
|
||||
*
|
||||
* @param mixed
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function assertNotNull($actual, $message = '') {
|
||||
$message = sprintf(
|
||||
'%sexpected NOT NULL, actual NULL',
|
||||
|
||||
!empty($message) ? $message . ' ' : ''
|
||||
);
|
||||
|
||||
if (is_null($actual)) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a variable is NULL.
|
||||
*
|
||||
* @param mixed
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function assertNull($actual, $message = '') {
|
||||
$message = sprintf(
|
||||
'%sexpected NULL, actual NOT NULL',
|
||||
|
||||
!empty($message) ? $message . ' ' : ''
|
||||
);
|
||||
|
||||
if (!is_null($actual)) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a condition is true.
|
||||
*
|
||||
* @param boolean
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function assertTrue($condition, $message = '') {
|
||||
$message = sprintf(
|
||||
'%sexpected TRUE, actual FALSE',
|
||||
|
||||
!empty($message) ? $message . ' ' : ''
|
||||
);
|
||||
|
||||
if (!$condition) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a condition is false.
|
||||
*
|
||||
* @param boolean
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function assertFalse($condition, $message = '') {
|
||||
$message = sprintf(
|
||||
'%sexpected FALSE, actual TRUE',
|
||||
|
||||
!empty($message) ? $message . ' ' : ''
|
||||
);
|
||||
|
||||
if ($condition) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a string matches a given regular expression.
|
||||
*
|
||||
* @param string
|
||||
* @param string
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function assertRegExp($pattern, $string, $message = '') {
|
||||
$message = sprintf(
|
||||
'%s"%s" does not match pattern "%s"',
|
||||
|
||||
!empty($message) ? $message . ' ' : '',
|
||||
$string,
|
||||
$pattern
|
||||
);
|
||||
|
||||
if (!preg_match($pattern, $string)) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a string does not match a given regular expression.
|
||||
*
|
||||
* @param string
|
||||
* @param string
|
||||
* @param string
|
||||
* @access public
|
||||
* @since Method available since Release 1.1.0
|
||||
*/
|
||||
function assertNotRegExp($pattern, $string, $message = '') {
|
||||
$message = sprintf(
|
||||
'%s"%s" matches pattern "%s"',
|
||||
|
||||
!empty($message) ? $message . ' ' : '',
|
||||
$string,
|
||||
$pattern
|
||||
);
|
||||
|
||||
if (preg_match($pattern, $string)) {
|
||||
return $this->fail($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that a variable is of a given type.
|
||||
*
|
||||
* @param string $expected
|
||||
* @param mixed $actual
|
||||
* @param optional string $message
|
||||
* @access public
|
||||
*/
|
||||
function assertType($expected, $actual, $message = '') {
|
||||
return $this->assertEquals(
|
||||
$expected,
|
||||
gettype($actual),
|
||||
$message
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a value to a string.
|
||||
*
|
||||
* @param mixed $value
|
||||
* @access private
|
||||
*/
|
||||
function _convertToString($value) {
|
||||
foreach ($value as $k => $v) {
|
||||
if (is_array($v)) {
|
||||
$value[$k] = $this->_convertToString($value[$k]);
|
||||
} else {
|
||||
settype($value[$k], 'string');
|
||||
}
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param boolean $looselyTyped
|
||||
* @access public
|
||||
*/
|
||||
function setLooselyTyped($looselyTyped) {
|
||||
if (is_bool($looselyTyped)) {
|
||||
$this->_looselyTyped = $looselyTyped;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fails a test with the given message.
|
||||
*
|
||||
* @param string
|
||||
* @access protected
|
||||
* @abstract
|
||||
*/
|
||||
function fail($message = '') { /* abstract */ }
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
@@ -0,0 +1,267 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: TestCase.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
require_once 'PHPUnit/Assert.php';
|
||||
require_once 'PHPUnit/TestResult.php';
|
||||
|
||||
/**
|
||||
* A TestCase defines the fixture to run multiple tests.
|
||||
*
|
||||
* To define a TestCase
|
||||
*
|
||||
* 1) Implement a subclass of PHPUnit_TestCase.
|
||||
* 2) Define instance variables that store the state of the fixture.
|
||||
* 3) Initialize the fixture state by overriding setUp().
|
||||
* 4) Clean-up after a test by overriding tearDown().
|
||||
*
|
||||
* Each test runs in its own fixture so there can be no side effects
|
||||
* among test runs.
|
||||
*
|
||||
* Here is an example:
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* class MathTest extends PHPUnit_TestCase {
|
||||
* var $fValue1;
|
||||
* var $fValue2;
|
||||
*
|
||||
* function MathTest($name) {
|
||||
* $this->PHPUnit_TestCase($name);
|
||||
* }
|
||||
*
|
||||
* function setUp() {
|
||||
* $this->fValue1 = 2;
|
||||
* $this->fValue2 = 3;
|
||||
* }
|
||||
* }
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* For each test implement a method which interacts with the fixture.
|
||||
* Verify the expected results with assertions specified by calling
|
||||
* assert with a boolean.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* function testPass() {
|
||||
* $this->assertTrue($this->fValue1 + $this->fValue2 == 5);
|
||||
* }
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_TestCase extends PHPUnit_Assert {
|
||||
/**
|
||||
* @var boolean
|
||||
* @access private
|
||||
*/
|
||||
var $_failed = FALSE;
|
||||
|
||||
/**
|
||||
* The name of the test case.
|
||||
*
|
||||
* @var string
|
||||
* @access private
|
||||
*/
|
||||
var $_name = '';
|
||||
|
||||
/**
|
||||
* PHPUnit_TestResult object
|
||||
*
|
||||
* @var object
|
||||
* @access private
|
||||
*/
|
||||
var $_result;
|
||||
|
||||
/**
|
||||
* Constructs a test case with the given name.
|
||||
*
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function PHPUnit_TestCase($name = FALSE) {
|
||||
if ($name !== FALSE) {
|
||||
$this->setName($name);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Counts the number of test cases executed by run(TestResult result).
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function countTestCases() {
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the name of a TestCase.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function getName() {
|
||||
return $this->_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the test case and collects the results in a given TestResult object.
|
||||
*
|
||||
* @param object
|
||||
* @return object
|
||||
* @access public
|
||||
*/
|
||||
function run(&$result) {
|
||||
$this->_result = &$result;
|
||||
$this->_result->run($this);
|
||||
|
||||
return $this->_result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the bare test sequence.
|
||||
*
|
||||
* @access public
|
||||
*/
|
||||
function runBare() {
|
||||
$this->setUp();
|
||||
$this->runTest();
|
||||
$this->tearDown();
|
||||
$this->pass();
|
||||
}
|
||||
|
||||
/**
|
||||
* Override to run the test and assert its state.
|
||||
*
|
||||
* @access protected
|
||||
*/
|
||||
function runTest() {
|
||||
call_user_func(
|
||||
array(
|
||||
&$this,
|
||||
$this->_name
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the name of a TestCase.
|
||||
*
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function setName($name) {
|
||||
$this->_name = $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of the test case.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function toString() {
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a default TestResult object.
|
||||
*
|
||||
* @return object
|
||||
* @access protected
|
||||
*/
|
||||
function &createResult() {
|
||||
return new PHPUnit_TestResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fails a test with the given message.
|
||||
*
|
||||
* @param string
|
||||
* @access protected
|
||||
*/
|
||||
function fail($message = '') {
|
||||
if (function_exists('debug_backtrace')) {
|
||||
$trace = debug_backtrace();
|
||||
|
||||
if (isset($trace['1']['file'])) {
|
||||
$message = sprintf(
|
||||
"%s in %s:%s",
|
||||
|
||||
$message,
|
||||
$trace['1']['file'],
|
||||
$trace['1']['line']
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$this->_result->addFailure($this, $message);
|
||||
$this->_failed = TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Passes a test.
|
||||
*
|
||||
* @access protected
|
||||
*/
|
||||
function pass() {
|
||||
if (!$this->_failed) {
|
||||
$this->_result->addPassedTest($this);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets up the fixture, for example, open a network connection.
|
||||
* This method is called before a test is executed.
|
||||
*
|
||||
* @access protected
|
||||
* @abstract
|
||||
*/
|
||||
function setUp() { /* abstract */ }
|
||||
|
||||
/**
|
||||
* Tears down the fixture, for example, close a network connection.
|
||||
* This method is called after a test is executed.
|
||||
*
|
||||
* @access protected
|
||||
* @abstract
|
||||
*/
|
||||
function tearDown() { /* abstract */ }
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
@@ -0,0 +1,130 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: TestDecorator.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
require_once 'PHPUnit/TestCase.php';
|
||||
require_once 'PHPUnit/TestSuite.php';
|
||||
|
||||
if (!function_exists('is_a')) {
|
||||
require_once 'PHP/Compat/Function/is_a.php';
|
||||
}
|
||||
|
||||
/**
|
||||
* A Decorator for Tests.
|
||||
*
|
||||
* Use TestDecorator as the base class for defining new
|
||||
* test decorators. Test decorator subclasses can be introduced
|
||||
* to add behaviour before or after a test is run.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_TestDecorator {
|
||||
/**
|
||||
* The Test to be decorated.
|
||||
*
|
||||
* @var object
|
||||
* @access protected
|
||||
*/
|
||||
var $_test = NULL;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function PHPUnit_TestDecorator(&$test) {
|
||||
if (is_object($test) &&
|
||||
(is_a($test, 'PHPUnit_TestCase') ||
|
||||
is_a($test, 'PHPUnit_TestSuite'))) {
|
||||
|
||||
$this->_test = &$test;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the test and collects the
|
||||
* result in a TestResult.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function basicRun(&$result) {
|
||||
$this->_test->run($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Counts the number of test cases that
|
||||
* will be run by this test.
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function countTestCases() {
|
||||
return $this->_test->countTestCases();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the test to be run.
|
||||
*
|
||||
* @return object
|
||||
* @access public
|
||||
*/
|
||||
function &getTest() {
|
||||
return $this->_test;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the decorated test and collects the
|
||||
* result in a TestResult.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
* @abstract
|
||||
*/
|
||||
function run(&$result) { /* abstract */ }
|
||||
|
||||
/**
|
||||
* Returns a string representation of the test.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function toString() {
|
||||
return $this->_test->toString();
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
@@ -0,0 +1,104 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: TestFailure.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* A TestFailure collects a failed test together with the caught exception.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_TestFailure {
|
||||
/**
|
||||
* @var object
|
||||
* @access private
|
||||
*/
|
||||
var $_failedTest;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
* @access private
|
||||
*/
|
||||
var $_thrownException;
|
||||
|
||||
/**
|
||||
* Constructs a TestFailure with the given test and exception.
|
||||
*
|
||||
* @param object
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function PHPUnit_TestFailure(&$failedTest, &$thrownException) {
|
||||
$this->_failedTest = &$failedTest;
|
||||
$this->_thrownException = &$thrownException;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the failed test.
|
||||
*
|
||||
* @return object
|
||||
* @access public
|
||||
*/
|
||||
function &failedTest() {
|
||||
return $this->_failedTest;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the thrown exception.
|
||||
*
|
||||
* @return object
|
||||
* @access public
|
||||
*/
|
||||
function &thrownException() {
|
||||
return $this->_thrownException;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a short description of the failure.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function toString() {
|
||||
return sprintf(
|
||||
"TestCase %s->%s() failed: %s\n",
|
||||
|
||||
get_class($this->_failedTest),
|
||||
$this->_failedTest->getName(),
|
||||
$this->_thrownException
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
@@ -0,0 +1,136 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: TestListener.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* A Listener for test progress.
|
||||
*
|
||||
* Here is an example:
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* require_once 'PHPUnit.php';
|
||||
* require_once 'PHPUnit/TestListener.php';
|
||||
*
|
||||
* class MathTest extends PHPUnit_TestCase {
|
||||
* var $fValue1;
|
||||
* var $fValue2;
|
||||
*
|
||||
* function MathTest($name) {
|
||||
* $this->PHPUnit_TestCase($name);
|
||||
* }
|
||||
*
|
||||
* function setUp() {
|
||||
* $this->fValue1 = 2;
|
||||
* $this->fValue2 = 3;
|
||||
* }
|
||||
*
|
||||
* function testAdd() {
|
||||
* $this->assertTrue($this->fValue1 + $this->fValue2 == 4);
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* class MyListener extends PHPUnit_TestListener {
|
||||
* function addError(&$test, &$t) {
|
||||
* print "MyListener::addError() called.\n";
|
||||
* }
|
||||
*
|
||||
* function addFailure(&$test, &$t) {
|
||||
* print "MyListener::addFailure() called.\n";
|
||||
* }
|
||||
*
|
||||
* function endTest(&$test) {
|
||||
* print "MyListener::endTest() called.\n";
|
||||
* }
|
||||
*
|
||||
* function startTest(&$test) {
|
||||
* print "MyListener::startTest() called.\n";
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* $suite = new PHPUnit_TestSuite;
|
||||
* $suite->addTest(new MathTest('testAdd'));
|
||||
*
|
||||
* $result = new PHPUnit_TestResult;
|
||||
* $result->addListener(new MyListener);
|
||||
*
|
||||
* $suite->run($result);
|
||||
* print $result->toString();
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_TestListener {
|
||||
/**
|
||||
* An error occurred.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @access public
|
||||
* @abstract
|
||||
*/
|
||||
function addError(&$test, &$t) { /*abstract */ }
|
||||
|
||||
/**
|
||||
* A failure occurred.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @access public
|
||||
* @abstract
|
||||
*/
|
||||
function addFailure(&$test, &$t) { /*abstract */ }
|
||||
|
||||
/**
|
||||
* A test ended.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
* @abstract
|
||||
*/
|
||||
function endTest(&$test) { /*abstract */ }
|
||||
|
||||
/**
|
||||
* A test started.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
* @abstract
|
||||
*/
|
||||
function startTest(&$test) { /*abstract */ }
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
@@ -0,0 +1,321 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: TestResult.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
require_once 'PHPUnit/TestFailure.php';
|
||||
require_once 'PHPUnit/TestListener.php';
|
||||
|
||||
if (!function_exists('is_a')) {
|
||||
require_once 'PHP/Compat/Function/is_a.php';
|
||||
}
|
||||
|
||||
/**
|
||||
* A TestResult collects the results of executing a test case.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_TestResult {
|
||||
/**
|
||||
* @var array
|
||||
* @access protected
|
||||
*/
|
||||
var $_errors = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
* @access protected
|
||||
*/
|
||||
var $_failures = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
* @access protected
|
||||
*/
|
||||
var $_listeners = array();
|
||||
|
||||
/**
|
||||
* @var array
|
||||
* @access protected
|
||||
*/
|
||||
var $_passedTests = array();
|
||||
|
||||
/**
|
||||
* @var integer
|
||||
* @access protected
|
||||
*/
|
||||
var $_runTests = 0;
|
||||
|
||||
/**
|
||||
* @var boolean
|
||||
* @access private
|
||||
*/
|
||||
var $_stop = FALSE;
|
||||
|
||||
/**
|
||||
* Adds an error to the list of errors.
|
||||
* The passed in exception caused the error.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function addError(&$test, &$t) {
|
||||
$this->_errors[] = new PHPUnit_TestFailure($test, $t);
|
||||
|
||||
for ($i = 0; $i < sizeof($this->_listeners); $i++) {
|
||||
$this->_listeners[$i]->addError($test, $t);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a failure to the list of failures.
|
||||
* The passed in exception caused the failure.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function addFailure(&$test, &$t) {
|
||||
$this->_failures[] = new PHPUnit_TestFailure($test, $t);
|
||||
|
||||
for ($i = 0; $i < sizeof($this->_listeners); $i++) {
|
||||
$this->_listeners[$i]->addFailure($test, $t);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a TestListener.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function addListener(&$listener) {
|
||||
if (is_object($listener) &&
|
||||
is_a($listener, 'PHPUnit_TestListener')) {
|
||||
$this->_listeners[] = &$listener;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a passed test to the list of passed tests.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function addPassedTest(&$test) {
|
||||
$this->_passedTests[] = &$test;
|
||||
}
|
||||
|
||||
/**
|
||||
* Informs the result that a test was completed.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function endTest(&$test) {
|
||||
for ($i = 0; $i < sizeof($this->_listeners); $i++) {
|
||||
$this->_listeners[$i]->endTest($test);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the number of detected errors.
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function errorCount() {
|
||||
return sizeof($this->_errors);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an Enumeration for the errors.
|
||||
*
|
||||
* @return array
|
||||
* @access public
|
||||
*/
|
||||
function &errors() {
|
||||
return $this->_errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the number of detected failures.
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function failureCount() {
|
||||
return sizeof($this->_failures);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an Enumeration for the failures.
|
||||
*
|
||||
* @return array
|
||||
* @access public
|
||||
*/
|
||||
function &failures() {
|
||||
return $this->_failures;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an Enumeration for the passed tests.
|
||||
*
|
||||
* @return array
|
||||
* @access public
|
||||
*/
|
||||
function &passedTests() {
|
||||
return $this->_passedTests;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregisters a TestListener.
|
||||
* This requires the Zend Engine 2 (to work properly).
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function removeListener(&$listener) {
|
||||
for ($i = 0; $i < sizeof($this->_listeners); $i++) {
|
||||
if ($this->_listeners[$i] === $listener) {
|
||||
unset($this->_listeners[$i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs a TestCase.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function run(&$test) {
|
||||
$this->startTest($test);
|
||||
$this->_runTests++;
|
||||
$test->runBare();
|
||||
$this->endTest($test);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the number of run tests.
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function runCount() {
|
||||
return $this->_runTests;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the test run should stop.
|
||||
*
|
||||
* @access public
|
||||
*/
|
||||
function shouldStop() {
|
||||
return $this->_stop;
|
||||
}
|
||||
|
||||
/**
|
||||
* Informs the result that a test will be started.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function startTest(&$test) {
|
||||
for ($i = 0; $i < sizeof($this->_listeners); $i++) {
|
||||
$this->_listeners[$i]->startTest($test);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Marks that the test run should stop.
|
||||
*
|
||||
* @access public
|
||||
*/
|
||||
function stop() {
|
||||
$this->_stop = TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a HTML representation of the test result.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function toHTML() {
|
||||
return '<pre>' . htmlspecialchars($this->toString()) . '</pre>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a text representation of the test result.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function toString() {
|
||||
$result = '';
|
||||
|
||||
foreach ($this->_passedTests as $passedTest) {
|
||||
$result .= sprintf(
|
||||
"TestCase %s->%s() passed\n",
|
||||
|
||||
get_class($passedTest),
|
||||
$passedTest->getName()
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($this->_failures as $failedTest) {
|
||||
$result .= $failedTest->toString();
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the entire test was successful or not.
|
||||
*
|
||||
* @return boolean
|
||||
* @access public
|
||||
*/
|
||||
function wasSuccessful() {
|
||||
if (empty($this->_errors) && empty($this->_failures)) {
|
||||
return TRUE;
|
||||
} else {
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
@@ -0,0 +1,239 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: TestSuite.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
require_once 'PHPUnit/TestCase.php';
|
||||
|
||||
/**
|
||||
* A TestSuite is a Composite of Tests. It runs a collection of test cases.
|
||||
*
|
||||
* Here is an example using the dynamic test definition.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $suite = new PHPUnit_TestSuite();
|
||||
* $suite->addTest(new MathTest('testPass'));
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* Alternatively, a TestSuite can extract the tests to be run automatically.
|
||||
* To do so you pass the classname of your TestCase class to the TestSuite
|
||||
* constructor.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $suite = new TestSuite('classname');
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* This constructor creates a suite with all the methods starting with
|
||||
* "test" that take no arguments.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit_TestSuite {
|
||||
/**
|
||||
* The name of the test suite.
|
||||
*
|
||||
* @var string
|
||||
* @access private
|
||||
*/
|
||||
var $_name = '';
|
||||
|
||||
/**
|
||||
* The tests in the test suite.
|
||||
*
|
||||
* @var array
|
||||
* @access private
|
||||
*/
|
||||
var $_tests = array();
|
||||
|
||||
/**
|
||||
* Constructs a TestSuite.
|
||||
*
|
||||
* @param mixed
|
||||
* @access public
|
||||
*/
|
||||
function PHPUnit_TestSuite($test = FALSE) {
|
||||
if ($test !== FALSE) {
|
||||
$this->setName($test);
|
||||
$this->addTestSuite($test);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a test to the suite.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function addTest(&$test) {
|
||||
$this->_tests[] = &$test;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the tests from the given class to the suite.
|
||||
*
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function addTestSuite($testClass) {
|
||||
if (class_exists($testClass)) {
|
||||
$methods = get_class_methods($testClass);
|
||||
$parentClasses = array(strtolower($testClass));
|
||||
$parentClass = $testClass;
|
||||
|
||||
while(is_string($parentClass = get_parent_class($parentClass))) {
|
||||
$parentClasses[] = $parentClass;
|
||||
}
|
||||
|
||||
foreach ($methods as $method) {
|
||||
if (substr($method, 0, 4) == 'test' &&
|
||||
!in_array($method, $parentClasses)) {
|
||||
$this->addTest(new $testClass($method));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Counts the number of test cases that will be run by this test.
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function countTestCases() {
|
||||
$count = 0;
|
||||
|
||||
foreach ($this->_tests as $test) {
|
||||
$count += $test->countTestCases();
|
||||
}
|
||||
|
||||
return $count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of the suite.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function getName() {
|
||||
return $this->_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the tests and collects their result in a TestResult.
|
||||
*
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function run(&$result, $show_progress='') {
|
||||
for ($i = 0; $i < sizeof($this->_tests) && !$result->shouldStop(); $i++) {
|
||||
$this->_tests[$i]->run($result);
|
||||
if ($show_progress != '') {
|
||||
echo $show_progress; flush();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs a test.
|
||||
*
|
||||
* @param object
|
||||
* @param object
|
||||
* @access public
|
||||
*/
|
||||
function runTest(&$test, &$result) {
|
||||
$test->run($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the name of the suite.
|
||||
*
|
||||
* @param string
|
||||
* @access public
|
||||
*/
|
||||
function setName($name) {
|
||||
$this->_name = $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the test at the given index.
|
||||
*
|
||||
* @param integer
|
||||
* @return object
|
||||
* @access public
|
||||
*/
|
||||
function &testAt($index) {
|
||||
if (isset($this->_tests[$index])) {
|
||||
return $this->_tests[$index];
|
||||
} else {
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of tests in this suite.
|
||||
*
|
||||
* @return integer
|
||||
* @access public
|
||||
*/
|
||||
function testCount() {
|
||||
return sizeof($this->_tests);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the tests as an enumeration.
|
||||
*
|
||||
* @return array
|
||||
* @access public
|
||||
*/
|
||||
function &tests() {
|
||||
return $this->_tests;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of the test suite.
|
||||
*
|
||||
* @return string
|
||||
* @access public
|
||||
*/
|
||||
function toString() {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
264
include/limesurvey/admin/classes/xmlrpc/test/benchmark.php
Normal file
264
include/limesurvey/admin/classes/xmlrpc/test/benchmark.php
Normal file
@@ -0,0 +1,264 @@
|
||||
<?php
|
||||
/**
|
||||
* Benchamrking suite for the PHP-XMLRPC lib
|
||||
* @author Gaetano Giunta
|
||||
* @version $Id: benchmark.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @copyright (c) 2005-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
**/
|
||||
|
||||
include(getcwd().'/parse_args.php');
|
||||
|
||||
require_once('xmlrpc.inc');
|
||||
|
||||
// Set up PHP structures to be used in many tests
|
||||
$data1 = array(1, 1.0, 'hello world', true, '20051021T23:43:00', -1, 11.0, '~!@#$%^&*()_+|', false, '20051021T23:43:00');
|
||||
$data2 = array('zero' => $data1, 'one' => $data1, 'two' => $data1, 'three' => $data1, 'four' => $data1, 'five' => $data1, 'six' => $data1, 'seven' => $data1, 'eight' => $data1, 'nine' => $data1);
|
||||
$data = array($data2, $data2, $data2, $data2, $data2, $data2, $data2, $data2, $data2, $data2);
|
||||
$keys = array('zero', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine');
|
||||
|
||||
$test_results=array();
|
||||
$xd = extension_loaded('xdebug') && ini_get('xdebug.profiler_enable');
|
||||
if ($xd)
|
||||
$num_tests = 1;
|
||||
else
|
||||
$num_tests = 10;
|
||||
|
||||
$title = 'XML-RPC Benchmark Tests';
|
||||
|
||||
if(isset($_SERVER['REQUEST_METHOD']))
|
||||
{
|
||||
echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">\n<head>\n<title>$title</title>\n</head>\n<body>\n<h1>$title</h1>\n<pre>\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
echo "$title\n\n";
|
||||
}
|
||||
|
||||
if(isset($_SERVER['REQUEST_METHOD']))
|
||||
{
|
||||
echo "<h3>Using lib version: $xmlrpcVersion on PHP version: ".phpversion()."</h3>\n";
|
||||
if ($xd) echo "<h4>XDEBUG profiling enabled: skipping remote tests. Trace file is: ".htmlspecialchars(xdebug_get_profiler_filename())."</h4>\n";
|
||||
flush();
|
||||
}
|
||||
else
|
||||
{
|
||||
echo "Using lib version: $xmlrpcVersion on PHP version: ".phpversion()."\n";
|
||||
if ($xd) echo "XDEBUG profiling enabled: skipping remote tests\nTrace file is: ".xdebug_get_profiler_filename()."\n";
|
||||
}
|
||||
|
||||
// test 'old style' data encoding vs. 'automatic style' encoding
|
||||
begin_test('Data encoding (large array)', 'manual encoding');
|
||||
for ($i = 0; $i < $num_tests; $i++)
|
||||
{
|
||||
$vals = array();
|
||||
for ($j = 0; $j < 10; $j++)
|
||||
{
|
||||
$valarray = array();
|
||||
foreach ($data[$j] as $key => $val)
|
||||
{
|
||||
$values = array();
|
||||
$values[] =& new xmlrpcval($val[0], 'int');
|
||||
$values[] =& new xmlrpcval($val[1], 'double');
|
||||
$values[] =& new xmlrpcval($val[2], 'string');
|
||||
$values[] =& new xmlrpcval($val[3], 'boolean');
|
||||
$values[] =& new xmlrpcval($val[4], 'dateTime.iso8601');
|
||||
$values[] =& new xmlrpcval($val[5], 'i4');
|
||||
$values[] =& new xmlrpcval($val[6], 'double');
|
||||
$values[] =& new xmlrpcval($val[7], 'string');
|
||||
$values[] =& new xmlrpcval($val[8], 'boolean');
|
||||
$values[] =& new xmlrpcval($val[9], 'dateTime.iso8601');
|
||||
$valarray[$key] =& new xmlrpcval($values, 'array');
|
||||
}
|
||||
$vals[] =& new xmlrpcval($valarray, 'struct');
|
||||
}
|
||||
$value =& new xmlrpcval($vals, 'array');
|
||||
$out = $value->serialize();
|
||||
}
|
||||
end_test('Data encoding (large array)', 'manual encoding', $out);
|
||||
|
||||
begin_test('Data encoding (large array)', 'automatic encoding');
|
||||
for ($i = 0; $i < $num_tests; $i++)
|
||||
{
|
||||
$value =& php_xmlrpc_encode($data, array('auto_dates'));
|
||||
$out = $value->serialize();
|
||||
}
|
||||
end_test('Data encoding (large array)', 'automatic encoding', $out);
|
||||
|
||||
if (function_exists('xmlrpc_set_type'))
|
||||
{
|
||||
begin_test('Data encoding (large array)', 'xmlrpc-epi encoding');
|
||||
for ($i = 0; $i < $num_tests; $i++)
|
||||
{
|
||||
for ($j = 0; $j < 10; $j++)
|
||||
foreach ($keys as $k)
|
||||
{
|
||||
xmlrpc_set_type($data[$j][$k][4], 'datetime');
|
||||
xmlrpc_set_type($data[$j][$k][8], 'datetime');
|
||||
}
|
||||
$out = xmlrpc_encode($data);
|
||||
}
|
||||
end_test('Data encoding (large array)', 'xmlrpc-epi encoding', $out);
|
||||
}
|
||||
|
||||
// test 'old style' data decoding vs. 'automatic style' decoding
|
||||
$dummy = new xmlrpcmsg('');
|
||||
$out = new xmlrpcresp($value);
|
||||
$in = '<?xml version="1.0" ?>'."\n".$out->serialize();
|
||||
|
||||
begin_test('Data decoding (large array)', 'manual decoding');
|
||||
for ($i = 0; $i < $num_tests; $i++)
|
||||
{
|
||||
$response =& $dummy->ParseResponse($in, true);
|
||||
$value = $response->value();
|
||||
$result = array();
|
||||
for ($k = 0; $k < $value->arraysize(); $k++)
|
||||
{
|
||||
$val1 = $value->arraymem($k);
|
||||
$out = array();
|
||||
while (list($name, $val) = $val1->structeach())
|
||||
{
|
||||
$out[$name] = array();
|
||||
for ($j = 0; $j < $val->arraysize(); $j++)
|
||||
{
|
||||
$data = $val->arraymem($j);
|
||||
$out[$name][] = $data->scalarval();
|
||||
}
|
||||
} // while
|
||||
$result[] = $out;
|
||||
}
|
||||
}
|
||||
end_test('Data decoding (large array)', 'manual decoding', $result);
|
||||
|
||||
begin_test('Data decoding (large array)', 'automatic decoding');
|
||||
for ($i = 0; $i < $num_tests; $i++)
|
||||
{
|
||||
$response =& $dummy->ParseResponse($in, true, 'phpvals');
|
||||
$value = $response->value();
|
||||
}
|
||||
end_test('Data decoding (large array)', 'automatic decoding', $value);
|
||||
|
||||
if (function_exists('xmlrpc_decode'))
|
||||
{
|
||||
begin_test('Data decoding (large array)', 'xmlrpc-epi decoding');
|
||||
for ($i = 0; $i < $num_tests; $i++)
|
||||
{
|
||||
$response =& $dummy->ParseResponse($in, true, 'xml');
|
||||
$value = xmlrpc_decode($response->value());
|
||||
}
|
||||
end_test('Data decoding (large array)', 'xmlrpc-epi decoding', $value);
|
||||
}
|
||||
|
||||
if (!$xd) {
|
||||
|
||||
/// test multicall vs. many calls vs. keep-alives
|
||||
$value = php_xmlrpc_encode($data1);
|
||||
$msg =& new xmlrpcmsg('interopEchoTests.echoValue', array($value));
|
||||
$msgs=array();
|
||||
for ($i = 0; $i < 25; $i++)
|
||||
$msgs[] = $msg;
|
||||
$server = split(':', $LOCALSERVER);
|
||||
if(count($server) > 1)
|
||||
{
|
||||
$c =& new xmlrpc_client($URI, $server[0], $server[1]);
|
||||
}
|
||||
else
|
||||
{
|
||||
$c =& new xmlrpc_client($URI, $LOCALSERVER);
|
||||
}
|
||||
// do not interfere with http compression
|
||||
$c->accepted_compression = array();
|
||||
//$c->debug=true;
|
||||
|
||||
if (function_exists('gzinflate')) {
|
||||
$c->accepted_compression = null;
|
||||
}
|
||||
begin_test('Repeated send (small array)', 'http 10');
|
||||
$response = array();
|
||||
for ($i = 0; $i < 25; $i++)
|
||||
{
|
||||
$resp =& $c->send($msg);
|
||||
$response[] = $resp->value();
|
||||
}
|
||||
end_test('Repeated send (small array)', 'http 10', $response);
|
||||
|
||||
if (function_exists('curl_init'))
|
||||
{
|
||||
begin_test('Repeated send (small array)', 'http 11 w. keep-alive');
|
||||
$response = array();
|
||||
for ($i = 0; $i < 25; $i++)
|
||||
{
|
||||
$resp =& $c->send($msg, 10, 'http11');
|
||||
$response[] = $resp->value();
|
||||
}
|
||||
end_test('Repeated send (small array)', 'http 11 w. keep-alive', $response);
|
||||
|
||||
$c->keepalive = false;
|
||||
begin_test('Repeated send (small array)', 'http 11');
|
||||
$response = array();
|
||||
for ($i = 0; $i < 25; $i++)
|
||||
{
|
||||
$resp =& $c->send($msg, 10, 'http11');
|
||||
$response[] = $resp->value();
|
||||
}
|
||||
end_test('Repeated send (small array)', 'http 11', $response);
|
||||
}
|
||||
|
||||
begin_test('Repeated send (small array)', 'multicall');
|
||||
$response =& $c->send($msgs);
|
||||
end_test('Repeated send (small array)', 'multicall', $response);
|
||||
|
||||
if (function_exists('gzinflate'))
|
||||
{
|
||||
$c->accepted_compression = array('gzip');
|
||||
$c->request_compression = 'gzip';
|
||||
|
||||
begin_test('Repeated send (small array)', 'http 10 w. compression');
|
||||
$response = array();
|
||||
for ($i = 0; $i < 25; $i++)
|
||||
{
|
||||
$resp =& $c->send($msg);
|
||||
$response[] = $resp->value();
|
||||
}
|
||||
end_test('Repeated send (small array)', 'http 10 w. compression', $response);
|
||||
}
|
||||
|
||||
} // end of 'if no xdebug profiling'
|
||||
|
||||
function begin_test($test_name, $test_case)
|
||||
{
|
||||
global $test_results;
|
||||
if (!isset($test_results[$test_name]))
|
||||
$test_results[$test_name]=array();
|
||||
$test_results[$test_name][$test_case] = array();
|
||||
list($micro, $sec) = explode(' ', microtime());
|
||||
$test_results[$test_name][$test_case]['time'] = $sec + $micro;
|
||||
}
|
||||
|
||||
function end_test($test_name, $test_case, $test_result)
|
||||
{
|
||||
global $test_results;
|
||||
list($micro, $sec) = explode(' ', microtime());
|
||||
if (!isset($test_results[$test_name][$test_case]))
|
||||
trigger_error('ending test that was not sterted');
|
||||
$test_results[$test_name][$test_case]['time'] = $sec + $micro - $test_results[$test_name][$test_case]['time'];
|
||||
$test_results[$test_name][$test_case]['result'] = $test_result;
|
||||
echo '.';
|
||||
flush();
|
||||
}
|
||||
|
||||
|
||||
echo "\n";
|
||||
foreach($test_results as $test => $results)
|
||||
{
|
||||
echo "\nTEST: $test\n";
|
||||
foreach ($results as $case => $data)
|
||||
echo " $case: {$data['time']} secs - Output data CRC: ".crc32(serialize($data['result']))."\n";
|
||||
}
|
||||
|
||||
|
||||
if(isset($_SERVER['REQUEST_METHOD']))
|
||||
{
|
||||
echo "\n</pre>\n</body>\n</html>\n";
|
||||
}
|
||||
?>
|
||||
132
include/limesurvey/admin/classes/xmlrpc/test/parse_args.php
Normal file
132
include/limesurvey/admin/classes/xmlrpc/test/parse_args.php
Normal file
@@ -0,0 +1,132 @@
|
||||
<?php
|
||||
/**
|
||||
* Common parameter parsing for benchmarks and tests scripts
|
||||
*
|
||||
* @param integer DEBUG
|
||||
* @param string LOCALSERVER
|
||||
* @param string URI
|
||||
* @param string HTTPSSERVER
|
||||
* @param string HTTPSSURI
|
||||
* @param string PROXY
|
||||
*
|
||||
* @version $Id: parse_args.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @copyright (C) 2007-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
**/
|
||||
|
||||
require_once('xmlrpc.inc');
|
||||
require_once('xmlrpcs.inc');
|
||||
|
||||
// play nice to older PHP versions that miss superglobals
|
||||
if(!isset($_SERVER))
|
||||
{
|
||||
$_SERVER = $HTTP_SERVER_VARS;
|
||||
$_GET = isset($HTTP_GET_VARS) ? $HTTP_GET_VARS : array();
|
||||
$_POST = isset($HTTP_POST_VARS) ? $HTTP_POST_VARS : array();
|
||||
}
|
||||
|
||||
// check for command line vs web page input params
|
||||
if(!isset($_SERVER['REQUEST_METHOD']))
|
||||
{
|
||||
if(isset($argv))
|
||||
{
|
||||
foreach($argv as $param)
|
||||
{
|
||||
$param = explode('=', $param);
|
||||
if(count($param) > 1)
|
||||
{
|
||||
$$param[0]=$param[1];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
elseif(!ini_get('register_globals'))
|
||||
{
|
||||
// play nice to 'safe' PHP installations with register globals OFF
|
||||
// NB: we might as well consider using $_GET stuff later on...
|
||||
extract($_GET);
|
||||
extract($_POST);
|
||||
}
|
||||
|
||||
if(!isset($DEBUG))
|
||||
{
|
||||
$DEBUG = 0;
|
||||
}
|
||||
else
|
||||
{
|
||||
$DEBUG = intval($DEBUG);
|
||||
}
|
||||
|
||||
if(!isset($LOCALSERVER))
|
||||
{
|
||||
if(isset($HTTP_HOST))
|
||||
{
|
||||
$LOCALSERVER = $HTTP_HOST;
|
||||
}
|
||||
elseif(isset($_SERVER['HTTP_HOST']))
|
||||
{
|
||||
$LOCALSERVER = $_SERVER['HTTP_HOST'];
|
||||
}
|
||||
else
|
||||
{
|
||||
$LOCALSERVER = 'localhost';
|
||||
}
|
||||
}
|
||||
if(!isset($HTTPSSERVER))
|
||||
{
|
||||
$HTTPSSERVER = 'xmlrpc.usefulinc.com';
|
||||
}
|
||||
if(!isset($HTTPSURI))
|
||||
{
|
||||
$HTTPSURI = '/server.php';
|
||||
}
|
||||
if(!isset($PROXY))
|
||||
{
|
||||
$PROXYSERVER = null;
|
||||
}
|
||||
else
|
||||
{
|
||||
$arr = explode(':',$PROXY);
|
||||
$PROXYSERVER = $arr[0];
|
||||
if(count($arr) > 1)
|
||||
{
|
||||
$PROXYPORT = $arr[1];
|
||||
}
|
||||
else
|
||||
{
|
||||
$PROXYPORT = 8080;
|
||||
}
|
||||
}
|
||||
if(!isset($URI))
|
||||
{
|
||||
// GUESTIMATE the url of local demo server
|
||||
// play nice to php 3 and 4-5 in retrieving URL of server.php
|
||||
/// @todo filter out query string from REQUEST_URI
|
||||
if(isset($REQUEST_URI))
|
||||
{
|
||||
$URI = str_replace('/test/testsuite.php', '/demo/server/server.php', $REQUEST_URI);
|
||||
$URI = str_replace('/testsuite.php', '/server.php', $URI);
|
||||
$URI = str_replace('/test/benchmark.php', '/server.php', $URI);
|
||||
$URI = str_replace('/benchmark.php', '/server.php', $URI);
|
||||
}
|
||||
elseif(isset($_SERVER['PHP_SELF']) && isset($_SERVER['REQUEST_METHOD']))
|
||||
{
|
||||
$URI = str_replace('/test/testsuite.php', '/demo/server/server.php', $_SERVER['PHP_SELF']);
|
||||
$URI = str_replace('/testsuite.php', '/server.php', $URI);
|
||||
$URI = str_replace('/test/benchmark.php', '/server.php', $URI);
|
||||
$URI = str_replace('/benchmark.php', '/server.php', $URI);
|
||||
}
|
||||
else
|
||||
{
|
||||
$URI = '/demo/server/server.php';
|
||||
}
|
||||
}
|
||||
if($URI[0] != '/')
|
||||
{
|
||||
$URI = '/'.$URI;
|
||||
}
|
||||
if(!isset($LOCALPATH))
|
||||
{
|
||||
$LOCALPATH = dirname(__FILE__);
|
||||
}
|
||||
?>
|
||||
106
include/limesurvey/admin/classes/xmlrpc/test/phpunit.php
Normal file
106
include/limesurvey/admin/classes/xmlrpc/test/phpunit.php
Normal file
@@ -0,0 +1,106 @@
|
||||
<?php
|
||||
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||||
|
||||
/**
|
||||
* PHP Version 4
|
||||
*
|
||||
* LICENSE: This source file is subject to version 3.0 of the PHP license
|
||||
* that is available through the world-wide-web at the following URI:
|
||||
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
|
||||
* the PHP License and are unable to obtain it through the web, please
|
||||
* send a note to license@php.net so we can mail you a copy immediately.
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version CVS: $Id: phpunit.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since File available since Release 1.0.0
|
||||
*/
|
||||
|
||||
require_once 'PHPUnit/TestCase.php';
|
||||
require_once 'PHPUnit/TestResult.php';
|
||||
require_once 'PHPUnit/TestSuite.php';
|
||||
|
||||
/**
|
||||
* PHPUnit runs a TestSuite and returns a TestResult object.
|
||||
*
|
||||
* Here is an example:
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* require_once 'PHPUnit.php';
|
||||
*
|
||||
* class MathTest extends PHPUnit_TestCase {
|
||||
* var $fValue1;
|
||||
* var $fValue2;
|
||||
*
|
||||
* function MathTest($name) {
|
||||
* $this->PHPUnit_TestCase($name);
|
||||
* }
|
||||
*
|
||||
* function setUp() {
|
||||
* $this->fValue1 = 2;
|
||||
* $this->fValue2 = 3;
|
||||
* }
|
||||
*
|
||||
* function testAdd() {
|
||||
* $this->assertTrue($this->fValue1 + $this->fValue2 == 5);
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* $suite = new PHPUnit_TestSuite();
|
||||
* $suite->addTest(new MathTest('testAdd'));
|
||||
*
|
||||
* $result = PHPUnit::run($suite);
|
||||
* print $result->toHTML();
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* Alternatively, you can pass a class name to the PHPUnit_TestSuite()
|
||||
* constructor and let it automatically add all methods of that class
|
||||
* that start with 'test' to the suite:
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $suite = new PHPUnit_TestSuite('MathTest');
|
||||
* $result = PHPUnit::run($suite);
|
||||
* print $result->toHTML();
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @category Testing
|
||||
* @package PHPUnit
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @license http://www.php.net/license/3_0.txt PHP License 3.0
|
||||
* @version Release: @package_version@
|
||||
* @link http://pear.php.net/package/PHPUnit
|
||||
* @since Class available since Release 1.0.0
|
||||
*/
|
||||
class PHPUnit {
|
||||
/**
|
||||
* Runs a test(suite).
|
||||
*
|
||||
* @param mixed
|
||||
* @return PHPUnit_TestResult
|
||||
* @access public
|
||||
*/
|
||||
function &run(&$suite, $show_progress=false) {
|
||||
$result = new PHPUnit_TestResult();
|
||||
$suite->run($result, $show_progress);
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Local variables:
|
||||
* tab-width: 4
|
||||
* c-basic-offset: 4
|
||||
* c-hanging-comment-ender-p: nil
|
||||
* End:
|
||||
*/
|
||||
?>
|
||||
1473
include/limesurvey/admin/classes/xmlrpc/test/testsuite.php
Normal file
1473
include/limesurvey/admin/classes/xmlrpc/test/testsuite.php
Normal file
File diff suppressed because it is too large
Load Diff
202
include/limesurvey/admin/classes/xmlrpc/test/verify_compat.php
Normal file
202
include/limesurvey/admin/classes/xmlrpc/test/verify_compat.php
Normal file
@@ -0,0 +1,202 @@
|
||||
<?php
|
||||
/**
|
||||
* Verify compatibility level of current php install with php-xmlrpc lib
|
||||
*
|
||||
* @version $Id: verify_compat.php 2 2009-03-16 20:22:51Z ggiunta $
|
||||
* @author Gaetano Giunta
|
||||
* @copyright (C) 2006-2008 G. Giunta
|
||||
* @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt
|
||||
*/
|
||||
|
||||
// be backward compat up to version 4.0.5...
|
||||
if (!function_exists('version_compare'))
|
||||
{
|
||||
// give an opportunity to user to specify where to include other files from
|
||||
if(!defined('PHP_XMLRPC_COMPAT_DIR'))
|
||||
{
|
||||
define('PHP_XMLRPC_COMPAT_DIR',dirname(__FILE__).'/compat/');
|
||||
}
|
||||
include(PHP_XMLRPC_COMPAT_DIR.'version_compare.php');
|
||||
}
|
||||
|
||||
function phpxmlrpc_verify_compat($mode='client')
|
||||
{
|
||||
$tests = array();
|
||||
|
||||
if ($mode == 'server')
|
||||
{
|
||||
// test for php version
|
||||
$ver = phpversion();
|
||||
$tests['php_version'] = array();
|
||||
$tests['php_version']['description'] = 'PHP version found: '.$ver.".\n\n";
|
||||
if (version_compare($ver, '4') < 0)
|
||||
{
|
||||
$tests['php_version']['status'] = 0;
|
||||
$tests['php_version']['description'] .= 'This version of PHP is not compatible with the PHP XMLRPC library. Please upgrade to 4.2 or later';
|
||||
}
|
||||
else if (version_compare($ver, '4.2') < 0)
|
||||
{
|
||||
$tests['php_version']['status'] = 1;
|
||||
$tests['php_version']['description'] .= "This version of PHP is partially compatible with the PHP XMLRPC library.\nIn order to use the library, you will need to make sure the files from the compat directory are available on your server";
|
||||
}
|
||||
else if (version_compare($ver, '5.0.3') < 0)
|
||||
{
|
||||
$tests['php_version']['status'] = 1;
|
||||
$tests['php_version']['description'] .= "This version of PHP is almost completely compatible with the PHP XMLRPC library.\nThe only unavailable function is automatic mapping of php functions to xmlrpc methods";
|
||||
}
|
||||
else
|
||||
{
|
||||
$tests['php_version']['status'] = 2;
|
||||
$tests['php_version']['description'] .= 'This version of PHP is fully compatible with the PHP XMLRPC library';
|
||||
}
|
||||
|
||||
// test for zlib
|
||||
$tests['zlib'] = array();
|
||||
if (!function_exists('gzinflate'))
|
||||
{
|
||||
$tests['zlib']['status'] = 0;
|
||||
$tests['zlib']['description'] = "The zlib extension is not enabled.\n\nYou will not be able to receive compressed requests or send compressed responses, unless using the cURL library (for 'HTTPS' and 'HTTP 1.1' connections)";
|
||||
}
|
||||
else
|
||||
{
|
||||
$tests['zlib']['status'] = 2;
|
||||
$tests['zlib']['description'] = "The zlib extension is enabled.\n\nYou will be able to receive compressed requests and send compressed responses for the 'HTTP' protocol";
|
||||
}
|
||||
|
||||
// test for diaply of php errors in xml reponse
|
||||
if (ini_get('display_errors'))
|
||||
{
|
||||
if (intval(ini_get('error_reporting')) && E_NOTICE )
|
||||
{
|
||||
$tests['display_errors']['status'] = 1;
|
||||
$tests['display_errors']['description'] = "Error reporting level includes E_NOTICE errors, and display_errors is set to ON.\n\nAny error, warning or notice raised while executing php code exposed as xmlrpc method will result in an invalid xmlrpc response";
|
||||
}
|
||||
else
|
||||
{
|
||||
$tests['display_errors']['status'] = 1;
|
||||
$tests['display_errors']['description'] = "display_errors is set to ON.\n\nAny error raised while executing php code exposed as xmlrpc method will result in an invalid xmlrpc response";
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
else
|
||||
{
|
||||
|
||||
// test for php version
|
||||
$ver = phpversion();
|
||||
$tests['php_version'] = array();
|
||||
$tests['php_version']['description'] = 'PHP version found: '.$ver.".\n\n";
|
||||
if (version_compare($ver, '4') < 0)
|
||||
{
|
||||
$tests['php_version']['status'] = 0;
|
||||
$tests['php_version']['description'] .= 'This version of PHP is not compatible with the PHP XMLRPC library. Please upgrade to 4.2 or later';
|
||||
}
|
||||
else if (version_compare($ver, '4.2') < 0)
|
||||
{
|
||||
$tests['php_version']['status'] = 1;
|
||||
$tests['php_version']['description'] .= "This version of PHP is partially compatible with the PHP XMLRPC library.\nIn order to use the library, you will need to make sure the files from the compat directory are available on your server";
|
||||
}
|
||||
else
|
||||
{
|
||||
$tests['php_version']['status'] = 2;
|
||||
$tests['php_version']['description'] .= 'This version of PHP is fully compatible with the PHP XMLRPC library';
|
||||
}
|
||||
|
||||
// test for zlib
|
||||
$tests['zlib'] = array();
|
||||
if (!function_exists('gzinflate'))
|
||||
{
|
||||
$tests['zlib']['status'] = 0;
|
||||
$tests['zlib']['description'] = "The zlib extension is not enabled.\n\nYou will not be able to send compressed requests or receive compressed responses, unless using the cURL library (for 'HTTPS' and 'HTTP 1.1' connections)";
|
||||
}
|
||||
else
|
||||
{
|
||||
$tests['zlib']['status'] = 2;
|
||||
$tests['zlib']['description'] = "The zlib extension is enabled.\n\nYou will be able to send compressed requests and receive compressed responses for the 'HTTP' protocol";
|
||||
}
|
||||
|
||||
// test for CURL
|
||||
$tests['curl'] = array();
|
||||
if (!extension_loaded('curl'))
|
||||
{
|
||||
$tests['curl']['status'] = 0;
|
||||
$tests['curl']['description'] = "The cURL extension is not enabled.\n\nYou will not be able to send and receive messages using 'HTTPS' and 'HTTP 1.1' protocols";
|
||||
}
|
||||
else
|
||||
{
|
||||
$info = curl_version();
|
||||
$tests['curl']['status'] = 2;
|
||||
$tests['curl']['description'] = "The cURL extension is enabled.\n\nYou will be able to send and receive messages using 'HTTPS' and 'HTTP 1.1' protocols";
|
||||
if (version_compare($ver, '4.3.8') < 0)
|
||||
{
|
||||
$tests['curl']['status'] = 1;
|
||||
$tests['curl']['description'] .= ".\nPlease note that the current cURL install does not support keep-alives";
|
||||
}
|
||||
if (!((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
|
||||
{
|
||||
$tests['curl']['status'] = 1;
|
||||
$tests['curl']['description'] .= ".\nPlease note that the current cURL install does not support compressed messages";
|
||||
}
|
||||
if (!((is_string($info) && strpos($info, 'OpenSSL') !== null) || isset($info['ssl_version'])))
|
||||
{
|
||||
$tests['curl']['status'] = 1;
|
||||
$tests['curl']['description'] .= ".\nPlease note that the current cURL install does not support HTTPS connections";
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
return $tests;
|
||||
}
|
||||
|
||||
?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<title>PHP XMLRPC compatibility assessment</title>
|
||||
<style type="text/css">
|
||||
body, html {background-color: white; font-family: Arial, Verdana, Geneva, sans-serif; font-size: small; }
|
||||
table { border: 1px solid gray; padding: 0;}
|
||||
thead { background-color: silver; color: black; }
|
||||
td { margin: 0; padding: 0.5em; }
|
||||
tbody td { border-top: 1px solid gray; }
|
||||
.res0 { background-color: red; color: black; border-right: 1px solid gray; }
|
||||
.res1 { background-color: yellow; color: black; border-right: 1px solid gray; }
|
||||
.res2 { background-color: green; color: black; border-right: 1px solid gray; }
|
||||
.result { white-space: pre; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>PHPXMLRPC compatibility assessment with the current PHP install</h1>
|
||||
<h4>For phpxmlrpc version 2.0 or later</h4>
|
||||
<h3>Server usage</h3>
|
||||
<table cellspacing="0">
|
||||
<thead>
|
||||
<tr><td>Test</td><td>Result</td></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<?php
|
||||
$res = phpxmlrpc_verify_compat('server');
|
||||
foreach($res as $test => $result)
|
||||
{
|
||||
echo '<tr><td class="res'.$result['status'].'">'.htmlspecialchars($test).'</td><td class="result">'.htmlspecialchars($result['description'])."</td></tr>\n";
|
||||
}
|
||||
?>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Client usage</h3>
|
||||
<table cellspacing="0">
|
||||
<thead>
|
||||
<tr><td>Test</td><td>Result</td></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<?php
|
||||
$res = phpxmlrpc_verify_compat('client');
|
||||
foreach($res as $test => $result)
|
||||
{
|
||||
echo '<tr><td class="res'.$result['status'].'">'.htmlspecialchars($test).'</td><td class="result">'.htmlspecialchars($result['description'])."</td></tr>\n";
|
||||
}
|
||||
?>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
152
include/limesurvey/admin/remotecontrol.php
Normal file
152
include/limesurvey/admin/remotecontrol.php
Normal file
@@ -0,0 +1,152 @@
|
||||
<?php
|
||||
|
||||
//Remote Control 2 backported from Limesurvey_CI to Limesurvey 1.91+.
|
||||
//Only implemented functions required for queXS - i.e
|
||||
// * webserver based authentication only
|
||||
// * addResponse RPC call only
|
||||
|
||||
require_once(dirname(__FILE__).'/../classes/core/startup.php');
|
||||
require_once(dirname(__FILE__).'/../config-defaults.php');
|
||||
require_once(dirname(__FILE__).'/../common.php');
|
||||
require_once(dirname(__FILE__)."/classes/xmlrpc/lib/xmlrpc.inc");
|
||||
require_once(dirname(__FILE__)."/classes/xmlrpc/lib/xmlrpcs.inc");
|
||||
|
||||
|
||||
$config = array('get_session_key' => array('function' => 'getSessionKey'),
|
||||
'add_response' => array('function' => 'addResponse'));
|
||||
|
||||
$s=new xmlrpc_server($config);
|
||||
//$s->setdebug(3);
|
||||
//$s->compress_response = true;
|
||||
$s->service();
|
||||
|
||||
/**
|
||||
* XML-RPC routine to create a session key
|
||||
*
|
||||
* @param array $request Array containing username and password
|
||||
*/
|
||||
function getSessionKey($request)
|
||||
{
|
||||
if (!is_object($request)) die();
|
||||
//$sUserName=$request->getParam(0);
|
||||
//$sPassword=$request->getParam(1);
|
||||
if (_doLogin())
|
||||
{
|
||||
return new xmlrpcresp(new xmlrpcval('OK'));
|
||||
}
|
||||
else
|
||||
{
|
||||
return new xmlrpcresp(0, 1, 'Login failed');
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* XML-RPC routine to add a response to the survey table
|
||||
* Returns the id of the inserted survey response
|
||||
*
|
||||
* @param array $request Array containing the following elements (in that order):
|
||||
* - Session key (string)
|
||||
* - Survey ID (integer)
|
||||
* - ResponseData (array)
|
||||
*
|
||||
*/
|
||||
function addResponse($request)
|
||||
{
|
||||
global $connect,$dbprefix;
|
||||
|
||||
if (!is_object($request)) die();
|
||||
|
||||
if ($request->getNumParams() != 3)
|
||||
{
|
||||
return new xmlrpcresp(0, 3, 'Missing parameters');
|
||||
}
|
||||
|
||||
$sSessionKey=$request->getParam(0)->scalarVal();
|
||||
$iSurveyID=(int)$request->getParam(1)->scalarVal();
|
||||
$aResponseData=php_xmlrpc_decode($request->getParam(2));
|
||||
|
||||
if (!is_array($aResponseData))
|
||||
return new xmlrpcresp(0, '14', 'Survey data is not in array form');
|
||||
|
||||
$uid = _doLogin();
|
||||
|
||||
if($uid)
|
||||
{
|
||||
if(bHasSurveyPermission($iSurveyID,'responses','create',$uid))
|
||||
{
|
||||
$surveytable = db_table_name("survey_".$iSurveyID);
|
||||
if (!db_tables_exist($dbprefix."survey_".$iSurveyID))
|
||||
{
|
||||
return new xmlrpcresp(0, '12', 'No survey table');
|
||||
}
|
||||
|
||||
//set required values if not set
|
||||
if (!isset($aResponseData['submitdate'])) $aResponseData['submitdate'] = date("Y-m-d H:i:s");
|
||||
if (!isset($aResponseData['datestamp'])) $aResponseData['datestamp'] = date("Y-m-d H:i:s");
|
||||
if (!isset($aResponseData['startdate'])) $aResponseData['startdate'] = date("Y-m-d H:i:s");
|
||||
if (!isset($aResponseData['startlanguage'])) $aResponseData['startlanguage'] = GetBaseLanguageFromSurveyID($iSurveyID);
|
||||
$SQL = "INSERT INTO $surveytable
|
||||
(".implode(',',array_keys($aResponseData)).")
|
||||
VALUES
|
||||
(".implode(',',array_map('db_quoteall',$aResponseData)).")";
|
||||
|
||||
$iinsert = $connect->Execute($SQL);
|
||||
|
||||
if ($iinsert)
|
||||
{
|
||||
$thisid=$connect->Insert_ID();
|
||||
return new xmlrpcresp(new xmlrpcval($thisid,'int'));
|
||||
}
|
||||
else
|
||||
{
|
||||
//Failed to insert return error
|
||||
return new xmlrpcresp(0, '13', 'Unable to add response');
|
||||
}
|
||||
}
|
||||
else
|
||||
return new xmlrpcresp(0, '2', 'No permission');
|
||||
}
|
||||
die();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to login using webserver auth
|
||||
*
|
||||
* @param string $sUsername
|
||||
* @param mixed $sPassword
|
||||
*/
|
||||
function _doLogin($sUsername = '', $sPassword = '')
|
||||
{
|
||||
global $connect,$useWebserverAuth;
|
||||
if ($useWebserverAuth !== true) //only implement webserver auth atm
|
||||
return false;
|
||||
|
||||
if (!isset($_SERVER['PHP_AUTH_USER']) && isset($_SERVER['REMOTE_USER']))
|
||||
$_SERVER['PHP_AUTH_USER'] = $_SERVER['REMOTE_USER'];
|
||||
|
||||
|
||||
// getting user name, optionnally mapped
|
||||
if (isset($userArrayMap) && is_array($userArrayMap) &&
|
||||
isset($userArrayMap[$_SERVER['PHP_AUTH_USER']]))
|
||||
{
|
||||
$mappeduser=$userArrayMap[$_SERVER['PHP_AUTH_USER']];
|
||||
}
|
||||
else
|
||||
{
|
||||
$mappeduser=$_SERVER['PHP_AUTH_USER'];
|
||||
}
|
||||
|
||||
$query = "SELECT uid, users_name, password, parent_id, email, lang, htmleditormode, dateformat FROM ".db_table_name('users')." WHERE users_name=".$connect->qstr($mappeduser);
|
||||
$ADODB_FETCH_MODE = ADODB_FETCH_ASSOC; //Checked
|
||||
$result = $connect->SelectLimit($query, 1) or safe_die ($query."<br />".$connect->ErrorMsg());
|
||||
|
||||
|
||||
if ($result->RecordCount() == 1)
|
||||
{
|
||||
$srow = $result->FetchRow();
|
||||
return $srow['uid'];
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
Reference in New Issue
Block a user