8 our $VERSION = q(1.0005);
10 use Fcntl qw( :flock );
14 use FileHandle::Fmode ();
17 use DBM::Deep::Engine;
21 '""' => sub { overload::StrVal( $_[0] ) },
25 # Setup constants for users to pass to new()
27 sub TYPE_HASH () { DBM::Deep::Engine->SIG_HASH }
28 sub TYPE_ARRAY () { DBM::Deep::Engine->SIG_ARRAY }
30 # This is used in all the children of this class in their TIE<type> methods.
37 $proto->_throw_error( "Odd number of parameters to " . (caller(1))[2] );
42 unless ( eval { local $SIG{'__DIE__'}; %{$_[0]} || 1 } ) {
43 $proto->_throw_error( "Not a hashref in args to " . (caller(1))[2] );
48 $args = { file => shift };
56 # Class constructor method for Perl OO interface.
57 # Calls tie() and returns blessed reference to tied hash or array,
58 # providing a hybrid OO/tie interface.
61 my $args = $class->_get_args( @_ );
64 # Check if we want a tied hash or array.
67 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
68 $class = 'DBM::Deep::Array';
69 require DBM::Deep::Array;
70 tie @$self, $class, %$args;
73 $class = 'DBM::Deep::Hash';
74 require DBM::Deep::Hash;
75 tie %$self, $class, %$args;
78 return bless $self, $class;
81 # This initializer is called from the various TIE* methods. new() calls tie(),
82 # which allows for a single point of entry.
87 $args->{storage} = DBM::Deep::File->new( $args )
88 unless exists $args->{storage};
90 # locking implicitly enables autoflush
91 if ($args->{locking}) { $args->{autoflush} = 1; }
93 # These are the defaults to be optionally overridden below
103 $args->{engine} = DBM::Deep::Engine->new( { %{$args}, obj => $self } )
104 unless exists $args->{engine};
106 # Grab the parameters we want to use
107 foreach my $param ( keys %$self ) {
108 next unless exists $args->{$param};
109 $self->{$param} = $args->{$param};
113 local $SIG{'__DIE__'};
116 $self->_engine->setup_fh( $self );
117 $self->_storage->set_inode;
121 eval { local $SIG{'__DIE__'}; $self->unlock; };
130 require DBM::Deep::Hash;
131 return DBM::Deep::Hash->TIEHASH( @_ );
136 require DBM::Deep::Array;
137 return DBM::Deep::Array->TIEARRAY( @_ );
141 my $self = shift->_get_self;
142 return $self->_storage->lock( $self, @_ );
146 my $self = shift->_get_self;
147 return $self->_storage->unlock( $self, @_ );
151 my $self = shift->_get_self;
152 my ($spot, $value) = @_;
157 elsif ( eval { local $SIG{__DIE__}; $value->isa( 'DBM::Deep' ) } ) {
158 ${$spot} = $value->_repr;
159 $value->_copy_node( ${$spot} );
162 my $r = Scalar::Util::reftype( $value );
163 my $c = Scalar::Util::blessed( $value );
164 if ( $r eq 'ARRAY' ) {
165 ${$spot} = [ @{$value} ];
168 ${$spot} = { %{$value} };
170 ${$spot} = bless ${$spot}, $c
178 # die "Must be implemented in a child class\n";
182 # die "Must be implemented in a child class\n";
187 # Recursively export into standard Perl hashes and arrays.
189 my $self = shift->_get_self;
191 my $temp = $self->_repr;
194 $self->_copy_node( $temp );
197 my $classname = $self->_engine->get_classname( $self );
198 if ( defined $classname ) {
199 bless $temp, $classname;
207 # Recursively import Perl hash/array structure
209 if (!ref($_[0])) { return; } # Perl calls import() on use -- ignore
211 my $self = shift->_get_self;
214 # struct is not a reference, so just import based on our type
216 $struct = $self->_repr( @_ );
219 #XXX This isn't the best solution. Better would be to use Data::Walker,
220 #XXX but that's a lot more thinking than I want to do right now.
222 local $SIG{'__DIE__'};
223 $self->_import( Clone::clone( $struct ) );
224 }; if ( my $e = $@ ) {
231 #XXX Need to keep track of who has a fh to this file in order to
232 #XXX close them all prior to optimize on Win32/cygwin
235 # Rebuild entire database into new file, then move
236 # it back on top of original.
238 my $self = shift->_get_self;
240 #XXX Need to create a new test for this
241 # if ($self->_storage->{links} > 1) {
242 # $self->_throw_error("Cannot optimize: reference count is greater than 1");
245 #XXX Do we have to lock the tempfile?
247 my $db_temp = DBM::Deep->new(
248 file => $self->_storage->{file} . '.tmp',
249 type => $self->_type,
251 # Bring over all the parameters that we need to bring over
252 ( map { $_ => $self->_engine->$_ } qw(
253 byte_size max_buckets data_sector_size num_txns
258 $self->_engine->clear_cache;
259 $self->_copy_node( $db_temp );
263 # Attempt to copy user, group and permissions over to new file
265 my @stats = stat($self->_fh);
266 my $perms = $stats[2] & 07777;
269 chown( $uid, $gid, $self->_storage->{file} . '.tmp' );
270 chmod( $perms, $self->_storage->{file} . '.tmp' );
272 # q.v. perlport for more information on this variable
273 if ( $^O eq 'MSWin32' || $^O eq 'cygwin' ) {
275 # Potential race condition when optmizing on Win32 with locking.
276 # The Windows filesystem requires that the filehandle be closed
277 # before it is overwritten with rename(). This could be redone
281 $self->_storage->close;
284 if (!rename $self->_storage->{file} . '.tmp', $self->_storage->{file}) {
285 unlink $self->_storage->{file} . '.tmp';
287 $self->_throw_error("Optimize failed: Cannot copy temp file over original: $!");
291 $self->_storage->close;
293 $self->_storage->open;
295 $self->_engine->setup_fh( $self );
303 # Make copy of object and return
305 my $self = shift->_get_self;
307 return DBM::Deep->new(
308 type => $self->_type,
309 base_offset => $self->_base_offset,
310 staleness => $self->_staleness,
311 storage => $self->_storage,
312 engine => $self->_engine,
316 #XXX Migrate this to the engine, where it really belongs and go through some
317 # API - stop poking in the innards of someone else..
319 my %is_legal_filter = map {
322 store_key store_value
323 fetch_key fetch_value
327 my $self = shift->_get_self;
331 if ( $is_legal_filter{$type} ) {
332 $self->_storage->{"filter_$type"} = $func;
339 sub filter_store_key { $_[0]->set_filter( store_key => $_[1] ); }
340 sub filter_store_value { $_[0]->set_filter( store_value => $_[1] ); }
341 sub filter_fetch_key { $_[0]->set_filter( fetch_key => $_[1] ); }
342 sub filter_fetch_value { $_[0]->set_filter( fetch_value => $_[1] ); }
346 my $self = shift->_get_self;
347 return $self->_engine->begin_work( $self, @_ );
351 my $self = shift->_get_self;
352 return $self->_engine->rollback( $self, @_ );
356 my $self = shift->_get_self;
357 return $self->_engine->commit( $self, @_ );
365 my $self = $_[0]->_get_self;
366 return $self->{engine};
370 my $self = $_[0]->_get_self;
371 return $self->{storage};
375 my $self = $_[0]->_get_self;
376 return $self->{type};
380 my $self = $_[0]->_get_self;
381 return $self->{base_offset};
385 my $self = $_[0]->_get_self;
386 return $self->{staleness};
390 my $self = $_[0]->_get_self;
391 return $self->_storage->{fh};
401 my @caller = caller( ++$n );
402 next if $caller[0] =~ m/^DBM::Deep/;
404 die "DBM::Deep: $_[1] at $0 line $caller[2]\n";
410 # Store single hash key/value or array element in database.
412 my $self = shift->_get_self;
413 my ($key, $value) = @_;
415 if ( !FileHandle::Fmode::is_W( $self->_fh ) ) {
416 $self->_throw_error( 'Cannot write to a readonly filehandle' );
420 # Request exclusive lock for writing
422 $self->lock( LOCK_EX );
424 # User may be storing a complex value, in which case we do not want it run
425 # through the filtering system.
426 if ( !ref($value) && $self->_storage->{filter_store_value} ) {
427 $value = $self->_storage->{filter_store_value}->( $value );
430 $self->_engine->write_value( $self, $key, $value);
439 # Fetch single value or element given plain key or array index
441 my $self = shift->_get_self;
445 # Request shared lock for reading
447 $self->lock( LOCK_SH );
449 my $result = $self->_engine->read_value( $self, $key);
453 # Filters only apply to scalar values, so the ref check is making
454 # sure the fetched bucket is a scalar, not a child hash or array.
455 return ($result && !ref($result) && $self->_storage->{filter_fetch_value})
456 ? $self->_storage->{filter_fetch_value}->($result)
462 # Delete single key/value pair or element given plain key or array index
464 my $self = shift->_get_self;
467 if ( !FileHandle::Fmode::is_W( $self->_fh ) ) {
468 $self->_throw_error( 'Cannot write to a readonly filehandle' );
472 # Request exclusive lock for writing
474 $self->lock( LOCK_EX );
479 my $value = $self->_engine->delete_key( $self, $key);
481 if (defined $value && !ref($value) && $self->_storage->{filter_fetch_value}) {
482 $value = $self->_storage->{filter_fetch_value}->($value);
492 # Check if a single key or element exists given plain key or array index
494 my $self = shift->_get_self;
498 # Request shared lock for reading
500 $self->lock( LOCK_SH );
502 my $result = $self->_engine->key_exists( $self, $key );
511 # Clear all keys from hash, or all elements from array.
513 my $self = shift->_get_self;
515 if ( !FileHandle::Fmode::is_W( $self->_fh ) ) {
516 $self->_throw_error( 'Cannot write to a readonly filehandle' );
520 # Request exclusive lock for writing
522 $self->lock( LOCK_EX );
524 #XXX Rewrite this dreck to do it in the engine as a tight loop vs.
525 # iterating over keys - such a WASTE - is this required for transactional
526 # clearning?! Surely that can be detected in the engine ...
527 if ( $self->_type eq TYPE_HASH ) {
528 my $key = $self->first_key;
530 # Retrieve the key before deleting because we depend on next_key
531 my $next_key = $self->next_key( $key );
532 $self->_engine->delete_key( $self, $key, $key );
537 my $size = $self->FETCHSIZE;
538 for my $key ( 0 .. $size - 1 ) {
539 $self->_engine->delete_key( $self, $key, $key );
541 $self->STORESIZE( 0 );
550 # Public method aliases
552 sub put { (shift)->STORE( @_ ) }
553 sub store { (shift)->STORE( @_ ) }
554 sub get { (shift)->FETCH( @_ ) }
555 sub fetch { (shift)->FETCH( @_ ) }
556 sub delete { (shift)->DELETE( @_ ) }
557 sub exists { (shift)->EXISTS( @_ ) }
558 sub clear { (shift)->CLEAR( @_ ) }
560 sub _dump_file {shift->_get_self->_engine->_dump_file;}