Add a short program description.

[ssic.git] / src / ssic.pl

diff --git a/src/ssic.pl b/src/ssic.pl
old mode 100644 (file)
new mode 100755 (executable)
index d678556..a88e565
--- a/src/ssic.pl
+++ b/src/ssic.pl
@@ -1,4 +1,21 @@
 #!/usr/bin/perl
+#
+# ssic - Server Side Includes Compiler
+#
+# Copyright (C) 2013  Patrick "P. J." McDermott
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 use strict;
 use warnings;
@@ -9,6 +26,7 @@ use CGI::SSI;
 sub main
 {
        my %opts;
+       my $ssi;
        my $input;
        my $output;
 
@@ -28,29 +46,34 @@ sub main
        }
 
        if (exists($opts{'h'})) {
-               help(*STDERR);
+               help(*STDOUT);
                exit(0);
        }
        if (exists($opts{'V'})) {
-               version(*STDERR);
+               version(*STDOUT);
                exit(0);
        }
 
        if ($#ARGV lt 0) {
                error(4, "No input files\n");
        }
+
+       $ssi = init_compiler($opts{'D'}, $opts{'I'});
+
        if (exists($opts{'o'})) {
                if ($#ARGV gt 0) {
                        error(4, "Cannot specify -o with multiple files\n");
                }
-               compile($ARGV[0], $opts{'o'}, $opts{'D'}, $opts{'I'});
+               compile($ssi, $ARGV[0], $opts{'o'});
        } else {
                for $input (@ARGV) {
                        $output = $input;
                        $output =~ s/\.[^.]+$/.html/;
-                       compile($input, $output, $opts{'D'}, $opts{'I'});
+                       compile($ssi, $input, $output);
                }
        }
+
+       undef $ssi;
 }
 
 sub usage
@@ -90,29 +113,49 @@ sub warning
 {
        my ($fmt, @args) = @_;
 
-       printf("ssic: Warning: " . $fmt, @args);
+       printf(STDERR "ssic: Warning: " . $fmt, @args);
 }
 
 sub error
 {
        my ($status, $fmt, @args) = @_;
 
-       printf("ssic: Error: " . $fmt, @args);
+       printf(STDERR "ssic: Error: " . $fmt, @args);
        exit($status);
 }
 
+sub init_compiler
+{
+       my ($vars, $root) = @_;
+       my $ssi;
+       my $var_name;
+       my $var_value;
+
+       %ENV = (
+               "DOCUMENT_ROOT" => $root,
+       );
+
+       $CGI::SSI::DEBUG = 0;
+       $ssi = CGI::SSI->new();
+
+       $ssi->set("DOCUMENT_ROOT" => $root);
+
+       while (($var_name, $var_value) = each(%{$vars})) {
+               $ssi->set($var_name => $var_value);
+       }
+
+       return $ssi;
+}
+
 sub compile
 {
-       my ($input, $output, $vars, $root) = @_;
+       my ($ssi, $input, $output) = @_;
        my $input_fh;
        my $input_abs;
        my $output_fh;
-       my $ssi;
-       my $var_name;
-       my $var_value;
 
-       if ($input eq $output) {
-               error(4, "Input and output files are equal\n");
+       if ($input eq $output and $input ne "-") {
+               warning("Input and output files are equal\n");
        }
 
        if ($input eq "-") {
@@ -127,31 +170,36 @@ sub compile
        if ($output eq "-") {
                $output_fh = *STDOUT;
        } else {
-               if (not open($output_fh, ">", $output)) {
-                       error(4, "%s: %s\n", $output, $!);
+               if (not open($output_fh, ">", $output . "~")) {
+                       error(4, "%s: %s\n", $output . "~", $!);
                }
        }
 
        # CGI::SSI uses SCRIPT_FILENAME to determine the value of LAST_MODIFIED.
-       %ENV = (
-               "DOCUMENT_NAME" => $input,
-               "DOCUMENT_URI" => $input,
-               "DOCUMENT_ROOT" => $root,
-               "SCRIPT_FILENAME" => $input_abs,
-       );
+       $ENV{"DOCUMENT_NAME"} = $input;
+       $ENV{"DOCUMENT_URI"} = $input;
+       $ENV{"SCRIPT_FILENAME"} = $input_abs;
 
-       $CGI::SSI::DEBUG = 0;
-       $ssi = CGI::SSI->new(
-               "DOCUMENT_NAME" => $input,
-               "DOCUMENT_URI" => $input,
-               "DOCUMENT_ROOT" => $root,
-       );
+       # Reset config tags to default values.
+       $ssi->config("errmsg",
+               "[an error occurred while processing this directive]");
+       $ssi->config("sizefmt", "abbrev");
+       $ssi->config("timefmt", undef);
 
-       while (($var_name, $var_value) = each(%{$vars})) {
-               $ssi->set($var_name => $var_value);
-       }
+       $ssi->set("DOCUMENT_NAME" => $input);
+       $ssi->set("DOCUMENT_URI" => $input);
 
        print($output_fh $ssi->process(<$input_fh>));
+
+       if ($input ne "-") {
+               close($input_fh);
+       }
+       if ($output ne "-") {
+               close($output_fh);
+               if (not rename($output . "~", $output)) {
+                       error(4, "%s: %s\n", $output, $!);
+               }
+       }
 }
 
 main();