| HTTP-Server-Simple documentation | Contained in the HTTP-Server-Simple distribution. |
HTTP::Server::Simple - Lightweight HTTP server
use warnings; use strict; use HTTP::Server::Simple; my $server = HTTP::Server::Simple->new(); $server->run();
However, normally you will sub-class the HTTP::Server::Simple::CGI module (see HTTP::Server::Simple::CGI);
package Your::Web::Server;
use base qw(HTTP::Server::Simple::CGI);
sub handle_request {
my ($self, $cgi) = @_;
#... do something, print output to default
# selected filehandle...
}
1;
This is a simple standalone HTTP server. By default, it doesn't thread or fork. It does, however, act as a simple frontend which can be used to build a standalone web-based application or turn a CGI into one.
It is possible to use Net::Server classes to create forking, pre-forking, and other types of more complicated servers; see net_server.
By default, the server traps a few signals:
When you kill -HUP the server, it lets the current request finish being
processed, then uses the restart method to re-exec itself. Please note that
in order to provide restart-on-SIGHUP, HTTP::Server::Simple sets a SIGHUP
handler during initialisation. If your request handling code forks you need to
make sure you reset this or unexpected things will happen if somebody sends a
HUP to all running processes spawned by your app (e.g. by "kill -HUP <script>")
If the server detects a broken pipe while writing output to the client, it ignores the signal. Otherwise, a client closing the connection early could kill the server.
#!/usr/bin/perl
{
package MyWebServer;
use HTTP::Server::Simple::CGI;
use base qw(HTTP::Server::Simple::CGI);
my %dispatch = (
'/hello' => \&resp_hello,
# ...
);
sub handle_request {
my $self = shift;
my $cgi = shift;
my $path = $cgi->path_info();
my $handler = $dispatch{$path};
if (ref($handler) eq "CODE") {
print "HTTP/1.0 200 OK\r\n";
$handler->($cgi);
} else {
print "HTTP/1.0 404 Not found\r\n";
print $cgi->header,
$cgi->start_html('Not found'),
$cgi->h1('Not found'),
$cgi->end_html;
}
}
sub resp_hello {
my $cgi = shift; # CGI.pm object
return if !ref $cgi;
my $who = $cgi->param('name');
print $cgi->header,
$cgi->start_html("Hello"),
$cgi->h1("Hello $who!"),
$cgi->end_html;
}
}
# start the server on port 8080
my $pid = MyWebServer->new(8080)->background();
print "Use 'kill $pid' to stop server.\n";
API call to start a new server. Does not actually start listening
until you call ->run(). If omitted, $port defaults to 8080.
Looks up the local host's IP address, and returns it. For most hosts,
this is 127.0.0.1.
Takes an optional port number for this server to listen on.
Returns this server's port. (Defaults to 8080)
Takes an optional host address for this server to bind to.
Returns this server's bound address (if any). Defaults to undef
(bind to all interfaces).
Runs the server in the background, and returns the process ID of the started process. Any arguments will be passed through to run.
Run the server. If all goes well, this won't ever return, but it will
start listening for HTTP requests. Any arguments passed to this
will be passed on to the underlying Net::Server implementation, if
one is used (see net_server).
User-overridable method. If you set it to a Net::Server subclass,
that subclass is used for the run method. Otherwise, a minimal
implementation is used as default.
Restarts the server. Usually called by a HUP signal, not directly.
When called with an argument, sets the socket to the server to that arg.
Returns the socket to the server; you should only use this for actual socket-related
calls like getsockname. If all you want is to read or write to the socket,
you should use stdin_handle and stdout_handle to get the in and out filehandles
explicitly.
Returns a filehandle used for input from the client. By default,
returns whatever was set with stdio_handle, but a subclass could do
something interesting here.
Returns a filehandle used for output to the client. By default,
returns whatever was set with stdio_handle, but a subclass
could do something interesting here.
A selection of these methods should be provided by sub-classes of this module.
This method is called after setup, with no parameters. It should print a valid, full HTTP response to the default selected filehandle.
This method is called with a name => value list of various things to do with the request. This list is given below.
The default setup handler simply tries to call methods with the names of keys of this list.
ITEM/METHOD Set to Example ----------- ------------------ ------------------------ method Request Method "GET", "POST", "HEAD" protocol HTTP version "HTTP/1.1" request_uri Complete Request URI "/foobar/baz?foo=bar" path Path part of URI "/foobar/baz" query_string Query String undef, "foo=bar" port Received Port 80, 8080 peername Remote name "200.2.4.5", "foo.com" peeraddr Remote address "200.2.4.5", "::1" peerport Remote port 42424 localname Local interface "localhost", "myhost.com"
Receives HTTP headers and does something useful with them. This is
called by the default setup() method.
You have lots of options when it comes to how you receive headers.
You can, if you really want, define parse_headers() and parse them
raw yourself.
Secondly, you can intercept them very slightly cooked via the
setup() method, above.
Thirdly, you can leave the setup() header as-is (or calling the
superclass setup() for unknown request items). Then you can define
headers() in your sub-class and receive them all at once.
Finally, you can define handlers to receive individual HTTP headers. This can be useful for very simple SOAP servers (to name a crack-fueled standard that defines its own special HTTP headers).
To do so, you'll want to define the header() method in your subclass.
That method will be handed a (key,value) pair of the header name and the value.
If defined by a sub-class, this method is called directly after an accept happens. An accept_hook to add SSL support might look like this:
sub accept_hook {
my $self = shift;
my $fh = $self->stdio_handle;
$self->SUPER::accept_hook(@_);
my $newfh =
IO::Socket::SSL->start_SSL( $fh,
SSL_server => 1,
SSL_use_cert => 1,
SSL_cert_file => 'myserver.crt',
SSL_key_file => 'myserver.key',
)
or warn "problem setting up SSL socket: " . IO::Socket::SSL::errstr();
$self->stdio_handle($newfh) if $newfh;
}
If defined by a sub-class, this method is called after all setup has finished, before the handler method.
Parse the HTTP request line. Returns three values, the request method, request URI and the protocol.
Parses incoming HTTP headers from STDIN, and returns an arrayref of
(header => value) pairs. See headers for possibilities on
how to inspect headers.
This routine binds the server to a port and interface.
This method is called immediately after setup_listener. It's here just for you to override.
This method should print a valid HTTP response that says that the request was invalid.
Given a candidate HTTP method in $method, determine if it is valid.
Override if, for example, you'd like to do some WebDAV. The default
implementation only accepts GET, POST, HEAD, PUT, and
DELETE.
Copyright (c) 2004-2008 Jesse Vincent, <jesse@bestpractical.com>. All rights reserved.
Marcus Ramberg <drave@thefeed.no> contributed tests, cleanup, etc
Sam Vilain, <samv@cpan.org> contributed the CGI.pm split-out and header/setup API.
Example section by almut on perlmonks, suggested by Mark Fuller.
There certainly are some. Please report them via rt.cpan.org
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| HTTP-Server-Simple documentation | Contained in the HTTP-Server-Simple distribution. |
use strict; use warnings; package HTTP::Server::Simple; use FileHandle; use Socket; use Carp; use vars qw($VERSION $bad_request_doc); $VERSION = '0.44';
sub new { my ( $proto, $port ) = @_; my $class = ref($proto) || $proto; if ( $class eq __PACKAGE__ ) { require HTTP::Server::Simple::CGI; return HTTP::Server::Simple::CGI->new( @_[ 1 .. $#_ ] ); } my $self = {}; bless( $self, $class ); $self->port( $port || '8080' ); return $self; }
sub lookup_localhost { my $self = shift; my $local_sockaddr = getsockname( $self->stdio_handle ); my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr); $self->host( gethostbyaddr( $localiaddr, AF_INET ) || "localhost"); $self->{'local_addr'} = inet_ntoa($localiaddr) || "127.0.0.1"; }
sub port { my $self = shift; $self->{'port'} = shift if (@_); return ( $self->{'port'} ); }
sub host { my $self = shift; $self->{'host'} = shift if (@_); return ( $self->{'host'} ); }
sub background { my $self = shift; my $child = fork; croak "Can't fork: $!" unless defined($child); return $child if $child; srand(); # after a fork, we need to reset the random seed # or we'll get the same numbers in both branches if ( $^O !~ /MSWin32/ ) { require POSIX; POSIX::setsid() or croak "Can't start a new session: $!"; } $self->run(@_); # should never return exit; # just to be sure }
my $server_class_id = 0; use vars '$SERVER_SHOULD_RUN'; $SERVER_SHOULD_RUN = 1; sub run { my $self = shift; my $server = $self->net_server; local $SIG{CHLD} = 'IGNORE'; # reap child processes # $pkg is generated anew for each invocation to "run" # Just so we can use different net_server() implementations # in different runs. my $pkg = join '::', ref($self), "NetServer" . $server_class_id++; no strict 'refs'; *{"$pkg\::process_request"} = $self->_process_request; if ($server) { require join( '/', split /::/, $server ) . '.pm'; *{"$pkg\::ISA"} = [$server]; # clear the environment before every request require HTTP::Server::Simple::CGI; *{"$pkg\::post_accept"} = sub { HTTP::Server::Simple::CGI::Environment->setup_environment; # $self->SUPER::post_accept uses the wrong super package $server->can('post_accept')->(@_); }; } else { $self->setup_listener; $self->after_setup_listener(); *{"$pkg\::run"} = $self->_default_run; } local $SIG{HUP} = sub { $SERVER_SHOULD_RUN = 0; }; $pkg->run( port => $self->port, @_ ); }
sub net_server {undef} sub _default_run { my $self = shift; # Default "run" closure method for a stub, minimal Net::Server instance. return sub { my $pkg = shift; $self->print_banner; while ($SERVER_SHOULD_RUN) { local $SIG{PIPE} = 'IGNORE'; # If we don't ignore SIGPIPE, a # client closing the connection before we # finish sending will cause the server to exit while ( accept( my $remote = new FileHandle, HTTPDaemon ) ) { $self->stdio_handle($remote); $self->lookup_localhost() unless ($self->host); $self->accept_hook if $self->can("accept_hook"); *STDIN = $self->stdin_handle(); *STDOUT = $self->stdout_handle(); select STDOUT; # required for HTTP::Server::Simple::Recorder # XXX TODO glasser: why? $pkg->process_request; close $remote; } } # Got here? Time to restart, due to SIGHUP $self->restart; }; }
sub restart { my $self = shift; close HTTPDaemon; $SIG{CHLD} = 'DEFAULT'; wait; ### if the standalone server was invoked with perl -I .. we will loose ### those include dirs upon re-exec. So add them to PERL5LIB, so they ### are available again for the exec'ed process --kane use Config; $ENV{PERL5LIB} .= join $Config{path_sep}, @INC; # Server simple # do the exec. if $0 is not executable, try running it with $^X. exec {$0}( ( ( -x $0 ) ? () : ($^X) ), $0, @ARGV ); } sub _process_request { my $self = shift; # Create a callback closure that is invoked for each incoming request; # the $self above is bound into the closure. sub { $self->stdio_handle(*STDIN) unless $self->stdio_handle; # Default to unencoded, raw data out. # if you're sending utf8 and latin1 data mixed, you may need to override this binmode STDIN, ':raw'; binmode STDOUT, ':raw'; # The ternary operator below is to protect against a crash caused by IE # Ported from Catalyst::Engine::HTTP (Originally by Jasper Krogh and Peter Edwards) # ( http://dev.catalyst.perl.org/changeset/5195, 5221 ) my $remote_sockaddr = getpeername( $self->stdio_handle ); my ( $iport, $iaddr ) = $remote_sockaddr ? sockaddr_in($remote_sockaddr) : (undef,undef); my $peeraddr = $iaddr ? ( inet_ntoa($iaddr) || "127.0.0.1" ) : '127.0.0.1'; my ( $method, $request_uri, $proto ) = $self->parse_request; unless ($self->valid_http_method($method) ) { $self->bad_request; return; } $proto ||= "HTTP/0.9"; my ( $file, $query_string ) = ( $request_uri =~ /([^?]*)(?:\?(.*))?/s ); # split at ? $self->setup( method => $method, protocol => $proto, query_string => ( defined($query_string) ? $query_string : '' ), request_uri => $request_uri, path => $file, localname => $self->host, localport => $self->port, peername => $peeraddr, peeraddr => $peeraddr, peerport => $iport, ); # HTTP/0.9 didn't have any headers (I think) if ( $proto =~ m{HTTP/(\d(\.\d)?)$} and $1 >= 1 ) { my $headers = $self->parse_headers or do { $self->bad_request; return }; $self->headers($headers); } $self->post_setup_hook if $self->can("post_setup_hook"); $self->handler; } }
sub stdio_handle { my $self = shift; $self->{'_stdio_handle'} = shift if (@_); return $self->{'_stdio_handle'}; }
sub stdin_handle { my $self = shift; return $self->stdio_handle; }
sub stdout_handle { my $self = shift; return $self->stdio_handle; }
sub handler { my ($self) = @_; if ( ref($self) ne __PACKAGE__ ) { croak "do not call " . ref($self) . "::SUPER->handler"; } else { croak "handler called out of context"; } }
sub setup { my $self = shift; while ( my ( $item, $value ) = splice @_, 0, 2 ) { $self->$item($value) if $self->can($item); } }
sub headers { my $self = shift; my $headers = shift; my $can_header = $self->can("header"); return unless $can_header; while ( my ( $header, $value ) = splice @$headers, 0, 2 ) { $self->header( $header => $value ); } }
sub print_banner { my $self = shift; print( ref($self) . ": You can connect to your server at " . "http://localhost:" . $self->port . "/\n" ); }
sub parse_request { my $self = shift; my $chunk; while ( sysread( STDIN, my $buff, 1 ) ) { last if $buff eq "\n"; $chunk .= $buff; } defined($chunk) or return undef; $_ = $chunk; m/^(\w+)\s+(\S+)(?:\s+(\S+))?\r?$/; my $method = $1 || ''; my $uri = $2 || ''; my $protocol = $3 || ''; return ( $method, $uri, $protocol ); }
sub parse_headers { my $self = shift; my @headers; my $chunk = ''; while ( sysread( STDIN, my $buff, 1 ) ) { if ( $buff eq "\n" ) { $chunk =~ s/[\r\l\n\s]+$//; if ( $chunk =~ /^([^()<>\@,;:\\"\/\[\]?={} \t]+):\s*(.*)/i ) { push @headers, $1 => $2; } last if ( $chunk =~ /^$/ ); $chunk = ''; } else { $chunk .= $buff } } return ( \@headers ); }
sub setup_listener { my $self = shift; my $tcp = getprotobyname('tcp'); socket( HTTPDaemon, PF_INET, SOCK_STREAM, $tcp ) or croak "socket: $!"; setsockopt( HTTPDaemon, SOL_SOCKET, SO_REUSEADDR, pack( "l", 1 ) ) or warn "setsockopt: $!"; bind( HTTPDaemon, sockaddr_in( $self->port(), ( $self->host ? inet_aton( $self->host ) : INADDR_ANY ) ) ) or croak "bind to @{[$self->host||'*']}:@{[$self->port]}: $!"; listen( HTTPDaemon, SOMAXCONN ) or croak "listen: $!"; }
sub after_setup_listener { }
$bad_request_doc = join "", <DATA>; sub bad_request { my $self = shift; print "HTTP/1.0 400 Bad request\r\n"; # probably OK by now print "Content-Type: text/html\r\nContent-Length: ", length($bad_request_doc), "\r\n\r\n", $bad_request_doc; }
sub valid_http_method { my $self = shift; my $method = shift or return 0; return $method =~ /^(?:GET|POST|HEAD|PUT|DELETE)$/; }
1; __DATA__ <html> <head> <title>Bad Request</title> </head> <body> <h1>Bad Request</h1> <p>Your browser sent a request which this web server could not grok.</p> </body> </html>