Finished documentation of the configuration directive "forbidden"

[devedit.git] / modules / Tool.pm

diff --git a/modules/Tool.pm b/modules/Tool.pm
index acc47220d5999748de0e0bb690d866db6b6c9734..d9a20f7ea72bccea4401552fe4872def65c0e823 100644 (file)
--- a/modules/Tool.pm
+++ b/modules/Tool.pm
@@ -6,7 +6,7 @@ package Tool;
 # Some shared sub routines
 #
 # Author:        Patrick Canterino <patrick@patshaping.de>
-# Last modified: 2005-02-12
+# Last modified: 2005-06-10
 #
 
 use strict;
@@ -29,9 +29,12 @@ use base qw(Exporter);
              clean_path
              devedit_reload
              dos_wildcard_match
+             encode_html
              equal_url
              file_name
+             is_forbidden_file
              mode_string
+             multi_string
              upper_path);
 
 # check_path()
@@ -61,12 +64,12 @@ sub check_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);
- $last     = '' if($last eq '.');
 
- if($last eq '..' || ($^O eq 'MSWin32' && $last =~ m!^\.\.\.+$!))
+ if(-d $first.'/'.$last && not -l $first.'/'.$last)
  {
   $first = abs_path($first.'/'.$last);
   $last  = '';
@@ -189,6 +192,26 @@ sub dos_wildcard_match($$)
  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
@@ -223,7 +246,7 @@ sub file_name($)
  my $path =  shift;
  $path    =~ tr!\\!/!;
 
- unless($path =~ m!^/+$! || ($^O eq 'MSWin32' && $path =~ m!^[a-z]:/+$!))
+ unless($path =~ m!^/+$! || ($^O eq 'MSWin32' && $path =~ m!^[a-z]:/+$!i))
  {
   $path =~ s!/+$!!;
   $path =  substr($path,rindex($path,'/')+1);
@@ -232,6 +255,29 @@ sub file_name($)
  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)
@@ -270,6 +316,29 @@ sub mode_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()
 #
 # Remove the last part of a path
@@ -284,7 +353,7 @@ sub upper_path($)
  my $path =  shift;
  $path    =~ tr!\\!/!;
 
- unless($path =~ m!^/+$! || ($^O eq 'MSWin32' && $path =~ m!^[a-z]:/+$!))
+ unless($path =~ m!^/+$! || ($^O eq 'MSWin32' && $path =~ m!^[a-z]:/+$!i))
  {
   $path =~ s!/+$!!;
   $path =  substr($path,0,rindex($path,'/')+1);