1 package DBM::Deep::File;
8 our $VERSION = q(0.99_01);
10 use Fcntl qw( :DEFAULT :flock :seek );
27 filter_store_key => undef,
28 filter_store_value => undef,
29 filter_fetch_key => undef,
30 filter_fetch_value => undef,
32 # These are values that are not expected to be passed in through
33 # $args. They are here for documentation purposes.
35 transaction_offset => 0,
36 transaction_audit => undef,
40 # Grab the parameters we want to use
41 foreach my $param ( keys %$self ) {
42 next unless exists $args->{$param};
43 $self->{$param} = $args->{$param};
46 if ( $self->{fh} && !$self->{file_offset} ) {
47 $self->{file_offset} = tell( $self->{fh} );
50 $self->open unless $self->{fh};
52 if ( $self->{audit_file} && !$self->{audit_fh} ) {
53 my $flags = O_WRONLY | O_APPEND | O_CREAT;
56 sysopen( $fh, $self->{audit_file}, $flags )
57 or die "Cannot open audit file '$self->{audit_file}' for read/write: $!";
59 # Set the audit_fh to autoflush
64 $self->{audit_fh} = $fh;
74 unless ( $self->{base_db_obj} ) {
75 $self->{base_db_obj} = shift;
76 Scalar::Util::weaken( $self->{base_db_obj} );
85 # Adding O_BINARY should remove the need for the binmode below. However,
86 # I'm not going to remove it because I don't have the Win32 chops to be
87 # absolutely certain everything will be ok.
88 my $flags = O_RDWR | O_CREAT | O_BINARY;
91 sysopen( $fh, $self->{file}, $flags )
92 or die "DBM::Deep: Cannot sysopen file '$self->{file}': $!\n";
95 # Even though we use O_BINARY, better be safe than sorry.
98 if ($self->{autoflush}) {
121 unless ( $self->{inode} ) {
122 my @stats = stat($self->{fh});
123 $self->{inode} = $stats[1];
124 $self->{end} = $stats[7];
136 my $fh = $self->{fh};
137 if ( defined $loc ) {
138 seek( $fh, $loc + $self->{file_offset}, SEEK_SET );
148 my ($loc, $size) = @_;
152 my $fh = $self->{fh};
153 if ( defined $loc ) {
154 seek( $fh, $loc + $self->{file_offset}, SEEK_SET );
158 read( $fh, $buffer, $size);
163 sub increment_pointer {
167 if ( defined $size ) {
168 seek( $self->{fh}, $size, SEEK_CUR );
187 #XXX Do I need to reset $self->{end} here? I need a testcase
188 my $loc = $self->{end};
189 $self->{end} += $size;
196 # my ($size, $loc) = @_;
202 # my $fh = $self->{fh};
203 # seek( $fh, $loc + $self->{file_offset}, SEEK_SET );
204 # print( $fh SIG_FREE
205 # . pack($self->{long_pack}, $size )
206 # . pack($self->{long_pack}, $next_loc )
213 # If db locking is set, flock() the db file. If called multiple
214 # times before unlock(), then the same number of unlocks() must
215 # be called before the lock is released.
219 my ($obj, $type) = @_;
221 #XXX This may not always be the correct thing to do
222 $obj = $self->{base_db_obj} unless defined $obj;
224 $type = LOCK_EX unless defined $type;
226 if (!defined($self->{fh})) { return; }
228 if ($self->{locking}) {
229 if (!$self->{locked}) {
230 flock($self->{fh}, $type);
232 # refresh end counter in case file has changed size
233 my @stats = stat($self->{fh});
234 $self->{end} = $stats[7];
236 # double-check file inode, in case another process
237 # has optimize()d our file while we were waiting.
238 if ($stats[1] != $self->{inode}) {
243 $obj->{engine}->setup_fh( $obj );
245 flock($self->{fh}, $type); # re-lock
247 # This may not be necessary after re-opening
248 $self->{end} = (stat($self->{fh}))[7]; # re-end
260 # If db locking is set, unlock the db file. See note in lock()
261 # regarding calling lock() multiple times.
266 if (!defined($self->{fh})) { return; }
268 if ($self->{locking} && $self->{locked} > 0) {
270 if (!$self->{locked}) { flock($self->{fh}, LOCK_UN); }
278 sub set_transaction_offset {
280 $self->{transaction_offset} = shift;
287 if ( my $afh = $self->{audit_fh} ) {
288 flock( $afh, LOCK_EX );
290 if ( $string =~ /^#/ ) {
291 print( $afh "$string " . localtime(time) . "\n" );
294 print( $afh "$string # " . localtime(time) . "\n" );
297 flock( $afh, LOCK_UN );
300 if ( $self->{transaction_audit} ) {
301 push @{$self->{transaction_audit}}, $string;
307 sub begin_transaction {
310 my $fh = $self->{fh};
314 my $buffer = $self->read_at( $self->{transaction_offset}, 4 );
315 my ($next, @trans) = unpack( 'C C C C', $buffer );
317 $self->{transaction_id} = ++$next;
319 die if $trans[-1] != 0;
321 for ( my $i = 0; $i <= $#trans; $i++ ) {
322 next if $trans[$i] != 0;
328 $self->{transaction_offset},
329 pack( 'C C C C', $next, @trans),
334 $self->{transaction_audit} = [];
336 return $self->{transaction_id};
339 sub end_transaction {
342 my $fh = $self->{fh};
346 my $buffer = $self->read_at( $self->{transaction_offset}, 4 );
347 my ($next, @trans) = unpack( 'C C C C', $buffer );
349 @trans = grep { $_ != $self->{transaction_id} } @trans;
352 $self->{transaction_offset},
353 pack( 'C C C C', $next, @trans),
356 #XXX Need to free the space used by the current transaction
360 $self->{transaction_id} = 0;
361 $self->{transaction_audit} = undef;
363 # $self->{base_db_obj}->optimize;
364 # $self->{inode} = undef;
370 sub current_transactions {
373 my $fh = $self->{fh};
377 my $buffer = $self->read_at( $self->{transaction_offset}, 4 );
378 my ($next, @trans) = unpack( 'C C C C', $buffer );
382 return grep { $_ && $_ != $self->{transaction_id} } @trans;
385 sub transaction_id { return $_[0]->{transaction_id} }
387 sub commit_transaction {
390 my @audit = @{$self->{transaction_audit}};
392 $self->end_transaction;
395 my $db = $self->{base_db_obj};
398 warn "$_: $@\n" if $@;