# Declare our package
package POE::Component::Server::SimpleHTTP;

# Standard stuff to catch errors
use strict qw(subs vars refs);    # Make sure we can't mess up
use warnings;

use vars qw($VERSION);

# Initialize our version
# $Revision: 1181 $
$VERSION = '1.54';

# Import what we need from the POE namespace
use POE;
use POE::Wheel::SocketFactory;
use POE::Wheel::ReadWrite;
use POE::Driver::SysRW;
use POE::Filter::HTTPD;
use POE::Filter::Stream;

# Other miscellaneous modules we need
use Carp qw( croak );
use Socket;

# HTTP-related modules
use HTTP::Date qw( time2str );

# Our own HTTP modules
use POE::Component::Server::SimpleHTTP::Connection;
use POE::Component::Server::SimpleHTTP::Response;

#sub DEBUG {1}
#Set some constants
BEGIN {

   # Debug fun!
   if ( !defined &DEBUG ) {
      eval "sub DEBUG () { 0 }";
   }

   # Our own definition of the max retries
   if ( !defined &MAX_RETRIES ) {
      eval "sub MAX_RETRIES () { 5 }";
   }
}

# Set things in motion!
sub new {

   # Get the OOP's type
   my $type = shift;

   # Sanity checking
   if ( @_ & 1 ) {
      croak(
         'POE::Component::Server::SimpleHTTP->new needs even number of options'
      );
   }

   # The options hash
   my %opt = @_;
   $opt{ uc $_ } = delete $opt{$_}
     for keys %opt;    # Fix that pesky uppercase option stuff.

   # Our own options
   my (
      $ALIAS,        $ADDRESS,      $PORT,        $HOSTNAME,
      $HEADERS,      $HANDLERS,     $SSLKEYCERT,  $LOGHANDLER,
      $ERRORHANDLER, $SETUPHANDLER, $LOG2HANDLER, $PROXYMODE
   );

   # You could say I should do this: $Stuff = delete $opt{'Stuff'}
   # But, that kind of behavior is not defined, so I would not trust it...

   # Get the SSL array
   if ( exists $opt{'SSLKEYCERT'} and defined $opt{'SSLKEYCERT'} ) {

      # Test if it is an array
      if ( ref( $opt{'SSLKEYCERT'} ) eq 'ARRAY'
         and scalar( @{ $opt{'SSLKEYCERT'} } ) == 2 )
      {
         $SSLKEYCERT = $opt{'SSLKEYCERT'};
         delete $opt{'SSLKEYCERT'};

         # Okay, pull in what is necessary
         eval {
            require POE::Component::SSLify;
            import POE::Component::SSLify
              qw( SSLify_Options SSLify_GetSocket Server_SSLify SSLify_GetCipher );
            SSLify_Options(@$SSLKEYCERT);
         };
         if ($@) {
            if (DEBUG) {
               warn "Unable to load PoCo::SSLify -> $@";
            }

            # Force ourself to not use SSL
            $SSLKEYCERT = undef;
         }
      }
      else {
         if (DEBUG) {
            warn
'The SSLKEYCERT option must be an array with exactly 2 elements in it!';
         }
      }
   }
   else {
      $SSLKEYCERT = undef;
   }

   # Get the session alias
   if (   exists $opt{'ALIAS'}
      and defined $opt{'ALIAS'}
      and length( $opt{'ALIAS'} ) )
   {
      $ALIAS = $opt{'ALIAS'};
      delete $opt{'ALIAS'};
   }

   # Get the PORT
   if (   exists $opt{'PORT'}
      and defined $opt{'PORT'}
      and length( $opt{'PORT'} ) )
   {
      $PORT = $opt{'PORT'};
      delete $opt{'PORT'};
   }
   else {
      croak(
'PORT is required to create a new POE::Component::Server::SimpleHTTP instance!'
      );
   }

# BinGOS was here: This is unecessary, fall back on default SocketFactory behaviour.
# Get the ADDRESS
#if ( exists $opt{'ADDRESS'} and defined $opt{'ADDRESS'} and length( $opt{'ADDRESS'} ) ) {
#	$ADDRESS = $opt{'ADDRESS'};
#	delete $opt{'ADDRESS'};
#} else {
#	croak( 'ADDRESS is required to create a new POE::Component::Server::SimpleHTTP instance!' );
#}

   # Get the HOSTNAME
   if (   exists $opt{'HOSTNAME'}
      and defined $opt{'HOSTNAME'}
      and length( $opt{'HOSTNAME'} ) )
   {
      $HOSTNAME = $opt{'HOSTNAME'};
      delete $opt{'HOSTNAME'};
   }
   else {
      if (DEBUG) {
         warn 'Using Sys::Hostname for HOSTNAME';
      }

      # Figure out the hostname
      require Sys::Hostname;
      $HOSTNAME = Sys::Hostname::hostname();

      # Get rid of any lingering HOSTNAME
      if ( exists $opt{'HOSTNAME'} ) {
         delete $opt{'HOSTNAME'};
      }
   }

   # Get the HEADERS
   if ( exists $opt{'HEADERS'} and defined $opt{'HEADERS'} ) {

      # Make sure it is ref to hash
      if ( ref $opt{'HEADERS'} and ref( $opt{'HEADERS'} ) eq 'HASH' ) {
         $HEADERS = $opt{'HEADERS'};
         delete $opt{'HEADERS'};
      }
      else {
         croak('HEADERS must be a reference to a HASH!');
      }
   }
   else {

      # Set to none
      $HEADERS = {};

      # Get rid of any lingering HEADERS
      if ( exists $opt{'HEADERS'} ) {
         delete $opt{'HEADERS'};
      }
   }

   # Get the HANDLERS
   if ( exists $opt{'HANDLERS'} and defined $opt{'HANDLERS'} ) {

      # Make sure it is ref to array
      if ( ref $opt{'HANDLERS'} and ref( $opt{'HANDLERS'} ) eq 'ARRAY' ) {
         $HANDLERS = $opt{'HANDLERS'};
         delete $opt{'HANDLERS'};
      }
      else {
         croak('HANDLERS must be a reference to an ARRAY!');
      }
   }
   else {
      croak(
'HANDLERS is required to create a new POE::Component::Server::SimpleHTTP instance!'
      );
   }

   # Get the ERRORHANDLER handler
   if ( exists $opt{'ERRORHANDLER'} and defined $opt{'ERRORHANDLER'} ) {

      # Make sure it is ref to an hash
      if ( ref $opt{'ERRORHANDLER'} and ref( $opt{'ERRORHANDLER'} ) eq 'HASH' )
      {
         $ERRORHANDLER = delete $opt{'ERRORHANDLER'};
         croak('ERRORHANDLER does not have a SESSION attribute')
           unless $ERRORHANDLER->{'SESSION'};
         croak('ERRORHANDLER does not have an EVENT attribute')
           unless $ERRORHANDLER->{'EVENT'};
      }
      else {
         croak('ERRORHANDLER must be a reference to an HASH!');
      }
   }

   if ( exists $opt{'LOGHANDLER'} and defined $opt{'LOGHANDLER'} ) {
      if ( ref $opt{'LOGHANDLER'} and ref $opt{'LOGHANDLER'} eq 'HASH' ) {
         $LOGHANDLER = delete $opt{'LOGHANDLER'};
         croak('LOGHANDLER does not have a SESSION attribute')
           unless $LOGHANDLER->{'SESSION'};
         croak('LOGHANDLER does not have an EVENT attribute')
           unless $LOGHANDLER->{'EVENT'};
      }
      else {
         croak('LOGHANDLER must be a reference to an HASH!');
      }
   }

   if ( exists $opt{'LOG2HANDLER'} and defined $opt{'LOG2HANDLER'} ) {
      if ( ref $opt{'LOG2HANDLER'} and ref $opt{'LOG2HANDLER'} eq 'HASH' ) {
         $LOG2HANDLER = delete $opt{'LOG2HANDLER'};
         croak('LOG2HANDLER does not have a SESSION attribute')
           unless $LOG2HANDLER->{'SESSION'};
         croak('LOG2HANDLER does not have an EVENT attribute')
           unless $LOG2HANDLER->{'EVENT'};
      }
      else {
         croak('LOG2HANDLER must be a reference to an HASH!');
      }
   }

   if ( exists $opt{'SETUPHANDLER'} and defined $opt{'SETUPHANDLER'} ) {
      if ( ref $opt{'SETUPHANDLER'} and ref $opt{'SETUPHANDLER'} eq 'HASH' ) {
         $SETUPHANDLER = delete $opt{'SETUPHANDLER'};
         croak('SETUPHANDLER does not have a SESSION attribute')
           unless $SETUPHANDLER->{'SESSION'};
         croak('SETUPHANDLER does not have an EVENT attribute')
           unless $SETUPHANDLER->{'EVENT'};
      }
      else {
         croak('SETUPHANDLER must be a reference to an HASH!');
      }
   }

   $PROXYMODE = $opt{'PROXYMODE'};

   my $KEEPALIVE = 0;
   if ( exists $opt{'KEEPALIVE'} ) {
      $KEEPALIVE = delete $opt{'KEEPALIVE'};
   }

   # Anything left over is unrecognized
   if (DEBUG) {
      if ( keys %opt > 0 ) {
         croak(
'Unrecognized options were present in POE::Component::Server::SimpleHTTP->new -> '
              . join( ', ', keys %opt ) );
      }
   }

   my $data = {
      'ALIAS'        => $ALIAS,
      'ADDRESS'      => $ADDRESS,
      'PORT'         => $PORT,
      'HEADERS'      => $HEADERS,
      'HOSTNAME'     => $HOSTNAME,
      'HANDLERS'     => $HANDLERS,
      'REQUESTS'     => {},
      'RETRIES'      => 0,
      'SSLKEYCERT'   => $SSLKEYCERT,
      'LOGHANDLER'   => $LOGHANDLER,
      'LOG2HANDLER'  => $LOG2HANDLER,
      'SETUPHANDLER' => $SETUPHANDLER,
      'ERRORHANDLER' => $ERRORHANDLER,
      'PROXYMODE'    => $PROXYMODE,
      'KEEPALIVE'    => $KEEPALIVE
   };

   my $self = bless $data, $type;

   # Create a new session for ourself
   $self->{SESSION_ID} = POE::Session->create(

      # Our subroutines
      'inline_states' => {

         # Maintenance events
         '_start' => \&StartServer,
         '_stop'  => \&FindRequestLeaks,
         '_child' => sub { },

         # Register states
         'REGISTER' => \&Register,

         # HANDLER stuff
         'GETHANDLERS' => \&GetHandlers,
         'SETHANDLERS' => \&SetHandlers,

         # SocketFactory events
         'SHUTDOWN'      => \&StopServer,
         'STOPLISTEN'    => \&StopListen,
         'STARTLISTEN'   => \&StartListen,
         'SetupListener' => \&SetupListener,
         'ListenerError' => \&ListenerError,

         # Wheel::ReadWrite stuff
         'Got_Connection' => \&Got_Connection,
         'Got_Input'      => \&Got_Input,
         'Got_Flush'      => \&Got_Flush,
         'Got_Error'      => \&Got_Error,

         # Send output to connection!
         'DONE' => \&Request_Output,

         # Stream output to connection!
         'STREAM' => \&Stream_Output,

         # Kill the connection!
         'CLOSE' => \&Request_Close,

         # Set close handler for a connection
         'SETCLOSEHANDLER' => \&SetCloseHandler
      },

      # Set up the heap for ourself
      'heap' => $self,
   )->ID();

   # Return success
   return $self;
}

