Small code cleaning

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

diff --git a/modules/File/Access.pm b/modules/File/Access.pm
index 28124cce18e1483381524a25fdf71eb98f1b2c15..dd6403bffaaab0fe18e6b5baa02c946023faf34a 100644 (file)
--- a/modules/File/Access.pm
+++ b/modules/File/Access.pm
@@ -3,18 +3,20 @@ package File::Access;
 #
 # Dev-Editor - Module File::Access
 #
-# Some simple routines for doing things with files
-# with only one command
+# Some simple routines for doing things with files by
+# using only one command
 #
 # Author:        Patrick Canterino <patrick@patshaping.de>
-# Last modified: 2004-10-26
+# Last modified: 2005-02-12
 #
 
 use strict;
 
-use vars qw(@EXPORT);
+use vars qw(@EXPORT
+            $has_flock);
 
-use Fcntl;
+use Fcntl qw(:DEFAULT
+             :flock);
 
 ### Export ###
 
@@ -22,9 +24,20 @@ use base qw(Exporter);
 
 @EXPORT = qw(dir_read
              file_create
+             file_lock
              file_read
              file_save
-             file_unlock);
+             file_unlock
+
+             LOCK_SH
+             LOCK_EX
+             LOCK_UN
+             LOCK_NB);
+
+# Check if flock() is available
+# I found this piece of code somewhere in the internet
+
+$has_flock = eval { local $SIG{'__DIE__'}; flock(STDOUT,0); 1 };
 
 # dir_read()
 #
@@ -33,7 +46,7 @@ use base qw(Exporter);
 # Params: Directory
 #
 # Return: Hash reference: dirs  => directories
-#                         files => files
+#                         files => files and symbolic links
 
 sub dir_read($)
 {
@@ -57,9 +70,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);
   }
@@ -98,21 +111,47 @@ sub file_create($)
  return 1;
 }
 
+# file_lock()
+#
+# System independent wrapper function for flock()
+# On systems where flock() is not available, this function
+# always returns true.
+#
+# Params: 1. Filehandle
+#         2. Locking mode
+#
+# Return: Status code (Boolean)
+
+sub file_lock(*$)
+{
+ my ($handle,$mode) = @_;
+
+ return 1 unless($has_flock);
+ return flock($handle,$mode);
+}
+
 # file_read()
 #
 # 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;
@@ -124,16 +163,23 @@ sub file_read($)
 #
 # Params: 1. File
 #         2. File content as Scalar Reference
+#         3. true  => open in binary mode
+#            false => open in normal mode (default)
 #
 # Return: Status code (Boolean)
 
-sub file_save($$)
+sub file_save($$;$)
 {
- my ($file,$content) = @_;
+ my ($file,$content,$binary) = @_;
  local *FILE;
 
  sysopen(FILE,$file,O_WRONLY | O_CREAT | O_TRUNC) or return;
+ file_lock(FILE,LOCK_EX)                          or do { close(FILE); return };
+ binmode(FILE) if($binary);
+
  print FILE $$content                             or do { close(FILE); return };
+
+ file_lock(FILE,LOCK_UN)                          or do { close(FILE); return };
  close(FILE)                                      or return;
 
  return 1;
@@ -146,16 +192,16 @@ sub file_save($$)
 # Params: 1. File::UseList object
 #         2. File to remove
 #
-# Return: -nothing-
+# Return: Status code (Boolean)
 
 sub file_unlock($$)
 {
  my ($uselist,$file) = @_;
 
- $uselist->remove_file($file);
- $uselist->save;
+ $uselist->remove_file($file) or return;
+ $uselist->save               or return;
 
- return;
+ return 1;
 }
 
 # it's true, baby ;-)