2 # dbi.pl: DBI (mysql/pgsql/sqlite) database frontend.
4 # Version: v0.9a (20021124)
6 # Notes: based on db_mysql.pl
7 # overhauled to be 31337.
13 use vars qw($dbh $shm $bot_data_dir);
18 # &sqlOpenDB($dbname, $dbtype, $sqluser, $sqlpass, $nofail);
20 my ($db, $type, $user, $pass, $no_fail) = @_;
21 # this is a mess. someone fix it, please.
22 if ($type =~ /^SQLite$/i) {
23 $db = "dbname=$db.sqlite";
24 } elsif ($type =~ /^pg/i) {
29 my $dsn = "DBI:$type:$db";
31 # SQLHost should be unset for SQLite
32 if (exists $param{'SQLHost'} and $param{'SQLHost'}) {
33 $dsn .= ":$param{SQLHost}";
34 $hoststr = " to $param{'SQLHost'}";
36 # SQLite ignores $user and $pass
37 $dbh = DBI->connect($dsn, $user, $pass);
39 if ($dbh && !$dbh->err) {
40 &status("Opened $type connection$hoststr");
42 &ERROR("Cannot connect$hoststr.");
43 &ERROR("Since $type is not available, shutting down bot!");
44 &ERROR( $dbh->errstr ) if ($dbh);
49 return 0 if ($no_fail);
56 return 0 unless ($dbh);
58 my $x = $param{SQLHost};
59 my $hoststr = ($x) ? " to $x" : "";
61 &status("Closed DBI connection$hoststr.");
68 # Usage: &sqlQuote($str);
70 return $dbh->quote($_[0]);
74 # Usage: &sqlSelectMany($table, $select, [$where_href], [$other]);
75 # Return: $sth (Statement handle object)
77 my($table, $select, $where_href, $other) = @_;
78 my $query = "SELECT $select FROM $table";
81 if (!defined $select or $select =~ /^\s*$/) {
82 &WARN("sqlSelectMany: select == NULL.");
86 if (!defined $table or $table =~ /^\s*$/) {
87 &WARN("sqlSelectMany: table == NULL.");
92 my $where = &hashref2where($where_href);
93 $query .= " WHERE $where" if ($where);
95 $query .= " $other" if $other;
97 if (!($sth = $dbh->prepare($query))) {
98 &ERROR("sqlSelectMany: prepare: $DBI::errstr");
103 if (!$sth->execute) {
104 &ERROR("sqlSelectMany: execute: '$query'");
112 # Usage: &sqlSelect($table, $select, [$where_href, [$other]);
113 # Return: scalar if one element, array if list of elements.
114 # Note: Suitable for one column returns, that is, one column in $select.
115 # Todo: Always return array?
117 my $sth = &sqlSelectMany(@_);
119 &WARN("sqlSelect failed.");
122 my @retval = $sth->fetchrow_array;
125 if (scalar @retval > 1) {
127 } elsif (scalar @retval == 1) {
135 # Usage: &sqlSelectColArray($table, $select, [$where_href], [$other]);
137 sub sqlSelectColArray {
138 my $sth = &sqlSelectMany(@_);
142 &WARN("sqlSelect failed.");
146 while (my @row = $sth->fetchrow_array) {
147 push(@retval, $row[0]);
155 # Usage: &sqlSelectColHash($table, $select, [$where_href], [$other], [$type]);
156 # Return: type = 1: $retval{ col2 }{ col1 } = 1;
157 # Return: no type: $retval{ col1 } = col2;
158 # Note: does not support $other, yet.
159 sub sqlSelectColHash {
160 my ($table, $select, $where_href, $other, $type) = @_;
161 my $sth = &sqlSelectMany($table, $select, $where_href, $other);
163 &WARN("sqlSelectColhash failed.");
168 if (defined $type and $type == 2) {
169 &DEBUG("dbgetcol: type 2!");
170 while (my @row = $sth->fetchrow_array) {
171 $retval{$row[0]} = join(':', $row[1..$#row]);
173 &DEBUG("dbgetcol: count => ".scalar(keys %retval) );
175 } elsif (defined $type and $type == 1) {
176 while (my @row = $sth->fetchrow_array) {
177 # reverse it to make it easier to count.
178 if (scalar @row == 2) {
179 $retval{$row[1]}{$row[0]} = 1;
180 } elsif (scalar @row == 3) {
181 $retval{$row[1]}{$row[0]} = 1;
183 # what to do if there's only one or more than 3?
187 while (my @row = $sth->fetchrow_array) {
188 $retval{$row[0]} = $row[1];
198 # Usage: &sqlSelectRowHash($table, $select, [$where_href]);
199 # Return: $hash{ col } = value;
200 # Note: useful for returning only one/first row of data.
201 sub sqlSelectRowHash {
202 my $sth = &sqlSelectMany(@_);
204 &WARN("sqlSelectRowHash failed.");
207 my $retval = $sth->fetchrow_hashref();
218 # End of SELECT functions.
222 # Usage: &sqlSet($table, $where_href, $data_href);
223 # Return: 1 for success, undef for failure.
225 my ($table, $where_href, $data_href) = @_;
227 if (!defined $table or $table =~ /^\s*$/) {
228 &WARN("sqlSet: table == NULL.");
232 if (!defined $data_href or ref($data_href) ne "HASH") {
233 &WARN("sqlSet: data_href == NULL.");
237 # any column can be NULL... so just get them all.
238 my $k = join(',', keys %{ $where_href } );
239 my $result = &sqlSelect($table, $k, $where_href);
240 # &DEBUG("result is not defined :(") if (!defined $result);
242 if (1 or defined $result) {
243 &sqlUpdate($table, $data_href, $where_href);
246 my %hash = %{ $where_href };
247 # add data_href values...
248 foreach (keys %{ $data_href }) {
249 $hash{ $_ } = ${ $data_href }{$_};
253 &sqlInsert($table, $data_href);
260 # Usage: &sqlUpdate($table, $data_href, $where_href);
262 my ($table, $data_href, $where_href) = @_;
264 if (!defined $data_href or ref($data_href) ne "HASH") {
265 &WARN("sqlSet: data_href == NULL.");
269 my $where = &hashref2where($where_href) if ($where_href);
270 my $update = &hashref2update($data_href) if ($data_href);
272 &sqlRaw("Update", "UPDATE $table SET $update WHERE $where");
278 # Usage: &sqlInsert($table, $data_href, $other);
280 my ($table, $data_href, $other) = @_;
281 # note: if $other == 1, add "DELAYED" to function instead.
283 if (!defined $data_href or ref($data_href) ne "HASH") {
284 &WARN("sqlInsert: data_href == NULL.");
288 my ($k_aref, $v_aref) = &hashref2array($data_href);
289 my @k = @{ $k_aref };
290 my @v = @{ $v_aref };
293 &WARN("sqlInsert: keys or vals is NULL.");
297 &sqlRaw("Insert($table)", sprintf(
298 "INSERT %s INTO %s (%s) VALUES (%s)",
299 ($other || ""), $table, join(',',@k), join(',',@v)
306 # Usage: &sqlReplace($table, $data_href);
308 my ($table, $data_href) = @_;
310 if (!defined $data_href or ref($data_href) ne "HASH") {
311 &WARN("sqlReplace: data_href == NULL.");
315 my ($k_aref, $v_aref) = &hashref2array($data_href);
316 my @k = @{ $k_aref };
317 my @v = @{ $v_aref };
320 &WARN("sqlReplace: keys or vals is NULL.");
324 &sqlRaw("Replace($table)", sprintf(
325 "REPLACE INTO %s (%s) VALUES (%s)",
326 $table, join(',',@k), join(',',@v)
333 # Usage: &sqlDelete($table, $where_href);
335 my ($table, $where_href) = @_;
337 if (!defined $where_href or ref($where_href) ne "HASH") {
338 &WARN("sqlDelete: where_href == NULL.");
342 my $where = &hashref2where($where_href);
344 &sqlRaw("Delete", "DELETE FROM $table WHERE $where");
350 # Usage: &sqlRaw($prefix, $query);
351 # Return: 1 for success, 0 for failure.
353 my ($prefix, $query) = @_;
356 if (!defined $query or $query =~ /^\s*$/) {
357 &WARN("sqlRaw: query == NULL.");
361 if (!($sth = $dbh->prepare($query))) {
362 &ERROR("Raw($prefix): !prepare => '$query'");
367 if (!$sth->execute) {
368 &ERROR("Raw($prefix): !execute => '$query'");
379 # Usage: &sqlRawReturn($query);
386 if (!defined $query or $query =~ /^\s*$/) {
387 &WARN("sqlRawReturn: query == NULL.");
391 if (!($sth = $dbh->prepare($query))) {
392 &ERROR("RawReturn: !prepare => '$query'");
397 if (!$sth->execute) {
398 &ERROR("RawReturn: !execute => '$query'");
403 while (my @row = $sth->fetchrow_array) {
404 push(@retval, $row[0]);
412 ####################################################################
413 ##### Misc DBI stuff...
419 if (!defined $href) {
420 &WARN("hashref2where: href == NULL.");
424 if (ref($href) ne "HASH") {
425 &WARN("hashref2where: href is not HASH ref (href => $href)");
429 my %hash = %{ $href };
430 foreach (keys %hash) {
433 if (s/^-//) { # as is.
435 delete $hash{'-'.$_};
437 $hash{$_} = &sqlQuote($v);
441 return join(' AND ', map { $_."=".$hash{$_} } keys %hash );
447 if (ref($href) ne "HASH") {
448 &WARN("hashref2update: href is not HASH ref.");
453 foreach (keys %{ $href }) {
455 my $v = ${ $href }{$_};
457 # is there a better way to do this?
458 if ($k =~ s/^-//) { # as is.
467 return join(', ', map { $_."=".$hash{$_} } sort keys %hash);
473 if (ref($href) ne "HASH") {
474 &WARN("hashref2update: href is not HASH ref.");
479 foreach (keys %{ $href }) {
481 my $v = ${ $href }{$_};
483 # is there a better way to do this?
484 if ($k =~ s/^-//) { # as is.
498 # Usage: &countKeys($table, [$col]);
500 my ($table, $col) = @_;
502 &DEBUG("&countKeys($table, $col);");
504 return (&sqlRawReturn("SELECT count($col) FROM $table"))[0];
508 # Usage: &sumKey($table, $col);
510 my ($table, $col) = @_;
512 return (&sqlRawReturn("SELECT sum($col) FROM $table"))[0];
516 # Usage: &randKey($table, $select);
518 my ($table, $select) = @_;
519 my $rand = int(rand(&countKeys($table) - 1));
520 my $query = "SELECT $select FROM $table LIMIT $rand,1";
521 if ($param{DBType} =~ /^pg/i) {
522 $query =~ s/$rand,1/1,$rand/;
525 my $sth = $dbh->prepare($query);
527 &WARN("randKey($query)") unless $sth->execute;
528 my @retval = $sth->fetchrow_array;
535 # Usage: &deleteTable($table);
537 &sqlRaw("deleteTable($_[0])", "DELETE FROM $_[0]");
541 # Usage: &searchTable($table, $select, $key, $str);
542 # Note: searchTable does dbQuote.
544 my($table, $select, $key, $str) = @_;
548 # allow two types of wildcards.
549 if ($str =~ /^\^(.*)\$$/) {
550 &DEBUG("searchTable: should use dbGet(), heh.");
553 $str .= "%" if ($str =~ s/^\^//);
554 $str = "%".$str if ($str =~ s/\$$//);
555 $str = "%".$str."%" if ($str eq $origStr); # el-cheapo fix.
559 $str =~ s/\?/_/g; # '.' should be supported, too.
563 my $query = "SELECT $select FROM $table WHERE $key LIKE ".
565 my $sth = $dbh->prepare($query);
568 if (!$sth->execute) {
569 &WARN("Search($query)");
574 while (my @row = $sth->fetchrow_array) {
575 push(@results, $row[0]);
584 my(@path) = ($bot_data_dir, ".","..","../..");
589 my $file = "$_/setup/$table.sql";
590 &DEBUG("dbCT: table => '$table', file => '$file'");
591 next unless ( -f $file );
593 &DEBUG("dbCT: found!!!");
608 &sqlRaw("sqlCreateTable($table)", $data);
614 my $database_exists = 0;
617 if ($param{DBType} =~ /^mysql$/i) {
618 my $sql = "SHOW DATABASES";
619 foreach ( &sqlRawReturn($sql) ) {
620 $database_exists++ if ($_ eq $param{'DBName'});
623 unless ($database_exists) {
624 &status("Creating database $param{DBName}...");
625 my $query = "CREATE DATABASE $param{DBName}";
626 &sqlRaw("create(db $param{DBName})", $query);
629 # retrieve a list of db's from the server.
630 foreach ($dbh->func('_ListTables')) {
634 } elsif ($param{DBType} =~ /^SQLite$/i) {
636 # retrieve a list of db's from the server.
637 foreach ( &sqlRawReturn("SELECT name FROM sqlite_master WHERE type='table'") ) {
642 if (!scalar keys %db) {
643 &status("Creating database $param{'DBName'}...");
644 my $query = "CREATE DATABASE $param{'DBName'}";
645 &sqlRaw("create(db $param{'DBName'})", $query);
649 foreach ( qw(factoids freshmeat rootwarn seen stats botmail) ) {
650 next if (exists $db{$_});
651 &status("checkTables: creating new table $_...");