sub session_id {
   $_[0]->{SESSION_ID};
}

sub getsockname {
   $_[0]->{SOCKETFACTORY}->getsockname;
}

sub shutdown {
   my $self = shift;
   $poe_kernel->call( $self->{SESSION_ID}, 'SHUTDOWN', @_ );
}

# This subroutine, when SimpleHTTP exits, will search for leaks
sub FindRequestLeaks {

   # Loop through all of the requests
   foreach my $req ( keys %{ $_[HEAP]->{'REQUESTS'} } ) {

      # Bite the programmer!
      warn 'Did not get DONE/CLOSE event for Wheel ID ' 
        . $req
        . ' from IP '
        . $_[HEAP]->{'REQUESTS'}->{$req}->[2]->connection->remote_ip;
   }

   # All done!
   return 1;
}

# Starts the server!
sub StartServer {
   my $heap = $_[HEAP];

   # Debug stuff
   if (DEBUG) {
      warn 'Starting up SimpleHTTP now';
   }

   $heap->{SESSION_ID} = $_[SESSION]->ID();

   # Register an alias for ourself
   $poe_kernel->alias_set( $heap->{'ALIAS'} ) if $heap->{'ALIAS'};
   $poe_kernel->refcount_increment( $heap->{SESSION_ID}, __PACKAGE__ )
     unless $heap->{'ALIAS'};

   # Massage the handlers!
   MassageHandlers( $heap->{'HANDLERS'} );

   # Setup the wheel
   $poe_kernel->yield('SetupListener');

   # All done!
   return 1;
}

# Stops the server!
sub StopServer {

   # Shutdown the SocketFactory wheel
   if ( exists $_[HEAP]->{'SOCKETFACTORY'} ) {
      delete $_[HEAP]->{'SOCKETFACTORY'};
   }

   # Debug stuff
   if (DEBUG) {
      warn 'Stopped listening for new connections!';
   }

   # Are we gracefully shutting down or not?
   if ( defined $_[ARG0] and $_[ARG0] eq 'GRACEFUL' ) {

      # Check for number of requests
      if ( keys( %{ $_[HEAP]->{'REQUESTS'} } ) == 0 ) {

         # Alright, shutdown anyway

         # Delete our alias
         $_[KERNEL]->alias_remove( $_[HEAP]->{'ALIAS'} ) if $_[HEAP]->{'ALIAS'};
         $_[KERNEL]->refcount_decrement( $_[HEAP]->{'SESSION_ID'}, __PACKAGE__ )
           unless $_[HEAP]->{'ALIAS'};

         # Debug stuff
         if (DEBUG) {
            warn 'Stopped SimpleHTTP gracefully, no requests left';
         }
      }

      # All done!
      return 1;
   }

   # Forcibly close all sockets that are open
   foreach my $S ( $_[HEAP]->{'REQUESTS'}, $_[HEAP]->{'CONNECTIONS'} ) {
      foreach my $conn ( keys %$S ) {

   # Can't call method "shutdown_input" on an undefined value at
   # /usr/lib/perl5/site_perl/5.8.2/POE/Component/Server/SimpleHTTP.pm line 323.
         if (   defined $S->{$conn}->[0]
            and defined $S->{$conn}->[0]->[POE::Wheel::ReadWrite::HANDLE_INPUT]
           )
         {
            $S->{$conn}->[0]->shutdown_input;
            $S->{$conn}->[0]->shutdown_output;
         }

         # Delete this request
         delete $S->{$conn};
      }
   }

   # Delete our alias
   $_[KERNEL]->alias_remove( $_[HEAP]->{'ALIAS'} ) if $_[HEAP]->{'ALIAS'};
   $_[KERNEL]->refcount_decrement( $_[HEAP]->{'SESSION_ID'}, __PACKAGE__ )
     unless $_[HEAP]->{'ALIAS'};

   # Debug stuff
   if (DEBUG) {
      warn 'Successfully stopped SimpleHTTP';
   }

   # Return success
   return 1;
}

