Data/Storage/Container.pm

################################################
#
#  $Id: Container.pm,v 1.9 2003/03/27 15:31:08 joko Exp $
#
#  $Log: Container.pm,v $
#  Revision 1.9  2003/03/27 15:31:08  joko
#  fixes to modules regarding new namespace(s) below Data::Mungle::*
#
#  Revision 1.8  2003/02/18 19:19:47  joko
#  + modified locator handling
#
#  Revision 1.7  2003/01/30 22:21:52  joko
#  + changed 'connect'-behaviour back to old state
#  + renamed log-output (now using 'initializing' instead of 'booting' - corresponding to 'initStorage')
#
#  Revision 1.6  2003/01/30 21:44:00  joko
#  + temporary fix: (FIXME) now connecting to storage on storagehandle-instantiation
#
#  Revision 1.5  2003/01/19 02:39:57  joko
#  + moved 'deep_copy' from module 'libp' to module 'Data.Transform.Deep'
#  + preserved order for hashes '$self->{config}' and '$self->{locator}' by using Tie::IxHash
#
#  Revision 1.4  2002/12/04 07:38:07  jonen
#  + deep copy
#
#  Revision 1.3  2002/12/01 22:18:28  joko
#  - no interactive implicit deploy
#  + only test integrity if storage available
#
#  Revision 1.2  2002/12/01 07:08:35  joko
#  + needs to "use Data::Storage;"
#
#  Revision 1.1  2002/11/29 04:54:54  joko
#  + initial check-in
#
#  Revision 1.1  2002/11/17 06:20:41  joko
#  + initial check in
#
#
################################################


package Data::Storage::Container;

use strict;
use warnings;

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


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   main
use Tie::IxHash;
use Data::Dumper;

use Data::Storage;
use Data::Storage::Locator;
use Data::Mungle::Transform::Deep qw( deep_copy );
use Data::Mungle::Compare::Struct qw( isEmpty );

sub new {
  my $invocant = shift;
  my $class = ref($invocant) || $invocant;

  # get constructor arguments
  my @args = ();
  @_ && (@args = @_);
  $logger->debug( __PACKAGE__ . "->new( @args )" );

  my $self = { @_ };
  bless $self, $class;
  
  # preserve order of configuration variables
  #$self->{config} = {};
  tie %{$self->{config}}, 'Tie::IxHash';
  tie %{$self->{locator}}, 'Tie::IxHash';
  
  return $self;
}

sub addConfig {
  my $self = shift;
  my $name = shift;
  my $config = shift;
  $self->{config}->{$name} = $config;
}

sub addConfigByDsn {
  my $self = shift;
  my $name = shift;
  my $dsn = shift;
  
  # HACK: assume DBI as default type for now
  # TODO: guess type from dsn
  my $type = "DBI";
  
  $self->addConfig($name, { type => $type, dsn => $dsn });
}

sub addStorage {
  my $self = shift;
  my $name = shift;
  my $storage = shift;
  $self->{storage}->{$name} = $storage;
}

sub existsStorage {
  my $self = shift;
  my $name = shift;
  return exists $self->{storage}->{$name};
}

sub initLocator {
  my $self = shift;
  my $name = shift;
  my $db_config = $self->{config}->{$name};
  $db_config ||= {};

  $logger->debug( __PACKAGE__ . "->initLocator( name='$name' )" );

  my $cfg_locator = {};
  
  # set default settings, if any
  my $default = deep_copy($self->{config}->{_default});
  foreach (keys %$default) {
    $cfg_locator->{$_} = $default->{$_};
  }
  
  # merge in specific settings
  my $specific = deep_copy($db_config);
  foreach (keys %$specific) {
    $cfg_locator->{$_} = $specific->{$_};
  }
  
  # HACK: transfer dsn from main to dbi settings
  $cfg_locator->{dbi}->{dsn} = $cfg_locator->{dsn} if $cfg_locator->{dsn};

  # HACK: set classnames empty if none given from config
  $cfg_locator->{classnames} = [] if !$cfg_locator->{classnames};

  # HACK: set errorhandler if dbi settings are present
  $cfg_locator->{dbi}->{HandleError} = \&_dbErrorHandler if $cfg_locator->{dbi};

  # trace
    #print "locator:", "\n";
    #print Dumper($cfg_locator);

  # check locator metadata
  if (isEmpty($cfg_locator)) {
    $logger->warning( __PACKAGE__ . "->initLocator( name='$name' ): Metadata was empty. Please check configuration." );
    return;
  }

  # name it
  $cfg_locator->{name} = $name;

  # create new locator object
  $self->{locator}->{$name} = Data::Storage::Locator->new( $cfg_locator );

}

