Added rudimentary support for unpacking archive files using Archive::Extract.

[devedit.git] / modules / Tool.pm

diff --git a/modules/Tool.pm b/modules/Tool.pm
index dc1157159e51b19cf193974f5ed89afd8c69ff58..4dc6fa29e50d7b9aea731cb7d8a00d0f63d1ef5d 100644 (file)
--- a/modules/Tool.pm
+++ b/modules/Tool.pm
@@ -6,7 +6,15 @@ package Tool;
 # Some shared sub routines
 #
 # Author:        Patrick Canterino <patrick@patshaping.de>
 # Some shared sub routines
 #
 # Author:        Patrick Canterino <patrick@patshaping.de>

-# Last modified: 2005-01-06
+# Last modified: 2010-12-23
+#
+# Copyright (C) 1999-2000 Roland Bluethgen, Frank Schoenmann
+# Copyright (C) 2003-2009 Patrick Canterino
+# All Rights Reserved.
+#
+# This file can be distributed and/or modified under the terms of
+# of the Artistic License 1.0 (see also the LICENSE file found at
+# the top level of the Dev-Editor distribution).

 #
 
 use strict;
 #
 
 use strict;


@@ -29,10 +37,18 @@ use base qw(Exporter);
              clean_path
              devedit_reload
              dos_wildcard_match
              clean_path
              devedit_reload
              dos_wildcard_match

+             encode_html

              equal_url
              file_name
              equal_url
              file_name

+             is_archive
+             in_array
+             is_disabled_command
+             is_forbidden_file

              mode_string
              mode_string

+             multi_string

              upper_path);
              upper_path);

+             
+my @archive_exts = ('.zip', 'tar.gz', 'tar.bz2');

 
 # check_path()
 #
 
 # check_path()
 #


@@ -61,25 +77,31 @@ sub check_path($$)
  # We extract the last part of the path and create the absolute path
 
  my $first = upper_path($path);
  # We extract the last part of the path and create the absolute path
 
  my $first = upper_path($path);

+ $first    = File::Spec->canonpath($first);
+ $first    = abs_path($first);
+

  my $last  = file_name($path);
  my $last  = file_name($path);

+ $last     = '' if($last eq '.');

 
 

- $first = abs_path($first);
- $path  = $first.'/'.$last;
+ if($last eq '..' || ($^O eq 'MSWin32' && $last =~ m!^\.\.\.+$!))
+ {
+  $first = abs_path($first.'/'.$last);
+  $last  = '';
+ }

 
 

- $first = File::Spec->canonpath($first);
- $path  = File::Spec->canonpath($path);
+ $path = File::Spec->canonpath($first.'/'.$last);

 
  # Check if the path is above the root directory
 
  return if(index($path,$root) != 0);
 
  # Check if the path is above the root directory
 
  return if(index($path,$root) != 0);

- return if($first eq $root && ($last eq '..' || ($^O eq 'MSWin32' && $last =~ m!^\.\.+$!)));
+ return if(substr($path,length($root)) && not File::Spec->file_name_is_absolute(substr($path,length($root))));

 
  # Create short path name
 
  my $short_path = substr($path,length($root));
  $short_path =~ tr!\\!/!;
  $short_path = '/'.$short_path if($short_path !~ m!^/!);
 
  # Create short path name
 
  my $short_path = substr($path,length($root));
  $short_path =~ tr!\\!/!;
  $short_path = '/'.$short_path if($short_path !~ m!^/!);

- $short_path = $short_path.'/' if($short_path !~ m!/$! && -d $path);
+ $short_path = $short_path.'/' if($short_path !~ m!/$! && -d $path && not -l $path);

 
  return ($path,$short_path);
 }
 
  return ($path,$short_path);
 }


@@ -174,6 +196,8 @@ sub dos_wildcard_match($$)
 {
  my ($pattern,$string) = @_;
 
 {
  my ($pattern,$string) = @_;
 

+ return 1 if($pattern eq '*');
+

  # The following part is stolen from File::DosGlob
 
  # escape regex metachars but not glob chars
  # The following part is stolen from File::DosGlob
 
  # escape regex metachars but not glob chars


@@ -185,6 +209,26 @@ sub dos_wildcard_match($$)
  return ($string =~ m|^$pattern$|is);
 }
 
  return ($string =~ m|^$pattern$|is);
 }
 