# Sets up the SocketFactory wheel :)
sub SetupListener {

   # Debug stuff
   my $heap = $_[HEAP];
   if (DEBUG) {
      warn 'Creating SocketFactory wheel now';
   }

   # Check if we should set up the wheel
   if ( $heap->{'RETRIES'} == MAX_RETRIES ) {
      die 'POE::Component::Server::SimpleHTTP tried '
        . MAX_RETRIES
        . ' times to create a Wheel and is giving up...';
   }
   else {

      # Increment the retry count if we did not get 'NOINC' as an argument
      if ( !defined $_[ARG0] ) {

         # Increment the retries count
         $heap->{'RETRIES'}++;
      }

      # Create our own SocketFactory Wheel :)
      $heap->{'SOCKETFACTORY'} = POE::Wheel::SocketFactory->new(
         'BindPort'     => $heap->{'PORT'},
         'BindAddress'  => $heap->{'ADDRESS'},
         'Reuse'        => 'yes',
         'SuccessEvent' => 'Got_Connection',
         'FailureEvent' => 'ListenerError',
      );
      my ( $port, $address ) =
        sockaddr_in( $heap->{'SOCKETFACTORY'}->getsockname );
      $heap->{'PORT'} = $port if $heap->{'PORT'} == 0;
      $poe_kernel->post(
         $heap->{'SETUPHANDLER'}->{'SESSION'},
         $heap->{'SETUPHANDLER'}->{'EVENT'},
         $port, $address,
      ) if $heap->{'SETUPHANDLER'};
   }

   # Success!
   return 1;
}

# Got some sort of error from SocketFactory
sub ListenerError {

   # ARG0 = operation, ARG1 = error number, ARG2 = error string, ARG3 = wheel ID
   my ( $operation, $errnum, $errstr, $wheel_id ) = @_[ ARG0 .. ARG3 ];

   # Debug stuff
   if (DEBUG) {
      warn
"SocketFactory Wheel $wheel_id generated $operation error $errnum: $errstr\n";
   }

   # Setup the SocketFactory wheel
   $_[KERNEL]->call( $_[SESSION], 'SetupListener' );

   # Success!
   return 1;
}

# Starts listening on the socket
sub StartListen {
   if (DEBUG) {
      warn 'STARTLISTEN called, resuming accepts on SocketFactory';
   }

   # Setup the SocketFactory wheel
   $_[KERNEL]->call( $_[SESSION], 'SetupListener', 'NOINC' );

   # All done!
   return 1;
}

# Stops listening on the socket
sub StopListen {
   if (DEBUG) {
      warn 'STOPLISTEN called, pausing accepts on SocketFactory';
   }

   # We have to get rid of the SocketFactory wheel...
   if ( exists $_[HEAP]->{'SOCKETFACTORY'} ) {
      $_[HEAP]->{'SOCKETFACTORY'} = undef;
   }

   # All done!
   return 1;
}

# Sets the HANDLERS
sub SetHandlers {

   # ARG0 = ref to handlers array
   my $handlers = $_[ARG0];

   # Validate it...
   MassageHandlers($handlers);

   # If we got here, passed tests!
   $_[HEAP]->{'HANDLERS'} = $handlers;

   # All done!
   return 1;
}

# Gets the HANDLERS
sub GetHandlers {

   # ARG0 = session, ARG1 = event
   my ( $session, $event ) = @_[ ARG0, ARG1 ];

   # Validation
   if ( !defined $session or !defined $event ) {
      return undef;
   }

   # Make a deep copy of the handlers
   require Storable;

   my $handlers = Storable::dclone( $_[HEAP]->{'HANDLERS'} );

   # Remove the RE part
   foreach my $ary (@$handlers) {
      delete $ary->{'RE'};
   }

   # All done!
   $_[KERNEL]->post( $session, $event, $handlers );

   # All done!
   return 1;
}

# This subroutine massages the HANDLERS for internal use
sub MassageHandlers {

   # Get the ref to handlers
   my $handler = shift;

   # Make sure it is ref to array
   if ( !ref $handler or ref($handler) ne 'ARRAY' ) {
      croak("HANDLERS is not a ref to an array!");
   }

   # Massage the handlers
   my $count = 0;
   while ( $count < scalar(@$handler) ) {

      # Must be ref to hash
      if ( ref $handler->[$count] and ref( $handler->[$count] ) eq 'HASH' ) {

         # Make sure all the keys are uppercase
         $handler->[$count]->{ uc $_ } = delete $handler->[$count]->{$_}
           for keys %{ $handler->[$count] };

         # Make sure it got the 3 parts necessary
         if (  !exists $handler->[$count]->{'SESSION'}
            or !defined $handler->[$count]->{'SESSION'} )
         {
            croak("HANDLER number $count does not have a SESSION argument!");
         }
         if (  !exists $handler->[$count]->{'EVENT'}
            or !defined $handler->[$count]->{'EVENT'} )
         {
            croak("HANDLER number $count does not have an EVENT argument!");
         }
         if (  !exists $handler->[$count]->{'DIR'}
            or !defined $handler->[$count]->{'DIR'} )
         {
            croak("HANDLER number $count does not have a DIR argument!");
         }

         # Convert SESSION to ID
         if (
            UNIVERSAL::isa( $handler->[$count]->{'SESSION'}, 'POE::Session' ) )
         {
            $handler->[$count]->{'SESSION'} =
              $handler->[$count]->{'SESSION'}->ID;
         }

         # Convert DIR to qr// format
         my $regex = undef;
         eval { $regex = qr/$handler->[ $count ]->{'DIR'}/ };

         # Check for errors
         if ($@) {
            croak("HANDLER number $count has a malformed DIR -> $@");
         }
         else {

            # Store it!
            $handler->[$count]->{'RE'} = $regex;
         }
      }
      else {
         croak("HANDLER number $count is not a reference to a HASH!");
      }

      # Done with this one!
      $count++;
   }

   # Got here, success!
   return 1;
}

# The actual manager of connections
sub Got_Connection {

   # ARG0 = Socket, ARG1 = Remote Address, ARG2 = Remote Port
   my $socket = $_[ARG0];

   # Should we SSLify it?
   if ( defined $_[HEAP]->{'SSLKEYCERT'} ) {

      # SSLify it!
      eval { $socket = Server_SSLify($socket) };
      if ($@) {
         warn "Unable to turn on SSL for connection from "
           . Socket::inet_ntoa( $_[ARG1] )
           . " -> $@";
         close $socket;
         return 1;
      }
   }

   # Set up the Wheel to read from the socket
   my $wheel = POE::Wheel::ReadWrite->new(
      'Handle'       => $socket,
      'Driver'       => POE::Driver::SysRW->new(),
      'Filter'       => POE::Filter::HTTPD->new(),
      'InputEvent'   => 'Got_Input',
      'FlushedEvent' => 'Got_Flush',
      'ErrorEvent'   => 'Got_Error',
   );

   if ( DEBUG and keys %{ $_[HEAP]->{CONNECTIONS} } ) {

      # use Data::Dumper;
      warn "conn id=", $wheel->ID, " [",
        join( ', ', keys %{ $_[HEAP]->{CONNECTIONS} } ), "]";
   }

   # Save this wheel!
   # 0 = wheel, 1 = Output done?, 2 = SimpleHTTP::Response object
   $_[HEAP]->{'REQUESTS'}->{ $wheel->ID } = [ $wheel, 0, undef ];

   # Debug stuff
   if (DEBUG) {
      warn "Got_Connection completed creation of ReadWrite wheel ( "
        . $wheel->ID . " )";
   }

   # Success!
   return 1;
}