sub initLocators {
  my $self = shift;
  foreach (keys %{$self->{config}}) {
    #print $_, "\n";
    $self->initLocator($_, $self->{config}->{$_}) if !/^_/;
  }
  #print "locs: ", Dumper($self->{locator});
}

sub getLocator {
  my $self = shift;
  my $name = shift;
  return $self->{locator}->{$name};
}

sub initStorage {
  my $self = shift;
  my $name = shift;

  return if $self->existsStorage($name);

  my $locator = $self->getLocator($name);
  $logger->info( __PACKAGE__ . " is initializing storage declared by locator \"$name\"" );

  my $storage = Data::Storage->new($locator);
  
  # TODO: do below (after 'testAvailability' and 'testIntegrity') again!!!
  #$storage->connect();

  my $log_prefix = __PACKAGE__ . "->initStorage: ";
  $log_prefix .= "dsn=\"$self->{locator}->{$name}->{dsn}\"" if $self->{locator}->{$name}->{dsn};

  # should we test availability of the storage before using it?
  if ($locator->{test_availability}) {
    $locator->{status}->{availability} = $storage->testAvailability();
    if ( !$storage->testAvailability() ) {
      $logger->error( "$log_prefix: testAvailability failed" );
    }
  }
          
  # should we test integrity of the storage before using it?
  if ($locator->{status}->{availability} && $locator->{test_integrity}) {
    #return unless $storage->testIntegrity();
    $locator->{status}->{integrity} = $storage->testIntegrity();
    # actions if integrity fails
    if (!$locator->{status}->{integrity}) {
      $logger->error( "$log_prefix: testIntegrity failed" );
    }
  }

  # try to connect...
  # TODO:
  # don't connect right here, do an implicit connect on (later) usage
  # maybe set ->{meta}->{connectmethod} = "connect" here
  #return unless $storage->connect();
  $storage->connect() if $locator->{status}->{integrity};

  # should we check emptyness?
  if ($locator->{status}->{availability} && $locator->{test_emptyness}) {
    #print "test empty", "\n";
    if ( !@{$storage->getChildNodes()} ) {
      $locator->{status}->{empty} = 1;
      $logger->warning( "$log_prefix: Storage is empty.");
      #return;
    }
  }

  # expand logging?
  if ( $locator->{status}->{integrity} && $locator->{logger} ) {
    # expand logging (to Tangram-Database)
    # TODO:
    # - move configuration data from this code to db_config somehow
    # - do complete handling of this stuff in Data::Storage::* also
    # - just leave a simple on/off-trigger here and/or 
    # - make it optionally configurable via e.g. get/set-methods
    #    to satisfy "manual"-mode instead of "config"-mode
    # - (re-)add hierarchical logging (each event may have a parent)
    no strict;
    my $creator = sub { return new SystemEvent; };
    use strict;
    $storage->addLogDispatchHandler("Tangram11", "Log::Dispatch::Tangram", $logger, $creator);
    #$storage_left->addLogDispatchHandler("Tangram11", "Log::Dispatch::Tangram", $logger);
  }

  #$self->{storage}->{$name} = $storage;
  #print "add storage: $name", "\n";
  $self->addStorage($name, $storage);

  return 1;
  
}

sub initStorages {
  my $self = shift;
  foreach (keys %{$self->{locator}}) {
    #print $_, "\n";
    $self->initStorage($_);
  }
}

sub _dbErrorHandler {
  my $message_db = shift;
  # get logger instance
  #my $logger = Log::Dispatch::Config->instance;
  #$logger->log(level => 'error', message => "Tangram DBI-Error: $message");
  my $message_log = "DBI-Error: $message_db";
  print STDERR $message_log, "\n";
  #$logger->error( $message_log );
  #$logger->log_to( name => 'file', level => 'error', message => $message_log);
  $logger->log_to( name => 'file', level => 'warning', message => $message_log);
  return 1;
}

