Storage/Handler/DBI.pm

#################################
#
#  $Id: DBI.pm,v 1.15 2003/04/09 07:53:33 joko Exp $
#
#  $Log: DBI.pm,v $
#  Revision 1.15  2003/04/09 07:53:33  joko
#  minor namespace update
#
#  Revision 1.14  2003/04/09 06:06:04  joko
#  sendQuery now is capable of doing 'SELECT'- or 'INSERT'-queries
#
#  Revision 1.13  2003/04/08 23:06:45  joko
#  renamed core database helper functions
#
#  Revision 1.12  2003/01/30 22:28:21  joko
#  + implemented new concrete methods
#
#  Revision 1.11  2002/12/19 16:31:05  joko
#  + sub dropDb
#  + sub rebuildDb
#
#  Revision 1.10  2002/12/15 02:02:22  joko
#  + fixed logging-message
#
#  Revision 1.9  2002/12/05 07:58:20  joko
#  + now using Tie::SecureHash as a base for the COREHANDLE
#  + former public COREHANDLE becomes private _COREHANDLE now
#
#  Revision 1.8  2002/12/01 22:20:43  joko
#  + sub createDb (from Storage.pm)
#
#  Revision 1.7  2002/12/01 07:09:09  joko
#  + sub getListFiltered (dummy redirecting to getListUnfiltered)
#
#  Revision 1.6  2002/12/01 04:46:01  joko
#  + sub eraseAll
#
#  Revision 1.5  2002/11/29 05:00:26  joko
#  + sub getListUnfiltered
#  + sub sendQuery
#
#  Revision 1.4  2002/11/17 08:46:42  jonen
#  + wrapped eval around DBI->connect to prevent deaths
#
#  Revision 1.3  2002/11/17 06:34:39  joko
#  + locator metadata can now be reached via ->{locator}
#  - sub hash2sql now taken from libdb
#
#  Revision 1.2  2002/10/25 11:43:27  joko
#  + enhanced robustness
#  + more logging for debug-levels
#
#  Revision 1.1  2002/10/10 03:44:07  cvsjoko
#  + new
#
#
#################################

package Data::Storage::Handler::DBI;

use strict;
use warnings;

use base ("Data::Storage::Handler::Abstract");


use DBI;
use Data::Dumper;
use shortcuts::database qw( hash2sql dsn2dbname );
use Data::Storage::Result::DBI;


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


sub getMetaInfo {
  my $self = shift;
  $logger->debug( __PACKAGE__ . "->getMetaInfo()"  );
  return {
    'disconnectMethod' => 'disconnect',
  };
}

sub connect {

    my $self = shift;
    
    # create handle
      if ( my $dsn = $self->{locator}->{dbi}->{dsn} ) {
      #if ( my $dsn = $self->{locator}->{dsn} ) {
        $logger->debug( __PACKAGE__ . "->connect( dsn $dsn )" );
        
        # HACK:
        # set errorhandler before actually calling DBI->connect 
        # in order to catch errors from the very beginning
        #DBI->{HandleError} = $self->{dbi}->{HandleError};
        
        #use Data::Dumper; print Dumper($self->{dbi});
        
        eval {
          $self->{_COREHANDLE} = DBI->connect( $dsn, '', '', $self->{locator}->{dbi} );
          if (!$self->{_COREHANDLE}) {
            $logger->warning( __PACKAGE__ . "->connect failed: " . DBI::errstr );
            return;
          }
        };
        $logger->warning( __PACKAGE__ . "->connect failed: " . $@ ) if $@;

      }
      $self->configureCOREHANDLE();

    $self->{locator}->{status}->{connected} = 1;

    return 1;
    
}

sub configureCOREHANDLE {

  my $self = shift;

  $logger->debug( __PACKAGE__ . "->configureCOREHANDLE" );

  return if !$self->{_COREHANDLE};

  # apply configured modifications to DBI-handle
    if (exists $self->{locator}->{dbi}->{trace_level} && exists $self->{locator}->{dbi}->{trace_file}) {
      $self->{_COREHANDLE}->trace($self->{locator}->{dbi}->{trace_level}, $self->{locator}->{dbi}->{trace_file});
    }
    if (exists $self->{locator}->{dbi}->{RaiseError}) {
      $self->{_COREHANDLE}->{RaiseError} = $self->{locator}->{dbi}->{RaiseError};
    }
    if (exists $self->{locator}->{dbi}->{PrintError}) {
      $self->{_COREHANDLE}->{PrintError} = $self->{locator}->{dbi}->{PrintError};
    }
    if (exists $self->{locator}->{dbi}->{HandleError}) {
      $self->{_COREHANDLE}->{HandleError} = $self->{locator}->{dbi}->{HandleError};
    }

}

