libs/Data/Storage.pm

## ------------------------------------------------------------------------
##
##    $Id: Storage.pm,v 1.17 2003/01/30 21:42:22 joko Exp $
##
##    Copyright (c) 2002  Andreas Motl <andreas.motl@ilo.de>
##
##    See COPYRIGHT section in pod text below for usage and distribution rights.
##
## ------------------------------------------------------------------------
##
##  $Log: Storage.pm,v $
##  Revision 1.17  2003/01/30 21:42:22  joko
##  + minor update: renamed method
##
##  Revision 1.16  2003/01/20 16:52:13  joko
##  + now using 'DesignPattern::Object' to create a new 'Data::Storage::Handler::Xyz' on demand - before we did this in a hand-rolled fashion
##
##  Revision 1.15  2003/01/19 03:12:59  joko
##  + modified header
##  - removed pod-documentation - now in 'Storage.pod'
##
##  Revision 1.14  2002/12/19 16:27:59  joko
##  - moved 'sub dropDb' to Data::Storage::Handler::DBI
##
##  Revision 1.13  2002/12/17 21:54:12  joko
##  + feature when using Tangram:
##    + what? each object created should delivered with a globally(!?) unique identifier (GUID) besides the native tangram object id (OID)
##        + patched Tangram::Storage (jonen)
##        + enhanced Data::Storage::Schema::Tangram (joko)
##        + enhanced Data::Storage::Handler::Tangram 'sub getObjectByGuid' (jonen)
##    + how?
##        + each concrete (non-abstract) class gets injected with an additional field/property called 'guid' - this is done (dynamically) on schema level
##        + this property ('guid') gets filled on object creation/insertion from 'sub Tangram::Storage::_insert' using Data::UUID from CPAN
##        + (as for now) this property can get accessed by calling 'getObjectByGuid' on the already known storage-handle used throughout the application
##
##  Revision 1.12  2002/12/12 02:50:15  joko
##  + this now (unfortunately) needs DBI for some helper functions
##  + TODO: these have to be refactored to another scope! (soon!)
##
##  Revision 1.11  2002/12/11 06:53:19  joko
##  + updated pod
##
##  Revision 1.10  2002/12/07 03:37:23  joko
##  + updated pod
##
##  Revision 1.9  2002/12/01 22:15:45  joko
##  - sub createDb: moved to handler
##
##  Revision 1.8  2002/11/29 04:48:23  joko
##  + updated pod
##
##  Revision 1.7  2002/11/17 06:07:18  joko
##  + creating the handler is easier than proposed first - for now :-)
##  + sub testAvailability
##
##  Revision 1.6  2002/11/09 01:04:58  joko
##  + updated pod
##
##  Revision 1.5  2002/10/29 19:24:18  joko
##  - reduced logging
##  + added some pod
##
##  Revision 1.4  2002/10/27 18:35:07  joko
##  + added pod
##
##  Revision 1.3  2002/10/25 11:40:37  joko
##  + enhanced robustness
##  + more logging for debug-levels
##  + sub dropDb
##
##  Revision 1.2  2002/10/17 00:04:29  joko
##  + sub createDb
##  + sub isConnected
##  + bugfixes regarding "deep recursion" stuff
##
##  Revision 1.1  2002/10/10 03:43:12  cvsjoko
##  + new
## ------------------------------------------------------------------------


BEGIN {
  $Data::Storage::VERSION = 0.03;
}

package Data::Storage;

use strict;
use warnings;

use Data::Dumper;
# FIXME: wipe out!
use DBI;

use Data::Storage::Locator;
use DesignPattern::Object;


# TODO: actually implement level (integrate with Log::Dispatch)
my $TRACELEVEL = 0;

# get logger instance
my $logger = Log::Dispatch::Config->instance;

sub new {
  my $invocant = shift;
  my $class = ref($invocant) || $invocant;
  #my @args = normalizeArgs(@_);

  my $arg_locator = shift;
  my $arg_options = shift;

  if (!$arg_locator) {
    $logger->critical( __PACKAGE__ . "->new: No locator passed in!" );
    return;
  }

  #my $self = { STORAGEHANDLE => undef, @_ };
  my $self = { STORAGEHANDLE => undef, locator => $arg_locator, options => $arg_options };
  #$logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->new(@_)" );
  $logger->debug( __PACKAGE__ . "[$arg_locator->{type}]" . "->new(@_)" );
  return bless $self, $class;
}