+# encode_html()
+#
+# Encode HTML control characters (< > " &)
+#
+# Params: String to encode
+#
+# Return: Encoded string
+
+sub encode_html($)
+{
+ my $string = shift;
+
+ $string =~ s/&/&amp;/g;
+ $string =~ s/</&lt;/g;
+ $string =~ s/>/&gt;/g;
+ $string =~ s/"/&quot;/g;
+
+ return $string;
+}
+

 # equal_url()
 #
 # Create URL equal to a file or directory
 # equal_url()
 #
 # Create URL equal to a file or directory


@@ -219,7 +263,7 @@ sub file_name($)
  my $path =  shift;
  $path    =~ tr!\\!/!;
 
  my $path =  shift;
  $path    =~ tr!\\!/!;
 

- unless($path eq '/')
+ unless($path =~ m!^/+$! || ($^O eq 'MSWin32' && $path =~ m!^[a-z]:/+$!i))

  {
   $path =~ s!/+$!!;
   $path =  substr($path,rindex($path,'/')+1);
  {
   $path =~ s!/+$!!;
   $path =  substr($path,rindex($path,'/')+1);


@@ -228,6 +272,93 @@ sub file_name($)
  return $path;
 }
 
  return $path;
 }
 

+# in_array()
+#
+# Check if a value is in an array
+#
+# Params: 1. Value to find
+#         2. Array
+#
+# Return: Status code (Boolean)
+
+sub in_array($$)
+{
+ my ($string,$array) = @_;
+
+ foreach my $element(@{$array})
+ {
+  return 1 if($string eq $element);
+ }
+
+ return;
+}
+
+# is_archive()
+#
+# Check if a file is an archive
+# (currently only by file extension)
+#
+# Params: Archive file name
+#
+# Return: Status code (Boolean)
+
+sub is_archive($)
+{
+ my $file = shift;
+ 
+ foreach my $ext(@archive_exts)
+ {
+  return 1 if(lc(substr($file,length($file)-length($ext),length($ext))) eq lc($ext));
+ }
+ 
+ return;
+}
+
+# is_disabled_command()
+#
+# Check if a command is disabled
+#
+# Params: 1. Array Reference containing the list
+#         2. Command to check
+#
+# Return: Status code (Boolean)
+
+sub is_disabled_command($$)
+{
+ my ($list,$command) = @_;
+ $command =~ s!/+$!!g;
+
+ foreach my $entry(@$list)
+ {
+  return 1 if(lc($command) eq lc($entry));
+ }
+
+ return;
+}
+
+# is_forbidden_file()
+#
+# Check if a file is in the list of forbidden files
+#
+# Params: 1. Array Reference containing the list
+#         2. Filename to check
+#
+# Return: Status code (Boolean)
+
+sub is_forbidden_file($$)
+{
+ my ($list,$file) = @_;
+ $file =~ s!/+$!!g;
+
+ foreach my $entry(@$list)
+ {
+  return 1 if($file eq $entry);
+  return 1 if(index($file,$entry.'/') == 0);
+ }
+
+ return;
+}
+

 # mode_string()
 #
 # Convert a file mode number into a human readable string (rwxr-x-r-x)
 # mode_string()
 #
 # Convert a file mode number into a human readable string (rwxr-x-r-x)


@@ -266,9 +397,33 @@ sub mode_string($)
  return $string;
 }
 
  return $string;
 }
 

+# multi_string()
+#
+# Create a Hash Reference containing three forms of a string
+#
+# Params: String
+#
+# Return: Hash Reference:
+#         normal => Normal form of the string
+#         html   => HTML encoded form (see encode_html())
+#         url    => URL encoded form
+
+sub multi_string($)
+{
+ my $string = shift;
+ my %multi;
+
+ $multi{'normal'} = $string;
+ $multi{'html'}   = encode_html($string);
+ $multi{'url'}    = escape($string);
+
+ return \%multi;
+}
+

 # upper_path()
 #
 # upper_path()
 #

-# Cut away the last part of a path
+# Remove the last part of a path
+# (the resulting path contains a trailing slash)

 #
 # Params: Path
 #
 #
 # Params: Path
 #


@@ -279,7 +434,7 @@ sub upper_path($)
  my $path =  shift;
  $path    =~ tr!\\!/!;
 
  my $path =  shift;
  $path    =~ tr!\\!/!;
 

- unless($path eq '/')
+ unless($path =~ m!^/+$! || ($^O eq 'MSWin32' && $path =~ m!^[a-z]:/+$!i))

  {
   $path =~ s!/+$!!;
   $path =  substr($path,0,rindex($path,'/')+1);
  {
   $path =~ s!/+$!!;
   $path =  substr($path,0,rindex($path,'/')+1);