sub _sendSql {
  my $self = shift;
  my $sql = shift;
  
  # pre-flight check: is $sql defined?
  if (!$sql) {
    $logger->warning( __PACKAGE__ . "->_sendSql: \$sql was empty." );
    return;
  }
  
  # two-level handling for implicit connect:
  # if there's no corehandle ...
  if (!$self->{_COREHANDLE}) {
    # ... try to connect, but ...
    $self->connect();
    # ... if this still fails, there's something wrong probably, so we won't continue
    if (!$self->{_COREHANDLE}) {
      return;
    }
  }
  
  #print "prepare sql: $sql\n";
  
  my $sth = $self->{_COREHANDLE}->prepare($sql);
  $sth->execute();
  return $sth;
}

sub sendCommand {
  my $self = shift;
  my $command = shift;
  # TODO: when tracing: yes, do actually log this
  #$logger->debug( __PACKAGE__ . "->sendCommand( command $command )" );
  my $cmdHandle = $self->_sendSql($command);
  my $result = Data::Storage::Result::DBI->new( RESULTHANDLE => $cmdHandle );
  return $result;
}

sub getChildNodes {
  my $self = shift;
  my @nodes;
  $logger->debug( __PACKAGE__ . "->getChildNodes()" );
  my $locator = $self->{locator};
  #print Dumper($locator); exit;
  if (my $result = $self->sendCommand( 'SHOW TABLES;' ) ) {
    my $dbname = dsn2dbname($self->{locator}->{dbi}->{dsn});
    my $key = "Tables_in_$dbname";
    while ( my $row = $result->getNextEntry() ) {
      push @nodes, $row->{$key};
    }
  }
  return \@nodes;
}

sub getListUnfiltered {
  my $self = shift;
  my $nodename = shift;
  my @list;
  $logger->debug( __PACKAGE__ . "->getListUnfiltered( nodename => '" . $nodename . "' )" );
  # get list of rows from rdbms by table name
  my $result = $self->sendCommand("SELECT * FROM $nodename");
  while ( my $row = $result->getNextEntry() ) {
    push @list, $row;
  }
  return \@list;
}

sub sendQuery {
  my $self = shift;
  my $query = shift;

  $logger->debug( __PACKAGE__ . "->sendQuery" );

  my $crud = $query->{options}->{crud};
  $crud ||= $query->{options}->{action};
  $crud ||= 'RETRIEVE';

  if (my $guid = $query->{options}->{GUID}) {
    $query->{criterias} = [ { key => 'guid', op => 'eq', val => $guid } ];
  }

  # check criterias (load & save)
  #my $sql = "SELECT cs FROM $self->{metainfo}->{$descent}->{node} WHERE $self->{metainfo}->{$descent}->{IdentProvider}->{arg}='$self->{entry}->{source}->{ident}';";
  #my $result = $self->{metainfo}->{$descent}->{storage}->sendCommand($sql);
  my @crits;
  foreach (@{$query->{criterias}}) {
    my $op = '';
    $op = '=' if lc $_->{op} eq 'eq';
    push @crits, "$_->{key}$op'$_->{val}'";
  }
  # HACK: this is hardcoded ;(    expand possibilities!
  my $crit = join(' AND ', @crits);
  
  # check subnodes (load)
  my $subnodes = {};
  map { $subnodes->{$_}++ } @{$query->{subnodes}};
  
  # check payload (save)
  #print Dumper($query->{payload});
  #$subnodes ||= $query->{payload};
  
  # dispatch action
  if ($crud eq 'RETRIEVE') {
    my $sql = hash2sql($query->{node}, $subnodes, 'SELECT', $crit);
    return $self->sendCommand($sql);

  } elsif ($crud eq 'UPDATE') {
    my $sql = hash2sql($query->{node}, $query->{payload}, 'UPDATE', $crit);
    $self->sendCommand($sql);

  } elsif ($crud eq 'DELETE') {
    my $sql = hash2sql($query->{node}, $query->{payload}, 'DELETE', $crit);
    $self->sendCommand($sql);

  }

}