# Finally got input, set some stuff and send away!
sub Got_Input {

   # ARG0 = HTTP::Request object, ARG1 = Wheel ID
   my ( $request, $id ) = @_[ ARG0, ARG1 ];

   my $connection;

   # Was this request Keep-Alive?
   if ( $_[HEAP]->{'CONNECTIONS'}->{$id} ) {
      my $c = delete $_[HEAP]->{'CONNECTIONS'}->{$id};
      $_[HEAP]->{'REQUESTS'}->{$id} = [ $c->[0], 0, undef ];
      $connection = $c->[1];
      if (DEBUG) {
         warn "Keep-alive id=$id next request...";
      }
   }

   # Quick check to see if the socket died already...
   # Initially reported by Tim Wood
   if (  !defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      or !
      defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      ->[POE::Wheel::ReadWrite::HANDLE_INPUT] )
   {
      if (DEBUG) {
         warn 'Got a request, but socket died already!';
      }

      # Destroy this wheel!
      delete $_[HEAP]->{'REQUESTS'}->{$id}->[0];
      delete $_[HEAP]->{'REQUESTS'}->{$id};

      # All done!
      return;
   }

   if ($connection) {

      # connection was kept-alive
   }

# Directly access POE::Wheel::ReadWrite's HANDLE_INPUT -> to get the socket itself
# Hmm, if we are SSL, then have to do an extra step!
   elsif ( defined $_[HEAP]->{'SSLKEYCERT'} ) {
      $connection = POE::Component::Server::SimpleHTTP::Connection->new(
         SSLify_GetSocket(
            $_[HEAP]->{'REQUESTS'}->{$id}->[0]
              ->[POE::Wheel::ReadWrite::HANDLE_INPUT]
         )
      );
   }
   else {
      $connection = POE::Component::Server::SimpleHTTP::Connection->new(
         $_[HEAP]->{'REQUESTS'}->{$id}->[0]
           ->[POE::Wheel::ReadWrite::HANDLE_INPUT] );
   }

   # The HTTP::Response object, the path
   my ( $response, $path, $malformed_req );

# Check if it is HTTP::Request or Response
# Quoting POE::Filter::HTTPD
# The HTTPD filter parses the first HTTP 1.0 request from an incoming stream into an
# HTTP::Request object (if the request is good) or an HTTP::Response object (if the
# request was malformed).
   if ( ref($request) eq 'HTTP::Response' ) {

      # Make the request nothing
      $response = $request;
      $request  = undef;

      # Mark that this is a malformed request
      $malformed_req = 1;

# Hack it to simulate POE::Component::Server::SimpleHTTP::Response->new( $id, $conn );
      bless( $response, 'POE::Component::Server::SimpleHTTP::Response' );
      $response->{'WHEEL_ID'} = $id;

      $response->{'CONNECTION'} = $connection;

      # Set the path to an empty string
      $path = '';
   }
   else {
      unless ( $_[HEAP]->{'PROXYMODE'} ) {

         # Add stuff it needs!
         my $uri = $request->uri;
         $uri->scheme('http');
         $uri->host( $_[HEAP]->{'HOSTNAME'} );
         $uri->port( $_[HEAP]->{'PORT'} );

         # Get the path
         $path = $uri->path();
         if ( !defined $path or $path eq '' ) {

            # Make it the default handler
            $path = '/';
         }
      }
      else {

         # We're in PROXYMODE set the path to the full URI
         $path = $request->uri->as_string();
      }

      # Get the response
      $response =
        POE::Component::Server::SimpleHTTP::Response->new( $id, $connection );

      # Stuff the default headers
      if ( keys( %{ $_[HEAP]->{'HEADERS'} } ) != 0 ) {
         $response->header( %{ $_[HEAP]->{'HEADERS'} } );
      }
   }

# Check if the SimpleHTTP::Connection object croaked ( happens when sockets just disappear )
   if ( !defined $response->{'CONNECTION'} ) {

      # Debug stuff
      if (DEBUG) {
         warn "could not make connection object";
      }

      # Destroy this wheel!
      delete $_[HEAP]->{'REQUESTS'}->{$id}->[0];
      delete $_[HEAP]->{'REQUESTS'}->{$id};

      # All done!
      return;
   }
   else {

      # If we used SSL, turn on the flag!
      if ( defined $_[HEAP]->{'SSLKEYCERT'} ) {
         $response->{'CONNECTION'}->{'SSLified'} = 1;

         # Put the cipher type for people who want it
         $response->{'CONNECTION'}->{'SSLCipher'} =
           SSLify_GetCipher( $_[HEAP]->{'REQUESTS'}->{$id}->[0]
              ->[POE::Wheel::ReadWrite::HANDLE_INPUT] );
      }
   }

   # Add this response to the wheel
   $_[HEAP]->{'REQUESTS'}->{$id}->[2] = $response;
   $_[HEAP]->{'REQUESTS'}->{$id}->[3] = $request;
   $response->{'CONNECTION'}->{id}    = $id;

# If they have a log handler registered, send out the needed information
# TODO if we received a malformed request, we will not have a request object
# We need to figure out what we're doing because they can't always expect to have
# a request object, or should we keep it from being ?undef'd?
   if ( $_[HEAP]->{'LOGHANDLER'} ) {
      $! = undef;
      $_[KERNEL]->post(
         $_[HEAP]->{'LOGHANDLER'}->{'SESSION'},
         $_[HEAP]->{'LOGHANDLER'}->{'EVENT'},
         $request, $response->connection->remote_ip()
      );

      # Warn if we had a problem dispatching to the log handler above
      warn(
         "I had a problem posting to event '",
         $_[HEAP]->{'LOGHANDLER'}->{'EVENT'},
         "' of the log handler alias '",
         $_[HEAP]->{'LOGHANDLE'}->{'SESSION'},
"'. As reported by Kernel: '$!', perhaps the alias is spelled incorrectly for this handler?"
      ) if $!;
   }

   # If we received a malformed request then
   # let's not try to dispatch to a handler
   if ($malformed_req) {

# Just push out the response we got from POE::Filter::HTTPD saying your request was bad
      POE::Kernel->post(
         $_[HEAP]->{ERRORHANDLER}->{SESSION},
         $_[HEAP]->{ERRORHANDLER}->{EVENT},
         'BadRequest (by POE::Filter::HTTPD)',
         $response->connection->remote_ip()
      );
      $_[KERNEL]->yield( 'DONE', $response );
      return;
   }
   else {

      # Find which handler will handle this one
      foreach my $handler ( @{ $_[HEAP]->{'HANDLERS'} } ) {

         # Check if this matches
         if ( $path =~ $handler->{'RE'} ) {

            # Send this off!
            $_[KERNEL]
              ->post( $handler->{'SESSION'}, $handler->{'EVENT'}, $request,
               $response, $handler->{'DIR'}, );

            # Make sure we croak if we have an issue posting
            croak(
"I had a problem posting to event $handler->{'EVENT'} of session $handler->{'SESSION'} for DIR handler '$handler->{'DIR'}'",
". As reported by Kernel: '$!', perhaps the session name is spelled incorrectly for this handler?"
            ) if $!;

            # All done!
            return;
         }
      }

      # If we reached here, no handler was able to handle it...
      # Set response code to 404 and tell the client we didn't find anything
      $response->code(404);
      $response->content('404 Not Found');
      $_[KERNEL]->yield( 'DONE', $response );
   }
   return;
}

