Improve error reporting; Add documentation and test suite.

6 files changed, 373 insertions, 14 deletions

diff --git a/lib/Apache/Defaults.pm b/lib/Apache/Defaults.pm
index 13c729e..08c4865 100644
--- a/lib/Apache/Defaults.pm
+++ b/lib/Apache/Defaults.pm
@@ -7,2 +7,3 @@ use Shell::GetEnv;
 use DateTime::Format::Strptime;
+use Text::ParseWords;
 use Symbol 'gensym';
@@ -28,3 +29,4 @@ sub new {
     
-    if (my @select = grep { -x $_ } @servlist) {
+    if (my @select = grep { -x $_->[0] }
+                      map { [ shellwords($_) ] } @servlist) {
         $self->{server} = shift @select;
@@ -35,5 +37,9 @@ sub new {
     if ($v = delete $_{environ}) {
-        $self->{environ} = Shell::GetEnv->new('sh', ". $v", startup => 0)
-                                        ->envs;
-    }
+        my $env = Shell::GetEnv->new('sh', ". $v",
+                                     { startup => 0 });
+        if ($env->status) {
+            croak "Got status ".$env->status." trying to inherit environment";
+        }
+        $self->{environ} = $env->envs;
+     }
 
@@ -43,3 +49,4 @@ sub new {
 
-sub server { shift->{server} }
+sub server { shift->{server}[0] }
+sub server_command { @{shift->{server}} }
 sub environ { shift->{environ} }
@@ -52,6 +59,8 @@ sub probe {
 
-    my $fd = gensym;
+    my $out = gensym;
+    my $err = gensym;
     local %ENV = %{$self->{environ}} if $self->{environ};
-    if (my $pid = open3($nullin, $fd, $nullout, $self->server, @opt)) {
-        while (<$fd>) {
+    if (my $pid = open3($nullin, $out, $err,
+                        $self->server_command, @opt)) {
+        while (<$out>) {
             chomp;
@@ -59,6 +68,18 @@ sub probe {
         }
+        waitpid($pid, 0);
+        if ($? == -1) {
+            croak "failed to execute " .$self->server . ": $!";
+        } elsif ($? & 127) {
+            croak sprintf("%s died with signal %d%s",
+                          $self->server, $? & 127,
+                          ($? & 128) ? ' (core dumped)' : '');
+        } elsif (my $code = $? >> 8) {
+            local $/ = undef;
+            croak sprintf("%s terminated with status %d; error message: %s",
+                          $self->server, $code, <$err>);
+        }
     }
-    close $fd;
     close $nullin;
-    close $nullout;
+    close $out;
+    close $err;
 }    
@@ -86,3 +107,2 @@ sub _get_version_info {
                         pattern => '%b %d %Y %H:%M%S',
-                        strict => 1,
                         locale => 'en_US',
@@ -106,3 +126,3 @@ sub _get_version_info {
                 $self->{defines}{$+{name}} = $self->dequote($+{val});
-            } elsif (/^\s+-D\s+(?<name>.+?)(?:\s*(?<com>.+))?$/) {
+            } elsif (/^\s+-D\s+(?<name>\S+)(?:\s*(?<com>.+))?$/) {
                 $self->{defines}{$+{name}} = 1;
@@ -141,3 +161,6 @@ sub defines {
     $self->_get_version_info;
-    return @{$self->{defines}}{@_};
+    if (@_) {
+        return @{$self->{defines}}{@_};
+    }
+    return sort keys %{$self->{defines}};
 }
@@ -273,3 +296,3 @@ sub preloaded {
     }
-    return keys %{$self->{preloaded}};
+    return sort keys %{$self->{preloaded}};
 }
@@ -292 +315,176 @@ sub _get_module_info {
 1;
+__END__
+=head1 NAME
+
+Apache::Defaults - Get default settings for Apache httpd daemon
+
+=head1 SYNOPSIS
+
+    $x = new Apache::Defaults;
+    print $x->name;
+    print $x->version;
+    print $x->server_root;
+    print $x->built;
+    print $x->architecture;
+    print $x->MPM;
+    print $x->defines('DYNAMIC_MODULE_LIMIT');
+    print $x->preloaded('cgi_module');
+
+=head1 DESCRIPTION
+
+Detects the default settings of the Apache httpd daemon by invoking
+it with appropriate options and analyzing its output.
+
+=head1 METHODS
+
+=head2 new
+
+    $x = new Apache::Defaults(%attrs);
+
+Detects the settings of the apache server and returns the object representing
+them. Attributes (I<%attrs>) are:
+
+=over 4
+
+=item C<server>
+
+Full pathname of the B<httpd> binary to inspect. The argument can also be
+a reference to the list of possible pathnames. In this case, the first of
+them that exists on disk and has executable privileges will be used. Full
+command line can also be used, e.g.:
+
+    server => '/usr/sbin/httpd -d /etc/httpd'
+
+The default used in the absense of this attribute is:
+
+    [ '/usr/sbin/httpd', '/usr/sbin/apache2' ]
+
+=item C<environ>
+
+Name of the shell script that sets the environment for B<httpd> invocation.
+For some obscure reason, B<httpd> attempts to read its configuration file
+even if invoked with the B<-V> option (which is intended to print the version
+and build parameters of the daemon). It will fail if its configuration refers
+to the environment variables, defined elsewhere. This situation is quite
+common in Debian-based distributions, which define the environment variables
+in file F</etc/apache2/envvars>. This attribute is intended to cope with
+such problems, e.g.:
+
+    $x = new Apache::Defaults(environ => /etc/apache2/envvars)
+    
+=back
+
+The method will I<croak> if an error occurs (e.g. the server binary
+is not found or exits with failure).
+
+=head2 server
+
+    $s = $x->server;
+    
+Returns the pathname of the B<httpd> binary.
+
+=head2 server_command
+
+    @cmd = $x->server_command;
+
+Returns full command line of the B<httpd> binary.
+
+=head2 environ
+
+    $hashref = $x->environ
+
+Returns a reference to the environment used when invoking the server.
+
+=head2 name
+
+    $s = $x->name;
+
+Returns server implementation name (normally C<Apache>).
+
+=head2 version
+
+    $v = $x->version;
+
+Returns server version (as string).
+
+=head2 platform
+
+    $s = $x->platform;
+
+Platform (distribution) on which the binary is compiled.
+
+=head2 architecture
+
+Architecture for which the server is built.
+    
+=head2 built
+
+    $d = $x->built;
+
+Returns a B<DateTime> object, representing the time when the server
+was built.
+
+=head2 loaded_with
+
+APR tools with which the server is loaded.
+    
+=head2 compiled_with
+
+APR tools with which the server is compiled.
+    
+=head2 MPM
+
+MPM module loaded in the configuration.
+
+=head2 MPM_threaded
+
+True if the MPM is threaded.
+
+=head2 MPM_forked
+
+True if the MPM is forked.
+
+=head2 defines