1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
|
# ======================================================================
#
# Copyright (C) 2000-2001 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.
#
# $Id: HTTP.pm,v 1.11 2002/04/15 17:35:11 paulk Exp $
#
# ======================================================================
package SOAP::Transport::HTTP;
use strict;
use vars qw($VERSION);
$VERSION = sprintf("%d.%s", map {s/_//g; $_} q$Name: release-0_55-public $ =~ /-(\d+)_([\d_]+)/);
use SOAP::Lite;
# ======================================================================
package SOAP::Transport::HTTP::Client;
use vars qw(@ISA $COMPRESS);
@ISA = qw(SOAP::Client LWP::UserAgent);
$COMPRESS = 'deflate';
my(%redirect, %mpost, %nocompress);
# hack for HTTP conection that returns Keep-Alive
# miscommunication (?) between LWP::Protocol and LWP::Protocol::http
# dies after timeout, but seems like we could make it work
sub patch {
local $^W;
{ sub LWP::UserAgent::redirect_ok; *LWP::UserAgent::redirect_ok = sub {1} }
{ package LWP::Protocol;
my $collect = \&collect; # store original
*collect = sub {
if (defined $_[2]->header('Connection') && $_[2]->header('Connection') eq 'Keep-Alive') {
my $data = $_[3]->();
my $next = SOAP::Utils::bytelength($$data) == $_[2]->header('Content-Length') ? sub { \'' } : $_[3];
my $done = 0; $_[3] = sub { $done++ ? &$next : $data };
}
goto &$collect;
};
}
*patch = sub {};
};
sub DESTROY { SOAP::Trace::objects('()') }
sub new { require LWP::UserAgent; patch;
my $self = shift;
unless (ref $self) {
my $class = ref($self) || $self;
my(@params, @methods);
while (@_) { $class->can($_[0]) ? push(@methods, shift() => shift) : push(@params, shift) }
$self = $class->SUPER::new(@params);
$self->agent(join '/', 'SOAP::Lite', 'Perl', SOAP::Transport::HTTP->VERSION);
$self->options({});
while (@methods) { my($method, $params) = splice(@methods,0,2);
$self->$method(ref $params eq 'ARRAY' ? @$params : $params)
}
SOAP::Trace::objects('()');
}
return $self;
}
sub send_receive {
my($self, %parameters) = @_;
my($envelope, $endpoint, $action, $encoding) =
@parameters{qw(envelope endpoint action encoding)};
$endpoint ||= $self->endpoint;
my $method = 'POST';
my $resp;
$self->options->{is_compress} ||= exists $self->options->{compress_threshold} &&
eval { require Compress::Zlib };
COMPRESS: {
my $compressed = !exists $nocompress{$endpoint} &&
$self->options->{is_compress} &&
($self->options->{compress_threshold} || 0) < SOAP::Utils::bytelength $envelope;
$envelope = Compress::Zlib::compress($envelope) if $compressed;
while (1) {
# check cache for redirect
$endpoint = $redirect{$endpoint} if exists $redirect{$endpoint};
# check cache for M-POST
$method = 'M-POST' if exists $mpost{$endpoint};
# what's this all about?
# unfortunately combination of LWP and Perl 5.6.1 and later has bug
# in sending multibyte characters. LWP uses length() to calculate
# content-length header and starting 5.6.1 length() calculates chars
# instead of bytes. 'use bytes' in THIS file doesn't work, because
# it's lexically scoped. Unfortunately, content-length we calculate
# here doesn't work either, because LWP overwrites it with
# content-length it calculates (which is wrong) AND uses length()
# during syswrite/sysread, so we are in a bad shape anyway.
# what to do? we calculate proper content-length (using
# bytelength() function from SOAP::Utils) and then drop utf8 mark
# from string (doing pack with 'C0A*' modifier) if length and
# bytelength are not the same
my $bytelength = SOAP::Utils::bytelength($envelope);
$envelope = pack('C0A*', $envelope)
if !$SOAP::Constants::DO_NOT_USE_LWP_LENGTH_HACK && length($envelope) != $bytelength;
my $req = HTTP::Request->new($method => $endpoint, HTTP::Headers->new, $envelope);
$req->proxy_authorization_basic($ENV{'HTTP_proxy_user'}, $ENV{'HTTP_proxy_pass'})
if ($ENV{'HTTP_proxy_user'} && $ENV{'HTTP_proxy_pass'}); # by Murray Nesbitt
if ($method eq 'M-POST') {
my $prefix = sprintf '%04d', int(rand(1000));
$req->header(Man => qq!"$SOAP::Constants::NS_ENV"; ns=$prefix!);
$req->header("$prefix-SOAPAction" => $action) if defined $action;
} else {
$req->header(SOAPAction => $action) if defined $action;
}
# allow compress if present and let server know we could handle it
$req->header(Accept => ['text/xml', 'multipart/*']);
$req->header('Accept-Encoding' => [$COMPRESS]) if $self->options->{is_compress};
$req->content_encoding($COMPRESS) if $compressed;
$req->content_type(join '; ', 'text/xml',
!$SOAP::Constants::DO_NOT_USE_CHARSET && $encoding ? 'charset=' . lc($encoding) : ());
$req->content_length($bytelength);
SOAP::Trace::transport($req);
SOAP::Trace::debug($req->as_string);
$self->SUPER::env_proxy if $ENV{'HTTP_proxy'};
$resp = $self->SUPER::request($req);
SOAP::Trace::transport($resp);
SOAP::Trace::debug($resp->as_string);
# 100 OK, continue to read?
if (($resp->code == 510 || $resp->code == 501) && $method ne 'M-POST') {
$mpost{$endpoint} = 1;
} elsif ($resp->code == 415 && $compressed) { # 415 Unsupported Media Type
$nocompress{$endpoint} = 1;
$envelope = Compress::Zlib::uncompress($envelope);
redo COMPRESS; # try again without compression
} else {
last;
}
}
}
$redirect{$endpoint} = $resp->request->url
if $resp->previous && $resp->previous->is_redirect;
$self->code($resp->code);
$self->message($resp->message);
$self->is_success($resp->is_success);
$self->status($resp->status_line);
my $content = ($resp->content_encoding || '') =~ /\b$COMPRESS\b/o && $self->options->{is_compress}
? Compress::Zlib::uncompress($resp->content)
: ($resp->content_encoding || '') =~ /\S/
? die "Unexpected Content-Encoding '@{[$resp->content_encoding]}' returned\n"
: $resp->content;
$resp->content_type =~ m!^multipart/!
? join("\n", $resp->headers_as_string, $content)
: ($resp->content_type eq 'text/xml' || # text/xml
!$resp->is_success || # failed request
$SOAP::Constants::DO_NOT_CHECK_CONTENT_TYPE)
? $content
: die "Unexpected Content-Type '@{[join '; ', $resp->content_type]}' returned\n";
}
# ======================================================================
package SOAP::Transport::HTTP::Server;
use vars qw(@ISA $COMPRESS);
@ISA = qw(SOAP::Server);
use URI;
$COMPRESS = 'deflate';
sub DESTROY { SOAP::Trace::objects('()') }
sub new { require LWP::UserAgent;
my $self = shift;
unless (ref $self) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(@_);
$self->on_action(sub {
(my $action = shift) =~ s/^("?)(.*)\1$/$2/;
die "SOAPAction shall match 'uri#method' if present (got '$action', expected '@{[join('#', @_)]}'\n"
if $action && $action ne join('#', @_)
&& $action ne join('/', @_)
&& (substr($_[0], -1, 1) ne '/' || $action ne join('', @_));
});
SOAP::Trace::objects('()');
}
return $self;
}
sub BEGIN {
no strict 'refs';
for my $method (qw(request response)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
@_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
}
}
}
sub handle {
my $self = shift->new;
if ($self->request->method eq 'POST') {
$self->action($self->request->header('SOAPAction') || undef);
} elsif ($self->request->method eq 'M-POST') {
return $self->response(HTTP::Response->new(510, # NOT EXTENDED
"Expected Mandatory header with $SOAP::Constants::NS_ENV as unique URI"))
if $self->request->header('Man') !~ /^"$SOAP::Constants::NS_ENV";\s*ns\s*=\s*(\d+)/;
$self->action($self->request->header("$1-SOAPAction") || undef);
} else {
return $self->response(HTTP::Response->new(405)) # METHOD NOT ALLOWED
}
my $compressed = ($self->request->content_encoding || '') =~ /\b$COMPRESS\b/;
$self->options->{is_compress} ||= $compressed && eval { require Compress::Zlib };
# signal error if content-encoding is 'deflate', but we don't want it OR
# something else, so we don't understand it
return $self->response(HTTP::Response->new(415)) # UNSUPPORTED MEDIA TYPE
if $compressed && !$self->options->{is_compress} ||
!$compressed && ($self->request->content_encoding || '') =~ /\S/;
my $content_type = $self->request->content_type || '';
# in some environments (PerlEx?) content_type could be empty, so allow it also
# anyway it'll blow up inside ::Server::handle if something wrong with message
# TBD: but what to do with MIME encoded messages in THOSE environments?
return $self->make_fault($SOAP::Constants::FAULT_CLIENT, "Content-Type must be 'text/xml' instead of '$content_type'")
if $content_type &&
$content_type ne 'text/xml' &&
$content_type !~ m!^multipart/!;
my $content = $compressed ? Compress::Zlib::uncompress($self->request->content) : $self->request->content;
my $response = $self->SUPER::handle(
$self->request->content_type =~ m!^multipart/!
? join("\n", $self->request->headers_as_string, $content) : $content
) or return;
$self->make_response($SOAP::Constants::HTTP_ON_SUCCESS_CODE, $response);
}
sub make_fault {
my $self = shift;
$self->make_response($SOAP::Constants::HTTP_ON_FAULT_CODE => $self->SUPER::make_fault(@_));
return;
}
sub make_response {
my $self = shift;
my($code, $response) = @_;
my $encoding = $1 if $response =~ /^<\?xml(?: version="1.0"| encoding="([^"]+)")+\?>/;
$response =~ s!(\?>)!$1<?xml-stylesheet type="text/css"?>! if $self->request->content_type eq 'multipart/form-data';
$self->options->{is_compress} ||=
exists $self->options->{compress_threshold} && eval { require Compress::Zlib };
my $compressed = $self->options->{is_compress} &&
grep(/\b($COMPRESS|\*)\b/, $self->request->header('Accept-Encoding')) &&
($self->options->{compress_threshold} || 0) < SOAP::Utils::bytelength $response;
$response = Compress::Zlib::compress($response) if $compressed;
$self->response(HTTP::Response->new(
$code => undef,
HTTP::Headers->new(
'SOAPServer' => $self->product_tokens,
$compressed ? ('Content-Encoding' => $COMPRESS) : (),
'Content-Type' => join('; ', 'text/xml',
!$SOAP::Constants::DO_NOT_USE_CHARSET && $encoding ? 'charset=' . lc($encoding) : ()),
'Content-Length' => SOAP::Utils::bytelength $response),
$response,
));
}
sub product_tokens { join '/', 'SOAP::Lite', 'Perl', SOAP::Transport::HTTP->VERSION }
# ======================================================================
package SOAP::Transport::HTTP::CGI;
use vars qw(@ISA);
@ISA = qw(SOAP::Transport::HTTP::Server);
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
unless (ref $self) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(@_);
SOAP::Trace::objects('()');
}
return $self;
}
sub handle {
my $self = shift->new;
my $length = $ENV{'CONTENT_LENGTH'} || 0;
if (!$length) {
$self->response(HTTP::Response->new(411)) # LENGTH REQUIRED
} elsif (defined $SOAP::Constants::MAX_CONTENT_SIZE && $length > $SOAP::Constants::MAX_CONTENT_SIZE) {
$self->response(HTTP::Response->new(413)) # REQUEST ENTITY TOO LARGE
} else {
my $content; binmode(STDIN); read(STDIN,$content,$length);
$self->request(HTTP::Request->new(
$ENV{'REQUEST_METHOD'} || '' => $ENV{'SCRIPT_NAME'},
HTTP::Headers->new(map {(/^HTTP_(.+)/i ? $1 : $_) => $ENV{$_}} keys %ENV),
$content,
));
$self->SUPER::handle;
}
# imitate nph- cgi for IIS (pointed by Murray Nesbitt)
my $status = defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/
? $ENV{SERVER_PROTOCOL} || 'HTTP/1.0' : 'Status:';
my $code = $self->response->code;
binmode(STDOUT); print STDOUT
"$status $code ", HTTP::Status::status_message($code),
"\015\012", $self->response->headers_as_string,
"\015\012", $self->response->content;
}
# ======================================================================
package SOAP::Transport::HTTP::Daemon;
use Carp ();
use vars qw($AUTOLOAD @ISA);
@ISA = qw(SOAP::Transport::HTTP::Server);
sub DESTROY { SOAP::Trace::objects('()') }
sub new { require HTTP::Daemon;
my $self = shift;
unless (ref $self) {
my $class = ref($self) || $self;
my(@params, @methods);
while (@_) { $class->can($_[0]) ? push(@methods, shift() => shift) : push(@params, shift) }
$self = $class->SUPER::new;
$self->{_daemon} = HTTP::Daemon->new(@params) or Carp::croak "Can't create daemon: $!";
$self->myuri(URI->new($self->url)->canonical->as_string);
while (@methods) { my($method, $params) = splice(@methods,0,2);
$self->$method(ref $params eq 'ARRAY' ? @$params : $params)
}
SOAP::Trace::objects('()');
}
return $self;
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
no strict 'refs';
*$AUTOLOAD = sub { shift->{_daemon}->$method(@_) };
goto &$AUTOLOAD;
}
sub handle {
my $self = shift->new;
while (my $c = $self->accept) {
while (my $r = $c->get_request) {
$self->request($r);
$self->SUPER::handle;
$c->send_response($self->response)
}
# replaced ->close, thanks to Sean Meisner <Sean.Meisner@VerizonWireless.com>
# shutdown() doesn't work on AIX. close() is used in this case. Thanks to Jos Clijmans <jos.clijmans@recyfin.be>
UNIVERSAL::isa($c, 'shutdown') ? $c->shutdown(2) : $c->close();
undef $c;
}
}
# ======================================================================
package SOAP::Transport::HTTP::Apache;
use vars qw(@ISA);
@ISA = qw(SOAP::Transport::HTTP::Server);
sub DESTROY { SOAP::Trace::objects('()') }
sub new { require Apache; require Apache::Constants;
my $self = shift;
unless (ref $self) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(@_);
SOAP::Trace::objects('()');
}
return $self;
}
sub handler {
my $self = shift->new;
my $r = shift || Apache->request;
$self->request(HTTP::Request->new(
$r->method => $r->uri,
HTTP::Headers->new($r->headers_in),
do { my $buf; $r->read($buf, $r->header_in('Content-length')); $buf; }
));
$self->SUPER::handle;
# we will specify status manually for Apache, because
# if we do it as it has to be done, returning SERVER_ERROR,
# Apache will modify our content_type to 'text/html; ....'
# which is not what we want.
# will emulate normal response, but with custom status code
# which could also be 500.
$r->status($self->response->code);
$self->response->headers->scan(sub { $r->header_out(@_) });
$r->send_http_header(join '; ', $self->response->content_type);
$r->print($self->response->content);
&Apache::Constants::OK;
}
sub configure {
my $self = shift->new;
my $config = shift->dir_config;
foreach (%$config) {
$config->{$_} =~ /=>/
? $self->$_({split /\s*(?:=>|,)\s*/, $config->{$_}})
: ref $self->$_() ? () # hm, nothing can be done here
: $self->$_(split /\s+|\s*,\s*/, $config->{$_})
if $self->can($_);
}
$self;
}
{ sub handle; *handle = \&handler } # just create alias
# ======================================================================
#
# Copyright (C) 2001 Single Source oy (marko.asplund@kronodoc.fi)
# a FastCGI transport class for SOAP::Lite.
#
# ======================================================================
package SOAP::Transport::HTTP::FCGI;
use vars qw(@ISA);
@ISA = qw(SOAP::Transport::HTTP::CGI);
sub DESTROY { SOAP::Trace::objects('()') }
sub new { require FCGI; Exporter::require_version('FCGI' => 0.47); # requires thread-safe interface
my $self = shift;
if (!ref($self)) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(@_);
$self->{_fcgirq} = FCGI::Request(\*STDIN, \*STDOUT, \*STDERR);
SOAP::Trace::objects('()');
}
return $self;
}
sub handle {
my $self = shift->new;
my ($r1, $r2);
my $fcgirq = $self->{_fcgirq};
while (($r1 = $fcgirq->Accept()) >= 0) {
$r2 = $self->SUPER::handle;
}
return undef;
}
# ======================================================================
1;
__END__
=head1 NAME
SOAP::Transport::HTTP - Server/Client side HTTP support for SOAP::Lite
=head1 SYNOPSIS
=over 4
=item Client
use SOAP::Lite
uri => 'http://my.own.site.com/My/Examples',
proxy => 'http://localhost/',
# proxy => 'http://localhost/cgi-bin/soap.cgi', # local CGI server
# proxy => 'http://localhost/', # local daemon server
# proxy => 'http://localhost/soap', # local mod_perl server
# proxy => 'https://localhost/soap', # local mod_perl SECURE server
# proxy => 'http://login:password@localhost/cgi-bin/soap.cgi', # local CGI server with authentication
;
print getStateName(1);
=item CGI server
use SOAP::Transport::HTTP;
SOAP::Transport::HTTP::CGI
# specify path to My/Examples.pm here
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'Module::Name', 'Module::method')
-> handle
;
=item Daemon server
use SOAP::Transport::HTTP;
# change LocalPort to 81 if you want to test it with soapmark.pl
my $daemon = SOAP::Transport::HTTP::Daemon
-> new (LocalAddr => 'localhost', LocalPort => 80)
# specify list of objects-by-reference here
-> objects_by_reference(qw(My::PersistentIterator My::SessionIterator My::Chat))
# specify path to My/Examples.pm here
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'Module::Name', 'Module::method')
;
print "Contact to SOAP server at ", $daemon->url, "\n";
$daemon->handle;
=item Apache mod_perl server
See F<examples/server/Apache.pm> and L</"EXAMPLES"> section for more information.
=item mod_soap server (.htaccess, directory-based access)
SetHandler perl-script
PerlHandler Apache::SOAP
PerlSetVar dispatch_to "/Your/Path/To/Deployed/Modules, Module::Name, Module::method"
PerlSetVar options "compress_threshold => 10000"
See L<Apache::SOAP> for more information.
=back
=head1 DESCRIPTION
This class encapsulates all HTTP related logic for a SOAP server,
independent of what web server it's attached to.
If you want to use this class you should follow simple guideline
mentioned above.
Following methods are available:
=over 4
=item on_action()
on_action method lets you specify SOAPAction understanding. It accepts
reference to subroutine that takes three parameters:
SOAPAction, method_uri and method_name.
C<SOAPAction> is taken from HTTP header and method_uri and method_name are
extracted from request's body. Default behavior is match C<SOAPAction> if
present and ignore it otherwise. You can specify you own, for example
die if C<SOAPAction> doesn't match with following code:
$server->on_action(sub {
(my $action = shift) =~ s/^("?)(.+)\1$/$2/;
die "SOAPAction shall match 'uri#method'\n" if $action ne join '#', @_;
});
=item dispatch_to()
dispatch_to lets you specify where you want to dispatch your services
to. More precisely, you can specify C<PATH>, C<MODULE>, C<method> or
combination C<MODULE::method>. Example:
dispatch_to(
'PATH/', # dynamic: load anything from there, any module, any method
'MODULE', # static: any method from this module
'MODULE::method', # static: specified method from this module
'method', # static: specified method from main::
);
If you specify C<PATH/> name of module/classes will be taken from uri as
path component and converted to Perl module name with substitution
'::' for '/'. Example:
urn:My/Examples => My::Examples
urn://localhost/My/Examples => My::Examples
http://localhost/My/Examples => My::Examples
For consistency first '/' in the path will be ignored.
According to this scheme to deploy new class you should put this
class in one of the specified directories and enjoy its services.
Easy, eh?
=item handle()
handle method will handle your request. You should provide parameters
with request() method, call handle() and get it back with response() .
=item request()
request method gives you access to HTTP::Request object which you
can provide for Server component to handle request.
=item response()
response method gives you access to HTTP::Response object which
you can access to get results from Server component after request was
handled.
=back
=head2 PROXY SETTINGS
You can use any proxy setting you use with LWP::UserAgent modules:
SOAP::Lite->proxy('http://endpoint.server/',
proxy => ['http' => 'http://my.proxy.server']);
or
$soap->transport->proxy('http' => 'http://my.proxy.server');
should specify proxy server for you. And if you use C<HTTP_proxy_user>
and C<HTTP_proxy_pass> for proxy authorization SOAP::Lite should know
how to handle it properly.
=head2 COOKIE-BASED AUTHENTICATION
use HTTP::Cookies;
my $cookies = HTTP::Cookies->new(ignore_discard => 1);
# you may also add 'file' if you want to keep them between sessions
my $soap = SOAP::Lite->proxy('http://localhost/');
$soap->transport->cookie_jar($cookies);
Cookies will be taken from response and provided for request. You may
always add another cookie (or extract what you need after response)
with HTTP::Cookies interface.
You may also do it in one line:
$soap->proxy('http://localhost/',
cookie_jar => HTTP::Cookies->new(ignore_discard => 1));
=head2 SSL CERTIFICATE AUTHENTICATION
To get certificate authentication working you need to specify three
environment variables: C<HTTPS_CERT_FILE>, C<HTTPS_KEY_FILE>, and
(optionally) C<HTTPS_CERT_PASS>:
$ENV{HTTPS_CERT_FILE} = 'client-cert.pem';
$ENV{HTTPS_KEY_FILE} = 'client-key.pem';
Crypt::SSLeay (which is used for https support) will take care about
everything else. Other options (like CA peer verification) can be specified
in a similar way. See Crypt::SSLeay documentation for more details.
Those who would like to use encrypted keys may check
http://groups.yahoo.com/group/soaplite/message/729 for details.
=head2 COMPRESSION
SOAP::Lite provides you with the option for enabling compression on the
wire (for HTTP transport only). Both server and client should support
this capability, but this should be absolutely transparent to your
application. The Server will respond with an encoded message only if
the client can accept it (indicated by client sending an Accept-Encoding
header with 'deflate' or '*' values) and client has fallback logic,
so if server doesn't understand specified encoding
(Content-Encoding: deflate) and returns proper error code
(415 NOT ACCEPTABLE) client will repeat the same request without encoding
and will store this server in a per-session cache, so all other requests
will go there without encoding.
Having options on client and server side that let you specify threshold
for compression you can safely enable this feature on both client and
server side.
=over 4
=item Client
print SOAP::Lite
-> uri('http://localhost/My/Parameters')
-> proxy('http://localhost/', options => {compress_threshold => 10000})
-> echo(1 x 10000)
-> result
;
=item Server
my $server = SOAP::Transport::HTTP::CGI
-> dispatch_to('My::Parameters')
-> options({compress_threshold => 10000})
-> handle;
=back
Compression will be enabled on the client side
B<if> the threshold is specified
B<and> the size of current message is bigger than the threshold
B<and> the module Compress::Zlib is available.
The Client will send the header 'Accept-Encoding' with value 'deflate'
B<if> the threshold is specified
B<and> the module Compress::Zlib is available.
Server will accept the compressed message if the module Compress::Zlib
is available, and will respond with the compressed message
B<only if> the threshold is specified
B<and> the size of the current message is bigger than the threshold
B<and> the module Compress::Zlib is available
B<and> the header 'Accept-Encoding' is presented in the request.
=head1 EXAMPLES
Consider following examples of SOAP servers:
=over 4
=item CGI:
use SOAP::Transport::HTTP;
SOAP::Transport::HTTP::CGI
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'Module::Name', 'Module::method')
-> handle
;
=item daemon:
use SOAP::Transport::HTTP;
my $daemon = SOAP::Transport::HTTP::Daemon
-> new (LocalAddr => 'localhost', LocalPort => 80)
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'Module::Name', 'Module::method')
;
print "Contact to SOAP server at ", $daemon->url, "\n";
$daemon->handle;
=item mod_perl:
httpd.conf:
<Location /soap>
SetHandler perl-script
PerlHandler SOAP::Apache
</Location>
Apache.pm:
package SOAP::Apache;
use SOAP::Transport::HTTP;
my $server = SOAP::Transport::HTTP::Apache
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'Module::Name', 'Module::method');
sub handler { $server->handler(@_) }
1;
=item Apache::Registry:
httpd.conf:
Alias /mod_perl/ "/Apache/mod_perl/"
<Location /mod_perl>
SetHandler perl-script
PerlHandler Apache::Registry
PerlSendHeader On
Options +ExecCGI
</Location>
soap.mod_cgi (put it in /Apache/mod_perl/ directory mentioned above)
use SOAP::Transport::HTTP;
SOAP::Transport::HTTP::CGI
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'Module::Name', 'Module::method')
-> handle
;
=back
WARNING: dynamic deployment with Apache::Registry will fail, because
module will be loaded dynamically only for the first time. After that
it is already in the memory, that will bypass dynamic deployment and
produces error about denied access. Specify both PATH/ and MODULE name
in dispatch_to() and module will be loaded dynamically and then will work
as under static deployment. See examples/server/soap.mod_cgi for example.
=head1 TROUBLESHOOTING
=over 4
=item Dynamic libraries are not found
If you see in webserver's log file something like this:
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.
and you are using Apache web server, try to put into your httpd.conf
<IfModule mod_env.c>
PassEnv LD_LIBRARY_PATH
</IfModule>
=item Apache is crashing with segfaults (it may looks like "500 unexpected EOF before status line seen" on client side)
If using SOAP::Lite (or XML::Parser::Expat) in combination with mod_perl
causes random segmentation faults in httpd processes try to configure
Apache with:
RULE_EXPAT=no
-- OR (for Apache 1.3.20 and later) --
./configure --disable-rule=EXPAT
See http://archive.covalent.net/modperl/2000/04/0185.xml for more
details and lot of thanks to Robert Barta <rho@bigpond.net.au> for
explaining this weird behavior.
If it doesn't help, you may also try -Uusemymalloc
(or something like that) to get perl to use the system's own malloc.
Thanks to Tim Bunce <Tim.Bunce@pobox.com>.
=item CGI scripts are not running under Microsoft Internet Information Server (IIS)
CGI scripts may not work under IIS unless scripts are .pl, not .cgi.
=back
=head1 DEPENDENCIES
Crypt::SSLeay for HTTPS/SSL
SOAP::Lite, URI for SOAP::Transport::HTTP::Server
LWP::UserAgent, URI for SOAP::Transport::HTTP::Client
HTTP::Daemon for SOAP::Transport::HTTP::Daemon
Apache, Apache::Constants for SOAP::Transport::HTTP::Apache
=head1 SEE ALSO
See ::CGI, ::Daemon and ::Apache for implementation details.
See examples/server/soap.cgi as SOAP::Transport::HTTP::CGI example.
See examples/server/soap.daemon as SOAP::Transport::HTTP::Daemon example.
See examples/My/Apache.pm as SOAP::Transport::HTTP::Apache example.
=head1 COPYRIGHT
Copyright (C) 2000-2001 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 AUTHOR
Paul Kulchenko (paulclinger@yahoo.com)
=cut
|