# Finished with a request!
sub Got_Flush {

   # ARG0 = wheel ID
   my $id = $_[ARG0];

   # Debug stuff
   if (DEBUG) {
      warn "Got Flush event for wheel ID ( $id )";
   }

   if ( $_[HEAP]->{'REQUESTS'}->{$id}->[1] == 2 ) {

      # Do the stream !
      if (DEBUG) {
         warn "Streaming in progress ...!";
      }
      return;
   }

   # Check if we are shutting down
   elsif ( $_[HEAP]->{'REQUESTS'}->{$id}->[1] == 1 ) {

      if ( Must_KeepAlive( $_[HEAP], $id ) ) {
         if (DEBUG) {
            warn "Keep-alive id=$id ...";
         }
         $_[HEAP]->{'CONNECTIONS'}->{$id} = [
            $_[HEAP]->{'REQUESTS'}->{$id}->[0],    # wheel
            $_[HEAP]->{'REQUESTS'}->{$id}->[2]->connection
         ];
      }
      else {

         # Shutdown read/write on the wheel
         $_[HEAP]->{'REQUESTS'}->{$id}->[0]->shutdown_input();
         $_[HEAP]->{'REQUESTS'}->{$id}->[0]->shutdown_output();
      }

      # Delete the wheel
      # Tracked down by Paul Visscher
      delete $_[HEAP]->{'REQUESTS'}->{$id}->[0];
      delete $_[HEAP]->{'REQUESTS'}->{$id};
   }
   else {

      # Ignore this, eh?
      if (DEBUG) {
         warn
           "Got Flush event for socket ( $id ) when we did not send anything!";
      }
   }

   # Alright, do we have to shutdown?
   if ( !exists $_[HEAP]->{'SOCKETFACTORY'} ) {

      # Check to see if we have any more requests
      if (   keys( %{ $_[HEAP]->{'REQUESTS'} } ) == 0
         and keys( %{ $_[HEAP]->{'CONNECTIONS'} } ) == 0 )
      {

         # Shutdown!
         $_[KERNEL]->yield('SHUTDOWN');
      }
   }

   # Success!
   return 1;
}

# should we keep-alive the connection?
sub Must_KeepAlive {
   my ( $heap, $id ) = @_;

   return unless $heap->{'KEEPALIVE'};

   my $resp = $heap->{'REQUESTS'}->{$id}->[2];
   my $req  = $heap->{'REQUESTS'}->{$id}->[3];

   # error = close
   return 0 if $resp->is_error;

   # Connection is a comma-seperated header
   my $conn = lc $req->header('Connection');
   return 0 if ",$conn," =~ /,\s*close\s*,/;
   $conn = lc $resp->header('Connection');
   return 0 if ",$conn," =~ /,\s*close\s*,/;

   # HTTP/1.1 = keep
   return 1 if $req->protocol eq 'HTTP/1.1';
   return 0;
}

# Got some sort of error from ReadWrite
sub Got_Error {

   # ARG0 = operation, ARG1 = error number, ARG2 = error string, ARG3 = wheel ID
   my ( $operation, $errnum, $errstr, $id ) = @_[ ARG0 .. ARG3 ];

   # Only do this for non-EOF on read
   unless ( $operation eq 'read' and $errnum == 0 ) {

      # Debug stuff
      if (DEBUG) {
         warn "Wheel $id generated $operation error $errnum: $errstr\n";
      }

      my $connection;
      if ( $_[HEAP]->{'CONNECTIONS'}{$id} ) {
         my $c = delete $_[HEAP]->{'CONNECTIONS'}{$id};
         $connection = $c->[1];
         delete $c->[0];
      }
      else {
         $connection = $_[HEAP]->{'REQUESTS'}->{$id}->[2]->{'CONNECTION'};

         # Delete this connection
         delete $_[HEAP]->{'REQUESTS'}->{$id}->[0];
         delete $_[HEAP]->{'REQUESTS'}->{$id};
      }

      # Mark the client dead
      $connection->{'DIED'} = 1;
   }

   # Success!
   return 1;
}

# Output to the client!
sub Request_Output {

   # ARG0 = HTTP::Response object
   my ( $kernel, $response ) = @_[ KERNEL, ARG0 ];

   # Check if we got it
   if ( !defined $response or !UNIVERSAL::isa( $response, 'HTTP::Response' ) ) {
      if (DEBUG) {
         warn 'Did not get a HTTP::Response object!';
      }

      # Abort...
      return undef;
   }

   # Get the wheel ID
   my $id = $response->_WHEEL;

# Check if the wheel exists ( sometimes it gets closed by the client, but the application doesn't know that... )
   if ( !exists $_[HEAP]->{'REQUESTS'}->{$id} ) {

      # Debug stuff
      if (DEBUG) {
         warn
'Wheel disappeared, but the application sent us a DONE event, discarding it';
      }

      POE::Kernel->post(
         $_[HEAP]->{ERRORHANDLER}->{SESSION},
         $_[HEAP]->{ERRORHANDLER}->{EVENT},
         'Wheel disappeared !'
      );

      # All done!
      return 1;
   }

   # Check if we have already sent the response
   if ( $_[HEAP]->{'REQUESTS'}->{$id}->[1] == 1 ) {

      # Tried to send twice!
      die 'Tried to send a response to the same connection twice!';
   }

   # Quick check to see if the wheel/socket died already...
   # Initially reported by Tim Wood
   if (  !defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      or !
      defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      ->[POE::Wheel::ReadWrite::HANDLE_INPUT] )
   {
      if (DEBUG) {
         warn 'Tried to send data over a closed/nonexistant socket!';
      }
      POE::Kernel->post(
         $_[HEAP]->{ERRORHANDLER}->{SESSION},
         $_[HEAP]->{ERRORHANDLER}->{EVENT},
         'Socket closed/nonexistant !'
      );
      return;
   }

   Fix_Headers( $_[HEAP], $response );

   # Send it out!
   $_[HEAP]->{'REQUESTS'}->{$id}->[0]->put($response);

   # Mark this socket done
   $_[HEAP]->{'REQUESTS'}->{$id}->[1] = 1;

# Log FINALLY If they have a logFinal handler registered, send out the needed information
   if ( $_[HEAP]->{'LOG2HANDLER'} ) {
      $! = undef;
      $_[KERNEL]->call(
         $_[HEAP]->{'LOG2HANDLER'}->{'SESSION'},
         $_[HEAP]->{'LOG2HANDLER'}->{'EVENT'},
         $_[HEAP]->{'REQUESTS'}{$id}[3], $response
      );

      # Warn if we had a problem dispatching to the log handler above
      warn(
         "I had a problem posting to event '",
         $_[HEAP]->{'LOG2HANDLER'}->{'EVENT'},
         "' of the log handler alias '",
         $_[HEAP]->{'LOG2HANDLER'}->{'SESSION'},
"'. As reported by Kernel: '$!', perhaps the alias is spelled incorrectly for this handler?"
      ) if $!;
   }

   # Debug stuff
   if (DEBUG) {
      warn "Completed with Wheel ID $id";
   }

   # Success!
   return 1;
}

