-
Notifications
You must be signed in to change notification settings - Fork 62
/
DBUTIL.pm
653 lines (491 loc) · 14.9 KB
/
DBUTIL.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
package DBUTIL;
use strict;
use DBI;
use Netdot::Meta::SQLT;
use Data::Dumper;
use Netdot::Config;
=head1 NAME
DBUTIL - Database Utilites
A few subroutines shared by scripts for database initialization and maintenance
=head1 SYNOPSIS
use DBUTIL;
my $dbh = &dbconnect();
&processdata(\@statements);
&dbdisconnect();
=cut
$|=1; #unbuffer output.
my %CONFIG;
my $rel_dir = '../etc';
my $abs_dir = '<<Make:ETC>>';
if ( -d $abs_dir ){
$CONFIG{CONFIG_DIR} = $abs_dir;
}elsif ( -d $rel_dir ){
$CONFIG{CONFIG_DIR} = $rel_dir;
}else{
die "Cannot figure out which etc/ directory to use";
}
$CONFIG{DEBUG} = 1;
$CONFIG{PROMPT} = 1;
$CONFIG{SCHEMA_FILE} = "$CONFIG{CONFIG_DIR}/netdot.meta";
$CONFIG{DEFAULT_DATA} = "$CONFIG{CONFIG_DIR}/default_data";
my $netdot_config = Netdot::Config->new(config_dir => $CONFIG{CONFIG_DIR});
foreach my $var ( qw /DB_TYPE DB_HOME DB_HOST DB_PORT DB_DBA DB_DBA_PASSWORD
DB_NETDOT_USER DB_NETDOT_PASS DB_DATABASE/ ){
$CONFIG{$var} = $netdot_config->get($var);
}
$CONFIG{BINDIR} = "$CONFIG{DB_HOME}/bin";
use vars qw( @ISA @EXPORT $dbh );
use Exporter ();
@ISA = qw(Exporter);
@EXPORT = qw( dbconnect dbdisconnect processdata build_statements init_db drop_db
generate_schema_from_metadata generate_schema_file insert_schema create_db _yesno
initacls_mysql initacls_pg insert_default_data insert_oui db_query );
##################################################
=head2 build_dsn - Construct the DSN for DB connection
Arguments:
Hash with following keys (optional if using config file):
DB_TYPE
DB_DATABASE
DB_HOST
DB_PORT
Returns:
DSN string
Examples:
my $dsn = &build_dsn(DB_TYPE => $db_args{DB_TYPE},
DB_DATABASE => $db_args{DB_DATABASE},
DB_HOST => $db_args{DB_HOST},
DB_PORT => $db_args{DB_PORT});
=cut
sub build_dsn {
my (%argv) = @_;
# Give preference to given args, then use config
my %db_args;
foreach ( qw(DB_TYPE DB_DATABASE DB_HOST DB_PORT) ){
$db_args{$_} = $argv{$_} || $CONFIG{$_};
}
my $dsn = "dbi:$db_args{DB_TYPE}:";
$dsn .= "dbname=$db_args{DB_DATABASE}";
$dsn .= ";host=$db_args{DB_HOST}" if ($db_args{DB_HOST});
$dsn .= ";port=$db_args{DB_PORT}" if ($db_args{DB_PORT});
if ($CONFIG{DB_TYPE} eq "mysql") {
$dsn .= ";mysql_local_infile=1";
}
return $dsn;
}
##################################################
=head2 dbconnect - Connect to database
Arguments:
Hash with following keys (optional if using config file):
DB_TYPE
DB_DATABASE
DB_HOST
DB_PORT
Returns:
DBI handle
Examples:
my $dbh = &dbconnect();
=cut
sub dbconnect {
my (%argv) = @_;
# Give preference to given args, then use config
my %db_args;
foreach ( qw(DB_TYPE DB_DATABASE DB_HOST DB_PORT DB_DBA DB_DBA_PASSWORD) ){
$db_args{$_} = $argv{$_} || $CONFIG{$_};
}
my $dsn = &build_dsn(DB_TYPE => $db_args{DB_TYPE}, DB_DATABASE =>$db_args{DB_DATABASE},
DB_HOST => $db_args{DB_HOST}, DB_PORT =>$db_args{DB_PORT});
print "DEBUG: init: $dsn\n" if $CONFIG{DEBUG};
if( $dbh = DBI->connect( $dsn, $db_args{DB_DBA}, $db_args{DB_DBA_PASSWORD}) ) {
$dbh->{AutoCommit} = 1;
$dbh->{RaiseError} = 1;
print "DEBUG: Connected successfully\n" if $CONFIG{DEBUG};
return $dbh;
} else {
die "Unable to connect to $db_args{DB_TYPE} $db_args{DB_DATABASE} db:"
. " $DBI::errstr\n";
}
}
##################################################
=head2 dbdisconnect - Name says it
Arguments:
None
Returns:
true if successful
Examples:
&dbdisconnect();
=cut
sub dbdisconnect {
if( $dbh->disconnect ) {
print "DEBUG: Disconnected successfully\n" if $CONFIG{DEBUG};
return 1;
} else {
warn "Unable to disconnect from DB\n";
return 0;
}
}
##################################################
=head2 init_db - Initialize database
Arguments:
None
Returns:
Nothing
Examples:
=cut
# This does it all at once, in the right order
sub init_db {
if ( $CONFIG{DB_TYPE} eq "mysql" ){
&create_db();
&initacls_mysql();
&generate_schema_file();
&insert_schema();
}elsif ( $CONFIG{DB_TYPE} eq "Pg" ){
&create_db();
&generate_schema_file();
&insert_schema();
&initacls_pg();
}else{
die '$CONFIG{DB_TYPE} invalid: '.$CONFIG{DB_TYPE} ;
}
&insert_default_data();
print "Database initialized successfully\n";
}
##################################################
=head2 drop_db - Delete Netdot database
Arguments:
None
Returns:
Nothing
Examples:
=cut
sub drop_db {
my $dsn = &build_dsn();
if ( $CONFIG{PROMPT} ) {
print <<END;
About to drop $CONFIG{DB_TYPE} database $CONFIG{DB_DATABASE}.
WARNING: This will erase all data in $CONFIG{DB_DATABASE}.
END
exit unless _yesno();
}
my $dbh;
print "\nDropping $CONFIG{DB_TYPE} database $CONFIG{DB_DATABASE}.\n";
if ($CONFIG{DB_TYPE} eq "mysql") {
$dbh = DBI->connect("dbi:mysql:mysql;host=$CONFIG{DB_HOST};port=$CONFIG{DB_PORT}",
$CONFIG{DB_DBA}, $CONFIG{DB_DBA_PASSWORD}) or die $DBI::errstr;
}elsif ($CONFIG{DB_TYPE} eq "Pg") {
$dbh = DBI->connect("dbi:Pg:dbname=postgres;host=$CONFIG{DB_HOST};port=$CONFIG{DB_PORT}",
$CONFIG{DB_DBA}, $CONFIG{DB_DBA_PASSWORD}) or die $DBI::errstr;
}else {
die "Unrecognized DB_TYPE: $CONFIG{DB_TYPE}\n";
}
$dbh->do("DROP DATABASE $CONFIG{DB_DATABASE};") or die $DBI::errstr;
}
##################################################
=head2 generate_schema_from_metadata
Uses SQL::Translator to generate a schema
file from Netdot metadata
Arguments:
None
Returns:
Array containing statements to create schema
Examples:
=cut
sub generate_schema_from_metadata {
# SQLT uses slightly different names for the db types
my $dbtype;
$dbtype = 'MySQL' if ( $CONFIG{DB_TYPE} eq 'mysql');
$dbtype = 'PostgreSQL' if ( $CONFIG{DB_TYPE} eq 'Pg');
my $meta_file = "$CONFIG{CONFIG_DIR}/$CONFIG{SCHEMA_FILE}";
my $sqlt = Netdot::Meta::SQLT->new(meta_file=>$meta_file);
my $schema = $sqlt->sql_schema($dbtype);
my @schema = grep /[^\n]/, split /\n/, $schema;
return (@schema);
}
##################################################
=head2 generate_schema_file
Writes file to disk with schema statements
Arguments:
None
Returns:
Nothing
Examples:
=cut
sub generate_schema_file {
my @schema = &generate_schema_from_metadata();
print "Generating schema for $CONFIG{DB_TYPE}...";
my $file = "$CONFIG{CONFIG_DIR}/schema.$CONFIG{DB_TYPE}";
system('mv', "$file", "$file.bak") if ( -f $file );
open(SCHEMA, ">$file");
foreach ( @schema ) {
print SCHEMA "$_\n";
}
close(SCHEMA);
print "done.\n";
}
##################################################
=head2 insert_schema
Creates schema by passing schema statements
to database
Arguments:
None
Returns:
Nothing
Examples:
=cut
sub insert_schema {
my @schema;
print "\nCreating database schema.\n";
my $file = "$CONFIG{CONFIG_DIR}/schema.$CONFIG{DB_TYPE}";
if ( -f $file){
open (SCHEMA, "<$file");
foreach (<SCHEMA>) {
push @schema, $_;
}
}else {
@schema = &generate_schema_from_metadata();
}
&db_query(\@schema);
print "Schema inserted sucessfully\n";
}
##################################################
=head2
Arguments:
Returns:
Examples:
=cut
sub create_db {
my $dsn = &build_dsn();
print "\nCreating $CONFIG{DB_TYPE} database $CONFIG{DB_DATABASE}.\n";
if ($CONFIG{DB_TYPE} eq "mysql") {
my $dbh = DBI->connect("dbi:mysql:mysql;host=$CONFIG{DB_HOST};port=$CONFIG{DB_PORT}",
$CONFIG{DB_DBA}, $CONFIG{DB_DBA_PASSWORD})
or die $DBI::errstr;
$dbh->do("CREATE DATABASE $CONFIG{DB_DATABASE} CHARACTER SET = utf8;")
or die $DBI::errstr;
} elsif ($CONFIG{DB_TYPE} eq "Pg") {
my $dbh = DBI->connect("dbi:Pg:dbname=postgres;host=$CONFIG{DB_HOST};port=$CONFIG{DB_PORT}",
$CONFIG{DB_DBA}, $CONFIG{DB_DBA_PASSWORD})
or die $DBI::errstr;
$dbh->do("CREATE DATABASE $CONFIG{DB_DATABASE} WITH ENCODING = 'UTF8' TEMPLATE template0;")
or die $DBI::errstr;
}
}
##################################################
# Prompt for user input
sub _yesno {
print "Proceed [y/N]:";
my $x = scalar(<STDIN>);
$x =~ /^y/i;
}
##################################################
=head2 initacls_mysql
Assign appropriate ACLs to MySQL
Arguments:
None
Returns:
Nothing
Examples:
=cut
sub initacls_mysql {
print "Setting up privileges for MySQL.\n";
my @acl;
push @acl, "DELETE FROM user WHERE user LIKE '$CONFIG{DB_NETDOT_USER}';";
push @acl, "DELETE FROM db WHERE db LIKE '$CONFIG{DB_DATABASE}';";
push @acl, "GRANT SELECT,INSERT,CREATE,INDEX,UPDATE,DELETE ON $CONFIG{DB_DATABASE}.* TO $CONFIG{DB_NETDOT_USER}\@$CONFIG{DB_HOST} IDENTIFIED BY '$CONFIG{DB_NETDOT_PASS}';";
&db_query(\@acl, 'mysql');
system ("$CONFIG{BINDIR}/mysqladmin --host=$CONFIG{DB_HOST} --port=$CONFIG{DB_PORT} --user=$CONFIG{DB_DBA} -p$CONFIG{DB_DBA_PASSWORD} reload");
}
##################################################
# Generate the ACLs for PostgreSQL
# We don't have wildcards like in MySQL ;-(
# so we have to look in the schema file first
#
# TODO: Test this. It might be unnecessary
#
=head2 initacls_pg
Assign appropriate ACLs to PostgreSQL
Arguments:
Returns:
Examples:
=cut
sub initacls_pg {
my $schema = "$CONFIG{CONFIG_DIR}/schema.Pg";
my @acl;
push @acl, "
DROP USER IF EXISTS $CONFIG{DB_NETDOT_USER};
CREATE USER $CONFIG{DB_NETDOT_USER} WITH PASSWORD '$CONFIG{DB_NETDOT_PASS}' NOCREATEDB NOCREATEUSER;
";
print "Now building ACL's for postgres\n";
open (SCHEMA, $schema)
or die "Couldn't open $schema: $!\n";
while (<SCHEMA>){
if ( /CREATE TABLE "(\w+)"/ ){
push @acl, "GRANT SELECT, INSERT, UPDATE, DELETE ON $1 TO $CONFIG{DB_NETDOT_USER};\n";
push @acl, "GRANT SELECT, INSERT, UPDATE, DELETE ON $1_id_seq to $CONFIG{DB_NETDOT_USER};\n";
}
}
&db_query(\@acl);
}
##################################################
=head2 insert_default_data
Insert default data into database
Arguments:
Returns:
Examples:
=cut
sub insert_default_data{
my @data;
# Insert current schema version
# Get version number from library
my $version = `grep 'our \$VERSION' ../lib/Netdot.pm`;
chomp($version);
$version =~ s/.*\=\s+"(.*)";/$1/;
push @data, "INSERT INTO schemainfo (version) VALUES('$version');";
my $file = $CONFIG{DEFAULT_DATA};
if ( -f $file) {
open (DEFAULT, "<$file") or die "Can't open $file: $!";
foreach (<DEFAULT>) {
next unless ( /\w+/ );
push @data, $_;
}
}else{
die "Can't find $file";
}
print "Inserting default data\n";
&db_query(\@data);
}
##################################################
=head2 insert_oui
Insert IEEE OUI data into database
Arguments:
Returns:
Examples:
=cut
sub insert_oui{
my $oui_file = "oui.txt";
unless ( -r $oui_file ){
print " $oui_file not found! Using default file in package.\n";
$oui_file = "oui.txt.default";
}
unless ( -r $oui_file ){
print " $oui_file not found!\n";
die "Please run ''make oui'' to download oui.txt.\n";
}
my @data;
print "Removing old contents of oui table in database.\n";
push @data, "DELETE FROM oui WHERE true;";
&db_query(\@data);
my %oui;
open (OUI, "<:encoding(iso-8859-1)","$oui_file") or die "Can't open $oui_file: $!\n";
while (my $line = <OUI>){
chomp $line;
if ($line =~ /^\s*([0-9A-F]{6})\s+\(base 16\)\s+(.*)\s*$/i){
$oui{$1} = $2;
}
}
close (OUI);
@data = ();
$oui_file = "/tmp/oui.txt";
open (OUI, ">:encoding(iso-8859-1)",$oui_file) or die "Can't open $oui_file: $!\n";
foreach my $oui ( keys %oui ){
my $vendor = $oui{$oui};
$vendor =~ s/\'/''/g;
$oui = uc($oui);
print "$oui : $vendor\n" if $CONFIG{DEBUG};
print OUI "$oui\t$vendor\n";
}
close(OUI);
if ($CONFIG{DB_TYPE} eq 'mysql') {
push @data, "LOAD DATA LOCAL INFILE '$oui_file' INTO TABLE oui (oui, vendor);"
} elsif ($CONFIG{DB_TYPE} eq 'Pg') {
push @data, "COPY oui(oui, vendor) FROM '$oui_file';"
}
&db_query(\@data);
unlink($oui_file);
my $oui_count = scalar keys %oui;
print "Inserted $oui_count entries from oui.txt\n";
}
##################################################
=head2 build_statements
Convert lines into complete statements if needed
Arguments:
Arrayref with SQL statements
Returns:
Arrayref
Examples:
=cut
sub build_statements{
my ($lines) = @_;
my @statements;
my $statement = "";
foreach my $line ( @$lines ) {
$statement .= $line;
if ($line =~ /;\s*$/) {
$statement =~ s/;$//g;
push @statements, $statement;
$statement = "";
}
}
return \@statements;
}
##################################################
=head2 processdata - Pass statements to database
Arguments:
Arrayref of SQL statements
Returns:
True
Examples:
=cut
sub processdata {
my ($lines) = @_;
$lines = &build_statements($lines);
my $rows = 0;
while (my $cmd = shift @$lines ){
$cmd =~ /^(.*)$/;
chomp($cmd);
print "DEBUG: ($cmd): \n" if $CONFIG{DEBUG};
eval {
$rows = $dbh->do( $cmd );
};
if ( my $e = $@ ){
# We will let the process continue
warn "ERROR while executing $cmd: $e\n";
}else{
print "rows affected: $rows\n" if $CONFIG{DEBUG};
}
}
return 1;
}
##################################################
=head2 db_query
Connect, issue queries and disconnect all at once
Arguments
$query - arrayref of SQL statements
$db - Database name
Returns
nothing
=cut
sub db_query{
my ($query, $db) = @_;
$db ||= $CONFIG{DB_DATABASE};
if ( &dbconnect(DB_DATABASE=>$db) ){
die "Error with db query" unless &processdata($query);
&dbdisconnect();
}
}
1;
=head1 AUTHOR
Carlos Vicente, C<< <cvicente at ns.uoregon.edu> >>
=head1 COPYRIGHT & LICENSE
Copyright 2012 University of Oregon, all rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
=cut