- Dev-Editor now uses flock(). flock() is called using a wrapper function which

[devedit.git] / modules / Tool.pm

diff --git a/modules/Tool.pm b/modules/Tool.pm
index a37967ed5863c77caf877c59a025492209d25800..6a615daf9d20208c8dcc9ad6e4b189f47ee49ef3 100644 (file)
--- a/modules/Tool.pm
+++ b/modules/Tool.pm
@@ -5,16 +5,20 @@ package Tool;
 #
 # Some shared sub routines
 #
 #
 # Some shared sub routines
 #

-# Author:        Patrick Canterino <patshaping@gmx.net>
-# Last modified: 10-03-2003
+# Author:        Patrick Canterino <patrick@patshaping.de>
+# Last modified: 2004-12-16

 #
 
 use strict;
 
 use vars qw(@EXPORT);
 
 #
 
 use strict;
 
 use vars qw(@EXPORT);
 

+use CGI qw(redirect
+           escape
+           virtual_host
+           https);
+

 use Cwd qw(abs_path);
 use Cwd qw(abs_path);

-use File::Basename;

 use File::Spec;
 
 ### Export ###
 use File::Spec;
 
 ### Export ###


@@ -23,12 +27,15 @@ use base qw(Exporter);
 
 @EXPORT = qw(check_path
              clean_path
 
 @EXPORT = qw(check_path
              clean_path

+             devedit_reload
+             equal_url

              file_name
              file_name

+             mode_string

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

-# Check, if a virtual path is above a virtual root directory
+# Check if a virtual path is above a virtual root directory

 # (currently no check if the path exists - check otherwise!)
 #
 # Params: 1. Virtual root directory
 # (currently no check if the path exists - check otherwise!)
 #
 # Params: 1. Virtual root directory


@@ -49,39 +56,27 @@ sub check_path($$)
  $path =~ s!^/{1}!!;
  $path = $root."/".$path;
 
  $path =~ s!^/{1}!!;
  $path = $root."/".$path;
 

- unless(-d $path)
- {
-  # The path points to a file
-  # We have to extract the directory name and create the absolute path
-
-  my @pathinfo = fileparse($path);
-
-  # This is only to avoid errors
+ # We extract the last part of the path and create the absolute path

 
 

-  my $basename = $pathinfo[0] || '';
-  my $dir      = $pathinfo[1] || '';
-  my $ext      = $pathinfo[2] || '';
+ my $first = upper_path($path);
+ my $last  = file_name($path);

 
 

-  $dir = abs_path($dir);
+ $first = abs_path($first);
+ $path  = $first."/".$last;

 
 

-  $path = $dir."/".$basename.$ext;
- }
- else
- {
-  $path = abs_path($path);
- }
-
- $path = File::Spec->canonpath($path);
+ $first = File::Spec->canonpath($first);
+ $path  = File::Spec->canonpath($path);

 
  # Check if the path is above the root directory
 
 
  # Check if the path is above the root directory
 

- return if(index($path,$root) == -1);
+ return if(index($path,$root) != 0);
+ return if($first eq $root && $last =~ m!^(/|\\)?\.\.(/|\\)?$!);

 
  # 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 unless($short_path =~ m!^/!);
+ $short_path = "/".$short_path if($short_path !~ m!^/!);

  $short_path = $short_path."/" if($short_path !~ m!/$! && -d $path);
 
  return ($path,$short_path);
  $short_path = $short_path."/" if($short_path !~ m!/$! && -d $path);
 
  return ($path,$short_path);


@@ -105,9 +100,89 @@ sub clean_path($)
  return $path;
 }
 
  return $path;
 }
 

+# devedit_reload()
+#
+# Create a HTTP redirection header to load Dev-Editor
+# with some other parameters
+#
+# Params: Hash Reference (will be merged to a query string)
+#         (optional)
+#
+# Return: HTTP redirection header (Scalar Reference)
+
+sub devedit_reload(;$)
+{
+ my $params = shift;
+
+ # Detect the protocol (simple HTTP or SSL encrypted HTTP)
+ # and check if the server listens on the default port
+
+ my $protocol = "";
+ my $port     = "";
+
+ if(https)
+ {
+  # SSL encrypted HTTP (HTTPS)
+
+  $protocol = "https";
+  $port     = ":".$ENV{'SERVER_PORT'} if($ENV{'SERVER_PORT'} != 443);
+ }
+ else
+ {
+  # Simple HTTP
+
+  $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
+
+ my $query = "";
+
+ if(ref($params) eq "HASH")
+ {
+  $query = '?'.join ('&' =>
+    map {
+      (ref)
+      ? map{escape ($_).'='.escape ($params -> {$_})} @{$params -> {$_}}
+      : escape ($_).'='.escape ($params -> {$_})
+    } keys %$params
+  );
+ }
+
+ # Create the redirection header
+
+ my $header = redirect($protocol."://".virtual_host.$port.$ENV{'SCRIPT_NAME'}.$query);
+
+ return \$header;
+}
+
+# equal_url()
+#
+# Create URL equal to a file or directory
+#
+# Params: 1. HTTP root
+#         2. Relative path
+#
+# Return: Formatted link (String)
+
+sub equal_url($$)
+{
+ my ($root,$path) = @_;
+ my $url;
+
+ $root =~ s!/$!!;
+ $path =~ s!^/!!;
+ $url  =  $root."/".$path;
+
+ return $url;
+}
+

 # file_name()
 #
 # file_name()
 #

-# Returns the last path of a filename
+# Return the last part of a path

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


@@ -127,14 +202,47 @@ sub file_name($)
  return $path;
 }
 
  return $path;
 }
 

-# upper_path()
+# mode_string()

 #
 #

-# Truncate a path in one of the following ways:
+# Convert a file mode number into a human readable string (rwxr-x-r-x)
+# (also supports SetUID, SetGID and Sticky Bit)
+#
+# Params: File mode number
+#
+# Return: Human readable mode string
+
+sub mode_string($)
+{
+ my $mode   = shift;
+ my $string = "";
+
+ # User
+
+ $string  = ($mode & 00400) ? "r" : "-";
+ $string .= ($mode & 00200) ? "w" : "-";
+ $string .= ($mode & 00100) ? (($mode & 04000) ? "s" : "x") :
+                               ($mode & 04000) ? "S" : "-";
+
+ # Group
+
+ $string .= ($mode & 00040) ? "r" : "-";
+ $string .= ($mode & 00020) ? "w" : "-";
+ $string .= ($mode & 00010) ? (($mode & 02000) ? "s" : "x") :
+                               ($mode & 02000) ? "S" : "-";
+
+ # Other
+
+ $string .= ($mode & 00004) ? "r" : "-";
+ $string .= ($mode & 00002) ? "w" : "-";
+ $string .= ($mode & 00001) ? (($mode & 01000) ? "t" : "x") :
+                               ($mode & 01000) ? "T" : "-";
+
+ return $string;
+}
+
+# upper_path()

 #
 #

-# - If the path points to a directory, the upper directory
-#   will be returned.
-# - If the path points to a file, the directory containing
-#   the file will be returned.
+# Cut away the last part of a path

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


@@ -148,8 +256,7 @@ sub upper_path($)
  unless($path eq "/")
  {
   $path = substr($path,0,-1) if($path =~ m!/$!);
  unless($path eq "/")
  {
   $path = substr($path,0,-1) if($path =~ m!/$!);

-  $path = substr($path,0,rindex($path,"/"));
-  $path = $path."/";
+  $path = substr($path,0,rindex($path,"/")+1);

  }
 
  return $path;
  }
 
  return $path;