Rewrote some sentences in the README file

[devedit.git] / modules / File / Access.pm

diff --git a/modules/File/Access.pm b/modules/File/Access.pm
index 8958e62fd0d137927d873553d92f3d2495d6ccaf..af219a7d3be73f32a83d9f85d50443e6786f56d6 100644 (file)
--- a/modules/File/Access.pm
+++ b/modules/File/Access.pm
@@ -7,27 +7,40 @@ package File::Access;
 # using only one command
 #
 # Author:        Patrick Canterino <patrick@patshaping.de>
-# Last modified: 2004-12-17
+# Last modified: 2011-02-11
+#
+# Copyright (C) 1999-2000 Roland Bluethgen, Frank Schoenmann
+# Copyright (C) 2003-2011 Patrick Canterino
+# All Rights Reserved.
+#
+# This file can be distributed and/or modified under the terms of
+# of the Artistic License 2.0 (see also the LICENSE file found at
+# the top level of the Dev-Editor distribution).
 #
 
 use strict;
 
 use vars qw(@EXPORT
-            $has_flock);
+            $has_flock
+            $has_archive_extract
+            $archive_extract_error);
 
 use Fcntl qw(:DEFAULT
              :flock);
 
+use File::Copy;
+
 ### Export ###
 
 use base qw(Exporter);
 
-@EXPORT = qw(dir_read
+@EXPORT = qw(archive_unpack
+             dir_copy
+             dir_read
              file_create
              file_lock
              file_read
              file_save
-             file_unlock
 
              LOCK_SH
              LOCK_EX
@@ -39,6 +52,106 @@ use base qw(Exporter);
 
 $has_flock = eval { local $SIG{'__DIE__'}; flock(STDOUT,0); 1 };
 
+# Check if Archive::Extract is available
+
+$has_archive_extract = eval { local $SIG{'__DIE__'}; require Archive::Extract; 1 };
+
+# Predeclaration of dir_copy()
+
+sub dir_copy($$);
+
+# archive_unpack()
+#
+# Unpack an archive
+# (archive type must be supported by Archive::Extract)
+#
+# Params: 1. Archive path
+#         2. Path to extract (optional)
+#
+# Return: - Status code (Boolean)
+#         - undef if Archive::Extract is not available
+
+sub archive_unpack($;$)
+{
+ my ($archive,$path) = @_;
+
+ return undef unless($has_archive_extract);
+
+ return unless(-f $archive);
+ return if($path && not -d $path);
+
+ my $ae = Archive::Extract->new(archive => $archive);
+ return unless($ae);
+
+ if($path)
+ {
+  if($ae->extract(to => $path))
+  {
+   return 1;
+  }
+  else
+  {
+   $archive_extract_error = $ae->error;
+   return;
+  }
+ }
+ else
+ {
+  if($ae->extract)
+  {
+   return 1;
+  }
+  else
+  {
+   $archive_extract_error = $ae->error;
+   return;
+  }
+ }
+}
+
+# dir_copy()
+#
+# Copy a directory
+#
+# Params: 1. Directory to copy
+#         2. Target
+#
+# Return: Status code (Boolean)
+
+sub dir_copy($$)
+{
+ my ($dir,$target) = @_;
+
+ return unless(-d $dir);
+
+ my $entries = dir_read($dir) or return;
+
+ my $dirs    = $entries->{'dirs'};
+ my $files   = $entries->{'files'};
+
+ mkdir($target,0777) unless(-d $target);
+
+ foreach my $directory(@$dirs)
+ {
+  unless(-d $target.'/'.$directory)
+  {
+   mkdir($target.'/'.$directory,0777) or next;
+  }
+
+  if(-r $target.'/'.$directory && -x $target.'/'.$directory)
+  {
+   dir_copy($dir.'/'.$directory,$target.'/'.$directory) or next;
+  }
+ }
+
+ foreach my $file(@$files)
+ {
+  copy($dir.'/'.$file,$target.'/'.$file) or next;
+ }
+
+ return 1;
+}
+
 # dir_read()
 #
 # Collect the files and directories in a directory
@@ -46,7 +159,7 @@ $has_flock = eval { local $SIG{'__DIE__'}; flock(STDOUT,0); 1 };
 # Params: Directory
 #
 # Return: Hash reference: dirs  => directories
-#                         files => files
+#                         files => files and symbolic links
 
 sub dir_read($)
 {
@@ -70,9 +183,9 @@ sub dir_read($)
 
  foreach my $entry(@entries)
  {
-  next if($entry eq "." || $entry eq "..");
+  next if($entry eq '.' || $entry eq '..');
 
-  if(-d $dir."/".$entry)
+  if(-d $dir.'/'.$entry && not -l $dir.'/'.$entry)
   {
    push(@dirs,$entry);
   }
@@ -134,21 +247,23 @@ sub file_lock(*$)
 #
 # Read out a file completely
 #
-# Params: File
+# Params: 1. File
+#         2. true  => open in binary mode
+#            false => open in normal mode (default)
 #
 # Return: Contents of the file (Scalar Reference)
 
-sub file_read($)
+sub file_read($;$)
 {
- my $file = shift;
+ my ($file,$binary) = @_;
  local *FILE;
 
  sysopen(FILE,$file,O_RDONLY) or return;
  file_lock(FILE,LOCK_SH)      or do { close(FILE); return };
+ binmode(FILE) if($binary);
 
  read(FILE, my $content, -s $file);
 
- file_lock(FILE,LOCK_UN)      or do { close(FILE); return };
  close(FILE)                  or return;
 
  return \$content;
@@ -176,31 +291,11 @@ sub file_save($$;$)
 
  print FILE $$content                             or do { close(FILE); return };
 
- file_lock(FILE,LOCK_UN)                          or do { close(FILE); return };
  close(FILE)                                      or return;
 
  return 1;
 }
 
-# file_unlock()
-#
-# Remove a file from the list of files in use
-#
-# Params: 1. File::UseList object
-#         2. File to remove
-#
-# Return: -nothing-
-
-sub file_unlock($$)
-{
- my ($uselist,$file) = @_;
-
- $uselist->remove_file($file);
- $uselist->save;
-
- return;
-}
-
 # it's true, baby ;-)
 
 1;