Upgrade to 4.0.13
[usit-rt.git] / sbin / rt-setup-database
CommitLineData
84fb5b46
MKG
1#!/usr/bin/perl
2# BEGIN BPS TAGGED BLOCK {{{
3#
4# COPYRIGHT:
5#
403d7b0b 6# This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
84fb5b46
MKG
7# <sales@bestpractical.com>
8#
9# (Except where explicitly superseded by other copyright notices)
10#
11#
12# LICENSE:
13#
14# This work is made available to you under the terms of Version 2 of
15# the GNU General Public License. A copy of that license should have
16# been provided with this software, but in any event can be snarfed
17# from www.gnu.org.
18#
19# This work is distributed in the hope that it will be useful, but
20# WITHOUT ANY WARRANTY; without even the implied warranty of
21# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22# General Public License for more details.
23#
24# You should have received a copy of the GNU General Public License
25# along with this program; if not, write to the Free Software
26# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27# 02110-1301 or visit their web page on the internet at
28# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
29#
30#
31# CONTRIBUTION SUBMISSION POLICY:
32#
33# (The following paragraph is not intended to limit the rights granted
34# to you to modify and distribute this software under the terms of
35# the GNU General Public License and is only of importance to you if
36# you choose to contribute your changes and enhancements to the
37# community by submitting them to Best Practical Solutions, LLC.)
38#
39# By intentionally submitting any modifications, corrections or
40# derivatives to this work, or any other work intended for use with
41# Request Tracker, to Best Practical Solutions, LLC, you confirm that
42# you are the copyright holder for those contributions and you grant
43# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
44# royalty-free, perpetual, license to use, copy, create derivative
45# works based on those contributions, and sublicense and distribute
46# those contributions and any derivatives thereof.
47#
48# END BPS TAGGED BLOCK }}}
49use strict;
50use warnings;
51
52use vars qw($Nobody $SystemUser $item);
53
54# fix lib paths, some may be relative
55BEGIN {
56 require File::Spec;
57 my @libs = ("lib", "local/lib");
58 my $bin_path;
59
60 for my $lib (@libs) {
61 unless ( File::Spec->file_name_is_absolute($lib) ) {
62 unless ($bin_path) {
63 if ( File::Spec->file_name_is_absolute(__FILE__) ) {
64 $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
65 }
66 else {
67 require FindBin;
68 no warnings "once";
69 $bin_path = $FindBin::Bin;
70 }
71 }
72 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
73 }
74 unshift @INC, $lib;
75 }
76
77}
78
79use Term::ReadKey;
80use Getopt::Long;
81
82$| = 1; # unbuffer all output.
83
84my %args = (
85 dba => 'postgres',
86);
87GetOptions(
88 \%args,
89 'action=s',
90 'force', 'debug',
91 'dba=s', 'dba-password=s', 'prompt-for-dba-password',
92 'datafile=s', 'datadir=s', 'skip-create', 'root-password-file=s',
93 'help|h',
94);
95
96no warnings 'once';
97if ( $args{help} || ! $args{'action'} ) {
98 require Pod::Usage;
99 Pod::Usage::pod2usage({ verbose => 2 });
100 exit;
101}
102
103require RT;
104RT->LoadConfig();
105RT->InitClasses();
106
107# Force warnings to be output to STDERR if we're not already logging
108# them at a higher level
109RT->Config->Set( LogToScreen => 'warning')
110 unless ( RT->Config->Get( 'LogToScreen' )
111 && RT->Config->Get( 'LogToScreen' ) =~ /^(debug|info|notice)$/ );
112
113# get customized root password
114my $root_password;
115if ( $args{'root-password-file'} ) {
116 open( my $fh, '<', $args{'root-password-file'} )
117 or die "Couldn't open 'args{'root-password-file'}' for reading: $!";
118 $root_password = <$fh>;
119 chomp $root_password;
120 my $min_length = RT->Config->Get('MinimumPasswordLength');
121 if ($min_length) {
122 die
123"password needs to be at least $min_length long, please check file '$args{'root-password-file'}'"
124 if length $root_password < $min_length;
125 }
126 close $fh;
127}
128
129
130# check and setup @actions
131my @actions = grep $_, split /,/, $args{'action'};
132if ( @actions > 1 && $args{'datafile'} ) {
133 print STDERR "You can not use --datafile option with multiple actions.\n";
134 exit(-1);
135}
136foreach ( @actions ) {
137 unless ( /^(?:init|create|drop|schema|acl|coredata|insert|upgrade)$/ ) {
138 print STDERR "$0 called with an invalid --action parameter.\n";
139 exit(-1);
140 }
141 if ( /^(?:init|drop|upgrade)$/ && @actions > 1 ) {
142 print STDERR "You can not mix init, drop or upgrade action with any action.\n";
143 exit(-1);
144 }
145}
146
147# convert init to multiple actions
148my $init = 0;
149if ( $actions[0] eq 'init' ) {
150 if ($args{'skip-create'}) {
151 @actions = qw(schema coredata insert);
152 } else {
153 @actions = qw(create schema acl coredata insert);
154 }
155 $init = 1;
156}
157
158# set options from environment
159foreach my $key(qw(Type Host Name User Password)) {
160 next unless exists $ENV{ 'RT_DB_'. uc $key };
161 print "Using Database$key from RT_DB_". uc($key) ." environment variable.\n";
162 RT->Config->Set( "Database$key", $ENV{ 'RT_DB_'. uc $key });
163}
164
165my $db_type = RT->Config->Get('DatabaseType') || '';
166my $db_host = RT->Config->Get('DatabaseHost') || '';
167my $db_name = RT->Config->Get('DatabaseName') || '';
168my $db_user = RT->Config->Get('DatabaseUser') || '';
169my $db_pass = RT->Config->Get('DatabasePassword') || '';
170
171# load it here to get error immidiatly if DB type is not supported
172require RT::Handle;
173
174if ( $db_type eq 'SQLite' && !File::Spec->file_name_is_absolute($db_name) ) {
175 $db_name = File::Spec->catfile($RT::VarPath, $db_name);
176 RT->Config->Set( DatabaseName => $db_name );
177}
178
179my $dba_user = $args{'dba'} || $ENV{'RT_DBA_USER'} || $db_user || '';
180my $dba_pass = $args{'dba-password'} || $ENV{'RT_DBA_PASSWORD'};
181
182if ($args{'skip-create'}) {
183 $dba_user = $db_user;
184 $dba_pass = $db_pass;
185} else {
186 if ( !$args{force} && ( !defined $dba_pass || $args{'prompt-for-dba-password'} ) ) {
187 $dba_pass = get_dba_password();
188 chomp $dba_pass if defined($dba_pass);
189 }
190}
191
192print "Working with:\n"
193 ."Type:\t$db_type\nHost:\t$db_host\nName:\t$db_name\n"
194 ."User:\t$db_user\nDBA:\t$dba_user" . ($args{'skip-create'} ? ' (No DBA)' : '') . "\n";
195
196foreach my $action ( @actions ) {
197 no strict 'refs';
198 my ($status, $msg) = *{ 'action_'. $action }{'CODE'}->( %args );
199 error($action, $msg) unless $status;
200 print $msg .".\n" if $msg;
201 print "Done.\n";
202}
203
204sub action_create {
205 my %args = @_;
206 my $dbh = get_system_dbh();
5b0d0914 207 my ($status, $msg) = RT::Handle->CheckCompatibility( $dbh, 'create' );
84fb5b46
MKG
208 return ($status, $msg) unless $status;
209
210 print "Now creating a $db_type database $db_name for RT.\n";
211 return RT::Handle->CreateDatabase( $dbh );
212}
213
214sub action_drop {
215 my %args = @_;
216
217 print "Dropping $db_type database $db_name.\n";
218 unless ( $args{'force'} ) {
219 print <<END;
220
221About to drop $db_type database $db_name on $db_host.
222WARNING: This will erase all data in $db_name.
223
224END
225 exit(-2) unless _yesno();
226 }
227
228 my $dbh = get_system_dbh();
229 return RT::Handle->DropDatabase( $dbh );
230}
231
232sub action_schema {
233 my %args = @_;
234 my $dbh = get_admin_dbh();
5b0d0914 235 my ($status, $msg) = RT::Handle->CheckCompatibility( $dbh, 'schema' );
84fb5b46
MKG
236 return ($status, $msg) unless $status;
237
238 print "Now populating database schema.\n";
239 return RT::Handle->InsertSchema( $dbh, $args{'datafile'} || $args{'datadir'} );
240}
241
242sub action_acl {
243 my %args = @_;
244 my $dbh = get_admin_dbh();
5b0d0914 245 my ($status, $msg) = RT::Handle->CheckCompatibility( $dbh, 'acl' );
84fb5b46
MKG
246 return ($status, $msg) unless $status;
247
248 print "Now inserting database ACLs.\n";
249 return RT::Handle->InsertACL( $dbh, $args{'datafile'} || $args{'datadir'} );
250}
251
252sub action_coredata {
253 my %args = @_;
254 $RT::Handle = RT::Handle->new;
255 $RT::Handle->dbh( undef );
256 RT::ConnectToDatabase();
257 RT::InitLogging();
5b0d0914 258 my ($status, $msg) = RT::Handle->CheckCompatibility( $RT::Handle->dbh, 'coredata' );
84fb5b46
MKG
259 return ($status, $msg) unless $status;
260
261 print "Now inserting RT core system objects.\n";
262 return $RT::Handle->InsertInitialData;
263}
264
265sub action_insert {
266 my %args = @_;
267 $RT::Handle = RT::Handle->new;
268 RT::Init();
5b0d0914 269 my ($status, $msg) = RT::Handle->CheckCompatibility( $RT::Handle->dbh, 'insert' );
84fb5b46
MKG
270 return ($status, $msg) unless $status;
271
272 print "Now inserting data.\n";
273 my $file = $args{'datafile'};
274 $file = $RT::EtcPath . "/initialdata" if $init && !$file;
275 $file ||= $args{'datadir'}."/content";
276
277 # Slurp in backcompat
278 my %removed;
279 my @back = @{$args{backcompat} || []};
280 if (@back) {
281 my @lines = do {local @ARGV = @back; <>};
282 for (@lines) {
283 s/\#.*//;
284 next unless /\S/;
285 my ($class, @fields) = split;
286 $class->_BuildTableAttributes;
287 $RT::Logger->debug("Temporarily removing @fields from $class");
288 $removed{$class}{$_} = delete $RT::Record::_TABLE_ATTR->{$class}{$_}
289 for @fields;
290 }
291 }
292
293 my @ret = $RT::Handle->InsertData( $file, $root_password );
294
295 # Put back the fields we chopped off
296 for my $class (keys %removed) {
297 $RT::Record::_TABLE_ATTR->{$class}{$_} = $removed{$class}{$_}
298 for keys %{$removed{$class}};
299 }
300 return @ret;
301}
302
303sub action_upgrade {
304 my %args = @_;
305 my $base_dir = $args{'datadir'} || "./etc/upgrade";
306 return (0, "Couldn't read dir '$base_dir' with upgrade data")
307 unless -d $base_dir || -r _;
308
c36a7e1d 309 my $version_word_regex = join '|', RT::Handle->version_words;
84fb5b46
MKG
310 my $upgrading_from = undef;
311 do {
312 if ( defined $upgrading_from ) {
313 print "Doesn't match #.#.#: ";
314 } else {
315 print "Enter RT version you're upgrading from: ";
316 }
317 $upgrading_from = scalar <STDIN>;
318 chomp $upgrading_from;
319 $upgrading_from =~ s/\s+//g;
c36a7e1d 320 } while $upgrading_from !~ /^\d+\.\d+\.\d+(?:$version_word_regex)?\d*$/;
84fb5b46
MKG
321
322 my $upgrading_to = $RT::VERSION;
323 return (0, "The current version $upgrading_to is lower than $upgrading_from")
324 if RT::Handle::cmp_version( $upgrading_from, $upgrading_to ) > 0;
325
326 return (1, "The version $upgrading_to you're upgrading to is up to date")
327 if RT::Handle::cmp_version( $upgrading_from, $upgrading_to ) == 0;
328
329 my @versions = get_versions_from_to($base_dir, $upgrading_from, undef);
330 return (1, "No DB changes since $upgrading_from")
331 unless @versions;
332
333 if (RT::Handle::cmp_version($versions[-1], $upgrading_to) > 0) {
334 print "\n***** There are upgrades for $versions[-1], which is later than $upgrading_to,\n";
335 print "***** which you are nominally upgrading to. Upgrading to $versions[-1] instead.\n";
336 $upgrading_to = $versions[-1];
337 }
338
339 print "\nGoing to apply following upgrades:\n";
340 print map "* $_\n", @versions;
341
342 {
343 my $custom_upgrading_to = undef;
344 do {
345 if ( defined $custom_upgrading_to ) {
346 print "Doesn't match #.#.#: ";
347 } else {
348 print "\nEnter RT version if you want to stop upgrade at some point,\n";
349 print " or leave it blank if you want apply above upgrades: ";
350 }
351 $custom_upgrading_to = scalar <STDIN>;
352 chomp $custom_upgrading_to;
353 $custom_upgrading_to =~ s/\s+//g;
354 last unless $custom_upgrading_to;
c36a7e1d 355 } while $custom_upgrading_to !~ /^\d+\.\d+\.\d+(?:$version_word_regex)?\d*$/;
84fb5b46
MKG
356
357 if ( $custom_upgrading_to ) {
358 return (
359 0, "The version you entered ($custom_upgrading_to) is lower than\n"
360 ."version you're upgrading from ($upgrading_from)"
361 ) if RT::Handle::cmp_version( $upgrading_from, $custom_upgrading_to ) > 0;
362
363 return (1, "The version you're upgrading to is up to date")
364 if RT::Handle::cmp_version( $upgrading_from, $custom_upgrading_to ) == 0;
365
366 if ( RT::Handle::cmp_version( $RT::VERSION, $custom_upgrading_to ) < 0 ) {
367 print "Version you entered is greater than installed ($RT::VERSION).\n";
368 _yesno() or exit(-2);
369 }
370 # ok, checked everything no let's refresh list
371 $upgrading_to = $custom_upgrading_to;
372 @versions = get_versions_from_to($base_dir, $upgrading_from, $upgrading_to);
373
374 return (1, "No DB changes between $upgrading_from and $upgrading_to")
375 unless @versions;
376
377 print "\nGoing to apply following upgrades:\n";
378 print map "* $_\n", @versions;
379 }
380 }
381
382 print "\nIT'S VERY IMPORTANT TO BACK UP BEFORE THIS STEP\n\n";
383 _yesno() or exit(-2) unless $args{'force'};
384
385 my ( $ret, $msg );
386 foreach my $n ( 0..$#versions ) {
387 my $v = $versions[$n];
388 my @back = grep {-e $_} map {"$base_dir/$versions[$_]/backcompat"} $n+1..$#versions;
389 print "Processing $v\n";
390 my %tmp = (%args, datadir => "$base_dir/$v", datafile => undef, backcompat => \@back);
391 if ( -e "$base_dir/$v/schema.$db_type" ) {
392 ( $ret, $msg ) = action_schema( %tmp );
393 return ( $ret, $msg ) unless $ret;
394 }
395 if ( -e "$base_dir/$v/acl.$db_type" ) {
396 ( $ret, $msg ) = action_acl( %tmp );
397 return ( $ret, $msg ) unless $ret;
398 }
399 if ( -e "$base_dir/$v/content" ) {
400 ( $ret, $msg ) = action_insert( %tmp );
401 return ( $ret, $msg ) unless $ret;
402 }
403 }
404 return 1;
405}
406
407sub get_versions_from_to {
408 my ($base_dir, $from, $to) = @_;
409
410 opendir( my $dh, $base_dir ) or die "couldn't open dir: $!";
411 my @versions = grep -d "$base_dir/$_" && /\d+\.\d+\.\d+/, readdir $dh;
412 closedir $dh;
413
414 return
415 grep defined $to ? RT::Handle::cmp_version($_, $to) <= 0 : 1,
416 grep RT::Handle::cmp_version($_, $from) > 0,
417 sort RT::Handle::cmp_version @versions;
418}
419
420sub error {
421 my ($action, $msg) = @_;
422 print STDERR "Couldn't finish '$action' step.\n\n";
423 print STDERR "ERROR: $msg\n\n";
424 exit(-1);
425}
426
427sub get_dba_password {
428 print "In order to create or update your RT database,"
429 . " this script needs to connect to your "
430 . " $db_type instance on $db_host as $dba_user\n";
431 print "Please specify that user's database password below. If the user has no database\n";
432 print "password, just press return.\n\n";
433 print "Password: ";
434 ReadMode('noecho');
435 my $password = ReadLine(0);
436 ReadMode('normal');
437 print "\n";
438 return ($password);
439}
440
441# get_system_dbh
442# Returns L<DBI> database handle connected to B<system> with DBA credentials.
443# See also L<RT::Handle/SystemDSN>.
444
445
446sub get_system_dbh {
447 return _get_dbh( RT::Handle->SystemDSN, $dba_user, $dba_pass );
448}
449
450sub get_admin_dbh {
451 return _get_dbh( RT::Handle->DSN, $dba_user, $dba_pass );
452}
453
454# get_rt_dbh [USER, PASSWORD]
455
456# Returns L<DBI> database handle connected to RT database,
457# you may specify credentials(USER and PASSWORD) to connect
458# with. By default connects with credentials from RT config.
459
460sub get_rt_dbh {
461 return _get_dbh( RT::Handle->DSN, $db_user, $db_pass );
462}
463
464sub _get_dbh {
465 my ($dsn, $user, $pass) = @_;
466 my $dbh = DBI->connect(
467 $dsn, $user, $pass,
468 { RaiseError => 0, PrintError => 0 },
469 );
470 unless ( $dbh ) {
471 my $msg = "Failed to connect to $dsn as user '$user': ". $DBI::errstr;
472 if ( $args{'debug'} ) {
473 require Carp; Carp::confess( $msg );
474 } else {
475 print STDERR $msg; exit -1;
476 }
477 }
478 return $dbh;
479}
480
481sub _yesno {
482 print "Proceed [y/N]:";
483 my $x = scalar(<STDIN>);
484 $x =~ /^y/i;
485}
486
4871;
488
489__END__
490
491=head1 NAME
492
493rt-setup-database - Set up RT's database
494
495=head1 SYNOPSIS
496
497 rt-setup-database --action ...
498
499=head1 OPTIONS
500
501=over
502
503=item action
504
505Several actions can be combined using comma separated list.
506
507=over
508
509=item init
510
511Initialize the database. This is combination of multiple actions listed below.
512Create DB, schema, setup acl, insert core data and initial data.
513
514=item upgrade
515
516Apply all needed schema/acl/content updates (will ask for version to upgrade
517from)
518
519=item create
520
521Create the database.
522
523=item drop
524
525Drop the database. This will B<ERASE ALL YOUR DATA>.
526
527=item schema
528
529Initialize only the database schema
530
531To use a local or supplementary datafile, specify it using the '--datadir'
532option below.
533
534=item acl
535
536Initialize only the database ACLs
537
538To use a local or supplementary datafile, specify it using the '--datadir'
539option below.
540
541=item coredata
542
543Insert data into RT's database. This data is required for normal functioning of
544any RT instance.
545
546=item insert
547
548Insert data into RT's database. By default, will use RT's installation data.
549To use a local or supplementary datafile, specify it using the '--datafile'
550option below.
551
552=back
553
554=item datafile
555
556file path of the data you want to action on
557
558e.g. C<--datafile /path/to/datafile>
559
560=item datadir
561
562Used to specify a path to find the local database schema and acls to be
563installed.
564
565e.g. C<--datadir /path/to/>
566
567=item dba
568
569dba's username
570
571=item dba-password
572
573dba's password
574
575=item prompt-for-dba-password
576
577Ask for the database administrator's password interactively
578
579=item skip-create
580
581for 'init': skip creating the database and the user account, so we don't need
582administrator privileges
583
584=item root-password-file
585
586for 'init' and 'insert': rather than using the default administrative password
587for RT's "root" user, use the password in this file.
588
589=back