# Stream output to the client
sub Stream_Output {

   # ARG0 = HTTP::Response object
   my ( $kernel, $response ) = @_[ KERNEL, ARG0 ];

   # Check if we got it
   if ( !defined $response or !UNIVERSAL::isa( $response, 'HTTP::Response' ) ) {
      if (DEBUG) {
         warn 'Did not get a HTTP::Response object!';
      }

      # Abort...
      return undef;
   }

   # Get the wheel ID
   my $id = $response->_WHEEL;
   $_[HEAP]->{'CHUNKCOUNT'}->{$id}++;

   if ( defined $response->{'STREAM'} ) {

      # Keep track if we plan to stream ...
      if ( $_[HEAP]->{'RESPONSES'}->{$id} ) {
         if (DEBUG) {
            warn "Restoring response from HEAP and id $id ";
         }
         $response = $_[HEAP]->{'RESPONSES'}->{$id};
      }
      else {
         if (DEBUG) {
            warn "Saving HEAP response to id $id ";
         }
         $_[HEAP]->{'RESPONSES'}->{$id} = $response;
      }
   }
   else {
      if (DEBUG) {
         warn
           'Can\'t push on a response that has not been not set as a STREAM!';
      }

      # Abort...
      return undef;
   }

# Check if the wheel exists ( sometimes it gets closed by the client, but the application doesn't know that... )
   if ( !exists $_[HEAP]->{'REQUESTS'}->{$id} ) {

      # Debug stuff
      if (DEBUG) {
         warn
'Wheel disappeared, but the application sent us a DONE event, discarding it';
      }
      POE::Kernel->post(
         $_[HEAP]->{ERRORHANDLER}->{SESSION},
         $_[HEAP]->{ERRORHANDLER}->{EVENT},
         'Wheel disappeared !'
      );

      # All done!
      return 1;
   }

   # Quick check to see if the wheel/socket died already...
   # Initially reported by Tim Wood
   if (  !defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      or !
      defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      ->[POE::Wheel::ReadWrite::HANDLE_INPUT] )
   {
      if (DEBUG) {
         warn 'Tried to send data over a closed/nonexistant socket!';
      }
      POE::Kernel->post(
         $_[HEAP]->{ERRORHANDLER}->{SESSION},
         $_[HEAP]->{ERRORHANDLER}->{EVENT},
         'Socket closed/nonexistant !'
      );
      return;
   }

   Fix_Headers( $_[HEAP], $response, 1 );

   # Preliminary check
   if (  !defined $_[HEAP]->{'REQUESTS'}->{ $response->_WHEEL }->[0]
      or !
      defined $_[HEAP]->{'REQUESTS'}->{ $response->_WHEEL }->[0]
      ->[POE::Wheel::ReadWrite::HANDLE_INPUT] )
   {
      if (DEBUG) {
         warn 'Tried to send data over a closed/nonexistant socket!';
      }
      next;
   }

   # Sets the correct POE::Filter
   unless ( defined $response->{'IS_STREAMING'} ) {

      # Mark this socket done
      $_[HEAP]->{'REQUESTS'}->{$id}->[1] = 2;

      #
      $response->{'IS_STREAMING'} = 1;
   }

   if (DEBUG) {
      warn "Sending stream via "
        . $response->{STREAM_SESSION} . "/"
        . $response->{STREAM}
        . " with id $id \n";
   }

   if ( $_[HEAP]->{'CHUNKCOUNT'}->{$id} > 1 ) {
      $_[HEAP]->{'REQUESTS'}->{ $response->_WHEEL }->[0]
        ->set_output_filter( POE::Filter::Stream->new() );
      $_[HEAP]->{'REQUESTS'}->{ $response->_WHEEL }->[0]
        ->put( $response->content );
   }
   else {
      $_[HEAP]->{'REQUESTS'}->{ $response->_WHEEL }->[0]
        ->set_output_filter( POE::Filter::HTTPD->new() );
      $_[HEAP]->{'REQUESTS'}->{ $response->_WHEEL }->[0]->put($response);
   }

   $response->content();

   # we send the event to stream with wheels request and response to the session
   # that has registered the streaming event
   unless ( $response->{'DONT_FLUSH'} ) {
      POE::Kernel->post(
         $response->{STREAM_SESSION},    # callback session
         $response->{STREAM},            # callback event
         $_[HEAP]->{'RESPONSES'}->{ $response->_WHEEL }
      );
   }

   # Success!
   return 1;
}

# Add required headers to a response
sub Fix_Headers {
   my ( $heap, $response, $stream ) = @_;

   # Set the date if needed
   if ( !$response->header('Date') ) {
      $response->header( 'Date', time2str(time) );
   }

   # Set the Content-Length if needed
   if (   !$stream
      and !defined $response->header('Content-Length')
      and my $len = length $response->content )
   {
      use bytes;
      $response->header( 'Content-Length', $len );
   }

   # Set the Content-Type if needed
   if ( !$response->header('Content-Type') ) {
      $response->header( 'Content-Type', 'text/plain' );
   }

   if ( !$response->protocol ) {
      my $request = $heap->{'REQUESTS'}->{ $response->_WHEEL }->[3];
      return unless $request and $request->isa('HTTP::Request');
      unless ( $request->method eq 'HEAD' ) {
         $response->protocol( $request->protocol );
      }
   }
}

# Closes the connection
sub Request_Close {

   # ARG0 = HTTP::Response object
   my $response = $_[ARG0];

   # Check if we got it
   if ( !defined $response or !UNIVERSAL::isa( $response, 'HTTP::Response' ) ) {
      if (DEBUG) {
         warn 'Did not get a HTTP::Response object!';
      }

      # Abort...
      return undef;
   }

   # Get the wheel ID
   my $id = $response->_WHEEL;

   if ( $_[HEAP]->{'CONNECTIONS'}->{$id} ) {
      my $c = delete $_[HEAP]->{'CONNECTIONS'}->{$id};
      $_[HEAP]->{'REQUESTS'}->{$id} = [ $c->[0], 0, undef ];
   }

# Check if the wheel exists ( sometimes it gets closed by the client, but the application doesn't know that... )
   if ( !exists $_[HEAP]->{'REQUESTS'}->{$id} ) {

      # Debug stuff
      if (DEBUG) {
         warn
'Wheel disappeared, but the application sent us a CLOSE event, discarding it';
      }

      # All done!
      return 1;
   }

   # Kill it!
   if (   defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      and defined $_[HEAP]->{'REQUESTS'}->{$id}->[0]
      ->[POE::Wheel::ReadWrite::HANDLE_INPUT] )
   {
      $_[HEAP]->{'REQUESTS'}->{$id}->[0]->shutdown_input;
      $_[HEAP]->{'REQUESTS'}->{$id}->[0]->shutdown_output;
   }

   # Delete it!
   delete $_[HEAP]->{'REQUESTS'}->{$id}->[0];
   delete $_[HEAP]->{'REQUESTS'}->{$id};
   delete $_[HEAP]->{'RESPONSES'}->{$id};

   if (DEBUG) {
      warn 'Delete references to the connection done.';
   }

   # All done!
   return 1;
}

# Registers a POE inline state (primarly for streaming)
sub Register {
   my ( $session, $state, $code_ref ) = @_[ SESSION, ARG0 .. ARG1 ];

   if (DEBUG) {
      warn 'Registering state in POE session';
   }

   return $session->register_state( $state, $code_ref );
}

