Changed version number to 3.1

[devedit.git] / modules / Tool.pm

diff --git a/modules/Tool.pm b/modules/Tool.pm
index a05b459c72787d18dfc949818326a944bd13bfd8..b143dcba0eca4c3e380672c98274ec81b17d570b 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-04
+# Last modified: 2008-04-25
+#
+# 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,9 +37,12 @@ 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_forbidden_file

              mode_string
              mode_string

+             multi_string

              upper_path);
 
 # check_path()
              upper_path);
 
 # check_path()


@@ -56,30 +67,36 @@ sub check_path($$)
 
  $path =~ tr!\\!/!;
  $path =~ s!^/+!!;
 
  $path =~ tr!\\!/!;
  $path =~ s!^/+!!;

- $path =  $root."/".$path;
+ $path =  $root.'/'.$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 =~ 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!\\!/!;
 
  # 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!^/!);
+ $short_path = $short_path.'/' if($short_path !~ m!/$! && -d $path && not -l $path);

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


@@ -119,31 +136,31 @@ sub devedit_reload(;$)
  # Detect the protocol (simple HTTP or SSL encrypted HTTP)
  # and check if the server listens on the default port
 
  # Detect the protocol (simple HTTP or SSL encrypted HTTP)
  # and check if the server listens on the default port
 

- my $protocol = "";
- my $port     = "";
+ my $protocol = '';
+ my $port     = '';

 
  if(https)
  {
   # SSL encrypted HTTP (HTTPS)
 
 
  if(https)
  {
   # SSL encrypted HTTP (HTTPS)
 

-  $protocol = "https";
-  $port     = ":".$ENV{'SERVER_PORT'} if($ENV{'SERVER_PORT'} != 443);
+  $protocol = 'https';
+  $port     = ':'.$ENV{'SERVER_PORT'} if($ENV{'SERVER_PORT'} != 443);

  }
  else
  {
   # Simple HTTP
 
  }
  else
  {
   # Simple HTTP
 

-  $protocol = "http";
-  $port     = ":".$ENV{'SERVER_PORT'} if($ENV{'SERVER_PORT'} != 80);
+  $protocol = 'http';
+  $port     = ':'.$ENV{'SERVER_PORT'} if($ENV{'SERVER_PORT'} != 80);

  }
 
  # The following code is grabbed from Template::_query of
  # Andre Malo's selfforum (http://sourceforge.net/projects/selfforum/)
  # and modified by Patrick Canterino
 
  }
 
  # The following code is grabbed from Template::_query of
  # Andre Malo's selfforum (http://sourceforge.net/projects/selfforum/)
  # and modified by Patrick Canterino
 

- my $query = "";
+ my $query = '';

 
 

- if(ref($params) eq "HASH")
+ if(ref($params) eq 'HASH')

  {
   $query = '?'.join ('&' =>
     map {
  {
   $query = '?'.join ('&' =>
     map {


@@ -156,7 +173,7 @@ sub devedit_reload(;$)
 
  # Create the redirection header
 
 
  # Create the redirection header
 

- my $header = redirect($protocol."://".virtual_host.$port.$ENV{'SCRIPT_NAME'}.$query);
+ my $header = redirect($protocol.'://'.virtual_host.$port.$ENV{'SCRIPT_NAME'}.$query);

 
  return \$header;
 }
 
  return \$header;
 }


@@ -174,6 +191,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 +204,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


@@ -201,7 +240,7 @@ sub equal_url($$)
 
  $root =~ s!/+$!!;
  $path =~ s!^/+!!;
 
  $root =~ s!/+$!!;
  $path =~ s!^/+!!;

- $url  =  $root."/".$path;
+ $url  =  $root.'/'.$path;

 
  return $url;
 }
 
  return $url;
 }


@@ -219,15 +258,38 @@ 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 = substr($path,0,-1) if($path =~ m!/$!);
-  $path = substr($path,rindex($path,"/")+1);
+  $path =~ s!/+$!!;
+  $path =  substr($path,rindex($path,'/')+1);

  }
 
  return $path;
 }
 
  }
 
  return $path;
 }
 

+# 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)


@@ -240,35 +302,59 @@ sub file_name($)
 sub mode_string($)
 {
  my $mode   = shift;
 sub mode_string($)
 {
  my $mode   = shift;

- my $string = "";
+ my $string = '';

 
  # User
 
 
  # User
 

- $string  = ($mode & 00400) ? "r" : "-";
- $string .= ($mode & 00200) ? "w" : "-";
- $string .= ($mode & 00100) ? (($mode & 04000) ? "s" : "x") :
-                               ($mode & 04000) ? "S" : "-";
+ $string  = ($mode & 00400) ? 'r' : '-';
+ $string .= ($mode & 00200) ? 'w' : '-';
+ $string .= ($mode & 00100) ? (($mode & 04000) ? 's' : 'x') :
+                               ($mode & 04000) ? 'S' : '-';

 
  # Group
 
 
  # Group
 

- $string .= ($mode & 00040) ? "r" : "-";
- $string .= ($mode & 00020) ? "w" : "-";
- $string .= ($mode & 00010) ? (($mode & 02000) ? "s" : "x") :
-                               ($mode & 02000) ? "S" : "-";
+ $string .= ($mode & 00040) ? 'r' : '-';
+ $string .= ($mode & 00020) ? 'w' : '-';
+ $string .= ($mode & 00010) ? (($mode & 02000) ? 's' : 'x') :
+                               ($mode & 02000) ? 'S' : '-';

 
  # Other
 
 
  # Other
 

- $string .= ($mode & 00004) ? "r" : "-";
- $string .= ($mode & 00002) ? "w" : "-";
- $string .= ($mode & 00001) ? (($mode & 01000) ? "t" : "x") :
-                               ($mode & 01000) ? "T" : "-";
+ $string .= ($mode & 00004) ? 'r' : '-';
+ $string .= ($mode & 00002) ? 'w' : '-';
+ $string .= ($mode & 00001) ? (($mode & 01000) ? 't' : 'x') :
+                               ($mode & 01000) ? 'T' : '-';

 
  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,10 +365,10 @@ 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 = substr($path,0,-1) if($path =~ m!/$!);
-  $path = substr($path,0,rindex($path,"/")+1);
+  $path =~ s!/+$!!;
+  $path =  substr($path,0,rindex($path,'/')+1);

  }
 
  return $path;
  }
 
  return $path;