sub eraseAll {
  my $self = shift;
  my $classname = shift;
  $logger->debug( __PACKAGE__ . "->eraseAll" );
  my $sql = "DELETE FROM $classname";
  $self->sendCommand($sql);
}

# TODO: actually implement the filtering functionality using $this->sendQuery
sub getListFiltered {
  my $self = shift;
  my $nodename = shift;
  return $self->getListUnfiltered($nodename);
}

# TODO: do this via a parametrized "$self->connect(<connect just to database server - don't select database>)"
sub createDb {
  
  my $self = shift;
  
  # get dsn from Data::Storage::Locator instance
  my $dsn = $self->{locator}->{dbi}->{dsn};

  $logger->debug( __PACKAGE__ .  "->createDb( dsn $dsn )" );

  # remove database setting from dsn-string
  $dsn =~ s/database=(.+?);//;
  
  # remember extracted database name to know what actually to create right now
  my $database_name = $1;

  # flag to indicate goodness
  my $ok;
  
  # connect to database server - don't select/use any specific database
  #if ( my $dbh = DBI->connect($dsn, '', '', { PrintError => 0 } ) ) {
  if ( my $dbh = DBI->connect($dsn, '', '', $self->{locator}->{dbi} ) ) {

    if ($database_name) {
      if ($dbh->do("CREATE DATABASE $database_name")) {
        $ok = 1;
      }
    }

    $dbh->disconnect();

  }
  
  return $ok;
  
}

sub getCOREHANDLE2 {
  my $self = shift;
  return $self->{_COREHANDLE};
}

sub dropDb {
  my $self = shift;
  my $dsn = $self->{locator}->{dbi}->{dsn};

  $logger->debug( __PACKAGE__ .  "->dropDb( dsn $dsn )" );

  $dsn =~ s/database=(.+?);//;
  my $database_name = $1;

  my $ok;
  
  if ( my $dbh = DBI->connect($dsn, '', '', {
                                                      PrintError => 0,
                                                      } ) ) {
    if ($database_name) {
      if ($dbh->do("DROP DATABASE $database_name;")) {
        $ok = 1;
      }
    }

    $dbh->disconnect();

  }
  
  return $ok;
}

sub rebuildDb {
  my $self = shift;
  $logger->info( __PACKAGE__ . "->rebuildDb()" );
  my @results;

  # sum up results (bool (0/1)) in array
  #push @results, $self->retreatSchema();
  push @results, $self->dropDb();
  push @results, $self->createDb();
  #push @results, $self->deploySchema();

  # scan array for "bad ones"
  my $res = 1;
  map {
    $res = 0 if (!$_);
  } @results;
  
  return $res;
}

sub testAvailability {
  my $self = shift;
  my $status = $self->testDsn();
  $self->{locator}->{status}->{available} = $status;
  return $status;
}

sub testDsn {
  my $self = shift;
  my $dsn = $self->{locator}->{dbi}->{dsn};
  my $result;
  if ( my $dbh = DBI->connect($dsn, '', '', {
                                                      PrintError => 0,
                                                      } ) ) {
    
    # TODO: REVIEW
    $dbh->disconnect();
    
    return 1;
  } else {
    $logger->warning( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr );
  }
}