# SETCLOSEHANDLER
sub SetCloseHandler {
   my ( $heap, $sender ) = @_[ HEAP, SENDER ];
   my ( $connection, $state, @params ) = @_[ ARG0 .. $#_ ];

   # turn connection ID into the connection object
   unless ( ref $connection ) {
      my $id = $connection;
      if ( $heap->{'CONNECTIONS'}->{$id} ) {
         $connection = $heap->{'CONNECTIONS'}->{$id}->[1];
      }
      elsif ($heap->{'REQUESTS'}->{$id}
         and $heap->{'REQUESTS'}->{$id}->[2] )
      {
         $connection = $_[HEAP]->{'REQUESTS'}->{$id}->[2]->connection;
      }
      unless ( ref $connection ) {
         die "Can't find connection object for request $id";
      }
   }

   if ($state) {
      $connection->_on_close( $sender, $state, @params );
   }
   else {
      $connection->_on_close($sender);
   }
}

# End of module
1;

__END__

=head1 NAME

POE::Component::Server::SimpleHTTP - Perl extension to serve HTTP requests in POE.

=head1 SYNOPSIS

	use POE;
	use POE::Component::Server::SimpleHTTP;

	# Start the server!
	POE::Component::Server::SimpleHTTP->new(
		'ALIAS'		=>	'HTTPD',
		'PORT'		=>	11111,
		'HOSTNAME'	=>	'MySite.com',
		'HANDLERS'	=>	[
			{
				'DIR'		=>	'^/bar/.*',
				'SESSION'	=>	'HTTP_GET',
				'EVENT'		=>	'GOT_BAR',
			},
			{
				'DIR'		=>	'^/$',
				'SESSION'	=>	'HTTP_GET',
				'EVENT'		=>	'GOT_MAIN',
			},
			{
				'DIR'		=>	'^/foo/.*',
				'SESSION'	=>	'HTTP_GET',
				'EVENT'		=>	'GOT_NULL',
			},
			{
				'DIR'		=>	'.*',
				'SESSION'	=>	'HTTP_GET',
				'EVENT'		=>	'GOT_ERROR',
			},
		],

		'LOGHANDLER' => { 'SESSION' => 'HTTP_GET',
				  'EVENT'   => 'GOT_LOG',
		},

		'LOG2HANDLER' => { 'SESSION' => 'HTTP_GET',
				  'EVENT'   => 'POSTLOG',
		},

		# In the testing phase...
		'SSLKEYCERT'	=>	[ 'public-key.pem', 'public-cert.pem' ],
	) or die 'Unable to create the HTTP Server';

	# Create our own session to receive events from SimpleHTTP
	POE::Session->create(
		inline_states => {
			'_start'	=>	sub {	$_[KERNEL]->alias_set( 'HTTP_GET' );
							$_[KERNEL]->post( 'HTTPD', 'GETHANDLERS', $_[SESSION], 'GOT_HANDLERS' );
						},

			'GOT_BAR'	=>	\&GOT_REQ,
			'GOT_MAIN'	=>	\&GOT_REQ,
			'GOT_ERROR'	=>	\&GOT_ERR,
			'GOT_NULL'	=>	\&GOT_NULL,
			'GOT_HANDLERS'	=>	\&GOT_HANDLERS,
			'GOT_LOG'       =>      \&GOT_LOG,
		},
	);

	# Start POE!
	POE::Kernel->run();

	sub GOT_HANDLERS {
		# ARG0 = HANDLERS array
		my $handlers = $_[ ARG0 ];

		# Move the first handler to the last one
		push( @$handlers, shift( @$handlers ) );

		# Send it off!
		$_[KERNEL]->post( 'HTTPD', 'SETHANDLERS', $handlers );
	}

	sub GOT_NULL {
		# ARG0 = HTTP::Request object, ARG1 = HTTP::Response object, ARG2 = the DIR that matched
		my( $request, $response, $dirmatch ) = @_[ ARG0 .. ARG2 ];

		# Kill this!
		$_[KERNEL]->post( 'HTTPD', 'CLOSE', $response );
	}

	sub GOT_REQ {
		# ARG0 = HTTP::Request object, ARG1 = HTTP::Response object, ARG2 = the DIR that matched
		my( $request, $response, $dirmatch ) = @_[ ARG0 .. ARG2 ];

		# Do our stuff to HTTP::Response
		$response->code( 200 );
		$response->content( 'Some funky HTML here' );

		# We are done!
		# For speed, you could use $_[KERNEL]->call( ... )
		$_[KERNEL]->post( 'HTTPD', 'DONE', $response );
	}

	sub GOT_ERR {
		# ARG0 = HTTP::Request object, ARG1 = HTTP::Response object, ARG2 = the DIR that matched
		my( $request, $response, $dirmatch ) = @_[ ARG0 .. ARG2 ];

		# Check for errors
		if ( ! defined $request ) {
			$_[KERNEL]->post( 'HTTPD', 'DONE', $response );
			return;
		}

		# Do our stuff to HTTP::Response
		$response->code( 404 );
		$response->content( "Hi visitor from " . $response->connection->remote_ip . ", Page not found -> '" . $request->uri->path . "'" );

		# We are done!
		# For speed, you could use $_[KERNEL]->call( ... )
		$_[KERNEL]->post( 'HTTPD', 'DONE', $response );
	}

	sub GOT_LOG {
		# ARG0 = HTTP::Request object, ARG1 = remote IP
		my ($request, $remote_ip) = @_[ARG0,ARG1];

		# Do some sort of logging activity.
		# If the request was malformed, $request = undef
		# CHECK FOR A REQUEST OBJECT BEFORE USING IT.
        if( $request ) {
        {
       		warn join(' ', time(), $remote_ip, $request->uri ), "\n";
        } else {
       		warn join(' ', time(), $remote_ip, 'Bad request' ), "\n";
        }

		return;
	}

=head1 ABSTRACT

	An easy to use HTTP daemon for POE-enabled programs

=head1 DESCRIPTION

This module makes serving up HTTP requests a breeze in POE.

The hardest thing to understand in this module is the HANDLERS. That's it!

The standard way to use this module is to do this:

	use POE;
	use POE::Component::Server::SimpleHTTP;

	POE::Component::Server::SimpleHTTP->new( ... );

	POE::Session->create( ... );

	POE::Kernel->run();

=head2 Starting SimpleHTTP

To start SimpleHTTP, just call it's new method:

	POE::Component::Server::SimpleHTTP->new(
		'ALIAS'		=>	'HTTPD',
		'ADDRESS'	=>	'192.168.1.1',
		'PORT'		=>	11111,
		'HOSTNAME'	=>	'MySite.com',
		'HEADERS'	=>	{},
		'HANDLERS'	=>	[ ],
	);

This method will die on error or return success.

This constructor accepts only 7 options.

=over 4

=item C<ALIAS>

This will set the alias SimpleHTTP uses in the POE Kernel.
This will default to "SimpleHTTP"

=item C<ADDRESS>

This value will be passed to POE::Wheel::SocketFactory to bind to, will use INADDR_ANY if it is nothing is provided.

=item C<PORT>

This value will be passed to POE::Wheel::SocketFactory to bind to.

=item C<HOSTNAME>

This value is for the HTTP::Request's URI to point to.
If this is not supplied, SimpleHTTP will use Sys::Hostname to find it.

=item C<HEADERS>

This should be a hashref, that will become the default headers on all HTTP::Response objects.
You can override this in individual requests by setting it via $request->header( ... )

For more information, consult the L<HTTP::Headers> module.

=item C<HANDLERS>

This is the hardest part of SimpleHTTP :)

You supply an array, with each element being a hash. All the hashes should contain those 3 keys:

DIR	->	The regexp that will be used, more later.

SESSION	->	The session to send the input

EVENT	->	The event to trigger

The DIR key should be a valid regexp. This will be matched against the current request path.
Pseudocode is: if ( $path =~ /$DIR/ )

NOTE: The path is UNIX style, not MSWIN style ( /blah/foo not \blah\foo )

Now, if you supply 100 handlers, how will SimpleHTTP know what to do? Simple! By passing in an array in the first place,
you have already told SimpleHTTP the order of your handlers. They will be tried in order, and if a match is not found,
SimpleHTTP will return a 404 response.

This allows some cool things like specifying 3 handlers with DIR of:
'^/foo/.*', '^/$', '.*'

Now, if the request is not in /foo or not root, your 3rd handler will catch it, becoming the "404 not found" handler!

NOTE: You might get weird Session/Events, make sure your handlers are in order, for example: '^/', '^/foo/.*'
The 2nd handler will NEVER get any requests, as the first one will match ( no $ in the regex )

Now, here's what a handler receives:

ARG0 -> HTTP::Request object

ARG1 -> POE::Component::Server::SimpleHTTP::Response object

ARG2 -> The exact DIR that matched, so you can see what triggered what

NOTE: If ARG0 is undef, that means POE::Filter::HTTPD encountered an error parsing the client request, simply modify the HTTP::Response
object and send some sort of generic error. SimpleHTTP will set the path used in matching the DIR regexes to an empty string, so if there
is a "catch-all" DIR regex like '.*', it will catch the errors, and only that one.

NOTE: The only way SimpleHTTP will leak memory ( hopefully heh ) is if you discard the SimpleHTTP::Response object without sending it
back to SimpleHTTP via the DONE/CLOSE events, so never do that!

=item C<KEEPALIVE>

Set to true to enable HTTP keep-alive support.  Connections will be
kept alive until the client closes the connection.  All HTTP/1.1 connections
are kept-open, unless you set the response C<Connection> header to C<close>.

    $response->header( Connection => 'close' );

If you want more control, use L<POE::Component::Server::HTTP::KeepAlive>.

=item C<LOGHANDLER>

Expects a hashref with the following key, values:

SESSION	->	The session to send the input

EVENT	->	The event to trigger

You will receive an event for each request to the server from clients.  Malformed client requests will not be passed into the handler.  Instead
undef will be passed.
Event is called before ANY content handler is called.

The event will have the following parameters:

ARG0 -> HTTP::Request object/undef if client request was malformed.

ARG1 -> the IP address of the client

=item C<LOG2HANDLER>

Expect a hashref with the following key, valyes:

SESSION	->	The session to send the input

EVENT	->	The event to trigger

You will receive an event for each response that hit DONE call. Malformed client requests will not be passed into the handler.
Event is after processing all content handlers.

The event will have the following parameters:

ARG0 -> HTTP::Request object

ARG1 -> HTTP::Response object

That makes possible following code:

	my ($login, $password) = $request->authorization_basic();
	printf STDERR "%s - %s [%s] \"%s %s %s\" %d %d\n",
		$response->connection->remote_ip, $login||'-', POSIX::strftime("%d/%b/%Y:%T %z",localtime(time())),
		$request->method(), $request->uri()->path(), $request->protocol(),
		$response->code(), length($response->content());

Emulate apache-like logs for PoCo::Server::SimpleHTTP

=item C<SETUPHANDLER>

Expects a hashref with the following key, values:

SESSION	->	The session to send the input

EVENT	->	The event to trigger

You will receive an event when the listener wheel has been setup.

Currently there are no parameters returned.

=item C<SSLKEYCERT>

This should be an arrayref of only 2 elements - the public key and certificate location. Now, this is still in the experimental stage, and testing
is greatly welcome!

Again, this will automatically turn every incoming connection into a SSL socket. Once enough testing has been done, this option will be augmented with more SSL stuff!

=item C<PROXYMODE>

Set this to a true value to enable the server to act as a proxy server, ie. it won't mangle the HTTP::Request
URI.

=back

=head2 Events

SimpleHTTP is so simple, there are only 8 events available.

=over 4

=item C<DONE>

	This event accepts only one argument: the HTTP::Response object we sent to the handler.

	Calling this event implies that this particular request is done, and will proceed to close the socket.

	NOTE: This method automatically sets those 3 headers if they are not already set:
		Date		->	Current date stringified via HTTP::Date->time2str
		Content-Type	->	text/html
		Content-Length	->	length( $response->content )

	To get greater throughput and response time, do not post() to the DONE event, call() it!
	However, this will force your program to block while servicing web requests...

=item C<CLOSE>

	This event accepts only one argument: the HTTP::Response object we sent to the handler.

	Calling this event will close the socket, not sending any output

=item C<GETHANDLERS>

	This event accepts 2 arguments: The session + event to send the response to

	This event will send back the current HANDLERS array ( deep-cloned via Storable::dclone )

	The resulting array can be played around to your tastes, then once you are done...

=item C<SETHANDLERS>

	This event accepts only one argument: pointer to HANDLERS array

	BEWARE: if there is an error in the HANDLERS, SimpleHTTP will die!

=item C<SETCLOSEHANDLER>

    $_[KERNEL]->call( $_[SENDER], 'SETCLOSEHANDLER', $connection,
                      $event, @args );

Calls C<$event> in the current session when C<$connection> is closed.  You
could use for persistent connection handling.

Multiple session may register close handlers.

Calling SETCLOSEHANDLER without C<$event> to remove the current session's
handler:

   $_[KERNEL]->call( $_[SENDER], 'SETCLOSEHANDLER', $connection );

You B<must> make sure that C<@args> doesn't cause a circular
reference.  Ideally, use C<$connection->ID> or some other unique value
associated with this C<$connection>.

=item C<STARTLISTEN>

	Starts the listening socket, if it was shut down

=item C<STOPLISTEN>

	Simply a wrapper for SHUTDOWN GRACEFUL, but will not shutdown SimpleHTTP if there is no more requests

=item C<SHUTDOWN>

	Without arguments, SimpleHTTP does this:
		Close the listening socket
		Kills all pending requests by closing their sockets
		Removes it's alias

	With an argument of 'GRACEFUL', SimpleHTTP does this:
		Close the listening socket
		Waits for all pending requests to come in via DONE/CLOSE, then removes it's alias

=item C<STREAM>

	With a $response argument it streams the content and calls back the streaming event
	of the user's session (or with the dont_flush option you're responsible for calling
        back your session's streaming event).

	To use the streaming feature see below.

=back

=head2 Streaming with SimpleHTTP

It's possible to send data as a stream to clients (unbuffered and integrated in the
POE loop).

