package File::UseList;
#
-# File::UseList
+# File::UseList 1.3
#
-# Fuehren einer Liste mit Dateien, auf die zur Zeit zugegriffen wird
-# (basiert auf Filing::UseList von Roland Bluethgen <calocybe@web.de>)
+# Run a list with files that are currently in use
+# (bases on Filing::UseList by Roland Bluethgen <calocybe@web.de>)
#
-# Autor: Patrick Canterino <patshaping@gmx.net>
-# Letzte Aenderung: 20.9.2003
+# Author: Patrick Canterino <patrick@patshaping.de>
+# Last modified: 2004-12-03
#
use strict;
use Carp qw(croak);
-
-our $VERSION = '1.0';
+use Fcntl;
# new()
#
-# Konstruktor
+# Constructor
#
-# Parameter: Hash: listfile => Datei mit der Liste der benutzten Dateien
-# lockfile => Lock-Datei
-# timeout => Lock-Timeout in Sekunden (Standard: 10)
+# Params: Hash: listfile => File with list of files in use
+# lockfile => Lock file (Default: List file + .lock)
+# timeout => Lock timeout in seconds (Default: 10)
#
-# Rueckgabe: File::UseList-Objekt
+# Return: File::UseList object (Blessed Reference)
sub new(%)
{
my ($class,%args) = @_;
- # Pruefen, ob wir alle Informationen erhalten haben
+ # Check if we got all the necessary information
- croak "Missing path of list file" unless($args{'listfile'});
- croak "Missing path of lockfile" unless($args{'lockfile'});
- $args{'timeout'} = 10 unless($args{'timeout'}); # Standard-Timeout
+ croak "Missing path to list file" unless($args{'listfile'});
+ $args{'lockfile'} = $args{'listfile'}.".lock" unless($args{'lockfile'}); # Default filename of lock file
+ $args{'timeout'} = 10 unless($args{'timeout'}); # Default timeout
- my $self = \%args;
- $self->{'files'} = [];
+ # Add some other information
- return bless($self,$class);
+ $args{'files'} = [];
+ $args{'locked'} = 0;
+
+ return bless(\%args,$class);
}
# lock()
#
-# Datei mit Liste sperren
-# (Lock-Datei loeschen)
+# Lock list with files
+# (delete lock file)
#
-# Parameter: -keine-
+# Params: -nothing-
#
-# Rueckgabe: Status-Code (Boolean)
+# Return: Status code (Boolean)
sub lock
{
my $lockfile = $self->{'lockfile'};
my $timeout = $self->{'timeout'};
- # Versuche, einmal pro Sekunde die Datei zu loeschen
- # bis das Timeout erreicht ist
+ return 1 if($self->{'locked'});
+
+ # Try to delete the lock file one time per second
+ # until the timeout is reached
for(my $x=$timeout;$x>=0;$x--)
{
- unlink($lockfile) and return 1;
+ if(unlink($lockfile))
+ {
+ $self->{'locked'} = 1;
+ return 1;
+ }
+
sleep(1);
}
# unlock()
#
-# Datei mit Liste freigeben
-# (Lock-Datei anlegen)
+# Unlock list with files, but only if _we_ locked it
+# (create lock file)
#
-# Parameter: -keine-
+# Params: -nothing-
#
-# Rueckgabe: Status-Code (Boolean)
+# Return: Status code (Boolean)
sub unlock
{
my $lockfile = $self->{'lockfile'};
local *LOCKFILE;
- return 1 if(-f $lockfile); # Hmmm...
+ if($self->{'locked'})
+ {
+ sysopen(LOCKFILE,$lockfile,O_WRONLY | O_CREAT | O_TRUNC) or return;
+ close(LOCKFILE) or return;
- open(LOCKFILE,">",$lockfile) or return;
- close(LOCKFILE) or return;
+ $self->{'locked'} = 0;
+ return 1;
+ }
- return 1;
+ # The list wasn't lock by us or it isn't locked at all
+
+ return;
}
# load()
#
-# Liste mit Dateien laden
+# Load the list with files from the list file
#
-# Parameter: -keine-
+# Params: -nothing-
#
-# Rueckgabe: Status-Code (Boolean)
+# Return: Status code (Boolean)
sub load
{
my $file = $self->{'listfile'};
local *FILE;
- # Datei auslesen und zeilenweise aufteilen
+ # Read out the file and split the content line-per-line
- open(FILE,"<".$file) or return;
+ sysopen(FILE,$file,O_RDONLY) or return;
read(FILE, my $content, -s $file);
- close(FILE) or return;
+ close(FILE) or return;
my @files = split(/\015\012|\012|\015/,$content);
- # Unbrauchbare Zeilen entfernen
+ # Remove useless lines
for(my $x=0;$x<@files;$x++)
{
if($files[$x] eq "" || $files[$x] =~ /^\s+$/)
{
splice(@files,$x,1);
- $x--; # <-- sehr wichtig!
+ $x--; # <-- very important!
}
}
# save()
#
-# Liste mit Dateien speichern
+# Write the list with files back to the list file
#
-# Parameter: -keine-
+# Params: -nothing-
#
-# Rueckgabe: Status-Code (Boolean)
+# Return: Status code (Boolean)
sub save
{
my $files = $self->{'files'};
local *FILE;
- my $data = (@$files) ? join("\n",@$files)."\n" : '';
+ my $data = (@$files) ? join("\n",@$files) : '';
- open(FILE,">",$temp) or return;
- print FILE $data;
- close(FILE) or return;
+ sysopen(FILE,$temp,O_WRONLY | O_CREAT | O_TRUNC) or return;
+ print FILE $data or do { close(FILE); return };
+ close(FILE) or return;
- rename($temp,$file) and return 1;
+ rename($temp,$file) or return;
- # Mist
-
- return;
+ return 1;
}
# add_file()
#
-# Datei zur Liste hinzufuegen
+# Add a file to the list
#
-# Parameter: Datei
+# Params: File
+#
+# Return: Status code (Boolean)
sub add_file($)
{
my ($self,$file) = @_;
my $files = $self->{'files'};
- # Pruefen, ob die Datei nicht schon in der Liste vorhanden ist
+ # Check if the file is already in the list
return if($self->in_use($file));
push(@$files,$file);
+ return 1;
}
# remove_file()
#
-# Datei aus der Liste entfernen
+# Remove a file from the list
#
-# Parameter: Datei
+# Params: File
+#
+# Return: Status code (Boolean)
sub remove_file($)
{
my ($self,$file) = @_;
my $files = $self->{'files'};
- # Pruefen, ob die Datei ueberhaupt in der Liste vorhanden ist
+ # Check if the file is really in the list
return if($self->unused($file));
- # Datei entfernen
+ # Remove the file from the list
for(my $x=0;$x<@$files;$x++)
{
if($files->[$x] eq $file)
{
splice(@$files,$x,1);
- last;
+ return 1;
}
}
}
+# remove_all()
+#
+# Remove all files from the list
+#
+# Params: -nothing-
+#
+# Return: -nothing-
+
+sub remove_all
+{
+ my $self = shift;
+
+ $self->{'files'} = [];
+
+ return;
+}
+
# in_use()
#
-# Pruefen, ob eine Datei in der Liste vorhanden ist
+# Check if a file is in the list
#
-# Parameter: Zu pruefende Datei
+# Params: File to check
#
-# Rueckgabe: Status-Code (Boolean)
+# Return: Status code (Boolean)
sub in_use($)
{
# unused()
#
-# Pruefen, ob eine Datei nicht in der Liste vorhanden ist
+# Check if a file is not in the list
#
-# Parameter: Zu pruefende Datei
+# Params: File to check
#
-# Rueckgabe: Status-Code (Boolean)
+# Return: Status code (Boolean)
sub unused($)
{
1;
#
-### Ende ###
\ No newline at end of file
+### End ###
\ No newline at end of file
git.p6c8.net / devedit.git / blobdiff