blib/lib/Uplug/Web/Process/Lock.pm untested

filter: Statementstmt 0.0% 0 / 98 Branchbran 0.0% 0 / 24 Conditioncond 0.0% 0 / 20 MC/DCmcdc 0.0% 0 / 11 Subroutinesub 0.0% 0 / 15 Podpod 0.0% 0 / 5 totaltotal 0.0% 0 / 173 CC 13 SCAR 30.0
CC
13
Cov
0%
nflock
56.0
RemoveOldLockFiles
20.0
nunflock
12.0
CRAP 20.1
1  
2  
3  
4  
5 # taken from the Perl Cookbook recipe 7.21 (netlock)
6 #
7 # try: LockFile::Simple
8 # http://search.cpan.org/~ram/LockFile-Simple-0.2.5/Simple.pm
9  
10  
11 package Uplug::Web::Process::Lock;
12 # module to provide very basic filename-level
13 # locks. No fancy systems calls. In theory,
14 # directory info is sync'd over NFS. Not
15 # stress tested.
16  
17 use strict;
18  
19 use Exporter;
20 use vars qw(@ISA @EXPORT);
21 @ISA = qw(Exporter);
22 @EXPORT = qw(nflock nunflock);
23  
24 use vars qw($Debug $Check $MaxLockTime);
25 $Debug ||= 0; # may be predefined
26 $Check ||= 5; # may be predefined
27  
28 $MaxLockTime ||= 10; # lock files max 10 seconds! (remove older lockfiles!)
29  
30 use Cwd;
31 use Fcntl;
32 use Sys::Hostname;
33 use File::Basename;
34 use File::stat;
35 use Carp;
36  
37 my %Locked_Files = ();
38  
39 # usage: nflock(FILE; NAPTILL)
40 sub nflock($;$) {
41 my $pathname = shift;
42 my $naptime = shift || 0;
43 my $lockname = name2lock($pathname);
44 my $whosegot = "$lockname/owner";
45 my $start = time();
46 my $missed = 0;
47 local *OWNER;
48  
49 # if locking what I've already locked, return
50 if ($Locked_Files{$pathname}) {
51 carp "$pathname already locked";
52 return 1
53 }
54  
55 if (!-w dirname($pathname)) {
56 # croak "can't write to directory of $pathname";
57 #
58 # joerg 040913:
59 # I should give up and return 0 but for the sake of UplugWeb
60 # and its write-permissions we simply go on instead of failing
61 return 1;
62 }
63  
64 while (1) {
65 last if mkdir($lockname, 0777);
66 confess "can't get $lockname: $!" if $missed++ > 10
67 && !-d $lockname;
68 if ($Debug) {{
69 open(OWNER, "< $whosegot") || last; # exit "if"!
70 my $lockee = <OWNER>;
71 chomp($lockee);
72 printf STDERR "%s $0\[$$]: lock on %s held by %s\n",
73 scalar(localtime), $pathname, $lockee;
74 close OWNER;
75 }}
76  
77 #### added by joerg@stp.ling.uu.se: check time stamp
78 #### remove files if too old
79 #### (time-mtime>maxlocktime)
80 &RemoveOldLockFiles($whosegot,$MaxLockTime);
81 &RemoveOldLockFiles($lockname,$MaxLockTime);
82 ####
83 ####
84  
85 sleep $Check;
86 return if $naptime && time > $start+$naptime;
87 }
88 sysopen(OWNER, $whosegot, O_WRONLY|O_CREAT|O_EXCL)
89 or croak "can't create $whosegot: $!";
90 printf OWNER "$0\[$$] on %s since %s\n",
91 hostname(), scalar(localtime);
92 close(OWNER)
93 or croak "close $whosegot: $!";
94 $Locked_Files{$pathname}++;
95 return 1;
96 }
97  
98 # free the locked file
99 sub nunflock($) {
100 my $pathname = shift;
101 my $dir = dirname($pathname);
102 my $lockname = name2lock($pathname);
103 my $whosegot = "$lockname/owner";
104 unlink($whosegot) if -e $whosegot;
105 carp "releasing lock on $lockname" if $Debug;
106 delete $Locked_Files{$pathname};
107 return rmdir($lockname);
108 # my $ret = rmdir($lockname);
109 # rmdir("$dir/.lockdir");
110 # return $ret;
111 }
112  
113 # helper function
114 sub name2lock($) {
115 my $pathname = shift;
116 my $dir = dirname($pathname);
117 my $file = basename($pathname);
118 $dir = getcwd() if $dir eq '.';
119 my $lockname = "$dir/$file.LOCKDIR"; # original version
120 # if (not -d "$dir/.lockdir"){
121 # mkdir ("$dir/.lockdir",0775);
122 # system ("chmod g+w $dir/.lockdir");
123 # }
124 # my $lockname = "$dir/.lockdir/$file";
125 return $lockname;
126 }
127  
128 sub RemoveOldLockFiles{
129 my $file=shift;
130 my $maxtime=shift;
131 if (not -e $file){return 1;}
132 my $filestat=stat($file);
133 if ((time-$filestat->mtime)>$maxtime){
134 if (-d $file){return rmdir($file);}
135 return unlink($file);
136 }
137 }
138  
139 # anything forgotten?
140 END {
141 for my $pathname (keys %Locked_Files) {
142 my $dir = dirname($pathname);
143 my $lockname = name2lock($pathname);
144 my $whosegot = "$lockname/owner";
145 carp "releasing forgotten $lockname";
146 unlink($whosegot);
147 return rmdir($lockname);
148 # my $ret = rmdir($lockname);
149 # rmdir("$dir/.lockdir");
150 # return $ret;
151 }
152 }
153  
154 1;