Just create your session to receive events from SimpleHTTP as usually and add a
streaming event, this event will be triggered over and over each time you set the
$response to a streaming state and once you trigger it:

   # sets the response as streamed within our session which alias is HTTP_GET
   # with the event GOT_STREAM
   $response->stream(
      session     => 'HTTP_GET',
      event       => 'GOT_STREAM',
      dont_flush  => 1
   );

   # then you can simply yield your streaming event, once the GOT_STREAM event
   # has reached its end it will be triggered again and again, until you
   # send a CLOSE event to the kernel with the appropriate response as parameter
   $kernel->yield('GOT_STREAM', $response);

The optionnal dont_flush option gives the user the ability to control the callback
to the streaming event, which means once your stream event has reached its end
it won't be called, you have to call it back.

You can now send data by chunks and either call yourself back (via POE) or
shutdown when your streaming is done (EOF for example).

   sub GOT_STREAM {
      my ( $kernel, $heap, $response ) = @_[KERNEL, HEAP, ARG0];

      # sets the content of the response
      $response->content("Hello World\n");

      # send it to the client
      POE::Kernel->post('HTTPD', 'STREAM', $response);

      # if we have previously set the dont_flush option
      # we have to trigger our event back until the end of
      # the stream like this (that can be a yield, of course):
      #
      # $kernel->delay('GOT_STREAM', 1, $stream );

      # otherwise the GOT_STREAM event is triggered continously until
      # we call the CLOSE event on the response like that :
      #
      if ($heap{'streaming_is_done'}) {
         # close the socket and end the stream
         POE::Kernel->post('HTTPD', 'CLOSE', $response );
      }
   }

The dont_flush option is there to be able to control the frequency of flushes
to the client.

=head2 SimpleHTTP Notes

You can enable debugging mode by doing this:

	sub POE::Component::Server::SimpleHTTP::DEBUG () { 1 }
	use POE::Component::Server::SimpleHTTP;

Also, this module will try to keep the Listening socket alive.
if it dies, it will open it again for a max of 5 retries.

You can override this behavior by doing this:

	sub POE::Component::Server::SimpleHTTP::MAX_RETRIES () { 10 }
	use POE::Component::Server::SimpleHTTP;

For those who are pondering about basic-authentication, here's a tiny snippet to put in the Event handler

	# Contributed by Rocco Caputo
	sub Got_Request {
		# ARG0 = HTTP::Request, ARG1 = HTTP::Response
		my( $request, $response ) = @_[ ARG0, ARG1 ];

		# Get the login
		my ( $login, $password ) = $request->authorization_basic();

		# Decide what to do
		if ( ! defined $login or ! defined $password ) {
			# Set the authorization
			$response->header( 'WWW-Authenticate' => 'Basic realm="MyRealm"' );
			$response->code( 401 );
			$response->content( 'FORBIDDEN.' );

			# Send it off!
			$_[KERNEL]->post( 'SimpleHTTP', 'DONE', $response );
		} else {
			# Authenticate the user and move on
		}
	}

=head2 EXPORT

Nothing.

=head1 SEE ALSO

	L<POE>

	L<POE::Filter::HTTPD>

	L<HTTP::Request>

	L<HTTP::Response>

	L<POE::Component::Server::SimpleHTTP::Connection>

	L<POE::Component::Server::SimpleHTTP::Response>

	L<POE::Component::Server::SimpleHTTP::PreFork>

	L<POE::Component::SSLify>

=head1 AUTHOR

Apocalypse E<lt>apocal@cpan.orgE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2006 by Apocalypse

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut