dwww 1.13.1 / usr / share / perl5 / Debian / Dwww / Utils.pm

# vim:ft=perl:cindent:ts=4:sts=4:sw=4:et:fdm=marker:cms=\ #\ %s
#
# $Id: Utils.pm 507 2009-01-10 15:37:23Z robert $
#
package Debian::Dwww::Utils;

use Exporter();
use Debian::Dwww::Version;
use Cwd qw(cwd realpath);
use POSIX qw(strftime locale_h);
use File::Path qw/rmtree mkpath/;
use File::NCopy qw/copy/;

use strict;
#use warnings;

use vars qw(@ISA @EXPORT);
@ISA = qw(Exporter);
@EXPORT = qw(URLEncode HTMLEncode  HTMLEncodeAbstract StripDirs CheckAccess RedirectToURL ErrorMsg
         TemplateFile BeginTable AddToTable EndTable GetCommandOutput RenameDir $TRUE $FALSE);

our $TRUE  = 1;
our $FALSE = 0;

sub URLEncode {
    my $url = shift;
    $url =~ s/([^A-Za-z0-9\_\-\.\/])/"%" . unpack("H*", $1)/eg;
#   $url =~ tr/ /+/;
    return $url;
}

# HTMLEncode(what)
sub HTMLEncode { # {{{
    my $text = shift;


    $text =~ s/&/&/g;
    $text =~ s/</&lt;/g;
    $text =~ s/>/&gt;/g;
    $text =~ s/"/&quot;/g;
    return $text;
} # }}}

sub HTMLEncodeAbstract { # {{{
    my $text = &HTMLEncode(@_);

    $text =~ s/^\s\s+(.*)$/<BR><TT>&nbsp;$1<\/TT><BR>/gm;
    $text =~ s/^\s\.\s*$/<BR>/gm;
    $text =~ s/(<BR>\s*)+/<BR>\n/g;
    $text =~ s/(http|ftp)s?:\/([\w\/~\.%#-])+[\w\/]/<A href="$&">$&<\/A>/g;
    $text =~ s/<BR>\s*$//;
    return $text;
} # }}}

sub GetDate { # {{{
    my $old_locale = &setlocale(LC_ALL, "C");
    my $date = &strftime ("%a %b %e %H:%M:%S %Z %Y", localtime(time));
    &setlocale(LC_ALL, $old_locale) unless $old_locale eq "C";
    return $date;
} # }}}


sub TemplateFile { # {{{
    my $file= shift;
    my $vars= shift; # hash reference
    my $res = '';
    local $_;


    open TEMPLATE , "<$file" or die "Can't open $file: $!";
    while (<TEMPLATE>) {
        foreach my $k (keys %{$vars}) {
#            my $subst = (defined $vars->{$k} ? $vars->{$k} : '');
#            print STDERR "k = $k ". $vars->{'SECTION'} . "\n" if defined $vars->{'SECTION'} ;
            my $subst = $vars->{$k};
            s/\%$k\%/$subst/g;
        }
        s/\%VERSION\%/$Debian::Dwww::Version::version/o;
        s/\%DATE\%/&GetDate()/eg;
        $res .= $_;
    }

    close TEMPLATE;
    return $res;
} # }}}


sub BeginTable { # {{{
    my $filehandle = shift;
    my $caption = shift;
    my $columns = shift;
    my $desc    = shift;
    my $widths  = shift;
    my $table = {};

    $desc = '' unless (defined $desc);

    $table->{'columns'}   = $columns + 0;
    $table->{'widths'}    = $widths;
    $table->{'in_column'} = 0;
    $table->{'in_row'}    = 0;

#  kv5r: updated to Strict html:
    print $filehandle "<p><strong>$caption</strong>$desc</p>\n";
#  kv5r: table controlled in css, no addnl stuff needed here:
    print $filehandle "<table class=\"wide\">\n";
    return $table;
} # }}}

sub AddToTable { # {{{
    my $filehandle = shift;
    my $table = shift;
    my $what = shift;
    my ($wdth, $c, $r) = ('', $table->{'in_column'}, $table->{'in_row'});


    if ($c == 0) {
        print $filehandle " <tr>\n"
    }
    
# kv5r: added inline css herein:

    # Add width="..." for all columns  except the last one
    # iff we are in first row and:
    # - if $table->{'widths'} are undefined => add 100/number_of_columns%
    # - if$table->{'widths'} are empty  => don't add widths, allow browsers
    #     to calculate them themselfs in hope they will output equal widths
    # - if $table->{'widths'} are nonempty, then it should contain widths for
    #      all, but the last, columns, so use the provided values
    if (!defined $table->{'widths'} || @{$table->{'widths'}})
    {
        if ($r == 0 && $c + 1 < $table->{'columns'}) {
            if (defined $table->{'widths'}) {
                $wdth = ' style="width:' . $table->{'widths'}[int($c)] .'%;"';
            } else  {
                $wdth = ' style="width:' . int(100 / $table->{'columns'}) . '%;"';
            }
        }
    }

    print $filehandle "  <td$wdth>$what</td>\n";

    if (++$c >= $table->{'columns'}) {
        print $filehandle " </tr>\n";
        $c = 0;
        $r++;
    }
    $table->{'in_column'} = $c;
    $table->{'in_row'}    = $r;
} #  }}}


sub EndTable { # {{{
    my $filehandle = shift;
    my $table = shift;

    while ($table->{'in_column'} != 0) {
        &AddToTable($filehandle, $table, '');
    }
    print $filehandle "</table>\n";

    undef %{$table};
} # }}}


# strips any '.' and '..' components from path
sub StripDirs { # {{{
    my $path = shift;


    $path = &cwd() . '/' . $path unless $path =~ /^\//;

    my @pc = split(/\/+/, $path);
    my @res = ();

    foreach my $p (@pc) {
        next             if $p eq '.' || $p eq '';
        pop(@res), next  if $p eq '..';
        push(@res, $p);
    }
    my $r = '/' . join ('/', @res);
    return $r;

} # }}}

#
# Print error message and exit the program
# usage: ErrorMsg status title message
sub ErrorMsg { # {{{
    my $status  = shift;
    my $title   = shift;
    my $message = shift;

    print "Status: $status\n";
    print "Content-type: text/html; charset=UTF-8\n";
    print "\n";
    print "<html>\n";
    print "<head>\n";
    print " <title>$title</title>\n";
    print "</head>";
    print "<body>";
    print " <h1 style=\"center\">$title</H1>\n";
    print "$message\n";
    print "</body>\n";
    print "</body>\n";
    exit 1;
} # }}}


# returns output of realpath($file)
sub CheckAccess() { # {{{
    my $dwwwvars    = shift;
    my $file        = shift;
    my $orig_file   = shift;
    $orig_file      = $file unless defined $orig_file;

    my $dwww_docpath            = $dwwwvars->{'DWWW_DOCPATH'};
    my $dwww_allowedlinkpath    = $dwwwvars->{'DWWW_ALLOWEDLINKPATH'};


    my $can_read_f              = -r $file;
    my $exists_f                = $can_read_f || -f $file;
    my $realp_file              = undef;


    if ( $exists_f ) {
        $realp_file = &realpath( $file );

        # file does exist, check if it match any files in @dwww_docpath
        foreach my $path  (@$dwww_docpath)  {
            if ( -d $path ) {
                $path = &realpath( $path );
                if (substr($realp_file, 0, length($path)) eq $path) {
                    &ErrorMsg( "403 Access Denied",
                               "Access Denied",
                               "The $orig_file is not readable!" ) unless $can_read_f;
                    return $realp_file; # everything OK
                }
            }
        }
    }

    # if we're here, the file either does not exist
    # or does not match any @dwww_docpath
    my $ok          = 0;
    my $strip_file  = &StripDirs( $file );
    foreach my $path  (@$dwww_docpath)  {
        if ( -d $path ) {
            $path = &StripDirs( $path );
            if (substr($strip_file, 0, length($path)) eq $path) {
                $ok = 1;
                last;
            }
        }
    }


    # if file exists, check if it's in allowed_linkpath
    if ( $exists_f && $ok ) {
        foreach my $path (@$dwww_allowedlinkpath) {
            if ( -d $path ) {
                $path = &realpath( $path );
                if (substr($realp_file, 0, length($path)) eq $path) {
                    return $realp_file;
                }
            }
        }
    }

    # file either does not exist or is not allowed to show
    # print suitable error message
    if ( !$exists_f && $ok ) {
        &ErrorMsg ("404 File not found",
                   "File not found" ,
                   "dwww could not find the file $orig_file" );
    } else {
        &ErrorMsg ("403 Access denied",
                    "Access denied",
                    "dwww will not allow you to read the file $orig_file" );
    }

    exit 1; ### UNREACHED ###
} # }}}

sub GetCommandOutput { # {{{
        my @args = @_;
    # fork and exec command
        open (OUT, '-|')
                || exec { $args[0] } @args;
        my @out=<OUT>;
        close OUT;
        return @out;
} # }}}

sub RedirectToURL() { # {{{
    my $url = shift;

    my $name     = $ENV{'SERVER_NAME'} ? $ENV{'SERVER_NAME'} : 'localhost';
    my $port     = $ENV{'SERVER_PORT'} ? ':' . $ENV{'SERVER_PORT'} : '';
    my $protocol = ($ENV{'HTTPS'} and $ENV{'HTTPS'} eq "on") ? "https" : "http";
    $url = "/$url" unless $url =~ m/^\//;

    print "Location: $protocol://$name$port$url\n\n";
} # }}}

sub RenameDir() { # {{{
    my ($srcdir, $tgtdir) = @_;

    &rmtree($tgtdir) or die "Cannot remove old $tgtdir directory: $!\n" if -d $tgtdir;
    if (! rename($srcdir, $tgtdir)) {
        &mkpath($tgtdir) or die "Cannot create $tgtdir: $!\n";
        &copy(\1, "$srcdir/*", $tgtdir) or die "Cannot copy $srcdir to $tgtdir: $!\n";
        &rmtree($srcdir);
    }
} # }}}


1;