Added description for "hide_dot_files" in README

[devedit.git] / modules / Tool.pm

diff --git a/modules/Tool.pm b/modules/Tool.pm
index 2347445b267fc84df46a578c5d101aace39e7eca..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-08
+# 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()


@@ -61,6 +72,7 @@ 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);
  $first    = abs_path($first);
 
  my $last  = file_name($path);


@@ -77,13 +89,14 @@ sub check_path($$)
  # 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(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);
 }


@@ -178,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


@@ -189,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


@@ -223,7 +258,7 @@ sub file_name($)
  my $path =  shift;
  $path    =~ tr!\\!/!;
 
  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);
  {
   $path =~ s!/+$!!;
   $path =  substr($path,rindex($path,'/')+1);


@@ -232,6 +267,29 @@ sub file_name($)
  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)


@@ -270,6 +328,29 @@ 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()
 #
 # Remove the last part of a path
 # upper_path()
 #
 # Remove the last part of a path


@@ -284,7 +365,7 @@ sub upper_path($)
  my $path =  shift;
  $path    =~ tr!\\!/!;
 
  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);
  {
   $path =~ s!/+$!!;
   $path =  substr($path,0,rindex($path,'/')+1);