6 use warnings FATAL => 'all';
8 our $VERSION = q(1.0015);
12 use DBM::Deep::Engine::DBI ();
13 use DBM::Deep::Engine::File ();
15 use DBM::Deep::SQL::Util;
16 use DBM::Deep::SQL::Array;
17 use DBM::Deep::SQL::Hash;
20 '""' => sub { overload::StrVal( $_[0] ) },
23 use constant DEBUG => 0;
25 sub TYPE_HASH () { DBM::Deep::Engine->SIG_HASH }
26 sub TYPE_ARRAY () { DBM::Deep::Engine->SIG_ARRAY }
28 # This is used in all the children of this class in their TIE<type> methods.
35 $proto->_throw_error( "Odd number of parameters to " . (caller(1))[2] );
40 unless ( eval { local $SIG{'__DIE__'}; %{$_[0]} || 1 } ) {
41 $proto->_throw_error( "Not a hashref in args to " . (caller(1))[2] );
46 $args = { file => shift };
52 # Class constructor method for Perl OO interface.
53 # Calls tie() and returns blessed reference to tied hash or array,
54 # providing a hybrid OO/tie interface.
57 my $args = $class->_get_args( @_ );
61 if (exists $args->{dbi}) {
63 require DBIx::Abstract;
65 __PACKAGE__->_throw_error('DBIx::Abstract not installed. You cannot use the SQL mode.');
67 unless (UNIVERSAL::isa($args->{dbi}, 'DBIx::Abstract')) {
68 $args->{dbi} = DBIx::Abstract->connect($args->{dbi});
71 if (defined $args->{id}) {
72 unless ($args->{id} =~ /^\d+$/ && $args->{id} > 0) {
73 __PACKAGE__->_throw_error('Invalid SQL record id');
75 my $util = {dbi => $args->{dbi}};
76 bless $util, 'DBM::Deep::SQL::Util';
77 my $q = $util->_select(
79 fields => 'item_type',
80 where => {id => $args->{id}},
82 if ($q->[0]->[0] eq 'array') {
83 $args->{type} = TYPE_ARRAY;
85 elsif ($q->[0]->[0] eq 'hash') {
86 $args->{type} = TYPE_HASH;
89 DBM::Deep->_throw_error('Unknown SQL record id');
93 my $util = {dbi => $args->{dbi}};
94 bless $util, 'DBM::Deep::SQL::Util';
95 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
96 $args->{id} = $util->_create('array');
99 $args->{id} = $util->_create('hash');
103 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
104 $class = 'DBM::Deep::SQL::Array';
105 require DBM::Deep::SQL::Array;
106 tie @$self, $class, %$args;
107 if ($args->{prefetch}) {
108 (tied(@$self))->_prefetch();
110 return bless $self, $class;
113 $class = 'DBM::Deep::SQL::Hash';
114 require DBM::Deep::SQL::Hash;
115 tie %$self, $class, %$args;
116 if ($args->{prefetch}) {
117 (tied(%$self))->_prefetch();
119 return bless $self, $class;
125 # Check if we want a tied hash or array.
127 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
128 $class = 'DBM::Deep::Array';
129 require DBM::Deep::Array;
130 tie @$self, $class, %$args;
133 $class = 'DBM::Deep::Hash';
134 require DBM::Deep::Hash;
135 tie %$self, $class, %$args;
138 return bless $self, $class;
141 # This initializer is called from the various TIE* methods. new() calls tie(),
142 # which allows for a single point of entry.
147 # locking implicitly enables autoflush
148 if ($args->{locking}) { $args->{autoflush} = 1; }
150 # These are the defaults to be optionally overridden below
153 base_offset => undef,
158 unless ( exists $args->{engine} ) {
159 my $class = exists $args->{dbi}
160 ? 'DBM::Deep::Engine::DBI'
161 : 'DBM::Deep::Engine::File';
163 $args->{engine} = $class->new({
169 # Grab the parameters we want to use
170 foreach my $param ( keys %$self ) {
171 next unless exists $args->{$param};
172 $self->{$param} = $args->{$param};
176 local $SIG{'__DIE__'};
178 $self->lock_exclusive;
179 $self->_engine->setup( $self );
183 eval { local $SIG{'__DIE__'}; $self->unlock; };
192 require DBM::Deep::Hash;
193 return DBM::Deep::Hash->TIEHASH( @_ );
198 require DBM::Deep::Array;
199 return DBM::Deep::Array->TIEARRAY( @_ );
203 my $self = shift->_get_self;
204 return $self->_engine->lock_exclusive( $self, @_ );
206 *lock = \&lock_exclusive;
208 my $self = shift->_get_self;
209 return $self->_engine->lock_shared( $self, @_ );
213 my $self = shift->_get_self;
214 return $self->_engine->unlock( $self, @_ );
218 my $self = shift->_get_self;
219 my ($spot, $value) = @_;
225 my $r = Scalar::Util::reftype( $value );
227 if ( $r eq 'ARRAY' ) {
228 $tied = tied(@$value);
230 elsif ( $r eq 'HASH' ) {
231 $tied = tied(%$value);
234 __PACKAGE__->_throw_error( "Unknown type for '$value'" );
237 if ( eval { local $SIG{__DIE__}; $tied->isa( __PACKAGE__ ) } ) {
238 ${$spot} = $tied->_repr;
239 $tied->_copy_node( ${$spot} );
242 if ( $r eq 'ARRAY' ) {
243 ${$spot} = [ @{$value} ];
246 ${$spot} = { %{$value} };
250 my $c = Scalar::Util::blessed( $value );
251 if ( defined $c && !$c->isa( __PACKAGE__ ) ) {
252 ${$spot} = bless ${$spot}, $c
260 # die "Must be implemented in a child class\n";
264 # die "Must be implemented in a child class\n";
268 my $self = shift->_get_self;
270 my $temp = $self->_repr;
272 $self->lock_exclusive;
273 $self->_copy_node( $temp );
276 my $classname = $self->_engine->get_classname( $self );
277 if ( defined $classname ) {
278 bless $temp, $classname;
284 sub _check_legality {
288 my $r = Scalar::Util::reftype( $val );
290 return $r if !defined $r || '' eq $r;
291 return $r if 'HASH' eq $r;
292 return $r if 'ARRAY' eq $r;
294 __PACKAGE__->_throw_error(
295 "Storage of references of type '$r' is not supported."
300 return if !ref $_[0]; # Perl calls import() on use -- ignore
302 my $self = shift->_get_self;
305 my $type = $self->_check_legality( $struct );
307 __PACKAGE__->_throw_error( "Cannot import a scalar" );
310 if ( substr( $type, 0, 1 ) ne $self->_type ) {
311 __PACKAGE__->_throw_error(
312 "Cannot import " . ('HASH' eq $type ? 'a hash' : 'an array')
313 . " into " . ('HASH' eq $type ? 'an array' : 'a hash')
322 my $obj = 'HASH' eq Scalar::Util::reftype( $db ) ? tied(%$db) : tied(@$db);
325 my $r = $self->_check_legality( $val );
326 if ( 'HASH' eq $r ) {
327 while ( my ($k, $v) = each %$val ) {
328 my $r = $self->_check_legality( $v );
330 my $temp = 'HASH' eq $r ? {} : [];
331 if ( my $c = Scalar::Util::blessed( $v ) ) {
334 $obj->put( $k, $temp );
335 $recurse->( $temp, $v );
342 elsif ( 'ARRAY' eq $r ) {
343 foreach my $k ( 0 .. $#$val ) {
345 my $r = $self->_check_legality( $v );
347 my $temp = 'HASH' eq $r ? {} : [];
348 if ( my $c = Scalar::Util::blessed( $v ) ) {
351 $obj->put( $k, $temp );
352 $recurse->( $temp, $v );
360 $recurse->( $self, $struct );
365 #XXX Need to keep track of who has a fh to this file in order to
366 #XXX close them all prior to optimize on Win32/cygwin
367 # Rebuild entire database into new file, then move
368 # it back on top of original.
370 my $self = shift->_get_self;
372 # Optimizing is only something we need to do when we're working with our
373 # own file format. Otherwise, let the other guy do the optimizations.
374 return unless $self->_engine->isa( 'DBM::Deep::Engine::File' );
376 #XXX Need to create a new test for this
377 # if ($self->_engine->storage->{links} > 1) {
378 # $self->_throw_error("Cannot optimize: reference count is greater than 1");
381 #XXX Do we have to lock the tempfile?
383 #XXX Should we use tempfile() here instead of a hard-coded name?
384 my $temp_filename = $self->_engine->storage->{file} . '.tmp';
385 my $db_temp = __PACKAGE__->new(
386 file => $temp_filename,
387 type => $self->_type,
389 # Bring over all the parameters that we need to bring over
390 ( map { $_ => $self->_engine->$_ } qw(
391 byte_size max_buckets data_sector_size num_txns
395 $self->lock_exclusive;
396 $self->_engine->clear_cache;
397 $self->_copy_node( $db_temp );
398 $db_temp->_engine->storage->close;
402 # Attempt to copy user, group and permissions over to new file
404 $self->_engine->storage->copy_stats( $temp_filename );
406 # q.v. perlport for more information on this variable
407 if ( $^O eq 'MSWin32' || $^O eq 'cygwin' ) {
409 # Potential race condition when optmizing on Win32 with locking.
410 # The Windows filesystem requires that the filehandle be closed
411 # before it is overwritten with rename(). This could be redone
415 $self->_engine->storage->close;
418 if (!rename $temp_filename, $self->_engine->storage->{file}) {
419 unlink $temp_filename;
421 $self->_throw_error("Optimize failed: Cannot copy temp file over original: $!");
425 $self->_engine->storage->close;
427 $self->_engine->storage->open;
428 $self->lock_exclusive;
429 $self->_engine->setup( $self );
437 # Make copy of object and return
439 my $self = shift->_get_self;
441 return __PACKAGE__->new(
442 type => $self->_type,
443 base_offset => $self->_base_offset,
444 staleness => $self->_staleness,
445 engine => $self->_engine,
449 #XXX Migrate this to the engine, where it really belongs and go through some
450 # API - stop poking in the innards of someone else..
452 my %is_legal_filter = map {
455 store_key store_value
456 fetch_key fetch_value
460 my $self = shift->_get_self;
464 if ( $is_legal_filter{$type} ) {
465 $self->_engine->storage->{"filter_$type"} = $func;
472 sub filter_store_key { $_[0]->set_filter( store_key => $_[1] ); }
473 sub filter_store_value { $_[0]->set_filter( store_value => $_[1] ); }
474 sub filter_fetch_key { $_[0]->set_filter( fetch_key => $_[1] ); }
475 sub filter_fetch_value { $_[0]->set_filter( fetch_value => $_[1] ); }
479 my $self = shift->_get_self;
480 $self->lock_exclusive;
481 my $rv = eval { $self->_engine->begin_work( $self, @_ ) };
489 my $self = shift->_get_self;
490 $self->lock_exclusive;
491 my $rv = eval { $self->_engine->rollback( $self, @_ ) };
499 my $self = shift->_get_self;
500 $self->lock_exclusive;
501 my $rv = eval { $self->_engine->commit( $self, @_ ) };
510 my $self = $_[0]->_get_self;
511 return $self->{engine};
515 my $self = $_[0]->_get_self;
516 return $self->{type};
520 my $self = $_[0]->_get_self;
521 return $self->{base_offset};
525 my $self = $_[0]->_get_self;
526 return $self->{staleness};
533 my @caller = caller( ++$n );
534 next if $caller[0] =~ m/^DBM::Deep/;
536 die "DBM::Deep: $_[1] at $0 line $caller[2]\n";
540 # Store single hash key/value or array element in database.
542 my $self = shift->_get_self;
543 my ($key, $value) = @_;
544 warn "STORE($self, '$key', '@{[defined$value?$value:'undef']}')\n" if DEBUG;
546 unless ( $self->_engine->storage->is_writable ) {
547 $self->_throw_error( 'Cannot write to a readonly filehandle' );
550 $self->lock_exclusive;
552 # User may be storing a complex value, in which case we do not want it run
553 # through the filtering system.
554 if ( !ref($value) && $self->_engine->storage->{filter_store_value} ) {
555 $value = $self->_engine->storage->{filter_store_value}->( $value );
558 $self->_engine->write_value( $self, $key, $value );
565 # Fetch single value or element given plain key or array index
567 my $self = shift->_get_self;
569 warn "FETCH($self, '$key')\n" if DEBUG;
573 my $result = $self->_engine->read_value( $self, $key );
577 # Filters only apply to scalar values, so the ref check is making
578 # sure the fetched bucket is a scalar, not a child hash or array.
579 return ($result && !ref($result) && $self->_engine->storage->{filter_fetch_value})
580 ? $self->_engine->storage->{filter_fetch_value}->($result)
584 # Delete single key/value pair or element given plain key or array index
586 my $self = shift->_get_self;
588 warn "DELETE($self, '$key')\n" if DEBUG;
590 unless ( $self->_engine->storage->is_writable ) {
591 $self->_throw_error( 'Cannot write to a readonly filehandle' );
594 $self->lock_exclusive;
599 my $value = $self->_engine->delete_key( $self, $key);
601 if (defined $value && !ref($value) && $self->_engine->storage->{filter_fetch_value}) {
602 $value = $self->_engine->storage->{filter_fetch_value}->($value);
610 # Check if a single key or element exists given plain key or array index
612 my $self = shift->_get_self;
614 warn "EXISTS($self, '$key')\n" if DEBUG;
618 my $result = $self->_engine->key_exists( $self, $key );
625 # Clear all keys from hash, or all elements from array.
627 my $self = shift->_get_self;
628 warn "CLEAR($self)\n" if DEBUG;
630 unless ( $self->_engine->storage->is_writable ) {
631 $self->_throw_error( 'Cannot write to a readonly filehandle' );
634 $self->lock_exclusive;
636 #XXX Rewrite this dreck to do it in the engine as a tight loop vs.
637 # iterating over keys - such a WASTE - is this required for transactional
638 # clearning?! Surely that can be detected in the engine ...
639 if ( $self->_type eq TYPE_HASH ) {
640 my $key = $self->first_key;
642 # Retrieve the key before deleting because we depend on next_key
643 my $next_key = $self->next_key( $key );
644 $self->_engine->delete_key( $self, $key, $key );
649 my $size = $self->FETCHSIZE;
650 for my $key ( 0 .. $size - 1 ) {
651 $self->_engine->delete_key( $self, $key, $key );
653 $self->STORESIZE( 0 );
661 # Public method aliases
662 sub put { (shift)->STORE( @_ ) }
663 sub get { (shift)->FETCH( @_ ) }
664 sub store { (shift)->STORE( @_ ) }
665 sub fetch { (shift)->FETCH( @_ ) }
666 sub delete { (shift)->DELETE( @_ ) }
667 sub exists { (shift)->EXISTS( @_ ) }
668 sub clear { (shift)->CLEAR( @_ ) }
670 sub _dump_file {shift->_get_self->_engine->_dump_file;}