1;
__END__
1	#################################
2	#
3	# $Id: DBI.pm,v 1.15 2003/04/09 07:53:33 joko Exp $
4	#
5	# $Log: DBI.pm,v $
6	# Revision 1.15 2003/04/09 07:53:33 joko
7	# minor namespace update
8	#
9	# Revision 1.14 2003/04/09 06:06:04 joko
10	# sendQuery now is capable of doing 'SELECT'- or 'INSERT'-queries
11	#
12	# Revision 1.13 2003/04/08 23:06:45 joko
13	# renamed core database helper functions
14	#
15	# Revision 1.12 2003/01/30 22:28:21 joko
16	# + implemented new concrete methods
17	#
18	# Revision 1.11 2002/12/19 16:31:05 joko
19	# + sub dropDb
20	# + sub rebuildDb
21	#
22	# Revision 1.10 2002/12/15 02:02:22 joko
23	# + fixed logging-message
24	#
25	# Revision 1.9 2002/12/05 07:58:20 joko
26	# + now using Tie::SecureHash as a base for the COREHANDLE
27	# + former public COREHANDLE becomes private _COREHANDLE now
28	#
29	# Revision 1.8 2002/12/01 22:20:43 joko
30	# + sub createDb (from Storage.pm)
31	#
32	# Revision 1.7 2002/12/01 07:09:09 joko
33	# + sub getListFiltered (dummy redirecting to getListUnfiltered)
34	#
35	# Revision 1.6 2002/12/01 04:46:01 joko
36	# + sub eraseAll
37	#
38	# Revision 1.5 2002/11/29 05:00:26 joko
39	# + sub getListUnfiltered
40	# + sub sendQuery
41	#
42	# Revision 1.4 2002/11/17 08:46:42 jonen
43	# + wrapped eval around DBI->connect to prevent deaths
44	#
45	# Revision 1.3 2002/11/17 06:34:39 joko
46	# + locator metadata can now be reached via ->{locator}
47	# - sub hash2sql now taken from libdb
48	#
49	# Revision 1.2 2002/10/25 11:43:27 joko
50	# + enhanced robustness
51	# + more logging for debug-levels
52	#
53	# Revision 1.1 2002/10/10 03:44:07 cvsjoko
54	# + new
55	#
56	#
57	#################################
58
59	package Data::Storage::Handler::DBI;
60
61	use strict;
62	use warnings;
63
64	use base ("Data::Storage::Handler::Abstract");
65
66
67	use DBI;
68	use Data::Dumper;
69	use shortcuts::database qw( hash2sql dsn2dbname );
70	use Data::Storage::Result::DBI;
71
72
73	# get logger instance
74	my $logger = Log::Dispatch::Config->instance;
75
76
77	sub getMetaInfo {
78	my $self = shift;
79	$logger->debug( __PACKAGE__ . "->getMetaInfo()" );
80	return {
81	'disconnectMethod' => 'disconnect',
82	};
83	}
84
85	sub connect {
86
87	my $self = shift;
88
89	# create handle
90	if ( my $dsn = $self->{locator}->{dbi}->{dsn} ) {
91	#if ( my $dsn = $self->{locator}->{dsn} ) {
92	$logger->debug( __PACKAGE__ . "->connect( dsn $dsn )" );
93
94	# HACK:
95	# set errorhandler before actually calling DBI->connect
96	# in order to catch errors from the very beginning
97	#DBI->{HandleError} = $self->{dbi}->{HandleError};
98
99	#use Data::Dumper; print Dumper($self->{dbi});
100
101	eval {
102	$self->{_COREHANDLE} = DBI->connect( $dsn, '', '', $self->{locator}->{dbi} );
103	if (!$self->{_COREHANDLE}) {
104	$logger->warning( __PACKAGE__ . "->connect failed: " . DBI::errstr );
105	return;
106	}
107	};
108	$logger->warning( __PACKAGE__ . "->connect failed: " . $@ ) if $@;
109
110	}
111	$self->configureCOREHANDLE();
112
113	$self->{locator}->{status}->{connected} = 1;
114
115	return 1;
116
117	}
118
119	sub configureCOREHANDLE {
120
121	my $self = shift;
122
123	$logger->debug( __PACKAGE__ . "->configureCOREHANDLE" );
124
125	return if !$self->{_COREHANDLE};
126
127	# apply configured modifications to DBI-handle
128	if (exists $self->{locator}->{dbi}->{trace_level} && exists $self->{locator}->{dbi}->{trace_file}) {
129	$self->{_COREHANDLE}->trace($self->{locator}->{dbi}->{trace_level}, $self->{locator}->{dbi}->{trace_file});
130	}
131	if (exists $self->{locator}->{dbi}->{RaiseError}) {
132	$self->{_COREHANDLE}->{RaiseError} = $self->{locator}->{dbi}->{RaiseError};
133	}
134	if (exists $self->{locator}->{dbi}->{PrintError}) {
135	$self->{_COREHANDLE}->{PrintError} = $self->{locator}->{dbi}->{PrintError};
136	}
137	if (exists $self->{locator}->{dbi}->{HandleError}) {
138	$self->{_COREHANDLE}->{HandleError} = $self->{locator}->{dbi}->{HandleError};
139	}
140
141	}
142
143	sub _sendSql {
144	my $self = shift;
145	my $sql = shift;
146
147	# pre-flight check: is $sql defined?
148	if (!$sql) {
149	$logger->warning( __PACKAGE__ . "->_sendSql: \$sql was empty." );
150	return;
151	}
152
153	# two-level handling for implicit connect:
154	# if there's no corehandle ...
155	if (!$self->{_COREHANDLE}) {
156	# ... try to connect, but ...
157	$self->connect();
158	# ... if this still fails, there's something wrong probably, so we won't continue
159	if (!$self->{_COREHANDLE}) {
160	return;
161	}
162	}
163
164	#print "prepare sql: $sql\n";
165
166	my $sth = $self->{_COREHANDLE}->prepare($sql);
167	$sth->execute();
168	return $sth;
169	}
170
171	sub sendCommand {
172	my $self = shift;
173	my $command = shift;
174	# TODO: when tracing: yes, do actually log this
175	#$logger->debug( __PACKAGE__ . "->sendCommand( command $command )" );
176	my $cmdHandle = $self->_sendSql($command);
177	my $result = Data::Storage::Result::DBI->new( RESULTHANDLE => $cmdHandle );
178	return $result;
179	}
180
181	sub getChildNodes {
182	my $self = shift;
183	my @nodes;
184	$logger->debug( __PACKAGE__ . "->getChildNodes()" );
185	my $locator = $self->{locator};
186	#print Dumper($locator); exit;
187	if (my $result = $self->sendCommand( 'SHOW TABLES;' ) ) {
188	my $dbname = dsn2dbname($self->{locator}->{dbi}->{dsn});
189	my $key = "Tables_in_$dbname";
190	while ( my $row = $result->getNextEntry() ) {
191	push @nodes, $row->{$key};
192	}
193	}
194	return \@nodes;
195	}
196
197	sub getListUnfiltered {
198	my $self = shift;
199	my $nodename = shift;
200	my @list;
201	$logger->debug( __PACKAGE__ . "->getListUnfiltered( nodename => '" . $nodename . "' )" );
202	# get list of rows from rdbms by table name
203	my $result = $self->sendCommand("SELECT * FROM $nodename");
204	while ( my $row = $result->getNextEntry() ) {
205	push @list, $row;
206	}
207	return \@list;
208	}
209
210	sub sendQuery {
211	my $self = shift;
212	my $query = shift;
213
214	$logger->debug( __PACKAGE__ . "->sendQuery" );
215
216	my $crud = $query->{options}->{crud};
217	$crud \|\|= $query->{options}->{action};
218	$crud \|\|= 'RETRIEVE';
219
220	if (my $guid = $query->{options}->{GUID}) {
221	$query->{criterias} = [ { key => 'guid', op => 'eq', val => $guid } ];
222	}
223
224	# check criterias (load & save)
225	#my $sql = "SELECT cs FROM $self->{metainfo}->{$descent}->{node} WHERE $self->{metainfo}->{$descent}->{IdentProvider}->{arg}='$self->{entry}->{source}->{ident}';";
226	#my $result = $self->{metainfo}->{$descent}->{storage}->sendCommand($sql);
227	my @crits;
228	foreach (@{$query->{criterias}}) {
229	my $op = '';
230	$op = '=' if lc $_->{op} eq 'eq';
231	push @crits, "$_->{key}$op'$_->{val}'";
232	}
233	# HACK: this is hardcoded ;( expand possibilities!
234	my $crit = join(' AND ', @crits);
235
236	# check subnodes (load)
237	my $subnodes = {};
238	map { $subnodes->{$_}++ } @{$query->{subnodes}};
239
240	# check payload (save)
241	#print Dumper($query->{payload});
242	#$subnodes \|\|= $query->{payload};
243
244	# dispatch action
245	if ($crud eq 'RETRIEVE') {
246	my $sql = hash2sql($query->{node}, $subnodes, 'SELECT', $crit);
247	return $self->sendCommand($sql);
248
249	} elsif ($crud eq 'UPDATE') {
250	my $sql = hash2sql($query->{node}, $query->{payload}, 'UPDATE', $crit);
251	$self->sendCommand($sql);
252
253	} elsif ($crud eq 'DELETE') {
254	my $sql = hash2sql($query->{node}, $query->{payload}, 'DELETE', $crit);
255	$self->sendCommand($sql);
256
257	}
258
259	}
260
261	sub eraseAll {
262	my $self = shift;
263	my $classname = shift;
264	$logger->debug( __PACKAGE__ . "->eraseAll" );
265	my $sql = "DELETE FROM $classname";
266	$self->sendCommand($sql);
267	}
268
269	# TODO: actually implement the filtering functionality using $this->sendQuery
270	sub getListFiltered {
271	my $self = shift;
272	my $nodename = shift;
273	return $self->getListUnfiltered($nodename);
274	}
275
276	# TODO: do this via a parametrized "$self->connect(<connect just to database server - don't select database>)"
277	sub createDb {
278
279	my $self = shift;
280
281	# get dsn from Data::Storage::Locator instance
282	my $dsn = $self->{locator}->{dbi}->{dsn};
283
284	$logger->debug( __PACKAGE__ . "->createDb( dsn $dsn )" );
285
286	# remove database setting from dsn-string
287	$dsn =~ s/database=(.+?);//;
288
289	# remember extracted database name to know what actually to create right now
290	my $database_name = $1;
291
292	# flag to indicate goodness
293	my $ok;
294
295	# connect to database server - don't select/use any specific database
296	#if ( my $dbh = DBI->connect($dsn, '', '', { PrintError => 0 } ) ) {
297	if ( my $dbh = DBI->connect($dsn, '', '', $self->{locator}->{dbi} ) ) {
298
299	if ($database_name) {
300	if ($dbh->do("CREATE DATABASE $database_name")) {
301	$ok = 1;
302	}
303	}
304
305	$dbh->disconnect();
306
307	}
308
309	return $ok;
310
311	}
312
313	sub getCOREHANDLE2 {
314	my $self = shift;
315	return $self->{_COREHANDLE};
316	}
317
318	sub dropDb {
319	my $self = shift;
320	my $dsn = $self->{locator}->{dbi}->{dsn};
321
322	$logger->debug( __PACKAGE__ . "->dropDb( dsn $dsn )" );
323
324	$dsn =~ s/database=(.+?);//;
325	my $database_name = $1;
326
327	my $ok;
328
329	if ( my $dbh = DBI->connect($dsn, '', '', {
330	PrintError => 0,
331	} ) ) {
332	if ($database_name) {
333	if ($dbh->do("DROP DATABASE $database_name;")) {
334	$ok = 1;
335	}
336	}
337
338	$dbh->disconnect();
339
340	}
341
342	return $ok;
343	}
344
345	sub rebuildDb {
346	my $self = shift;
347	$logger->info( __PACKAGE__ . "->rebuildDb()" );
348	my @results;
349
350	# sum up results (bool (0/1)) in array
351	#push @results, $self->retreatSchema();
352	push @results, $self->dropDb();
353	push @results, $self->createDb();
354	#push @results, $self->deploySchema();
355
356	# scan array for "bad ones"
357	my $res = 1;
358	map {
359	$res = 0 if (!$_);
360	} @results;
361
362	return $res;
363	}
364
365	sub testAvailability {
366	my $self = shift;
367	my $status = $self->testDsn();
368	$self->{locator}->{status}->{available} = $status;
369	return $status;
370	}
371
372	sub testDsn {
373	my $self = shift;
374	my $dsn = $self->{locator}->{dbi}->{dsn};
375	my $result;
376	if ( my $dbh = DBI->connect($dsn, '', '', {
377	PrintError => 0,
378	} ) ) {
379
380	# TODO: REVIEW
381	$dbh->disconnect();
382
383	return 1;
384	} else {
385	$logger->warning( __PACKAGE__ . "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr );
386	}
387	}
388
389	1;
390	__END__
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26