1;
__END__
1	joko	1.1	################################################
2			#
3	joko	1.10	# $Id: Container.pm,v 1.9 2003/03/27 15:31:08 joko Exp $
4	joko	1.1	#
5			# $Log: Container.pm,v $
6	joko	1.10	# Revision 1.9 2003/03/27 15:31:08 joko
7			# fixes to modules regarding new namespace(s) below Data::Mungle::*
8			#
9	joko	1.9	# Revision 1.8 2003/02/18 19:19:47 joko
10			# + modified locator handling
11			#
12	joko	1.8	# Revision 1.7 2003/01/30 22:21:52 joko
13			# + changed 'connect'-behaviour back to old state
14			# + renamed log-output (now using 'initializing' instead of 'booting' - corresponding to 'initStorage')
15			#
16	joko	1.7	# Revision 1.6 2003/01/30 21:44:00 joko
17			# + temporary fix: (FIXME) now connecting to storage on storagehandle-instantiation
18			#
19	joko	1.6	# Revision 1.5 2003/01/19 02:39:57 joko
20	joko	1.9	# + moved 'deep_copy' from module 'libp' to module 'Data.Transform.Deep'
21	joko	1.6	# + preserved order for hashes '$self->{config}' and '$self->{locator}' by using Tie::IxHash
22			#
23	joko	1.5	# Revision 1.4 2002/12/04 07:38:07 jonen
24			# + deep copy
25			#
26	jonen	1.4	# Revision 1.3 2002/12/01 22:18:28 joko
27			# - no interactive implicit deploy
28			# + only test integrity if storage available
29			#
30	joko	1.3	# Revision 1.2 2002/12/01 07:08:35 joko
31			# + needs to "use Data::Storage;"
32			#
33	joko	1.2	# Revision 1.1 2002/11/29 04:54:54 joko
34			# + initial check-in
35			#
36	joko	1.1	# Revision 1.1 2002/11/17 06:20:41 joko
37			# + initial check in
38			#
39			#
40			################################################
41
42
43			package Data::Storage::Container;
44
45			use strict;
46			use warnings;
47
48			# get logger instance
49			my $logger = Log::Dispatch::Config->instance;
50
51	joko	1.5
52			# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - main
53			use Tie::IxHash;
54	joko	1.1	use Data::Dumper;
55	joko	1.5
56	joko	1.8	use Data::Storage;
57			use Data::Storage::Locator;
58	joko	1.9	use Data::Mungle::Transform::Deep qw( deep_copy );
59			use Data::Mungle::Compare::Struct qw( isEmpty );
60	joko	1.1
61			sub new {
62			my $invocant = shift;
63			my $class = ref($invocant) \|\| $invocant;
64
65			# get constructor arguments
66			my @args = ();
67			@_ && (@args = @_);
68			$logger->debug( __PACKAGE__ . "->new( @args )" );
69
70			my $self = { @_ };
71	joko	1.5	bless $self, $class;
72
73			# preserve order of configuration variables
74			#$self->{config} = {};
75			tie %{$self->{config}}, 'Tie::IxHash';
76			tie %{$self->{locator}}, 'Tie::IxHash';
77
78			return $self;
79	joko	1.1	}
80
81			sub addConfig {
82			my $self = shift;
83			my $name = shift;
84			my $config = shift;
85			$self->{config}->{$name} = $config;
86			}
87
88			sub addConfigByDsn {
89			my $self = shift;
90			my $name = shift;
91			my $dsn = shift;
92
93			# HACK: assume DBI as default type for now
94			# TODO: guess type from dsn
95			my $type = "DBI";
96
97			$self->addConfig($name, { type => $type, dsn => $dsn });
98			}
99
100			sub addStorage {
101			my $self = shift;
102			my $name = shift;
103			my $storage = shift;
104			$self->{storage}->{$name} = $storage;
105			}
106
107	joko	1.10	sub existsStorage {
108			my $self = shift;
109			my $name = shift;
110			return exists $self->{storage}->{$name};
111			}
112
113	joko	1.1	sub initLocator {
114			my $self = shift;
115			my $name = shift;
116			my $db_config = $self->{config}->{$name};
117	joko	1.8	$db_config \|\|= {};
118	joko	1.1
119	joko	1.8	$logger->debug( __PACKAGE__ . "->initLocator( name='$name' )" );
120	joko	1.1
121			my $cfg_locator = {};
122
123			# set default settings, if any
124			my $default = deep_copy($self->{config}->{_default});
125			foreach (keys %$default) {
126			$cfg_locator->{$_} = $default->{$_};
127			}
128
129			# merge in specific settings
130	jonen	1.4	my $specific = deep_copy($db_config);
131			foreach (keys %$specific) {
132			$cfg_locator->{$_} = $specific->{$_};
133	joko	1.1	}
134
135			# HACK: transfer dsn from main to dbi settings
136			$cfg_locator->{dbi}->{dsn} = $cfg_locator->{dsn} if $cfg_locator->{dsn};
137
138			# HACK: set classnames empty if none given from config
139			$cfg_locator->{classnames} = [] if !$cfg_locator->{classnames};
140
141			# HACK: set errorhandler if dbi settings are present
142			$cfg_locator->{dbi}->{HandleError} = \&_dbErrorHandler if $cfg_locator->{dbi};
143	joko	1.8
144			# trace
145			#print "locator:", "\n";
146			#print Dumper($cfg_locator);
147
148			# check locator metadata
149			if (isEmpty($cfg_locator)) {
150			$logger->warning( __PACKAGE__ . "->initLocator( name='$name' ): Metadata was empty. Please check configuration." );
151			return;
152			}
153
154			# name it
155			$cfg_locator->{name} = $name;
156	joko	1.1
157			# create new locator object
158			$self->{locator}->{$name} = Data::Storage::Locator->new( $cfg_locator );
159
160			}
161
162			sub initLocators {
163			my $self = shift;
164			foreach (keys %{$self->{config}}) {
165	joko	1.5	#print $_, "\n";
166	joko	1.1	$self->initLocator($_, $self->{config}->{$_}) if !/^_/;
167			}
168			#print "locs: ", Dumper($self->{locator});
169			}
170
171			sub getLocator {
172			my $self = shift;
173			my $name = shift;
174			return $self->{locator}->{$name};
175			}
176
177			sub initStorage {
178			my $self = shift;
179			my $name = shift;
180
181	joko	1.10	return if $self->existsStorage($name);
182
183	joko	1.1	my $locator = $self->getLocator($name);
184	joko	1.7	$logger->info( __PACKAGE__ . " is initializing storage declared by locator \"$name\"" );
185	joko	1.1
186			my $storage = Data::Storage->new($locator);
187	joko	1.6
188			# TODO: do below (after 'testAvailability' and 'testIntegrity') again!!!
189	joko	1.7	#$storage->connect();
190	joko	1.1
191			my $log_prefix = __PACKAGE__ . "->initStorage: ";
192			$log_prefix .= "dsn=\"$self->{locator}->{$name}->{dsn}\"" if $self->{locator}->{$name}->{dsn};
193
194			# should we test availability of the storage before using it?
195			if ($locator->{test_availability}) {
196	joko	1.3	$locator->{status}->{availability} = $storage->testAvailability();
197	joko	1.1	if ( !$storage->testAvailability() ) {
198	joko	1.3	$logger->error( "$log_prefix: testAvailability failed" );
199	joko	1.1	}
200			}
201
202			# should we test integrity of the storage before using it?
203	joko	1.3	if ($locator->{status}->{availability} && $locator->{test_integrity}) {
204	joko	1.1	#return unless $storage->testIntegrity();
205			$locator->{status}->{integrity} = $storage->testIntegrity();
206			# actions if integrity fails
207			if (!$locator->{status}->{integrity}) {
208	joko	1.3	$logger->error( "$log_prefix: testIntegrity failed" );
209	joko	1.1	}
210			}
211
212			# try to connect...
213			# TODO:
214			# don't connect right here, do an implicit connect on (later) usage
215			# maybe set ->{meta}->{connectmethod} = "connect" here
216			#return unless $storage->connect();
217	joko	1.7	$storage->connect() if $locator->{status}->{integrity};
218	joko	1.1
219			# should we check emptyness?
220	joko	1.3	if ($locator->{status}->{availability} && $locator->{test_emptyness}) {
221			#print "test empty", "\n";
222	joko	1.1	if ( !@{$storage->getChildNodes()} ) {
223			$locator->{status}->{empty} = 1;
224	joko	1.3	$logger->warning( "$log_prefix: Storage is empty.");
225	joko	1.1	#return;
226			}
227			}
228
229			# expand logging?
230	joko	1.3	if ( $locator->{status}->{integrity} && $locator->{logger} ) {
231	joko	1.1	# expand logging (to Tangram-Database)
232			# TODO:
233			# - move configuration data from this code to db_config somehow
234			# - do complete handling of this stuff in Data::Storage::* also
235			# - just leave a simple on/off-trigger here and/or
236			# - make it optionally configurable via e.g. get/set-methods
237			# to satisfy "manual"-mode instead of "config"-mode
238			# - (re-)add hierarchical logging (each event may have a parent)
239			no strict;
240			my $creator = sub { return new SystemEvent; };
241			use strict;
242			$storage->addLogDispatchHandler("Tangram11", "Log::Dispatch::Tangram", $logger, $creator);
243			#$storage_left->addLogDispatchHandler("Tangram11", "Log::Dispatch::Tangram", $logger);
244			}
245
246			#$self->{storage}->{$name} = $storage;
247	joko	1.3	#print "add storage: $name", "\n";
248	joko	1.1	$self->addStorage($name, $storage);
249
250			return 1;
251
252			}
253
254			sub initStorages {
255			my $self = shift;
256			foreach (keys %{$self->{locator}}) {
257	joko	1.5	#print $_, "\n";
258	joko	1.1	$self->initStorage($_);
259			}
260			}
261
262			sub _dbErrorHandler {
263			my $message_db = shift;
264			# get logger instance
265			#my $logger = Log::Dispatch::Config->instance;
266			#$logger->log(level => 'error', message => "Tangram DBI-Error: $message");
267			my $message_log = "DBI-Error: $message_db";
268			print STDERR $message_log, "\n";
269			#$logger->error( $message_log );
270			#$logger->log_to( name => 'file', level => 'error', message => $message_log);
271			$logger->log_to( name => 'file', level => 'warning', message => $message_log);
272			return 1;
273			}
274
275			1;
276	joko	1.10	__END__
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26