sub AUTOLOAD {
  
  # since this is a core function acting as dispatcher to $self->{STORAGEHANDLE},
  # some sophisticated handling and filtering is needed to avoid things like
  #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"
  #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"
  #     - Deep recursion on anonymous subroutine at [...]
  # we also might filter log messages caused by logging to itself in "advanced logging of AUTOLOAD calls"
  
  my $self = shift;
  our $AUTOLOAD;
  
  # ->DESTROY would - if not declared - trigger an AUTOLOAD also
  return if $AUTOLOAD =~ m/::DESTROY$/;

  my $method = $AUTOLOAD;
  $method =~ s/^.*:://;

  # advanced logging of AUTOLOAD calls ...
  # ... nice but do it only when TRACING (TODO) is enabled
      my $logstring = "";
      $logstring .= __PACKAGE__ . "[$self->{locator}->{type}]" . "->" . $method;
      #print "count: ", $#_, "\n";
      #$logstring .= Dumper(@_) if ($#_ != -1);
      my $tabcount = int( (80 - length($logstring)) / 10 );
      $logstring .= "\t" x $tabcount . "(AUTOLOAD)";
      # TODO: only ok if logstring doesn't contain 
      #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"
      # but that would be _way_ too specific as long as we don't have an abstract handler for this  ;)
    if ($TRACELEVEL) {
      $logger->debug( $logstring );
      #print join('; ', @_);
    }
    
  # filtering AUTOLOAD calls and first-time-touch of the actual storage impl
  if ($self->_filter_AUTOLOAD($method)) {
    #print "=== FILTER!", "\n";
    $self->_accessStorageHandle();
    if ($self->{STORAGEHANDLE}) {
      return $self->{STORAGEHANDLE}->$method(@_);
    } else {
      $logger->critical( __PACKAGE__ . "->AUTOLOAD: ERROR: " . $logstring );
      return;
    }
  }
  
}

sub _filter_AUTOLOAD {
  my $self = shift;
  my $method = shift;
  if ($self->{options}->{protected}) {
    if ($method eq 'disconnect') {
      return;
    }
  }
  return 1;
}


sub _accessStorageHandle {
  my $self = shift;
  # TODO: to some tracelevel!
  #print "=========== _accessStorage", "\n";
  if ($TRACELEVEL) {
    $logger->debug( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->_accessStorageHandle()" );
  }
  if (!$self->{STORAGEHANDLE}) {
    return $self->_createStorageHandle();
  }
}

sub _createStorageHandle1 {
  my $self = shift;
  my $type = $self->{locator}->{type};
  $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );

  my $pkg = "Data::Storage::Handler::" . $type . "";
  
  # try to load perl module at runtime
  my $evalstr = "use $pkg;";
  eval($evalstr);
  if ($@) {
    $logger->error( __PACKAGE__ .  "[$type]" . "->_createStorageHandle(): $@" );
    return;
  }
  
  # build up some additional arguments to pass on
  #my @args = %{$self->{locator}};
  my @args = ();

  # - create new storage handle object
  # - propagate arguments to handler
  # - pass locator by reference to be able to store status- or meta-information in it
  $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );

}

sub _createStorageHandle {
  my $self = shift;
  my $type = $self->{locator}->{type};
  $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );

#print Dumper($self);
#exit;

  my $pkg = "Data::Storage::Handler::" . $type . "";
  
  # try to load perl module at runtime
=pod
  my $evalstr = "use $pkg;";
  eval($evalstr);
  if ($@) {
    $logger->error( __PACKAGE__ .  "[$type]" . "->_createStorageHandle(): $@" );
    return;
  }
  
  # build up some additional arguments to pass on
  #my @args = %{$self->{locator}};
  my @args = ();

  # - create new storage handle object
  # - propagate arguments to handler
  # - pass locator by reference to be able to store status- or meta-information in it
  $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
=cut

  $self->{STORAGEHANDLE} = DesignPattern::Object->fromPackage( $pkg, locator => $self->{locator} );
  return 1;

}

