SOAP-Lite-1.09/ 000755 000766 000024 00000000000 12265327263 014250 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/bin/ 000755 000766 000024 00000000000 12265327263 015020 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/Changes 000644 000766 000024 00000116364 12265326274 015557 0 ustar 00fredmoyer staff 000000 000000 #
# Revision history for Perl extension SOAP::Lite.
#
The contents of this file provides a change history for the SOAP::Lite
Perl module. New features are designated with a '+' and bug fixes with
a '!'.
Numbers in square brackets are sourceforge tracker IDs from
https://sourceforge.net/tracker/?group_id=66000&atid=513017
Numbers with # are CPANRT tracker IDs from
http://rt.cpan.org/Public/Dist/Display.html?Name=SOAP-Lite
-----------------------------------------------------------------------
THIS RELEASE
-----------------------------------------------------------------------
1.09 January 14, 2013
! #92025 tighten multipart content-type matching [dmn@debian.org]
1.08 November 8, 2013
! #15703 add no_index for examples to prevent CPAN pollution [githumb.com/sergeyromanov]
1.07 November 7, 2013
! #89948 Remove warning when Content-Id is not present
1.06 August 21, 2013
! #87935 skip all MIME-Parser tests if it is not installed
! #87787 Use of uninitialized value $ns in Lite.pm
1.05 August 18, 2013
! #87848 Fix manifest, fix invalid http version from release blunder
1.04 August 9, 2013
! #87605 Skip XML::Parser::Lite tests if it is missing [github.com/omega]
1.03 August 4, 2013
! #87195 Remove DIME::Tools dep until we can work around its issues
1.02 July 30, 2013
! #87421 1.01 release blew out xml versions. mea culpa.
1.01 July 29, 2013
! #84168 Test t/02-payload.t fails under Perl 5.17.10
! #87127 TEST.pl removed from MANIFEST
! revert #85713 - various reports of environment failures
1.0 July 16, 2013
! #85713 SOAP::Transport::HTTP, 500 error skips parsing of response
! No more Windows 98 client support. Wait, wut?
! Merge SOAP::Transport::TCP back into SOAP::Lite (for now)
! #82416: xop href cid: URI encoded support reported by Michael R. Davis (mrdvt92)
! #85208 bad test plan
! #83750 different headers for mod_perl vs mod_perl2 [Mithun Bhattacharya]
0.716 May 10, 2013
! #17275 Client unable to detect fatal SOAP failure (e.g. unable to connect to host)
! #81471 Force array context for correct Apache header parsing in SOAP::Transport::HTTP
! #45611 deserializing SOAP message with composite attachment raises exception
! #84168 Test t/02-payload.t fails under Perl 5.17.10
! #85098 Monkey patch for LWP::Protocol confuses the toolchain
! #78692 / #84724 / #83715 Sending large object (many levels deep) throws error Incorrect parameter
! #78502 t/08-schema.t noisy under 5.17.2 (unescaped left brace in regex is deprecated)
! #78608 Documentation for "+trace"
! #78639 Spelling error reported by Debian tools
0.715
! #75938 Change to warning / add configuration variable to allow XML tags starting with /xml/i
! #76902 Missing info in "SSL CERTIFICATE AUTHENTICATION" documentation
! #74577 work around/fixes for success with MS WS https/compressed
! #74308 SOAP-Lite fails for operations with period in name
! #73802 client did not set the encoding of the soap-envelope to 'iso-8859-1' in HTTP-request
! #75019 HTTP server doesn't process PIPE signal
! #72836 Processing a SOAP 1.2 request breaks the next SOAP 1.1 response
! #70381 SOAP-Lite performance
! #53375 comments after
! #63693 Uninitalized value (again)
! #37360 Use of uninitialized variables in SOAP tests
! fixed encoding in xmlrpc keys
! #15176 problems with SOAP::Header ->value
0.714
Moved SOAP::Transport::TCP into SOAP-Transport-TPC distribution
! #70329 - not generating attributes properly (deleting id attribute)
0.713
! #52637 error sending a request in perl 5.10.0 containing utf-8 data using the string data type
! #48775 Small bug in SOAP::Packager
! #51178 Emailing: SOAP-Lite-0.710.10.patch
! #55962 Spelling errors
! #52015 defined(%hash) deprecated in Perl 5.11
! #63693 Uninitalized value
! #65655 Assignment of shift to list
! #58538 regression from 0.710.08 soap:Client,Application failed during request deserialization
! #64250 Bleadperl v5.13.7-297-g558b442 breaks SOAP::Lite 0.712
! #68088 XML::Parser::Lite fails tests under perl 5.14 RC1
! #69825 Bug in SOAP/Lite/Deserializer/XMLSchemaSOAP1_2.pm
0.712
! #57409 SOAP::Lite installation problem
! #52015 defined(%hash) deprecated in Perl 5.11
! #39546 use of version.pm
! #52637 error sending a request in perl 5.10.0 containing utf-8 data using the string data type
! #55962 Spelling errors
0.712
SOAP::Transport::JABBER, SOAP::Transport::MQ and SOAP::Tranport::FTP
are now in their own distributions.
! [2790747] Bugtracker specification in META.yml missing
! #45997: Inconsistency in SOAP::Serializer documentation
! #55618: HTTP_TRANSFER_ENCODING can be undefined in SOAP/Transpo
! [2946245] / #54106 Only last Cookie Set
! #50178: Win32 isuue with IO::SessionData and IO::SessionSet
! #41527: SOAP::Lite 0.69 with Apache2 HTTP Server module and mod_perl 2
returns 500 Internal
0.710.10
! #49981: UDDI::Lite version not parsable by cpanplus (again)
0.710.09
! #46444: use SOAP::Lite::Deserializer::XMLSchemaSOAP1_2 missing
! #37151: Strawberry perl 5.10 - Tests fail and then later hang
! #49981: UDDI::Lite version not parsable by cpanplus
! #49011: Fails to install under strawberry perl
! [2825166] In Constant DEFAULT_HTTP_CONTENT_TYPE
! [2832939] chunked client requests are returned 411(Length Required)
! [2860559] serious utf8 bug
! #44568 Tracing unavailable when SOAP::Lite is used as a server
! #44195 submitting patches / mention Nginx transport module in documentation
! [2777361] SOAP 1.2 Content-Type rejected
! #41937 ([patch] enable more tests)
! #39101: Apache2::Const::HTTP_BAD_REQUEST not defined
! #39672: serialization and autotype 'off'
! #41348: t/SOAP/Transport/HTTP/CGI.t failing on 5.6.x
! #20569: XMLRPC::Lite "wrong element 'nil'" exception on ''
+ require Task::Weaken
+ better META.yml generated (Alexandr Ciornii)
0.710.08 - Jul 13 2008
! [ 2015071 ] HTTP header is no more accessible
The HTTP header can be pre-filled again. Now, the HTTP header is cloned
from a (possibly user defined) header for every request
! #37358: Test Failure in Strawberry perl - IO::SessionData
! #37359: Test Failure in Strawberry perl - IO::SessionSet
! [ 2005296 ] CPANTS says META.yml broken
! [ 2005288 ] CPANTS: has_humanreadable_license not ok
! #37040: Memory leak when calling WS using wsdl
SOAP::Transport::HTTP->new() was leaking two scalars per call
0.710.07
! [ 1963995 ] > not deserialized in result
! [ 1833218 ] < and > not deserialized in faultstring/detail
! [ 1959329 ] Incorrect Content-Type while sending requests with no parts
! [ 1945385 ] Incorrect starting part detection for Multipart/Related
0.710.06
! #36477 SOAP::Lite Envelope not stripped down for XMLRPC
! #36455 XMLRPC::Transport::HTTP::CGI generates extra params
0.710.05
! got version number right, finally. Thanks to Graham Barr,
Andreas J. Koenig and Matt S Trout (in alphabetical order) for support
0.071.04
! updated version number and fixed declaring version, so that perl 5.6.2
can parse it, too
! fixed memory leaks with XMLRPC::Lite
v0.71.03
! #35041: SOAP::Lite Passes Decoded Strings to LWP
! #35133: Version Unparsable by ExtUtils::MakeMaker
! #33973: KeepAlive fails to function
! #33773: redefined warnings
! #34514: Subclasses of XMLRPC::Serializer misbehave because of a "ref" call in SOAP::Lite
(actually fixed in 0.71.01, but I forgot to add it to Changes)
0.71.02
! [1942233] Memory leak in 0.69 && 0.71
0.71.01
! #34515: Printing UTF-8 through SOAP::Transport::HTTP throws a warning
! Version numbers updated
! [1904955] Subclassing XMLRPC::Serializer broken
0.71 Feb 2008
- bumped up version. Just curious about commit e-mail.
0.70_08 Feb 25 2008
- bumped up version - accidentally uploaded a ppm to CPAN
0.70_07 Feb 25 2008
+ Added additional callbacks to XML::Parser::Lite and made it work under
(at least) perl5.6.2, 5.8.7, 5.8.8 and 5.10.
Thanks to Adam Leggett.
! Fixes failing test on 5.10. The mechanism for determining whether
a class is loaded in SOAP::Server has been changed to the following:
Assume loaded if
- the class is main
- the class implements the required method
- the corresponding module (file) exists in %INC
This is still error prone - if you know a better algorithm, please help me
out.
0.70_06 Feb 16 2008
! Fixes failing test without FCGI installed
0.70_05 Feb 13 2008
! Fixes #32971 Undefined subroutine &Apache::Constant::BAD_REQUEST called
! Fixes [ 1867264 ] [PATCH] handle empty complexTypes correctly
! Fixes #32810: [PATCH] handle empty complexTypes correctly (duplicate)
! Fixes [ 1864481 ] XML::Parser::Lite documentation is incomplete
+ Fixes [ 747302 ] Make tainting work with XML::Parser::Lite
+ Fixes [ 1864480 ] Make XML::Parser::Lite's private subs private
! Fixes [ uncategorized ] bad XML::Parser::Lite behaviour under perl 5.8
0.70_04 Jan 02 2008
! Fixes #32008: Failed t/03-server.t tests 2-5 under Perl 5.10 on Mac OS X 10.3.9
! Fixes [ 1855575 ] "P" autotyped as xsd:duration
! Fixes [ 1842314 ] Expect: 100-Continue does not work with Apache::SOAP
! Fixes #13140 unable to use local file as WSDL service description file
Acually there is no bug, but just a missing comment in the examples...
0.70_03 Nov 18 2007
! Fixes [ 1816906 ] 7/06_modules.t fails with Apache 1.27
! Fixes [ 1414914 ] longs are serialized into xsd:int by default
- ! Fixes [ 1833803 ] int numbers serialized as long
! Fixes #21113: sending xml files using SOAP::Transport::HTTP::CGI
(actually trapped a documentation error)
! Fixes #3677: Line > 1000 characters breaks perl parser
! Fixes #11797: SOAP::Transport::HTTP::CGI returns HTTP response headers terminated by "\n" instead of "\r\n"
! Fixed #24211: strings with leading zero mistreated as int
! Fixed #25668: cannot build SOAP::Lite with mod_perl 1.29
! Fixed #16897: SOAP::Lite 0.66 fails with UNIVERSAL::use
! Fixed #30741: SOAP::Transport::HTTP::Apache
0.70_02 Nov 08 2007
! Fixed [ 1828412 ] SOAP::Lite serializes faults with wrong element order,
thanks to Tom Fischer.
! Fixed [ 1073360 ] Failure to read() long requests under mod_perl (fixed
for mod_perl before thanks to JT Justman, now fixed for CGI, too).
! Fixed #30339: envelope subroutine() in XMLRPC/Lite.pm incorrectly
requires method parameter for a response envelope
! Fixed #26408: SOAP::Transport::HTTP needs to call extract_cookies when
dealing with a cookie jar
! Fixed #22730 test failure on bleedperl
! Fixed #30271 Don't give strings with utf8 flag set to
MIME::Base64::encode_base64().
! Fixed [ 1816907 ] t/01_core.t fails on 5.6.x
! Fixed #24810 missing prerequisite LWP::UserAgent
0.70_01 Oct 18 2007
+ Added LOOPBACK test transport backend.
+ Added more core tests
! Fixed #14052: 'use base' pragma no longer works for SOAP::Lite
! Fixed #27032: Some debugging-aid patches
! Fixed #22732: Documentation error for use_prefix()
! Fixed [ 1044270 ] Suppress type for array when autotyping off
! Fixed [ 1665916 ] encode_scalar needs "no strict 'refs'"?
! Fixed [ 1481017 ] Typo on CPAN's documentation
! Fixed [ 1750846 ] Error with ENV{EXPECT}
! Fixed [ 887015 ] Memory Leak
! Fixed [ 1700326 ] encode_data called incorrectly in envelope
! Fixed [ 1612405 ] Incorrect deserialization of arrays/vectors
! Fixed [ 1204279 ] Boolean serialization error and added test
! Fixed [ 1569418 ] anyURI Serialization problem
0.68 July 6 2006
! Patched support for mod_perl Apache2 (thanks to JT Justman)
! Fixed bug where SOAP::SOM objects were not properly detected,
serialized and returned (thanks chris at prather dot o r g)
! Fixed bug with default_ns and ns functions so that they
serialized XML properly.
+ Started to add experimental DIME support - possible impacts to MIME
support as well
0.65-beta7 May 12 2005
+ Added default_ns and ns to replace the confusing use of uri() and
use_prefex()
0.65-beta6 June 3 2005
! Fixed bug resulting in XMLRPC requests to be serialized using the
doc/literal serializer if serializing arrays
0.65-beta5 May 6 2005
! Fixed critical bug which prevented all XMLRPC servers from working
0.65-beta4 Apr 3 2005
! Fixed bug 1160881 - HTTP headers are now terminated by \r\n for
compatibility with .NET and compliance with HTTP spec.
! Fixed 1158666 - stubmaker.pl no longer call deprecated subroutine
+ stubmaker.pl got a lot of enhancements - now has help and version
output, run time options, etc. See 'man stubmaker.pl' for more.
+ Classes generated by stub_maker.pl now have a special subroutine
called 'want_som.' When set to 1, the stub class will return a
SOAP::SOM object for every request.
! Fixed bug 1149427 - now capable of returning SOAP::SOM objects
from generated stub classes.
0.65-beta3 Mon Oct 25 2004
+ SOAP::Lite will only warn you once when you call a doc/literal
service
+ Added SOAP::Schema->cache_dir() and SOAP::Schema->cache_ttl(),
which control how code stubs generated from WSDLs are cached to
prevent constant reparsing of WSDL files.
! Tested SOAP::Lite against Google, Salesforce, and FedEx. So far,
clients can successfully call these service providers (at least
some of their operations) - testing does not provide 100% coverage
of their APIs.
0.65-beta2.1 Mon Oct 25 2004
+ Fixed bug in unit tests in which MIME::Tools was not properly detected
resulting in failed unit tests for some users.
+ Fixed some documentation issues (speling, etc).
0.65-beta2 Mon Oct 25 2004
** WARNING ** substantial changes have been made to SOAP::Lite in
this release in regards to how it manages attachments. The changes
may introduce instabilities into your software that relies on this
functionality. Please test your software with 0.65 prior to moving it
to a production environment.
+ Added ReleaseNotes.txt
+ Added section REPORTING BUGS to pod comments
+ Deprecated SOAP::Lite->schema removed
+ Deprecated SOAP::Lite->on_debug removed
+ Deprecated SOAP::Schema->schema in favor of SOAP::Schema->schema_url
+ Added SOAP::Schema->useragent - which returns the LWP::UserAgent instance
that will be used when accessing WSDLs via the SOAP::Lite->service call.
This is helpful when access to a WSDL requires authentication, etc.
+ Made changes that allow messages to be constructed using a NULL body:
+ Added constant OBJS_BY_REF_KEEPALIVE which defaults to 600 - this is
so that services can configure how long to cache objects marked as persistent
using SOAP::Server::Object->objects_by_reference()
+ Added the ability for a user to modify the UserAgent class used
by SOAP::Transport::HTTP::Client, updated Transport.pm's documentation
to reflect this. Added $SOAP::Transport::HTTP::Client::USERAGENT_CLASS
variable as a means of setting this.
+ Added initial DIME support
+ SOAP Packager package/unpackage now take in a context variable as
input because DIME needs to know what version of SOAP you are using.
+ Refactored and rewrote README
+ Renamed SOAP::Schema->stub() to SOAP::Schema->generate_stub. This populates
a private variable called C with the autogenerate Perl code.
+ Added SOAP::Schema->stub() which returns the autogenerated Perl code used
internally by SOAP::Lite. This can be helpful for debugging SOAP::Lite's
utilization of WSDL, as well as helpful to developers working on S::L's
WSDL support.
0.65-beta1 Mon Oct 18 15:55:00 2004
+ Made SOAP::Serializer->readable actually produce readable XML!
! Fixed bug 747312 - Made XML Schema 2001 the default schema
+ Changed typelookup of base64 to base64Binary to conform with 2001
schema
+ Added support for [almost] all XML Schema 2001 built-in datatypes
+ Added register_ns subroutine to SOAP::Serializer
+ Added find_prefix subroutine to SOAP::Serializer
+ Added use_prefix subroutine to SOAP::Serializer
+ Added a necessary set of initial subroutinues to support wsdl2perl
project
+ Added format_datetime to SOAP::Utils
+ Documented SOAP::SOM->parts
+ Added SOAP::SOM->is_multipart
+ Properly escaped characters to facilitate emacs syntax highlighting
+ Ran podchecker to validate all POD comments
! Fixed bug 749636 - changed a croak to a warn to enable socket
timeouts in SOAP::Transport::TCP::Server
+ Added support for UDDI 2/3
+ Majorly revamped product documentation thanks to the kind
contribution made by O'Reilly. Appendix B from "Programming Web
Services with Perl" has been completely integrated.
+ To better segment SOAP::Lite documentation, many modules have been
added that contain documentation only. For those who loved the old
documentation, it can be found in lib/OldDocs/SOAP/*.pm and
lib/OldDocs/SOAP/Transport/*.pm
! Fix a bug in which doclit style arrays were not being deserialized
properly. IOW, Repeated elements were not made into an array, only
the last occurring value was recorded.
+ Added the ability for a SOAP Client to gain direct access to the
HTTP::Request and HTTP::Response objects.
+ Changed default envelope namespace prefix from SOAP-ENV to soap
+ Changed default encoding namespace prefix from SOAP-ENC to soapenc
+ Reachitected MIME support to decouple MIME layer from transport
layer. This only impacts the HTTP layer since that is the only
transport in SOAP::Lite that supports attachments.
+ Creation of SOAP::Packager - decoupled in an extensible way the
packaging of parts (a.k.a. attachments). This is used for encoding
and decoding. This enables a more seemless addition of DIME
support. Changes were made throughout SOAP::Lite to accomodate this
functionality.
- a call "context" was added to SOAP::Server and SOAP::Deserializer
so that those classes could have access to the global
SOAP::Packager instance
- deprecated many function calls and packages having to do with
attachment support
- fixed several of the SOAP::*::new() methods so that they don't
inadvertantly reinitialize themselves and destroy precious context
information in the process
+ Gave developers direct access to MIME::Parser object so that they
can optimize its use. See the following URL to optimize it for
memory consumption, parsing speed, disk utilization, etc:
http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm#OPTIMIZING_YOUR_PARSER
+ Added a context variable to SOAP::Serializer and SOAP::Deserializer
so that they have mechanisms for getting instance data from the
calling context. The value of context is either SOAP::Lite or
SOAP::Server depending upon the role the service is playing in the
transaction. Contexts are initialized when a call is made, and
destroyed when a call is completed.
+ Greater than character '>' has been added to list of characters
that will be automatically escaped. This is not a requirement by
the XML spec, it is a MAY, but I am doing it after seeing a minority
of people report a compatibility problem.
- Removed deprecated methods: SOAP::Serializer::namespace and
encodingspace
+ Added SOAP::Serializer::encodingStyle method which allows users to
set the URI for default encodingStyle.
+ Added initial support for literal encoding style. EXPERIMENTAL
+ Added some true constant values representing various SOAP namespace
URIs
+ Added SOAP::Constants::SUPPORTED_ENCODING_STYLES for better tracking
of the set of encoding styles that the toolkit can [de]serialize
! Fixed bug 840172 - "Makefile.PL --noprompt flag broken," now fixed
+ Updated SOAP 1.2 URIs to the latest (TODO - maintain support for
older ones)
+ Added HTTPS support for HTTP::Server Daemon class - thanks to Nils
Sowen for this contribution
-----------------------------------------------------------------------
PREVIOUS RELEASES
-----------------------------------------------------------------------
0.60 Mon Aug 18 12:10:27 2003
+ Merged SOAP::MIME into SOAP::Lite's core
+ Cleaned up the UI for the Makefile.PL script - it now detects and
indicated whether certain Perl modules have been detected. The
table displaying installation preferences has been substantially
cleaned up, the code is much more modular and relies on a simple
data structure representing potential module dependencies.
+ Made the Makefile.PL script iterative - meaning, the user will be
continually be presented with their preferences until they
explicity choose to accept them and continue (bug 747295)
+ Differentiate between xsd:int and xsd:long to fix interoperability
bug with Java Web services
! Fixed MIME interoperability bug with Apache Axis - Axis' MIME
parser requires that MIME boundaries are terminiated by a CRLF
character where the MIME::Tools package only outputs a CR
character. A patch was integrated into the MIME::Tools module
which allows SOAP::Lite to specify its own MIME Boundary delimiter
! SOAP Faultcodes are now properly typed a xsd:QName, whereas
before they were xsd:string - to be honest, they are left untyped
so that toolkits can serialize them according to the schema
(bug 747283)
! Fixed documentation error around turning on a trace for multiple
"channels" (bug 747310)
! Disabled SOAPStruct (bug 747316)
! Fixed XML::Parser::Expat vulnerability (bug 747265)
! Added item in TROUBLESHOOTING section explaining that there is a
bug in Perl 5.8 that prevents +autodispatch from working properly.
The workaround is to use dispatch_from instead (bug 747290)
! Fixed warning when autodispatched call has no parameters
(bug 747286)
! Fixed warning when empty SOAPAction specified (bug 747278)
! Turned off HTTP keep alive patch by default, however users can now
turn on the patch by setting the constant PATCH_HTTP_KEEPALIVE to
1 (bug 747281)
! Removed dependency on the URI module for non-HTTP transports
(bug 747306)
0.55 Mon Apr 15 22:20:39 2002
! fixed security vulnerability with fully qualified method names
(thanks to Randal Schwartz, Ilya Martynov and many others)
! fixed problem with TCP transport and SSL (thanks to Chris Hurd)
! fixed TCP transport to specify correct length with utf8 strings
(thanks to Robin Fuller)
! fixed incorrect encoding when parameters list includes undefined
values (thanks to Chris Radcliff)
! updated 'xmlsoap' prefix (thanks to Pierre Denis)
! updated MIME parser to accept messages that start with 'From'
(thanks to Chris Davies)
+ added check for TCP transport on Mac (thanks to Robin Fuller)
+ added check for shutdown() method on AIX (thanks to Jos Clijmans)
+ added check for blocking() method in TCP transport
(thanks to Jos Clijmans)
+ optimized parsing strings with entity encoding (thanks to Mathieu
Longtin)
+ added check for entity size for CGI transport
($SOAP::Constant::MAX_CONTENT_SIZE) (thanks to J. Klunder)
+ added example (google.pl)
+ updated tests and examples with new endpoints
0.52 Mon Oct 18 21:20:19 2001
! fixed content_type returned under mod_perl with 500 SERVER ERROR
status (thanks to Geoffrey Young and Scott Hutton)
! fixed problem with multiple bindings in WSDL file generated by
MS SOAP toolkit
! fixed handling of boolean type in 1999 Schema and hexBinary type
in 2001 Schema
! fixed warning and problem with WOULDBLOCK state in IO::SessionData
(thanks to Marty Pauley)
! fixed miscalculation in position within sparse arrays
! fixed problem with URI when methods of SOAP::Data are called in
certain order (thanks to Taras Shkvarchuk)
! fixed CRLF problem in CGI module on Windows platform under IIS
(thanks to Werner Ackerl)
! fixed hex and hexBinary datatypes generation
! fixed content-length calculation when payload has multibyte utf8
characters
! fixed problem with XMLRPC and nested packages with more than two
levels (thanks to Leonid Gernovski)
! fixed (again) memory leak in SOAP::Parser (thanks to Craig
Johnston)
+ updated Jabber interface for new format of 'use Net::Jabber ...'
does not work with Net::Jabber 1.022 and later
+ updated XMLRPC::Lite to not detect value as float for 'NaN' and
'INF' strings
+ updated XMLRPC::Lite to return 200OK on errors
+ updated XMLRPC do not specify charset in content-type
+ updated Makefile.PL to allow configuration from command line
(thanks to Dana Powers)
+ updated publishing API tests for UDDI server to call a new server
(GLUE)
+ changed close() to shutdown() in Daemon transport (thanks to Sean
Meisner)
+ added support for HTTP_proxy and HTTP_proxy_* in WSDL access
(thanks to Stephen Shortland)
+ added XMLRPC support in COM interface. XMLRPC client and server
can be created using COM interface
+ added DO_NOT_PROCESS_XML_IN_MIME option for MIME parts with
text/xml content type
+ modified deserialization algorithm that allows to properly
deserialize SOAP1.2 messages when default is set to SOAP1.1 and
vice versa
+ added fault in XMLRPC::Lite for incorrect datatypes specified by
user (thanks to Paul Prescod)
+ added option to not generate XML declaration
+ added encoding for ']]>' (thanks to Matt Sergeant and James
Amrhein)
+ added '\r' => '
' conversion in strings
+ added complaint on incorrect simple types
+ added byNameOrOrder and byName functions for
SOAP::Server::Parameters (thanks to Matt Stum)
+ added handling relative locations in in WSDL
+ added stringification of SOAP::Fault (thanks to Tim Jenness)
+ added documentation for SSL certificate authentication
+ added more examples (terraserver.pl, joke.pl, weblog.pl)
+ added more tests
0.51 Tue Jul 18 15:15:14 2001
! fixed memory leak in SOAP::Parser (thanks to Ryan Adams and Michael
Brown)
! fixed skipping undef elements in arrays under Perl 5.005 (thanks to
Arne Georg Gleditsch)
! fixed warning from undefined type in out parameters (thanks to
Jrg Ziefle)
! fixed autovivification warnings on 5.7.x (thanks to Igor Pechersky)
! fixed tests on 64bit systems (thanks to Gurusamy Sarathy)
! fixed installation problem with long filenames on MacOS (thanks to
Alex Harper)
! fixed POP3 server (thanks to Kevin Hutchinson)
! number of fixes in XMLRPC::Lite
o fixed requirement (thanks to Matthew Krenzer and Dana
Powers)
o fixed empty slot skipping (thanks to Jon Udell)
o fixed serialization of "0"/""/undef values (thanks to Michael E.
Gage)
o fixed autodispatch (thanks to Craig Kelley)
+ added support for SOAP 1.2 (spec is still in draft, implementation
is subject to change)
+ added extended array support (only in deserializer)
sparse arrays
multidimensional arrays (deserialized as array of arrays)
partially transmitted arrays
+ modified XML::Parser::Lite to work on Perl 5.005 (thanks to John
Gotts)
fixed handling empty attributes as undef
fixed minors (thanks to Duncan Cameron)
+ modified deserializer to work with different schemas (1999/2001)
+ added JABBER transport
+ added MQ transport
+ added mod_xmlrpc transport (Apache::XMLRPC::Lite)
+ added TCP over SSL transport
+ added non-blocking TCP multiserver
+ included FastCGI transport (thanks to Marko Asplund)
+ added support for APOP authentication in POP3 transport
+ added Encoding parameter for MAILTO transport (to choose
base64/binary)
+ added 'autoresult' option (thanks to Mathieu Longtin)
+ added support for import directive in WSDL
+ added support for short (tModel) WSDL service descriptions
+ added support for multiple services/ports and allowed non-SOAP
bindings in WSDL
+ added full search example UDDI->WSDL->SOAP (fullsearch.pl)
+ added charset in response message for HTTP transport
+ modified SOAPsh/XMLRPCsh to return all parameters (thanks to Chris
Davies)
+ modified dispatch for XMLRPC server to work exactly as for SOAP
server examples included in examples/XMLRPC directory
+ added example with Inline::C module (inline.daemon).
Dispatch to C, C++, assembler, Java, Python and Tcl :).
Thanks to Brian Ingerson for his Inline module.
+ all transport are available for both SOAP::Lite and XMLRPC::Lite:
HTTP (daemon, CGI, mod_perl), SMTP/POP3, TCP, IO, JABBER, MQ
+ updated INCOMPATIBILITY section in README file
+ tested on Perl 5.00503, 5.6.0, 5.6.1, 5.7.1 and 5.7.2
+ added SOAP Cookbook (http://cookbook.soaplite.com/)
+ added server scripts for MQ and JABBER transports
+ added roundtrip example for JABBER transport
+ updated documentation and added new examples
+ added more tests (more than 700 for now)
0.50 Wed Apr 18 11:45:14 2001
! fixed tests on Windows platform
! fixed authInfo in UDDI publishing interface
! fixed mod_soap (Apache::SOAP) on Perl 5.005/5.004
! fixed namespace prefix on arrays of arrays
! modified Content-encoding from 'compress' to 'deflate'
+ added XML::Parser::Lite, regexp-based XML parser
used automatically when XML::Parser is not available
+ added examples of custom serialization and deserialization
(XML::DOM)
+ added XMLRPC::Lite (XMLRPC client and server interface)
all transports and features of SOAP::Lite should be available
+ added XMLRPC interactive shell (XMLRPCsh.pl)
+ added dispatching based on URI and SOAPAction (dispatch_with)
+ added dispatching to object (in addition to class/method)
+ added dispatch from specific class(es) (dispatch_from)
+ added limited support for mustUnderstand and actor attributes
+ added SOAP::Fault class for customization of returning Fault
message
+ added charset in HTTP header for requests
+ added check for namespace and types resolving
+ added namespaces declarations from WSDL interface
+ added INCOMPATIBILITY section in README file
+ added live tests/examples for UDDI publishing interface
+ added live tests/examples for basic authentication
+ added XMLRPC server code that validates with Userland's validator
+ added more examples, tests and documentation
0.47 Wed Feb 21 17:11:12 2001
! fixed lack of parameter in MAILTO transport
! fixed minimal version of COM interface to not require absent
modules
+ added compression for HTTP transport
+ added mod_soap interface, add SOAP server functionality
with couple of lines in .htaccess or httpd.conf file
+ added proper serialization of circular multiple references
+ significantly redesigned handling types and URIs
! incompatibilities with ApacheSOAP clients may occur
+ added handling PIPE and INT signals in Daemon server implementation
+ changed return from autodispatched calls:
result() in scalar context and paramsall() in list context
+ redesigned tests and split on core and optional for smooth CPAN
installation
+ added examples for cookie-based authorization
+ added examples in C# and PerlScript for COM interface
+ added more documentation for COM interface
+ updated documentation and added new examples
0.46 Wed Jan 31 16:30:24 2001
! fixed SOAP:: prefix with SOAP::Lite objects
! fixed documentation installation on Unix
! changed interface of schema() method. Use service() instead
+ added COM interface
single dll (standalone or minimal version, downloadable separately)
doesn't require ROPE.dll, MSXML.dll or listener.asp
tested on Windows 98/2K, and should work on Windows 9x/Me/NT/2K
ASP and daemon server implementations
examples in VB/VBS, Excel/VBA, JavaScript, Perl and ASP
+ added parsing multipart/form-data
SOAP server can accept SOAP requests directly from web form
examples are provided (examples/forms/*)
+ added Map type for hash encoding. Tested with ApacheSOAP
+ added function that maps classes to URI (maptype)
+ allowed multiple ports in WSDL
+ tested object interoperability with Apache SOAP
+ optimized internal functions
0.45 Tue Jan 16 00:38:04 2001
! fixed interoperability problem with incorrect Array prefix for
Apache SOAP
+ added interoperability tests for Apache SOAP
+ added interoperability tests with MS SOAP, 4s4c and Lucin
implementations
+ added attachment parsing (singlepart/multipart MIME)
Content-ID and Content-Location are supported
text/xml fragments are supported and parsed
all implementations support MIME encoded messages
+ added IO server implementation (for pipes, mail handlers, FTP and
file processing)
+ added FTP client implementation
+ added global settings, shareable between objects
+ allowed empty URI and non-prefixed method (documentation included)
+ added tests for xml, xml with headers, single and multipart MIME
+ updated documentation and added examples
+ more that 300 tests in test suite
0.44 Tue Dec 12 23:52:12 2000
! fixed mod_perl server to return '500 Server Error' in case of error
! fixed CGI server to work under PerlIS and PerlEx (thanks to Murray
Nesbitt)
+ tested publishing API for UDDI::Lite, examples provided
(thanks to Petr Janata for access to UDDI server and provided help)
+ added bi-directional TCP client/server, examples and tests provided
+ enabled de/serializer overloading on server side (in addition to
client)
+ added optimization for objects-by-reference
+ added ForkingDaemon server implementation (thanks to Peter
Fraenkel)
+ added SOAP::Custom::XML for XML processing, examples and tests
provided
+ added SOAP::Test as simple test framework
+ added documentation for UDDI publishing API
+ redesigned examples and tests (~240 tests for now)
0.43 Tue Nov 28 01:47:02 2000
! fixed bug in UDDI interface that made UDDI client almost useless
! fixed Makefile.PL
! tests confirmed that memory leak is gone
+ changed syntax for UDDI client to more flexible/convenient
+ added limited support for WSDL schemas. Dynamic and stub access
supported
+ added script for stub generation (stubmaker.pl)
+ optimized code on server side
+ object interface for SOAP, UDDI and schemas are supported
consistently
+ allowed manipulation of method's attributes and namespaces
+ added attributes encoding ('&', '<' and '"' are encoded)
+ updated documentation
(thanks to Robert Barta who basically did this work)
+ added more examples and tests (154 for now)
0.42 Tue Nov 14 23:14:18 2000
+ added UDDI client (UDDI::Lite) with documentation
+ added M-POST functionality in HTTP::Client
+ added redirect (3??) functionality in HTTP::Client
+ added session cache for M-POSTs and redirects
+ added conversion of all objects to o-b-r in parameters
+ changed passing envelope into method
+ allowed \x0d and \x0a in strings (will not do base64 encode)
+ added die with object that allows to specify complex Fault detail
+ optimized XML encoding
+ allowed function call with autodispatch
+ improved syntax for 'use SOAP::Lite'
+ added soap.tcp example for TCP server implementation
+ added tests with Microsoft implementation
+ added documentation and tests (145 for now)
0.41 Tue Oct 31 01:24:51 2000
! fixed memory leak on server side
! fixed die on absence of HTTP::* modules on server side
! fixed working with keep-alive connections (added test with
Xmethods)
+ changed autotyping from double to float
+ added support for proxy authorization (thanks to Murray Nesbitt)
+ added TCP client/server implementation
+ added benchmark for all implementations except smtp/pop3
+ added SOAP::Trace for detail logging on client/server side
+ added examples/tests for Apache::Registry implementations
+ added more examples, documentation and tests (127 for now)
0.40 Sun Oct 15 18:20:55 2000
! fixed die in mailto: protocol if you don't have URI::URL installed
! fixed misbehavior on Mac platform (thanks to Carl K. Cunningham)
+ added default namespace processing [xmlns] (thanks to Petr Janata)
+ added objects-by-reference, simple garbage collection and
activation
+ added full access to envelope on server side
+ added versionMismatch reaction
+ added local: protocol for local binding without any transport
+ added examples for objects-by-reference: persistent/session
iterators and chat (40 lines on server and 25 lines on client side)
0.39 Sun Oct 8 22:55:20 2000
! fixed incompatibility with Perl 5.005
+ added interactive Makefile.PL for CPAN installation
0.38 Thu Oct 5 22:06:20 2000
! fixed namespace for base64 encoding
! fixed security problem on server side, upgrade is highly
recommended
+ added HTTPS/SSL support
+ added SMTP client implementation
+ added POP3 server implementation
+ added support for Basic/Digest server authentication
+ added support for header(s) on client/server side with SOAP::Header
+ added Array and SOAPStruct for interoperability with ApacheSOAP
+ added generic class for server support SOAP::Server
+ added Actor attribute
+ added more examples, documentation and tests (88 for now)
0.36 Sun Sep 24 20:12:10 2000
! fixed output parameters autobinding
+ added mod_perl server implementation
+ added recognizing all simple types mentioned in specification
+ added support for 'hex' type
+ added more documentation (twice as much as before)
+ added more tests (74 for now)
0.35 Sun Sep 17 23:57:10 2000
! fixed minors (Response instead of Respond, server will map client's
URI)
+ cleaned HTTP::Server internals (will go to SOAP::Server in the
future)
+ test.pl won't abort on transport errors. Failed test will be
skipped
+ added daemon server implementation
+ added cgi/daemon server implementation examples
+ added deserialization into blessed reference
+ added dynamic/static class/method binding
+ added output parameters matching based on signature (name/type)
+ added real object transferring back and forth (see example of
Chatbot::Eliza, fixed for CODE references)
+ added more interoperability with on_action on client and server
side
+ added new events (on_action, on_fault, on_nonserialized)
+ added global class settings with 'use SOAP::Lite ...'
+ added code for returning application errors on server
+ added autodispatch
+ added SOAP prefix to method calls
+ added more documentation
+ added more tests (54 for now)
+ added more examples (Chatbot::Eliza, My::PingPong)
0.32 Sun Sep 10 23:27:10 2000
! fixed warnings with -w
! fixed blessed reference serialization. Assigned type has top
priority
+ added working with current node in SOAP::SOM
+ SOAP::SOM::valueof returns nodeset
+ SOAP::SOM::match returns boolean in boolean context
+ added raw xml accepting and output
+ added UserAgent parameters to SOAP::Transport (understands timeout)
+ added better diagnostic on transport errors in test.pl
+ added 'method', 'fault', 'freeform' types of Envelope
+ added server implementation
+ added CGI interface to server implementation
+ added My::Examples.pm as example of loaded class for SOAP server
+ added more tests (47 for now)
0.31 Wed Sep 6 00:36:15 2000
+ added expressions to SOAP::SOM->match method
+ added deserialization of circular references
+ added tests for deserialization
+ added documentation
0.3 Mon Sep 4 00:59:04 2000
+ first public beta version
+ added live SOAP calls
+ added test suite (25 tests)
+ added documentation
+ added interactive shell (SOAPsh.pl)
0.2 Mon Aug 24 19:34:24 2000
- next stable version; works with public test servers
0.1 Mon Aug 11 23:12:02 2000
- first version; serialization part only
SOAP-Lite-1.09/examples/ 000755 000766 000024 00000000000 12265327263 016066 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/HACKING 000644 000766 000024 00000011007 12200752752 015230 0 ustar 00fredmoyer staff 000000 000000 HACKING
=======
Development of SOAP::Lite takes place on GitHub.
git@github.com:redhotpenguin/soaplite.git
Come on by and fork it and submit a pull request.
Looking for a few good maintainers! We want you!
SOAP::Lite CODING GUIDELINES
============================
SOAP::Lite's coding style in principle follows Perl Best Practices by
Damian Conway, but allows deviances for speed and backward compatibility
reasons.
The following guidelines apply:
- Symbol table operations
* SOAP::Lite heavily relies on symbol table operations. While this is
nothing bad, you should always try other variants like subclassing before.
Use symbol table operations as a last resort, and preferably consolidate
similar operations into utility functions.
- Autoloading
* SOAP::Lite heavily relies on AUTOLOAD, often together with symbol table
operations. While this is nothing generally bad, it can lead to subtle
errors, for example when switching the underlying protocol handler of
a transport backend. Methods already autoloaded (and cached via symbol
table) remain, even if there's a equally named method in the new protocol
handler.
It's generally best not to rely on AUTOLOAD and symbol table operations -
subclassing is often more appropriate.
- testing
* SOAP::Lite has a test coverage of >60%, but aims at 100%. Please write
a test first.
* Use author tests for testing guidelines. Disable author tests for
users - it's time consuming and of no use to have users run author tests.
Author tests are enabled by setting the "TEST_AUTHOR" environment
variable to a true value.
- Indentation and formatting
* indent with spaces.
* indent 4 characters per level
* use \n (LF) for newlines, not CRLF
* use blank lines to separate paragraphs
* Coding style is similar to K&R (opening brace on last line, closing
brace on new line. No cuddled else)
* No trailing spaces allowed (except to indicate a blank line in a POD
source block)
- Flow control
* postfix if is allowed for single statements only. Preferably for flow
control only like in:
return $self if ref $self;
* postfix for, while, until are not allowed.
* unless is not allowed at all. Use if not.
* goto is only allowed for jumping into subs. Nothing else.
* redo, next, last etc. are preferred over goto.
- Strictness
* always use strict. Switch off for the smallest block
possible, but switch off if there's a reason (don't let tools like
perlcritic fool you: no strict qw(refs); is often required.
- Naming
* variable names are lower case with _ separating words, except when
a XML Schema, SOAP, or WSDL name is name-giving (don't force portType to
become port_type)
* hashes should be named FOO_of, lists FOO_from, references FOO_ref.
* package names are CamelCase, except when a XML, SOAP or WSDL name is
name-giving (don't force 'int' to become 'Int'. However, simpleType
becomes SimpleType).
Protocol names for transport modules are all UPPERCASE, like in
SOAP::Transport::HTTP or in SOAP::Transport::MAILTO.
- Subroutines
* Subroutines shouldn't be more than around 50 lines long
* @_ should be unpacked. Deviances are allowed for speed reasons. If
you're not unpacking @_ in a sub of say, 5 lines or more, please comment
what you're doing.
* The preferred idiom for unpacking @_ is:
my ($self, @arg_from) = @_;
or
my ($self, %arg_of) = @_;
$_[0] is preferred over shift, except where the rest of the parameter
stack is used en block later.
* Always return.
- POD and comments
* Comments denoting some people's copyright on some piece of the code
MUST be kept intact.
* Comment extensively. Comments are the maintainer (and core developer's)
documentation - aid them where possible (your're probably doing yourself
a favor by adding extensive comments).
* Comment either in blocks or as hanging side comments (especially when
commenting @_ access).
Example:
sub baz {
# @_ not unpacked for speed reasons. Read:
# my ($self, $something, %args_of) = @_;
$_[0]->bar($_[1]); # read as $self->bar($something);
$_[0]->foo($_[2..$#]); # read as $self->foo(%args_of);
return;
}
* POD is located at end of file, preferably after __END__
* Complete POD coverage is essential. However, if the package in question
is used internally only, it's better to omit the POD completely - too many
PODs to look at confuse the average CPAN user.
SOAP-Lite-1.09/lib/ 000755 000766 000024 00000000000 12265327263 015016 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/Makefile.PL 000644 000766 000024 00000004301 12237220576 016216 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use strict;
use warnings;
use ExtUtils::MakeMaker;
my %prereqs = (
# Core package
"Test::More" => 0,
"XML::Parser" => "2.23",
"MIME::Base64" => 0,
"URI" => 0,
"Scalar::Util" => 0,
"Task::Weaken" => 0, # to be sure than weaken works
"constant" => 0, # don't force people to upgrade
"Class::Inspector" => 0,
# Client TCP support
"IO::SessionData" => 1.03,
"IO::Socket::SSL" => 0,
# Compression support for HTTP
"Compress::Zlib" => 0,
# Client HTTP support
"LWP::UserAgent" => 0,
# Client HTTPS support
"Crypt::SSLeay" => 0,
# "Standalone HTTP server"
# ,"SOAP::Transport::HTTP::Daemon",{
# "HTTP::Daemon" => 0,
# "Apache/mod_perl server"
# "Apache" => 0,
# "FastCGI server"
# "FCGI" => 0,
# "POP3 server"
# "Net::POP3" => 0,
# "MIME::Parser" => 0,
# "MQ transport support"
# "SOAP::Transport::MQ" => 0.712,
# "JABBER transport support"
# "SOAP::Transport::JABBER" => 0.712,
# MIME messages
# "MIME::Parser" => 0,
# DIME messages
# "IO::Scalar" => "2.105",
# "DIME::Tools" => 0.03,
# "Data::UUID" => "0.11",
#"IO::File" => 0,
# "MIME interoperability w/ Axis"
# "MIME::Parser" => "6.106",
);
ExtUtils::MakeMaker::WriteMakefile(
'NAME' => 'SOAP::Lite',
'AUTHOR' =>
'Pavel Kulchenko, Randy J Ray, Byrne Reese, Martin Kutter (MKUTTER@cpan.org), Fred Moyer',
'LICENSE' => 'perl',
'VERSION_FROM' => 'lib/SOAP/Lite.pm',
'ABSTRACT_FROM' => 'lib/SOAP/Lite.pm',
'PREREQ_PM' => \%prereqs,
'EXE_FILES' => [ 'bin/SOAPsh.pl', 'bin/stubmaker.pl' ],
(
$ExtUtils::MakeMaker::VERSION ge '6.48'
? (
MIN_PERL_VERSION => 5.006,
META_MERGE => {
resources => {
repository => 'https://github.com/redhotpenguin/soaplite',
},
keywords => [ 'SOAP', 'SOAP client', 'SOAP server' ],
no_index => {
directory => [ qw( examples t ) ],
},
},
)
: ()
),
);
1;
SOAP-Lite-1.09/MANIFEST 000644 000766 000024 00000010766 12265327263 015413 0 ustar 00fredmoyer staff 000000 000000 bin/SOAPsh.pl
bin/stubmaker.pl
Changes
examples/allclients.pl
examples/authentication.pl
examples/autoexamples.pl
examples/chat.pl
examples/COM/hash.vbs
examples/COM/hashecho.vbs
examples/COM/local.vbs
examples/COM/make-com-minimal.bat
examples/COM/make-com-standalone.bat
examples/COM/make-com.args
examples/COM/README
examples/COM/remote.cs
examples/COM/remote.vba
examples/COM/remote.vbs
examples/COM/remote.xls
examples/COM/service.vbs
examples/COM/SOAP-Lite-COM-minimal.ctrl
examples/COM/SOAP-Lite-COM-standalone.ctrl
examples/COM/soap.asp
examples/COM/soap.vbs
examples/COM/soap_perl.asp
examples/COM/states.html
examples/COM/states.pl
examples/COM/states.vba
examples/COM/states.vbs
examples/COM/states.xls
examples/COM/temper.vbs
examples/COM/xmlrpc.vbs
examples/compress.pl
examples/cookie.pl
examples/cookieauth.pl
examples/customschema.pl
examples/forms/style.cgi
examples/forms/style.html
examples/fullsearch.pl
examples/getdom.pl
examples/google.pl
examples/inline.daemon
examples/iterator.pl
examples/joke.pl
examples/My/Chat.pm
examples/My/Examples.pm
examples/My/Parameters.pm
examples/My/PersistentIterator.pm
examples/My/PingPong.pm
examples/My/SessionIterator.pm
examples/oneliners
examples/oo-apache.pl
examples/parametersbyname.pl
examples/pingpong.pl
examples/server/Apache.pm
examples/server/mod_soap.htaccess
examples/server/soap.asp
examples/server/soap.cgi
examples/server/soap.daemon
examples/server/soap.daemon.forkafterprocessing
examples/server/soap.daemon.forkonaccept
examples/server/soap.fcgi
examples/server/soap.io
examples/server/soap.jabber
examples/server/soap.mod_cgi
examples/server/soap.mq
examples/server/soap.pop3
examples/server/soap.tcp
examples/server/soap.vbs
examples/server/soap_perl.asp
examples/SOAP/simple1.pl
examples/SOAP/simple2.pl
examples/SOAP/simple3.pl
examples/SOAP/Transport/HTTP/Daemon/ForkAfterProcessing.pm
examples/SOAP/Transport/HTTP/Daemon/ForkOnAccept.pm
examples/soapmark.pl
examples/soapsmtp.pl
examples/tcpclient.pl
examples/terraserver.pl
examples/UDDI/inquire1.pl
examples/UDDI/publish1.pl
examples/UDDI/simple1.pl
examples/UDDI/simple2.pl
examples/UDDI/syntax1.pl
examples/UDDI/syntax2.pl
examples/UDDI/syntax3.pl
examples/weblog.pl
examples/WSDL/dynamic1.pl
examples/WSDL/dynamic2.pl
examples/WSDL/dynamic3.pl
examples/WSDL/dynamic4.pl
examples/WSDL/stub1.pl
examples/WSDL/stub2.pl
examples/WSDL/stub3.pl
examples/XML/customxml.pl
examples/XMLRPC/mod_xmlrpc.htaccess
examples/XMLRPC/simple1.pl
examples/XMLRPC/xmlrpc.cgi
examples/XMLRPC/xmlrpc.daemon
HACKING
Makefile.PL
MANIFEST This list of files
META.yml
README
ReleaseNotes.txt
lib/Apache/SOAP.pm
lib/SOAP/Constants.pm
lib/SOAP/Lite/Deserializer/XMLSchema1999.pm
lib/SOAP/Lite/Deserializer/XMLSchema2001.pm
lib/SOAP/Lite/Deserializer/XMLSchemaSOAP1_1.pm
lib/SOAP/Lite/Deserializer/XMLSchemaSOAP1_2.pm
lib/SOAP/Lite/Packager.pm
lib/SOAP/Lite/Utils.pm
lib/SOAP/Lite.pm
lib/SOAP/Packager.pm
lib/SOAP/Test.pm
lib/SOAP/Transport/HTTP.pm
lib/SOAP/Transport/IO.pm
lib/SOAP/Transport/LOCAL.pm
lib/SOAP/Transport/LOOPBACK.pm
lib/SOAP/Transport/MAILTO.pm
lib/SOAP/Transport/POP3.pm
lib/SOAP/Transport/TCP.pm
lib/SOAP/Client.pod
lib/SOAP/Data.pod
lib/SOAP/Deserializer.pod
lib/SOAP/Fault.pod
lib/SOAP/Header.pod
lib/SOAP/Schema.pod
lib/SOAP/Serializer.pod
lib/SOAP/Server.pod
lib/SOAP/SOM.pod
lib/SOAP/Trace.pod
lib/SOAP/Transport.pod
lib/SOAP/Utils.pod
t/01-core.t
t/010-serializer.t
t/012-cloneable.t
t/013-array-deserialization.t
t/014_UNIVERSAL_use.t
t/015_UNIVERSAL_can.t
t/02-payload.t
t/03-server.t
t/04-attach-cid-encoded.t
t/04-attach.t
t/05-customxml.t
t/06-modules.t
t/08-schema.t
t/096_characters.t
t/097_kwalitee.t
t/098_pod.t
t/099_pod_coverage.t
t/11-cgi.t
t/12-cgi_https.t
t/13-mod_perl.t
t/14-cgi_apache.t
t/15-daemon.t
t/17-mod_soap.t
t/19-apachesoap.t
t/21-public.t
t/22-interop_apache.t
t/23-ppm.t
t/24-wsdl.t
t/36-leaks.t
t/38-packager.t
t/40-loopback.t
t/Issues/rt15176.t
t/Issues/rt53375.t
t/Issues/rt70329.t
t/Issues/rt70381.t
t/Issues/rt72836.t
t/Issues/rt74029.t
t/Issues/rt74308.t
t/Issues/rt75169.t
t/Issues/rt78588.t
t/SOAP/Data.t
t/SOAP/Lite/Deserializer/XMLSchema1999.t
t/SOAP/Lite/Deserializer/XMLSchema2001.t
t/SOAP/Lite/Deserializer/XMLSchemaSOAP1_1.t
t/SOAP/Lite/Deserializer/XMLSchemaSOAP1_2.t
t/SOAP/Lite/Packager.t
t/SOAP/Schema/WSDL.t
t/SOAP/Serializer.t
t/SOAP/Transport/HTTP/CGI.t
t/SOAP/Transport/HTTP.t
t/SOAP/Transport/IO.t
t/SOAP/Transport/LOCAL.t
t/SOAP/Transport/LOOPBACK.t
t/SOAP/Transport/MAILTO.t
t/SOAP/Transport/POP3.t
t/SOAP/Transport/TCP.t
META.json Module JSON meta-data (added by MakeMaker)
SOAP-Lite-1.09/META.json 000644 000766 000024 00000003103 12265327263 015666 0 ustar 00fredmoyer staff 000000 000000 {
"abstract" : "Perl's Web Services Toolkit",
"author" : [
"Pavel Kulchenko, Randy J Ray, Byrne Reese, Martin Kutter (MKUTTER@cpan.org), Fred Moyer"
],
"dynamic_config" : 1,
"generated_by" : "ExtUtils::MakeMaker version 6.78, CPAN::Meta::Converter version 2.132830",
"keywords" : [
"SOAP",
"SOAP client",
"SOAP server"
],
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : "2"
},
"name" : "SOAP-Lite",
"no_index" : {
"directory" : [
"t",
"inc",
"examples",
"t"
]
},
"prereqs" : {
"build" : {
"requires" : {
"ExtUtils::MakeMaker" : "0"
}
},
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "0"
}
},
"runtime" : {
"requires" : {
"Class::Inspector" : "0",
"Compress::Zlib" : "0",
"Crypt::SSLeay" : "0",
"IO::SessionData" : "1.03",
"IO::Socket::SSL" : "0",
"LWP::UserAgent" : "0",
"MIME::Base64" : "0",
"Scalar::Util" : "0",
"Task::Weaken" : "0",
"Test::More" : "0",
"URI" : "0",
"XML::Parser" : "2.23",
"constant" : "0",
"perl" : "5.006"
}
}
},
"release_status" : "stable",
"resources" : {
"repository" : {
"url" : "https://github.com/redhotpenguin/soaplite"
}
},
"version" : "1.09"
}
SOAP-Lite-1.09/META.yml 000644 000766 000024 00000001631 12265327263 015522 0 ustar 00fredmoyer staff 000000 000000 ---
abstract: "Perl's Web Services Toolkit"
author:
- 'Pavel Kulchenko, Randy J Ray, Byrne Reese, Martin Kutter (MKUTTER@cpan.org), Fred Moyer'
build_requires:
ExtUtils::MakeMaker: 0
configure_requires:
ExtUtils::MakeMaker: 0
dynamic_config: 1
generated_by: 'ExtUtils::MakeMaker version 6.78, CPAN::Meta::Converter version 2.132830'
keywords:
- SOAP
- 'SOAP client'
- 'SOAP server'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: 1.4
name: SOAP-Lite
no_index:
directory:
- t
- inc
- examples
- t
requires:
Class::Inspector: 0
Compress::Zlib: 0
Crypt::SSLeay: 0
IO::SessionData: 1.03
IO::Socket::SSL: 0
LWP::UserAgent: 0
MIME::Base64: 0
Scalar::Util: 0
Task::Weaken: 0
Test::More: 0
URI: 0
XML::Parser: 2.23
constant: 0
perl: 5.006
resources:
repository: https://github.com/redhotpenguin/soaplite
version: 1.09
SOAP-Lite-1.09/README 000644 000766 000024 00000172222 12200752752 015130 0 ustar 00fredmoyer staff 000000 000000 NAME
SOAP::Lite - Perl's Web Services Toolkit
DESCRIPTION
SOAP::Lite is a collection of Perl modules which provides a simple and
lightweight interface to the Simple Object Access Protocol (SOAP) both
on client and server side.
PERL VERSION WARNING
As of version SOAP::Lite version 1.0, no perl versions before 5.8 will
be supported.
SOAP::Lite 0.71 will be the last version of SOAP::Lite running on perl
5.005
Future versions of SOAP::Lite will require at least perl 5.6.0
If you have not had the time to upgrade your perl, you should consider
this now.
OVERVIEW OF CLASSES AND PACKAGES
lib/SOAP/Lite.pm
SOAP::Lite - Main class provides all logic
SOAP::Transport - Transport backend
SOAP::Data - Data objects
SOAP::Header - Header Data Objects
SOAP::Serializer - Serializes data structures to SOAP messages
SOAP::Deserializer - Deserializes SOAP messages into SOAP::SOM
objects
SOAP::SOM - SOAP Message objects
SOAP::Constants - Provides access to common constants and defaults
SOAP::Trace - Tracing facilities
SOAP::Schema - Provides access and stub(s) for schema(s)
SOAP::Schema::WSDL - WSDL implementation for SOAP::Schema
SOAP::Server - Handles requests on server side
SOAP::Server::Object - Handles objects-by-reference
SOAP::Fault - Provides support for Faults on server side
SOAP::Utils - A set of private and public utility subroutines
lib/SOAP/Packager.pm
SOAP::Packager - Provides an abstract class for implementing custom
packagers.
SOAP::Packager::MIME - Provides MIME support to SOAP::Lite
SOAP::Packager::DIME - Provides DIME support to SOAP::Lite
lib/SOAP/Transport/HTTP.pm
SOAP::Transport::HTTP::Client - Client interface to HTTP transport
SOAP::Transport::HTTP::Server - Server interface to HTTP transport
SOAP::Transport::HTTP::CGI - CGI implementation of server interface
SOAP::Transport::HTTP::Daemon - Daemon implementation of server
interface
SOAP::Transport::HTTP::Apache - mod_perl implementation of server
interface
lib/SOAP/Transport/POP3.pm
SOAP::Transport::POP3::Server - Server interface to POP3 protocol
lib/SOAP/Transport/MAILTO.pm
SOAP::Transport::MAILTO::Client - Client interface to SMTP/sendmail
lib/SOAP/Transport/LOCAL.pm
SOAP::Transport::LOCAL::Client - Client interface to local transport
lib/SOAP/Transport/TCP.pm
SOAP::Transport::TCP::Server - Server interface to TCP protocol
SOAP::Transport::TCP::Client - Client interface to TCP protocol
lib/SOAP/Transport/IO.pm
SOAP::Transport::IO::Server - Server interface to IO transport
METHODS
All accessor methods return the current value when called with no
arguments, while returning the object reference itself when called with
a new value. This allows the set-attribute calls to be chained together.
new(optional key/value pairs)
$client = SOAP::Lite->new(proxy => $endpoint)
Constructor. Many of the accessor methods defined here may be
initialized at creation by providing their name as a key, followed
by the desired value. The example provides the value for the proxy
element of the client.
transport(optional transport object)
$transp = $client->transport( );
Gets or sets the transport object used for sending/receiving SOAP
messages.
See SOAP::Transport for details.
serializer(optional serializer object)
$serial = $client->serializer( )
Gets or sets the serializer object used for creating XML messages.
See SOAP::Serializer for details.
packager(optional packager object)
$packager = $client->packager( )
Provides access to the "SOAP::Packager" object that the client uses
to manage the use of attachments. The default packager is a MIME
packager, but unless you specify parts to send, no MIME formatting
will be done.
See also: SOAP::Packager.
proxy(endpoint, optional extra arguments)
$client->proxy('http://soap.xml.info/ endPoint');
The proxy is the server or endpoint to which the client is going to
connect. This method allows the setting of the endpoint, along with
any extra information that the transport object may need when
communicating the request.
This method is actually an alias to the proxy method of
SOAP::Transport. It is the same as typing:
$client->transport( )->proxy(...arguments);
Extra parameters can be passed to proxy() - see below.
compress_threshold
See COMPRESSION in HTTP::Transport.
All initialization options from the underlying transport layer
The options for HTTP(S) are the same as for LWP::UserAgent's
new() method.
A common option is to create a instance of HTTP::Cookies and
pass it as cookie_jar option:
my $cookie_jar = HTTP::Cookies->new()
$client->proxy('http://www.example.org/webservice',
cookie_jar => $cookie_jar,
);
For example, if you wish to set the HTTP timeout for a SOAP::Lite
client to 5 seconds, use the following code:
my $soap = SOAP::Lite
->uri($uri)
->proxy($proxyUrl, timeout => 5 );
See LWP::UserAgent.
endpoint(optional new endpoint address)
$client->endpoint('http://soap.xml.info/ newPoint')
It may be preferable to set a new endpoint without the additional
work of examining the new address for protocol information and
checking to ensure the support code is loaded and available. This
method allows the caller to change the endpoint that the client is
currently set to connect to, without reloading the relevant
transport code. Note that the proxy method must have been called
before this method is used.
service(service URL)
$client->service('http://svc.perl.org/Svc.wsdl');
"SOAP::Lite" offers some support for creating method stubs from
service descriptions. At present, only WSDL support is in place.
This method loads the specified WSDL schema and uses it as the basis
for generating stubs.
outputxml(boolean)
$client->outputxml('true');
When set to a true value, the raw XML is returned by the call to a
remote method.
The default is to return the a SOAP::SOM object (false).
autotype(boolean)
$client->autotype(0);
This method is a shortcut for:
$client->serializer->autotype(boolean);
By default, the serializer tries to automatically deduce types for
the data being sent in a message. Setting a false value with this
method disables the behavior.
readable(boolean)
$client->readable(1);
This method is a shortcut for:
$client->serializer->readable(boolean);
When this is used to set a true value for this property, the
generated XML sent to the endpoint has extra characters (spaces and
new lines) added in to make the XML itself more readable to human
eyes (presumably for debugging). The default is to not send any
additional characters.
default_ns($uri)
Sets the default namespace for the request to the specified uri.
This overrides any previous namespace declaration that may have been
set using a previous call to "ns()" or "default_ns()". Setting the
default namespace causes elements to be serialized without a
namespace prefix, like this:
Some .NET web services have been reported to require this XML
namespace idiom.
ns($uri,$prefix=undef)
Sets the namespace uri and optionally the namespace prefix for the
request to the specified values. This overrides any previous
namespace declaration that may have been set using a previous call
to "ns()" or "default_ns()".
If a prefix is not specified, one will be generated for you
automatically. Setting the namespace causes elements to be
serialized with a declared namespace prefix, like this:
use_prefix(boolean)
Deprecated. Use the "ns()" and "default_ns" methods described above.
Shortcut for "serializer->use_prefix()". This lets you turn on/off
the use of a namespace prefix for the children of the /Envelope/Body
element. Default is 'true'.
When use_prefix is set to 'true', serialized XML will look like
this:
When use_prefix is set to 'false', serialized XML will look like
this:
Some .NET web services have been reported to require this XML
namespace idiom.
soapversion(optional value)
$client->soapversion('1.2');
If no parameter is given, returns the current version of SOAP that
is being used by the client object to encode requests. If a
parameter is given, the method attempts to set that as the version
of SOAP being used.
The value should be either 1.1 or 1.2.
envprefix(QName)
$client->envprefix('env');
This method is a shortcut for:
$client->serializer->envprefix(QName);
Gets or sets the namespace prefix for the SOAP namespace. The
default is SOAP.
The prefix itself has no meaning, but applications may wish to chose
one explicitly to denote different versions of SOAP or the like.
encprefix(QName)
$client->encprefix('enc');
This method is a shortcut for:
$client->serializer->encprefix(QName);
Gets or sets the namespace prefix for the encoding rules namespace.
The default value is SOAP-ENC.
While it may seem to be an unnecessary operation to set a value that
isn't relevant to the message, such as the namespace labels for the
envelope and encoding URNs, the ability to set these labels explicitly
can prove to be a great aid in distinguishing and debugging messages on
the server side of operations.
encoding(encoding URN)
$client->encoding($soap_12_encoding_URN);
This method is a shortcut for:
$client->serializer->encoding(args);
Where the earlier method dealt with the label used for the
attributes related to the SOAP encoding scheme, this method actually
sets the URN to be specified as the encoding scheme for the message.
The default is to specify the encoding for SOAP 1.1, so this is
handy for applications that need to encode according to SOAP 1.2
rules.
typelookup
$client->typelookup;
This method is a shortcut for:
$client->serializer->typelookup;
Gives the application access to the type-lookup table from the
serializer object. See the section on SOAP::Serializer.
uri(service specifier)
Deprecated - the "uri" subroutine is deprecated in order to provide
a more intuitive naming scheme for subroutines that set namespaces.
In the future, you will be required to use either the "ns()" or
"default_ns()" subroutines instead of "uri()".
$client->uri($service_uri);
This method is a shortcut for:
$client->serializer->uri(service);
The URI associated with this accessor on a client object is the
service-specifier for the request, often encoded for HTTP-based
requests as the SOAPAction header. While the names may seem
confusing, this method doesn't specify the endpoint itself. In most
circumstances, the "uri" refers to the namespace used for the
request.
Often times, the value may look like a valid URL. Despite this, it
doesn't have to point to an existing resource (and often doesn't).
This method sets and retrieves this value from the object. Note that
no transport code is triggered by this because it has no direct
effect on the transport of the object.
multirefinplace(boolean)
$client->multirefinplace(1);
This method is a shortcut for:
$client->serializer->multirefinplace(boolean);
Controls how the serializer handles values that have multiple
references to them. Recall from previous SOAP chapters that a value
may be tagged with an identifier, then referred to in several
places. When this is the case for a value, the serializer defaults
to putting the data element towards the top of the message, right
after the opening tag of the method-specification. It is serialized
as a standalone entity with an ID that is then referenced at the
relevant places later on. If this method is used to set a true
value, the behavior is different. When the multirefinplace attribute
is true, the data is serialized at the first place that references
it, rather than as a separate element higher up in the body. This is
more compact but may be harder to read or trace in a debugging
environment.
parts( ARRAY )
Used to specify an array of MIME::Entity's to be attached to the
transmitted SOAP message. Attachments that are returned in a
response can be accessed by "SOAP::SOM::parts()".
self
$ref = SOAP::Lite->self;
Returns an object reference to the default global object the
"SOAP::Lite" package maintains. This is the object that processes
many of the arguments when provided on the use line.
The following method isn't an accessor style of method but neither does
it fit with the group that immediately follows it:
call(arguments)
$client->call($method => @arguments);
As has been illustrated in previous chapters, the "SOAP::Lite"
client objects can manage remote calls with auto-dispatching using
some of Perl's more elaborate features. call is used when the
application wants a greater degree of control over the details of
the call itself. The method may be built up from a SOAP::Data
object, so as to allow full control over the namespace associated
with the tag, as well as other attributes like encoding. This is
also important for calling methods that contain characters not
allowable in Perl function names, such as A.B.C.
The next four methods used in the "SOAP::Lite" class are geared towards
handling the types of events than can occur during the message
lifecycle. Each of these sets up a callback for the event in question:
on_action(callback)
$client->on_action(sub { qq("$_[0]") });
Triggered when the transport object sets up the SOAPAction header
for an HTTP-based call. The default is to set the header to the
string, uri#method, in which URI is the value set by the uri method
described earlier, and method is the name of the method being
called. When called, the routine referenced (or the closure, if
specified as in the example) is given two arguments, uri and method,
in that order.
.NET web services usually expect "/" as separator for "uri" and
"method". To change SOAP::Lite's behaviour to use uri/method as
SOAPAction header, use the following code:
$client->on_action( sub { join '/', @_ } );
=item on_fault(callback)
$client->on_fault(sub { popup_dialog($_[1]) });
Triggered when a method call results in a fault response from the
server. When it is called, the argument list is first the client
object itself, followed by the object that encapsulates the fault.
In the example, the fault object is passed (without the client
object) to a hypothetical GUI function that presents an error dialog
with the text of fault extracted from the object (which is covered
shortly under the SOAP::SOM methods).
on_nonserialized(callback)
$client->on_nonserialized(sub { die "$_[0]?!?" });
Occasionally, the serializer may be given data it can't turn into
SOAP-savvy XML; for example, if a program bug results in a code
reference or something similar being passed in as a parameter to
method call. When that happens, this callback is activated, with one
argument. That argument is the data item that could not be
understood. It will be the only argument. If the routine returns,
the return value is pasted into the message as the serialization.
Generally, an error is in order, and this callback allows for
control over signaling that error.
on_debug(callback)
$client->on_debug(sub { print @_ });
Deprecated. Use the global +debug and +trace facilities described in
SOAP::Trace
Note that this method will not work as expected: Instead of
affecting the debugging behaviour of the object called on, it will
globally affect the debugging behaviour for all objects of that
class.
WRITING A SOAP CLIENT
This chapter guides you to writing a SOAP client by example.
The SOAP service to be accessed is a simple variation of the well-known
hello world program. It accepts two parameters, a name and a given name,
and returns "Hello $given_name $name".
We will use "Martin Kutter" as the name for the call, so all variants
will print the following message on success:
Hello Martin Kutter!
SOAP message styles
There are three common (and one less common) variants of SOAP messages.
These address the message style (positional parameters vs. specified
message documents) and encoding (as-is vs. typed).
The different message styles are:
* rpc/encoded
Typed, positional parameters. Widely used in scripting languages.
The type of the arguments is included in the message. Arrays and the
like may be encoded using SOAP encoding rules (or others).
* rpc/literal
As-is, positional parameters. The type of arguments is defined by
some pre-exchanged interface definition.
* document/encoded
Specified message with typed elements. Rarely used.
* document/literal
Specified message with as-is elements. The message specification and
element types are defined by some pre-exchanged interface
definition.
As of 2008, document/literal has become the predominant SOAP message
variant. rpc/literal and rpc/encoded are still in use, mainly with
scripting languages, while document/encoded is hardly used at all.
You will see clients for the rpc/encoded and document/literal SOAP
variants in this section.
Example implementations
RPC/ENCODED
Rpc/encoded is most popular with scripting languages like perl, php and
python without the use of a WSDL. Usual method descriptions look like
this:
Method: sayHello(string, string)
Parameters:
name: string
givenName: string
Such a description usually means that you can call a method named
"sayHello" with two positional parameters, "name" and "givenName", which
both are strings.
The message corresponding to this description looks somewhat like this:
KutterMartin
Any XML tag names may be used instead of the "s-gensym01" stuff -
parameters are positional, the tag names have no meaning.
A client producing such a call is implemented like this:
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:81/soap-wsdl-test/helloworld.pl');
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello', 'Kutter', 'Martin');
die $som->faultstring if ($som->fault);
print $som->result, "\n";
You can of course use a one-liner, too...
Sometimes, rpc/encoded interfaces are described with WSDL definitions. A
WSDL accepting "named" parameters with rpc/encoded looks like this:
The message corresponding to this schema looks like this:
KutterMartin
A web service client using this schema looks like this:
use SOAP::Lite;
my $soap = SOAP::Lite->service("file:say_hello_rpcenc.wsdl");
eval { my $result = $soap->sayHello('Kutter', 'Martin'); };
if ($@) {
die $@;
}
print $som->result();
You may of course also use the following one-liner:
perl -MSOAP::Lite -e 'print SOAP::Lite->service("file:say_hello_rpcenc.wsdl")\
->sayHello('Kutter', 'Martin'), "\n";'
A web service client (without a service description) looks like this.
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:81/soap-wsdl-test/helloworld.pl');
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello',
SOAP::Data->name('name')->value('Kutter'),
SOAP::Data->name('givenName')->value('Martin')
);
die $som->faultstring if ($som->fault);
print $som->result, "\n";
RPC/LITERAL
SOAP web services using the document/literal message encoding are
usually described by some Web Service Definition. Our web service has
the following WSDL description:
The XML message (inside the SOAP Envelope) look like this:
KutterMartinHello Martin Kutter!
This is the SOAP::Lite implementation for the web service client:
use SOAP::Lite +trace;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:80/helloworld.pl');
$soap->on_action( sub { "urn:HelloWorld#sayHello" });
$soap->autotype(0)->readable(1);
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello', SOAP::Data->name('parameters')->value(
\SOAP::Data->value([
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
]))
);
die $som->fault->{ faultstring } if ($som->fault);
print $som->result, "\n";
DOCUMENT/LITERAL
SOAP web services using the document/literal message encoding are
usually described by some Web Service Definition. Our web service has
the following WSDL description:
The XML message (inside the SOAP Envelope) look like this:
KutterMartinHello Martin Kutter!
You can call this web service with the following client code:
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:80/helloworld.pl');
$soap->on_action( sub { "urn:HelloWorld#sayHello" });
$soap->autotype(0);
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call("sayHello",
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
);
die $som->fault->{ faultstring } if ($som->fault);
print $som->result, "\n";
Differences between the implementations
You may have noticed that there's little difference between the
rpc/encoded, rpc/literal and the document/literal example's
implementation. In fact, from SOAP::Lite's point of view, the only
differences between rpc/literal and document/literal that parameters are
always named.
In our example, the rpc/encoded variant already used named parameters
(by using two messages), so there's no difference at all.
You may have noticed the somewhat strange idiom for passing a list of
named paraneters in the rpc/literal example:
my $som = $soap->call('sayHello', SOAP::Data->name('parameters')->value(
\SOAP::Data->value([
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
]))
);
While SOAP::Data provides full control over the XML generated, passing
hash-like structures require additional coding.
WRITING A SOAP SERVER
See SOAP::Server, or SOAP::Transport.
FEATURES
ATTACHMENTS
"SOAP::Lite" features support for the SOAP with Attachments
specification. Currently, SOAP::Lite only supports MIME based
attachments. DIME based attachments are yet to be fully functional.
EXAMPLES
Client sending an attachment
"SOAP::Lite" clients can specify attachments to be sent along with a
request by using the "SOAP::Lite::parts()" method, which takes as an
argument an ARRAY of "MIME::Entity"'s.
use SOAP::Lite;
use MIME::Entity;
my $ent = build MIME::Entity
Type => "image/gif",
Encoding => "base64",
Path => "somefile.gif",
Filename => "saveme.gif",
Disposition => "attachment";
my $som = SOAP::Lite
->uri($SOME_NAMESPACE)
->parts([ $ent ])
->proxy($SOME_HOST)
->some_method(SOAP::Data->name("foo" => "bar"));
Client retrieving an attachment
A client accessing attachments that were returned in a response by using
the "SOAP::SOM::parts()" accessor.
use SOAP::Lite;
use MIME::Entity;
my $soap = SOAP::Lite
->uri($NS)
->proxy($HOST);
my $som = $soap->foo();
foreach my $part (${$som->parts}) {
print $part->stringify;
}
Server receiving an attachment
Servers, like clients, use the SOAP::SOM module to access attachments
transmitted to it.
package Attachment;
use SOAP::Lite;
use MIME::Entity;
use strict;
use vars qw(@ISA);
@ISA = qw(SOAP::Server::Parameters);
sub someMethod {
my $self = shift;
my $envelope = pop;
foreach my $part (@{$envelope->parts}) {
print "AttachmentService: attachment found! (".ref($part).")\n";
}
# do something
}
Server responding with an attachment
Servers wishing to return an attachment to the calling client need only
return "MIME::Entity" objects along with SOAP::Data elements, or any
other data intended for the response.
package Attachment;
use SOAP::Lite;
use MIME::Entity;
use strict;
use vars qw(@ISA);
@ISA = qw(SOAP::Server::Parameters);
sub someMethod {
my $self = shift;
my $envelope = pop;
my $ent = build MIME::Entity
'Id' => "<1234>",
'Type' => "text/xml",
'Path' => "some.xml",
'Filename' => "some.xml",
'Disposition' => "attachment";
return SOAP::Data->name("foo" => "blah blah blah"),$ent;
}
DEFAULT SETTINGS
Though this feature looks similar to autodispatch they have (almost)
nothing in common. This capability allows you specify default settings
so that all objects created after that will be initialized with the
proper default settings.
If you wish to provide common "proxy()" or "uri()" settings for all
"SOAP::Lite" objects in your application you may do:
use SOAP::Lite
proxy => 'http://localhost/cgi-bin/soap.cgi',
uri => 'http://my.own.com/My/Examples';
my $soap1 = new SOAP::Lite; # will get the same proxy()/uri() as above
print $soap1->getStateName(1)->result;
my $soap2 = SOAP::Lite->new; # same thing as above
print $soap2->getStateName(2)->result;
# or you may override any settings you want
my $soap3 = SOAP::Lite->proxy('http://localhost/');
print $soap3->getStateName(1)->result;
Any "SOAP::Lite" properties can be propagated this way. Changes in
object copies will not affect global settings and you may still change
global settings with "SOAP::Lite->self" call which returns reference to
global object. Provided parameter will update this object and you can
even set it to "undef":
SOAP::Lite->self(undef);
The "use SOAP::Lite" syntax also lets you specify default event handlers
for your code. If you have different SOAP objects and want to share the
same "on_action()" (or "on_fault()" for that matter) handler. You can
specify "on_action()" during initialization for every object, but you
may also do:
use SOAP::Lite
on_action => sub {sprintf '%s#%s', @_};
and this handler will be the default handler for all your SOAP objects.
You can override it if you specify a handler for a particular object.
See t/*.t for example of on_fault() handler.
Be warned, that since "use ..." is executed at compile time all "use"
statements will be executed before script execution that can make
unexpected results. Consider code:
use SOAP::Lite proxy => 'http://localhost/';
print SOAP::Lite->getStateName(1)->result;
use SOAP::Lite proxy => 'http://localhost/cgi-bin/soap.cgi';
print SOAP::Lite->getStateName(1)->result;
Both SOAP calls will go to 'http://localhost/cgi-bin/soap.cgi'. If you
want to execute "use" at run-time, put it in "eval":
eval "use SOAP::Lite proxy => 'http://localhost/cgi-bin/soap.cgi'; 1" or die;
Or alternatively,
SOAP::Lite->self->proxy('http://localhost/cgi-bin/soap.cgi');
SETTING MAXIMUM MESSAGE SIZE
One feature of "SOAP::Lite" is the ability to control the maximum size
of a message a SOAP::Lite server will be allowed to process. To control
this feature simply define $SOAP::Constants::MAX_CONTENT_SIZE in your
code like so:
use SOAP::Transport::HTTP;
use MIME::Entity;
$SOAP::Constants::MAX_CONTENT_SIZE = 10000;
SOAP::Transport::HTTP::CGI
->dispatch_to('TemperatureService')
->handle;
IN/OUT, OUT PARAMETERS AND AUTOBINDING
"SOAP::Lite" gives you access to all parameters (both in/out and out)
and also does some additional work for you. Lets consider following
example:
name1name2name3
In that case:
$result = $r->result; # gives you 'name1'
$paramout1 = $r->paramsout; # gives you 'name2', because of scalar context
$paramout1 = ($r->paramsout)[0]; # gives you 'name2' also
$paramout2 = ($r->paramsout)[1]; # gives you 'name3'
or
@paramsout = $r->paramsout; # gives you ARRAY of out parameters
$paramout1 = $paramsout[0]; # gives you 'res2', same as ($r->paramsout)[0]
$paramout2 = $paramsout[1]; # gives you 'res3', same as ($r->paramsout)[1]
Generally, if server returns "return (1,2,3)" you will get 1 as the
result and 2 and 3 as out parameters.
If the server returns "return [1,2,3]" you will get an ARRAY reference
from "result()" and "undef" from "paramsout()".
Results can be arbitrary complex: they can be an array references, they
can be objects, they can be anything and still be returned by "result()"
. If only one parameter is returned, "paramsout()" will return "undef".
Furthermore, if you have in your output parameters a parameter with the
same signature (name+type) as in the input parameters this parameter
will be mapped into your input automatically. For example:
Server Code:
sub mymethod {
shift; # object/class reference
my $param1 = shift;
my $param2 = SOAP::Data->name('myparam' => shift() * 2);
return $param1, $param2;
}
Client Code:
$a = 10;
$b = SOAP::Data->name('myparam' => 12);
$result = $soap->mymethod($a, $b);
After that, "$result == 10 and $b->value == 24"! Magic? Sort of.
Autobinding gives it to you. That will work with objects also with one
difference: you do not need to worry about the name and the type of
object parameter. Consider the "PingPong" example
(examples/My/PingPong.pm and examples/pingpong.pl):
Server Code:
package My::PingPong;
sub new {
my $self = shift;
my $class = ref($self) || $self;
bless {_num=>shift} => $class;
}
sub next {
my $self = shift;
$self->{_num}++;
}
Client Code:
use SOAP::Lite +autodispatch =>
uri => 'urn:',
proxy => 'http://localhost/';
my $p = My::PingPong->new(10); # $p->{_num} is 10 now, real object returned
print $p->next, "\n"; # $p->{_num} is 11 now!, object autobinded
STATIC AND DYNAMIC SERVICE DEPLOYMENT
Let us scrutinize the deployment process. When designing your SOAP
server you can consider two kind of deployment: static and dynamic. For
both, static and dynamic, you should specify "MODULE", "MODULE::method",
"method" or "PATH/" when creating "use"ing the SOAP::Lite module. The
difference between static and dynamic deployment is that in case of
'dynamic', any module which is not present will be loaded on demand. See
the "SECURITY" section for detailed description.
When statically deploying a SOAP Server, you need to know all modules
handling SOAP requests before.
Dynamic deployment allows extending your SOAP Server's interface by just
installing another module into the dispatch_to path (see below).
STATIC DEPLOYMENT EXAMPLE
use SOAP::Transport::HTTP;
use My::Examples; # module is preloaded
SOAP::Transport::HTTP::CGI
# deployed module should be present here or client will get
# 'access denied'
-> dispatch_to('My::Examples')
-> handle;
For static deployment you should specify the MODULE name directly.
You should also use static binding when you have several different
classes in one file and want to make them available for SOAP calls.
DYNAMIC DEPLOYMENT EXAMPLE
use SOAP::Transport::HTTP;
# name is unknown, module will be loaded on demand
SOAP::Transport::HTTP::CGI
# deployed module should be present here or client will get 'access denied'
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'My::Examples')
-> handle;
For dynamic deployment you can specify the name either directly (in that
case it will be "require"d without any restriction) or indirectly, with
a PATH. In that case, the ONLY path that will be available will be the
PATH given to the dispatch_to() method). For information how to handle
this situation see "SECURITY" section.
SUMMARY
dispatch_to(
# dynamic dispatch that allows access to ALL modules in specified directory
PATH/TO/MODULES
# 1. specifies directory
# -- AND --
# 2. gives access to ALL modules in this directory without limits
# static dispatch that allows access to ALL methods in particular MODULE
MODULE
# 1. gives access to particular module (all available methods)
# PREREQUISITES:
# module should be loaded manually (for example with 'use ...')
# -- OR --
# you can still specify it in PATH/TO/MODULES
# static dispatch that allows access to particular method ONLY
MODULE::method
# same as MODULE, but gives access to ONLY particular method,
# so there is not much sense to use both MODULE and MODULE::method
# for the same MODULE
);
In addition to this "SOAP::Lite" also supports an experimental syntax
that allows you to bind a specific URL or SOAPAction to a CLASS/MODULE
or object.
For example:
dispatch_with({
URI => MODULE, # 'http://www.soaplite.com/' => 'My::Class',
SOAPAction => MODULE, # 'http://www.soaplite.com/method' => 'Another::Class',
URI => object, # 'http://www.soaplite.com/obj' => My::Class->new,
})
"URI" is checked before "SOAPAction". You may use both the
"dispatch_to()" and "dispatch_with()" methods in the same server, but
note that "dispatch_with()" has a higher order of precedence.
"dispatch_to()" will be checked only after "URI" and "SOAPAction" has
been checked.
See also: EXAMPLE APACHE::REGISTRY USAGE, "SECURITY"
COMPRESSION
"SOAP::Lite" provides you option to enable transparent compression over
the wire. Compression can be enabled by specifying a threshold value (in
the form of kilobytes) for compression on both the client and server
sides:
*Note: Compression currently only works for HTTP based servers and
clients.*
Client Code
print SOAP::Lite
->uri('http://localhost/My/Parameters')
->proxy('http://localhost/', options => {compress_threshold => 10000})
->echo(1 x 10000)
->result;
Server Code
my $server = SOAP::Transport::HTTP::CGI
->dispatch_to('My::Parameters')
->options({compress_threshold => 10000})
->handle;
For more information see COMPRESSION in HTTP::Transport.
SECURITY
For security reasons, the exisiting path for Perl modules (@INC) will be
disabled once you have chosen dynamic deployment and specified your own
"PATH/". If you wish to access other modules in your included package
you have several options:
1 Switch to static linking:
use MODULE;
$server->dispatch_to('MODULE');
Which can also be useful when you want to import something specific
from the deployed modules:
use MODULE qw(import_list);
2 Change "use" to "require". The path is only unavailable during the
initialization phase. It is available once more during execution.
Therefore, if you utilize "require" somewhere in your package, it
will work.
3 Wrap "use" in an "eval" block:
eval 'use MODULE qw(import_list)'; die if $@;
4 Set your include path in your package and then specify "use". Don't
forget to put @INC in a "BEGIN{}" block or it won't work. For
example,
BEGIN { @INC = qw(my_directory); use MODULE }
INTEROPERABILITY
Microsoft .NET client with SOAP::Lite Server
In order to use a .NET client with a SOAP::Lite server, be sure you use
fully qualified names for your return values. For example:
return SOAP::Data->name('myname')
->type('string')
->uri($MY_NAMESPACE)
->value($output);
In addition see comment about default incoding in .NET Web Services
below.
SOAP::Lite client with a .NET server
If experiencing problems when using a SOAP::Lite client to call a .NET
Web service, it is recommended you check, or adhere to all of the
following recommendations:
Declare a proper soapAction in your call
For example, use "on_action( sub {
'http://www.myuri.com/WebService.aspx#someMethod'; } )".
Disable charset definition in Content-type header
Some users have said that Microsoft .NET prefers the value of the
Content-type header to be a mimetype exclusively, but SOAP::Lite
specifies a character set in addition to the mimetype. This results
in an error similar to:
Server found request content type to be 'text/xml; charset=utf-8',
but expected 'text/xml'
To turn off this behavior specify use the following code:
use SOAP::Lite;
$SOAP::Constants::DO_NOT_USE_CHARSET = 1;
# The rest of your code
Use fully qualified name for method parameters
For example, the following code is preferred:
SOAP::Data->name(Query => 'biztalk')
->uri('http://tempuri.org/')
As opposed to:
SOAP::Data->name('Query' => 'biztalk')
Place method in default namespace
For example, the following code is preferred:
my $method = SOAP::Data->name('add')
->attr({xmlns => 'http://tempuri.org/'});
my @rc = $soap->call($method => @parms)->result;
As opposed to:
my @rc = $soap->call(add => @parms)->result;
# -- OR --
my @rc = $soap->add(@parms)->result;
Disable use of explicit namespace prefixes
Some user's have reported that .NET will simply not parse messages
that use namespace prefixes on anything but SOAP elements
themselves. For example, the following XML would not be parsed:
SOAP::Lite allows users to disable the use of explicit namespaces
through the "use_prefix()" method. For example, the following code:
$som = SOAP::Lite->uri('urn:MyURI')
->proxy($HOST)
->use_prefix(0)
->myMethod();
Will result in the following XML, which is more pallatable by .NET:
Modify your .NET server, if possible
Stefan Pharies :
SOAP::Lite uses the SOAP encoding (section 5 of the soap 1.1 spec),
and the default for .NET Web Services is to use a literal encoding.
So elements in the request are unqualified, but your service expects
them to be qualified. .Net Web Services has a way for you to change
the expected message format, which should allow you to get your
interop working. At the top of your class in the asmx, add this
attribute (for Beta 1):
[SoapService(Style=SoapServiceStyle.RPC)]
Another source said it might be this attribute (for Beta 2):
[SoapRpcService]
Full Web Service text may look like:
<%@ WebService Language="C#" Class="Test" %>
using System;
using System.Web.Services;
using System.Xml.Serialization;
[SoapService(Style=SoapServiceStyle.RPC)]
public class Test : WebService {
[WebMethod]
public int add(int a, int b) {
return a + b;
}
}
Another example from Kirill Gavrylyuk :
"You can insert [SoapRpcService()] attribute either on your class or
on operation level".
<%@ WebService Language=CS class="DataType.StringTest"%>
namespace DataType {
using System;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Web.Services.Description;
[SoapRpcService()]
public class StringTest: WebService {
[WebMethod]
[SoapRpcMethod()]
public string RetString(string x) {
return(x);
}
}
}
Example from Yann Christensen :
using System;
using System.Web.Services;
using System.Web.Services.Protocols;
namespace Currency {
[WebService(Namespace="http://www.yourdomain.com/example")]
[SoapRpcService]
public class Exchange {
[WebMethod]
public double getRate(String country, String country2) {
return 122.69;
}
}
}
Special thanks goes to the following people for providing the above
description and details on .NET interoperability issues:
Petr Janata ,
Stefan Pharies ,
Brian Jepson , and others
TROUBLESHOOTING
SOAP::Lite serializes "18373" as an integer, but I want it to be a
string!
SOAP::Lite guesses datatypes from the content provided, using a set
of common-sense rules. These rules are not 100% reliable, though
they fit for most data.
You may force the type by passing a SOAP::Data object with a type
specified:
my $proxy = SOAP::Lite->proxy('http://www.example.org/soapservice');
my $som = $proxy->myMethod(
SOAP::Data->name('foo')->value(12345)->type('string')
);
You may also change the precedence of the type-guessing rules. Note
that this means fiddling with SOAP::Lite's internals - this may not
work as expected in future versions.
The example above forces everything to be encoded as string (this is
because the string test is normally last and allways returns true):
my @list = qw(-1 45 foo bar 3838);
my $proxy = SOAP::Lite->uri($uri)->proxy($proxyUrl);
my $lookup = $proxy->serializer->typelookup;
$lookup->{string}->[0] = 0;
$proxy->serializer->typelookup($lookup);
$proxy->myMethod(\@list);
See SOAP::Serializer for more details.
"+autodispatch" doesn't work in Perl 5.8
There is a bug in Perl 5.8's "UNIVERSAL::AUTOLOAD" functionality
that prevents the "+autodispatch" functionality from working
properly. The workaround is to use "dispatch_from" instead. Where
you might normally do something like this:
use Some::Module;
use SOAP::Lite +autodispatch =>
uri => 'urn:Foo'
proxy => 'http://...';
You would do something like this:
use SOAP::Lite dispatch_from(Some::Module) =>
uri => 'urn:Foo'
proxy => 'http://...';
Problems using SOAP::Lite's COM Interface
Can't call method "server" on undefined value
You probably did not register Lite.dll using "regsvr32 Lite.dll"
Failed to load PerlCtrl Runtime
It is likely that you have install Perl in two different
locations and the location of ActiveState's Perl is not the
first instance of Perl specified in your PATH. To rectify,
rename the directory in which the non-ActiveState Perl is
installed, or be sure the path to ActiveState's Perl is
specified prior to any other instance of Perl in your PATH.
Dynamic libraries are not found
If you are using the Apache web server, and you are seeing something
like the following in your webserver log file:
Can't load '/usr/local/lib/perl5/site_perl/.../XML/Parser/Expat/Expat.so'
for module XML::Parser::Expat: dynamic linker: /usr/local/bin/perl:
libexpat.so.0 is NEEDED, but object does not exist at
/usr/local/lib/perl5/.../DynaLoader.pm line 200.
Then try placing the following into your httpd.conf file and see if
it fixes your problem.
PassEnv LD_LIBRARY_PATH
SOAP client reports "500 unexpected EOF before status line seen
See "Apache is crashing with segfaults"
Apache is crashing with segfaults
Using "SOAP::Lite" (or XML::Parser::Expat) in combination with
mod_perl causes random segmentation faults in httpd processes. To
fix, try configuring Apache with the following:
RULE_EXPAT=no
If you are using Apache 1.3.20 and later, try configuring Apache
with the following option:
./configure --disable-rule=EXPAT
See http://archive.covalent.net/modperl/2000/04/0185.xml for more
details and lot of thanks to Robert Barta for
explaining this weird behavior.
If this doesn't address the problem, you may wish to try
"-Uusemymalloc", or a similar option in order to instruct Perl to
use the system's own "malloc".
Thanks to Tim Bunce .
CGI scripts do not work under Microsoft Internet Information Server
(IIS)
CGI scripts may not work under IIS unless scripts use the ".pl"
extension, opposed to ".cgi".
Java SAX parser unable to parse message composed by SOAP::Lite
In some cases SOAP messages created by "SOAP::Lite" may not be
parsed properly by a SAX2/Java XML parser. This is due to a known
bug in "org.xml.sax.helpers.ParserAdapter". This bug manifests
itself when an attribute in an XML element occurs prior to the XML
namespace declaration on which it depends. However, according to the
XML specification, the order of these attributes is not significant.
http://www.megginson.com/SAX/index.html
Thanks to Steve Alpert (Steve_Alpert@idx.com) for pointing on it.
PERFORMANCE
Processing of XML encoded fragments
"SOAP::Lite" is based on XML::Parser which is basically wrapper
around James Clark's expat parser. Expat's behavior for parsing XML
encoded string can affect processing messages that have lot of
encoded entities, like XML fragments, encoded as strings. Providing
low-level details, parser will call char() callback for every
portion of processed stream, but individually for every processed
entity or newline. It can lead to lot of calls and additional memory
manager expenses even for small messages. By contrast, XML messages
which are encoded as base64Binary, don't have this problem and
difference in processing time can be significant. For XML encoded
string that has about 20 lines and 30 tags, number of call could be
about 100 instead of one for the same string encoded as
base64Binary.
Since it is parser's feature there is NO fix for this behavior (let
me know if you find one), especially because you need to parse
message you already got (and you cannot control content of this
message), however, if your are in charge for both ends of processing
you can switch encoding to base64 on sender's side. It will
definitely work with SOAP::Lite and it may work with other
toolkits/implementations also, but obviously I cannot guarantee
that.
If you want to encode specific string as base64, just do
"SOAP::Data->type(base64 => $string)" either on client or on server
side. If you want change behavior for specific instance of
SOAP::Lite, you may subclass "SOAP::Serializer", override
"as_string()" method that is responsible for string encoding (take a
look into "as_base64Binary()") and specify new serializer class for
your SOAP::Lite object with:
my $soap = new SOAP::Lite
serializer => My::Serializer->new,
..... other parameters
or on server side:
my $server = new SOAP::Transport::HTTP::Daemon # or any other server
serializer => My::Serializer->new,
..... other parameters
If you want to change this behavior for all instances of SOAP::Lite,
just substitute "as_string()" method with "as_base64Binary()"
somewhere in your code after "use SOAP::Lite" and before actual
processing/sending:
*SOAP::Serializer::as_string = \&SOAP::XMLSchema2001::Serializer::as_base64Binary;
Be warned that last two methods will affect all strings and convert
them into base64 encoded. It doesn't make any difference for
SOAP::Lite, but it may make a difference for other toolkits.
BUGS AND LIMITATIONS
* No support for multidimensional, partially transmitted and sparse
arrays (however arrays of arrays are supported, as well as any other
data structures, and you can add your own implementation with
SOAP::Data).
* Limited support for WSDL schema.
* XML::Parser::Lite relies on Unicode support in Perl and doesn't do
entity decoding.
* Limited support for mustUnderstand and Actor attributes.
PLATFORM SPECIFICS
MacOS
Information about XML::Parser for MacPerl could be found here:
http://bumppo.net/lists/macperl-modules/1999/07/msg00047.html
Compiled XML::Parser for MacOS could be found here:
http://www.perl.com/CPAN-local/authors/id/A/AS/ASANDSTRM/XML-Parser-
2.27-bin-1-MacOS.tgz
RELATED MODULES
Transport Modules
SOAP::Lite allows one to add support for additional transport protocols,
or server handlers, via separate modules implementing the
SOAP::Transport::* interface. The following modules are available from
CPAN:
* SOAP-Transport-HTTP-Nginx
SOAP::Transport::HTTP::Nginx provides a transport module for nginx
()
AVAILABILITY
You can download the latest version SOAP::Lite for Unix or SOAP::Lite
for Win32 from the following sources:
* CPAN: http://search.cpan.org/search?dist=SOAP-Lite
You are welcome to send e-mail to the maintainers of SOAP::Lite with
your comments, suggestions, bug reports and complaints.
ACKNOWLEDGEMENTS
Special thanks to Randy J. Ray, author of *Programming Web Services with
Perl*, who has contributed greatly to the documentation effort of
SOAP::Lite.
Special thanks to O'Reilly publishing which has graciously allowed
SOAP::Lite to republish and redistribute the SOAP::Lite reference manual
found in Appendix B of *Programming Web Services with Perl*.
And special gratitude to all the developers who have contributed
patches, ideas, time, energy, and help in a million different forms to
the development of this software.
HACKING
Latest development takes place on GitHub.com. Come on by and fork it.
git@github.com:redhotpenguin/soaplite.git
Also see the HACKING file.
Actively recruiting maintainers for this module. Come and get it on!
REPORTING BUGS
Please use rt.cpan.org or github to report bugs. Pull requests are
preferred.
COPYRIGHT
Copyright (C) 2000-2007 Paul Kulchenko. All rights reserved.
Copyright (C) 2007-2008 Martin Kutter
Copyright (C) 2013 Fred Moyer
LICENSE
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
This text and all associated documentation for this library is made
available under the Creative Commons Attribution-NoDerivs 2.0 license.
http://creativecommons.org/licenses/by-nd/2.0/
AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
Martin Kutter (martin.kutter@fen-net.de)
Fred Moyer (fred@redhotpenguin.com)
SOAP-Lite-1.09/ReleaseNotes.txt 000644 000766 000024 00000004502 12200752752 017375 0 ustar 00fredmoyer staff 000000 000000 #
# ReleaseNotes.txt
#
The following is a compilation of various issues developers should be aware of
when developing Web services using SOAP::Lite.
LIMITED WSDL SUPPORT - SOAP::Lite is not capable of generating WSDLs
automatically. If you require a WSDL for a service written using SOAP::Lite,
please consider using a tool like XML Spy, or CapeClear's WSDL Editor.
NO ENTITY DECODING
SOAP::Lite uses XML::Parser::Lite which relies on Unicode support in Perl and
doesn't perform XML ENTITY decoding.
LIMITED SUPPORT FOR MUSTUNDERSTAND and ACTOR ATTRIBUTES
SOAP::Lite does not currently heed the soap:mustUnderstand XML attribute, or
SOAP actor attributes.
DOCUMENT-LITERAL SUPPORT
All literal encoding support for SOAP::Lite is marked EXPERIMENTAL, and it is
incomplete. Developers are encouraged to use this capability but should be
fore-warned.
As an alternative, SOAP::WSDL or XML::Compiled::SOAP may be used for
document/literal bindings derived from WSDL definitions.
CLIENT SIDE WSDL SUPPORT
SOAP::Lites ability to consume a WSDL and generate the necessary message based
on that WSDL is improving, but it does not work with complex types.
As an alternative, SOAP::WSDL or XML::Compiled::SOAP may be used for
document/literal bindings derived from WSDL definitions.
SERVICE SIDE WSDL SUPPORT
Perl is a loosely typed language making it extraordinarily difficult to generate
a reliable WSDL based upon reflection of somekind. Therefore, no WSDL can be
generated using SOAP::Lite.
SOAP FAULT NOT GETTING SERIALIZED PROPERLY
A user reported that when a service run under Perl version 5.5003 issues the
die command with a SOAP::Fault as input, that SOAP::Lite does not properly
serialize the Fault object. However, the same code works under 5.6 and above.
NULL BODIES
SOAP::Lite currently allows users to construct an Envelope using a null body,
e.g. . However, SOAP::Lite services have no way
of processing such a message.
XML NAMESPACES ABSENT FROM RESPONSES
A user reported that under mod_perl for a series of requests which were using
SOAP 1.1 and 1.2, that some of the responses to incoming messages lacked the
XSD and XSI namespace declarations causing an error with the receiving .NET
client for those response lacking these attributes.
OBJECTS BY REFERENCE
SOAP::Server->objects_by_reference is marked EXPERIMENTAL
SOAP-Lite-1.09/t/ 000755 000766 000024 00000000000 12265327263 014513 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/01-core.t 000644 000766 000024 00000030631 12156373142 016045 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
BEGIN { plan tests => 42; }
use SOAP::Lite;
my($a, $s, $r, $serialized, $deserialized);
{ # check 'use ...'
print "'use SOAP::Lite ...' test(s)...\n";
eval 'use SOAP::Lite 99.99'; # hm, definitely should fail
ok(scalar $@ =~ /99.+required/);
}
# These tests are for backwards compatibility
{ # check use of use_prefix and uri together
# test 2 - turn OFF default namespace
$SIG{__WARN__} = sub { ; }; # turn off deprecation warnings
$serialized = SOAP::Serializer->use_prefix(1)->uri("urn:Test")->method(
'testMethod', SOAP::Data->name(test => 123)
);
ok($serialized =~ m!123!);
# test 3 - turn ON default namespace
$serialized = SOAP::Serializer->use_prefix(0)->uri("urn:Test")->method(
'testMethod', SOAP::Data->name(test => 123)
);
ok($serialized =~ m!123!);
}
{ # check use of default_ns, ns, and use_prefix
# test 4
$serialized = SOAP::Serializer->ns("urn:Test")->method(
'testMethod', SOAP::Data->name(test => 123)
);
ok($serialized =~ m!123!);
# test 5
$serialized = SOAP::Serializer->ns("urn:Test","testns")->method(
'testMethod', SOAP::Data->name(test => 123)
);
ok($serialized =~ m!123!);
# test 6
$serialized = SOAP::Serializer->default_ns("urn:Test")->method(
'testMethod', SOAP::Data->name(test => 123)
);
ok($serialized =~ m!123!);
}
{ # check serialization
print "Arrays, structs, refs serialization test(s)...\n";
$serialized = SOAP::Serializer->serialize(
SOAP::Data->name(test => \SOAP::Data->value(1, [1,2], {a=>3}, \4))
);
ok($serialized =~ m!11234!);
}
{ # check simple circular references
print "Simple circular references (\$a=\\\$a) serialization test(s)...\n";
$a = \$a;
$serialized = SOAP::Serializer->namespaces({})->serialize($a);
ok($serialized =~ m!!);
$a = SOAP::Deserializer->deserialize($serialized)->root;
ok(0+$a == 0+(values%$a)[0]);
}
{ # check complex circular references
print "Complex circlular references serialization test(s)...\n";
$a = SOAP::Deserializer->deserialize(<<'EOX')->root;
178
EOX
ok($a->{a}->{next}->{next}->{next}->{next}->{x} ==
$a->{a}->{next}->{x});
$a = { a => 1 }; my $b = { b => $a }; $a->{a} = $b;
$serialized = SOAP::Serializer->autotype(0)->namespaces({})->serialize($a);
ok($serialized =~ m!!);
}
{ # check multirefs
print "Multireferences serialization test(s)...\n";
$a = 1; my $b = \$a;
$serialized = SOAP::Serializer->new(multirefinplace=>1)->serialize(
SOAP::Data->name(test => \SOAP::Data->value($b, $b))
);
ok($serialized =~ m!1!);
$serialized = SOAP::Serializer->namespaces({})->serialize(
SOAP::Data->name(test => \SOAP::Data->value($b, $b))
);
print $serialized, "\n";
ok($serialized =~ m!1!);
}
{ # check base64, XML encoding of elements and attributes
print "base64, XML encoding of elements and attributes test(s)...\n";
$serialized = SOAP::Serializer->serialize(
SOAP::Data->name(test => \SOAP::Data->value("\0\1\2\3 \4\5\6", "<123>&\015"))
);
ok($serialized =~ m!AAECAyAgIAQFBg==<123>&
</123>!);
$serialized = SOAP::Serializer->namespaces({})->serialize(
SOAP::Data->name(name=>'value')->attr({attr => '<123>"&"'})
);
ok($serialized =~ m!^<\?xml version="1.0" encoding="UTF-8"\?>value$!);
}
{ # check objects and SOAP::Data
print "Blessed references and SOAP::Data encoding test(s)...\n";
$serialized = SOAP::Serializer->serialize(SOAP::Data->uri('some_urn' => bless {a => 1} => 'ObjectType'));
ok($serialized =~ m!1!);
}
{ # check serialization/deserialization of simple types
print "Serialization/deserialization of simple types test(s)...\n";
$a = 'abc234xyz';
$serialized = SOAP::Serializer->serialize(SOAP::Data->type(hex => $a));
ok($serialized =~ m!61626332333478797A!);
ok(SOAP::Deserializer->deserialize($serialized)->root eq $a);
$a = <<"EOBASE64";
qwertyuiop[]asdfghjkl;'zxcvbnm,./QWERTYUIOP{}ASDFGHJKL:"ZXCVBNM<>?`1234567890-=\~!@#$%^&*()_+|
EOBASE64
$serialized = SOAP::Serializer->serialize($a);
ok(index($serialized, quotemeta(q!qwertyuiop[]asdfghjkl;'zxcvbnm,./QWERTYUIOP{}ASDFGHJKL:"ZXCVBNM<>?`1234567890-=~\!@#0^&*()_+|!)));
if (UNIVERSAL::isa(SOAP::Deserializer->parser->parser => 'XML::Parser::Lite')) {
skip(q!Entity decoding is not supported in XML::Parser::Lite! => undef);
} else {
ok(SOAP::Deserializer->deserialize($serialized)->root eq $a);
}
$a = <<"EOBASE64";
qwertyuiop[]asdfghjkl;'zxcvbnm,./
QWERTYUIOP{}ASDFGHJKL:"ZXCVBNM<>?
\x00
EOBASE64
$serialized = SOAP::Serializer->serialize($a);
ok($serialized =~ /base64/);
}
{ # check serialization/deserialization of blessed reference
print "Serialization/deserialization of blessed reference test(s)...\n";
$serialized = SOAP::Serializer->serialize(bless {a => 1} => 'SOAP::Lite');
$a = SOAP::Deserializer->deserialize($serialized)->root;
ok(ref $a eq 'SOAP::Lite' && UNIVERSAL::isa($a => 'HASH'));
$a = SOAP::Deserializer->deserialize(
SOAP::Serializer->serialize(bless [a => 1] => 'SOAP::Lite')
)->root;
ok(ref $a eq 'SOAP::Lite' && UNIVERSAL::isa($a => 'ARRAY'));
}
{ # check serialization/deserialization of undef/empty elements
print "Serialization/deserialization of undef/empty elements test(s)...\n";
{ local $^W; # suppress warnings
$a = undef;
$serialized = SOAP::Serializer->serialize(
SOAP::Data->type(negativeInteger => $a)
);
ok(! defined SOAP::Deserializer->deserialize($serialized)->root);
my $type = 'nonstandardtype';
eval {
$serialized = SOAP::Serializer->serialize(
SOAP::Data->type($type => $a)
);
};
ok($@ =~ /for type '$type' is not specified/);
$serialized = SOAP::Serializer->serialize(
SOAP::Data->type($type => {})
);
ok(ref SOAP::Deserializer->deserialize($serialized)->root eq $type);
}
}
{
print "Check for unspecified Transport module test(s)...\n";
eval { SOAP::Lite->new->abc() };
ok($@ =~ /A service address has not been specified/);
}
{
print "Deserialization of CDATA test(s)...\n";
UNIVERSAL::isa(SOAP::Deserializer->parser->parser => 'XML::Parser::Lite') ?
skip(q!CDATA decoding is not supported in XML::Parser::Lite! => undef) :
ok(SOAP::Deserializer->deserialize(']]>')->root eq '<123>');
}
{
print "Test of XML::Parser External Entity vulnerability...\n";
UNIVERSAL::isa(SOAP::Deserializer->parser->parser => 'XML::Parser::Lite') ?
skip(q!External entity references are not supported in XML::Parser::Lite! => undef) :
ok(!eval { SOAP::Deserializer->deserialize(' ]>≪')->root } and $@ =~ /^External entity/);
}
{
print "Test SOAP:: prefix with no +autodispatch option...\n";
eval { A->SOAP::b };
ok($@ =~ /^SOAP:: prefix/);
}
{
# check deserialization of an array of multiple elements
# nested within a complex type
print "Deserialization of document/literal arrays nested in complex types...\n";
my $input = '100onetwo';
my $deserializer = SOAP::Deserializer->new;
my $ret = $deserializer->deserialize($input);
my @arr = @{$ret->result->{'complexFoo'}{'arrayFoo'}};
ok($#arr == 1);
ok("one" eq $arr[0]);
ok("two" eq $arr[1]);
ok(100 == $ret->result->{"id"});
# If only one araryFoo tag is found, it's deserialized as a scalar.
$input = '100one';
$ret = $deserializer->deserialize($input);
ok("one" eq $ret->result->{'complexFoo'}{'arrayFoo'});
}
{
print "Serialization of document/literal arrays\n";
# check array serialization with autotyping disabled
my $serializer = SOAP::Serializer->new;
$serializer->autotype(0);
my $hash = {
"scalar" => 1,
"array" => [ 2, 3],
"hash" => {
"scalar" => 4,
"array" => [ 5, 6],
}
};
my $xml = $serializer->serialize($hash);
ok($xml =~ m{
]*>
(:?
(:?
56
|4
){2}
| 23
| 1
){3}
}xms
);
# deserialize it and check that a similar object is created
my $deserializer = SOAP::Deserializer->new;
my $obj = $deserializer->deserialize($xml)->root;
ok(1, $obj->{"scalar"});
my @arr= @{$obj->{"array"}};
ok(2, $arr[0]);
ok(3, $arr[1]);
ok(4, $obj->{"hash"}{"scalar"});
@arr = @{$obj->{"hash"}{"array"}};
ok(5, $arr[0]);
ok(6, $arr[1]);
}
SOAP-Lite-1.09/t/010-serializer.t 000644 000766 000024 00000010271 12156373142 017344 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test;
use SOAP::Lite;
my @types1999 = qw(
anyURI
string float double decimal timeDuration recurringDuration uriReference
integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger timeInstant time timePeriod date month year century
recurringDate recurringDay language
);
my @types2001 = qw(
anyType anyURI
string float double decimal dateTime timePeriod gMonth gYearMonth gYear
century gMonthDay gDay duration recurringDuration anyURI
language integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger date time dateTime
);
# types * 3 + extra tests + autotype tests
plan tests => 225;
test_serializer('SOAP::XMLSchema1999::Serializer', @types1999);
test_serializer('SOAP::XMLSchema2001::Serializer', @types2001);
sub test_serializer {
my $package = shift;
my @types = @_;
print "# $package\n";
for my $type (@types) {
my $method = "as_$type";
print "# $method\n";
use Data::Dumper;
my $result = $package->$method('', 'test', $type , {});
ok $result->[0] eq 'test';
ok $result->[1]->{ 'xsi:type' };
ok $result->[2] eq '';
}
}
# additional tests
ok (SOAP::XMLSchema1999::Serializer->anyTypeValue eq 'ur-type');
my $enc = SOAP::XMLSchema1999::Serializer->as_hex('AA', 'test', 'hex', {});
ok $enc->[2] eq '4141';
$enc = SOAP::XMLSchema1999::Serializer->as_dateTime('AA', 'test', 'FOO', {});
ok $enc->[1]->{'xsi:type'} eq 'xsd:dateTime';
ok $enc->[2] eq 'AA';
$enc = SOAP::XMLSchema1999::Serializer->as_boolean(1, 'test', 'boolean', {});
ok $enc->[2] eq 'true';
$enc = SOAP::XMLSchema1999::Serializer->as_boolean(0, 'test', 'boolean', {});
ok $enc->[2] eq 'false';
$enc = SOAP::XMLSchema1999::Serializer->as_undef(1, 'test', 'boolean', {});
ok $enc eq '1';
$enc = SOAP::XMLSchema1999::Serializer->as_undef(0, 'test', 'boolean', {});
ok $enc eq '0';
$enc = SOAP::XMLSchema1999::Serializer->as_base64(0, 'test', 'string', {});
ok ($enc->[2] eq 'MA==');
print "# encoding/decoding Euro symbol in base64\n";
if ($] < 5.008) {
print "# Skippng unicode test on perl <5.8 ($])\n";
ok(1);
ok(1);
}
else {
eval {
# may fail on old perls
my $str = chr(8364);
utf8::encode($str);
my $enc = SOAP::XMLSchema1999::Serializer->as_base64($str, 'test', 'string', {});
my $enc2001 = SOAP::XMLSchema2001::Serializer->as_base64Binary($str, 'test', 'string', {});
use MIME::Base64;
for ($enc, $enc2001) {
if ( decode_base64($_->[2]) eq $str ) {
ok(1);
}
else {
print "$str, ", decode_base64($enc->[2]), "\n";
ok(0);
}
}
}
}
eval { SOAP::XMLSchema1999::Serializer->as_string([], 'test', 'string', {}) };
ok $@ =~m{ \A String \s value \s expected }xms;
eval { SOAP::XMLSchema1999::Serializer->as_anyURI([], 'test', 'string', {}) };
ok $@ =~m{ \A String \s value \s expected }xms;
ok ! SOAP::XMLSchema1999::Serializer->DESTROY();
my $serializer = SOAP::Serializer->new();
my $fault_envelope = $serializer->envelope(
fault => 'Code', 'string', 'Detail', 'Actor'
);
# Test fault serialization order
ok $fault_envelope =~m{ .+(faultcode).+(faultstring).+(faultactor).+(detail)}x;
$serializer = SOAP::Serializer->new();
print "# autotype tests\n";
$serializer->autotype(1);
my %type_of = (
'true' => 'xsd:boolean',
'false' => 'xsd:boolean',
'rtue' => 'xsd:string',
'aflse' => 'xsd:string',
'012345' => 'xsd:string',
'Hello World' => 'xsd:string',
'http://example.org' => 'xsd:anyURI',
'12345' => 'xsd:int',
'-2147483648' => 'xsd:int',
'2147483647' => 'xsd:int',
'2147483648' => 'xsd:long',
'5999927619709920' => 'xsd:long',
'P' => 'xsd:string',
'PT' => 'xsd:string',
'PT01S' => 'xsd:duration',
);
while (my ($value, $type) = each %type_of) {
my $result = $serializer->encode_scalar($value, 'test', undef, {});
print "# $value => $type (result: $result->[1]->{'xsi:type'})\n";
ok ( $result->[1]->{'xsi:type'} eq $type );
} SOAP-Lite-1.09/t/012-cloneable.t 000644 000766 000024 00000000351 12156373142 017117 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test;
use SOAP::Lite;
plan tests => 2;
my $soap = SOAP::Lite->new(
readable => 1,
outputxml => 1,
);
my $clone = $soap->clone();
ok ($clone->readable() == 1);
ok ($clone->outputxml() == 1);
SOAP-Lite-1.09/t/013-array-deserialization.t 000644 000766 000024 00000004116 12156373142 021501 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use strict;
use Test;
plan tests => 5;
local $/ = undef;
my $xml = ;
use SOAP::Lite;
my $som = SOAP::Deserializer->new->deserialize($xml);
my $result = $som->result();
ok (@$result == 2);
ok $result->[0]->isa('outer');
ok $result->[1]->isa('outer');
ok $result->[1]->{ kids }->[0]->isa('inner');
ok $result->[1]->{ kids }->[1]->isa('inner');
__DATA__
aaaabbbabb
SOAP-Lite-1.09/t/014_UNIVERSAL_use.t 000644 000766 000024 00000000403 12156373142 017501 0 ustar 00fredmoyer staff 000000 000000 use Test;
use SOAP::Lite;
plan tests => 1;
eval "use UNIVERSAL::require"
or do {
print "# Test should always without UNIVERSAL::use installed\n";
};
my $obj = SOAP::Custom::XML::Data->new();
eval { $obj->use('SOAP-encoded') };
ok !$@; SOAP-Lite-1.09/t/015_UNIVERSAL_can.t 000644 000766 000024 00000001422 12156373142 017451 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl -w
use Test;
BEGIN {
if ($] < 5.008001) {
print "# +autodispatch broken in 5.8.0\n";
plan tests => 0;
exit 0;
}
}
package foo;
sub new {
my $class = shift;
my $self = {count => 0,};
bless $self, $class;
}
sub bar {
my $self = shift;
++$self->{count};
}
sub proxy {
my $self = shift;
my $meth = shift;
if ($self->can($meth)) {
return $self->$meth;
} else {
return;
}
}
# This code works if it's a regular class
package main;
use Test;
plan tests => 3;
my $f = new foo();
use SOAP::Lite +autodispatch =>
uri => 'http://example.org/foo',
proxy => 'http://example.org.cgi';
ok $f->bar() == 1;
if ($f->can("bar")) {
ok $f->bar == 2;
}
if ($f->can("proxy")) {
ok $f->proxy("bar") == 3;
} SOAP-Lite-1.09/t/02-payload.t 000644 000766 000024 00000100400 12200752752 016535 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
BEGIN {
plan tests => 133;
}
use SOAP::Lite;
$SIG{__WARN__} = sub { ; }; # turn off deprecation warnings
my($a, $s, $r, $serialized, $deserialized);
{ # check root, mustUnderstand
print "root and mustUnderstand attributes with SOAP::Data test(s)...\n";
$serialized = SOAP::Serializer->serialize(SOAP::Data->root(1 => 1)->name('rootandunderstand')->mustUnderstand(1));
ok($serialized =~ m!1!);
}
{ # check deserialization of envelope with result
print "Deserialization of envelope with result test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
204060100200
');
ok($deserialized->result->[2] == 60);
ok((my @array = $deserialized->paramsall) == 1);
ok(ref $deserialized->body eq 'HASH'); # not blessed anymore since 0.51
}
{ # check deserialization of envelope with fault
print "Deserialization of envelope with fault test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
soap:ClientApplication ErrorInvalid Password
');
ok($deserialized->faultcode eq 'soap:Client');
ok($deserialized->faultstring eq 'Application Error');
ok($deserialized->faultdetail eq 'Invalid Password');
}
{ # check deserialization of circular references
print "Deserialization of circular references test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
');
ok(ref $deserialized->valueof('/Struct') eq ref $deserialized->valueof('//b'));
ok($deserialized->dataof('/Struct')->attr->{'{aaa}id'} == 123);
ok(exists $deserialized->dataof('/Struct')->attr->{'id'});
}
{ # check SOAP::SOM
print "SOM test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
204060100200200200200400450600
');
# should return STRING '/Envelope/Body/[1]/[1]'
my $result = SOAP::SOM::result;
ok($deserialized->valueof("$result/[1]") == 20);
ok($deserialized->valueof("$result/[3]") == 60);
ok($deserialized->valueof("$result/[5]") == 200);
ok($deserialized->valueof("$result/[9]") == 400);
# Test more than 9 items to check depth is okay - RT78692
ok($deserialized->valueof("$result/[11]") == 600);
# match should return true/false in boolean context (and object ref otherwise)
ok($deserialized->match('aaa') ? 0 : 1);
# should return same string as above
ok($deserialized->match(SOAP::SOM->result));
ok($deserialized->valueof('[1]') == 20);
ok($deserialized->valueof('[3]') == 60);
ok($deserialized->valueof('[5]') == 200);
$deserialized->match('//Body/[1]/[1]'); # match path and change current node on success
ok($deserialized->valueof('[1]') == 20);
ok($deserialized->valueof('[3]') == 60);
ok($deserialized->valueof('[5]') == 200);
}
{ # check output parameters
print "Output parameters test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
name1name2name3
');
my @paramsout = $deserialized->paramsout;
ok($paramsout[0] eq 'name2' && $paramsout[1] eq 'name3');
}
{ # check nonqualified namespace
print "Nonqualified namespace test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
204060100200
');
ok($deserialized->namespaceuriof(SOAP::SOM::method) eq 'http://simon.fell.com/calc');
ok($deserialized->namespaceuriof('//doublerResponse') eq 'http://simon.fell.com/calc');
}
{ # check for Array of Array serialization
print "Array of Array serialization test(s)...\n";
$serialized = SOAP::Serializer
->readable(1)
->method('mymethod' => [[1, 2], [3, 4]]);
ok($serialized =~ m!soapenc:arrayType="soapenc:Array\[2\]"!);
}
{ # check for serialization with SOAPStruct
print "Serialization w/out SOAPStruct test(s)...\n";
$a = { a => 1 };
$serialized = SOAP::Serializer->namespaces({})->serialize($a);
ok($serialized =~ m!1!);
}
{ # check header/envelope serialization/deserialization
print "Header/Envelope serialization/deserialization test(s)...\n";
$serialized = SOAP::Serializer->method( # same as ->envelope(method =>
'mymethod', 1, 2, 3,
SOAP::Header->name(t1 => 5)->mustUnderstand(1)->uri('http://namespaces.soaplite.com/headers'),
SOAP::Header->name(t2 => 7)->mustUnderstand(2),
);
$deserialized = SOAP::Deserializer->deserialize($serialized);
my $t1 = $deserialized->match(SOAP::SOM::header)->headerof('t1');
my $t2 = $deserialized->dataof('t2');
my $t3 = eval { $deserialized->headerof(SOAP::SOM::header . '/{http://namespaces.soaplite.com/headers}t3'); };
ok(!$@ && !defined $t3);
my @paramsin = $deserialized->paramsin;
my @paramsall = $deserialized->paramsall;
ok($t2->type =~ /^int$/);
ok($t2->mustUnderstand == 1);
ok(@paramsin == 3);
ok(@paramsall == 3);
eval { $deserialized->result(1) };
ok($@ =~ /Method 'result' is readonly/);
$serialized = SOAP::Serializer->method( # same as ->envelope(method =>
SOAP::Data->name('mymethod')->attr({something => 'value'}), 1, 2, 3,
);
ok($serialized =~ //);
$serialized = SOAP::Serializer
-> envprefix('')
-> method('mymethod');
ok($serialized =~ m!!);
$deserialized = SOAP::Deserializer->deserialize('1');
ok(! defined $deserialized->namespaceuriof('//getStateName'));
$deserialized = SOAP::Deserializer->deserialize('1');
ok($deserialized->namespaceuriof('//getStateName') eq 'a');
}
{ # Map type serialization/deserialization
print "Map type serialization/deserialization test(s)...\n";
my $key = "\0\1";
$serialized = SOAP::Serializer->method(aa => SOAP::Data->type(map => {a => 123, $key => 456})->name('maaap'));
{ local $^W; # disable warning on implicit map encoding
my $implicit = SOAP::Serializer->method(aa => SOAP::Data->name(maaap => {a => 123, $key => 456}));
ok($implicit eq $serialized);
}
ok($serialized =~ /apachens:Map/);
ok($serialized =~ m!xmlns:apachens="http://xml.apache.org/xml-soap"!);
$deserialized = SOAP::Deserializer->deserialize($serialized);
$a = $deserialized->valueof('//maaap');
ok(UNIVERSAL::isa($a => 'HASH'));
ok(ref $a && $a->{$key} == 456);
}
{ # Stringified type serialization
print "Stringified type serialization test(s)...\n";
$serialized = SOAP::Serializer->serialize(bless { a => 1, _current => [] } => 'SOAP::SOM');
my $test = $serialized;
ok $test =~s{
<\?xml \s version="1.0" \s encoding="UTF-8"\?>
}{}xms;
ok $test =~s{
\z
}{}xms;
ok $test =~s{ 1 }{}xms;
ok $test =~s{ <_current (:?
\s soapenc:arrayType="xsd:anyType\[0\]"
| \s xsi:type="soapenc:Array" ){2}
\s/>
}{}xms;
ok length $test == 0;
# Replaced complex regex by several simpler (see above).
# ok($serialized =~ m!1<_current(?: soapenc:arrayType="xsd:anyType\[0\]"| xsi:type="soapenc:Array"){2} />!);
# ok( ($serialized =~ m!1<_current(?: soapenc:arrayType="xsd:anyType\[0\]"| xsi:type="soapenc:Array"){2}/>!)
# || ($serialized =~ m!<_current(?: soapenc:arrayType="xsd:anyType\[0\]"| xsi:type="soapenc:Array"){2}/>1!));
#print $serialized;
# exit;
$serialized =~ s/__/./g; # check for SOAP.SOM instead of SOAP__SOM
ok(ref SOAP::Deserializer->deserialize($serialized)->root eq 'SOAP::SOM');
}
{ # Serialization of non-allowed element
print "Serialization of non-allowed element test(s)...\n";
eval { $serialized = SOAP::Serializer->serialize(SOAP::Data->name('---' => 'aaa')) };
ok($@ =~ /^Element/);
}
{ # Custom serialization of blessed reference
print "Custom serialization of blessed reference test(s)...\n";
eval q!
sub SOAP::Serializer::as_My__Own__Class {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return [$name, {%{$attr || {}}, 'xsi:type' => 'xsd:string'}, join ', ', map {"$_ => $value->{$_}"} sort keys %$value];
}
1;
! or die;
$serialized = SOAP::Serializer->serialize(bless {a => 1, b => 2} => 'My::Own::Class');
ok($serialized =~ m!a => 1, b => 2!);
}
{ # Multirefs serialization
print "Multirefs serialization test(s)...\n";
my $b = { b => 2 };
my $a = { a => $b };
my $c = { c1 => $a, c2 => $a };
$serialized = SOAP::Serializer->autotype(0)->method(a => $c);
ok($serialized =~ m!2! ||
$serialized =~ m!2! ||
$serialized =~ m!2! ||
$serialized =~ m!2!);
$serialized = SOAP::Serializer->autotype(0)->namespaces({})->serialize($c);
ok($serialized =~ m!2! ||
$serialized =~ m!2! ||
$serialized =~ m!2! ||
$serialized =~ m!2!);
my $root = SOAP::Deserializer->deserialize($serialized)->root;
ok($root->{c1}->{a}->{b} == 2);
ok($root->{c2}->{a}->{b} == 2);
}
{ # Serialization of multirefs shared between Header and Body
print "Serialization of multirefs shared between Header and Body test(s)...\n";
$a = { b => 2 };
print $serialized = SOAP::Serializer->autotype(0)->method(a => SOAP::Header->value($a), $a);
print "\n";
print '2', "\n";
ok($serialized =~ m!2!);
}
{ # Deserialization with typecast
print "Deserialization with typecast test(s)...\n";
my $desc = 0;
my $typecasts = 0;
eval {
package MyDeserializer;
@MyDeserializer::ISA = 'SOAP::Deserializer';
sub typecast;
*typecast = sub { shift;
my($value, $name, $attrs, $children, $type) = @_;
$desc = "$name @{[scalar @$children]}" if $name eq 'a';
$typecasts++;
return;
};
1;
} or die;
$deserialized = MyDeserializer->deserialize('12');
ok($desc eq 'a 2'); #! fix "if $name eq 'a'", because $name is QName now ('{}a')
ok($typecasts == 5);
}
{ # Deserialization with wrong encodingStyle
print "Deserialization with wrong encodingStyle test(s)...\n";
eval { $deserialized = SOAP::Deserializer->deserialize(
'1') };
ok(!$@ && $deserialized);
eval { $deserialized = SOAP::Deserializer->deserialize(
'1') };
ok(!$@ && $deserialized);
eval { $deserialized = SOAP::Deserializer->deserialize(
'1') };
ok(!$@ && $deserialized);
eval { $deserialized = SOAP::Deserializer->deserialize(
'1') };
ok(!$@ && $deserialized);
eval { $deserialized = SOAP::Deserializer->deserialize(
'1') };
ok(!$@ && $deserialized);
}
{ # Deserialization with root attribute
print "Deserialization with root attribute test(s)...\n";
# root="0", should skip
$deserialized = SOAP::Deserializer->deserialize('
12
');
ok($deserialized->result == 2);
# root="0", but in wrong namespace
$deserialized = SOAP::Deserializer->deserialize('
12
');
ok($deserialized->result == 1);
# root="1"
$deserialized = SOAP::Deserializer->deserialize('
1234
');
ok($deserialized->result == 1);
ok($deserialized->valueof('//{http://www.soaplite.com/2}doublerResponse2/nums') == 2);
ok($deserialized->valueof('//{http://www.soaplite.com/3}doublerResponse2/nums') == 3);
ok($deserialized->valueof('//{}doublerResponse2/nums') == 4);
my @nums = $deserialized->valueof('//doublerResponse2/nums');
ok(@nums == 3);
ok($nums[0] == 2 && $nums[1] == 3);
my $body = $deserialized->body;
ok(ref $body->{doublerResponse1} && ref $body->{doublerResponse2});
}
{
print "Deserialization with null elements test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
1257
')->result;
ok(scalar @$deserialized == 7);
ok(! defined $deserialized->[2]);
ok(! defined $deserialized->[3]);
ok($deserialized->[5] eq '');
}
{
print "Serialization of list with undef elements test(s)...\n";
$serialized = SOAP::Serializer->method(a => undef, 1, undef, 2);
my(@r) = SOAP::Deserializer->deserialize($serialized)->paramsall;
ok(2 == grep {!defined} @r);
}
{
print "Deserialization with xsi:type='string' test(s)...\n";
$a = 'SOAP::Lite';
$deserialized = SOAP::Deserializer->deserialize(qq!$a!)->root;
ok($deserialized eq $a);
}
{
print "Deserialization with typing inherited from Array element test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
MTIzMTIz')->root;
ok(scalar @$deserialized == 3);
ok($deserialized->[0] eq 'MTIz');
ok($deserialized->[1] eq 123);
ok($deserialized->[2] eq '');
}
{
print "Serialization with explicit typing test(s)...\n";
$serialized = SOAP::Serializer
->method(a => SOAP::Data->name('return')->type(int => 1));
ok($serialized =~ /xsd:int/);
eval {
$serialized = SOAP::Serializer
->method(a => SOAP::Data->name('return')->type(noint => 1));
};
ok($@ =~ /for type 'noint' is not specified/);
}
{
print "Serialization w/out explicit typing test(s)...\n";
$a = { a => 'false' };
$serialized = SOAP::Serializer->namespaces({})->serialize($a);
### 'false' evaluated as a boolean should still be false after the evaluation.
ok($serialized =~ m!false!);
$a = { a => 'true' };
$serialized = SOAP::Serializer->namespaces({})->serialize($a);
### 'false' evaluated as a boolean should still be false after the evaluation.
ok($serialized =~ m!true!);
}
{
print "Serialization with explicit namespaces test(s)...\n";
$serialized = SOAP::Serializer->serialize(SOAP::Data->name('b' => 1));
ok($serialized =~ m!serialize(SOAP::Data->name('c:b' => 1));
ok($serialized =~ m!serialize(SOAP::Data->name('{a}b' => 1));
ok($serialized =~ m!serialize(SOAP::Data->name('{}b' => 1));
ok($serialized =~ m!1' ],
[ undef, '', '1' ],
[ undef, 'a', '<(namesp\d+):b xmlns:\1="a">1' ],
[ '', undef, '1' ],
[ '', '', '1' ],
[ '', 'a', '1' ],
[ 'c', undef, '1' ],
[ 'c', '', '1' ],
[ 'c', 'a', '1' ],
);
my $serializer = SOAP::Serializer->autotype(0)->namespaces({});
my $deserializer = SOAP::Deserializer->new;
my $testnum = 0;
foreach (@prefix_uri_tests) {
$testnum++;
my($prefix, $uri, $test) = @$_;
my $res = $serializer->serialize(
SOAP::Data->name('b')->prefix($prefix)->uri($uri)->value(1)
);
ok($res =~ /$test/);
next unless $testnum =~ /^([4569])$/;
my $data = $deserializer->deserialize($res)->dataof(SOAP::SOM::root);
ok(defined $prefix ? defined $data->prefix && $data->prefix eq $prefix
: !defined $data->prefix);
ok(defined $uri ? defined $data->uri && $data->uri eq $uri
: !defined $data->uri);
}
}
{
print "Deserialization for different SOAP versions test(s)...\n";
my $version = SOAP::Lite->soapversion;
$a = q!
135!;
SOAP::Lite->soapversion(1.1);
$deserialized = SOAP::Deserializer->deserialize($a);
ok(ref $deserialized->result eq 'ARRAY');
SOAP::Lite->soapversion(1.2);
$deserialized = SOAP::Deserializer->deserialize($a);
ok(ref $deserialized->result eq 'ARRAY');
SOAP::Lite->soapversion($version);
}
{
print "Deserialization of multidimensional array of array test(s)...\n";
$a = q!
123456789101112!;
$deserialized = SOAP::Deserializer->deserialize($a)->result;
# [
# [
# ['1', '2', '3'],
# ['4', '5', '6']
# ],
# [
# ['7', '8', '9'],
# ['10', '11', '12']
# ]
# ]
ok(ref $deserialized eq 'ARRAY');
ok(@$deserialized == 2);
ok(@{$deserialized->[0]} == 2);
ok(@{$deserialized->[0]->[0]} == 3);
ok($deserialized->[0]->[0]->[2] == 3);
}
{
print "Serialization without specified typemapping test(s)...\n";
$serialized = SOAP::Serializer->method(a => bless {a => 1} => 'A');
ok($serialized =~ m!!);
ok($serialized =~ m!^<\?xml!); # xml declaration
# higly questionably, but that's how it is
$serialized = SOAP::Serializer->encoding(undef)->method(a => bless {a => 1} => 'A');
ok($serialized =~ m!!);
ok($serialized !~ m!^<\?xml!); # no xml declaration
}
{
print "Deserialization with different XML Schemas on one element test(s)...\n";
my $deserializer = SOAP::Deserializer->new;
$deserializer->deserialize(q!Simple Test String!);
ok($deserializer->xmlschema eq 'http://www.w3.org/1999/XMLSchema');
$deserializer->deserialize(q!Simple Test String!);
ok($deserializer->xmlschema eq 'http://www.w3.org/2001/XMLSchema');
}
{
print "SOAP::Fault stringification test(s)...\n";
my $f = SOAP::Fault->faultcode('Client.Authenticate')
->faultstring('Bad error');
ok($f eq 'Client.Authenticate: Bad error');
}
{
print "Memory leaks test(s)...\n"; # also check 36-leaks.t
my %calls;
{
SOAP::Lite->import(trace => [objects => sub {
if ((caller(2))[3] =~ /^(.+)::(.+)$/) {
$calls{$2}{$1}++;
}
}]);
my $soap = SOAP::Lite
-> uri("Echo")
-> proxy("http://services.soaplite.com/echo.cgi");
}
foreach (keys %{$calls{new}}) {
ok(exists $calls{DESTROY}{$_});
}
%calls = ();
{
local $SOAP::Constants::DO_NOT_USE_XML_PARSER = 1;
my $soap = SOAP::Lite
-> uri("Echo")
-> proxy("http://services.soaplite.com/echo.cgi");
}
foreach (keys %{$calls{new}}) {
ok(exists $calls{DESTROY}{$_});
}
SOAP::Lite->import(trace => '-objects');
}
SOAP-Lite-1.09/t/03-server.t 000644 000766 000024 00000025046 12156373142 016431 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
BEGIN { plan tests => 32 }
use SOAP::Lite;
my($a, $s, $r, $serialized, $deserialized);
my %tests = (
'XML only' => <<'EOM',
25
EOM
'message with headers' => <<'EOM',
Content-Type: text/xml
25
EOM
'singlepart MIME' => <<'EOM',
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: 25
--MIME_boundary--
EOM
'multipart MIME' => <<'EOM',
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: 25
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID:
2
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID:
5
--MIME_boundary--
EOM
'multipart MIME w/multiref' => <<'EOM',
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID:
2
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID:
5
--MIME_boundary--
EOM
);
eval "SOAP::Packager::MIME->new->initialize_parser();";
my $is_mimetools_installed = ($@) ? 0 : 1;
(my $reason = $@) =~ s/ at .+// unless $is_mimetools_installed;
print "MIME tests will be skipped: $reason" if defined $reason;
my $package = '
package Calculator;
sub new { bless {} => ref($_[0]) || $_[0] }
sub add { $_[1] + $_[2] }
sub schema { $SOAP::Constants::DEFAULT_XML_SCHEMA }
1;';
# TEST 1-4
HANDLER: {
print "Server handler test(s)...\n";
my $server = SOAP::Server->dispatch_to('Calculator');
SKIP: for (reverse sort keys %tests) {
#print $_, "\n";
my $result = SOAP::Deserializer->deserialize($server->handle($tests{$_}));
skip(1, 'skip')
if ($_ =~m/XML/ || !$is_mimetools_installed)
|| ($result->faultstring || '') =~ /Failed to access class \(Calculator\)/;
#print $result->faultstring;
#print "SKIP\n";
}
eval $package or die;
SKIP: for (reverse sort keys %tests) {
my $result = SOAP::Deserializer->deserialize($server->handle($tests{$_}));
if ($_ =~m/XML/ || !$is_mimetools_installed) {
skip(1, 'skip');
next SKIP;
}
ok (($result->result || 0) == 7);
}
}
{
print "Server handler with complex dispatches test(s)...\n";
foreach my $server (
# dispatch to class
SOAP::Server->dispatch_to('Calculator'),
# dispatch to object
SOAP::Server->dispatch_to(Calculator->new),
# dispatch to regexp
SOAP::Server->dispatch_to('Calc\w+'),
# dispatch URI to class
SOAP::Server->dispatch_with({'http://www.soaplite.com/Calculator' => 'Calculator'}),
# dispatch URI to object
SOAP::Server->dispatch_with({'http://www.soaplite.com/Calculator' => Calculator->new}),
# dispatch quoted SOAPAction to class
SOAP::Server->action('"http://action/#method"')
->dispatch_with({'http://action/#method' => 'Calculator'}),
# dispatch non-quoted SOAPAction to class
SOAP::Server->action('http://action/#method')
->dispatch_with({'http://action/#method' => 'Calculator'}),
# dispatch to class and BAD regexp.
SOAP::Server->dispatch_to('\protocols', 'Calculator')
) { # end for
my $result = SOAP::Deserializer->deserialize($server->handle($tests{'XML only'}));
my $value = $result->result;
use Data::Dumper; print Dumper $value;
ok($value + 0 == 7);
}
}
{
print "Error handling in server test(s)...\n";
$a = SOAP::Server->handle('');
ok($a =~ /Can't find root/);
$a = SOAP::Server->handle('');
ok($a =~ /Can't find method/);
$a = SOAP::Server->handle('11');
ok($a =~m{Denied \s access \s to \s method}x);
$a = SOAP::Server->handle('');
ok($a =~ /Can't find method/);
}
{
print "Envelope with no namespaces test(s)...\n";
eval 'sub add { $_[1] + $_[2] }; 1' or die;
my $result = SOAP::Deserializer->deserialize(SOAP::Server->dispatch_to('add')->handle('34'));
ok(($result->result || 0) == 7);
}
{
print "Different XML Schemas test(s)...\n";
my $server = SOAP::Server->dispatch_to('Calculator');
$a = $server->handle('');
ok($a =~ m!xsi="http://www.w3.org/2001/XMLSchema-instance"!);
ok($a =~ m!xsd="http://www.w3.org/2001/XMLSchema"!);
ok($a =~ m!>http://www.w3.org/2001/XMLSchemahandle('2');
ok($a =~ m!xsi="http://www.w3.org/2001/XMLSchema-instance"!);
ok($a =~ m!xsd="http://www.w3.org/2001/XMLSchema"!);
ok($a =~ m!>http://www.w3.org/2001/XMLSchemahandle('2');
ok($a =~ m!xsi="http://www.w3.org/2001/XMLSchema-instance"!);
ok($a =~ m!xsd="http://www.w3.org/2001/XMLSchema"!);
ok($a =~ m!>http://www.w3.org/2001/XMLSchemanew->initialize_parser; 1 };
if ($@) {
$@ =~ s/ at .+//;
print "1..0 # Skip: $@"; exit;
}
}
BEGIN { plan tests => 15 }
my($a, $soap, $d, $s, $r, $serialized, $deserialized);
{ # check attachment deserialization
$soap = SOAP::Lite->new();
$soap->init_context();
##############################################################################
print "Attachment deserialization (Content-ID) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
SOAPAction: http://schemas.risky-stuff.com/Auto-Claim
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: base64
Content-ID:
AAECAyAgIAQFBg==
--MIME_boundary
Content-Type: image/jpeg
Content-Transfer-Encoding: binary
Content-ID:
...Raw JPEG image..
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary
Content-Type: text/xml
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary--
EOX
ok(ref $a);
ok(ref $a && ref $a->valueof('//insurance_claim_auto') &&
$a->valueof('//insurance_claim_auto')->{theCrashPhoto} =~ /JPEG/);
ok(ref $a && $a->valueof('//theCrashPhoto') =~ /Raw JPEG image/);
ok(ref $a && $a->valueof('//theSignedForm') eq "\0\1\2\3 \4\5\6");
ok(ref $a && $a->valueof('//somexml') =~ m!c!);
ok(ref $a && $a->valueof('//realxml')->{b} eq 'c');
##############################################################################
print "Attachment deserialization (Content-ID and Content-Location) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
MIME-Version: 1.0
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
Content-Location: http://claiming-it.com/claim061400a.xml
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: binary
Content-ID:
Content-Location: http://claiming-it.com/claim061400a.tiff
...binary TIFF image...
--MIME_boundary--
EOX
ok(ref $a);
ok(ref $a && ref $a->valueof('//insurance_claim_auto') &&
$a->valueof('//insurance_claim_auto')->{theSignedForm} =~ /TIFF/);
ok(ref $a && $a->valueof('//theSignedForm') =~ /binary TIFF image/);
##############################################################################
print "Attachment deserialization (relative Content-Location) test(s)...\n";
# TODO - this unit test breaks - it does not seem to be picking up a base location
# from outer Content-Location
eval { $a = $soap->deserializer->deserialize(<<'EOX'); };
MIME-Version: 1.0
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
Content-Description: This is the optional message description.
Content-Location: http://claiming-it.com/
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
Content-Location: claim061400a.xml
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: binary
Content-Id:
Content-Location: claim061400a.tiff
...binary TIFF image...
--MIME_boundary--
EOX
ok(ref $a);
ok(ref $a && ref $a->valueof('//insurance_claim_auto') &&
$a->valueof('//insurance_claim_auto')->{theSignedForm} =~ /TIFF/);
ok(ref $a && $a->valueof('//theSignedForm') =~ /binary TIFF image/);
##############################################################################
print "Attachment deserialization (no default Content-Location) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
MIME-Version: 1.0
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
Content-Location: claim061400a.xml
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: binary
Content-ID:
Content-Location: the_signed_form.tiff
...binary TIFF image...
--MIME_boundary-
EOX
#
ok(ref $a);
ok(ref $a && ref $a->valueof('//insurance_claim_auto') &&
$a->valueof('//insurance_claim_auto')->{theSignedForm} =~ /TIFF/);
ok(ref $a && $a->valueof('//theSignedForm') =~ /binary TIFF image/);
} SOAP-Lite-1.09/t/04-attach.t 000644 000766 000024 00000022416 12156373142 016366 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless ( grep /blib/, @INC ) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
BEGIN {
use SOAP::Lite;
eval { SOAP::Packager::MIME->new->initialize_parser; 1 };
if ($@) {
$@ =~ s/ at .+//;
print "1..0 # Skip: $@";
exit;
}
}
BEGIN { plan tests => 18 }
my ( $a, $soap, $d, $s, $r, $serialized, $deserialized );
{ # check attachment deserialization
$soap = SOAP::Lite->new();
$soap->init_context();
##############################################################################
print "Attachment deserialization (Content-ID) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
SOAPAction: http://schemas.risky-stuff.com/Auto-Claim
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: base64
Content-ID:
AAECAyAgIAQFBg==
--MIME_boundary
Content-Type: image/jpeg
Content-Transfer-Encoding: binary
Content-ID:
...Raw JPEG image..
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary
Content-Type: text/xml
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary--
EOX
ok( ref $a );
ok( ref $a
&& ref $a->valueof('//insurance_claim_auto')
&& $a->valueof('//insurance_claim_auto')->{theCrashPhoto} =~ /JPEG/ );
ok( ref $a && $a->valueof('//theCrashPhoto') =~ /Raw JPEG image/ );
ok( ref $a && $a->valueof('//theSignedForm') eq "\0\1\2\3 \4\5\6" );
ok( ref $a && $a->valueof('//somexml') =~ m!c! );
ok( ref $a && $a->valueof('//realxml')->{b} eq 'c' );
##############################################################################
print
"Attachment deserialization (Content-ID and Content-Location) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
MIME-Version: 1.0
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
Content-Location: http://claiming-it.com/claim061400a.xml
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: binary
Content-ID:
Content-Location: http://claiming-it.com/claim061400a.tiff
...binary TIFF image...
--MIME_boundary--
EOX
ok( ref $a );
ok( ref $a
&& ref $a->valueof('//insurance_claim_auto')
&& $a->valueof('//insurance_claim_auto')->{theSignedForm} =~ /TIFF/ );
ok( ref $a && $a->valueof('//theSignedForm') =~ /binary TIFF image/ );
##############################################################################
print "Attachment deserialization (relative Content-Location) test(s)...\n";
# TODO - this unit test breaks - it does not seem to be picking up a base location
# from outer Content-Location
eval {
$a = $soap->deserializer->deserialize(<<'EOX'); };
MIME-Version: 1.0
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
Content-Description: This is the optional message description.
Content-Location: http://claiming-it.com/
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
Content-Location: claim061400a.xml
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: binary
Content-Id:
Content-Location: claim061400a.tiff
...binary TIFF image...
--MIME_boundary--
EOX
ok( ref $a );
ok( ref $a
&& ref $a->valueof('//insurance_claim_auto')
&& $a->valueof('//insurance_claim_auto')->{theSignedForm} =~ /TIFF/ );
ok( ref $a && $a->valueof('//theSignedForm') =~ /binary TIFF image/ );
##############################################################################
print
"Attachment deserialization (no default Content-Location) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
MIME-Version: 1.0
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
Content-Location: claim061400a.xml
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: binary
Content-ID:
Content-Location: the_signed_form.tiff
...binary TIFF image...
--MIME_boundary-
EOX
#
ok( ref $a );
ok( ref $a
&& ref $a->valueof('//insurance_claim_auto')
&& $a->valueof('//insurance_claim_auto')->{theSignedForm} =~ /TIFF/ );
ok( ref $a && $a->valueof('//theSignedForm') =~ /binary TIFF image/ );
# check attachment of composite element
$soap = SOAP::Lite->new();
$soap->init_context();
##############################################################################
print "Attachment deserialization (Nested Attachment) test(s)...\n";
$a = $soap->deserializer->deserialize(<<'EOX');
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
SOAPAction: http://schemas.risky-stuff.com/Auto-Claim
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
--MIME_boundary
Content-Type: message/rfc822
Content-Transfer-Encoding: binary
Content-ID:
MIME-Version: 1.0
X-Mailer: MIME::Lite 3.01 (F2.74; T1.24; A1.74; B3.07; Q3.07)
Date: Thu, 30 Apr 2009 15:59:49 -0400
To: foo@bar.com
Subject: multipart message
Content-Transfer-Encoding: binary
Content-Type: multipart/related; boundary="_----------=_1241121589160890"
This is a multi-part message in MIME format.
--_----------=_1241121589160890
Content-Disposition: inline
Content-Length: 36
Content-Transfer-Encoding: binary
Content-Type: text/html
Here's my text
--_----------=_1241121589160890
Content-Disposition: inline
Content-Length: 16
Content-Transfer-Encoding: binary
Content-Type: text/plain
Here's my text
--_----------=_1241121589160890--
--MIME_boundary--
EOX
ok( ref $a );
ok( ref $a
&& ref $a->valueof('//insurance_claim_auto')
&& $a->valueof('//insurance_claim_auto')->{email} =~
m{my()? text} );
ok( ref $a && $a->valueof('//email') =~ m{my()? text} );
}
SOAP-Lite-1.09/t/05-customxml.t 000644 000766 000024 00000014022 12156373142 017150 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
use SOAP::Lite;
plan tests => 40;
my($a, $s, $r, $serialized, $deserialized);
$deserialized = SOAP::Custom::XML::Deserializer
-> deserialize(join '', );
ok(ref $deserialized);
$r = $deserialized->valueof('/Envelope/Body');
ok(ref $r);
my @portfolios = $r->Report->Request->Composition->PortfolioDistribution;
ok(@portfolios == 6);
foreach my $portfolio (@portfolios) {
# test attributes
print $portfolio->type, " ", $portfolio->date, "\n";
ok($portfolio->type && $portfolio->date);
foreach my $row ($portfolio->Row) {
# test elements
print " ", $row->Element, " ", $row->Value, "\n";
ok($row->Element && $row->Value);
}
}
__DATA__
61744J366Returned no data for request: PortfolioDistributionReturned no data for request: PortfolioDistributionReturned no data for request: PortfolioDistributionReturned no data for request: PortfolioDistributionCould not retrieve PortfolioDistributionCould not retrieve PortfolioDistributionCould not retrieve PortfolioDistributionCould not retrieve PortfolioDistributionCommon Stocks0.9991Other0.0021Cash & Cash Equivalents-0.0012General Electric Company0.0458Cisco Systems Inc0.033Microsoft Corporation0.0263Exxon Mobil Corp.0.0263Pfizer, Inc.0.0231Intel Corporation0.0209Citigroup Inc0.02Emc Corp.0.0185American International Group, Inc.0.0181Oracle Corporation0.0172Pharmaceuticals0.0941Communications Equipment0.0857Computers & Peripherals0.0764Diversified Financials0.0724Industrial Conglomerates0.0581Diversified Telecommunication Services0.058Software0.056Other0.5002Cash & Cash Equivalents-0.0012Information Technology0.2964Financials0.154Health Care0.1265Consumer Discretionary0.1026Industrials0.0874Telecommunication Services0.0632Consumer Staples0.0575Other0.1136Cash & Cash Equivalents-0.0012
SOAP-Lite-1.09/t/06-modules.t 000644 000766 000024 00000002071 12156373142 016567 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test::More qw(no_plan);
my @modules = qw(SOAP::Lite
SOAP::Transport::HTTP
SOAP::Transport::MAILTO
SOAP::Transport::FTP
SOAP::Transport::TCP
SOAP::Transport::IO
SOAP::Transport::LOCAL
SOAP::Transport::POP3
XML::Parser::Lite
UDDI::Lite XMLRPC::Lite
XMLRPC::Transport::HTTP
XMLRPC::Transport::TCP
XMLRPC::Transport::POP3
SOAP::Packager
SOAP::Transport::MQ SOAP::Transport::JABBER
);
foreach (@modules) {
eval "require $_";
if ($@ =~ /(Can\'t locate)|(XML::Parser::Lite requires)|(this is only version)|(load mod_perl)/) {
SKIP: {
skip("Module $_ does not exist or is breaking in an expected way", 1);
}
next;
}
is($@, '', "use $_") or warn $@;
} SOAP-Lite-1.09/t/08-schema.t 000644 000766 000024 00000013562 12156373142 016370 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
BEGIN { plan tests => 47 }
use SOAP::Lite;
my($a, $s, $r, $serialized, $deserialized);
{ # check deserialization of envelope with result
print "Deserialization of envelope with result test(s)...\n";
$deserialized = SOAP::Deserializer->deserialize('
204060100200
');
ok($deserialized->result->[2] == 60);
ok((my @array = $deserialized->paramsall) == 1);
ok(ref $deserialized->body eq 'HASH'); # not blessed anymore since 0.51
}
{
print "hex encoding test(s)...\n";
$a = "\0 {a}\1";
$serialized = SOAP::Serializer->serialize(SOAP::Data->type(hex => $a));
ok($serialized =~ />00207B617D01deserialize($serialized)->root eq $a);
}
{
print "Deserialization of 1999/2001 schemas test(s)...\n";
foreach (split "\n", <12
121212121212
EOX
$deserialized = SOAP::Deserializer->deserialize($_);
ok($deserialized->root == 12);
}
eval { SOAP::Deserializer->deserialize('12') };
ok($@ =~ m!Unrecognized type '\{http://www.w3.org/1999/XMLSchema\}something'!);
eval { SOAP::Deserializer->deserialize('12') };
ok($@ =~ m!Unrecognized type '\{http://some.thing.else/XMLSchema\}something'!);
foreach (qw(base64Binary hexBinary anyType anySimpleType
gMonth gYearMonth gYear gMonthDay gDay duration anyURI dateTime)) {
eval { SOAP::Deserializer->deserialize(qq!12!) };
ok($@ =~ m!Unrecognized type '\{http://www.w3.org/1999/XMLSchema\}$_'!);
}
ok(SOAP::Deserializer->deserialize(qq!true!)->root eq '1');
eval { SOAP::Deserializer->deserialize(qq!something!) };
ok($@ =~ m!Wrong boolean value!);
ok(SOAP::Deserializer->deserialize(qq!true!)->root eq '1');
ok(SOAP::Deserializer->deserialize(qq!1!)->root eq '1');
ok(SOAP::Deserializer->deserialize(qq!false!)->root eq '0');
ok(SOAP::Deserializer->deserialize(qq!0!)->root eq '0');
foreach (qw(ur-type base64 hex
timeDuration uriReference timeInstant month year recurringDate recurringDay)) {
eval { SOAP::Deserializer->deserialize(qq!12!) };
ok($@ =~ m!Unrecognized type '\{http://www.w3.org/2001/XMLSchema\}$_'!);
}
eval { SOAP::Deserializer->deserialize(qq!something!) };
ok($@ =~ m!Wrong boolean value!);
ok(SOAP::Deserializer->deserialize(qq!true!)->root eq '1');
ok(SOAP::Deserializer->deserialize(qq!1!)->root eq '1');
ok(SOAP::Deserializer->deserialize(qq!false!)->root eq '0');
ok(SOAP::Deserializer->deserialize(qq!0!)->root eq '0');
}
SOAP-Lite-1.09/t/096_characters.t 000644 000766 000024 00000003717 12156373142 017421 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use strict;
BEGIN {
if ( not $ENV{TEST_AUTHOR} ) {
my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
print "1..0
# $msg";
exit 0;
}
require Test::More;
Test::More->import();
}
use File::Find;
use IO::File;
if ( not $ENV{TEST_AUTHOR} ) {
my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
plan( skip_all => $msg );
}
my @skip = (
qr(\.svn)
);
my $dir = 'blib/lib';
if (-d '../t') {
$dir = '../lib';
}
my @filelist = ();
find( \&filelist, $dir);
sub filelist {
my $name = $_;
return if (-d $name);
return if $File::Find::name =~m{\.svn}x;
push @filelist, $File::Find::name;
}
plan( tests => scalar @filelist);
for my $file (sort @filelist) {
check_file($file);
}
sub check_file {
my $file = shift;
my $fh = IO::File->new($file, O_RDONLY) or die "Cannot open $file";
my $line_nr = 0;
my $error_count = 0;
while (my $line = $fh->getline() ) {
# check for trailing whitespace
# allow single whitespace on line to allow
# pod source blocks with empty lines
#
$line_nr++;
if ($line =~m{ (:?[^\s]+|\s)\s\r?\n$ }x) {
$error_count++;
print "# trailing whitespace in $file line $line_nr at end of line\n"
}
# check for tabs and report their position
my @tab_pos_from = ();
my $pos = -1;
while (1) {
$pos = index($line, "\t", $pos + 1);
last if $pos <0;
push @tab_pos_from, $pos + 1;
}
if (@tab_pos_from) {
print "# tab found in $file line $line_nr cols ${ \join(', ', @tab_pos_from) }\n";
$error_count += scalar(@tab_pos_from);
}
if ($line=~m{\r}) {
print "# CR (\\r) found in $file line $line_nr. Convert to LF only.\n";
$error_count++;
}
}
is $error_count, 0 , "$file characters";
} SOAP-Lite-1.09/t/097_kwalitee.t 000644 000766 000024 00000001023 12156373142 017074 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use strict;
use warnings;
if ( not $ENV{TEST_AUTHOR} ) {
my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
print "1..0
# $msg";
exit 0;
}
require Test::More;
Test::More->import();
if ( not $ENV{TEST_AUTHOR} ) {
my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
plan( skip_all => $msg );
}
chdir '..' if -d ('../t');
eval 'use Test::Kwalitee';
if ( $@ ) {
my $msg = 'Test::Kwalitee not installed; skipping';
plan( skip_all => $msg );
}
SOAP-Lite-1.09/t/098_pod.t 000644 000766 000024 00000001236 12156373142 016060 0 ustar 00fredmoyer staff 000000 000000 use strict;
if ( not $ENV{TEST_AUTHOR} ) {
my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
print "1..0
# $msg";
exit 0;
}
require Test::More;
Test::More->import();
eval "use Test::Pod 1.00";
if ($@) {
print "# Test::Pod 1.00 required for testing POD";
plan(tests => 0);
exit 0;
}
my @directories;
# perl Build test or make test run from top-level dir.
if ( -d '../t/' ) {
@directories = ('../lib/', '../bin');
}
else {
@directories = (); # empty - will work automatically
}
my @files = all_pod_files(@directories);
plan(tests => scalar(@files) );
foreach my $module (@files){
pod_file_ok( $module )
} SOAP-Lite-1.09/t/099_pod_coverage.t 000644 000766 000024 00000001443 12156373142 017734 0 ustar 00fredmoyer staff 000000 000000 use strict;
if ( not $ENV{TEST_AUTHOR} ) {
my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
print "1..0
# $msg";
exit 0;
}
require Test::More;
Test::More->import();
eval "use Test::Pod::Coverage 1.00";
plan( skip_all => "Test::Pod::Coverage 1.00 required for testing POD") if $@;
my @dirs = ( 'lib' );
if (-d '../t/') { # we are inside t/
@dirs = ('../lib');
}
else { # we are outside t/
# add ./lib to include path if blib/lib is not there (e.g. we're not
# run from Build test or the like)
push @INC, './lib' if not grep { $_ eq 'blib/lib' } @INC;
}
my @files = all_modules( @dirs );
plan( tests => scalar @files);
foreach (@files) {
pod_coverage_ok( $_ ,
{
private => [
qr/^_/,
]
});
} SOAP-Lite-1.09/t/11-cgi.t 000644 000766 000024 00000000340 12156373142 015652 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use SOAP::Test;
SOAP::Test::Server::run_for(shift || 'http://localhost/cgi-bin/soap.cgi');
SOAP-Lite-1.09/t/12-cgi_https.t 000644 000766 000024 00000000341 12156373142 017076 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use SOAP::Test;
SOAP::Test::Server::run_for(shift || 'https://localhost/cgi-bin/soap.cgi');
SOAP-Lite-1.09/t/13-mod_perl.t 000644 000766 000024 00000000322 12156373142 016713 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use SOAP::Test;
SOAP::Test::Server::run_for(shift || 'http://localhost/soap'); SOAP-Lite-1.09/t/14-cgi_apache.t 000644 000766 000024 00000000345 12156373142 017163 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use SOAP::Test;
SOAP::Test::Server::run_for(shift || 'http://localhost/mod_perl/soap.mod_cgi');
SOAP-Lite-1.09/t/15-daemon.t 000644 000766 000024 00000000320 12156373142 016355 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use SOAP::Test;
SOAP::Test::Server::run_for(shift || 'http://localhost/');
SOAP-Lite-1.09/t/17-mod_soap.t 000644 000766 000024 00000000330 12156373142 016716 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use SOAP::Test;
SOAP::Test::Server::run_for(shift || 'http://localhost/mod_soap');
SOAP-Lite-1.09/t/19-apachesoap.t 000644 000766 000024 00000002433 12156373142 017231 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
ref $res ? warn(join "\n", "--- SOAP FAULT ---", $res->faultcode, $res->faultstring, '')
: warn(join "\n", "--- TRANSPORT ERROR ---", $soap->transport->status, '');
return new SOAP::SOM;
}
;
my($a, $s, $r, $serialized, $deserialized);
my $proxy = 'http://localhost:8080/soap/servlet/rpcrouter';
# ------------------------------------------------------
use SOAP::Test;
$s = SOAP::Lite->uri('http://something/somewhere')->proxy($proxy)->on_fault(sub{});
eval { $s->transport->timeout($SOAP::Test::TIMEOUT = $SOAP::Test::TIMEOUT) };
$r = $s->test_connection;
unless (defined $r && defined $r->envelope) {
print "1..0 # Skip: ", $s->transport->status, "\n";
exit;
}
# ------------------------------------------------------
plan tests => 2;
{
# Local server with Apache SOAP (http://xml.apache.org/soap)
print "Apache SOAP server test(s)...\n";
$s = SOAP::Lite
-> uri('urn:xmltoday-delayed-quotes')
-> proxy($proxy)
;
ok($s->getQuote('MSFT')->result > 0);
ok($s->getQuote(SOAP::Data->name(symbol => 'MSFT'))->result > 0);
}
SOAP-Lite-1.09/t/21-public.t 000644 000766 000024 00000023724 12156373142 016402 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
ref $res
? warn(join " ", "SOAP FAULT:", $res->faultstring, "\n")
: warn(join " ", "TRANSPORT ERROR:", $soap->transport->status, "\n");
return new SOAP::SOM;
};
$SOAP::Constants::DO_NOT_USE_CHARSET = 1;
my($a, $s, $r, $serialized, $deserialized);
# ------------------------------------------------------
use SOAP::Test;
$s = SOAP::Lite->uri('http://something/somewhere')->proxy('http://services.xmethods.net/soap/servlet/rpcrouter')->on_fault(sub{});
eval {
$s->transport->timeout($SOAP::Test::TIMEOUT = $SOAP::Test::TIMEOUT)
};
$r = $s->test_connection;
unless (defined $r && defined $r->envelope) {
print "1..0 # Skip: ", $s->transport->status, "\n";
exit;
}
# ------------------------------------------------------
plan tests => 21;
{
# Public test server with Frontier implementation (http://soap.weblogs.com/)
print "Frontier server test(s)...\n";
$s = SOAP::Lite
-> uri('/examples')
-> on_action(sub { sprintf '"%s"', @_ })
-> proxy('http://superhonker.userland.com/', timeout => $SOAP::Test::TIMEOUT);
ok($s->getCurrentTime()->result);
ok($s->getStateName(SOAP::Data->name(statenum => 1))->result eq 'Alabama');
print "SOAP::Lite server test(s)...\n";
$s = SOAP::Lite
-> uri('http://www.soaplite.com/My/Examples')
-> proxy('http://services.soaplite.com/examples.cgi', timeout => $SOAP::Test::TIMEOUT);
ok($s->getStateNames(1,4,6,13)->result =~ /^Alabama\s+Arkansas\s+Colorado\s+Illinois\s*$/);
$r = $s->getStateList([1,2,3,4])->result;
ok(ref $r && $r->[0] eq 'Alabama');
$r = $s->getStateStruct(SOAP::Data->type(ordered_hash => [item1 => 1, item2 => 4]))->result;
ok(ref $r && $r->{item2} eq 'Arkansas');
# Public test server with COM implementation (http://www.zaks.demon.co.uk/com/4s4c/)
print "COM server test(s)...\n";
$s = SOAP::Lite
-> uri('http://simon.fell.com/calc')
-> proxy('http://soap.4s4c.com/ssss4c/soap.asp', timeout => $SOAP::Test::TIMEOUT)
;
beta
$r = $s->doubler(name SOAP::Data nums => [10,20,30,50,100])->result;
ok(ref $r && $r->[1] == 40);
# Real server with ASP implementation (http://www.soap-wrc.com/webservices/)
print "ASP server test(s)...\n";
$s = SOAP::Lite
-> uri('www.soap-wrc.com')
-> proxy('http://www.soap-wrc.com/webservices/soapv11.asp', timeout => $SOAP::Test::TIMEOUT)
-> on_fault(sub{ref$_[1]?return$_[1]:return});
import SOAP::Data 'name'; # no import by default
$r = $s->addResource(
name(Login => 'login'),
name(Password => 'password'),
name(Caption => 'caption'),
name(Description => 'description'),
name(URL => 'http://yahoo.com'),
);
ok(ref $r && $r->faultcode eq 'SOAP-ENV:Client');
# Password should be wrong. Put yours if you have it.
# Remember: this is the real server
if (0) { # doesn't seem to be working on 2001/01/31
print "DevelopMentor's Perl server test(s)...\n";
ok((SOAP::Lite
-> uri('urn:soap-perl-test')
-> proxy('http://soapl.develop.com/soap?class=SPTest', timeout => $SOAP::Test::TIMEOUT)
-> add(SOAP::Data->name(a => 3), SOAP::Data->name(b => 4))
-> result or 0) == 7);beta
}
# Public server with Microsoft implementation (http://search.microsoft.com/search/MSComSearchService.asmx)
print "Microsoft's server test(s)...\n";
ok((SOAP::Lite
-> uri('http://tempuri.org/')
-> proxy('http://search.microsoft.com/search/MSComSearchService.asmx', timeout => $SOAP::Test::TIMEOUT)
-> on_action(sub{join'',@_})
-> GetVocabulary(SOAP::Data->name(Query => 'something_very_unusual')->uri('http://tempuri.org/'))
-> valueof('//Found') || '') eq 'false');
$r = SOAP::Lite
-> uri('http://tempuri.org/')
-> proxy('http://search.microsoft.com/search/MSComSearchService.asmx', timeout => $SOAP::Test::TIMEOUT)
-> on_action(sub{join'',@_})
-> GetBestBets(SOAP::Data->name(Query => 'data')->uri('http://tempuri.org/'))
-> result;
ok(ref $r && $r->{VocabularyLastcache} =~ /T/);
# Public server with 4s4c implementation (http://www.pocketsoap.com/4s4c/)
print "4s4c (aka Simon's SOAP Server Services For COM) server test(s)...\n";
$s = SOAP::Lite
-> uri('http://www.pocketsoap.com/whois')
-> proxy('http://soap.4s4c.com/whois/soap.asp', timeout => $SOAP::Test::TIMEOUT)
-> whois(SOAP::Data->name('name' => 'yahoo'));
$r = $s->result || '';
ok($r =~ /YAHOO/);
# Public server with MS SOAP implementation (http://www.itfinity.net/soap/guid/details.html)
print "MS SOAP (on itfinity.net) server test(s)...\n";
ok((SOAP::Lite
-> uri('http://www.itfinity.net/soap/guid/guid.xsd')
-> proxy('http://www.itfinity.net/soap/guid/default.asp', timeout => $SOAP::Test::TIMEOUT)
-> NextGUID
-> result or '') =~ /.{8}-.{4}-.{4}-.{4}-.{12}/);
# Public server with Apache implementation (http://www.lemurlabs.com/projects/soap/itime/index.jsp)
print "Apache SOAP (on lemurlabs.com) server test(s)...\n";
ok((SOAP::Lite
-> uri('urn:lemurlabs-ITimeService')
-> proxy('http://www.lemurlabs.com/rpcrouter', timeout => $SOAP::Test::TIMEOUT)
-> getInternetTime
-> result or '') =~ /\d/);
ok(@{SOAP::Lite
-> uri('urn:lemurlabs-Fortune')
-> proxy('http://www.lemurlabs.com/rpcrouter', timeout => $SOAP::Test::TIMEOUT)
-> getDictionaryNameList #getAnyFortune
-> result or []} > 1);
$r = (SOAP::Lite
-> uri('urn:lemurlabs-Fortune')
-> proxy('http://www.lemurlabs.com/rpcrouter', timeout => $SOAP::Test::TIMEOUT)
-> getFortuneByDictionary('work')
-> result) || '';
ok($r && ref($r = SOAP::Deserializer->deserialize($r)) && ($r = $r->valueof('//fortune') || ''));
print $r ? "Your fortune cookie:\n$r\n" : "No fortune cookies for you today\n\n";
if (0) { # seems to be down as of 2001/04/18
# Public server with Lucin implementation (http://www.lucin.com/lu003/sal.htm)
print "Lucin SOAP (lucin.com) server test(s)...\n";
$r = (SOAP::Lite
-> proxy('http://srv.lucin.net/bin/SOAP002.asp', timeout => $SOAP::Test::TIMEOUT)
-> uri('http://schema.soapranch.com/salACC/CAddress.xml')
-> Ping(SOAP::Data->new(name => 'ApplicID', type => 'xsd:long', value => 1001))
-> result) || '';
ok($r && $r =~ /^OKO/);
}
# Public server with SOAP::Lite/ApacheSOAP implementations (http://www.xmethods.net/)
print "XMethods (SOAP::Lite/ApacheSOAP) server test(s)...\n";
print "All connections are keep-alive\n";
$s = SOAP::Lite
-> uri('urn:xmethods-BNPriceCheck')
-> proxy('http://services.xmethods.net/soap/servlet/rpcrouter', timeout => $SOAP::Test::TIMEOUT);
my $isbn = '0672319225';
$r = ($s->getPrice(SOAP::Data->type(string => $isbn))->result) || 0;
print "Price for ISBN$isbn is \$$r\n";
ok($r > 20 && $r < 60);
$s = SOAP::Lite
-> uri('urn:xmethods-CurrencyExchange')
-> proxy('http://services.xmethods.net/soap', timeout => $SOAP::Test::TIMEOUT);
$r = ($s->getRate(SOAP::Data->name(country1 => 'England'),
SOAP::Data->name(country2 => 'Japan'))
->result) || 0;
print "Currency rate for England/Japan is $r\n";
ok($r > 1);
$s = SOAP::Lite
-> uri('urn:xmethods-delayed-quotes')
-> proxy('http://services.xmethods.net/soap', timeout => $SOAP::Test::TIMEOUT);
$r = ($s->getQuote('MSFT')->result) || 0;
print "Quote for MSFT symbol is $r\n";
ok($r > 1);
if (0) { # should work, but server wasn't ready as of 2001/04/18
$s = SOAP::Lite
-> uri('urn:xmethods-delayed-quotes')
-> proxy('https://services.xmethods.net/soap', timeout => $SOAP::Test::TIMEOUT);
$r = ($s->getQuote('MSFT')->result) || 0;
print "Quote for MSFT symbol from secure server is $r\n";
ok($r > 1);
}
ok((SOAP::Lite
-> uri('urn:xmethods-DomainChecker')
-> proxy('http://services.xmethods.net/soap', timeout => $SOAP::Test::TIMEOUT)
-> checkDomain('yahoo.com')
-> result or '') eq 'unavailable');
ok((SOAP::Lite
-> uri('urn:xmethods-CATraffic')
-> proxy('http://services.xmethods.net/soap/servlet/rpcrouter', timeout => $SOAP::Test::TIMEOUT)
-> getTraffic(type SOAP::Data string => 101)
-> result or '') =~ /reported/);
ok((SOAP::Lite
-> uri('urn:xmethods-Temperature')
-> proxy('http://services.xmethods.net/soap/servlet/rpcrouter', timeout => $SOAP::Test::TIMEOUT)
-> getTemp(type SOAP::Data string => 64151)
-> result or '') =~ /\./);
if (0) { # Tony brought it down as of 2001/06/11
ok((SOAP::Lite
-> uri('urn:xmethodsSoapPing')
-> proxy('http://services.xmethods.net/perl/soaplite.cgi', timeout => $SOAP::Test::TIMEOUT)
-> pingHost(name SOAP::Data hostname => 'www.yahoo.com')
-> result or 0) == 1);
skip 'xmethods is unavailable', 1;
print "BabelFish translator server test(s)...\n";
ok((SOAP::Lite
-> uri('urn:xmethodsBabelFish')
-> proxy('http://services.xmethods.net/perl/soaplite.cgi', timeout => $SOAP::Test::TIMEOUT)
-> BabelFish(SOAP::Data->name(translationmode => 'en_it'),
SOAP::Data->name(sourcedata => 'I want to work'))
-> result or '') =~ /^Desidero lavorare$/);
}
}
if (0) { # Kafka response has xsi:type="string" response which is invalid
print "Kafka (http://www.vbxml.com/soapworkshop/utilities/kafka/) server test(s)...\n";
ok((SOAP::Lite
-> service('http://www.vbxml.com/soapworkshop/services/id/id.xml')
-> GetSecretIdentity('Superman') or '') eq 'Clark Kent');
}
SOAP-Lite-1.09/t/22-interop_apache.t 000644 000766 000024 00000007477 12156373142 020115 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
ref $res ? warn(join " ", "SOAP FAULT:", $res->faultstring, "\n")
: warn(join " ", "TRANSPORT ERROR:", $soap->transport->status, "\n");
return new SOAP::SOM;
}
;
my($a, $s, $r);
# updated on 2001/08/17
# http://services.xmethods.net:80/soap/servlet/rpcrouter
my $proxy = 'http://nagoya.apache.org:5049/axis/servlet/AxisServlet';
# ------------------------------------------------------
use SOAP::Test;
$s = SOAP::Lite->uri('http://something/somewhere')->proxy($proxy)->on_fault(sub{});
eval { $s->transport->timeout($SOAP::Test::TIMEOUT = $SOAP::Test::TIMEOUT) };
$r = $s->test_connection;
unless (defined $r && defined $r->envelope) {
print "1..0 # Skip: ", $s->transport->status, "\n";
exit;
}
# ------------------------------------------------------
plan tests => 15;
{
# XMethod's JavaSOAP server (http://xmethods.net/detail.html?id=11)
print "XMethod's JavaSOAP server test(s)...\n";
$s = SOAP::Lite
-> uri('http://soapinterop.org/')
-> proxy($proxy)
;
$a = 'SOAP::Lite';
$r = $s->echoString($a)->result;
ok($r eq $a);
$a = ['a', 'b'];
$r = $s->echoStringArray($a)->result;
ok(ref $r && join('', @$r) eq join('', @$a));
$a = 11;
$r = $s->echoInteger($a)->result;
ok($r == $a);
$a = [1, 3, 5];
$r = $s->echoIntegerArray($a)->result;
ok(ref $r && join('', @$r) == join('', @$a));
$a = 11.02;
$r = $s->echoFloat($a)->result;
ok($r == $a);
$a = [1.1, 3.3, 5.5];
$r = $s->echoFloatArray($a)->result;
ok(ref $r && join('', @$r) eq join('', @$a));
# you may specify URI manually (but see maptype() below)
$a = {varString => 'b', varInt => 2, varFloat => 95.7};
$r = $s->echoStruct(
SOAP::Data->type('xx:SOAPStruct' => $a)
->attr({'xmlns:xx' => 'http://soapinterop.org/xsd'})
)->result;
ok(ref $r && join('', sort values %$r) eq join('', sort values %$a));
# specify mapping to URI
$s->maptype({SOAPStruct => 'http://soapinterop.org/xsd'});
$a = {varString => 'b', varInt => 2, varFloat => 95.7};
$r = $s->echoStruct($a)->result;
ok(ref $r && join('', sort values %$r) eq join('', sort values %$a));
$a = {varString => 'b', varInt => 2, varFloat => 95.7};
$r = $s->echoStruct(SOAP::Data->name(something => $a))->result;
ok(ref $r && join('', sort values %$r) eq join('', sort values %$a));
$a = [
{varString => 'b', varInt => 2, varFloat => 95.7},
{varString => 'c', varInt => 3, varFloat => 85.7},
{varString => 'd', varInt => 4, varFloat => 75.7},
];
$r = $s->echoStructArray($a)->result;
ok(ref $r && join('', map { sort values %$_ } @$r) eq join('', map { sort values %$_ } @$a));
$a = [
{varString => 'b', varInt => 2, varFloat => 95.7},
{varString => 'c', varInt => 3, varFloat => 85.7},
{varString => 'd', varInt => 4, varFloat => 75.7},
];
$r = $s->echoStructArray(SOAP::Data->name(something => $a))->result;
ok(ref $r && join('', map { sort values %$_ } @$r) eq join('', map { sort values %$_ } @$a));
my $key = "\0\1";
my $value = 456;
{ local $^W;
# implicit, warning with -w
$a = $s->echoMap({a => 123, $key => $value})->result;
ok($a->{$key} == $value);
}
# explicit
$a = $s->echoMap(SOAP::Data->type(map => {a => 123, $key => $value}))->result;
ok($a->{$key} == $value);
{ local $^W;
# implicit, warning with -w
$a = $s->echoMapArray([{a => 123, $key => $value}, {b => 123, $key => 789}])->result;
ok($a->[0]->{$key} == $value);
}
# explicit
$a = $s->echoMapArray([SOAP::Data->type(map => {a => 123, $key => $value}), SOAP::Data->type(map => {b => 123, $key => 789})])->result;
ok($a->[0]->{$key} == $value);
}
SOAP-Lite-1.09/t/23-ppm.t 000644 000766 000024 00000002647 12156373142 015723 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
#use strict;
BEGIN {
print "1..0 # Skip: ActiveState's ppmserver.pl server seems to be broken - skipping tests\n";
exit 0;
};
use Test;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
ref $res ? warn(join " ", "SOAP FAULT:", $res->faultstring, "\n")
: warn(join " ", "TRANSPORT ERROR:", $soap->transport->status, "\n");
return new SOAP::SOM;
}
;
my($a, $s, $r);
my $proxy = 'http://ppm.activestate.com/cgibin/PPM/ppmserver.pl';
# ------------------------------------------------------
use SOAP::Test;
$s = SOAP::Lite->uri('urn:/PPMServer')->proxy($proxy)->on_fault(sub{});
eval { $s->transport->timeout($SOAP::Test::TIMEOUT = $SOAP::Test::TIMEOUT) };
$r = $s->test_connection;
unless (defined $r && defined $r->envelope) {
print "1..0 # Skip: ", $s->transport->status, "\n";
exit;
}
# ------------------------------------------------------
plan tests => 3;
{
# ActiveState's PPM server (http://activestate.com/)
print "ActiveState's PPM server test(s)...\n";
$s = SOAP::Lite
-> uri('urn:/PPMServer')
-> proxy($proxy)
;
$r = $s->fetch_ppd('SOAP-Lite')->result;
# use Data::Dumper;
# print Dumper $r;
ok($r =~ 'SOAP-Lite');
ok($r =~ 'Paul Kulchenko');
$r = $s->fetch_ppd('SOAP-Super-Lite')->result;
ok(!defined $r);
}
SOAP-Lite-1.09/t/24-wsdl.t 000644 000766 000024 00000006214 12156373142 016073 0 ustar 00fredmoyer staff 000000 000000 #!/bin/env perl
BEGIN {
unless(grep /blib/, @INC) {
chdir 't' if -d 't';
unshift @INC, '../lib' if -d '../lib';
}
}
use strict;
use Test;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
ref $res ? warn(join "\n", "--- SOAP FAULT ---", $res->faultcode, $res->faultstring, '')
: warn(join "\n", "--- TRANSPORT ERROR ---", $soap->transport->status, '');
return new SOAP::SOM;
}
;
my($a, $s, $r, $serialized, $deserialized);
# ------------------------------------------------------
use SOAP::Test;
$s = SOAP::Lite->uri('http://something/somewhere')->proxy('http://services.xmethods.net/soap/servlet/rpcrouter')->on_fault(sub{});
eval { $s->transport->timeout($SOAP::Test::TIMEOUT = $SOAP::Test::TIMEOUT) };
$r = $s->test_connection;
unless (defined $r && defined $r->envelope) {
print "1..0 # Skip: ", $s->transport->status, "\n";
exit;
}
# ------------------------------------------------------
plan tests => 12;
{
# Service description (WSDL) (http://www.xmethods.net/)
print "Service description (WSDL) test(s)...\n";
$s = SOAP::Lite
-> service('http://services.xmethods.net/soap/urn:xmethods-delayed-quotes.wsdl');
ok($s->getQuote('MSFT') > 1);
ok(SOAP::Lite
-> service('http://services.xmethods.net/soap/urn:xmethods-delayed-quotes.wsdl')
-> getQuote('MSFT') > 1);
# WSDL with element and multiple ports (non-SOAP bindings)
ok(SOAP::Lite
-> service('http://www.xmethods.net/sd/StockQuoteImport.wsdl')
-> getQuote('MSFT') > 1);
my $schema = SOAP::Schema
-> schema('http://services.xmethods.net/soap/urn:xmethods-delayed-quotes.wsdl')
-> parse('net.xmethods.services.stockquote.StockQuoteService');
foreach (keys %{$schema->services}) {
eval { $schema->stub($_) } or die;
}
# SOAP::Schema converts
# net.xmethods.services.stockquote.StockQuoteService
# into
# net_xmethods_services_stockquote_StockQuoteService
print "Service description static stub test(s)...\n";
ok(net_xmethods_services_stockquote_StockQuoteService->getQuote('MSFT') > 1);
ok(defined net_xmethods_services_stockquote_StockQuoteService->self);
ok(net_xmethods_services_stockquote_StockQuoteService->self->call);
print "Service description static stub with import test(s)...\n";
net_xmethods_services_stockquote_StockQuoteService->import(':all');
ok(getQuote('MSFT') > 1);
ok(defined net_xmethods_services_stockquote_StockQuoteService->self);
ok(net_xmethods_services_stockquote_StockQuoteService->self->call);
# ok, now we'll test for passing SOAP::Data and SOAP::Headers as a parameters
my @params;
{
package TestStockQuoteService;
@TestStockQuoteService::ISA = 'net_xmethods_services_stockquote_StockQuoteService';
sub call { shift; @params = @_; new SOAP::SOM }
}
my @testparams = (SOAP::Data->name(param1 => 'MSFT'),
SOAP::Data->name('param2'),
SOAP::Header->name(header1 => 'value'));
TestStockQuoteService->new->getQuote(@testparams);
ok($params[1]->value->name eq 'param1');
ok($params[2]->name eq 'param2');
ok(ref $params[3] eq 'SOAP::Header' && $params[3]->name eq 'header1');
}
SOAP-Lite-1.09/t/36-leaks.t 000644 000766 000024 00000003530 12205505133 016212 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use strict;
use warnings;
use Test::More;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
ref $res ? warn(join " ", "SOAP FAULT:", $res->faultstring, "\n")
: warn(join " ", "TRANSPORT ERROR:", $soap->transport->status, "\n");
return new SOAP::SOM;
}
;
my ($a, $s, $r);
my $proxy = 'http://services.soaplite.com/echo.cgi';
# ------------------------------------------------------
use SOAP::Test;
$s = SOAP::Lite->uri('http://something/somewhere')->proxy($proxy)->on_fault(sub{});
eval { $s->transport->timeout($SOAP::Test::TIMEOUT = $SOAP::Test::TIMEOUT) };
$r = $s->test_connection;
unless (defined $r && defined $r->envelope) {
print "1..0 # Skip: ", $s->transport->status, "\n";
exit;
}
# ------------------------------------------------------
plan tests => 16;
{
print "Memory leaks test(s)...\n";
SOAP::Lite->self(undef);
my %calls = ();
SOAP::Lite->import(trace => [objects => sub {
# warn join ', ' , caller(2);
my @caller = caller(2);
$calls{$2}{$1}++ if ($caller[3] =~ /^(.+)::([^\:]+)$/);
}]);
{
my $soap = SOAP::Lite
-> uri("Echo")
-> proxy($proxy)
-> echo;
use Data::Dumper;
# find_cycle $soap;
}
use Data::Dumper;
foreach (keys %{$calls{new}}) {
print "default parser: $_\n";
ok(exists $calls{DESTROY}{$_});
}
SKIP: {
eval "require XML::Parser::Lite; 1;";
skip "XML::Parser::Lite is required for this test", 8 if $@;
%calls = ();
{
local $SOAP::Constants::DO_NOT_USE_XML_PARSER = 1;
my $soap = SOAP::Lite
-> uri("Echo")
-> proxy($proxy)
-> echo;
}
foreach (keys %{$calls{new}}) {
print "XML::Parser::Lite: $_\n";
ok(exists $calls{DESTROY}{$_});
}
}
# SOAP::Lite->import(trace => '-objects');
}
SOAP-Lite-1.09/t/38-packager.t 000644 000766 000024 00000012617 12237220251 016700 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use strict;
use warnings;
use Test::More;
BEGIN {
eval { require MIME::Parser; };
plan(skip_all => "MIME::Parser not installed") if $@;
}
my ($mp, $env, $part, @part_data);
use SOAP::Packager;
$mp = SOAP::Packager::MIME->new;
ok(ref $mp);
# check attachment deserialization
print "Attachment deserialization (Content-ID) test(s)...\n";
$env = $mp->unpackage(<<'EOX');
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
SOAPAction: http://schemas.risky-stuff.com/Auto-Claim
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
--MIME_boundary
Content-Type: image/tiff
Content-Transfer-Encoding: base64
Content-ID:
AAECAyAgIAQFBg==
--MIME_boundary
Content-Type: image/jpeg
Content-Transfer-Encoding: binary
Content-ID:
...Raw JPEG image..
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary
Content-Type: text/xml
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary--
EOX
# test to see how how many parts were found:
ok(@{$mp->parts} == 4);
ok(UNIVERSAL::isa(ref($mp->parts->[0]) => "MIME::Entity"));
# Tests to see if data extraction works - TIFF not checked
#@part_data = $mp->find_part( id => '' );
#ok($part_data[0] eq '...Raw JPEG image..');
#@part_data = $mp->find_part( id => '' );
#ok($part_data[0] eq 'c');
#@part_data = $mp->find_part( id => '' );
#ok($part_data[0] eq 'c');
# Test: no start parameter specified
# Content-ID:
# Content-Type: text/xml; charset=UTF-8
$env = $mp->unpackage(<<'EOX');
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"
SOAPAction: http://schemas.risky-stuff.com/Auto-Claim
Content-Description: This is the optional message description.
--MIME_boundary
Content-Transfer-Encoding: 8bit
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary--
EOX
# test to see how how many parts were found:
ok(@{$mp->parts} == 1);
# Tests to see if data extraction worked
#@part_data = $mp->find_part( id => '' );
#ok($part_data[0] eq 'c');
# test to see if start parameter works if it doesn't point to root
$env = $mp->unpackage(<<'EOX');
Content-Type: Multipart/Related; boundary=MIME_boundary; type="text/xml"; start=""
SOAPAction: http://schemas.risky-stuff.com/Auto-Claim
Content-Description: This is the optional message description.
--MIME_boundary
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID: c
--MIME_boundary
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID:
--MIME_boundary--
EOX
# test to see how how many parts were found:
ok(@{$mp->parts} == 1);
# Tests to see if data extraction worked
#@part_data = $mp->find_part( id => '' );
#ok($part_data[0] eq 'c');
done_testing();
1;
SOAP-Lite-1.09/t/40-loopback.t 000644 000766 000024 00000000400 12156373142 016701 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test;
use SOAP::Lite;
plan tests => 3;
ok my $soap = SOAP::Lite->new(
proxy => 'loopback://test',
# outputxml => 1,
);
ok my $som = $soap->call('test', SOAP::Data->name('test')->value(42));
ok $som->result() == 42; SOAP-Lite-1.09/t/Issues/ 000755 000766 000024 00000000000 12265327263 015766 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/ 000755 000766 000024 00000000000 12265327263 015255 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/Data.t 000644 000766 000024 00000001455 12156373142 016314 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More tests => 33; #qw(no_plan);
use_ok qw(SOAP::Lite);
my @setter_from = qw(
name value attr type actor encodingStyle
prefix uri value signature
);
my @option_from = qw(
root mustUnderstand
);
my $data = SOAP::Data->new();
isa_ok $data, 'SOAP::Data';
for my $method ( @option_from ) {
no strict qw(refs);
my $data = SOAP::Data->$method("foo_$method");
}
for my $method ( @setter_from ) {
no strict qw(refs);
my $data = SOAP::Data->$method("foo_$method");
isa_ok $data, 'SOAP::Data';
is $data->$method(), "foo_$method", "SOAP::Data->$method() value";
$data = $data->$method("bar_$method");
is $data->$method(), "bar_$method", "\$data->$method() value";
}
$data = SOAP::Data->set_value('foo');
is $data->value(), 'foo';
SOAP-Lite-1.09/t/SOAP/Lite/ 000755 000766 000024 00000000000 12265327263 016152 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/Schema/ 000755 000766 000024 00000000000 12265327263 016455 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/Serializer.t 000644 000766 000024 00000004025 12156373142 017550 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More tests => 13; #qw(no_plan);
use_ok qw(SOAP::Lite);
my $serializer = SOAP::Serializer->new();
is $serializer->find_prefix('http://schemas.xmlsoap.org/soap/envelope/'), 'soap';
ok my $tag = $serializer->tag('fooxml', {}), 'serialize ';
ok $tag = $serializer->tag('_xml', {}), 'serialize <_xml/>';
eval {
$tag = $serializer->tag('---', {});
};
like $@, qr{^Element \s '---' \s can't \s be \s allowed}x, 'error on ';
undef $@;
eval {
local $SIG{__WARN__} = sub {
like $_[0], qr{^Element \s 'xmlfoo'}x;
};
$tag = $serializer->tag('xmlfoo', {});
};
my $xml = $serializer->envelope('fault', faultstring => '>>> foo <<<');
like $xml, qr{\>\>\>}x, 'fault escaped OK';
unlike $xml, qr{\>}x, 'fault escaped OK';
$xml = $serializer->envelope('response', foo => '>>> bar <<<');
like $xml, qr{\>\>\>}x, 'response escaped OK';
unlike $xml, qr{\>}x, 'response escaped OK';
$xml = $serializer->envelope('method', foo => '>>> bar <<<');
like $xml, qr{\>\>\>}x, 'response escaped OK';
unlike $xml, qr{\>}x, 'response escaped OK';
SKIP: {
eval "require Test::Differences"
or skip 'Cannot test without Test::Differences', 1;
my $serializer = SOAP::Serializer->new()->autotype(1);
my @som_data = ( SOAP::Data->name('Spec'), SOAP::Data->name('Version')
);
my $complex_data = SOAP::Data->name( 'complex' )
->attr( { attr => '123' } )
->value( [ SOAP::Data->name('Spec'), SOAP::Data->name('Version') ]
);
my $result = $serializer->encode_object($complex_data, 'test', undef, {});
# remove attributes created by autotype
delete $result->[1]->{'soapenc:arrayType'};
delete $result->[1]->{'xsi:type'};
# turn off autotyping
$serializer->autotype(0);
# now we are able to compare both kinds of serialization
Test::Differences::eq_or_diff( $result,
$serializer->encode_object($complex_data, 'test', undef, {}),
'autotype off array serialization');
}
SOAP-Lite-1.09/t/SOAP/Transport/ 000755 000766 000024 00000000000 12265327263 017251 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/Transport/HTTP/ 000755 000766 000024 00000000000 12265327263 020030 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/Transport/HTTP.t 000644 000766 000024 00000006504 12156373142 020216 0 ustar 00fredmoyer staff 000000 000000 use strict;
use Test::More qw(no_plan);
use_ok qw(SOAP::Transport::HTTP);
# Try mocking LWP::UserAgent to simulate sending something over the wire.
# Skip if we don't have Test::MockObject.
SKIP: {
eval "require Test::MockObject"
or skip "Cannot simulate transport layer without Test::MockObject", 3;
require HTTP::Response;
my $mock = Test::MockObject->new();
$mock->fake_module( 'LWP::UserAgent',
'new' => sub { return bless {}, $_[0] },
'agent' => sub {
return $_[1]
? $_[0]->{ agent } = $_[1]
: $_[0]->{ agent }
},
# TODO return something meaningful
'request' => sub {
return HTTP::Response->new(200, '200 OK');
},
);
my $client;
ok $client = SOAP::Transport::HTTP::Client->new();
$client->send_receive(endpoint => 'http://example.org',
envelope => '');
is $client->code(), '200';
is $client->message(), '200 OK';
}
# client
my $client;
ok $client = SOAP::Transport::HTTP::Client->new(), 'SOAP::Transport::HTTP::Client->new()';
# just use twice to avoid warning
undef $SOAP::Constants::PATCH_HTTP_KEEPALIVE;
undef $SOAP::Constants::PATCH_HTTP_KEEPALIVE;
ok $client = SOAP::Transport::HTTP::Client->new(), 'SOAP::Transport::HTTP::Client->new() - PATCH_KEEPALIVE = undef';
is $client, $client->new(), '$client->new() returns $client';
is $client->http_request('foo'), $client;
is $client->http_request(), 'foo';
is $client->http_response('foo'), $client;
is $client->http_response(), 'foo';
undef $client;
# package SOAP::Transport::HTTP::Server;
my $server;
ok $server = SOAP::Transport::HTTP::Server->new(), 'SOAP::Transport::HTTP::Server->new()';
isa_ok $server, 'SOAP::Transport::HTTP::Server';
isa_ok $server, 'SOAP::Server';
is $server, $server->new(), '$server->new() returns $server';
like $server->product_tokens(), qr{SOAP::Lite}x;
test_make_fault($server);
undef $server;
# package SOAP::Transport::HTTP::CGI;
ok $server = SOAP::Transport::HTTP::CGI->new();
isa_ok $server, 'SOAP::Transport::HTTP::Server';
isa_ok $server, 'SOAP::Server';
test_make_fault($server);
# package SOAP::Transport::HTTP::Daemon
my $transport;
ok $transport = SOAP::Transport::HTTP::Daemon->new(), 'SOAP::Transport::HTTP::Daemon->new()';
is $transport, $transport->new(), '$transport->new() is $transport';
is $transport->SSL(1), $transport;
is $transport->SSL(), 1;
is $transport->http_daemon_class(), 'HTTP::Daemon::SSL';
is $transport->SSL(0), $transport;
is $transport->SSL(), 0;
is $transport->http_daemon_class(), 'HTTP::Daemon';
undef $transport;
# package SOAP::Transport::HTTP::Apache is untestable under mod_perl 1.x
# due to missing exports in Apache::Constant
SKIP: {
eval "require FCGI;"
or skip "Can't test without FCGI", 1;
# package SOAP::Transport::HTTP::FCGI
ok $transport = SOAP::Transport::HTTP::FCGI->new(), 'SOAP::Transport::HTTP::FCGI->new()';
undef $transport;
}
sub test_make_fault {
my $server = shift;
# try creating a fault
my $request = HTTP::Request->new();
is $server->request($request), $server, '$server->request($request)';
is $server->request(), $request, '$server->request()';
$server->make_fault();
is $server->response()->code(), 500, 'fault response code is 500';
like $server->response->content(), qr{\bFault\b}x, 'Fault content';
}
SOAP-Lite-1.09/t/SOAP/Transport/IO.t 000644 000766 000024 00000001371 12156373142 017743 0 ustar 00fredmoyer staff 000000 000000 use strict;
use Test::More qw(no_plan);
use_ok qw(SOAP::Transport::IO);
my $server;
ok $server = SOAP::Transport::IO::Server->new(), 'new()';
SKIP: {
eval "require IO::Scalar"
or skip "cannot test Scalar IO without IO::Scalar", 1;
my $input = q{};
my $input_handle = IO::Scalar->new(\$input);
ok $server->in($input_handle);
eval { $server->handle() };
ok !$@;
}
is $server, $server->new(), '$server->new() is $server';
my $name = __FILE__;
$name =~s{ t $}{xml}x;
ok $server = SOAP::Transport::IO::Server->in($name), 'in($filename)';
eval { $server->handle() };
ok !$@;
ok $server->in(undef), 'in(undef)';
ok $server->out(undef), 'in(undef)';
# TODO: add some content to IO.xml and run it through a SOAP server... SOAP-Lite-1.09/t/SOAP/Transport/LOCAL.t 000644 000766 000024 00000001411 12156373142 020261 0 ustar 00fredmoyer staff 000000 000000 use strict;
use Test::More qw(no_plan);
use_ok qw(SOAP::Transport::LOCAL);
my $transport;
ok $transport = SOAP::Transport::LOCAL::Client->new();
# call methods if known, pass through the rest as arguments
#
# ->new calls the methods $self->endpoint('local:main') and $self->options({}),
# and calls SUPER::new("foo");
#
ok $transport = SOAP::Transport::LOCAL::Client->new(endpoint => 'local:main', options => [], "foo");
is $transport, $transport->new() , '$transport->new() returns $transport';
use_ok qw(SOAP::Lite);
my $soap = SOAP::Lite->proxy('local:main');
$soap->transport()->dispatch_to('main');
my $som = $soap->call('test');
die $som->fault()->{ faultstring } if $som->fault();
is $som->result, 'Zumsel', 'result is Zumsel';
sub test {
return "Zumsel";
}
SOAP-Lite-1.09/t/SOAP/Transport/LOOPBACK.t 000644 000766 000024 00000000711 12156373142 020623 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More qw(no_plan);
use_ok qw(SOAP::Transport::LOOPBACK);
my $transport;
ok $transport = SOAP::Transport::LOOPBACK::Client->new();
is $transport, $transport->new() , '$transport->new() returns $transport';
use_ok qw(SOAP::Lite);
my $soap = SOAP::Lite->proxy('loopback:main');
my $som = $soap->call('test', 'Zumsel');
die $som->fault()->{ faultstring } if $som->fault();
is $som->result, 'Zumsel', 'result is Zumsel';
SOAP-Lite-1.09/t/SOAP/Transport/MAILTO.t 000644 000766 000024 00000002557 12156373142 020430 0 ustar 00fredmoyer staff 000000 000000 use strict;
use Test::More;
eval { require Test::MockObject }
or plan skip_all => 'Cannot test without Test::MockObject';
plan tests => 15;
my $mock = Test::MockObject->new();
$mock->fake_module('MIME::Lite',
new => sub { my $class = shift;
my %arg_of = @_;
return bless { %arg_of }, $class;
},
send => sub {},
replace => sub {},
add => sub {},
as_string => sub {},
);
use_ok qw(SOAP::Transport::MAILTO);
my $transport;
ok $transport = SOAP::Transport::MAILTO::Client->new(
endpoint => 'mailto:test@example.org'
), 'new( endpoint => mailto:test@example.org';
is $transport, $transport->new() , '$transport->new() returns $transport';
test_send_receive($transport);
$transport = SOAP::Transport::MAILTO::Client->new(
smtp => 'smtp.example.org',
From => 'test@example.org',
'Reply-To' => 'test@example.org',
Subject => 'MAILTO.t',
Encoding => 'Quoted-printable',
);
test_send_receive($transport, endpoint => 'mailto:arg_of@example.org');
test_send_receive($transport, endpoint => 'mailto:');
sub test_send_receive {
my $transport = shift;
my %arg_of = @_;
$transport->send_receive(%arg_of);
ok $transport->is_success(), 'is_success() is true';
ok ! $transport->code(), 'code() is false';
ok ! $transport->message(), 'message() is false';
ok ! $transport->status(), 'status() is false';
} SOAP-Lite-1.09/t/SOAP/Transport/POP3.t 000644 000766 000024 00000000375 12156373142 020160 0 ustar 00fredmoyer staff 000000 000000 use strict;
use Test::More qw(no_plan);
use_ok qw(SOAP::Transport::POP3);
my $uri = 'pop://user@mail.example.org';
my $server;
#ok $server = SOAP::Transport::POP3::Server->new(
# # $uri
#);
#is $server->new(), $server, '$server->new() is $server'; SOAP-Lite-1.09/t/SOAP/Transport/TCP.t 000644 000766 000024 00000001004 12200752752 020051 0 ustar 00fredmoyer staff 000000 000000 use strict;
use Test::More tests => 7;
use_ok qw(SOAP::Transport::TCP);
my $transport;
ok $transport = SOAP::Transport::TCP::Client->new(
endpoint => 'tcp://127.0.0.1:0'
), 'new()';
is $transport, $transport->new(), '$transport->new() returns $transport';
{
no warnings qw(uninitialized);
$transport->send_receive();
}
ok ! $transport->is_success(), 'is_success() is false';
like $transport->status(), qr{ Cannot }x;
like $transport->message(), qr{ Cannot }x;
like $transport->code(), qr{ Cannot }x;
SOAP-Lite-1.09/t/SOAP/Transport/HTTP/CGI.t 000644 000766 000024 00000003162 12156373142 020615 0 ustar 00fredmoyer staff 000000 000000 package SOAP::Transport::CGI_TEST::Client;
use strict; use warnings;
use IPC::Open2;
use File::Basename qw(dirname);
# make a send_receive which performs an open2, much like a web server
# connects to STDIN and STDOUT...
sub send_receive {
my ($self, %parameters) = @_;
my ($context, $envelope, $endpoint, $action, $encoding, $parts) =
@parameters{qw(context envelope endpoint action encoding parts)};
# safety measure: Die if we hang
$SIG{ALRM} = sub { die "did not return" };
alarm(3);
my $perl = $^X;
my $dir = dirname(__FILE__);
my $cmd = "$dir/CGI/test_server.pl";
$ENV{'CONTENT_LENGTH'} = length($envelope);
$ENV{'REQUEST_METHOD'} = 'POST';
my($child_out, $child_in);
my $pid = open2($child_out, $child_in, $perl, '-Mblib', $cmd);
die "Cannot open $cmd: $!" if not ($pid);
print $child_in $envelope;
print $child_in "\n";
close $child_in;
my @result = <$child_out>;
close $child_out;
alarm(0);
return $result[-1];
}
package main;
no strict;
use Test::More qw(no_plan);
use SOAP::Lite; # +trace;
my $soap = SOAP::Lite->new()->proxy('http://');
no warnings qw(redefine once);
# make override send_receive in CGI client
*SOAP::Transport::HTTP::Client::send_receive =
\&SOAP::Transport::CGI_TEST::Client::send_receive;
my $som = $soap->call('test');
my $result = $som->result;
if ($] >= 5.008) {
ok utf8::is_utf8($result), 'return utf8 string';
{
is $result, 'Уberall', 'utf8 content: ' . $result;
}
}
else {
eval { use bytes;
is length $result, 8, "length of >$result< is 8 due to wide character";
}
}
SOAP-Lite-1.09/t/SOAP/Schema/WSDL.t 000644 000766 000024 00000000672 12156373142 017414 0 ustar 00fredmoyer staff 000000 000000 use Test::More qw(no_plan);
use SOAP::Lite;
ok my $schema = SOAP::Schema::WSDL->new();
my $element = SOAP::Custom::XML::Data
-> SOAP::Data::name('schema')
-> set_value(
SOAP::Custom::XML::Data
-> SOAP::Data::name('complexType')
->attr({ name => 'test' })
);
my @result = SOAP::Schema::WSDL::parse_schema_element( $element );
is @result, 0, 'empty elements on empty complexType'
SOAP-Lite-1.09/t/SOAP/Lite/Deserializer/ 000755 000766 000024 00000000000 12265327263 020574 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/t/SOAP/Lite/Packager.t 000644 000766 000024 00000000513 12156373142 020047 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More tests => 4; #qw(no_plan);
use_ok qw(SOAP::Lite::Packager);
ok SOAP::Lite::Packager->new(), 'SOAP::Lite::Packager->new()';
ok my $mime = SOAP::Lite::Packager::MIME->new(), 'SOAP::Lite::Packager::MIME->new()';
my $entity = bless {}, 'MIME::Entity';
ok $mime->is_supported_part($entity);
SOAP-Lite-1.09/t/SOAP/Lite/Deserializer/XMLSchema1999.t 000644 000766 000024 00000003221 12156373142 023070 0 ustar 00fredmoyer staff 000000 000000 use Test::More;
plan tests => 42;
use_ok qw(SOAP::Lite::Deserializer::XMLSchema1999);
is SOAP::Lite::Deserializer::XMLSchema1999->anyTypeValue(),
'ur-type',
'anyTypeValue';
is SOAP::Lite::Deserializer::XMLSchema1999->as_boolean('false'),
0, 'as_boolean("false")';
is SOAP::Lite::Deserializer::XMLSchema1999->as_boolean('true'),
1, 'as_boolean("false")';
eval {SOAP::Lite::Deserializer::XMLSchema1999->as_boolean('foobar') };
ok $@, 'died on illegal boolean value';
undef $@;
is ord SOAP::Lite::Deserializer::XMLSchema1999->as_hex('FF'),
255, 'as_hex(FF)';
is ord SOAP::Lite::Deserializer::XMLSchema1999->as_hex('65'),
101, 'as_hex(65)';
is SOAP::Lite::Deserializer::XMLSchema1999->as_hex('4142'),
'AB', 'as_hex(4142)';
is SOAP::Lite::Deserializer::XMLSchema1999->as_ur_type('4242'),
'4242', 'as_ur_type(4242)';
is SOAP::Lite::Deserializer::XMLSchema1999->as_undef('true'),
'1', 'as_undef("true")';
is SOAP::Lite::Deserializer::XMLSchema1999->as_undef('false'),
'0', 'as_undef("false")';
eval {SOAP::XMLSchema1999::Deserializer->as_undef('ZUMSL')};
ok $@, 'died on illegal nil value';
undef $@;
for (qw(
string
float double decimal
timeDuration recurringDuration uriReference
integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger timeInstant time timePeriod date month year century
recurringDate recurringDay language) ) {
no strict qw(refs);
my $method = "as_$_";
is SOAP::Lite::Deserializer::XMLSchema1999->$method('something nice'),
'something nice', "$method('something nice')";
}
SOAP-Lite-1.09/t/SOAP/Lite/Deserializer/XMLSchema2001.t 000644 000766 000024 00000002562 12156373142 023046 0 ustar 00fredmoyer staff 000000 000000 use Test::More tests => 42;
use_ok qw(SOAP::Lite::Deserializer::XMLSchema2001);
is SOAP::Lite::Deserializer::XMLSchema2001->anyTypeValue(),
'anyType',
'anyTypeValue';
is SOAP::Lite::Deserializer::XMLSchema2001->as_boolean('false'),
0, 'as_boolean("false")';
is ord SOAP::Lite::Deserializer::XMLSchema2001->as_hexBinary('FF'),
255, 'as_hex(FF)';
is ord SOAP::Lite::Deserializer::XMLSchema2001->as_hexBinary('65'),
101, 'as_hex(65)';
is SOAP::Lite::Deserializer::XMLSchema2001->as_hexBinary('4142'),
'AB', 'as_hex(4142)';
#is SOAP::Lite::Deserializer::XMLSchema2001->as_ur_type('4242'),
# '4242', 'as_ur_type(4242)';
is SOAP::Lite::Deserializer::XMLSchema2001->as_undef('true'),
'1', 'as_undef("true")';
is SOAP::Lite::Deserializer::XMLSchema2001->as_undef('false'),
'0', 'as_undef("false")';
for (qw(
string
anyType anySimpleType
float double decimal dateTime timePeriod gMonth gYearMonth gYear
century gMonthDay gDay duration recurringDuration
language integer nonPositiveInteger negativeInteger long int short
byte nonNegativeInteger unsignedLong unsignedInt unsignedShort
unsignedByte positiveInteger date time dateTime
QName) ) {
no strict qw(refs);
my $method = "as_$_";
is SOAP::Lite::Deserializer::XMLSchema2001->$method('something nice'),
'something nice', "$method('something nice')";
} SOAP-Lite-1.09/t/SOAP/Lite/Deserializer/XMLSchemaSOAP1_1.t 000644 000766 000024 00000001641 12156373142 023524 0 ustar 00fredmoyer staff 000000 000000 use Test::More tests => 35;
use_ok qw(SOAP::Lite::Deserializer::XMLSchemaSOAP1_1);
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_1->anyTypeValue(),
'ur-type',
'anyTypeValue';
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_1->as_boolean('false'),
0, 'as_boolean("false")';
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_1->as_ur_type('4242'),
'4242', 'as_ur_type(4242)';
for (qw(
string float double decimal timeDuration recurringDuration uriReference
integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger timeInstant time timePeriod date month year century
recurringDate recurringDay language
anyURI
) ) {
no strict qw(refs);
my $method = "as_$_";
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_1->$method('something nice'),
'something nice', "$method('something nice')";
} SOAP-Lite-1.09/t/SOAP/Lite/Deserializer/XMLSchemaSOAP1_2.t 000644 000766 000024 00000002004 12156373142 023517 0 ustar 00fredmoyer staff 000000 000000 use Test::More tests => 37;
use_ok qw(SOAP::Lite::Deserializer::XMLSchemaSOAP1_2);
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->anyTypeValue(),
'anyType',
'anyTypeValue';
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->as_boolean('true'),
1, 'as_boolean("true")';
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->as_boolean('false'),
0, 'as_boolean("false")';
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->as_anyType('4242'),
'4242', 'as_anyType(4242)';
for (qw(
string float double decimal dateTime timePeriod gMonth gYearMonth gYear
century gMonthDay gDay duration recurringDuration anyURI
language integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger date time dateTime
) ) {
no strict qw(refs);
my $method = "as_$_";
is SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->$method('something nice'),
'something nice', "$method('something nice')";
} SOAP-Lite-1.09/t/Issues/rt15176.t 000644 000766 000024 00000000373 12156373142 017203 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More tests => 1;
use SOAP::Lite;
# When setting a value that contains wide characters (> U+00ff), it tries to encode as Base64 but then fails
eval {
my $header = SOAP::Header->value("\N{U+00ff}");
};
ok (!@$);
SOAP-Lite-1.09/t/Issues/rt53375.t 000644 000766 000024 00000001024 12156373142 017200 0 ustar 00fredmoyer staff 000000 000000 use Test::More tests => 4;
use XML::Parser::Lite;
my $comment = '';
my $parser = new XML::Parser::Lite(
Handlers => {
Comment => sub { $comment .= $_[1]; },
}
);
my $xml = <<'EOT';
EOT
eval {
$parser->parse($xml);
};
ok(! $@);
is($comment, ' seed-viewer ');
$comment = '';
$xml = <<'EOT';
EOT
eval {
$parser->parse($xml);
};
ok(! $@);
is($comment, ' seed_viewer ');
SOAP-Lite-1.09/t/Issues/rt70329.t 000644 000766 000024 00000001452 12156373142 017203 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
#
# Tests the error described in rt.cpan.org #70329
#
# The error came from handling multiref ids, and unconditionally
# overwriting the id attribute
#
#
use Test::More tests => 1;
use 5.006;
use strict;
use warnings;
use SOAP::Lite +trace => [ 'debug' ];
my $req1 = SOAP::Lite->new(
readable => 1,
autotype => 0,
proxy => 'LOOPBACK://',
);
# req1 does not generate the XML attribute it just generates
#
my $content = SOAP::Data->new(
name => 'item',
attr => { "id" => 1 },
value => \SOAP::Data->new(
name => 'foo',
value => 1,
),
);
my $response = $req1->requestMessage(\$content);
my $response_item = $response->dataof("//item");
is($content->attr->{ id }, $response_item->attr->{ id });
SOAP-Lite-1.09/t/Issues/rt70381.t 000644 000766 000024 00000002173 12156373142 017202 0 ustar 00fredmoyer staff 000000 000000 use Test::More;
if (not $ENV{PROFILE_PERFORMANCE}) {
plan ('skip_all' => 'This is a performance test. Set PROFILE_PERFORMANCE env var to a true value to run');
exit 1;
}
plan qw(no_plan);
use SOAP::Lite;
my $content = SOAP::Data->name('test')->uri('http://example.org')
->value([
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
\SOAP::Data->name('level1')->value('value1')->uri('http:/example.org'),
]);
my $soap = SOAP::Lite->proxy('loopback://');
for (1..100) {
my $response = $soap->call('test', \$content);
}
SOAP-Lite-1.09/t/Issues/rt72836.t 000644 000766 000024 00000004755 12156373142 017221 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
package DoThingsWithStuff;
use SOAP::Lite;
our @ISA = qw(SOAP::Server::Parameters);
sub new {
my ( $class ) = @_;
my $self = bless {}, ref($class) || $class;
$self;
}
sub do_something {
my $self = shift;
my $som = pop;
#$som->context->serializer->encodingStyle(""); # does adding this affect the fix?
return SOAP::Data->name(wotsit => "doofer");
}
package main;
use Test::More;
use SOAP::Lite;
eval {
require Test::XML;
};
if ($@) {
plan skip_all => 'Cannot test without Test::XML ' . $@;
exit 0;
}
my $req11 = 'things';
my $req12 = 'things';
my $expected_11 = 'doofer';
my $expected_12 = 'doofer';
my $t = DoThingsWithStuff->new;
my $s = SOAP::Server->new;
$s->dispatch_with({
"urn:Something" => $t
});
my $res_11_1 = $s->handle($req11);
Test::XML::is_xml($res_11_1, $expected_11, "Got correct SOAP 1.1 response");
my $res_12 = $s->handle($req12);
Test::XML::is_xml($res_12, $expected_12, "Got correct SOAP 1.2 response");
my $res_11_2 = $s->handle($req11);
Test::XML::is_xml($res_11_2, $expected_11, "Got correct SOAP 1.1 response after processing a SOAP 1.2 request");
done_testing;
SOAP-Lite-1.09/t/Issues/rt74029.t 000644 000766 000024 00000001721 12156373142 017203 0 ustar 00fredmoyer staff 000000 000000 #!/usr/bin/perl
use Test::More skip_all => 'not fixed yet';
exit;
use Data::Dumper;
our %stack = ();
use SOAP::Lite +trace => 'all';
use Storable qw(nstore retrieve);
use B 'svref_2object';
use Symbol 'qualify_to_ref';
sub change_depth_warn {
my($subname, $limit) = @_;
my $subref = \&$subname;
my $gv = svref_2object($subref)->GV;
my $lineno = 0;
no warnings 'redefine';
*{ qualify_to_ref $subname } = sub {
if( $gv->CV->DEPTH % $limit == 0 ) {
$lineno = do {
my $i = 0;
1 while caller $i++;
(caller($i - 2))[2]
} unless $lineno;
die sprintf "Deep recursion on subroutine '%s' at %s line %d.\n", join('::', $gv->STASH->NAME, $gv->NAME), $0, $lineno;
}
&$subref(@_);
};
}
my $obj = retrieve("$0.stored");
print Dumper $obj;
change_depth_warn("SOAP::Serializer::encode_object", 100);
my $ser = SOAP::Serializer->new( readable => 1);
$ser->autotype(0);
print $ser->freeform($obj);
ok(1);
done_testing();
SOAP-Lite-1.09/t/Issues/rt74308.t 000644 000766 000024 00000000220 12156373142 017174 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More tests => 1;
use SOAP::Lite;
eval {
my $soap = SOAP::Lite->service("file:$0.wsdl");
};
ok (! $@);
SOAP-Lite-1.09/t/Issues/rt75169.t 000644 000766 000024 00000000600 12156373142 017204 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More;
use SOAP::Lite;
use utf8;
use Encode;
my $data = "УМ";
my $soap = SOAP::Serializer->new();
$soap->autotype(0);
my $xml = $soap->envelope( freeform => "$data" );
my ( $cycled ) = values %{ SOAP::Deserializer->deserialize( $xml )->body };
is( length( $data ), length( $cycled ), "UTF-8 string is the same after serializing" );
done_testing;
SOAP-Lite-1.09/t/Issues/rt78588.t 000644 000766 000024 00000000646 12156373142 017226 0 ustar 00fredmoyer staff 000000 000000 use strict;
use warnings;
use Test::More;
use SOAP::Lite;
use utf8;
my $data = "mУМ\x{2013}";
my $serializer = SOAP::Serializer->new();
$serializer->typelookup()->{ base64Binary } = [ 10, sub { 0 }, undef];
my $xml = $serializer->envelope( freeform => $data );
my ( $cycled ) = values %{ SOAP::Deserializer->deserialize( $xml )->body };
is( $data, $cycled, "UTF-8 string is the same after serializing" );
done_testing;
SOAP-Lite-1.09/lib/Apache/ 000755 000766 000024 00000000000 12265327263 016177 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/lib/SOAP/ 000755 000766 000024 00000000000 12265327263 015560 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/lib/SOAP/Client.pod 000644 000766 000024 00000005704 12200752752 017502 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2004 Paul Kulchenko (paulclinger@yahoo.com)
#
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
=pod
=head1 NAME
SOAP::Client - exists purely as a superclass for client classes declared by the various SOAP::Lite transport modules.
=head1 DESCRIPTION
The SOAP::Client class exists purely as a superclass for client classes
declared by the various SOAP::Lite transport modules. The methods it
provides are all simple accessors; they return the current value when
called with no arguments or set the attribute value and return the object
reference when called with an argument. These attributes include:
=head1 METHODS
=over
=item code, message, status
Stores the response code, message, and status from the most-recent send attempt. For some protocols, such as FTP, the same value is used for all three because of the lack of finer-grained detail (the default is to ensure that all three attributes contain data, even if redundant). Other protocols (such as HTTP) have distinct values in each.
=item endpoint
Identifies the current endpoint to which messages are being sent. This should match the value of the transport method from the L class, but setting this doesn't propagate to the transport object. It is better to use the transport object (or the shortcut via the SOAP::Lite object itself) when setting this.
=item is_success
The success or failure of the most-recent transmission is noted here as a boolean value.
=item options
The options attribute keeps a hash-table reference of additional options and their values. At present, only one option is used by any of the transport modules:
=over
=item compress_threshold
The value of this option should be a numerical value. If set, and if the Compress::Zlib library is available, messages whose size in bytes exceeds this value will be compressed before sending. Both ends of the conversation must have it enabled.
=back
Other options may be defined using this mechanism. Note that setting the options using this accessor requires a full hash reference be passed. To set just one or a few values, consider retrieving the current reference value and using it to set the key(s).
=back
=head1 SEE ALSO
L
=head1 ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from I, mainly the SOAP::Lite reference found in Appendix B.
=head1 COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
=cut
SOAP-Lite-1.09/lib/SOAP/Constants.pm 000644 000766 000024 00000020132 12265326352 020066 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2004 Paul Kulchenko (paulclinger@yahoo.com)
#
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
package SOAP::Constants;
use strict;
use SOAP::Lite;
our $VERSION = 1.09;
use constant URI_1999_SCHEMA_XSD => "http://www.w3.org/1999/XMLSchema";
use constant URI_1999_SCHEMA_XSI => "http://www.w3.org/1999/XMLSchema-instance";
use constant URI_2000_SCHEMA_XSD => "http://www.w3.org/2000/10/XMLSchema";
use constant URI_2000_SCHEMA_XSI => "http://www.w3.org/2000/10/XMLSchema-instance";
use constant URI_2001_SCHEMA_XSD => "http://www.w3.org/2001/XMLSchema";
use constant URI_2001_SCHEMA_XSI => "http://www.w3.org/2001/XMLSchema-instance";
use constant URI_LITERAL_ENC => "";
use constant URI_SOAP11_ENC => "http://schemas.xmlsoap.org/soap/encoding/";
use constant URI_SOAP11_ENV => "http://schemas.xmlsoap.org/soap/envelope/";
use constant URI_SOAP11_NEXT_ACTOR => "http://schemas.xmlsoap.org/soap/actor/next";
use constant URI_SOAP12_ENC => "http://www.w3.org/2003/05/soap-encoding";
use constant URI_SOAP12_ENV => "http://www.w3.org/2003/05/soap-envelope";
use constant URI_SOAP12_NOENC => "http://www.w3.org/2003/05/soap-envelope/encoding/none";
use constant URI_SOAP12_NEXT_ACTOR => "http://www.w3.org/2003/05/soap-envelope/role/next";
use vars qw($NSMASK $ELMASK);
$NSMASK = '[a-zA-Z_:][\w.\-:]*';
$ELMASK = '^(?![xX][mM][lL])[a-zA-Z_][\w.\-]*$';
use vars qw($NEXT_ACTOR $NS_ENV $NS_ENC $NS_APS
$FAULT_CLIENT $FAULT_SERVER $FAULT_VERSION_MISMATCH
$HTTP_ON_FAULT_CODE $HTTP_ON_SUCCESS_CODE $FAULT_MUST_UNDERSTAND
$NS_XSI_ALL $NS_XSI_NILS %XML_SCHEMAS $DEFAULT_XML_SCHEMA
$DEFAULT_HTTP_CONTENT_TYPE
$SOAP_VERSION %SOAP_VERSIONS $WRONG_VERSION
$NS_SL_HEADER $NS_SL_PERLTYPE $PREFIX_ENV $PREFIX_ENC
$DO_NOT_USE_XML_PARSER $DO_NOT_CHECK_MUSTUNDERSTAND
$DO_NOT_USE_CHARSET $DO_NOT_PROCESS_XML_IN_MIME
$DO_NOT_USE_LWP_LENGTH_HACK $DO_NOT_CHECK_CONTENT_TYPE
$MAX_CONTENT_SIZE $PATCH_HTTP_KEEPALIVE $DEFAULT_PACKAGER
@SUPPORTED_ENCODING_STYLES $OBJS_BY_REF_KEEPALIVE
$DEFAULT_CACHE_TTL
%XML_SCHEMA_OF
);
$FAULT_CLIENT = 'Client';
$FAULT_SERVER = 'Server';
$FAULT_VERSION_MISMATCH = 'VersionMismatch';
$FAULT_MUST_UNDERSTAND = 'MustUnderstand';
$HTTP_ON_SUCCESS_CODE = 200; # OK
$HTTP_ON_FAULT_CODE = 500; # INTERNAL_SERVER_ERROR
@SUPPORTED_ENCODING_STYLES = ( URI_LITERAL_ENC,URI_SOAP11_ENC,URI_SOAP12_ENC,URI_SOAP12_NOENC );
$WRONG_VERSION = 'Wrong SOAP version specified.';
$SOAP_VERSION = '1.1';
%SOAP_VERSIONS = (
1.1 => {
NEXT_ACTOR => URI_SOAP11_NEXT_ACTOR,
NS_ENV => URI_SOAP11_ENV,
NS_ENC => URI_SOAP11_ENC,
DEFAULT_XML_SCHEMA => URI_2001_SCHEMA_XSD,
DEFAULT_HTTP_CONTENT_TYPE => 'text/xml',
},
1.2 => {
NEXT_ACTOR => URI_SOAP12_NEXT_ACTOR,
NS_ENV => URI_SOAP12_ENV,
NS_ENC => URI_SOAP12_ENC,
DEFAULT_XML_SCHEMA => URI_2001_SCHEMA_XSD,
DEFAULT_HTTP_CONTENT_TYPE => 'application/soap+xml',
},
);
# schema namespaces
%XML_SCHEMAS = ( # The '()' is necessary to put constants in SCALAR form
URI_1999_SCHEMA_XSD() => 'SOAP::XMLSchema1999',
URI_2001_SCHEMA_XSD() => 'SOAP::XMLSchema2001',
URI_SOAP11_ENC() => 'SOAP::XMLSchemaSOAP1_1',
URI_SOAP12_ENC() => 'SOAP::XMLSchemaSOAP1_2',
);
# schema namespaces
%XML_SCHEMA_OF = ( # The '()' is necessary to put constants in SCALAR form
URI_1999_SCHEMA_XSD() => 'XMLSchema1999',
URI_2001_SCHEMA_XSD() => 'XMLSchema2001',
URI_SOAP11_ENC() => 'XMLSchemaSOAP1_1',
URI_SOAP12_ENC() => 'XMLSchemaSOAP1_2',
);
$NS_XSI_ALL = join join('|', map {"$_-instance"} grep {/XMLSchema/} keys %XML_SCHEMAS), '(?:', ')';
$NS_XSI_NILS = join join('|', map { my $class = $XML_SCHEMAS{$_} . '::Serializer'; "\{($_)-instance\}" . $class->nilValue
} grep {/XMLSchema/} keys %XML_SCHEMAS),
'(?:', ')';
# ApacheSOAP namespaces
$NS_APS = 'http://xml.apache.org/xml-soap';
# SOAP::Lite namespace
$NS_SL_HEADER = 'http://namespaces.soaplite.com/header';
$NS_SL_PERLTYPE = 'http://namespaces.soaplite.com/perl';
# default prefixes
$PREFIX_ENV = 'soap';
$PREFIX_ENC = 'soapenc';
# others
$DO_NOT_USE_XML_PARSER = 0;
$DO_NOT_CHECK_MUSTUNDERSTAND = 0;
$DO_NOT_USE_CHARSET = 0;
$DO_NOT_PROCESS_XML_IN_MIME = 0;
$DO_NOT_USE_LWP_LENGTH_HACK = 0;
$DO_NOT_CHECK_CONTENT_TYPE = 0;
$PATCH_HTTP_KEEPALIVE = 1;
$OBJS_BY_REF_KEEPALIVE = 600; # seconds
# TODO - use default packager constant somewhere
$DEFAULT_PACKAGER = "SOAP::Packager::MIME";
$DEFAULT_CACHE_TTL = 0;
1;
__END__
=pod
=head1 NAME
SOAP::Constants - SOAP::Lite provides several variables to allows programmers and users to modify the behavior of SOAP::Lite in specific ways.
=head1 DESCRIPTION
A number of "constant" values are provided by means of this namespace. The values aren't constants in the strictest sense; the purpose of the values detailed here is to allow the application to change them if it desires to alter the specific behavior governed.
=head1 CONSTANTS
=head2 $DO_NOT_USE_XML_PARSER
The SOAP::Lite package attempts to locate and use the L package, falling back on an internal, pure-Perl parser in its absence. This package is a fast parser, based on the Expat parser developed by James Clark. If the application sets this value to 1, there will be no attempt to locate or use XML::Parser. There are several reasons you might choose to do this. If the package will never be made available, there is no reason to perform the test. Setting this parameter is less time-consuming than the test for the package would be. Also, the XML::Parser code links against the Expat libraries for the C language. In some environments, this could cause a problem when mixed with other applications that may be linked against a different version of the same libraries. This was once the case with certain combinations of Apache, mod_perl and XML::Parser.
=head2 $DO_NOT_USE_CHARSET
Unless this parameter is set to 1, outgoing Content-Type headers will include specification of the character set used in encoding the message itself. Not all endpoints (client or server) may be able to properly deal with that data on the content header, however. If dealing with an endpoint that expects to do a more literal examination of the header as whole (as opposed to fully parsing it), this parameter may prove useful.
=head2 $DO_NOT_CHECK_CONTENT_TYPE
The content-type itself for a SOAP message is rather clearly defined, and in most cases, an application would have no reason to disable the testing of that header. This having been said, the content-type for SOAP 1.2 is still only a recommended draft, and badly coded endpoints might send valid messages with invalid Content-Type headers. While the "right" thing to do would be to reject such messages, that isn't always an option. Setting this parameter to 1 allows the toolkit to skip the content-type test.
=head2 $PATCH_HTTP_KEEPALIVE
SOAP::Lite's HTTP Transport module attempts to provide a simple patch to
LWP::Protocol to enable HTTP Keep Alive. By default, this patch is turned
off, if however you would like to turn on the experimental patch change the
constant like so:
$SOAP::Constants::PATCH_HTTP_KEEPALIVE = 1;
=head1 ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from I, mainly the SOAP::Lite reference found in Appendix B.
=head1 COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
=cut
SOAP-Lite-1.09/lib/SOAP/Data.pod 000644 000766 000024 00000023063 12200752752 017133 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2003 Paul Kulchenko (paulclinger@yahoo.com)
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
=pod
=head1 NAME
SOAP::Data - this class provides the means by which to explicitly manipulate and control all aspects of the way in which Perl data gets expressed as SOAP data entities.
=head1 DESCRIPTION
The SOAP::Data class provides the means by which to explicitly manipulate and control all aspects of the way in which Perl data gets expressed as SOAP data entities. Most of the methods are accessors, which like those in SOAP::Lite are designed to return the current value if no new one is passed, while returning the object reference otherwise (allowing for chained method calls). Note that most accessors (except value) accept a new value for the data object as a second argument.
=head1 METHODS
=over
=item new(optional key/value pairs)
$obj = SOAP::Data->new(name => 'idx', value => 5);
This is the class constructor. Almost all of the attributes related to the class may be passed to the constructor as key/value pairs. This method isn't often used directly because SOAP::Data objects are generally created for temporary use. It is available for those situations that require it.
=item name(new name, optional value)
$obj->name('index');
Gets or sets the current value of the name, as the object regards it. The name is what the serializer will use for the tag when generating the XML for this object. It is what will become the accessor for the data element. Optionally, the object's value may be updated if passed as a second argument.
=item type(new type, optional value)
$obj->type('int');
Gets or sets the type associated with the current value in the object. This is useful for those cases where the SOAP::Data object is used to explicitly specify the type of data that would otherwise be interpreted as a different type completely (such as perceiving the string 123 as an integer, instead). Allows the setting of the object's value, if passed as a second argument to the method.
=item uri(new uri, optional value)
$obj->uri('http://www.perl.com/SOAP');
Gets or sets the URI that will be used as the namespace for the resulting XML entity, if one is desired. This doesn't set the label for the namespace. If one isn't provided by means of the prefix method, one is generated automatically when needed. Also allows the setting of the object's value, if passed as a second argument to the method.
=item prefix(new prefix, optional value)
$obj->prefix('perl');
Provides the prefix, or label, for use when associating the data object with a specific namespace. Also allows the setting of the object's value, if passed as a second argument to the method.
=item attr(hash reference of attributes, optional value)
$obj->attr({ attr1 => 'value' });
Allows for the setting of arbitrary attributes on the data object. Keep in mind the requirement that any attributes not natively known to SOAP must be namespace-qualified. Also allows the setting of the object's value, if passed as a second argument to the method.
=item value(new value)
$obj->value(10);
Fetches the current value encapsulated by the object, or explicitly sets it.
=back
The last four methods are convenience shortcuts for the attributes that SOAP itself supports. Each also permits inclusion of a new value, as an optional second argument.
=over
=item actor(new actor, optional value)
$obj->actor($new_actor_name);
Gets or sets the value of the actor attribute; useful only when the object generates an entity for the message header.
=item mustUnderstand(boolean, optional value)
$obj->mustUnderstand(0);
Manipulates the mustUnderstand attribute, which tells the SOAP processor whether it is required to understand the entity in question.
=item encodingStyle(new encoding URN, optional value)
$obj->encodingStyle($soap_11_encoding);
This method is most likely to be used in places outside the header creation. Sets encodingStyle, which specifies an encoding that differs from the one that would otherwise be defaulted to.
=item root(boolean, optional value)
$obj->root(1);
When the application must explicitly specify which data element is to be regarded as the root element for the sake of generating the object model, this method provides the access to the root attribute.
=back
=head1 TYPE DETECTION
SOAP::Lite's serializer will detect the type of any scalar passed in as a SOAP::Data object's value. Because Perl is loosely typed, the serializer is only able to detect types based upon a predetermined set of regular expressions. Therefore, type detection is not always 100% accurate. In such a case you may need to explicitly set the type of the element being encoded. For example, by default the following code will be serialized as an integer:
$elem = SOAP::Data->name('idx')->value(5);
If, however, you need to serialize this into a long, then the following code will do so:
$elem = SOAP::Data->name('idx')->value(5)->type('long');
=head1 EXAMPLES
=head2 SIMPLE TYPES
The following example will all produce the same XML:
$elem1 = SOAP::Data->new(name => 'idx', value => 5);
$elem2 = SOAP::Data->name('idx' => 5);
$elem3 = SOAP::Data->name('idx')->value(5);
=head2 COMPLEX TYPES
A common question is how to do you created nested XML elements using SOAP::Lite. The following example demonstrates how:
SOAP::Data->name('foo' => \SOAP::Data->value(
SOAP::Data->name('bar' => '123')));
The above code will produce the following XML:
123
=head2 ARRAYS
The following code:
$elem1 = SOAP::Data->name('item' => 123)->type('SomeObject');
$elem2 = SOAP::Data->name('item' => 456)->type('SomeObject');
push(@array,$elem1);
push(@array,$elem2);
my $client = SOAP::Lite
->readable(1)
->uri($NS)
->proxy($HOST);
$temp_elements = SOAP::Data
->name("CallDetails" => \SOAP::Data->value(
SOAP::Data->name("elem1" => 'foo'),
SOAP::Data->name("elem2" => 'baz'),
SOAP::Data->name("someArray" => \SOAP::Data->value(
SOAP::Data->name("someArrayItem" => @array)
->type("SomeObject"))
)->type("ArrayOf_SomeObject") ))
->type("SomeObject");
$response = $client->someMethod($temp_elements);
Will produce the following XML:
foobaz123
456
In the code above, the @array variable can be an array of anything. If you pass
in an array of numbers, then SOAP::Lite will properly serialize that into such.
If however you need to encode an array of complex types, then simply pass in an
array of other SOAP::Data objects and you are all set.
=head2 COMPOSING MESSAGES USING RAW XML
In some circumstances you may need to encode a message using raw unserialized
XML text. To instantiate a SOAP::Data object using raw XML, do the following:
$xml_content = "123";
$elem = SOAP::Data->type('xml' => $xml_content);
SOAP::Lite's serializer simple takes whatever text is passed to it, and inserts
into the encoded SOAP::Data element I. The text input is NOT validated to
ensure it is valid XML, nor is the resulting SOAP::Data element validated to
ensure that it will produce valid XML. Therefore, it is incumbent upon the
developer to ensure that any XML data used in this fashion is valid and will
result in a valid XML document.
=head2 MULTIPLE NAMESPACES
When working with complex types it may be necessary to declare multiple namespaces. The following code demonstrates how to do so:
$elem = SOAP::Data->name("myElement" => "myValue")
->attr( { 'xmlns:foo2' => 'urn:Foo2',
'xmlns:foo3' => 'urn:Foo3' } );
This will produce the following XML:
myValue
=head1 SEE ALSO
L, L, L
=head1 ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from I, mainly the SOAP::Lite reference found in Appendix B.
=head1 COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
=cut
SOAP-Lite-1.09/lib/SOAP/Deserializer.pod 000644 000766 000024 00000003662 12200752752 020707 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2004 Paul Kulchenko (paulclinger@yahoo.com)
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
=pod
=head1 NAME
SOAP::Deserializer - the means by which the toolkit manages the conversion of XML into an object manageable by a developer
=head1 DESCRIPTION
SOAP::Deserializer provides the means by which incoming XML is decoded into a Perl data structure.
=head1 METHODS
=over
=item context
This provides access to the calling context of C. In a client side context the often means a reference to an instance of SOAP::Lite. In a server side context this means a reference to a SOAP::Server instance.
=back
=head1 EXAMPLES
=head2 DESERIALIZING RAW XML INTO A SOAP::SOM OBJECT
A useful utility for SOAP::Deserializer is for parsing raw XML documents or fragments into a SOAP::SOM object. SOAP::Lite developers use this technique to write unit tests for the SOAP::Lite module itself. It is a lot more efficient for testing aspects of the toolkit than generating client calls over the network. This is a perfect way for developers to write unit tests for their custom data types for example.
Here is an example of how raw XML content can be parsed into a SOAP::SOM object by using SOAP::Deserializer:
$xml = <123456789012
END_XML
my $som = SOAP::Deserializer->deserialize($xml);
=head1 COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Byrne Reese (byrne@majordojo.com)
=cut
SOAP-Lite-1.09/lib/SOAP/Fault.pod 000644 000766 000024 00000007365 12200752752 017344 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2003 Paul Kulchenko (paulclinger@yahoo.com)
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
=pod
=head1 NAME
SOAP::Fault - encapsulates SOAP faults prior to their serialization or after their deserialization
=head1 DESCRIPTION
This class encapsulates SOAP faults prior to their serialization or after their deserialization. The methods available are a constructor and four accessors. Each accessor creates an object on demand, just as the other classes do, when called as a static method. Like other accessors in the SOAP::Lite package, they return the object itself when setting the attribute.
=head1 GENERATING A SOAP FAULT
To generate a SOAP Fault simply issue a Perl die command on the server side as you might normally. The SOAP processor will intercept the die command and return a SOAP Fault, using the string passed to the die command as the faultstring, to the client making the call. If you require having more control over the SOAP Fault returned to the client, then simply pass a SOAP::Fault object to the die command and the SOAP processor will behave accordingly. For example:
die SOAP::Fault->faultcode('Server.Custom') # will be qualified
->faultstring('Died in server method')
->faultdetail(bless {code => 1} => 'BadError')
->faultactor('http://www.soaplite.com/custom');
=head1 METHODS
=over
=item new(optional data)
$fault = SOAP::Fault->new(faultcode => 'Server');
Explicitly creates a new SOAP::Fault object. Any of the four attributes represented next by accessor methods may be passed in the argument list with values immediately following their attribute name.
=item faultcode(optional value)
$fault->faultcode('MethodUnknown');
Returns the current fault code or sets it if a value is given.
=item faultstring(optional value)
$fault->faultstring("There is no $method here");
Returns or sets the fault string.
=item faultactor(optional value)
$fault->faultcode($header->actor);
Returns or sets the fault-actor element. Note that the actor isn't always required in a SOAP fault.
=item faultdetail(optional value)
$fault->faultcode(bless { proxy => $ip }, 'Err');
Returns or sets the fault's detail element. Like the actor, this isn't always a required element. Note that fault detail content in a message is represented as tag blocks. Thus, the values passed to this accessor when setting the value are either SOAP::Data objects, or more general blessed hash references.
=back
In addition to these methods, the SOAP::Fault package also provides detail as an alias for faultdetail. The former is the actual name of the element with SOAP faults, but the latter name is less ambiguous when regarded with the rest of the SOAP::Lite package. Objects of this class also have a special stringification enabled. If an object is printed or otherwise stringified, the value produced is faultcode: faultstring, with the attribute values of the object.
=head1 SEE ALSO
L, L, L
=head1 ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from I, mainly the SOAP::Lite reference found in Appendix B.
=head1 COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
=cut
SOAP-Lite-1.09/lib/SOAP/Header.pod 000644 000766 000024 00000002541 12200752752 017450 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2003 Paul Kulchenko (paulclinger@yahoo.com)
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
=pod
=head1 NAME
SOAP::Header - similar to SOAP::Data elements, a SOAP::Header object simply is encoded in the SOAP Header block
=head1 DESCRIPTION
Objects instantiated from the SOAP::Header class are functionally the same as SOAP::Data objects, and as such share all the methods from that class. The distinction may be cosmetic, but it is present so that applications may more easily distinguish header blocks from more generic data elements.
=head1 SEE ALSO
L
=head1 ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from I, mainly the SOAP::Lite reference found in Appendix B.
=head1 COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
=cut
SOAP-Lite-1.09/lib/SOAP/Lite/ 000755 000766 000024 00000000000 12265327263 016455 5 ustar 00fredmoyer staff 000000 000000 SOAP-Lite-1.09/lib/SOAP/Lite.pm 000644 000766 000024 00000547703 12265327250 017027 0 ustar 00fredmoyer staff 000000 000000 # ======================================================================
#
# Copyright (C) 2000-2005 Paul Kulchenko (paulclinger@yahoo.com)
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# ======================================================================
# Formatting hint:
# Target is the source code format laid out in Perl Best Practices (4 spaces
# indent, opening brace on condition line, no cuddled else).
#
# October 2007, Martin Kutter
package SOAP::Lite;
use strict;
use warnings;
our $VERSION = '1.09';
package SOAP::XMLSchemaApacheSOAP::Deserializer;
sub as_map {
my $self = shift;
return {
map {
my $hash = ($self->decode_object($_))[1];
($hash->{key} => $hash->{value})
} @{$_[3] || []}
};
}
sub as_Map; *as_Map = \&as_map;
# Thank to Kenneth Draper for this contribution
sub as_vector {
my $self = shift;
return [ map { scalar(($self->decode_object($_))[1]) } @{$_[3] || []} ];
}
sub as_Vector; *as_Vector = \&as_vector;
# ----------------------------------------------------------------------
package SOAP::XMLSchema::Serializer;
use vars qw(@ISA);
sub xmlschemaclass {
my $self = shift;
return $ISA[0] unless @_;
@ISA = (shift);
return $self;
}
# ----------------------------------------------------------------------
package SOAP::XMLSchema1999::Serializer;
use vars qw(@EXPORT $AUTOLOAD);
sub AUTOLOAD {
local($1,$2);
my($package, $method) = $AUTOLOAD =~ m/(?:(.+)::)([^:]+)$/;
return if $method eq 'DESTROY';
no strict 'refs';
my $export_var = $package . '::EXPORT';
my @export = @$export_var;
# Removed in 0.69 - this is a total hack. For some reason this is failing
# despite not being a fatal error condition.
# die "Type '$method' can't be found in a schema class '$package'\n"
# unless $method =~ s/^as_// && grep {$_ eq $method} @{$export_var};
# This was added in its place - it is still a hack, but it performs the
# necessary substitution. It just does not die.
if ($method =~ s/^as_// && grep {$_ eq $method} @{$export_var}) {
# print STDERR "method is now '$method'\n";
} else {
return;
}
$method =~ s/_/-/; # fix ur-type
*$AUTOLOAD = sub {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return [$name, {'xsi:type' => "xsd:$method", %$attr}, $value];
};
goto &$AUTOLOAD;
}
BEGIN {
@EXPORT = qw(ur_type
float double decimal timeDuration recurringDuration uriReference
integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger timeInstant time timePeriod date month year century
recurringDate recurringDay language
base64 hex string boolean
);
# TODO: replace by symbol table operations...
# predeclare subs, so ->can check will be positive
foreach (@EXPORT) { eval "sub as_$_" }
}
sub nilValue { 'null' }
sub anyTypeValue { 'ur-type' }
sub as_base64 {
my ($self, $value, $name, $type, $attr) = @_;
# Fixes #30271 for 5.8 and above.
# Won't fix for 5.6 and below - perl can't handle unicode before
# 5.8, and applying pack() to everything is just a slowdown.
if (eval "require Encode; 1") {
if (Encode::is_utf8($value)) {
if (Encode->can('_utf8_off')) { # the quick way, but it may change in future Perl versions.
Encode::_utf8_off($value);
}
else {
$value = pack('C*',unpack('C*',$value)); # the slow but safe way,
# but this fallback works always.
}
}
}
require MIME::Base64;
return [
$name,
{
'xsi:type' => SOAP::Utils::qualify($self->encprefix => 'base64'),
%$attr
},
MIME::Base64::encode_base64($value,'')
];
}
sub as_hex {
my ($self, $value, $name, $type, $attr) = @_;
return [
$name,
{
'xsi:type' => 'xsd:hex', %$attr
},
join '', map {
uc sprintf "%02x", ord
} split '', $value
];
}
sub as_long {
my($self, $value, $name, $type, $attr) = @_;
return [
$name,
{'xsi:type' => 'xsd:long', %$attr},
$value
];
}
sub as_dateTime {
my ($self, $value, $name, $type, $attr) = @_;
return [$name, {'xsi:type' => 'xsd:dateTime', %$attr}, $value];
}
sub as_string {
my ($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n"
if ref $value;
return [
$name,
{'xsi:type' => 'xsd:string', %$attr},
SOAP::Utils::encode_data($value)
];
}
sub as_anyURI {
my($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n" if ref $value;
return [
$name,
{'xsi:type' => 'xsd:anyURI', %$attr},
SOAP::Utils::encode_data($value)
];
}
sub as_undef { $_[1] ? '1' : '0' }
sub as_boolean {
my $self = shift;
my($value, $name, $type, $attr) = @_;
# fix [ 1.05279 ] Boolean serialization error
return [
$name,
{'xsi:type' => 'xsd:boolean', %$attr},
( $value && $value ne 'false' ) ? 'true' : 'false'
];
}
sub as_float {
my($self, $value, $name, $type, $attr) = @_;
return [
$name,
{'xsi:type' => 'xsd:float', %$attr},
$value
];
}
# ----------------------------------------------------------------------
package SOAP::XMLSchema2001::Serializer;
use vars qw(@EXPORT);
# no more warnings about "used only once"
*AUTOLOAD if 0;
*AUTOLOAD = \&SOAP::XMLSchema1999::Serializer::AUTOLOAD;
BEGIN {
@EXPORT = qw(anyType anySimpleType float double decimal dateTime
timePeriod gMonth gYearMonth gYear century
gMonthDay gDay duration recurringDuration anyURI
language integer nonPositiveInteger negativeInteger
long int short byte nonNegativeInteger unsignedLong
unsignedInt unsignedShort unsignedByte positiveInteger
date time string hex base64 boolean
QName
);
# Add QName to @EXPORT
# predeclare subs, so ->can check will be positive
foreach (@EXPORT) { eval "sub as_$_" }
}
sub nilValue { 'nil' }
sub anyTypeValue { 'anyType' }
sub as_long; *as_long = \&SOAP::XMLSchema1999::Serializer::as_long;
sub as_float; *as_float = \&SOAP::XMLSchema1999::Serializer::as_float;
sub as_string; *as_string = \&SOAP::XMLSchema1999::Serializer::as_string;
sub as_anyURI; *as_anyURI = \&SOAP::XMLSchema1999::Serializer::as_anyURI;
# TODO - QNames still don't work for 2001 schema!
sub as_QName; *as_QName = \&SOAP::XMLSchema1999::Serializer::as_string;
sub as_hex; *as_hex = \&as_hexBinary;
sub as_base64; *as_base64 = \&as_base64Binary;
sub as_timeInstant; *as_timeInstant = \&as_dateTime;
# only 0 and 1 allowed - that's easy...
sub as_undef {
$_[1]
? 'true'
: 'false'
}
sub as_hexBinary {
my ($self, $value, $name, $type, $attr) = @_;
return [
$name,
{'xsi:type' => 'xsd:hexBinary', %$attr},
join '', map {
uc sprintf "%02x", ord
} split '', $value
];
}
sub as_base64Binary {
my ($self, $value, $name, $type, $attr) = @_;
# Fixes #30271 for 5.8 and above.
# Won't fix for 5.6 and below - perl can't handle unicode before
# 5.8, and applying pack() to everything is just a slowdown.
if (eval "require Encode; 1") {
if (Encode::is_utf8($value)) {
if (Encode->can('_utf8_off')) { # the quick way, but it may change in future Perl versions.
Encode::_utf8_off($value);
}
else {
$value = pack('C*',unpack('C*',$value)); # the slow but safe way,
# but this fallback works always.
}
}
}
require MIME::Base64;
return [
$name,
{
'xsi:type' => 'xsd:base64Binary', %$attr
},
MIME::Base64::encode_base64($value,'')
];
}
sub as_boolean {
my ($self, $value, $name, $type, $attr) = @_;
# fix [ 1.05279 ] Boolean serialization error
return [
$name,
{
'xsi:type' => 'xsd:boolean', %$attr
},
( $value && ($value ne 'false') )
? 'true'
: 'false'
];
}
# ======================================================================
package SOAP::Utils;
sub qualify {
$_[1]
? $_[1] =~ /:/
? $_[1]
: join(':', $_[0] || (), $_[1])
: defined $_[1]
? $_[0]
: ''
}
sub overqualify (&$) {
for ($_[1]) {
&{$_[0]};
s/^:|:$//g
}
}
sub disqualify {
(my $qname = shift) =~ s/^($SOAP::Constants::NSMASK?)://;
return $qname;
}
sub splitqname {
local($1,$2);
$_[0] =~ /^(?:([^:]+):)?(.+)$/;
return ($1,$2)
}
sub longname {
defined $_[0]
? sprintf('{%s}%s', $_[0], $_[1])
: $_[1]
}
sub splitlongname {
local($1,$2);
$_[0] =~ /^(?:\{(.*)\})?(.+)$/;
return ($1,$2)
}
# Q: why only '&' and '<' are encoded, but not '>'?
# A: because it is not required according to XML spec.
#
# [http://www.w3.org/TR/REC-xml#syntax]
# The ampersand character (&) and the left angle bracket (<) may appear in
# their literal form only when used as markup delimiters, or within a comment,
# a processing instruction, or a CDATA section. If they are needed elsewhere,
# they must be escaped using either numeric character references or the
# strings "&" and "<" respectively. The right angle bracket (>) may be
# represented using the string ">", and must, for compatibility, be
# escaped using ">" or a character reference when it appears in the
# string "]]>" in content, when that string is not marking the end of a
# CDATA section.
my %encode_attribute = ('&' => '&', '>' => '>', '<' => '<', '"' => '"');
sub encode_attribute { (my $e = $_[0]) =~ s/([&<>\"])/$encode_attribute{$1}/g; $e }
my %encode_data = ('&' => '&', '>' => '>', '<' => '<', "\xd" => '
');
sub encode_data {
my $e = $_[0];
if ($e) {
$e =~ s/([&<>\015])/$encode_data{$1}/g;
$e =~ s/\]\]>/\]\]>/g;
}
$e
}
# methods for internal tree (SOAP::Deserializer, SOAP::SOM and SOAP::Serializer)
sub o_qname { $_[0]->[0] }
sub o_attr { $_[0]->[1] }
sub o_child { ref $_[0]->[2] ? $_[0]->[2] : undef }
sub o_chars { ref $_[0]->[2] ? undef : $_[0]->[2] }
# $_[0]->[3] is not used. Serializer stores object ID there
sub o_value { $_[0]->[4] }
sub o_lname { $_[0]->[5] }
sub o_lattr { $_[0]->[6] }
sub format_datetime {
my ($s,$m,$h,$D,$M,$Y) = (@_)[0,1,2,3,4,5];
my $time = sprintf("%04d-%02d-%02dT%02d:%02d:%02d",($Y+1900),($M+1),$D,$h,$m,$s);
return $time;
}
# make bytelength that calculates length in bytes regardless of utf/byte settings
# either we can do 'use bytes' or length will count bytes already
BEGIN {
sub bytelength;
*bytelength = eval('use bytes; 1') # 5.6.0 and later?
? sub { use bytes; length(@_ ? $_[0] : $_) }
: sub { length(@_ ? $_[0] : $_) };
}
# ======================================================================
package SOAP::Cloneable;
sub clone {
my $self = shift;
return unless ref $self && UNIVERSAL::isa($self => __PACKAGE__);
my $clone = bless {} => ref($self) || $self;
for (keys %$self) {
my $value = $self->{$_};
$clone->{$_} = ref $value && UNIVERSAL::isa($value => __PACKAGE__) ? $value->clone : $value;
}
return $clone;
}
# ======================================================================
package SOAP::Transport;
use vars qw($AUTOLOAD @ISA);
@ISA = qw(SOAP::Cloneable);
use Class::Inspector;
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
my $class = ref($self) || $self;
SOAP::Trace::objects('()');
return bless {} => $class;
}
sub proxy {
my $self = shift;
$self = $self->new() if not ref $self;
my $class = ref $self;
return $self->{_proxy} unless @_;
$_[0] =~ /^(\w+):/ or die "proxy: transport protocol not specified\n";
my $protocol = uc "$1"; # untainted now
# HTTPS is handled by HTTP class
$protocol =~s/^HTTPS$/HTTP/;
(my $protocol_class = "${class}::$protocol") =~ s/-/_/g;
no strict 'refs';
unless (Class::Inspector->loaded("$protocol_class\::Client")
&& UNIVERSAL::can("$protocol_class\::Client" => 'new')
) {
eval "require $protocol_class";
die "Unsupported protocol '$protocol'\n"
if $@ =~ m!^Can\'t locate SOAP/Transport/!;
die if $@;
}
$protocol_class .= "::Client";
return $self->{_proxy} = $protocol_class->new(endpoint => shift, @_);
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
no strict 'refs';
*$AUTOLOAD = sub { shift->proxy->$method(@_) };
goto &$AUTOLOAD;
}
# ======================================================================
package SOAP::Fault;
use Carp ();
use overload fallback => 1, '""' => "stringify";
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
unless (ref $self) {
my $class = $self;
$self = bless {} => $class;
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()"
if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my $method = shift;
$self->$method(shift)
if $self->can($method)
}
return $self;
}
sub stringify {
my $self = shift;
return join ': ', $self->faultcode, $self->faultstring;
}
sub BEGIN {
no strict 'refs';
for my $method (qw(faultcode faultstring faultactor faultdetail)) {
my $field = '_' . $method;
*$method = sub {
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new
: __PACKAGE__->new;
if (@_) {
$self->{$field} = shift;
return $self
}
return $self->{$field};
}
}
*detail = \&faultdetail;
}
# ======================================================================
package SOAP::Data;
use vars qw(@ISA @EXPORT_OK);
use Exporter;
use Carp ();
use SOAP::Lite::Deserializer::XMLSchemaSOAP1_2;
@ISA = qw(Exporter);
@EXPORT_OK = qw(name type attr value uri);
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
unless (ref $self) {
my $class = $self;
$self = bless {_attr => {}, _value => [], _signature => []} => $class;
SOAP::Trace::objects('()');
}
no strict qw(refs);
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
while (@_) {
my $method = shift;
$self->$method(shift) if $self->can($method)
}
return $self;
}
sub name {
my $self = ref $_[0] ? shift : UNIVERSAL::isa($_[0] => __PACKAGE__) ? shift->new : __PACKAGE__->new;
if (@_) {
my $name = shift;
my ($uri, $prefix); # predeclare, because can't declare in assign
if ($name) {
($uri, $name) = SOAP::Utils::splitlongname($name);
unless (defined $uri) {
($prefix, $name) = SOAP::Utils::splitqname($name);
$self->prefix($prefix) if defined $prefix;
} else {
$self->uri($uri);
}
}
$self->{_name} = $name;
$self->value(@_) if @_;
return $self;
}
return $self->{_name};
}
sub attr {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
if (@_) {
$self->{_attr} = shift;
return $self->value(@_) if @_;
return $self
}
return $self->{_attr};
}
sub type {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
if (@_) {
$self->{_type} = shift;
$self->value(@_) if @_;
return $self;
}
if (!defined $self->{_type} && (my @types = grep {/^\{$SOAP::Constants::NS_XSI_ALL}type$/o} keys %{$self->{_attr}})) {
$self->{_type} = (SOAP::Utils::splitlongname(delete $self->{_attr}->{shift(@types)}))[1];
}
return $self->{_type};
}
BEGIN {
no strict 'refs';
for my $method (qw(root mustUnderstand)) {
my $field = '_' . $method;
*$method = sub {
my $attr = $method eq 'root'
? "{$SOAP::Constants::NS_ENC}$method"
: "{$SOAP::Constants::NS_ENV}$method";
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new
: __PACKAGE__->new;
if (@_) {
$self->{_attr}->{$attr} = $self->{$field} = shift() ? 1 : 0;
$self->value(@_) if @_;
return $self;
}
$self->{$field} = SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->as_boolean($self->{_attr}->{$attr})
if !defined $self->{$field} && defined $self->{_attr}->{$attr};
return $self->{$field};
}
}
for my $method (qw(actor encodingStyle)) {
my $field = '_' . $method;
*$method = sub {
my $attr = "{$SOAP::Constants::NS_ENV}$method";
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
if (@_) {
$self->{_attr}->{$attr} = $self->{$field} = shift;
$self->value(@_) if @_;
return $self;
}
$self->{$field} = $self->{_attr}->{$attr}
if !defined $self->{$field} && defined $self->{_attr}->{$attr};
return $self->{$field};
}
}
}
sub prefix {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
return $self->{_prefix} unless @_;
$self->{_prefix} = shift;
if (scalar @_) {
return $self->value(@_);
}
return $self;
}
sub uri {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
return $self->{_uri} unless @_;
my $uri = $self->{_uri} = shift;
warn "Usage of '::' in URI ($uri) deprecated. Use '/' instead\n"
if defined $uri && $^W && $uri =~ /::/;
if (scalar @_) {
return $self->value(@_);
}
return $self;
}
sub set_value {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
$self->{_value} = [@_];
return $self;
}
sub value {
my $self = ref $_[0] ? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new;
if (@_) {
return $self->set_value(@_);
}
else {
return wantarray
? @{$self->{_value}}
: $self->{_value}->[0];
}
}
sub signature {
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
(@_)
? ($self->{_signature} = shift, return $self)
: (return $self->{_signature});
}
# ======================================================================
package SOAP::Header;
use vars qw(@ISA);
@ISA = qw(SOAP::Data);
# ======================================================================
package SOAP::Serializer;
use SOAP::Lite::Utils;
use Carp ();
use vars qw(@ISA);
@ISA = qw(SOAP::Cloneable SOAP::XMLSchema::Serializer);
BEGIN {
# namespaces and anonymous data structures
my $ns = 0;
my $name = 0;
my $prefix = 'c-';
sub gen_ns { 'namesp' . ++$ns }
sub gen_name { join '', $prefix, 'gensym', ++$name }
sub prefix { $prefix =~ s/^[^\-]+-/$_[1]-/; $_[0]; }
}
sub BEGIN {
no strict 'refs';
__PACKAGE__->__mk_accessors(qw(readable level seen autotype attr maptype
namespaces multirefinplace encoding signature on_nonserialized context
ns_uri ns_prefix use_default_ns));
for my $method (qw(method fault freeform)) { # aliases for envelope
*$method = sub { shift->envelope($method => @_) }
}
# Is this necessary? Seems like work for nothing when a user could just use
# SOAP::Utils directly.
# for my $method (qw(qualify overqualify disqualify)) { # import from SOAP::Utils
# *$method = \&{'SOAP::Utils::'.$method};
# }
}
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
my $class = $self;
$self = bless {
_level => 0,
_autotype => 1,
_readable => 0,
_ns_uri => '',
_ns_prefix => '',
_use_default_ns => 1,
_multirefinplace => 0,
_seen => {},
_encoding => 'UTF-8',
_objectstack => {},
_signature => [],
_maptype => {},
_on_nonserialized => sub {Carp::carp "Cannot marshall @{[ref shift]} reference" if $^W; return},
_encodingStyle => $SOAP::Constants::NS_ENC,
_attr => {
"{$SOAP::Constants::NS_ENV}encodingStyle" => $SOAP::Constants::NS_ENC,
},
_namespaces => {},
_soapversion => SOAP::Lite->soapversion,
} => $class;
$self->typelookup({
'base64Binary' =>
[10, sub {$_[0] =~ /[^\x09\x0a\x0d\x20-\x7f]/ }, 'as_base64Binary'],
'zerostring' =>
[12, sub { $_[0] =~ /^0\d+$/ }, 'as_string'],
# int (and actually long too) are subtle: the negative range is one greater...
'int' =>
[20, sub {$_[0] =~ /^([+-]?\d+)$/ && ($1 <= 2147483647) && ($1 >= -2147483648); }, 'as_int'],
'long' =>
[25, sub {$_[0] =~ /^([+-]?\d+)$/ && $1 <= 9223372036854775807;}, 'as_long'],
'float' =>
[30, sub {$_[0] =~ /^(-?(?:\d+(?:\.\d*)?|\.\d+|NaN|INF)|([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?)$/}, 'as_float'],
'gMonth' =>
[35, sub { $_[0] =~ /^--\d\d--(-\d\d:\d\d)?$/; }, 'as_gMonth'],
'gDay' =>
[40, sub { $_[0] =~ /^---\d\d(-\d\d:\d\d)?$/; }, 'as_gDay'],
'gYear' =>
[45, sub { $_[0] =~ /^-?\d\d\d\d(-\d\d:\d\d)?$/; }, 'as_gYear'],
'gMonthDay' =>
[50, sub { $_[0] =~ /^-\d\d-\d\d(-\d\d:\d\d)?$/; }, 'as_gMonthDay'],
'gYearMonth' =>
[55, sub { $_[0] =~ /^-?\d\d\d\d-\d\d(Z|([+-]\d\d:\d\d))?$/; }, 'as_gYearMonth'],
'date' =>
[60, sub { $_[0] =~ /^-?\d\d\d\d-\d\d-\d\d(Z|([+-]\d\d:\d\d))?$/; }, 'as_date'],
'time' =>
[70, sub { $_[0] =~ /^\d\d:\d\d:\d\d(\.\d\d\d)?(Z|([+-]\d\d:\d\d))?$/; }, 'as_time'],
'dateTime' =>
[75, sub { $_[0] =~ /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d\d\d)?(Z|([+-]\d\d:\d\d))?$/; }, 'as_dateTime'],
'duration' =>
[80, sub { $_[0] !~m{^-?PT?$} && $_[0] =~ m{^
-? # a optional - sign
P
(:? \d+Y )?
(:? \d+M )?
(:? \d+D )?
(:?
T(:?\d+H)?
(:?\d+M)?
(:?\d+S)?
)?
$
}x;
}, 'as_duration'],
'boolean' =>
[90, sub { $_[0] =~ /^(true|false)$/i; }, 'as_boolean'],
'anyURI' =>
[95, sub { $_[0] =~ /^(urn:|http:\/\/)/i; }, 'as_anyURI'],
'string' =>
[100, sub {1}, 'as_string'],
});
$self->register_ns($SOAP::Constants::NS_ENC,$SOAP::Constants::PREFIX_ENC);
$self->register_ns($SOAP::Constants::NS_ENV,$SOAP::Constants::PREFIX_ENV)
if $SOAP::Constants::PREFIX_ENV;
$self->xmlschema($SOAP::Constants::DEFAULT_XML_SCHEMA);
SOAP::Trace::objects('()');
no strict qw(refs);
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
while (@_) { my $method = shift; $self->$method(shift) if $self->can($method) }
return $self;
}
sub typelookup {
my ($self, $lookup) = @_;
if (defined $lookup) {
$self->{ _typelookup } = $lookup;
$self->{ _typelookup_order } = [ sort { $lookup->{$a}->[0] <=> $lookup->{$b}->[0] } keys %{ $lookup } ];
return $self;
}
return $self->{ _typelookup };
}
sub ns {
my $self = shift;
$self = $self->new() if not ref $self;
if (@_) {
my ($u,$p) = @_;
my $prefix;
if ($p) {
$prefix = $p;
}
elsif (!$p && !($prefix = $self->find_prefix($u))) {
$prefix = gen_ns;
}
$self->{'_ns_uri'} = $u;
$self->{'_ns_prefix'} = $prefix;
$self->{'_use_default_ns'} = 0;
# $self->register_ns($u,$prefix);
$self->{'_namespaces'}->{$u} = $prefix;
return $self;
}
return $self->{'_ns_uri'};
}
sub default_ns {
my $self = shift;
$self = $self->new() if not ref $self;
if (@_) {
my ($u) = @_;
$self->{'_ns_uri'} = $u;
$self->{'_ns_prefix'} = '';
$self->{'_use_default_ns'} = 1;
return $self;
}
return $self->{'_ns_uri'};
}
sub use_prefix {
my $self = shift;
$self = $self->new() if not ref $self;
warn 'use_prefix has been deprecated. if you wish to turn off or on the '
. 'use of a default namespace, then please use either ns(uri) or default_ns(uri)';
if (@_) {
my $use = shift;
$self->{'_use_default_ns'} = !$use || 0;
return $self;
} else {
return $self->{'_use_default_ns'};
}
}
sub uri {
my $self = shift;
$self = $self->new() if not ref $self;
# warn 'uri has been deprecated. if you wish to set the namespace for the request, then please use either ns(uri) or default_ns(uri)';
if (@_) {
my $ns = shift;
if ($self->{_use_default_ns}) {
$self->default_ns($ns);
}
else {
$self->ns($ns);
}
# $self->{'_ns_uri'} = $ns;
# $self->register_ns($self->{'_ns_uri'}) if (!$self->{_use_default_ns});
return $self;
}
return $self->{'_ns_uri'};
}
sub encodingStyle {
my $self = shift;
$self = $self->new() if not ref $self;
return $self->{'_encodingStyle'} unless @_;
my $cur_style = $self->{'_encodingStyle'};
delete($self->{'_namespaces'}->{$cur_style});
my $new_style = shift;
if ($new_style eq "") {
delete($self->{'_attr'}->{"{$SOAP::Constants::NS_ENV}encodingStyle"});
}
else {
$self->{'_attr'}->{"{$SOAP::Constants::NS_ENV}encodingStyle"} = $new_style;
$self->{'_namespaces'}->{$new_style} = $SOAP::Constants::PREFIX_ENC;
}
}
# TODO - changing SOAP version can affect previously set encodingStyle
sub soapversion {
my $self = shift;
return $self->{_soapversion} unless @_;
return $self if $self->{_soapversion} eq SOAP::Lite->soapversion;
$self->{_soapversion} = shift;
$self->attr({
"{$SOAP::Constants::NS_ENV}encodingStyle" => $SOAP::Constants::NS_ENC,
});
$self->namespaces({
$SOAP::Constants::NS_ENC => $SOAP::Constants::PREFIX_ENC,
$SOAP::Constants::PREFIX_ENV ? ($SOAP::Constants::NS_ENV => $SOAP::Constants::PREFIX_ENV) : (),
});
$self->xmlschema($SOAP::Constants::DEFAULT_XML_SCHEMA);
return $self;
}
sub xmlschema {
my $self = shift->new;
return $self->{_xmlschema} unless @_;
my @schema;
if ($_[0]) {
@schema = grep {/XMLSchema/ && /$_[0]/} keys %SOAP::Constants::XML_SCHEMAS;
Carp::croak "More than one schema match parameter '$_[0]': @{[join ', ', @schema]}" if @schema > 1;
Carp::croak "No schema match parameter '$_[0]'" if @schema != 1;
}
# do nothing if current schema is the same as new
# return $self if $self->{_xmlschema} && $self->{_xmlschema} eq $schema[0];
my $ns = $self->namespaces;
# delete current schema from namespaces
if (my $schema = $self->{_xmlschema}) {
delete $ns->{$schema};
delete $ns->{"$schema-instance"};
}
# add new schema into namespaces
if (my $schema = $self->{_xmlschema} = shift @schema) {
$ns->{$schema} = 'xsd';
$ns->{"$schema-instance"} = 'xsi';
}
# and here is the class serializer should work with
my $class = exists $SOAP::Constants::XML_SCHEMAS{$self->{_xmlschema}}
? $SOAP::Constants::XML_SCHEMAS{$self->{_xmlschema}} . '::Serializer'
: $self;
$self->xmlschemaclass($class);
return $self;
}
sub envprefix {
my $self = shift->new();
return $self->namespaces->{$SOAP::Constants::NS_ENV} unless @_;
$self->namespaces->{$SOAP::Constants::NS_ENV} = shift;
return $self;
}
sub encprefix {
my $self = shift->new();
return $self->namespaces->{$SOAP::Constants::NS_ENC} unless @_;
$self->namespaces->{$SOAP::Constants::NS_ENC} = shift;
return $self;
}
sub gen_id { sprintf "%U", $_[1] }
sub multiref_object {
my ($self, $object) = @_;
my $id = $self->gen_id($object);
if (! exists $self->{ _seen }->{ $id }) {
$self->{ _seen }->{ $id } = {
count => 1,
multiref => 0,
value => $object,
recursive => 0
};
}
else {
my $id_seen = $self->{ _seen }->{ $id };
$id_seen->{count}++;
$id_seen->{multiref} = 1;
$id_seen->{value} = $object;
$id_seen->{recursive} ||= 0;
}
return $id;
}
sub recursive_object {
my $self = shift;
$self->seen->{$self->gen_id(shift)}->{recursive} = 1;
}
sub is_href {
my $self = shift;
my $seen = $self->seen->{shift || return} or return;
return 1 if $seen->{id};
return $seen->{multiref}
&& !($seen->{id} = (shift
|| $seen->{recursive}
|| $seen->{multiref} && $self->multirefinplace));
}
sub multiref_anchor {
my ($self, $id) = @_;
no warnings qw(uninitialized);
if ($self->{ _seen }->{ $id }->{multiref}) {
return "ref-$id"
}
else {
return undef;
}
}
sub encode_multirefs {
my $self = shift;
return if $self->multirefinplace();
my $seen = $self->{ _seen };
map { $_->[1]->{_id} = 1; $_ }
map { $self->encode_object($seen->{$_}->{value}) }
grep { $seen->{$_}->{multiref} && !$seen->{$_}->{recursive} }
keys %$seen;
}
sub maptypetouri {
my($self, $type, $simple) = @_;
return $type unless defined $type;
my($prefix, $name) = SOAP::Utils::splitqname($type);
unless (defined $prefix) {
$name =~ s/__|\./::/g;
$self->maptype->{$name} = $simple
? die "Schema/namespace for type '$type' is not specified\n"
: $SOAP::Constants::NS_SL_PERLTYPE
unless exists $self->maptype->{$name};
$type = $self->maptype->{$name}
? SOAP::Utils::qualify($self->namespaces->{$self->maptype->{$name}} ||= gen_ns, $type)
: undef;
}
return $type;
}
sub encode_object {
my($self, $object, $name, $type, $attr) = @_;
$attr ||= {};
return $self->encode_scalar($object, $name, $type, $attr)
unless ref $object;
my $id = $self->multiref_object($object);
use vars '%objectstack'; # we'll play with symbol table
local %objectstack = %objectstack; # want to see objects ONLY in the current tree
# did we see this object in current tree? Seems to be recursive refs
# same as call to $self->recursive_object($object) - but
# recursive_object($object) has to re-compute the object's id
if (++$objectstack{ $id } > 1) {
$self->{ _seen }->{ $id }->{recursive} = 1
}
# return if we already saw it twice. It should be already properly serialized
return if $objectstack{$id} > 2;
if (UNIVERSAL::isa($object => 'SOAP::Data')) {
# use $object->SOAP::Data:: to enable overriding name() and others in inherited classes
$object->SOAP::Data::name($name)
unless defined $object->SOAP::Data::name;
# apply ->uri() and ->prefix() which can modify name and attributes of
# element, but do not modify SOAP::Data itself
my($name, $attr) = $self->fixattrs($object);
$attr = $self->attrstoqname($attr);
my @realvalues = $object->SOAP::Data::value;
return [$name || gen_name, $attr] unless @realvalues;
my $method = "as_" . ($object->SOAP::Data::type || '-'); # dummy type if not defined
# try to call method specified for this type
no strict qw(refs);
my @values = map {
# store null/nil attribute if value is undef
local $attr->{SOAP::Utils::qualify(xsi => $self->xmlschemaclass->nilValue)} = $self->xmlschemaclass->as_undef(1)
unless defined;
$self->can($method) && $self->$method($_, $name || gen_name, $object->SOAP::Data::type, $attr)
|| $self->typecast($_, $name || gen_name, $object->SOAP::Data::type, $attr)
|| $self->encode_object($_, $name, $object->SOAP::Data::type, $attr)
} @realvalues;
$object->SOAP::Data::signature([map {join $;, $_->[0], SOAP::Utils::disqualify($_->[1]->{'xsi:type'} || '')} @values]) if @values;
return wantarray ? @values : $values[0];
}
my $class = ref $object;
if ($class !~ /^(?:SCALAR|ARRAY|HASH|REF)$/o) {
# we could also check for CODE|GLOB|LVALUE, but we cannot serialize
# them anyway, so they'll be caught by check below
$class =~ s/::/__/g;
$name = $class if !defined $name;
$type = $class if !defined $type && $self->autotype;
my $method = 'as_' . $class;
if ($self->can($method)) {
no strict qw(refs);
my $encoded = $self->$method($object, $name, $type, $attr);
return $encoded if ref $encoded;
# return only if handled, otherwise handle with default handlers
}
}
if (UNIVERSAL::isa($object => 'REF') || UNIVERSAL::isa($object => 'SCALAR')) {
return $self->encode_scalar($object, $name, $type, $attr);
}
elsif (UNIVERSAL::isa($object => 'ARRAY')) {
# Added in SOAP::Lite 0.65_6 to fix an XMLRPC bug
return $self->encodingStyle eq ""
|| $self->isa('XMLRPC::Serializer')
? $self->encode_array($object, $name, $type, $attr)
: $self->encode_literal_array($object, $name, $type, $attr);
}
elsif (UNIVERSAL::isa($object => 'HASH')) {
return $self->encode_hash($object, $name, $type, $attr);
}
else {
return $self->on_nonserialized->($object);
}
}
sub encode_scalar {
my($self, $value, $name, $type, $attr) = @_;
$name ||= gen_name;
my $schemaclass = $self->xmlschemaclass;
# null reference
return [$name, {%$attr, SOAP::Utils::qualify(xsi => $schemaclass->nilValue) => $schemaclass->as_undef(1)}] unless defined $value;
# object reference
return [$name, {'xsi:type' => $self->maptypetouri($type), %$attr}, [$self->encode_object($$value)], $self->gen_id($value)] if ref $value;
# autodefined type
if ($self->{ _autotype}) {
my $lookup = $self->{_typelookup};
no strict qw(refs);
#for (sort {$lookup->{$a}->[0] <=> $lookup->{$b}->[0]} keys %$lookup) {
for (@{ $self->{ _typelookup_order } }) {
my $method = $lookup->{$_}->[2];
return $self->can($method) && $self->$method($value, $name, $type, $attr)
|| $method->($value, $name, $type, $attr)
if $lookup->{$_}->[1]->($value);
}
}
# invariant
return [$name, $attr, $value];
}
sub encode_array {
my ($self, $array, $name, $type, $attr) = @_;
my $items = 'item';
# If typing is disabled, just serialize each of the array items
# with no type information, each using the specified name,
# and do not create a wrapper array tag.
if (!$self->autotype) {
$name ||= gen_name;
return map {$self->encode_object($_, $name)} @$array;
}
# TODO: add support for multidimensional, partially transmitted and sparse arrays
my @items = map {$self->encode_object($_, $items)} @$array;
my $num = @items;
my($arraytype, %types) = '-';
for (@items) { $arraytype = $_->[1]->{'xsi:type'} || '-'; $types{$arraytype}++ }
$arraytype = sprintf "%s\[$num]", keys %types > 1 || $arraytype eq '-' ? SOAP::Utils::qualify(xsd => $self->xmlschemaclass->anyTypeValue) : $arraytype;
# $type = SOAP::Utils::qualify($self->encprefix => 'Array') if $self->autotype && !defined $type;
$type = qualify($self->encprefix => 'Array') if !defined $type;
return [$name || SOAP::Utils::qualify($self->encprefix => 'Array'),
{
SOAP::Utils::qualify($self->encprefix => 'arrayType') => $arraytype,
'xsi:type' => $self->maptypetouri($type), %$attr
},
[@items],
$self->gen_id($array)
];
}
# Will encode arrays using doc-literal style
sub encode_literal_array {
my($self, $array, $name, $type, $attr) = @_;
if ($self->autotype) {
my $items = 'item';
# TODO: add support for multidimensional, partially transmitted and sparse arrays
my @items = map {$self->encode_object($_, $items)} @$array;
my $num = @items;
my($arraytype, %types) = '-';
for (@items) {
$arraytype = $_->[1]->{'xsi:type'} || '-';
$types{$arraytype}++
}
$arraytype = sprintf "%s\[$num]", keys %types > 1 || $arraytype eq '-'
? SOAP::Utils::qualify(xsd => $self->xmlschemaclass->anyTypeValue)
: $arraytype;
$type = SOAP::Utils::qualify($self->encprefix => 'Array')
if !defined $type;
return [$name || SOAP::Utils::qualify($self->encprefix => 'Array'),
{
SOAP::Utils::qualify($self->encprefix => 'arrayType') => $arraytype,
'xsi:type' => $self->maptypetouri($type), %$attr
},
[ @items ],
$self->gen_id($array)
];
}
else {
#
# literal arrays are different - { array => [ 5,6 ] }
# results in 56
# This means that if there's a literal inside the array (not a
# reference), we have to encode it this way. If there's only
# nested tags, encode as
# 12
#
my $literal = undef;
my @items = map {
ref $_
? $self->encode_object($_)
: do {
$literal++;
$_
}
} @$array;
if ($literal) {
return map { [ $name , $attr , $_, $self->gen_id($array) ] } @items;
}
else {
return [$name || SOAP::Utils::qualify($self->encprefix => 'Array'),
$attr,
[ @items ],
$self->gen_id($array)
];
}
}
}
sub encode_hash {
my($self, $hash, $name, $type, $attr) = @_;
if ($self->autotype && grep {!/$SOAP::Constants::ELMASK/o} keys %$hash) {
warn qq!Cannot encode @{[$name ? "'$name'" : 'unnamed']} element as 'hash'. Will be encoded as 'map' instead\n! if $^W;
return $self->as_map($hash, $name || gen_name, $type, $attr);
}
$type = 'SOAPStruct'
if $self->autotype && !defined($type) && exists $self->maptype->{SOAPStruct};
return [$name || gen_name,
$self->autotype ? {'xsi:type' => $self->maptypetouri($type), %$attr} : { %$attr },
[map {$self->encode_object($hash->{$_}, $_)} keys %$hash],
$self->gen_id($hash)
];
}
sub as_ordered_hash {
my ($self, $value, $name, $type, $attr) = @_;
die "Not an ARRAY reference for 'ordered_hash' type" unless UNIVERSAL::isa($value => 'ARRAY');
return [ $name, $attr,
[map{$self->encode_object(@{$value}[2*$_+1,2*$_])} 0..$#$value/2 ],
$self->gen_id($value)
];
}
sub as_map {
my ($self, $value, $name, $type, $attr) = @_;
die "Not a HASH reference for 'map' type" unless UNIVERSAL::isa($value => 'HASH');
my $prefix = ($self->namespaces->{$SOAP::Constants::NS_APS} ||= 'apachens');
my @items = map {
$self->encode_object(
SOAP::Data->type(
ordered_hash => [
key => $_,
value => $value->{$_}
]
),
'item',
''
)} sort keys %$value;
return [
$name,
{'xsi:type' => "$prefix:Map", %$attr},
[@items],
$self->gen_id($value)
];
}
sub as_xml {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return [$name, {'_xml' => 1}, $value];
}
sub typecast {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return if ref $value; # skip complex object, caller knows how to deal with it
return if $self->autotype && !defined $type; # we don't know, autotype knows
return [$name,
{(defined $type && $type gt '' ? ('xsi:type' => $self->maptypetouri($type, 'simple type')) : ()), %$attr},
$value
];
}
sub register_ns {
my $self = shift->new();
my ($ns,$prefix) = @_;
$prefix = gen_ns if !$prefix;
$self->{'_namespaces'}->{$ns} = $prefix if $ns;
}
sub find_prefix {
my ($self, $ns) = @_;
return (exists $self->{'_namespaces'}->{$ns})
? $self->{'_namespaces'}->{$ns}
: ();
}
sub fixattrs {
my ($self, $data) = @_;
my ($name, $attr) = ($data->SOAP::Data::name, {%{$data->SOAP::Data::attr}});
my ($xmlns, $prefix) = ($data->uri, $data->prefix);
unless (defined($xmlns) || defined($prefix)) {
$self->register_ns($xmlns,$prefix) unless ($self->use_default_ns);
return ($name, $attr);
}
$name ||= gen_name(); # local name
$prefix = gen_ns() if !defined $prefix && $xmlns gt '';
$prefix = ''
if defined $xmlns && $xmlns eq ''
|| defined $prefix && $prefix eq '';
$attr->{join ':', xmlns => $prefix || ()} = $xmlns if defined $xmlns;
$name = join ':', $prefix, $name if $prefix;
$self->register_ns($xmlns,$prefix) unless ($self->use_default_ns);
return ($name, $attr);
}
sub toqname {
my $self = shift;
my $long = shift;
return $long unless $long =~ /^\{(.*)\}(.+)$/;
return SOAP::Utils::qualify $self->namespaces->{$1} ||= gen_ns, $2;
}
sub attrstoqname {
my $self = shift;
my $attrs = shift;
return {
map { /^\{(.*)\}(.+)$/
? ($self->toqname($_) => $2 eq 'type'
|| $2 eq 'arrayType'
? $self->toqname($attrs->{$_})
: $attrs->{$_})
: ($_ => $attrs->{$_})
} keys %$attrs
};
}
sub tag {
my ($self, $tag, $attrs, @values) = @_;
my $readable = $self->{ _readable };
my $value = join '', @values;
my $indent = $readable ? ' ' x (($self->{ _level }-1)*2) : '';
# check for special attribute
return "$indent$value" if exists $attrs->{_xml} && delete $attrs->{_xml};
die "Element '$tag' can't be allowed in valid XML message. Died."
if $tag !~ /^$SOAP::Constants::NSMASK$/o;
warn "Element '$tag' uses the reserved prefix 'XML' (in any case)"
if $tag !~ /^(?![Xx][Mm][Ll])/;
my $prolog = $readable ? "\n" : "";
my $epilog = $readable ? "\n" : "";
my $tagjoiner = " ";
if ($self->{ _level } == 1) {
my $namespaces = $self->namespaces;
foreach (keys %$namespaces) {
$attrs->{SOAP::Utils::qualify(xmlns => $namespaces->{$_})} = $_
}
$prolog = qq!encoding]}"?>!
if defined $self->encoding;
$prolog .= "\n" if $readable;
$tagjoiner = " \n".(' ' x 4 ) if $readable;
}
my $tagattrs = join($tagjoiner, '',
map { sprintf '%s="%s"', $_, SOAP::Utils::encode_attribute($attrs->{$_}) }
grep { $_ && defined $attrs->{$_} && ($_ ne 'xsi:type' || $attrs->{$_} ne '') }
sort keys %$attrs);
if ($value gt '') {
return sprintf("$prolog$indent<%s%s>%s%s$epilog",$tag,$tagattrs,$value,($value =~ /^\s*$epilog$indent",$tag,$tagattrs);
}
}
sub xmlize {
my $self = shift;
my($name, $attrs, $values, $id) = @{$_[0]};
$attrs ||= {};
local $self->{_level} = $self->{_level} + 1;
return $self->tag($name, $attrs)
unless defined $values;
return $self->tag($name, $attrs, $values)
unless ref $values eq "ARRAY";
return $self->tag($name, {%$attrs, href => '#'.$self->multiref_anchor($id)})
if $self->is_href($id, delete($attrs->{_id}));
# we have seen this element as a reference
if (defined $id && $self->{ _seen }->{ $id }->{ multiref}) {
return $self->tag($name,
{
%$attrs, id => $self->multiref_anchor($id)
},
map {$self->xmlize($_)} @$values
);
}
else {
return $self->tag($name, $attrs, map {$self->xmlize($_)} @$values);
}
}
sub uriformethod {
my $self = shift;
my $method_is_data = ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Data');
# drop prefix from method that could be string or SOAP::Data object
my($prefix, $method) = $method_is_data
? ($_[0]->prefix, $_[0]->name)
: SOAP::Utils::splitqname($_[0]);
my $attr = {reverse %{$self->namespaces}};
# try to define namespace that could be stored as
# a) method is SOAP::Data
# ? attribute in method's element as xmlns= or xmlns:${prefix}=
# : uri
# b) attribute in Envelope element as xmlns= or xmlns:${prefix}=
# c) no prefix or prefix equal serializer->envprefix
# ? '', but see comment below
# : die with error message
my $uri = $method_is_data
? ref $_[0]->attr && ($_[0]->attr->{$prefix ? "xmlns:$prefix" : 'xmlns'} || $_[0]->uri)
: $self->uri;
defined $uri or $uri = $attr->{$prefix || ''};
defined $uri or $uri = !$prefix || $prefix eq $self->envprefix
# still in doubts what should namespace be in this case
# but will keep it like this for now and be compatible with our server
? ( $method_is_data
&& $^W
&& warn("URI is not provided as an attribute for method ($method)\n"),
''
)
: die "Can't find namespace for method ($prefix:$method)\n";
return ($uri, $method);
}
sub serialize { SOAP::Trace::trace('()');
my $self = shift->new;
@_ == 1 or Carp::croak "serialize() method accepts one parameter";
$self->seen({}); # reinitialize multiref table
my($encoded) = $self->encode_object($_[0]);
# now encode multirefs if any
# v -------------- subelements of Envelope
push(@{$encoded->[2]}, $self->encode_multirefs) if ref $encoded->[2];
return $self->xmlize($encoded);
}
sub envelope {
SOAP::Trace::trace('()');
my $self = shift->new;
my $type = shift;
my(@parameters, @header);
for (@_) {
# Find all the SOAP Headers
if (defined($_) && ref($_) && UNIVERSAL::isa($_ => 'SOAP::Header')) {
push(@header, $_);
}
# Find all the SOAP Message Parts (attachments)
elsif (defined($_) && ref($_) && $self->context
&& $self->context->packager->is_supported_part($_)
) {
$self->context->packager->push_part($_);
}
# Find all the SOAP Body elements
else {
# proposed resolution for [ 1700326 ] encode_data called incorrectly in envelope
push(@parameters, $_);
# push (@parameters, SOAP::Utils::encode_data($_));
}
}
my $header = @header ? SOAP::Data->set_value(@header) : undef;
my($body,$parameters);
if ($type eq 'method' || $type eq 'response') {
SOAP::Trace::method(@parameters);
my $method = shift(@parameters);
# or die "Unspecified method for SOAP call\n";
$parameters = @parameters ? SOAP::Data->set_value(@parameters) : undef;
if (!defined($method)) {}
elsif (UNIVERSAL::isa($method => 'SOAP::Data')) {
$body = $method;
}
elsif ($self->use_default_ns) {
if ($self->{'_ns_uri'}) {
$body = SOAP::Data->name($method)
->attr({'xmlns' => $self->{'_ns_uri'} } );
}
else {
$body = SOAP::Data->name($method);
}
}
else {
# Commented out by Byrne on 1/4/2006 - to address default namespace problems
# $body = SOAP::Data->name($method)->uri($self->{'_ns_uri'});
# $body = $body->prefix($self->{'_ns_prefix'}) if ($self->{'_ns_prefix'});
# Added by Byrne on 1/4/2006 - to avoid the unnecessary creation of a new
# namespace
# Begin New Code (replaces code commented out above)
$body = SOAP::Data->name($method);
my $pre = $self->find_prefix($self->{'_ns_uri'});
$body = $body->prefix($pre) if ($self->{'_ns_prefix'});
# End new code
}
# This is breaking a unit test right now...
# proposed resolution for [ 1700326 ] encode_data called incorrectly in envelope
# $body->set_value(SOAP::Utils::encode_data($parameters ? \$parameters : ()))
# if $body;
# must call encode_data on nothing to enforce xsi:nil="true" to be set.
$body->set_value($parameters ? \$parameters : SOAP::Utils::encode_data()) if $body;
}
elsif ($type eq 'fault') {
SOAP::Trace::fault(@parameters);
# -> attr({'xmlns' => ''})
# Parameter order fixed thanks to Tom Fischer
$body = SOAP::Data-> name(SOAP::Utils::qualify($self->envprefix => 'Fault'))
-> value(\SOAP::Data->set_value(
SOAP::Data->name(faultcode => SOAP::Utils::qualify($self->envprefix => $parameters[0]))->type(""),
SOAP::Data->name(faultstring => SOAP::Utils::encode_data($parameters[1]))->type(""),
defined($parameters[3])
? SOAP::Data->name(faultactor => $parameters[3])->type("")
: (),
defined($parameters[2])
? SOAP::Data->name(detail => do{
my $detail = $parameters[2];
ref $detail
? \$detail
: SOAP::Utils::encode_data($detail)
})
: (),
));
}
elsif ($type eq 'freeform') {
SOAP::Trace::freeform(@parameters);
$body = SOAP::Data->set_value(@parameters);
}
elsif (!defined($type)) {
# This occurs when the Body is intended to be null. When no method has been
# passed in of any kind.
}
else {
die "Wrong type of envelope ($type) for SOAP call\n";
}
$self->{ _seen } = {}; # reinitialize multiref table
# Build the envelope
# Right now it is possible for $body to be a SOAP::Data element that has not
# XML escaped any values. How do you remedy this?
my($encoded) = $self->encode_object(
SOAP::Data->name(
SOAP::Utils::qualify($self->envprefix => 'Envelope') => \SOAP::Data->value(
($header
? SOAP::Data->name( SOAP::Utils::qualify($self->envprefix => 'Header') => \$header)
: ()
),
($body
? SOAP::Data->name(SOAP::Utils::qualify($self->envprefix => 'Body') => \$body)
: SOAP::Data->name(SOAP::Utils::qualify($self->envprefix => 'Body')) ),
)
)->attr($self->attr)
);
$self->signature($parameters->signature) if ref $parameters;
# IMHO multirefs should be encoded after Body, but only some
# toolkits understand this encoding, so we'll keep them for now (04/15/2001)
# as the last element inside the Body
# v -------------- subelements of Envelope
# vv -------- last of them (Body)
# v --- subelements
push(@{$encoded->[2]->[-1]->[2]}, $self->encode_multirefs) if ref $encoded->[2]->[-1]->[2];
# Sometimes SOAP::Serializer is invoked statically when there is no context.
# So first check to see if a context exists.
# TODO - a context needs to be initialized by a constructor?
if ($self->context && $self->context->packager->parts) {
# TODO - this needs to be called! Calling it though wraps the payload twice!
# return $self->context->packager->package($self->xmlize($encoded));
}
return $self->xmlize($encoded);
}
# ======================================================================
package SOAP::Parser;
sub DESTROY { SOAP::Trace::objects('()') }
sub xmlparser {
my $self = shift;
return eval {
$SOAP::Constants::DO_NOT_USE_XML_PARSER
? undef
: do {
require XML::Parser;
XML::Parser->new() }
}
|| eval { require XML::Parser::Lite; XML::Parser::Lite->new }
|| die "XML::Parser is not @{[$SOAP::Constants::DO_NOT_USE_XML_PARSER ? 'used' : 'available']} and ", $@;
}
sub parser {
my $self = shift->new;
# set the parser if passed
if (my $parser = shift) {
$self->{'_parser'} = shift;
return $self;
}
# else return the parser or use XML::Parser::Lite
return ($self->{'_parser'} ||= $self->xmlparser);
}
sub new {
my $self = shift;
return $self if ref $self;
my $class = $self;
SOAP::Trace::objects('()');
return bless {_parser => shift}, $class;
}
sub decode { SOAP::Trace::trace('()');
my $self = shift;
$self->parser->setHandlers(
Final => sub { shift; $self->final(@_) },
Start => sub { shift; $self->start(@_) },
End => sub { shift; $self->end(@_) },
Char => sub { shift; $self->char(@_) },
ExternEnt => sub { shift; die "External entity (pointing to '$_[1]') is not allowed" },
);
# my $parsed = $self->parser->parse($_[0]);
# return $parsed;
#
my $ret = undef;
eval {
$ret = $self->parser->parse($_[0]);
};
if ($@) {
$self->final; # Clean up in the event of an error
die $@; # Pass back the error
}
return $ret;
}
sub final {
my $self = shift;
# clean handlers, otherwise SOAP::Parser won't be deleted:
# it refers to XML::Parser which refers to subs from SOAP::Parser
# Thanks to Ryan Adams
# and Craig Johnston
# checked by number of tests in t/02-payload.t
undef $self->{_values};
$self->parser->setHandlers(
Final => undef,
Start => undef,
End => undef,
Char => undef,
ExternEnt => undef,
);
$self->{_done};
}
sub start { push @{shift->{_values}}, [shift, {@_}] }
# string concatenation changed to arrays which should improve performance
# for strings with many entity-encoded elements.
# Thanks to Mathieu Longtin
sub char { push @{shift->{_values}->[-1]->[3]}, shift }
sub end {
my $self = shift;
my $done = pop @{$self->{_values}};
$done->[2] = defined $done->[3]
? join('',@{$done->[3]})
: '' unless ref $done->[2];
undef $done->[3];
@{$self->{_values}}
? (push @{$self->{_values}->[-1]->[2]}, $done)
: ($self->{_done} = $done);
}
# ======================================================================
package SOAP::SOM;
use Carp ();
use SOAP::Lite::Utils;
sub BEGIN {
no strict 'refs';
my %path = (
root => '/',
envelope => '/Envelope',
body => '/Envelope/Body',
header => '/Envelope/Header',
headers => '/Envelope/Header/[>0]',
fault => '/Envelope/Body/Fault',
faultcode => '/Envelope/Body/Fault/faultcode',
faultstring => '/Envelope/Body/Fault/faultstring',
faultactor => '/Envelope/Body/Fault/faultactor',
faultdetail => '/Envelope/Body/Fault/detail',
);
for my $method (keys %path) {
*$method = sub {
my $self = shift;
ref $self or return $path{$method};
Carp::croak "Method '$method' is readonly and doesn't accept any parameters" if @_;
return $self->valueof($path{$method});
};
}
my %results = (
method => '/Envelope/Body/[1]',
result => '/Envelope/Body/[1]/[1]',
freeform => '/Envelope/Body/[>0]',
paramsin => '/Envelope/Body/[1]/[>0]',
paramsall => '/Envelope/Body/[1]/[>0]',
paramsout => '/Envelope/Body/[1]/[>1]'
);
for my $method (keys %results) {
*$method = sub {
my $self = shift;
ref $self or return $results{$method};
Carp::croak "Method '$method' is readonly and doesn't accept any parameters" if @_;
defined $self->fault ? return : return $self->valueof($results{$method});
};
}
for my $method (qw(o_child o_value o_lname o_lattr o_qname)) { # import from SOAP::Utils
*$method = \&{'SOAP::Utils::'.$method};
}
__PACKAGE__->__mk_accessors('context');
}
# use object in boolean context return true/false on last match
# Ex.: $som->match('//Fault') ? 'SOAP call failed' : 'success';
use overload fallback => 1, 'bool' => sub { @{shift->{_current}} > 0 };
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
my $class = ref($self) || $self;
my $content = shift;
SOAP::Trace::objects('()');
return bless { _content => $content, _current => [$content] } => $class;
}
sub parts {
my $self = shift;
if (@_) {
$self->context->packager->parts(@_);
return $self;
}
else {
return $self->context->packager->parts;
}
}
sub is_multipart {
my $self = shift;
return defined($self->parts);
}
sub current {
my $self = shift;
$self->{_current} = [@_], return $self if @_;
return wantarray ? @{$self->{_current}} : $self->{_current}->[0];
}
sub valueof {
my $self = shift;
local $self->{_current} = $self->{_current};
$self->match(shift) if @_;
return wantarray
? map {o_value($_)} @{$self->{_current}}
: @{$self->{_current}} ? o_value($self->{_current}->[0]) : undef;
}
sub headerof { # SOAP::Header is the same as SOAP::Data, so just rebless it
wantarray
? map { bless $_ => 'SOAP::Header' } shift->dataof(@_)
: do { # header returned by ->dataof can be undef in scalar context
my $header = shift->dataof(@_);
ref $header ? bless($header => 'SOAP::Header') : undef;
};
}
sub dataof {
my $self = shift;
local $self->{_current} = $self->{_current};
$self->match(shift) if @_;
return wantarray
? map {$self->_as_data($_)} @{$self->{_current}}
: @{$self->{_current}}
? $self->_as_data($self->{_current}->[0])
: undef;
}
sub namespaceuriof {
my $self = shift;
local $self->{_current} = $self->{_current};
$self->match(shift) if @_;
return wantarray
? map {(SOAP::Utils::splitlongname(o_lname($_)))[0]} @{$self->{_current}}
: @{$self->{_current}} ? (SOAP::Utils::splitlongname(o_lname($self->{_current}->[0])))[0] : undef;
}
#sub _as_data {
# my $self = shift;
# my $pointer = shift;
#
# SOAP::Data
# -> new(prefix => '', name => o_qname($pointer), name => o_lname($pointer), attr => o_lattr($pointer))
# -> set_value(o_value($pointer));
#}
sub _as_data {
my $self = shift;
my $node = shift;
my $data = SOAP::Data->new( prefix => '',
# name => o_qname has side effect: sets namespace !
name => o_qname($node),
name => o_lname($node),
attr => o_lattr($node) );
if ( defined o_child($node) ) {
my @children;
foreach my $child ( @{ o_child($node) } ) {
push( @children, $self->_as_data($child) );
}
$data->set_value( \SOAP::Data->value(@children) );
}
else {
$data->set_value( o_value($node) );
}
return $data;
}
sub match {
my $self = shift;
my $path = shift;
$self->{_current} = [
$path =~ s!^/!! || !@{$self->{_current}}
? $self->_traverse($self->{_content}, 1 => split '/' => $path)
: map {$self->_traverse_tree(o_child($_), split '/' => $path)} @{$self->{_current}}
];
return $self;
}
sub _traverse {
my ($self, $pointer, $itself, $path, @path) = @_;
die "Incorrect parameter" unless $itself =~/^\d+$/;
if ($path && substr($path, 0, 1) eq '{') {
$path = join '/', $path, shift @path while @path && $path !~ /}/;
}
my($op, $num) = $path =~ /^\[(<=|<|>=|>|=|!=?)?(\d+)\]$/ if defined $path;
return $pointer unless defined $path;
if (! $op) {
$op = '==';
}
elsif ($op eq '=' || $op eq '!') {
$op .= '=';
}
my $numok = defined $num && eval "$itself $op $num";
my $nameok = (o_lname($pointer) || '') =~ /(?:^|\})$path$/ if defined $path; # name can be with namespace
my $anynode = $path eq '';
unless ($anynode) {
if (@path) {
return if defined $num && !$numok || !defined $num && !$nameok;
}
else {
return $pointer if defined $num && $numok || !defined $num && $nameok;
return;
}
}
my @walk;
push @walk, $self->_traverse_tree([$pointer], @path) if $anynode;
push @walk, $self->_traverse_tree(o_child($pointer), $anynode ? ($path, @path) : @path);
return @walk;
}
sub _traverse_tree {
my ($self, $pointer, @path) = @_;
# can be list of children or value itself. Traverse only children
return unless ref $pointer eq 'ARRAY';
my $itself = 1;
grep {defined}
map {$self->_traverse($_, $itself++, @path)}
grep {!ref o_lattr($_) ||
!exists o_lattr($_)->{"{$SOAP::Constants::NS_ENC}root"} ||
o_lattr($_)->{"{$SOAP::Constants::NS_ENC}root"} ne '0'}
@$pointer;
}
# ======================================================================
package SOAP::Deserializer;
use vars qw(@ISA);
use SOAP::Lite::Utils;
use Class::Inspector;
use URI::Escape qw{uri_unescape};
@ISA = qw(SOAP::Cloneable);
sub DESTROY { SOAP::Trace::objects('()') }
sub BEGIN {
__PACKAGE__->__mk_accessors( qw(ids hrefs parts parser
base xmlschemas xmlschema context) );
}
# Cache (slow) Class::Inspector results
my %_class_loaded=();
sub new {
my $self = shift;
return $self if ref $self;
my $class = $self;
SOAP::Trace::objects('()');
return bless {
'_ids' => {},
'_hrefs' => {},
'_parser' => SOAP::Parser->new,
'_xmlschemas' => {
$SOAP::Constants::NS_APS => 'SOAP::XMLSchemaApacheSOAP::Deserializer',
# map {
# $_ => $SOAP::Constants::XML_SCHEMAS{$_} . '::Deserializer'
# } keys %SOAP::Constants::XML_SCHEMAS
map {
$_ => 'SOAP::Lite::Deserializer::' . $SOAP::Constants::XML_SCHEMA_OF{$_}
} keys %SOAP::Constants::XML_SCHEMA_OF
},
}, $class;
}
sub is_xml {
# Added check for envelope delivery. Fairly standard with MMDF and sendmail
# Thanks to Chris Davies
$_[1] =~ /^\s*new($location);
# make absolute location if relative
$location = $uri->abs($self->base || 'thismessage:/')->as_string unless $uri->scheme;
}
return $location;
}
# Returns the envelope and populates SOAP::Packager with parts
sub decode_parts {
my $self = shift;
my $env = $self->context->packager->unpackage($_[0],$self->context);
my $body = $self->parser->decode($env);
# TODO - This shouldn't be here! This is packager specific!
# However this does need to pull out all the cid's
# to populate ids hash with.
foreach (@{$self->context->packager->parts}) {
my $data = $_->bodyhandle->as_string;
my $type = $_->head->mime_attr('Content-Type');
my $location = $_->head->mime_attr('Content-Location');
my $id = $_->head->mime_attr('Content-Id');
$location = $self->baselocation($location);
my $part = lc($type) eq 'text/xml' && !$SOAP::Constants::DO_NOT_PROCESS_XML_IN_MIME
? $self->parser->decode($data)
: ['mimepart', {}, $data];
# This below looks like unnecessary bloat!!!
# I should probably dereference the mimepart, provide a callback to get the string data
$self->ids->{$1} = $part if ($id && $id =~ m/^<([^>]+)>$/); # strip any leading and trailing brackets
$self->ids->{$location} = $part if $location;
}
return $body;
}
# decode returns a parsed body in the form of an ARRAY
# each element of the ARRAY is a HASH, ARRAY or SCALAR
sub decode {
my $self = shift->new; # this actually is important
return $self->is_xml($_[0])
? $self->parser->decode($_[0])
: $self->decode_parts($_[0]);
}
# deserialize returns a SOAP::SOM object and parses straight
# text as input
sub deserialize {
SOAP::Trace::trace('()');
my $self = shift->new;
# initialize
$self->hrefs({});
$self->ids({});
# If the document is XML, then ids will be empty
# If the document is MIME, then ids will hold a list of cids
my $parsed = $self->decode($_[0]);
# Having this code here makes multirefs in the Body work, but multirefs
# that reference XML fragments in a MIME part do not work.
if (keys %{$self->ids()}) {
$self->traverse_ids($parsed);
}
else {
# delay - set ids to be traversed later in decode_object, they only get
# traversed if an href is found that is referencing an id.
$self->ids($parsed);
}
$self->decode_object($parsed);
my $som = SOAP::SOM->new($parsed);
$som->context($self->context); # TODO - try removing this and see if it works!
return $som;
}
sub traverse_ids {
my $self = shift;
my $ref = shift;
my($undef, $attrs, $children) = @$ref;
# ^^^^^^ to fix nasty error on Mac platform (Carl K. Cunningham)
$self->ids->{$attrs->{'id'}} = $ref if exists $attrs->{'id'};
return unless ref $children;
for (@$children) {
$self->traverse_ids($_)
};
}
use constant _ATTRS => 6;
use constant _NAME => 5;
sub decode_object {
my $self = shift;
my $ref = shift;
my($name, $attrs_ref, $children, $value) = @$ref;
my %attrs = %{ $attrs_ref };
$ref->[ _ATTRS ] = \%attrs; # make a copy for long attributes
use vars qw(%uris);
local %uris = (%uris, map {
do { (my $ns = $_) =~ s/^xmlns:?//; $ns } => delete $attrs{$_}
} grep {/^xmlns(:|$)/} keys %attrs);
foreach (keys %attrs) {
next unless m/^($SOAP::Constants::NSMASK?):($SOAP::Constants::NSMASK)$/;
$1 =~ /^[xX][mM][lL]/ ||
$uris{$1} &&
do {
$attrs{SOAP::Utils::longname($uris{$1}, $2)} = do {
my $value = $attrs{$_};
$2 ne 'type' && $2 ne 'arrayType'
? $value
: SOAP::Utils::longname($value =~ m/^($SOAP::Constants::NSMASK?):(${SOAP::Constants::NSMASK}(?:\[[\d,]*\])*)/
? ($uris{$1} || die("Unresolved prefix '$1' for attribute value '$value'\n"), $2)
: ($uris{''} || die("Unspecified namespace for type '$value'\n"), $value)
);
};
1;
}
|| die "Unresolved prefix '$1' for attribute '$_'\n";
}
# and now check the element
my $ns = ($name =~ s/^($SOAP::Constants::NSMASK?):// ? $1 : '');
$ref->[ _NAME ] = SOAP::Utils::longname(
$ns
? ($uris{$ns} || die "Unresolved prefix '$ns' for element '$name'\n")
: (defined $uris{''} ? $uris{''} : undef),
$name
);
($children, $value) = (undef, $children) unless ref $children;
return $name => ($ref->[4] = $self->decode_value(
[$ref->[ _NAME ], \%attrs, $children, $value]
));
}
sub decode_value {
my $self = shift;
my($name, $attrs, $children, $value) = @{ $_[0] };
# check SOAP version if applicable
use vars '$level'; local $level = $level || 0;
if (++$level == 1) {
my($namespace, $envelope) = SOAP::Utils::splitlongname($name);
SOAP::Lite->soapversion($namespace) if $envelope eq 'Envelope' && $namespace;
}
if (exists $attrs->{"{$SOAP::Constants::NS_ENV}encodingStyle"}) {
# check encodingStyle
# future versions may bind deserializer to encodingStyle
my $encodingStyle = $attrs->{"{$SOAP::Constants::NS_ENV}encodingStyle"};
# TODO - SOAP 1.2 and 1.1 have different rules about valid encodingStyle values
# For example, in 1.1 - any http://schemas.xmlsoap.org/soap/encoding/*
# value is valid
if (defined $encodingStyle && length($encodingStyle)) {
my %styles = map { $_ => undef } @SOAP::Constants::SUPPORTED_ENCODING_STYLES;
my $found = 0;
foreach my $e (split(/ +/,$encodingStyle)) {
if (exists $styles{$e}) {
$found ++;
}
}
die "Unrecognized/unsupported value of encodingStyle attribute '$encodingStyle'"
if (! $found) && !(SOAP::Lite->soapversion == 1.1 && $encodingStyle =~ /(?:^|\b)$SOAP::Constants::NS_ENC/);
}
}
use vars '$arraytype'; # type of Array element specified on Array itself
# either specified with xsi:type, or or array element
my ($type) = grep { defined }
map($attrs->{$_}, sort grep {/^\{$SOAP::Constants::NS_XSI_ALL\}type$/o} keys %$attrs),
$name =~ /^\{$SOAP::Constants::NS_ENC\}/ ? $name : $arraytype;
local $arraytype; # it's used only for one level, we don't need it anymore
# $name is not used here since type should be encoded as type, not as name
my ($schema, $class) = SOAP::Utils::splitlongname($type) if $type;
my $schemaclass = defined($schema) && $self->{ _xmlschemas }->{$schema}
|| $self;
if (! exists $_class_loaded{$schemaclass}) {
no strict qw(refs);
if (! Class::Inspector->loaded($schemaclass) ) {
eval "require $schemaclass" or die $@ if not ref $schemaclass;
}
$_class_loaded{$schemaclass} = undef;
}
# store schema that is used in parsed message
$self->{ _xmlschema } = $schema if ($schema) && $schema =~ /XMLSchema/;
# don't use class/type if anyType/ur-type is specified on wire
undef $class
if $schemaclass->can('anyTypeValue')
&& $schemaclass->anyTypeValue eq $class;
my $method = 'as_' . ($class || '-'); # dummy type if not defined
$class =~ s/__|\./::/g if $class;
my $id = $attrs->{id};
if (defined $id && exists $self->hrefs->{$id}) {
return $self->hrefs->{$id};
}
elsif (exists $attrs->{href}) {
(my $id = delete $attrs->{href}) =~ s/^(#|cid:|uuid:)?//;
my $type=$1;
$id=uri_unescape($id) if (defined($type) and $type eq 'cid:');
# convert to absolute if not internal '#' or 'cid:'
$id = $self->baselocation($id) unless $type;
return $self->hrefs->{$id} if exists $self->hrefs->{$id};
# First time optimization. we don't traverse IDs unless asked for it.
# This is where traversing id's is delayed from before
# - the first time through - ids should contain a copy of the parsed XML
# structure! seems silly to make so many copies
my $ids = $self->ids;
if (ref($ids) ne 'HASH') {
$self->ids({}); # reset list of ids first time through
$self->traverse_ids($ids);
}
if (exists($self->ids->{$id})) {
my $obj = ($self->decode_object(delete($self->ids->{$id})))[1];
return $self->hrefs->{$id} = $obj;
}
else {
die "Unresolved (wrong?) href ($id) in element '$name'\n";
}
}
return undef if grep {
/^$SOAP::Constants::NS_XSI_NILS$/ && do {
my $class = $self->xmlschemas->{ $1 || $2 };
eval "require $class" or die @$;;
$class->as_undef($attrs->{$_})
}
} keys %$attrs;
# try to handle with typecasting
my $res = $self->typecast($value, $name, $attrs, $children, $type);
return $res if defined $res;
# ok, continue with others
if (exists $attrs->{"{$SOAP::Constants::NS_ENC}arrayType"}) {
my $res = [];
$self->hrefs->{$id} = $res if defined $id;
# check for arrayType which could be [1], [,2][5] or []
# [,][1] will NOT be allowed right now (multidimensional sparse array)
my($type, $multisize) = $attrs->{"{$SOAP::Constants::NS_ENC}arrayType"}
=~ /^(.+)\[(\d*(?:,\d+)*)\](?:\[(?:\d+(?:,\d+)*)\])*$/
or die qq!Unrecognized/unsupported format of arrayType attribute '@{[$attrs->{"{$SOAP::Constants::NS_ENC}arrayType"}]}'\n!;
my @dimensions = map { $_ || undef } split /,/, $multisize;
my $size = 1;
foreach (@dimensions) { $size *= $_ || 0 }
# TODO УЄhm, shouldn't this local be my?
local $arraytype = $type;
# multidimensional
if ($multisize =~ /,/) {
@$res = splitarray(
[@dimensions],
[map { scalar(($self->decode_object($_))[1]) } @{$children || []}]
);
}
# normal
else {
@$res = map { scalar(($self->decode_object($_))[1]) } @{$children || []};
}
# sparse (position)
if (ref $children && exists SOAP::Utils::o_lattr($children->[0])->{"{$SOAP::Constants::NS_ENC}position"}) {
my @new;
for (my $pos = 0; $pos < @$children; $pos++) {
# TBD implement position in multidimensional array
my($position) = SOAP::Utils::o_lattr($children->[$pos])->{"{$SOAP::Constants::NS_ENC}position"} =~ /^\[(\d+)\]$/
or die "Position must be specified for all elements of sparse array\n";
$new[$position] = $res->[$pos];
}
@$res = @new;
}
# partially transmitted (offset)
# TBD implement offset in multidimensional array
my($offset) = $attrs->{"{$SOAP::Constants::NS_ENC}offset"} =~ /^\[(\d+)\]$/
if exists $attrs->{"{$SOAP::Constants::NS_ENC}offset"};
unshift(@$res, (undef) x $offset) if $offset;
die "Too many elements in array. @{[scalar@$res]} instead of claimed $multisize ($size)\n"
if $multisize && $size < @$res;
# extend the array if number of elements is specified
$#$res = $dimensions[0]-1 if defined $dimensions[0] && @$res < $dimensions[0];
return defined $class && $class ne 'Array' ? bless($res => $class) : $res;
}
elsif ($name =~ /^\{$SOAP::Constants::NS_ENC\}Struct$/
|| !$schemaclass->can($method)
&& (ref $children || defined $class && $value =~ /^\s*$/)) {
my $res = {};
$self->hrefs->{$id} = $res if defined $id;
# Patch code introduced in 0.65 - deserializes array properly
# Decode each element of the struct.
my %child_count_of = ();
foreach my $child (@{$children || []}) {
my ($child_name, $child_value) = $self->decode_object($child);
# Store the decoded element in the struct. If the element name is
# repeated, replace the previous scalar value with a new array
# containing both values.
if (not $child_count_of{$child_name}) {
# first time to see this value: use scalar
$res->{$child_name} = $child_value;
}
elsif ($child_count_of{$child_name} == 1) {
# second time to see this value: convert scalar to array
$res->{$child_name} = [ $res->{$child_name}, $child_value ];
}
else {
# already have an array: append to it
push @{$res->{$child_name}}, $child_value;
}
$child_count_of{$child_name}++;
}
# End patch code
return defined $class && $class ne 'SOAPStruct' ? bless($res => $class) : $res;
}
else {
my $res;
if (my $method_ref = $schemaclass->can($method)) {
$res = $method_ref->($self, $value, $name, $attrs, $children, $type);
}
else {
$res = $self->typecast($value, $name, $attrs, $children, $type);
$res = $class ? die "Unrecognized type '$type'\n" : $value
unless defined $res;
}
$self->hrefs->{$id} = $res if defined $id;
return $res;
}
}
sub splitarray {
my @sizes = @{+shift};
my $size = shift @sizes;
my $array = shift;
return splice(@$array, 0, $size) unless @sizes;
my @array = ();
push @array, [
splitarray([@sizes], $array)
] while @$array && (!defined $size || $size--);
return @array;
}
sub typecast { } # typecast is called for both objects AND scalar types
# check ref of the second parameter (first is the object)
# return undef if you don't want to handle it
# ======================================================================
package SOAP::Client;
use SOAP::Lite::Utils;
$VERSION = $SOAP::Lite::VERSION;
sub BEGIN {
__PACKAGE__->__mk_accessors(qw(endpoint code message
is_success status options));
}
# ======================================================================
package SOAP::Server::Object;
sub gen_id; *gen_id = \&SOAP::Serializer::gen_id;
my %alive;
my %objects;
sub objects_by_reference {
shift;
while (@_) {
@alive{shift()} = ref $_[0]
? shift
: sub {
$_[1]-$_[$_[5] ? 5 : 4] > $SOAP::Constants::OBJS_BY_REF_KEEPALIVE
}
}
keys %alive;
}
sub reference {
my $self = shift;
my $stamp = time;
my $object = shift;
my $id = $stamp . $self->gen_id($object);
# this is code for garbage collection
my $time = time;
my $type = ref $object;
my @objects = grep { $objects{$_}->[1] eq $type } keys %objects;
for (grep { $alive{$type}->(scalar @objects, $time, @{$objects{$_}}) } @objects) {
delete $objects{$_};
}
$objects{$id} = [$object, $type, $stamp];
bless { id => $id } => ref $object;
}
sub references {
my $self = shift;
return @_ unless %alive; # small optimization
return map {
ref($_) && exists $alive{ref $_}
? $self->reference($_)
: $_
} @_;
}
sub object {
my $self = shift;
my $class = ref($self) || $self;
my $object = shift;
return $object unless ref($object) && $alive{ref $object} && exists $object->{id};
my $reference = $objects{$object->{id}};
die "Object with specified id couldn't be found\n" unless ref $reference->[0];
$reference->[3] = time; # last access time
return $reference->[0]; # reference to actual object
}
sub objects {
my $self = shift;
return @_ unless %alive; # small optimization
return map {
ref($_) && exists $alive{ref $_} && exists $_->{id}
? $self->object($_)
: $_
} @_;
}
# ======================================================================
package SOAP::Server::Parameters;
sub byNameOrOrder {
unless (UNIVERSAL::isa($_[-1] => 'SOAP::SOM')) {
warn "Last parameter is expected to be envelope\n" if $^W;
pop;
return @_;
}
my $params = pop->method;
my @mandatory = ref $_[0] eq 'ARRAY'
? @{shift()}
: die "list of parameters expected as the first parameter for byName";
my $byname = 0;
my @res = map { $byname += exists $params->{$_}; $params->{$_} } @mandatory;
return $byname
? @res
: @_;
}
sub byName {
unless (UNIVERSAL::isa($_[-1] => 'SOAP::SOM')) {
warn "Last parameter is expected to be envelope\n" if $^W;
pop;
return @_;
}
return @{pop->method}{ref $_[0] eq 'ARRAY' ? @{shift()} : die "list of parameters expected as the first parameter for byName"};
}
# ======================================================================
package SOAP::Server;
use Carp ();
use Scalar::Util qw(weaken);
sub DESTROY { SOAP::Trace::objects('()') }
sub initialize {
return (
packager => SOAP::Packager::MIME->new,
transport => SOAP::Transport->new,
serializer => SOAP::Serializer->new,
deserializer => SOAP::Deserializer->new,
on_action => sub { ; },
on_dispatch => sub {
return;
},
);
}
sub new {
my $self = shift;
return $self if ref $self;
unless (ref $self) {
my $class = $self;
my(@params, @methods);
while (@_) {
my($method, $params) = splice(@_,0,2);
$class->can($method)
? push(@methods, $method, $params)
: $^W && Carp::carp "Unrecognized parameter '$method' in new()";
}
$self = bless {
_dispatch_to => [],
_dispatch_with => {},
_dispatched => [],
_action => '',
_options => {},
} => $class;
unshift(@methods, $self->initialize);
no strict qw(refs);
while (@methods) {
my($method, $params) = splice(@methods,0,2);
$self->$method(ref $params eq 'ARRAY' ? @$params : $params)
}
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()"
if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my($method, $params) = splice(@_,0,2);
$self->can($method)
? $self->$method(ref $params eq 'ARRAY' ? @$params : $params)
: $^W && Carp::carp "Unrecognized parameter '$method' in new()"
}
return $self;
}
sub init_context {
my $self = shift;
$self->{'_deserializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken($self->{'_deserializer'}->{'_context'});
$self->{'_serializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken($self->{'_serializer'}->{'_context'});
}
sub BEGIN {
no strict 'refs';
for my $method (qw(serializer deserializer transport)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new();
if (@_) {
my $context = $self->{$field}->{'_context'}; # save the old context
$self->{$field} = shift;
$self->{$field}->{'_context'} = $context; # restore the old context
return $self;
}
else {
return $self->{$field};
}
}
}
for my $method (qw(action myuri options dispatch_with packager)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new();
(@_)
? do {
$self->{$field} = shift;
return $self;
}
: return $self->{$field};
}
}
for my $method (qw(on_action on_dispatch)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
# my $self = shift;
return $self->{$field} unless @_;
local $@;
# commented out because that 'eval' was unsecure
# > ref $_[0] eq 'CODE' ? shift : eval shift;
# Am I paranoid enough?
$self->{$field} = shift;
Carp::croak $@ if $@;
Carp::croak "$method() expects subroutine (CODE) or string that evaluates into subroutine (CODE)"
unless ref $self->{$field} eq 'CODE';
return $self;
}
}
# __PACKAGE__->__mk_accessors( qw(dispatch_to) );
for my $method (qw(dispatch_to)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
# my $self = shift;
(@_)
? do {
$self->{$field} = [@_];
return $self;
}
: return @{ $self->{$field} };
}
}
}
sub objects_by_reference {
my $self = shift;
$self = $self->new() if not ref $self;
@_
? (SOAP::Server::Object->objects_by_reference(@_), return $self)
: SOAP::Server::Object->objects_by_reference;
}
sub dispatched {
my $self = shift;
$self = $self->new() if not ref $self;
@_
? (push(@{$self->{_dispatched}}, @_), return $self)
: return @{$self->{_dispatched}};
}
sub find_target {
my $self = shift;
my $request = shift;
# try to find URI/method from on_dispatch call first
my($method_uri, $method_name) = $self->on_dispatch->($request);
# if nothing there, then get it from envelope itself
$request->match((ref $request)->method);
($method_uri, $method_name) = ($request->namespaceuriof || '', $request->dataof->name)
unless $method_name;
$self->on_action->(my $action = $self->action, $method_uri, $method_name);
# check to avoid security vulnerability: Protected->Unprotected::method(@parameters)
# see for more details: http://www.phrack.org/phrack/58/p58-0x09
die "Denied access to method ($method_name)\n" unless $method_name =~ /^\w+$/;
my ($class, $static);
# try to bind directly
if (defined($class = $self->dispatch_with->{$method_uri}
|| $self->dispatch_with->{$action || ''}
|| (defined($action) && $action =~ /^"(.+)"$/
? $self->dispatch_with->{$1}
: undef))) {
# return object, nothing else to do here
return ($class, $method_uri, $method_name) if ref $class;
$static = 1;
}
else {
die "URI path shall map to class" unless defined ($class = URI->new($method_uri)->path);
for ($class) { s!^/|/$!!g; s!/!::!g; s/^$/main/; }
die "Failed to access class ($class)" unless $class =~ /^(\w[\w:]*)$/;
my $fullname = "$class\::$method_name";
foreach ($self->dispatch_to) {
return ($_, $method_uri, $method_name) if ref eq $class; # $OBJECT
next if ref; # skip other objects
# will ignore errors, because it may complain on
# d:\foo\bar, which is PATH and not regexp
eval {
$static ||= $class =~ /^$_$/ # MODULE
|| $fullname =~ /^$_$/ # MODULE::method
|| $method_name =~ /^$_$/ && ($class eq 'main'); # method ('main' assumed)
};
}
}
no strict 'refs';
# TODO - sort this mess out:
# The task is to test whether the class in question has already been loaded.
#
# SOAP::Lite 0.60:
# unless (defined %{"${class}::"}) {
# Patch to SOAP::Lite 0.60:
# The following patch does not work for packages defined within a BEGIN block
# unless (exists($INC{join '/', split /::/, $class.'.pm'})) {
# Combination of 0.60 and patch did not work reliably, either.
#
# Now we do the following: Check whether the class is main (always loaded)
# or the class implements the method in question
# or the package exists as file in %INC.
#
# This is still sort of a hack - but I don't know anything better
# If you have some idea, please help me out...
#
unless (($class eq 'main') || $class->can($method_name)
|| exists($INC{join '/', split /::/, $class . '.pm'})) {
# allow all for static and only specified path for dynamic bindings
local @INC = (($static ? @INC : ()), grep {!ref && m![/\\.]!} $self->dispatch_to());
eval 'local $^W; ' . "require $class";
die "Failed to access class ($class): $@" if $@;
$self->dispatched($class) unless $static;
}
die "Denied access to method ($method_name) in class ($class)"
unless $static || grep {/^$class$/} $self->dispatched;
return ($class, $method_uri, $method_name);
}
sub handle {
SOAP::Trace::trace('()');
my $self = shift;
$self = $self->new if !ref $self; # inits the server when called in a static context
$self->init_context();
# we want to restore it when we are done
local $SOAP::Constants::DEFAULT_XML_SCHEMA
= $SOAP::Constants::DEFAULT_XML_SCHEMA;
# SOAP version WILL NOT be restored when we are done.
# is it problem?
my $result = eval {
local $SIG{__DIE__};
# why is this here:
$self->serializer->soapversion(1.1);
my $request = eval { $self->deserializer->deserialize($_[0]) };
die SOAP::Fault
->faultcode($SOAP::Constants::FAULT_VERSION_MISMATCH)
->faultstring($@)
if $@ && $@ =~ /^$SOAP::Constants::WRONG_VERSION/;
die "Application failed during request deserialization: $@" if $@;
my $som = ref $request;
die "Can't find root element in the message"
unless $request->match($som->envelope);
$self->serializer->soapversion(SOAP::Lite->soapversion);
$self->serializer->xmlschema($SOAP::Constants::DEFAULT_XML_SCHEMA
= $self->deserializer->xmlschema)
if $self->deserializer->xmlschema;
die SOAP::Fault
->faultcode($SOAP::Constants::FAULT_MUST_UNDERSTAND)
->faultstring("Unrecognized header has mustUnderstand attribute set to 'true'")
if !$SOAP::Constants::DO_NOT_CHECK_MUSTUNDERSTAND &&
grep {
$_->mustUnderstand
&& (!$_->actor || $_->actor eq $SOAP::Constants::NEXT_ACTOR)
} $request->dataof($som->headers);
die "Can't find method element in the message"
unless $request->match($som->method);
# TODO - SOAP::Dispatcher plugs in here
# my $handler = $self->dispatcher->find_handler($request);
my($class, $method_uri, $method_name) = $self->find_target($request);
my @results = eval {
local $^W;
my @parameters = $request->paramsin;
# SOAP::Trace::dispatch($fullname);
SOAP::Trace::parameters(@parameters);
push @parameters, $request
if UNIVERSAL::isa($class => 'SOAP::Server::Parameters');
no strict qw(refs);
SOAP::Server::Object->references(
defined $parameters[0]
&& ref $parameters[0]
&& UNIVERSAL::isa($parameters[0] => $class)
? do {
my $object = shift @parameters;
SOAP::Server::Object->object(ref $class
? $class
: $object
)->$method_name(SOAP::Server::Object->objects(@parameters)),
# send object back as a header
# preserve name, specify URI
SOAP::Header
->uri($SOAP::Constants::NS_SL_HEADER => $object)
->name($request->dataof($som->method.'/[1]')->name)
} # end do block
# SOAP::Dispatcher will plug-in here as well
# $handler->dispatch(SOAP::Server::Object->objects(@parameters)
: $class->$method_name(SOAP::Server::Object->objects(@parameters)) );
}; # end eval block
SOAP::Trace::result(@results);
# let application errors pass through with 'Server' code
die ref $@
? $@
: $@ =~ /^Can\'t locate object method "$method_name"/
? "Failed to locate method ($method_name) in class ($class)"
: SOAP::Fault->faultcode($SOAP::Constants::FAULT_SERVER)->faultstring($@)
if $@;
my $result = $self->serializer
->prefix('s') # distinguish generated element names between client and server
->uri($method_uri)
->envelope(response => $method_name . 'Response', @results);
return $result;
};
# void context
return unless defined wantarray;
# normal result
return $result unless $@;
# check fails, something wrong with message
return $self->make_fault($SOAP::Constants::FAULT_CLIENT, $@) unless ref $@;
# died with SOAP::Fault
return $self->make_fault($@->faultcode || $SOAP::Constants::FAULT_SERVER,
$@->faultstring || 'Application error',
$@->faultdetail, $@->faultactor)
if UNIVERSAL::isa($@ => 'SOAP::Fault');
# died with complex detail
return $self->make_fault($SOAP::Constants::FAULT_SERVER, 'Application error' => $@);
} # end of handle()
sub make_fault {
my $self = shift;
my($code, $string, $detail, $actor) = @_;
$self->serializer->fault($code, $string, $detail, $actor || $self->myuri);
}
# ======================================================================
package SOAP::Trace;
use Carp ();
my @list = qw(
transport dispatch result
parameters headers objects
method fault freeform
trace debug);
{
no strict 'refs';
for (@list) {
*$_ = sub {}
}
}
sub defaultlog {
my $caller = (caller(1))[3]; # the 4th element returned by caller is the subroutine name
$caller = (caller(2))[3] if $caller =~ /eval/;
chomp(my $msg = join ' ', @_);
printf STDERR "%s: %s\n", $caller, $msg;
}
sub import {
no strict 'refs';
local $^W;
my $pack = shift;
my(@notrace, @symbols);
for (@_) {
if (ref eq 'CODE') {
my $call = $_;
foreach (@symbols) { *$_ = sub { $call->(@_) } }
@symbols = ();
}
else {
local $_ = $_;
my $minus = s/^-//;
my $all = $_ eq 'all';
Carp::carp "Illegal symbol for tracing ($_)" unless $all || $pack->can($_);
$minus ? push(@notrace, $all ? @list : $_) : push(@symbols, $all ? @list : $_);
}
}
no warnings qw{ redefine };
foreach (@symbols) { *$_ = \&defaultlog }
foreach (@notrace) { *$_ = sub {} }
}
# ======================================================================
package SOAP::Custom::XML::Data;
use vars qw(@ISA $AUTOLOAD);
@ISA = qw(SOAP::Data);
use overload fallback => 1, '""' => sub { shift->value };
sub _compileit {
no strict 'refs';
my $method = shift;
*$method = sub {
return __PACKAGE__->SUPER::name($method => $_[0]->attr->{$method})
if exists $_[0]->attr->{$method};
my @elems = grep {
ref $_ && UNIVERSAL::isa($_ => __PACKAGE__)
&& $_->SUPER::name =~ /(^|:)$method$/
} $_[0]->value;
return wantarray? @elems : $elems[0];
};
}
sub BEGIN { foreach (qw(name type import use)) { _compileit($_) } }
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
_compileit($method);
goto &$AUTOLOAD;
}
# ======================================================================
package SOAP::Custom::XML::Deserializer;
use vars qw(@ISA);
@ISA = qw(SOAP::Deserializer);
sub decode_value {
my $self = shift;
my $ref = shift;
my($name, $attrs, $children, $value) = @$ref;
# base class knows what to do with it
return $self->SUPER::decode_value($ref) if exists $attrs->{href};
SOAP::Custom::XML::Data
-> SOAP::Data::name($name)
-> attr($attrs)
-> set_value(ref $children && @$children
? map(scalar(($self->decode_object($_))[1]), @$children)
: $value);
}
# ======================================================================
package SOAP::Schema::Deserializer;
use vars qw(@ISA);
@ISA = qw(SOAP::Custom::XML::Deserializer);
# ======================================================================
package SOAP::Schema::WSDL;
use vars qw(%imported @ISA);
@ISA = qw(SOAP::Schema);
sub new {
my $self = shift;
unless (ref $self) {
my $class = $self;
$self = $class->SUPER::new(@_);
}
return $self;
}
sub base {
my $self = shift->new;
@_
? ($self->{_base} = shift, return $self)
: return $self->{_base};
}
sub import {
my $self = shift->new;
my $s = shift;
my $base = shift || $self->base || die "Missing base argument for ", __PACKAGE__, "\n";
my @a = $s->import;
local %imported = %imported;
foreach (@a) {
next unless $_->location;
my $location = URI->new_abs($_->location->value, $base)->as_string;
if ($imported{$location}++) {
warn "Recursion loop detected in service description from '$location'. Ignored\n" if $^W;
return $s;
}
my $root = $self->import(
$self->deserializer->deserialize(
$self->access($location)
)->root, $location);
$root->SOAP::Data::name eq 'definitions' ? $s->set_value($s->value, $root->value) :
$root->SOAP::Data::name eq 'schema' ? do { # add element if there is no one
$s->set_value($s->value, $self->deserializer->deserialize('')->root) unless $s->types;
$s->types->set_value($s->types->value, $root) } :
die "Don't know what to do with '@{[$root->SOAP::Data::name]}' in schema imported from '$location'\n";
}
# return the parsed WSDL file
$s;
}
# TODO - This is woefully incomplete!
sub parse_schema_element {
my $element = shift;
# Current element is a complex type
if (defined($element->complexType)) {
my @elements = ();
if (defined($element->complexType->sequence)) {
foreach my $e ($element->complexType->sequence->element) {
push @elements,parse_schema_element($e);
}
}
return @elements;
}
elsif ($element->simpleType) {
}
else {
return $element;
}
}
sub parse {
my $self = shift->new;
my($s, $service, $port) = @_;
my @result;
# handle imports
$self->import($s);
# handle descriptions without , aka tModel-type descriptions
my @services = $s->service;
my $tns = $s->{'_attr'}->{'targetNamespace'};
# if there is no element we'll provide it
@services = $self->deserializer->deserialize(<<"FAKE")->root->service unless @services;
FAKE
my $has_warned = 0;
foreach (@services) {
my $name = $_->name;
next if $service && $service ne $name;
my %services;
foreach ($_->port) {
next if $port && $port ne $_->name;
my $binding = SOAP::Utils::disqualify($_->binding);
my $endpoint = ref $_->address ? $_->address->location : undef;
foreach ($s->binding) {
# is this a SOAP binding?
next unless grep { $_->uri eq 'http://schemas.xmlsoap.org/wsdl/soap/' } $_->binding;
next unless $_->name eq $binding;
my $default_style = $_->binding->style;
my $porttype = SOAP::Utils::disqualify($_->type);
foreach ($_->operation) {
my $opername = $_->name;
$services{$opername} = {}; # should be initialized in 5.7 and after
my $soapaction = $_->operation->soapAction;
my $invocationStyle = $_->operation->style || $default_style || "rpc";
my $encodingStyle = $_->input->body->use || "encoded";
my $namespace = $_->input->body->namespace || $tns;
my @parts;
foreach ($s->portType) {
next unless $_->name eq $porttype;
foreach ($_->operation) {
next unless $_->name eq $opername;
my $inputmessage = SOAP::Utils::disqualify($_->input->message);
foreach my $msg ($s->message) {
next unless $msg->name eq $inputmessage;
if ($invocationStyle eq "document" && $encodingStyle eq "literal") {
# warn "document/literal support is EXPERIMENTAL in SOAP::Lite"
# if !$has_warned && ($has_warned = 1);
my ($input_ns,$input_name) = SOAP::Utils::splitqname($msg->part->element);
foreach my $schema ($s->types->schema) {
foreach my $element ($schema->element) {
next unless $element->name eq $input_name;
push @parts,parse_schema_element($element);
}
$services{$opername}->{parameters} = [ @parts ];
}
}
else {
# TODO - support all combinations of doc|rpc/lit|enc.
#warn "$invocationStyle/$encodingStyle is not supported in this version of SOAP::Lite";
@parts = $msg->part;
$services{$opername}->{parameters} = [ @parts ];
}
}
}
for ($services{$opername}) {
$_->{endpoint} = $endpoint;
$_->{soapaction} = $soapaction;
$_->{namespace} = $namespace;
# $_->{parameters} = [@parts];
}
}
}
}
}
# fix nonallowed characters in package name, and add 's' if started with digit
for ($name) { s/\W+/_/g; s/^(\d)/s$1/ }
push @result, $name => \%services;
}
return @result;
}
# ======================================================================
# Naming? SOAP::Service::Schema?
package SOAP::Schema;
use Carp ();
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
unless (ref $self) {
my $class = $self;
require LWP::UserAgent;
$self = bless {
'_deserializer' => SOAP::Schema::Deserializer->new,
'_useragent' => LWP::UserAgent->new,
}, $class;
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my $method = shift;
$self->$method(shift) if $self->can($method)
}
return $self;
}
sub schema {
warn "SOAP::Schema->schema has been deprecated. "
. "Please use SOAP::Schema->schema_url instead.";
return shift->schema_url(@_);
}
sub BEGIN {
no strict 'refs';
for my $method (qw(deserializer schema_url services useragent stub cache_dir cache_ttl)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
@_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
}
}
}
sub parse {
my $self = shift;
my $s = $self->deserializer->deserialize($self->access)->root;
# here should be something that defines what schema description we want to use
$self->services({SOAP::Schema::WSDL->base($self->schema_url)->parse($s, @_)});
}
sub refresh_cache {
my $self = shift;
my ($filename,$contents) = @_;
open CACHE,">$filename" or Carp::croak "Could not open cache file for writing: $!";
print CACHE $contents;
close CACHE;
}
sub load {
my $self = shift->new;
local $^W; # suppress warnings about redefining
foreach (keys %{$self->services || Carp::croak 'Nothing to load. Schema is not specified'}) {
# TODO - check age of cached file, and delete if older than configured amount
if ($self->cache_dir) {
my $cached_file = File::Spec->catfile($self->cache_dir,$_.".pm");
my $ttl = $self->cache_ttl || $SOAP::Constants::DEFAULT_CACHE_TTL;
open (CACHE, "<$cached_file");
my @stat = stat($cached_file) unless eof(CACHE);
close CACHE;
if (@stat) {
# Cache exists
my $cache_lived = time() - $stat[9];
if ($ttl > 0 && $cache_lived > $ttl) {
$self->refresh_cache($cached_file,$self->generate_stub($_));
}
}
else {
# Cache doesn't exist
$self->refresh_cache($cached_file,$self->generate_stub($_));
}
push @INC,$self->cache_dir;
eval "require $_" or Carp::croak "Could not load cached file: $@";
}
else {
eval $self->generate_stub($_) or Carp::croak "Bad stub: $@";
}
}
$self;
}
sub access {
my $self = shift->new;
my $url = shift || $self->schema_url || Carp::croak 'Nothing to access. URL is not specified';
$self->useragent->env_proxy if $ENV{'HTTP_proxy'};
my $req = HTTP::Request->new(GET => $url);
$req->proxy_authorization_basic($ENV{'HTTP_proxy_user'}, $ENV{'HTTP_proxy_pass'})
if ($ENV{'HTTP_proxy_user'} && $ENV{'HTTP_proxy_pass'});
my $resp = $self->useragent->request($req);
$resp->is_success ? $resp->content : die "Service description '$url' can't be loaded: ", $resp->status_line, "\n";
}
sub generate_stub {
my $self = shift->new;
my $package = shift;
my $services = $self->services->{$package};
my $schema_url = $self->schema_url;
$self->{'_stub'} = <<"EOP";
package $package;
# Generated by SOAP::Lite (v$SOAP::Lite::VERSION) for Perl -- soaplite.com
# Copyright (C) 2000-2006 Paul Kulchenko, Byrne Reese
# -- generated at [@{[scalar localtime]}]
EOP
$self->{'_stub'} .= "# -- generated from $schema_url\n" if $schema_url;
$self->{'_stub'} .= 'my %methods = ('."\n";
foreach my $service (keys %$services) {
$self->{'_stub'} .= "'$service' => {\n";
foreach (qw(endpoint soapaction namespace)) {
$self->{'_stub'} .= " $_ => '".$services->{$service}{$_}."',\n";
}
$self->{'_stub'} .= " parameters => [\n";
foreach (@{$services->{$service}{parameters}}) {
# This is a workaround for https://sourceforge.net/tracker/index.php?func=detail&aid=2001592&group_id=66000&atid=513017
next unless ref $_;
$self->{'_stub'} .= " SOAP::Data->new(name => '".$_->name."', type => '".$_->type."', attr => {";
$self->{'_stub'} .= do {
my %attr = %{$_->attr};
join(', ', map {"'$_' => '$attr{$_}'"}
grep {/^xmlns:(?!-)/}
keys %attr);
};
$self->{'_stub'} .= "}),\n";
}
$self->{'_stub'} .= " ], # end parameters\n";
$self->{'_stub'} .= " }, # end $service\n";
}
$self->{'_stub'} .= "); # end my %methods\n";
$self->{'_stub'} .= <<'EOP';
use SOAP::Lite;
use Exporter;
use Carp ();
use vars qw(@ISA $AUTOLOAD @EXPORT_OK %EXPORT_TAGS);
@ISA = qw(Exporter SOAP::Lite);
@EXPORT_OK = (keys %methods);
%EXPORT_TAGS = ('all' => [@EXPORT_OK]);
sub _call {
my ($self, $method) = (shift, shift);
my $name = UNIVERSAL::isa($method => 'SOAP::Data') ? $method->name : $method;
my %method = %{$methods{$name}};
$self->proxy($method{endpoint} || Carp::croak "No server address (proxy) specified")
unless $self->proxy;
my @templates = @{$method{parameters}};
my @parameters = ();
foreach my $param (@_) {
if (@templates) {
my $template = shift @templates;
my ($prefix,$typename) = SOAP::Utils::splitqname($template->type);
my $method = 'as_'.$typename;
# TODO - if can('as_'.$typename) {...}
my $result = $self->serializer->$method($param, $template->name, $template->type, $template->attr);
push(@parameters, $template->value($result->[2]));
}
else {
push(@parameters, $param);
}
}
$self->endpoint($method{endpoint})
->ns($method{namespace})
->on_action(sub{qq!"$method{soapaction}"!});
EOP
my $namespaces = $self->deserializer->ids->[1];
foreach my $key (keys %{$namespaces}) {
my ($ns,$prefix) = SOAP::Utils::splitqname($key);
$self->{'_stub'} .= ' $self->serializer->register_ns("'.$namespaces->{$key}.'","'.$prefix.'");'."\n"
if (defined $ns && ($ns eq "xmlns"));
}
$self->{'_stub'} .= <<'EOP';
my $som = $self->SUPER::call($method => @parameters);
if ($self->want_som) {
return $som;
}
UNIVERSAL::isa($som => 'SOAP::SOM') ? wantarray ? $som->paramsall : $som->result : $som;
}
sub BEGIN {
no strict 'refs';
for my $method (qw(want_som)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
@_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
}
}
}
no strict 'refs';
for my $method (@EXPORT_OK) {
my %method = %{$methods{$method}};
*$method = sub {
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? ref $_[0]
? shift # OBJECT
# CLASS, either get self or create new and assign to self
: (shift->self || __PACKAGE__->self(__PACKAGE__->new))
# function call, either get self or create new and assign to self
: (__PACKAGE__->self || __PACKAGE__->self(__PACKAGE__->new));
$self->_call($method, @_);
}
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY' || $method eq 'want_som';
die "Unrecognized method '$method'. List of available method(s): @EXPORT_OK\n";
}
1;
EOP
return $self->stub;
}
# ======================================================================
package SOAP;
use vars qw($AUTOLOAD);
require URI;
my $soap; # shared between SOAP and SOAP::Lite packages
{
no strict 'refs';
*AUTOLOAD = sub {
local($1,$2);
my($package, $method) = $AUTOLOAD =~ m/(?:(.+)::)([^:]+)$/;
return if $method eq 'DESTROY';
my $soap = ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Lite')
? $_[0]
: $soap
|| die "SOAP:: prefix shall only be used in combination with +autodispatch option\n";
my $uri = URI->new($soap->uri);
my $currenturi = $uri->path;
$package = ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Lite')
? $currenturi
: $package eq 'SOAP'
? ref $_[0] || ($_[0] eq 'SOAP'
? $currenturi || Carp::croak "URI is not specified for method call"
: $_[0])
: $package eq 'main'
? $currenturi || $package
: $package;
# drop first parameter if it's a class name
{
my $pack = $package;
for ($pack) { s!^/!!; s!/!::!g; }
shift @_ if @_ && !ref $_[0] && ($_[0] eq $pack || $_[0] eq 'SOAP')
|| ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Lite');
}
for ($package) { s!::!/!g; s!^/?!/!; }
$uri->path($package);
my $som = $soap->uri($uri->as_string)->call($method => @_);
UNIVERSAL::isa($som => 'SOAP::SOM')
? wantarray
? $som->paramsall
: $som->result
: $som;
};
}
# ======================================================================
package SOAP::Lite;
use vars qw($AUTOLOAD @ISA);
use Carp ();
use SOAP::Lite::Utils;
use SOAP::Constants;
use SOAP::Packager;
use Scalar::Util qw(weaken blessed);
@ISA = qw(SOAP::Cloneable);
# provide access to global/autodispatched object
sub self {
@_ > 1
? $soap = $_[1]
: $soap
}
# no more warnings about "used only once"
*UNIVERSAL::AUTOLOAD if 0;
sub autodispatched { \&{*UNIVERSAL::AUTOLOAD} eq \&{*SOAP::AUTOLOAD} };
sub soapversion {
my $self = shift;
my $version = shift or return $SOAP::Constants::SOAP_VERSION;
($version) = grep {
$SOAP::Constants::SOAP_VERSIONS{$_}->{NS_ENV} eq $version
} keys %SOAP::Constants::SOAP_VERSIONS
unless exists $SOAP::Constants::SOAP_VERSIONS{$version};
die qq!$SOAP::Constants::WRONG_VERSION Supported versions:\n@{[
join "\n", map {" $_ ($SOAP::Constants::SOAP_VERSIONS{$_}->{NS_ENV})"} keys %SOAP::Constants::SOAP_VERSIONS
]}\n!
unless defined($version) && defined(my $def = $SOAP::Constants::SOAP_VERSIONS{$version});
foreach (keys %$def) {
eval "\$SOAP::Constants::$_ = '$SOAP::Constants::SOAP_VERSIONS{$version}->{$_}'";
}
$SOAP::Constants::SOAP_VERSION = $version;
return $self;
}
BEGIN { SOAP::Lite->soapversion(1.1) }
sub import {
my $pkg = shift;
my $caller = caller;
no strict 'refs';
# emulate 'use SOAP::Lite 0.99' behavior
$pkg->require_version(shift) if defined $_[0] && $_[0] =~ /^\d/;
while (@_) {
my $command = shift;
my @parameters = UNIVERSAL::isa($_[0] => 'ARRAY')
? @{shift()}
: shift
if @_ && $command ne 'autodispatch';
if ($command eq 'autodispatch' || $command eq 'dispatch_from') {
$soap = ($soap||$pkg)->new;
no strict 'refs';
foreach ($command eq 'autodispatch'
? 'UNIVERSAL'
: @parameters
) {
my $sub = "${_}::AUTOLOAD";
defined &{*$sub}
? (\&{*$sub} eq \&{*SOAP::AUTOLOAD}
? ()
: Carp::croak "$sub already assigned and won't work with DISPATCH. Died")
: (*$sub = *SOAP::AUTOLOAD);
}
}
elsif ($command eq 'service') {
foreach (keys %{SOAP::Schema->schema_url(shift(@parameters))->parse(@parameters)->load->services}) {
$_->export_to_level(1, undef, ':all');
}
}
elsif ($command eq 'debug' || $command eq 'trace') {
SOAP::Trace->import(@parameters ? @parameters : 'all');
}
elsif ($command eq 'import') {
local $^W; # suppress warnings about redefining
my $package = shift(@parameters);
$package->export_to_level(1, undef, @parameters ? @parameters : ':all') if $package;
}
else {
Carp::carp "Odd (wrong?) number of parameters in import(), still continue" if $^W && !(@parameters & 1);
$soap = ($soap||$pkg)->$command(@parameters);
}
}
}
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
unless (ref $self) {
my $class = $self;
# Check whether we can clone. Only the SAME class allowed, no inheritance
$self = ref($soap) eq $class ? $soap->clone : {
_transport => SOAP::Transport->new,
_serializer => SOAP::Serializer->new,
_deserializer => SOAP::Deserializer->new,
_packager => SOAP::Packager::MIME->new,
_schema => undef,
_autoresult => 0,
_on_action => sub { sprintf '"%s#%s"', shift || '', shift },
_on_fault => sub {ref $_[1] ? return $_[1] : Carp::croak $_[0]->transport->is_success ? $_[1] : $_[0]->transport->status},
};
bless $self => $class;
$self->on_nonserialized($self->on_nonserialized || $self->serializer->on_nonserialized);
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my($method, $params) = splice(@_,0,2);
$self->can($method)
? $self->$method(ref $params eq 'ARRAY' ? @$params : $params)
: $^W && Carp::carp "Unrecognized parameter '$method' in new()"
}
return $self;
}
sub init_context {
my $self = shift->new;
$self->{'_deserializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken $self->{'_deserializer'}->{'_context'};
$self->{'_serializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken $self->{'_serializer'}->{'_context'};
}
# Naming? wsdl_parser
sub schema {
my $self = shift;
if (@_) {
$self->{'_schema'} = shift;
return $self;
}
else {
if (!defined $self->{'_schema'}) {
$self->{'_schema'} = SOAP::Schema->new;
}
return $self->{'_schema'};
}
}
sub BEGIN {
no strict 'refs';
for my $method (qw(serializer deserializer)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
if (@_) {
my $context = $self->{$field}->{'_context'}; # save the old context
$self->{$field} = shift;
$self->{$field}->{'_context'} = $context; # restore the old context
return $self;
}
else {
return $self->{$field};
}
}
}
__PACKAGE__->__mk_accessors(
qw(endpoint transport outputxml autoresult packager)
);
# for my $method () {
# my $field = '_' . $method;
# *$method = sub {
# my $self = shift->new;
# @_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
# }
# }
for my $method (qw(on_action on_fault on_nonserialized)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
return $self->{$field} unless @_;
local $@;
# commented out because that 'eval' was unsecure
# > ref $_[0] eq 'CODE' ? shift : eval shift;
# Am I paranoid enough?
$self->{$field} = shift;
Carp::croak $@ if $@;
Carp::croak "$method() expects subroutine (CODE) or string that evaluates into subroutine (CODE)"
unless ref $self->{$field} eq 'CODE';
return $self;
}
}
# SOAP::Transport Shortcuts
# TODO - deprecate proxy() in favor of new language endpoint_url()
no strict qw(refs);
for my $method (qw(proxy)) {
*$method = sub {
my $self = shift->new;
@_ ? ($self->transport->$method(@_), return $self) : return $self->transport->$method();
}
}
# SOAP::Seriailizer Shortcuts
for my $method (qw(autotype readable envprefix encodingStyle
encprefix multirefinplace encoding
typelookup header maptype xmlschema
uri ns_prefix ns_uri use_prefix use_default_ns
ns default_ns)) {
*$method = sub {
my $self = shift->new;
@_ ? ($self->serializer->$method(@_), return $self) : return $self->serializer->$method();
}
}
# SOAP::Schema Shortcuts
for my $method (qw(cache_dir cache_ttl)) {
*$method = sub {
my $self = shift->new;
@_ ? ($self->schema->$method(@_), return $self) : return $self->schema->$method();
}
}
}
sub parts {
my $self = shift;
$self->packager->parts(@_);
return $self;
}
# Naming? wsdl
sub service {
my $self = shift->new;
return $self->{'_service'} unless @_;
$self->schema->schema_url($self->{'_service'} = shift);
my %services = %{$self->schema->parse(@_)->load->services};
Carp::croak "More than one service in service description. Service and port names have to be specified\n"
if keys %services > 1;
my $service = (keys %services)[0]->new;
return $service;
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
ref $_[0] or Carp::croak qq!Can\'t locate class method "$method" via package \"! . __PACKAGE__ .'\"';
no strict 'refs';
*$AUTOLOAD = sub {
my $self = shift;
my $som = $self->call($method => @_);
return $self->autoresult && UNIVERSAL::isa($som => 'SOAP::SOM')
? wantarray ? $som->paramsall : $som->result
: $som;
};
goto &$AUTOLOAD;
}
sub call {
SOAP::Trace::trace('()');
my $self = shift;
die "A service address has not been specified either by using SOAP::Lite->proxy() or a service description)\n"
unless defined $self->proxy && UNIVERSAL::isa($self->proxy => 'SOAP::Client');
$self->init_context();
my $serializer = $self->serializer;
$serializer->on_nonserialized($self->on_nonserialized);
my $response = $self->transport->send_receive(
context => $self, # this is provided for context
endpoint => $self->endpoint,
action => scalar($self->on_action->($serializer->uriformethod($_[0]))),
# leave only parameters so we can later update them if required
envelope => $serializer->envelope(method => shift, @_),
encoding => $serializer->encoding,
parts => @{$self->packager->parts} ? $self->packager->parts : undef,
);
return $response if $self->outputxml;
my $result = eval { $self->deserializer->deserialize($response) }
if $response;
if (!$self->transport->is_success || # transport fault
$@ || # not deserializible
# fault message even if transport OK
# or no transport error (for example, fo TCP, POP3, IO implementations)
UNIVERSAL::isa($result => 'SOAP::SOM') && $result->fault) {
return ($self->on_fault->($self, $@
? $@ . ($response || '')
: $result)
|| $result
);
# ? # trick editors
}
# this might be trouble for connection close...
return unless $response; # nothing to do for one-ways
# little bit tricky part that binds in/out parameters
if (UNIVERSAL::isa($result => 'SOAP::SOM')
&& ($result->paramsout || $result->headers)
&& $serializer->signature) {
my $num = 0;
my %signatures = map {$_ => $num++} @{$serializer->signature};
for ($result->dataof(SOAP::SOM::paramsout), $result->dataof(SOAP::SOM::headers)) {
my $signature = join $;, $_->name, $_->type || '';
if (exists $signatures{$signature}) {
my $param = $signatures{$signature};
my($value) = $_->value; # take first value
# fillup parameters
UNIVERSAL::isa($_[$param] => 'SOAP::Data')
? $_[$param]->SOAP::Data::value($value)
: UNIVERSAL::isa($_[$param] => 'ARRAY')
? (@{$_[$param]} = @$value)
: UNIVERSAL::isa($_[$param] => 'HASH')
? (%{$_[$param]} = %$value)
: UNIVERSAL::isa($_[$param] => 'SCALAR')
? (${$_[$param]} = $$value)
: ($_[$param] = $value)
}
}
}
return $result;
} # end of call()
# ======================================================================
package SOAP::Lite::COM;
require SOAP::Lite;
sub required {
foreach (qw(
URI::_foreign URI::http URI::https
LWP::Protocol::http LWP::Protocol::https LWP::Authen::Basic LWP::Authen::Digest
HTTP::Daemon Compress::Zlib SOAP::Transport::HTTP
XMLRPC::Lite XMLRPC::Transport::HTTP
)) {
eval join ';', 'local $SIG{__DIE__}', "require $_";
}
}
sub new { required; SOAP::Lite->new(@_) }
sub create; *create = \&new; # make alias. Somewhere 'new' is registered keyword
sub soap; *soap = \&new; # also alias. Just to be consistent with .xmlrpc call
sub xmlrpc { required; XMLRPC::Lite->new(@_) }
sub server { required; shift->new(@_) }
sub data { SOAP::Data->new(@_) }
sub header { SOAP::Header->new(@_) }
sub hash { +{@_} }
sub instanceof {
my $class = shift;
die "Incorrect class name" unless $class =~ /^(\w[\w:]*)$/;
eval "require $class";
$class->new(@_);
}
# ======================================================================
1;
__END__
=pod
=head1 NAME
SOAP::Lite - Perl's Web Services Toolkit
=head1 DESCRIPTION
SOAP::Lite is a collection of Perl modules which provides a simple and
lightweight interface to the Simple Object Access Protocol (SOAP) both on
client and server side.
=head1 PERL VERSION WARNING
As of version SOAP::Lite version 1.05, no perl versions before 5.8 will be supported.
SOAP::Lite 0.71 will be the last version of SOAP::Lite running on perl 5.005
Future versions of SOAP::Lite will require at least perl 5.6.0
If you have not had the time to upgrade your perl, you should consider this now.
=head1 OVERVIEW OF CLASSES AND PACKAGES
=over
=item F
L - Main class provides all logic
L - Transport backend
L - Data objects
L - Header Data Objects
L - Serializes data structures to SOAP messages
L - Deserializes SOAP messages into SOAP::SOM objects
L - SOAP Message objects
L - Provides access to common constants and defaults
L - Tracing facilities
L - Provides access and stub(s) for schema(s)
L - WSDL implementation for SOAP::Schema
L - Handles requests on server side
SOAP::Server::Object - Handles objects-by-reference
L - Provides support for Faults on server side
L - A set of private and public utility subroutines
=item F
L - Provides an abstract class for implementing custom packagers.
L - Provides MIME support to SOAP::Lite
L - Provides DIME support to SOAP::Lite
=item F
L - Client interface to HTTP transport
L - Server interface to HTTP transport
L - CGI implementation of server interface
L - Daemon implementation of server interface
L - mod_perl implementation of server interface
=item F
L - Server interface to POP3 protocol
=item F
L - Client interface to SMTP/sendmail
=item F
L - Client interface to local transport
=item F
L - Server interface to TCP protocol
L - Client interface to TCP protocol
=item F
L - Server interface to IO transport
=back
=head1 METHODS
All accessor methods return the current value when called with no arguments,
while returning the object reference itself when called with a new value.
This allows the set-attribute calls to be chained together.
=over
=item new(optional key/value pairs)
$client = SOAP::Lite->new(proxy => $endpoint)
Constructor. Many of the accessor methods defined here may be initialized at
creation by providing their name as a key, followed by the desired value.
The example provides the value for the proxy element of the client.
=item transport(optional transport object)
$transp = $client->transport( );
Gets or sets the transport object used for sending/receiving SOAP messages.
See L for details.
=item serializer(optional serializer object)
$serial = $client->serializer( )
Gets or sets the serializer object used for creating XML messages.
See L for details.
=item packager(optional packager object)
$packager = $client->packager( )
Provides access to the C object that the client uses to manage
the use of attachments. The default packager is a MIME packager, but unless
you specify parts to send, no MIME formatting will be done.
See also: L.
=item proxy(endpoint, optional extra arguments)
$client->proxy('http://soap.xml.info/ endPoint');
The proxy is the server or endpoint to which the client is going to connect.
This method allows the setting of the endpoint, along with any extra
information that the transport object may need when communicating the request.
This method is actually an alias to the proxy method of L.
It is the same as typing:
$client->transport( )->proxy(...arguments);
Extra parameters can be passed to proxy() - see below.
=over
=item compress_threshold
See L in L.
=item All initialization options from the underlying transport layer
The options for HTTP(S) are the same as for LWP::UserAgent's new() method.
A common option is to create a instance of HTTP::Cookies and pass it as
cookie_jar option:
my $cookie_jar = HTTP::Cookies->new()
$client->proxy('http://www.example.org/webservice',
cookie_jar => $cookie_jar,
);
=back
For example, if you wish to set the HTTP timeout for a SOAP::Lite client to 5
seconds, use the following code:
my $soap = SOAP::Lite
->uri($uri)
->proxy($proxyUrl, timeout => 5 );
See L.
=item endpoint(optional new endpoint address)
$client->endpoint('http://soap.xml.info/ newPoint')
It may be preferable to set a new endpoint without the additional work of
examining the new address for protocol information and checking to ensure the
support code is loaded and available. This method allows the caller to change
the endpoint that the client is currently set to connect to, without
reloading the relevant transport code. Note that the proxy method must have
been called before this method is used.
=item service(service URL)
$client->service('http://svc.perl.org/Svc.wsdl');
C offers some support for creating method stubs from service
descriptions. At present, only WSDL support is in place. This method loads
the specified WSDL schema and uses it as the basis for generating stubs.
=item outputxml(boolean)
$client->outputxml('true');
When set to a true value, the raw XML is returned by the call to a remote
method.
The default is to return the a L object (false).
=item autotype(boolean)
$client->autotype(0);
This method is a shortcut for:
$client->serializer->autotype(boolean);
By default, the serializer tries to automatically deduce types for the data
being sent in a message. Setting a false value with this method disables the
behavior.
=item readable(boolean)
$client->readable(1);
This method is a shortcut for:
$client->serializer->readable(boolean);
When this is used to set a true value for this property, the generated XML
sent to the endpoint has extra characters (spaces and new lines) added in to
make the XML itself more readable to human eyes (presumably for debugging).
The default is to not send any additional characters.
=item default_ns($uri)
Sets the default namespace for the request to the specified uri. This
overrides any previous namespace declaration that may have been set using a
previous call to C or C. Setting the default namespace
causes elements to be serialized without a namespace prefix, like this:
Some .NET web services have been reported to require this XML namespace idiom.
=item ns($uri,$prefix=undef)
Sets the namespace uri and optionally the namespace prefix for the request to
the specified values. This overrides any previous namespace declaration that
may have been set using a previous call to C or C.
If a prefix is not specified, one will be generated for you automatically.
Setting the namespace causes elements to be serialized with a declared
namespace prefix, like this:
=item use_prefix(boolean)
Deprecated. Use the C and C methods described above.
Shortcut for C<< serializer->use_prefix() >>. This lets you turn on/off the
use of a namespace prefix for the children of the /Envelope/Body element.
Default is 'true'.
When use_prefix is set to 'true', serialized XML will look like this:
When use_prefix is set to 'false', serialized XML will look like this:
Some .NET web services have been reported to require this XML namespace idiom.
=item soapversion(optional value)
$client->soapversion('1.2');
If no parameter is given, returns the current version of SOAP that is being
used by the client object to encode requests. If a parameter is given, the
method attempts to set that as the version of SOAP being used.
The value should be either 1.1 or 1.2.
=item envprefix(QName)
$client->envprefix('env');
This method is a shortcut for:
$client->serializer->envprefix(QName);
Gets or sets the namespace prefix for the SOAP namespace. The default is
SOAP.
The prefix itself has no meaning, but applications may wish to chose one
explicitly to denote different versions of SOAP or the like.
=item encprefix(QName)
$client->encprefix('enc');
This method is a shortcut for:
$client->serializer->encprefix(QName);
Gets or sets the namespace prefix for the encoding rules namespace.
The default value is SOAP-ENC.
=back
While it may seem to be an unnecessary operation to set a value that isn't
relevant to the message, such as the namespace labels for the envelope and
encoding URNs, the ability to set these labels explicitly can prove to be a
great aid in distinguishing and debugging messages on the server side of
operations.
=over
=item encoding(encoding URN)
$client->encoding($soap_12_encoding_URN);
This method is a shortcut for:
$client->serializer->encoding(args);
Where the earlier method dealt with the label used for the attributes related
to the SOAP encoding scheme, this method actually sets the URN to be specified
as the encoding scheme for the message. The default is to specify the encoding
for SOAP 1.1, so this is handy for applications that need to encode according
to SOAP 1.2 rules.
=item typelookup
$client->typelookup;
This method is a shortcut for:
$client->serializer->typelookup;
Gives the application access to the type-lookup table from the serializer
object. See the section on L.
=item uri(service specifier)
Deprecated - the C subroutine is deprecated in order to provide a more
intuitive naming scheme for subroutines that set namespaces. In the future,
you will be required to use either the C or C subroutines
instead of C.
$client->uri($service_uri);
This method is a shortcut for:
$client->serializer->uri(service);
The URI associated with this accessor on a client object is the
service-specifier for the request, often encoded for HTTP-based requests as
the SOAPAction header. While the names may seem confusing, this method
doesn't specify the endpoint itself. In most circumstances, the C refers
to the namespace used for the request.
Often times, the value may look like a valid URL. Despite this, it doesn't
have to point to an existing resource (and often doesn't). This method sets
and retrieves this value from the object. Note that no transport code is
triggered by this because it has no direct effect on the transport of the
object.
=item multirefinplace(boolean)
$client->multirefinplace(1);
This method is a shortcut for:
$client->serializer->multirefinplace(boolean);
Controls how the serializer handles values that have multiple references to
them. Recall from previous SOAP chapters that a value may be tagged with an
identifier, then referred to in several places. When this is the case for a
value, the serializer defaults to putting the data element towards the top of
the message, right after the opening tag of the method-specification. It is
serialized as a standalone entity with an ID that is then referenced at the
relevant places later on. If this method is used to set a true value, the
behavior is different. When the multirefinplace attribute is true, the data
is serialized at the first place that references it, rather than as a separate
element higher up in the body. This is more compact but may be harder to read
or trace in a debugging environment.
=item parts( ARRAY )
Used to specify an array of L's to be attached to the
transmitted SOAP message. Attachments that are returned in a response can be
accessed by C.
=item self
$ref = SOAP::Lite->self;
Returns an object reference to the default global object the C
package maintains. This is the object that processes many of the arguments
when provided on the use line.
=back
The following method isn't an accessor style of method but neither does it fit
with the group that immediately follows it:
=over
=item call(arguments)
$client->call($method => @arguments);
As has been illustrated in previous chapters, the C client objects
can manage remote calls with auto-dispatching using some of Perl's more
elaborate features. call is used when the application wants a greater degree
of control over the details of the call itself. The method may be built up
from a L object, so as to allow full control over the namespace
associated with the tag, as well as other attributes like encoding. This is
also important for calling methods that contain characters not allowable in
Perl function names, such as A.B.C.
=back
The next four methods used in the C class are geared towards
handling the types of events than can occur during the message lifecycle. Each
of these sets up a callback for the event in question:
=over
=item on_action(callback)
$client->on_action(sub { qq("$_[0]") });
Triggered when the transport object sets up the SOAPAction header for an
HTTP-based call. The default is to set the header to the string, uri#method,
in which URI is the value set by the uri method described earlier, and method
is the name of the method being called. When called, the routine referenced
(or the closure, if specified as in the example) is given two arguments, uri
and method, in that order.
.NET web services usually expect C as separator for C and C.
To change SOAP::Lite's behaviour to use uri/method as SOAPAction header, use
the following code:
$client->on_action( sub { join '/', @_ } );
=item on_fault(callback)
$client->on_fault(sub { popup_dialog($_[1]) });
Triggered when a method call results in a fault response from the server.
When it is called, the argument list is first the client object itself,
followed by the object that encapsulates the fault. In the example, the fault
object is passed (without the client object) to a hypothetical GUI function
that presents an error dialog with the text of fault extracted from the object
(which is covered shortly under the L methods).
=item on_nonserialized(callback)
$client->on_nonserialized(sub { die "$_[0]?!?" });
Occasionally, the serializer may be given data it can't turn into SOAP-savvy
XML; for example, if a program bug results in a code reference or something
similar being passed in as a parameter to method call. When that happens, this
callback is activated, with one argument. That argument is the data item that
could not be understood. It will be the only argument. If the routine returns,
the return value is pasted into the message as the serialization. Generally,
an error is in order, and this callback allows for control over signaling that
error.
=item on_debug(callback)
$client->on_debug(sub { print @_ });
Deprecated. Use the global +debug and +trace facilities described in
L
Note that this method will not work as expected: Instead of affecting the
debugging behaviour of the object called on, it will globally affect the
debugging behaviour for all objects of that class.
=back
=head1 WRITING A SOAP CLIENT
This chapter guides you to writing a SOAP client by example.
The SOAP service to be accessed is a simple variation of the well-known
hello world program. It accepts two parameters, a name and a given name,
and returns "Hello $given_name $name".
We will use "Martin Kutter" as the name for the call, so all variants will
print the following message on success:
Hello Martin Kutter!
=head2 SOAP message styles
There are three common (and one less common) variants of SOAP messages.
These address the message style (positional parameters vs. specified message
documents) and encoding (as-is vs. typed).
The different message styles are:
=over
=item * rpc/encoded
Typed, positional parameters. Widely used in scripting languages.
The type of the arguments is included in the message.
Arrays and the like may be encoded using SOAP encoding rules (or others).
=item * rpc/literal
As-is, positional parameters. The type of arguments is defined by some
pre-exchanged interface definition.
=item * document/encoded
Specified message with typed elements. Rarely used.
=item * document/literal
Specified message with as-is elements. The message specification and
element types are defined by some pre-exchanged interface definition.
=back
As of 2008, document/literal has become the predominant SOAP message
variant. rpc/literal and rpc/encoded are still in use, mainly with scripting
languages, while document/encoded is hardly used at all.
You will see clients for the rpc/encoded and document/literal SOAP variants in
this section.
=head2 Example implementations
=head3 RPC/ENCODED
Rpc/encoded is most popular with scripting languages like perl, php and python
without the use of a WSDL. Usual method descriptions look like this:
Method: sayHello(string, string)
Parameters:
name: string
givenName: string
Such a description usually means that you can call a method named "sayHello"
with two positional parameters, "name" and "givenName", which both are
strings.
The message corresponding to this description looks somewhat like this:
KutterMartin
Any XML tag names may be used instead of the "s-gensym01" stuff - parameters
are positional, the tag names have no meaning.
A client producing such a call is implemented like this:
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:81/soap-wsdl-test/helloworld.pl');
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello', 'Kutter', 'Martin');
die $som->faultstring if ($som->fault);
print $som->result, "\n";
You can of course use a one-liner, too...
Sometimes, rpc/encoded interfaces are described with WSDL definitions.
A WSDL accepting "named" parameters with rpc/encoded looks like this:
The message corresponding to this schema looks like this:
KutterMartin
A web service client using this schema looks like this:
use SOAP::Lite;
my $soap = SOAP::Lite->service("file:say_hello_rpcenc.wsdl");
eval { my $result = $soap->sayHello('Kutter', 'Martin'); };
if ($@) {
die $@;
}
print $som->result();
You may of course also use the following one-liner:
perl -MSOAP::Lite -e 'print SOAP::Lite->service("file:say_hello_rpcenc.wsdl")\
->sayHello('Kutter', 'Martin'), "\n";'
A web service client (without a service description) looks like this.
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:81/soap-wsdl-test/helloworld.pl');
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello',
SOAP::Data->name('name')->value('Kutter'),
SOAP::Data->name('givenName')->value('Martin')
);
die $som->faultstring if ($som->fault);
print $som->result, "\n";
=head3 RPC/LITERAL
SOAP web services using the document/literal message encoding are usually
described by some Web Service Definition. Our web service has the following
WSDL description:
The XML message (inside the SOAP Envelope) look like this:
KutterMartinHello Martin Kutter!
This is the SOAP::Lite implementation for the web service client:
use SOAP::Lite +trace;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:80/helloworld.pl');
$soap->on_action( sub { "urn:HelloWorld#sayHello" });
$soap->autotype(0)->readable(1);
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello', SOAP::Data->name('parameters')->value(
\SOAP::Data->value([
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
]))
);
die $som->fault->{ faultstring } if ($som->fault);
print $som->result, "\n";
=head3 DOCUMENT/LITERAL
SOAP web services using the document/literal message encoding are usually
described by some Web Service Definition. Our web service has the following
WSDL description:
The XML message (inside the SOAP Envelope) look like this:
KutterMartinHello Martin Kutter!
You can call this web service with the following client code:
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:80/helloworld.pl');
$soap->on_action( sub { "urn:HelloWorld#sayHello" });
$soap->autotype(0);
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call("sayHello",
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
);
die $som->fault->{ faultstring } if ($som->fault);
print $som->result, "\n";
=head2 Differences between the implementations
You may have noticed that there's little difference between the rpc/encoded,
rpc/literal and the document/literal example's implementation. In fact, from
SOAP::Lite's point of view, the only differences between rpc/literal and
document/literal that parameters are always named.
In our example, the rpc/encoded variant already used named parameters (by
using two messages), so there's no difference at all.
You may have noticed the somewhat strange idiom for passing a list of named
parameters in the rpc/literal example:
my $som = $soap->call('sayHello', SOAP::Data->name('parameters')->value(
\SOAP::Data->value([
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
]))
);
While SOAP::Data provides full control over the XML generated, passing
hash-like structures require additional coding.
=head1 WRITING A SOAP SERVER
See L, or L.
=head1 FEATURES
=head2 ATTACHMENTS
C features support for the SOAP with Attachments specification.
Currently, SOAP::Lite only supports MIME based attachments. DIME based
attachments are yet to be fully functional.
=head3 EXAMPLES
=head4 Client sending an attachment
C clients can specify attachments to be sent along with a request
by using the C method, which takes as an argument an
ARRAY of C's.
use SOAP::Lite;
use MIME::Entity;
my $ent = build MIME::Entity
Type => "image/gif",
Encoding => "base64",
Path => "somefile.gif",
Filename => "saveme.gif",
Disposition => "attachment";
my $som = SOAP::Lite
->uri($SOME_NAMESPACE)
->parts([ $ent ])
->proxy($SOME_HOST)
->some_method(SOAP::Data->name("foo" => "bar"));
=head4 Client retrieving an attachment
A client accessing attachments that were returned in a response by using the
C accessor.
use SOAP::Lite;
use MIME::Entity;
my $soap = SOAP::Lite
->uri($NS)
->proxy($HOST);
my $som = $soap->foo();
foreach my $part (${$som->parts}) {
print $part->stringify;
}
=head4 Server receiving an attachment
Servers, like clients, use the S module to access attachments
transmitted to it.
package Attachment;
use SOAP::Lite;
use MIME::Entity;
use strict;
use vars qw(@ISA);
@ISA = qw(SOAP::Server::Parameters);
sub someMethod {
my $self = shift;
my $envelope = pop;
foreach my $part (@{$envelope->parts}) {
print "AttachmentService: attachment found! (".ref($part).")\n";
}
# do something
}
=head4 Server responding with an attachment
Servers wishing to return an attachment to the calling client need only return
C objects along with SOAP::Data elements, or any other data
intended for the response.
package Attachment;
use SOAP::Lite;
use MIME::Entity;
use strict;
use vars qw(@ISA);
@ISA = qw(SOAP::Server::Parameters);
sub someMethod {
my $self = shift;
my $envelope = pop;
my $ent = build MIME::Entity
'Id' => "<1234>",
'Type' => "text/xml",
'Path' => "some.xml",
'Filename' => "some.xml",
'Disposition' => "attachment";
return SOAP::Data->name("foo" => "blah blah blah"),$ent;
}
=head2 DEFAULT SETTINGS
Though this feature looks similar to
L they have (almost)
nothing in common. This capability allows you specify default settings so that
all objects created after that will be initialized with the proper default
settings.
If you wish to provide common C or C settings for all
C objects in your application you may do:
use SOAP::Lite
proxy => 'http://localhost/cgi-bin/soap.cgi',
uri => 'http://my.own.com/My/Examples';
my $soap1 = new SOAP::Lite; # will get the same proxy()/uri() as above
print $soap1->getStateName(1)->result;
my $soap2 = SOAP::Lite->new; # same thing as above
print $soap2->getStateName(2)->result;
# or you may override any settings you want
my $soap3 = SOAP::Lite->proxy('http://localhost/');
print $soap3->getStateName(1)->result;
B C properties can be propagated this way. Changes in object
copies will not affect global settings and you may still change global
settings with C<< SOAP::Lite->self >> call which returns reference to global
object. Provided parameter will update this object and you can even set it to
C:
SOAP::Lite->self(undef);
The C