3 # This file is part of Koha.
5 # Copyright (C) YEAR YOURNAME-OR-YOUREMPLOYER
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use C4::InstallAuth qw( get_template_and_user );
28 use C4::Output qw( output_html_with_http_headers );
30 use C4::Languages qw( getAllLanguages getTranslatedLanguages );
32 use C4::Installer::PerlModules;
37 my $step = $query->param('step');
39 my $language = $query->param('language');
40 my ( $template, $loggedinuser, $cookie );
42 my $all_languages = getAllLanguages();
44 if ( defined($language) ) {
45 C4::Templates::setlanguagecookie( $query, $language, "install.pl?step=1" );
47 ( $template, $loggedinuser, $cookie ) = get_template_and_user(
49 template_name => "installer/step" . ( $step ? $step : 1 ) . ".tt",
55 my $installer = C4::Installer->new();
57 $info{'dbname'} = C4::Context->config("database_test") || C4::Context->config("database");
59 C4::Context->config("db_scheme")
60 ? C4::Context->config("db_scheme")
63 $info{'hostname'} = C4::Context->config("hostname");
64 $info{'port'} = C4::Context->config("port");
65 $info{'user'} = C4::Context->config("user");
66 $info{'password'} = C4::Context->config("pass");
67 $info{'tls'} = C4::Context->config("tls");
68 if ($info{'tls'} && $info{'tls'} eq 'yes'){
69 $info{'ca'} = C4::Context->config('ca');
70 $info{'cert'} = C4::Context->config('cert');
71 $info{'key'} = C4::Context->config('key');
72 $info{'tlsoptions'} = ";mysql_ssl=1;mysql_ssl_client_key=".$info{key}.";mysql_ssl_client_cert=".$info{cert}.";mysql_ssl_ca_file=".$info{ca};
73 $info{'tlscmdline'} = " --ssl-cert ". $info{cert} . " --ssl-key " . $info{key} . " --ssl-ca ".$info{ca}." "
76 my $dbh = DBI->connect(
77 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
78 . ( $info{port} ? ";port=$info{port}" : "" )
79 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
80 $info{'user'}, $info{'password'}
83 if ( $step && $step == 1 ) {
85 #First Step (for both fresh installations and upgrades)
86 #Checking ALL perl Modules and services needed are installed.
87 #Whenever there is an error, adding a report to the page
88 my $op = $query->param('op') || 'noop';
89 $template->param( language => 1 );
91 $template->param( 'checkmodule' => 1 )
92 ; # we start with the assumption that there are no problems and set this to 0 if there are
94 unless ( $] >= 5.010000 ) { # Bug 7375
95 $template->param( problems => 1, perlversion => 1, checkmodule => 0 );
99 my $perl_modules = C4::Installer::PerlModules->new;
100 $perl_modules->versions_info;
102 my $missing_modules = $perl_modules->get_attr('missing_pm');
103 my $upgrade_modules = $perl_modules->get_attr('upgrade_pm');
104 if ( scalar(@$missing_modules) || scalar(@$upgrade_modules) ) {
107 foreach (@$missing_modules) {
108 my ( $module, $stats ) = each %$_;
109 $checkmodule = 0 if $stats->{'required'};
114 min_version => $stats->{'min_ver'},
115 max_version => $stats->{'max_ver'},
116 require => $stats->{'required'}
120 foreach (@$upgrade_modules) {
121 my ( $module, $stats ) = each %$_;
122 $checkmodule = 0 if $stats->{'required'};
127 min_version => $stats->{'min_ver'},
128 max_version => $stats->{'max_ver'},
129 require => $stats->{'required'}
133 @missing = sort { $a->{'name'} cmp $b->{'name'} } @missing;
134 @upgrade = sort { $a->{'name'} cmp $b->{'name'} } @upgrade;
136 missing_modules => \@missing,
137 upgrade_modules => \@upgrade,
138 checkmodule => $checkmodule,
143 elsif ( $step && $step == 2 ) {
145 #STEP 2 Check Database connection and access
147 $template->param(%info);
148 my $checkdb = $query->param("checkdb");
149 $template->param( 'dbconnection' => $checkdb );
153 # Can connect to the mysql
154 $template->param( "checkdatabaseaccess" => 1 );
155 if ( $info{dbms} eq "mysql" ) {
157 #Check if database created
158 my $rv = $dbh->do("SHOW DATABASES LIKE \'$info{dbname}\'");
160 $template->param( 'checkdatabasecreated' => 1 );
163 # Check if user have all necessary grants on this database.
164 # CURRENT_USER is ANSI SQL, and doesn't require mysql table
165 # privileges, making the % check pointless, since they
166 # couldn't even check GRANTS if they couldn't connect.
167 my $rq = $dbh->prepare('SHOW GRANTS FOR CURRENT_USER');
170 while ( my ($line) = $rq->fetchrow ) {
171 my $dbname = $info{dbname};
172 if ( $line =~ m/^GRANT (.*?) ON `$dbname`\.\*/
173 || index( $line, '*.*' ) > 0 )
177 index( $line, 'ALL PRIVILEGES' ) > 0
178 || ( ( index( $line, 'SELECT' ) > 0 )
179 && ( index( $line, 'INSERT' ) > 0 )
180 && ( index( $line, 'UPDATE' ) > 0 )
181 && ( index( $line, 'DELETE' ) > 0 )
182 && ( index( $line, 'CREATE' ) > 0 )
183 && ( index( $line, 'DROP' ) > 0 ) )
187 $template->param( "checkgrantaccess" => $grantaccess );
188 } # End mysql connect check...
190 elsif ( $info{dbms} eq "Pg" ) {
192 # Check if database has been created...
194 "SELECT * FROM pg_catalog.pg_database WHERE datname = \'$info{dbname}\';"
197 $template->param( 'checkdatabasecreated' => 1 );
200 # Check if user has all necessary grants on this database...
203 FROM pg_catalog.pg_user as u
204 WHERE u.usename = \'$info{user}\';"
207 $template->param( "checkgrantaccess" => 1 );
209 } # End Pg connect check...
212 $template->param( "error" => DBI::err, "message" => DBI::errstr );
216 elsif ( $step && $step == 3 ) {
218 # STEP 3 : database setup
220 my $op = $query->param('op');
221 if ( $op && $op eq 'finished' ) {
222 # Remove the HandleError set at the beginning of the installer process
223 C4::Context->dbh->disconnect;
225 # we have finished, just redirect to mainpage.
226 print $query->redirect("/cgi-bin/koha/mainpage.pl");
229 elsif ( $op && $op eq 'finish' ) {
230 $installer->set_version_syspref();
232 my $langchoice = $query->param('fwklanguage');
233 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
234 $langchoice =~ s/[^a-zA-Z_-]*//g;
235 $installer->set_languages_syspref($langchoice);
237 # Installation is finished.
238 # We just deny anybody access to install
239 # And we redirect people to mainpage.
240 # The installer will have to relogin since we do not pass cookie to redirection.
241 $template->param( "$op" => 1 );
244 elsif ( $op && $op eq 'addframeworks' ) {
246 # 1ST install, 3rd sub-step : insert the SQL files the user has selected
247 my $langchoice = $query->param('fwklanguage');
248 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
249 $langchoice =~ s/[^a-zA-Z_-]*//g;
251 my ( $fwk_language, $list ) =
252 $installer->load_sql_in_order( $langchoice, $all_languages,
253 $query->multi_param('framework') );
255 "fwklanguage" => $fwk_language,
258 use Koha::SearchEngine::Elasticsearch;
259 Koha::SearchEngine::Elasticsearch->reset_elasticsearch_mappings;
260 $template->param( "$op" => 1 );
262 elsif ( $op && $op eq 'selectframeworks' ) {
265 # 1ST install, 2nd sub-step : show the user the sql datas they can insert in the database.
268 # (note that the term "selectframeworks is not correct. The user can select various files, not only frameworks)
271 #sql data for import are supposed to be located in installer/data/<language>/<level>
272 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
273 # Where <level> is a category of requirement : required, recommended optional
274 # level should contain :
275 # SQL File for import With a readable name.
276 # txt File that explains what this SQL File is meant for.
277 # Could be VERY useful to have A Big file for a kind of library.
278 # But could also be useful to have some Authorised values data set prepared here.
279 # Framework Selection is achieved through checking boxes.
280 my $langchoice = $query->param('fwklanguage');
281 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
282 $langchoice =~ s/[^a-zA-Z_-]*//g;
283 my $marcflavour = $query->param('marcflavour');
285 $installer->set_marcflavour_syspref($marcflavour);
287 $marcflavour = C4::Context->preference('marcflavour')
288 unless ($marcflavour);
290 #Insert into database the selected marcflavour
292 my ( $marc_defaulted_to_en, $fwklist ) =
293 $installer->marc_framework_sql_list( $langchoice, $marcflavour );
294 $template->param( 'en_marc_frameworks' => $marc_defaulted_to_en );
295 $template->param( "frameworksloop" => $fwklist );
296 $template->param( "marcflavour" => ucfirst($marcflavour) );
298 my ( $sample_defaulted_to_en, $levellist ) =
299 $installer->sample_data_sql_list($langchoice);
300 $template->param( "en_sample_data" => $sample_defaulted_to_en );
301 $template->param( "levelloop" => $levellist );
302 $template->param( "$op" => 1 );
305 elsif ( $op && $op eq 'choosemarc' ) {
308 # 1ST install, 2nd sub-step : show the user the marcflavour available.
313 #sql data are supposed to be located in installer/data/<dbms>/<language>/marcflavour/marcflavourname
314 # Where <dbms> is database type according to DBD syntax
315 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
316 # Where <level> is a category of requirement : required, recommended optional
317 # level should contain :
318 # SQL File for import With a readable name.
319 # txt File that explains what this SQL File is meant for.
320 # Could be VERY useful to have A Big file for a kind of library.
321 # But could also be useful to have some Authorised values data set prepared here.
322 # Marcflavour Selection is achieved through radiobuttons.
323 my $langchoice = $query->param('fwklanguage');
325 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
326 $langchoice =~ s/[^a-zA-Z_-]*//g;
328 C4::Context->config('intranetdir')
329 . "/installer/data/$info{dbms}/$langchoice/marcflavour";
330 unless ( opendir( MYDIR, $dir ) ) {
331 if ( $langchoice eq 'en' ) {
332 warn "cannot open MARC frameworks directory $dir";
335 # if no translated MARC framework is available,
337 $dir = C4::Context->config('intranetdir')
338 . "/installer/data/$info{dbms}/en/marcflavour";
339 opendir( MYDIR, $dir )
340 or warn "cannot open English MARC frameworks directory $dir";
343 my @listdir = grep { !/^\./ && -d "$dir/$_" } readdir(MYDIR);
345 my $marcflavour = C4::Context->preference("marcflavour");
347 foreach my $marc (@listdir) {
349 "label"=> ucfirst($marc),
351 "checked"=> defined($marcflavour) ? uc($marc) eq $marcflavour : 0);
352 # $cell{"description"}= do { local $/ = undef; open INPUT "<$dir/$marc.txt"||"";<INPUT> };
353 push @flavourlist, \%cell;
355 $template->param( "flavourloop" => \@flavourlist );
356 $template->param( "$op" => 1 );
358 elsif ( $op && $op eq 'importdatastructure' ) {
361 # 1st install, 1st "sub-step" : import kohastructure
364 my $error = $installer->load_db_schema();
370 elsif ( $op && $op eq 'updatestructure' ) {
372 # Not 1st install, the only sub-step : update database
374 #Do updatedatabase And report
376 if ( !defined $ENV{PERL5LIB} ) {
377 my $find = "C4/Context.pm";
378 my $path = $INC{$find};
379 $path =~ s/\Q$find\E//;
380 $ENV{PERL5LIB} = "$path:$path/installer";
381 warn "# plack? inserted PERL5LIB $ENV{PERL5LIB}\n";
384 my $now = POSIX::strftime( "%Y-%m-%dT%H:%M:%S", localtime() );
385 my $logdir = C4::Context->config('logdir');
386 my $dbversion = C4::Context->preference('Version');
387 my $kohaversion = Koha::version;
388 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
390 my $filename_suffix = join '_', $now, $dbversion, $kohaversion;
391 my ( $logfilepath, $logfilepath_errors ) = (
392 chk_log( $logdir, "updatedatabase_$filename_suffix" ),
393 chk_log( $logdir, "updatedatabase-error_$filename_suffix" )
396 my $cmd = C4::Context->config("intranetdir")
397 . "/installer/data/$info{dbms}/updatedatabase.pl >> $logfilepath 2>> $logfilepath_errors";
402 open( $fh, "<:encoding(utf-8)", $logfilepath )
403 or die "Cannot open log file $logfilepath: $!";
407 $template->param( update_report =>
408 [ map { { line => $_ =~ s/\t/  /gr } } split( /\n/, join( '', @report ) ) ]
410 $template->param( has_update_succeeds => 1 );
413 eval { `rm $logfilepath` };
415 open( $fh, "<:encoding(utf-8)", $logfilepath_errors )
416 or die "Cannot open log file $logfilepath_errors: $!";
421 $template->param( update_errors =>
422 [ map { { line => $_ } } split( /\n/, join( '', @report ) ) ]
425 $template->param( has_update_errors => 1 );
427 "The following errors were returned while attempting to run the updatedatabase.pl script:\n";
428 foreach my $line (@report) { warn "$line\n"; }
431 eval { `rm $logfilepath_errors` };
434 unless ( $update_errors ) {
435 my $db_entries = get_db_entries();
436 my $report = update( $db_entries );
437 my $atomic_update_files = get_atomic_updates;
438 my $atomic_update_report = run_atomic_updates( $atomic_update_files );
441 success => $report->{success},
442 error => $report->{error},
444 success => $atomic_update_report->{success},
445 error => $atomic_update_report->{error}
450 $template->param( $op => 1 );
454 # check whether it's a 1st install or an update
456 #Check if there are enough tables.
457 # Paul has cleaned up tables so reduced the count
458 #I put it there because it implied a data import if condition was not satisfied.
459 my $dbh = DBI->connect(
460 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
461 . ( $info{port} ? ";port=$info{port}" : "" )
462 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
463 $info{'user'}, $info{'password'}
466 if ( $info{dbms} eq 'mysql' ) { $rq = $dbh->prepare("SHOW TABLES"); }
467 elsif ( $info{dbms} eq 'Pg' ) {
470 FROM information_schema.tables
471 WHERE table_schema='public' and table_type='BASE TABLE';"
475 my $data = $rq->fetchall_arrayref( {} );
476 my $count = scalar(@$data);
478 # we don't have tables, propose DB import
481 $template->param( "count" => $count, "proposeimport" => 1 );
485 # we have tables, propose to select files to upload or updatedatabase
487 $template->param( "count" => $count, "default" => 1 );
489 # 1st part of step 3 : check if there is a databaseversion systempreference
490 # if there is, then we just need to upgrade
491 # if there is none, then we need to install the database
493 if ( C4::Context->preference('Version') ) {
494 my $dbversion = C4::Context->preference('Version');
495 $dbversion =~ /(.*)\.(..)(..)(...)/;
496 $dbversion = "$1.$2.$3.$4";
499 "dbversion" => $dbversion,
500 "kohaversion" => Koha::version(),
508 # LANGUAGE SELECTION page by default
509 # using opendir + language Hash
510 my $languages_loop = getTranslatedLanguages('intranet');
511 $template->param( installer_languages_loop => $languages_loop );
515 "SELECT * from systempreferences WHERE variable='Version'");
516 if ( $rq->execute ) {
517 my ($version) = $rq->fetchrow;
519 print $query->redirect(
520 "/cgi-bin/koha/installer/install.pl?step=3");
526 output_html_with_http_headers $query, $cookie, $template->output;
528 sub chk_log { #returns a logfile in $dir or - if that failed - in temp dir
529 my ( $dir, $name ) = @_;
530 my $fn = $dir . '/' . $name . '.log';
531 if ( !open my $fh, '>', $fn ) {
535 File::Temp::tempfile( $name, TMPDIR => 1, SUFFIX => '.log' );
537 #if this should not work, let croak take over