sub addLogDispatchHandler {

      my $self = shift;
      my $name = shift;
      my $package = shift;
      my $logger1 = shift;
      my $objectCreator = shift;
      
      #$logger->add( Log::Dispatch::Tangram->new( name => $name,
      $logger->add( $package->new( name => $name,
                                            #min_level => 'debug',
                                            min_level => 'info',
                                            storage => $self,
                                            objectCreator => $objectCreator,
                                            fields => {
                                              message => 'usermsg',
                                              timestamp => 'stamp',
                                              level => 'level',
                                              name => 'code',
                                            },
                                            filter_patterns => [ '->insert\(SystemEvent=' ],
                                            #filter_patterns => [ 'SystemEvent' ],
                                            
                                            #format  => '[%d] [%p] %m%n',
                                             ) );

}

sub removeLogDispatchHandler {
  my $self = shift;
  my $name = shift;
  #my $logger = shift;
  $logger->remove($name);
}


1;
__END__
1	joko	1.15	## ------------------------------------------------------------------------
2			##
3	joko	1.18	## $Id: Storage.pm,v 1.17 2003/01/30 21:42:22 joko Exp $
4	joko	1.15	##
5			## Copyright (c) 2002 Andreas Motl <andreas.motl@ilo.de>
6			##
7			## See COPYRIGHT section in pod text below for usage and distribution rights.
8			##
9			## ------------------------------------------------------------------------
10			##
11			## $Log: Storage.pm,v $
12	joko	1.18	## Revision 1.17 2003/01/30 21:42:22 joko
13			## + minor update: renamed method
14			##
15	joko	1.17	## Revision 1.16 2003/01/20 16:52:13 joko
16			## + now using 'DesignPattern::Object' to create a new 'Data::Storage::Handler::Xyz' on demand - before we did this in a hand-rolled fashion
17			##
18	joko	1.16	## Revision 1.15 2003/01/19 03:12:59 joko
19			## + modified header
20			## - removed pod-documentation - now in 'Storage.pod'
21			##
22	joko	1.15	## Revision 1.14 2002/12/19 16:27:59 joko
23			## - moved 'sub dropDb' to Data::Storage::Handler::DBI
24			##
25			## Revision 1.13 2002/12/17 21:54:12 joko
26			## + feature when using Tangram:
27			## + what? each object created should delivered with a globally(!?) unique identifier (GUID) besides the native tangram object id (OID)
28			## + patched Tangram::Storage (jonen)
29			## + enhanced Data::Storage::Schema::Tangram (joko)
30			## + enhanced Data::Storage::Handler::Tangram 'sub getObjectByGuid' (jonen)
31			## + how?
32			## + each concrete (non-abstract) class gets injected with an additional field/property called 'guid' - this is done (dynamically) on schema level
33			## + this property ('guid') gets filled on object creation/insertion from 'sub Tangram::Storage::_insert' using Data::UUID from CPAN
34			## + (as for now) this property can get accessed by calling 'getObjectByGuid' on the already known storage-handle used throughout the application
35			##
36			## Revision 1.12 2002/12/12 02:50:15 joko
37			## + this now (unfortunately) needs DBI for some helper functions
38			## + TODO: these have to be refactored to another scope! (soon!)
39			##
40			## Revision 1.11 2002/12/11 06:53:19 joko
41			## + updated pod
42			##
43			## Revision 1.10 2002/12/07 03:37:23 joko
44			## + updated pod
45			##
46			## Revision 1.9 2002/12/01 22:15:45 joko
47			## - sub createDb: moved to handler
48			##
49			## Revision 1.8 2002/11/29 04:48:23 joko
50			## + updated pod
51			##
52			## Revision 1.7 2002/11/17 06:07:18 joko
53			## + creating the handler is easier than proposed first - for now :-)
54			## + sub testAvailability
55			##
56			## Revision 1.6 2002/11/09 01:04:58 joko
57			## + updated pod
58			##
59			## Revision 1.5 2002/10/29 19:24:18 joko
60			## - reduced logging
61			## + added some pod
62			##
63			## Revision 1.4 2002/10/27 18:35:07 joko
64			## + added pod
65			##
66			## Revision 1.3 2002/10/25 11:40:37 joko
67			## + enhanced robustness
68			## + more logging for debug-levels
69			## + sub dropDb
70			##
71			## Revision 1.2 2002/10/17 00:04:29 joko
72			## + sub createDb
73			## + sub isConnected
74			## + bugfixes regarding "deep recursion" stuff
75			##
76			## Revision 1.1 2002/10/10 03:43:12 cvsjoko
77			## + new
78			## ------------------------------------------------------------------------
79	cvsjoko	1.1
80	joko	1.3
81	joko	1.4	BEGIN {
82	joko	1.15	$Data::Storage::VERSION = 0.03;
83	joko	1.4	}
84
85	cvsjoko	1.1	package Data::Storage;
86
87			use strict;
88			use warnings;
89
90	joko	1.16	use Data::Dumper;
91			# FIXME: wipe out!
92			use DBI;
93
94	cvsjoko	1.1	use Data::Storage::Locator;
95	joko	1.16	use DesignPattern::Object;
96	cvsjoko	1.1
97	joko	1.12
98	joko	1.6	# TODO: actually implement level (integrate with Log::Dispatch)
99	joko	1.5	my $TRACELEVEL = 0;
100
101	cvsjoko	1.1	# get logger instance
102			my $logger = Log::Dispatch::Config->instance;
103
104			sub new {
105			my $invocant = shift;
106			my $class = ref($invocant) \|\| $invocant;
107			#my @args = normalizeArgs(@_);
108	joko	1.7
109	cvsjoko	1.1	my $arg_locator = shift;
110			my $arg_options = shift;
111	joko	1.7
112	joko	1.15	if (!$arg_locator) {
113			$logger->critical( __PACKAGE__ . "->new: No locator passed in!" );
114			return;
115			}
116
117	cvsjoko	1.1	#my $self = { STORAGEHANDLE => undef, @_ };
118			my $self = { STORAGEHANDLE => undef, locator => $arg_locator, options => $arg_options };
119	joko	1.7	#$logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->new(@_)" );
120			$logger->debug( __PACKAGE__ . "[$arg_locator->{type}]" . "->new(@_)" );
121	cvsjoko	1.1	return bless $self, $class;
122			}
123
124			sub AUTOLOAD {
125
126	joko	1.2	# since this is a core function acting as dispatcher to $self->{STORAGEHANDLE},
127			# some sophisticated handling and filtering is needed to avoid things like
128			# - Deep recursion on subroutine "Data::Storage::AUTOLOAD"
129			# - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"
130			# - Deep recursion on anonymous subroutine at [...]
131	joko	1.8	# we also might filter log messages caused by logging to itself in "advanced logging of AUTOLOAD calls"
132	joko	1.2
133	cvsjoko	1.1	my $self = shift;
134			our $AUTOLOAD;
135
136			# ->DESTROY would - if not declared - trigger an AUTOLOAD also
137			return if $AUTOLOAD =~ m/::DESTROY$/;
138
139			my $method = $AUTOLOAD;
140			$method =~ s/^.*:://;
141
142	joko	1.5	# advanced logging of AUTOLOAD calls ...
143			# ... nice but do it only when TRACING (TODO) is enabled
144			my $logstring = "";
145			$logstring .= __PACKAGE__ . "[$self->{locator}->{type}]" . "->" . $method;
146			#print "count: ", $#_, "\n";
147			#$logstring .= Dumper(@_) if ($#_ != -1);
148			my $tabcount = int( (80 - length($logstring)) / 10 );
149			$logstring .= "\t" x $tabcount . "(AUTOLOAD)";
150			# TODO: only ok if logstring doesn't contain
151			# e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c)) (AUTOLOAD)"
152	joko	1.8	# but that would be _way_ too specific as long as we don't have an abstract handler for this ;)
153	joko	1.16	if ($TRACELEVEL) {
154	joko	1.5	$logger->debug( $logstring );
155	joko	1.7	#print join('; ', @_);
156	joko	1.5	}
157
158	joko	1.8	# filtering AUTOLOAD calls and first-time-touch of the actual storage impl
159	cvsjoko	1.1	if ($self->_filter_AUTOLOAD($method)) {
160	joko	1.17	#print "=== FILTER!", "\n";
161			$self->_accessStorageHandle();
162	joko	1.16	if ($self->{STORAGEHANDLE}) {
163			return $self->{STORAGEHANDLE}->$method(@_);
164			} else {
165			$logger->critical( __PACKAGE__ . "->AUTOLOAD: ERROR: " . $logstring );
166			return;
167			}
168	cvsjoko	1.1	}
169
170			}
171
172			sub _filter_AUTOLOAD {
173			my $self = shift;
174			my $method = shift;
175			if ($self->{options}->{protected}) {
176			if ($method eq 'disconnect') {
177			return;
178			}
179			}
180			return 1;
181			}
182
183
184	joko	1.17	sub _accessStorageHandle {
185	cvsjoko	1.1	my $self = shift;
186			# TODO: to some tracelevel!
187	joko	1.17	#print "=========== _accessStorage", "\n";
188	joko	1.5	if ($TRACELEVEL) {
189	joko	1.17	$logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->_accessStorageHandle()" );
190	joko	1.5	}
191	cvsjoko	1.1	if (!$self->{STORAGEHANDLE}) {
192	joko	1.16	return $self->_createStorageHandle();
193			}
194			}
195
196			sub _createStorageHandle1 {
197			my $self = shift;
198			my $type = $self->{locator}->{type};
199			$logger->debug( __PACKAGE__ . "[$type]" . "->_createStorageHandle()" );
200
201			my $pkg = "Data::Storage::Handler::" . $type . "";
202
203			# try to load perl module at runtime
204			my $evalstr = "use $pkg;";
205			eval($evalstr);
206			if ($@) {
207			$logger->error( __PACKAGE__ . "[$type]" . "->_createStorageHandle(): $@" );
208			return;
209	cvsjoko	1.1	}
210	joko	1.16
211			# build up some additional arguments to pass on
212			#my @args = %{$self->{locator}};
213			my @args = ();
214
215			# - create new storage handle object
216			# - propagate arguments to handler
217			# - pass locator by reference to be able to store status- or meta-information in it
218			$self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
219
220	cvsjoko	1.1	}
221
222			sub _createStorageHandle {
223			my $self = shift;
224			my $type = $self->{locator}->{type};
225			$logger->debug( __PACKAGE__ . "[$type]" . "->_createStorageHandle()" );
226
227	joko	1.16	#print Dumper($self);
228			#exit;
229
230	cvsjoko	1.1	my $pkg = "Data::Storage::Handler::" . $type . "";
231
232	joko	1.7	# try to load perl module at runtime
233	joko	1.16	=pod
234	joko	1.7	my $evalstr = "use $pkg;";
235			eval($evalstr);
236			if ($@) {
237			$logger->error( __PACKAGE__ . "[$type]" . "->_createStorageHandle(): $@" );
238			return;
239	cvsjoko	1.1	}
240	joko	1.7
241			# build up some additional arguments to pass on
242			#my @args = %{$self->{locator}};
243			my @args = ();
244
245	joko	1.8	# - create new storage handle object
246			# - propagate arguments to handler
247			# - pass locator by reference to be able to store status- or meta-information in it
248	joko	1.7	$self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
249	joko	1.16	=cut
250
251			$self->{STORAGEHANDLE} = DesignPattern::Object->fromPackage( $pkg, locator => $self->{locator} );
252			return 1;
253	joko	1.3
254	cvsjoko	1.1	}
255
256			sub addLogDispatchHandler {
257
258			my $self = shift;
259			my $name = shift;
260			my $package = shift;
261	joko	1.3	my $logger1 = shift;
262	cvsjoko	1.1	my $objectCreator = shift;
263
264			#$logger->add( Log::Dispatch::Tangram->new( name => $name,
265			$logger->add( $package->new( name => $name,
266			#min_level => 'debug',
267			min_level => 'info',
268			storage => $self,
269			objectCreator => $objectCreator,
270			fields => {
271			message => 'usermsg',
272			timestamp => 'stamp',
273			level => 'level',
274			name => 'code',
275			},
276			filter_patterns => [ '->insert\(SystemEvent=' ],
277			#filter_patterns => [ 'SystemEvent' ],
278
279			#format => '[%d] [%p] %m%n',
280			) );
281
282			}
283
284			sub removeLogDispatchHandler {
285	joko	1.8	my $self = shift;
286			my $name = shift;
287			#my $logger = shift;
288			$logger->remove($name);
289	cvsjoko	1.1	}
290
291
292	joko	1.4	1;
293			__END__
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26