/usr/share/perl5/Wiki/Toolkit/Setup/Pg.pm is in libwiki-toolkit-perl 0.85-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | package Wiki::Toolkit::Setup::Pg;
use strict;
use vars qw( @ISA $VERSION $SCHEMA_VERSION );
use Wiki::Toolkit::Setup::Database;
@ISA = qw( Wiki::Toolkit::Setup::Database );
$VERSION = '0.10';
use DBI;
use Carp;
$SCHEMA_VERSION = $VERSION*100;
my $create_sql = {
8 => {
schema_info => [ qq|
CREATE TABLE schema_info (
version integer NOT NULL default 0
)
|, qq|
INSERT INTO schema_info VALUES (8)
| ],
node => [ qq|
CREATE SEQUENCE node_seq
|, qq|
CREATE TABLE node (
id integer NOT NULL DEFAULT NEXTVAL('node_seq'),
name varchar(200) NOT NULL DEFAULT '',
version integer NOT NULL default 0,
text text NOT NULL default '',
modified timestamp without time zone default NULL,
CONSTRAINT pk_id PRIMARY KEY (id)
)
|, qq|
CREATE UNIQUE INDEX node_name ON node (name)
| ],
content => [ qq|
CREATE TABLE content (
node_id integer NOT NULL,
version integer NOT NULL default 0,
text text NOT NULL default '',
modified timestamp without time zone default NULL,
comment text NOT NULL default '',
CONSTRAINT pk_node_id PRIMARY KEY (node_id,version),
CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
)
| ],
internal_links => [ qq|
CREATE TABLE internal_links (
link_from varchar(200) NOT NULL default '',
link_to varchar(200) NOT NULL default ''
)
|, qq|
CREATE UNIQUE INDEX internal_links_pkey ON internal_links (link_from, link_to)
| ],
metadata => [ qq|
CREATE TABLE metadata (
node_id integer NOT NULL,
version integer NOT NULL default 0,
metadata_type varchar(200) NOT NULL DEFAULT '',
metadata_value text NOT NULL DEFAULT '',
CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
)
|, qq|
CREATE INDEX metadata_index ON metadata (node_id, version, metadata_type, metadata_value)
| ]
},
9 => {
schema_info => [ qq|
CREATE TABLE schema_info (
version integer NOT NULL default 0
)
|, qq|
INSERT INTO schema_info VALUES (9)
| ],
node => [ qq|
CREATE SEQUENCE node_seq
|, qq|
CREATE TABLE node (
id integer NOT NULL DEFAULT NEXTVAL('node_seq'),
name varchar(200) NOT NULL DEFAULT '',
version integer NOT NULL default 0,
text text NOT NULL default '',
modified timestamp without time zone default NULL,
moderate boolean NOT NULL default '0',
CONSTRAINT pk_id PRIMARY KEY (id)
)
|, qq|
CREATE UNIQUE INDEX node_name ON node (name)
| ],
content => [ qq|
CREATE TABLE content (
node_id integer NOT NULL,
version integer NOT NULL default 0,
text text NOT NULL default '',
modified timestamp without time zone default NULL,
comment text NOT NULL default '',
moderated boolean NOT NULL default '1',
CONSTRAINT pk_node_id PRIMARY KEY (node_id,version),
CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
)
| ],
internal_links => [ qq|
CREATE TABLE internal_links (
link_from varchar(200) NOT NULL default '',
link_to varchar(200) NOT NULL default ''
)
|, qq|
CREATE UNIQUE INDEX internal_links_pkey ON internal_links (link_from, link_to)
| ],
metadata => [ qq|
CREATE TABLE metadata (
node_id integer NOT NULL,
version integer NOT NULL default 0,
metadata_type varchar(200) NOT NULL DEFAULT '',
metadata_value text NOT NULL DEFAULT '',
CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
)
|, qq|
CREATE INDEX metadata_index ON metadata (node_id, version, metadata_type, metadata_value)
| ]
},
10 => {
schema_info => [ qq|
CREATE TABLE schema_info (
version integer NOT NULL default 0
)
|, qq|
INSERT INTO schema_info VALUES (10)
| ],
node => [ qq|
CREATE SEQUENCE node_seq
|, qq|
CREATE TABLE node (
id integer NOT NULL DEFAULT NEXTVAL('node_seq'),
name varchar(200) NOT NULL DEFAULT '',
version integer NOT NULL default 0,
text text NOT NULL default '',
modified timestamp without time zone default NULL,
moderate boolean NOT NULL default '0',
CONSTRAINT pk_id PRIMARY KEY (id)
)
|, qq|
CREATE UNIQUE INDEX node_name ON node (name)
| ],
content => [ qq|
CREATE TABLE content (
node_id integer NOT NULL,
version integer NOT NULL default 0,
text text NOT NULL default '',
modified timestamp without time zone default NULL,
comment text NOT NULL default '',
moderated boolean NOT NULL default '1',
verified timestamp without time zone default NULL,
verified_info text NOT NULL default '',
CONSTRAINT pk_node_id PRIMARY KEY (node_id,version),
CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
)
| ],
internal_links => [ qq|
CREATE TABLE internal_links (
link_from varchar(200) NOT NULL default '',
link_to varchar(200) NOT NULL default ''
)
|, qq|
CREATE UNIQUE INDEX internal_links_pkey ON internal_links (link_from, link_to)
| ],
metadata => [ qq|
CREATE TABLE metadata (
node_id integer NOT NULL,
version integer NOT NULL default 0,
metadata_type varchar(200) NOT NULL DEFAULT '',
metadata_value text NOT NULL DEFAULT '',
CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
)
|, qq|
CREATE INDEX metadata_index ON metadata (node_id, version, metadata_type, metadata_value)
| ]
},
};
my %upgrades = (
old_to_8 => [ qq|
CREATE SEQUENCE node_seq;
ALTER TABLE node ADD COLUMN id INTEGER;
UPDATE node SET id = NEXTVAL('node_seq');
|, qq|
ALTER TABLE node ALTER COLUMN id SET NOT NULL;
ALTER TABLE node ALTER COLUMN id SET DEFAULT NEXTVAL('node_seq');
|, qq|
DROP INDEX node_pkey;
ALTER TABLE node ADD CONSTRAINT pk_id PRIMARY KEY (id);
CREATE UNIQUE INDEX node_name ON node (name)
|,
qq|
ALTER TABLE content ADD COLUMN node_id INTEGER;
UPDATE content SET node_id =
(SELECT id FROM node where node.name = content.name)
|, qq|
DELETE FROM content WHERE node_id IS NULL;
ALTER TABLE content ALTER COLUMN node_id SET NOT NULL;
ALTER TABLE content DROP COLUMN name;
ALTER TABLE content ADD CONSTRAINT pk_node_id PRIMARY KEY (node_id,version);
ALTER TABLE content ADD CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id)
|,
qq|
ALTER TABLE metadata ADD COLUMN node_id INTEGER;
UPDATE metadata SET node_id =
(SELECT id FROM node where node.name = metadata.node)
|, qq|
DELETE FROM metadata WHERE node_id IS NULL;
ALTER TABLE metadata ALTER COLUMN node_id SET NOT NULL;
ALTER TABLE metadata DROP COLUMN node;
ALTER TABLE metadata ADD CONSTRAINT fk_node_id FOREIGN KEY (node_id) REFERENCES node (id);
CREATE INDEX metadata_index ON metadata (node_id, version, metadata_type, metadata_value)
|,
qq|
CREATE TABLE schema_info (version integer NOT NULL default 0);
INSERT INTO schema_info VALUES (8)
|
],
'8_to_9' => [ qq|
ALTER TABLE node ADD COLUMN moderate boolean;
UPDATE node SET moderate = '0';
ALTER TABLE node ALTER COLUMN moderate SET DEFAULT '0';
ALTER TABLE node ALTER COLUMN moderate SET NOT NULL;
|, qq|
ALTER TABLE content ADD COLUMN moderated boolean;
UPDATE content SET moderated = '1';
ALTER TABLE content ALTER COLUMN moderated SET DEFAULT '1';
ALTER TABLE content ALTER COLUMN moderated SET NOT NULL;
UPDATE schema_info SET version = 9;
|
],
'9_to_10' => [ qq|
ALTER TABLE content ADD COLUMN verified timestamp without time zone default NULL;
ALTER TABLE content ADD COLUMN verified_info text NOT NULL default '';
|, qq|
UPDATE schema_info SET version = 10;
|
],
);
my @old_to_10 = ($upgrades{'old_to_8'},$upgrades{'8_to_9'},$upgrades{'9_to_10'});
my @eight_to_10 = ($upgrades{'8_to_9'},$upgrades{'9_to_10'});
$upgrades{'old_to_10'} = \@old_to_10;
$upgrades{'8_to_10'} = \@eight_to_10;
=head1 NAME
Wiki::Toolkit::Setup::Pg - Set up tables for a Wiki::Toolkit store in a Postgres database.
=head1 SYNOPSIS
use Wiki::Toolkit::Setup::Pg;
Wiki::Toolkit::Setup::Pg::setup($dbname, $dbuser, $dbpass, $dbhost);
Omit $dbhost if the database is local.
=head1 DESCRIPTION
Set up a Postgres database for use as a Wiki::Toolkit store.
=head1 FUNCTIONS
=over 4
=item B<setup>
use Wiki::Toolkit::Setup::Pg;
Wiki::Toolkit::Setup::Pg::setup($dbname, $dbuser, $dbpass, $dbhost);
or
Wiki::Toolkit::Setup::Pg::setup( $dbh );
You can either provide an active database handle C<$dbh> or connection
parameters.
If you provide connection parameters the following arguments are
mandatory -- the database name, the username and the password. The
username must be able to create and drop tables in the database.
The $dbhost argument is optional -- omit it if the database is local.
B<NOTE:> If a table that the module wants to create already exists,
C<setup> will leave it alone. This means that you can safely run this
on an existing L<Wiki::Toolkit> database to bring the schema up to date
with the current L<Wiki::Toolkit> version. If you wish to completely start
again with a fresh database, run C<cleardb> first.
=cut
sub setup {
my @args = @_;
my $dbh = _get_dbh( @args );
my $disconnect_required = _disconnect_required( @args );
my $wanted_schema = _get_wanted_schema( @args ) || $SCHEMA_VERSION;
die "No schema information for requested schema version $wanted_schema\n"
unless $create_sql->{$wanted_schema};
# Check whether tables exist
my $sql = "SELECT tablename FROM pg_tables
WHERE tablename in ("
. join( ",", map { $dbh->quote($_) } keys %{$create_sql->{$wanted_schema}} ) . ")";
my $sth = $dbh->prepare($sql) or croak $dbh->errstr;
$sth->execute;
my %tables;
while ( my $table = $sth->fetchrow_array ) {
exists $create_sql->{$wanted_schema}->{$table} and $tables{$table} = 1;
}
# Do we need to upgrade the schema of existing tables?
# (Don't check if no tables currently exist)
my $upgrade_schema;
if(scalar keys %tables > 0) {
$upgrade_schema = Wiki::Toolkit::Setup::Database::get_database_upgrade_required($dbh,$wanted_schema);
} else {
print "Skipping schema upgrade check - no tables found\n";
}
# Set up tables if not found
foreach my $required ( reverse sort keys %{$create_sql->{$wanted_schema}} ) {
if ( $tables{$required} ) {
print "Table $required already exists... skipping...\n";
} else {
print "Creating table $required... done\n";
foreach my $sql ( @{ $create_sql->{$wanted_schema}->{$required} } ) {
$dbh->do($sql) or croak $dbh->errstr;
}
}
}
# Do the upgrade if required
if($upgrade_schema) {
print "Upgrading schema: $upgrade_schema\n";
my @updates = @{$upgrades{$upgrade_schema}};
foreach my $update (@updates) {
if(ref($update) eq "CODE") {
&$update($dbh);
} elsif(ref($update) eq "ARRAY") {
foreach my $nupdate (@$update) {
$dbh->do($nupdate);
}
} else {
$dbh->do($update);
}
}
}
# Clean up if we made our own dbh.
$dbh->disconnect if $disconnect_required;
}
=item B<cleardb>
use Wiki::Toolkit::Setup::Pg;
# Clear out all Wiki::Toolkit tables from the database.
Wiki::Toolkit::Setup::Pg::cleardb($dbname, $dbuser, $dbpass, $dbhost);
or
Wiki::Toolkit::Setup::Pg::cleardb( $dbh );
You can either provide an active database handle C<$dbh> or connection
parameters.
If you provide connection parameters the following arguments are
mandatory -- the database name, the username and the password. The
username must be able to drop tables in the database.
The $dbhost argument is optional -- omit it if the database is local.
Clears out all L<Wiki::Toolkit> store tables from the database. B<NOTE>
that this will lose all your data; you probably only want to use this
for testing purposes or if you really screwed up somewhere. Note also
that it doesn't touch any L<Wiki::Toolkit> search backend tables; if you
have any of those in the same or a different database see
L<Wiki::Toolkit::Setup::DBIxFTS> or L<Wiki::Toolkit::Setup::SII>, depending on
which search backend you're using.
=cut
sub cleardb {
my @args = @_;
my $dbh = _get_dbh( @args );
my $disconnect_required = _disconnect_required( @args );
print "Dropping tables... ";
my $sql = "SELECT tablename FROM pg_tables
WHERE tablename in ("
. join( ",", map { $dbh->quote($_) } keys %{$create_sql->{$SCHEMA_VERSION}} ) . ")";
foreach my $tableref (@{$dbh->selectall_arrayref($sql)}) {
$dbh->do("DROP TABLE $tableref->[0] CASCADE") or croak $dbh->errstr;
}
$sql = "SELECT relname FROM pg_statio_all_sequences
WHERE relname = 'node_seq'";
foreach my $seqref (@{$dbh->selectall_arrayref($sql)}) {
$dbh->do("DROP SEQUENCE $seqref->[0]") or croak $dbh->errstr;
}
print "done\n";
# Clean up if we made our own dbh.
$dbh->disconnect if $disconnect_required;
}
sub _get_dbh {
# Database handle passed in.
if ( ref $_[0] and ref $_[0] eq 'DBI::db' ) {
return $_[0];
}
# Args passed as hashref.
if ( ref $_[0] and ref $_[0] eq 'HASH' ) {
my %args = %{$_[0]};
if ( $args{dbh} ) {
return $args{dbh};
} else {
return _make_dbh( %args );
}
}
# Args passed as list of connection details.
return _make_dbh(
dbname => $_[0],
dbuser => $_[1],
dbpass => $_[2],
dbhost => $_[3],
);
}
sub _get_wanted_schema {
# Database handle passed in.
if ( ref $_[0] and ref $_[0] eq 'DBI::db' ) {
return undef;
}
# Args passed as hashref.
if ( ref $_[0] and ref $_[0] eq 'HASH' ) {
my %args = %{$_[0]};
return $args{wanted_schema};
}
}
sub _disconnect_required {
# Database handle passed in.
if ( ref $_[0] and ref $_[0] eq 'DBI::db' ) {
return 0;
}
# Args passed as hashref.
if ( ref $_[0] and ref $_[0] eq 'HASH' ) {
my %args = %{$_[0]};
if ( $args{dbh} ) {
return 0;
} else {
return 1;
}
}
# Args passed as list of connection details.
return 1;
}
sub _make_dbh {
my %args = @_;
my $dsn = "dbi:Pg:dbname=$args{dbname}";
$dsn .= ";host=$args{dbhost}" if $args{dbhost};
my $dbh = DBI->connect($dsn, $args{dbuser}, $args{dbpass},
{ PrintError => 1, RaiseError => 1,
AutoCommit => 1 } )
or croak DBI::errstr;
return $dbh;
}
=back
=head1 ALTERNATIVE CALLING SYNTAX
As requested by Podmaster. Instead of passing arguments to the methods as
($dbname, $dbuser, $dbpass, $dbhost)
you can pass them as
( { dbname => $dbname,
dbuser => $dbuser,
dbpass => $dbpass,
dbhost => $dbhost
}
)
or indeed as
( { dbh => $dbh } )
Note that's a hashref, not a hash.
=head1 AUTHOR
Kake Pugh (kake@earth.li).
=head1 COPYRIGHT
Copyright (C) 2002-2004 Kake Pugh. All Rights Reserved.
Copyright (C) 2006-2008 the Wiki::Toolkit team. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=head1 SEE ALSO
L<Wiki::Toolkit>, L<Wiki::Toolkit::Setup::DBIxFTS>, L<Wiki::Toolkit::Setup::SII>
=cut
1;
|