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>.
25 use POSIX qw(strftime);
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",
56 my $installer = C4::Installer->new();
58 $info{'dbname'} = C4::Context->config("database");
60 C4::Context->config("db_scheme")
61 ? C4::Context->config("db_scheme")
64 $info{'hostname'} = C4::Context->config("hostname");
65 $info{'port'} = C4::Context->config("port");
66 $info{'user'} = C4::Context->config("user");
67 $info{'password'} = C4::Context->config("pass");
68 $info{'tls'} = C4::Context->config("tls");
69 if ($info{'tls'} && $info{'tls'} eq 'yes'){
70 $info{'ca'} = C4::Context->config('ca');
71 $info{'cert'} = C4::Context->config('cert');
72 $info{'key'} = C4::Context->config('key');
73 $info{'tlsoptions'} = ";mysql_ssl=1;mysql_ssl_client_key=".$info{key}.";mysql_ssl_client_cert=".$info{cert}.";mysql_ssl_ca_file=".$info{ca};
74 $info{'tlscmdline'} = " --ssl-cert ". $info{cert} . " --ssl-key " . $info{key} . " --ssl-ca ".$info{ca}." "
77 my $dbh = DBI->connect(
78 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
79 . ( $info{port} ? ";port=$info{port}" : "" )
80 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
81 $info{'user'}, $info{'password'}
84 if ( $step && $step == 1 ) {
86 #First Step (for both fresh installations and upgrades)
87 #Checking ALL perl Modules and services needed are installed.
88 #Whenever there is an error, adding a report to the page
89 my $op = $query->param('op') || 'noop';
90 $template->param( language => 1 );
92 $template->param( 'checkmodule' => 1 )
93 ; # we start with the assumption that there are no problems and set this to 0 if there are
95 unless ( $] >= 5.010000 ) { # Bug 7375
96 $template->param( problems => 1, perlversion => 1, checkmodule => 0 );
100 my $perl_modules = C4::Installer::PerlModules->new;
101 $perl_modules->versions_info;
103 my $missing_modules = $perl_modules->get_attr('missing_pm');
104 my $upgrade_modules = $perl_modules->get_attr('upgrade_pm');
105 if ( scalar(@$missing_modules) || scalar(@$upgrade_modules) ) {
108 foreach (@$missing_modules) {
109 my ( $module, $stats ) = each %$_;
110 $checkmodule = 0 if $stats->{'required'};
115 min_version => $stats->{'min_ver'},
116 max_version => $stats->{'max_ver'},
117 require => $stats->{'required'}
121 foreach (@$upgrade_modules) {
122 my ( $module, $stats ) = each %$_;
123 $checkmodule = 0 if $stats->{'required'};
128 min_version => $stats->{'min_ver'},
129 max_version => $stats->{'max_ver'},
130 require => $stats->{'required'}
134 @missing = sort { $a->{'name'} cmp $b->{'name'} } @missing;
135 @upgrade = sort { $a->{'name'} cmp $b->{'name'} } @upgrade;
137 missing_modules => \@missing,
138 upgrade_modules => \@upgrade,
139 checkmodule => $checkmodule,
144 elsif ( $step && $step == 2 ) {
146 #STEP 2 Check Database connection and access
148 $template->param(%info);
149 my $checkdb = $query->param("checkdb");
150 $template->param( 'dbconnection' => $checkdb );
154 # Can connect to the mysql
155 $template->param( "checkdatabaseaccess" => 1 );
156 if ( $info{dbms} eq "mysql" ) {
158 #Check if database created
159 my $rv = $dbh->do("SHOW DATABASES LIKE \'$info{dbname}\'");
161 $template->param( 'checkdatabasecreated' => 1 );
164 # Check if user have all necessary grants on this database.
165 # CURRENT_USER is ANSI SQL, and doesn't require mysql table
166 # privileges, making the % check pointless, since they
167 # couldn't even check GRANTS if they couldn't connect.
168 my $rq = $dbh->prepare('SHOW GRANTS FOR CURRENT_USER');
171 while ( my ($line) = $rq->fetchrow ) {
172 my $dbname = $info{dbname};
173 if ( $line =~ m/^GRANT (.*?) ON `$dbname`\.\*/
174 || index( $line, '*.*' ) > 0 )
178 index( $line, 'ALL PRIVILEGES' ) > 0
179 || ( ( index( $line, 'SELECT' ) > 0 )
180 && ( index( $line, 'INSERT' ) > 0 )
181 && ( index( $line, 'UPDATE' ) > 0 )
182 && ( index( $line, 'DELETE' ) > 0 )
183 && ( index( $line, 'CREATE' ) > 0 )
184 && ( index( $line, 'DROP' ) > 0 ) )
188 $template->param( "checkgrantaccess" => $grantaccess );
189 } # End mysql connect check...
191 elsif ( $info{dbms} eq "Pg" ) {
193 # Check if database has been created...
195 "SELECT * FROM pg_catalog.pg_database WHERE datname = \'$info{dbname}\';"
198 $template->param( 'checkdatabasecreated' => 1 );
201 # Check if user has all necessary grants on this database...
204 FROM pg_catalog.pg_user as u
205 WHERE u.usename = \'$info{user}\';"
208 $template->param( "checkgrantaccess" => 1 );
210 } # End Pg connect check...
213 $template->param( "error" => DBI::err, "message" => DBI::errstr );
217 elsif ( $step && $step == 3 ) {
219 # STEP 3 : database setup
221 my $op = $query->param('op');
222 if ( $op && $op eq 'finished' ) {
223 # Remove the HandleError set at the beginning of the installer process
224 C4::Context->dbh->disconnect;
226 # we have finished, just redirect to mainpage.
227 print $query->redirect("/cgi-bin/koha/mainpage.pl");
230 elsif ( $op && $op eq 'finish' ) {
231 $installer->set_version_syspref();
233 my $langchoice = $query->param('fwklanguage');
234 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
235 $langchoice =~ s/[^a-zA-Z_-]*//g;
236 $installer->set_languages_syspref($langchoice);
238 # Installation is finished.
239 # We just deny anybody access to install
240 # And we redirect people to mainpage.
241 # The installer will have to relogin since we do not pass cookie to redirection.
242 $template->param( "$op" => 1 );
245 elsif ( $op && $op eq 'addframeworks' ) {
247 # 1ST install, 3rd sub-step : insert the SQL files the user has selected
248 my $langchoice = $query->param('fwklanguage');
249 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
250 $langchoice =~ s/[^a-zA-Z_-]*//g;
252 my ( $fwk_language, $list ) =
253 $installer->load_sql_in_order( $langchoice, $all_languages,
254 $query->multi_param('framework') );
256 "fwklanguage" => $fwk_language,
259 use Koha::SearchEngine::Elasticsearch;
260 Koha::SearchEngine::Elasticsearch->reset_elasticsearch_mappings;
261 $template->param( "$op" => 1 );
263 elsif ( $op && $op eq 'selectframeworks' ) {
266 # 1ST install, 2nd sub-step : show the user the sql datas they can insert in the database.
269 # (note that the term "selectframeworks is not correct. The user can select various files, not only frameworks)
272 #sql data for import are supposed to be located in installer/data/<language>/<level>
273 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
274 # Where <level> is a category of requirement : required, recommended optional
275 # level should contain :
276 # SQL File for import With a readable name.
277 # txt File that explains what this SQL File is meant for.
278 # Could be VERY useful to have A Big file for a kind of library.
279 # But could also be useful to have some Authorised values data set prepared here.
280 # Framework Selection is achieved through checking boxes.
281 my $langchoice = $query->param('fwklanguage');
282 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
283 $langchoice =~ s/[^a-zA-Z_-]*//g;
284 my $marcflavour = $query->param('marcflavour');
286 $installer->set_marcflavour_syspref($marcflavour);
288 $marcflavour = C4::Context->preference('marcflavour')
289 unless ($marcflavour);
291 #Insert into database the selected marcflavour
293 my ( $marc_defaulted_to_en, $fwklist ) =
294 $installer->marc_framework_sql_list( $langchoice, $marcflavour );
295 $template->param( 'en_marc_frameworks' => $marc_defaulted_to_en );
296 $template->param( "frameworksloop" => $fwklist );
297 $template->param( "marcflavour" => ucfirst($marcflavour) );
299 my ( $sample_defaulted_to_en, $levellist ) =
300 $installer->sample_data_sql_list($langchoice);
301 $template->param( "en_sample_data" => $sample_defaulted_to_en );
302 $template->param( "levelloop" => $levellist );
303 $template->param( "$op" => 1 );
306 elsif ( $op && $op eq 'choosemarc' ) {
309 # 1ST install, 2nd sub-step : show the user the marcflavour available.
314 #sql data are supposed to be located in installer/data/<dbms>/<language>/marcflavour/marcflavourname
315 # Where <dbms> is database type according to DBD syntax
316 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
317 # Where <level> is a category of requirement : required, recommended optional
318 # level should contain :
319 # SQL File for import With a readable name.
320 # txt File that explains what this SQL File is meant for.
321 # Could be VERY useful to have A Big file for a kind of library.
322 # But could also be useful to have some Authorised values data set prepared here.
323 # Marcflavour Selection is achieved through radiobuttons.
324 my $langchoice = $query->param('fwklanguage');
326 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
327 $langchoice =~ s/[^a-zA-Z_-]*//g;
329 C4::Context->config('intranetdir')
330 . "/installer/data/$info{dbms}/$langchoice/marcflavour";
331 unless ( opendir( MYDIR, $dir ) ) {
332 if ( $langchoice eq 'en' ) {
333 warn "cannot open MARC frameworks directory $dir";
336 # if no translated MARC framework is available,
338 $dir = C4::Context->config('intranetdir')
339 . "/installer/data/$info{dbms}/en/marcflavour";
340 opendir( MYDIR, $dir )
341 or warn "cannot open English MARC frameworks directory $dir";
344 my @listdir = grep { !/^\./ && -d "$dir/$_" } readdir(MYDIR);
346 my $marcflavour = C4::Context->preference("marcflavour");
348 foreach my $marc (@listdir) {
350 "label"=> ucfirst($marc),
352 "checked"=> defined($marcflavour) ? uc($marc) eq $marcflavour : 0);
353 # $cell{"description"}= do { local $/ = undef; open INPUT "<$dir/$marc.txt"||"";<INPUT> };
354 push @flavourlist, \%cell;
356 $template->param( "flavourloop" => \@flavourlist );
357 $template->param( "$op" => 1 );
359 elsif ( $op && $op eq 'importdatastructure' ) {
362 # 1st install, 1st "sub-step" : import kohastructure
365 my $error = $installer->load_db_schema();
371 elsif ( $op && $op eq 'updatestructure' ) {
373 # Not 1st install, the only sub-step : update database
375 #Do updatedatabase And report
377 if ( !defined $ENV{PERL5LIB} ) {
378 my $find = "C4/Context.pm";
379 my $path = $INC{$find};
380 $path =~ s/\Q$find\E//;
381 $ENV{PERL5LIB} = "$path:$path/installer";
382 warn "# plack? inserted PERL5LIB $ENV{PERL5LIB}\n";
385 my $now = POSIX::strftime( "%Y-%m-%dT%H:%M:%S", localtime() );
386 my $logdir = C4::Context->config('logdir');
387 my $dbversion = C4::Context->preference('Version');
388 my $kohaversion = Koha::version;
389 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
391 my $filename_suffix = join '_', $now, $dbversion, $kohaversion;
392 my ( $logfilepath, $logfilepath_errors ) = (
393 chk_log( $logdir, "updatedatabase_$filename_suffix" ),
394 chk_log( $logdir, "updatedatabase-error_$filename_suffix" )
397 my $cmd = C4::Context->config("intranetdir")
398 . "/installer/data/$info{dbms}/updatedatabase.pl >> $logfilepath 2>> $logfilepath_errors";
403 open( $fh, "<:encoding(utf-8)", $logfilepath )
404 or die "Cannot open log file $logfilepath: $!";
408 $template->param( update_report =>
409 [ map { { line => $_ =~ s/\t/  /gr } } split( /\n/, join( '', @report ) ) ]
411 $template->param( has_update_succeeds => 1 );
414 eval { `rm $logfilepath` };
416 open( $fh, "<:encoding(utf-8)", $logfilepath_errors )
417 or die "Cannot open log file $logfilepath_errors: $!";
421 $template->param( update_errors =>
422 [ map { { line => $_ } } split( /\n/, join( '', @report ) ) ]
424 $template->param( has_update_errors => 1 );
426 "The following errors were returned while attempting to run the updatedatabase.pl script:\n";
427 foreach my $line (@report) { warn "$line\n"; }
430 eval { `rm $logfilepath_errors` };
432 $template->param( $op => 1 );
436 # check whether it's a 1st install or an update
438 #Check if there are enough tables.
439 # Paul has cleaned up tables so reduced the count
440 #I put it there because it implied a data import if condition was not satisfied.
441 my $dbh = DBI->connect(
442 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
443 . ( $info{port} ? ";port=$info{port}" : "" )
444 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
445 $info{'user'}, $info{'password'}
448 if ( $info{dbms} eq 'mysql' ) { $rq = $dbh->prepare("SHOW TABLES"); }
449 elsif ( $info{dbms} eq 'Pg' ) {
452 FROM information_schema.tables
453 WHERE table_schema='public' and table_type='BASE TABLE';"
457 my $data = $rq->fetchall_arrayref( {} );
458 my $count = scalar(@$data);
460 # we don't have tables, propose DB import
463 $template->param( "count" => $count, "proposeimport" => 1 );
467 # we have tables, propose to select files to upload or updatedatabase
469 $template->param( "count" => $count, "default" => 1 );
471 # 1st part of step 3 : check if there is a databaseversion systempreference
472 # if there is, then we just need to upgrade
473 # if there is none, then we need to install the database
475 if ( C4::Context->preference('Version') ) {
476 my $dbversion = C4::Context->preference('Version');
477 $dbversion =~ /(.*)\.(..)(..)(...)/;
478 $dbversion = "$1.$2.$3.$4";
481 "dbversion" => $dbversion,
482 "kohaversion" => Koha::version(),
490 # LANGUAGE SELECTION page by default
491 # using opendir + language Hash
492 my $languages_loop = getTranslatedLanguages('intranet');
493 $template->param( installer_languages_loop => $languages_loop );
497 "SELECT * from systempreferences WHERE variable='Version'");
498 if ( $rq->execute ) {
499 my ($version) = $rq->fetchrow;
501 print $query->redirect(
502 "/cgi-bin/koha/installer/install.pl?step=3");
508 output_html_with_http_headers $query, $cookie, $template->output;
510 sub chk_log { #returns a logfile in $dir or - if that failed - in temp dir
511 my ( $dir, $name ) = @_;
512 my $fn = $dir . '/' . $name . '.log';
513 if ( !open my $fh, '>', $fn ) {
517 File::Temp::tempfile( $name, TMPDIR => 1, SUFFIX => '.log' );
519 #if this should not work, let croak take over