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>.
26 use POSIX qw(strftime);
31 use C4::Languages qw(getAllLanguages getTranslatedLanguages);
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",
57 my $installer = C4::Installer->new();
59 $info{'dbname'} = C4::Context->config("database");
61 C4::Context->config("db_scheme")
62 ? C4::Context->config("db_scheme")
65 $info{'hostname'} = C4::Context->config("hostname");
66 $info{'port'} = C4::Context->config("port");
67 $info{'user'} = C4::Context->config("user");
68 $info{'password'} = C4::Context->config("pass");
69 $info{'tls'} = C4::Context->config("tls");
70 if ($info{'tls'} && $info{'tls'} eq 'yes'){
71 $info{'ca'} = C4::Context->config('ca');
72 $info{'cert'} = C4::Context->config('cert');
73 $info{'key'} = C4::Context->config('key');
74 $info{'tlsoptions'} = ";mysql_ssl=1;mysql_ssl_client_key=".$info{key}.";mysql_ssl_client_cert=".$info{cert}.";mysql_ssl_ca_file=".$info{ca};
75 $info{'tlscmdline'} = " --ssl-cert ". $info{cert} . " --ssl-key " . $info{key} . " --ssl-ca ".$info{ca}." "
78 my $dbh = DBI->connect(
79 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
80 . ( $info{port} ? ";port=$info{port}" : "" )
81 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
82 $info{'user'}, $info{'password'}
85 if ( $step && $step == 1 ) {
87 #First Step (for both fresh installations and upgrades)
88 #Checking ALL perl Modules and services needed are installed.
89 #Whenever there is an error, adding a report to the page
90 my $op = $query->param('op') || 'noop';
91 $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 );
99 my $perl_modules = C4::Installer::PerlModules->new;
100 $perl_modules->versions_info;
102 my $modules = $perl_modules->get_attr('missing_pm');
103 if ( scalar(@$modules) ) {
106 foreach (@$modules) {
107 my ( $module, $stats ) = each %$_;
108 $checkmodule = 0 if $stats->{'required'};
113 version => $stats->{'min_ver'},
114 require => $stats->{'required'},
115 usage => $stats->{'usage'},
119 @components = sort { $a->{'name'} cmp $b->{'name'} } @components;
121 missing_modules => \@components,
122 checkmodule => $checkmodule,
127 elsif ( $step && $step == 2 ) {
129 #STEP 2 Check Database connection and access
131 $template->param(%info);
132 my $checkdb = $query->param("checkdb");
133 $template->param( 'dbconnection' => $checkdb );
137 # Can connect to the mysql
138 $template->param( "checkdatabaseaccess" => 1 );
139 if ( $info{dbms} eq "mysql" ) {
141 #Check if database created
142 my $rv = $dbh->do("SHOW DATABASES LIKE \'$info{dbname}\'");
144 $template->param( 'checkdatabasecreated' => 1 );
147 #Check if user have all necessary grants on this database.
150 "SHOW GRANTS FOR \'$info{user}\'\@'$info{hostname}'");
153 while ( my ($line) = $rq->fetchrow ) {
154 my $dbname = $info{dbname};
155 if ( $line =~ m/^GRANT (.*?) ON `$dbname`\.\*/
156 || index( $line, '*.*' ) > 0 )
160 index( $line, 'ALL PRIVILEGES' ) > 0
161 || ( ( index( $line, 'SELECT' ) > 0 )
162 && ( index( $line, 'INSERT' ) > 0 )
163 && ( index( $line, 'UPDATE' ) > 0 )
164 && ( index( $line, 'DELETE' ) > 0 )
165 && ( index( $line, 'CREATE' ) > 0 )
166 && ( index( $line, 'DROP' ) > 0 ) )
170 unless ($grantaccess) {
172 $dbh->prepare("SHOW GRANTS FOR \'$info{user}\'\@'\%'");
174 while ( my ($line) = $rq->fetchrow ) {
175 my $dbname = $info{dbname};
176 if ( $line =~ m/$dbname/ || index( $line, '*.*' ) > 0 )
180 index( $line, 'ALL PRIVILEGES' ) > 0
181 || ( ( index( $line, 'SELECT' ) > 0 )
182 && ( index( $line, 'INSERT' ) > 0 )
183 && ( index( $line, 'UPDATE' ) > 0 )
184 && ( index( $line, 'DELETE' ) > 0 )
185 && ( index( $line, 'CREATE' ) > 0 )
186 && ( index( $line, 'DROP' ) > 0 ) )
191 $template->param( "checkgrantaccess" => $grantaccess );
192 } # End mysql connect check...
194 elsif ( $info{dbms} eq "Pg" ) {
196 # Check if database has been created...
198 "SELECT * FROM pg_catalog.pg_database WHERE datname = \'$info{dbname}\';"
201 $template->param( 'checkdatabasecreated' => 1 );
204 # Check if user has all necessary grants on this database...
207 FROM pg_catalog.pg_user as u
208 WHERE u.usename = \'$info{user}\';"
211 $template->param( "checkgrantaccess" => 1 );
213 } # End Pg connect check...
216 $template->param( "error" => DBI::err, "message" => DBI::errstr );
220 elsif ( $step && $step == 3 ) {
222 # STEP 3 : database setup
224 my $op = $query->param('op');
225 if ( $op && $op eq 'finished' ) {
227 # we have finished, just redirect to mainpage.
229 print $query->redirect("/cgi-bin/koha/mainpage.pl");
232 elsif ( $op && $op eq 'finish' ) {
233 $installer->set_version_syspref();
235 # Installation is finished.
236 # We just deny anybody access to install
237 # And we redirect people to mainpage.
238 # The installer will have to relogin since we do not pass cookie to redirection.
239 $template->param( "$op" => 1 );
242 elsif ( $op && $op eq 'addframeworks' ) {
244 # 1ST install, 3rd sub-step : insert the SQL files the user has selected
246 my ( $fwk_language, $list ) =
247 $installer->load_sql_in_order( $all_languages,
248 $query->param('framework') );
250 "fwklanguage" => $fwk_language,
253 use Koha::SearchEngine::Elasticsearch;
254 Koha::SearchEngine::Elasticsearch->reset_elasticsearch_mappings;
255 $template->param( "$op" => 1 );
257 elsif ( $op && $op eq 'selectframeworks' ) {
260 # 1ST install, 2nd sub-step : show the user the sql datas they can insert in the database.
263 # (note that the term "selectframeworks is not correct. The user can select various files, not only frameworks)
266 #sql data for import are supposed to be located in installer/data/<language>/<level>
267 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
268 # Where <level> is a category of requirement : required, recommended optional
269 # level should contain :
270 # SQL File for import With a readable name.
271 # txt File that explains what this SQL File is meant for.
272 # Could be VERY useful to have A Big file for a kind of library.
273 # But could also be useful to have some Authorised values data set prepared here.
274 # Framework Selection is achieved through checking boxes.
275 my $langchoice = $query->param('fwklanguage');
276 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
277 $langchoice =~ s/[^a-zA-Z_-]*//g;
278 my $marcflavour = $query->param('marcflavour');
280 $installer->set_marcflavour_syspref($marcflavour);
282 $marcflavour = C4::Context->preference('marcflavour')
283 unless ($marcflavour);
285 #Insert into database the selected marcflavour
287 my ( $marc_defaulted_to_en, $fwklist ) =
288 $installer->marc_framework_sql_list( $langchoice, $marcflavour );
289 $template->param( 'en_marc_frameworks' => $marc_defaulted_to_en );
290 $template->param( "frameworksloop" => $fwklist );
291 $template->param( "marcflavour" => ucfirst($marcflavour) );
293 my ( $sample_defaulted_to_en, $levellist ) =
294 $installer->sample_data_sql_list($langchoice);
295 $template->param( "en_sample_data" => $sample_defaulted_to_en );
296 $template->param( "levelloop" => $levellist );
297 $template->param( "$op" => 1 );
299 my $setup = $query->param('setup');
300 $template->param( "setup" => $setup );
303 elsif ( $op && $op eq 'choosemarc' ) {
306 # 1ST install, 2nd sub-step : show the user the marcflavour available.
311 #sql data are supposed to be located in installer/data/<dbms>/<language>/marcflavour/marcflavourname
312 # Where <dbms> is database type according to DBD syntax
313 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
314 # Where <level> is a category of requirement : required, recommended optional
315 # level should contain :
316 # SQL File for import With a readable name.
317 # txt File taht explains what this SQL File is meant for.
318 # Could be VERY useful to have A Big file for a kind of library.
319 # But could also be useful to have some Authorised values data set prepared here.
320 # Marcflavour Selection is achieved through radiobuttons.
321 my $langchoice = $query->param('fwklanguage');
323 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
324 $langchoice =~ s/[^a-zA-Z_-]*//g;
326 C4::Context->config('intranetdir')
327 . "/installer/data/$info{dbms}/$langchoice/marcflavour";
328 unless ( opendir( MYDIR, $dir ) ) {
329 if ( $langchoice eq 'en' ) {
330 warn "cannot open MARC frameworks directory $dir";
333 # if no translated MARC framework is available,
335 $dir = C4::Context->config('intranetdir')
336 . "/installer/data/$info{dbms}/en/marcflavour";
337 opendir( MYDIR, $dir )
338 or warn "cannot open English MARC frameworks directory $dir";
341 my @listdir = grep { !/^\./ && -d "$dir/$_" } readdir(MYDIR);
343 my $marcflavour = C4::Context->preference("marcflavour");
345 foreach my $marc (@listdir) {
347 "label" => ucfirst($marc),
349 "checked" => defined($marcflavour)
350 ? uc($marc) eq $marcflavour
354 # $cell{"description"}= do { local $/ = undef; open INPUT "<$dir/$marc.txt"||"";<INPUT> };
355 push @flavourlist, \%cell;
357 $template->param( "flavourloop" => \@flavourlist );
358 $template->param( "$op" => 1 );
360 elsif ( $op && $op eq 'importdatastructure' ) {
363 # 1st install, 1st "sub-step" : import kohastructure
366 my $error = $installer->load_db_schema();
372 elsif ( $op && $op eq 'updatestructure' ) {
374 # Not 1st install, the only sub-step : update database
376 #Do updatedatabase And report
378 if ( !defined $ENV{PERL5LIB} ) {
379 my $find = "C4/Context.pm";
380 my $path = $INC{$find};
381 $path =~ s/\Q$find\E//;
382 $ENV{PERL5LIB} = "$path:$path/installer";
383 warn "# plack? inserted PERL5LIB $ENV{PERL5LIB}\n";
386 my $now = POSIX::strftime( "%Y-%m-%dT%H:%M:%S", localtime() );
387 my $logdir = C4::Context->config('logdir');
388 my $dbversion = C4::Context->preference('Version');
389 my $kohaversion = Koha::version;
390 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
392 my $filename_suffix = join '_', $now, $dbversion, $kohaversion;
393 my ( $logfilepath, $logfilepath_errors ) = (
394 chk_log( $logdir, "updatedatabase_$filename_suffix" ),
395 chk_log( $logdir, "updatedatabase-error_$filename_suffix" )
398 my $cmd = C4::Context->config("intranetdir")
399 . "/installer/data/$info{dbms}/updatedatabase.pl >> $logfilepath 2>> $logfilepath_errors";
404 open( $fh, "<", $logfilepath )
405 or die "Cannot open log file $logfilepath: $!";
409 $template->param( update_report =>
410 [ map { { line => $_ } } split( /\n/, join( '', @report ) ) ]
412 $template->param( has_update_succeeds => 1 );
415 eval { `rm $logfilepath` };
417 open( $fh, "<", $logfilepath_errors )
418 or die "Cannot open log file $logfilepath_errors: $!";
422 $template->param( update_errors =>
423 [ 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` };
433 $template->param( $op => 1 );
437 # check whether it's a 1st install or an update
439 #Check if there are enough tables.
440 # Paul has cleaned up tables so reduced the count
441 #I put it there because it implied a data import if condition was not satisfied.
442 my $dbh = DBI->connect(
443 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
444 . ( $info{port} ? ";port=$info{port}" : "" )
445 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
446 $info{'user'}, $info{'password'}
449 if ( $info{dbms} eq 'mysql' ) { $rq = $dbh->prepare("SHOW TABLES"); }
450 elsif ( $info{dbms} eq 'Pg' ) {
453 FROM information_schema.tables
454 WHERE table_schema='public' and table_type='BASE TABLE';"
458 my $data = $rq->fetchall_arrayref( {} );
459 my $count = scalar(@$data);
461 # we don't have tables, propose DB import
464 $template->param( "count" => $count, "proposeimport" => 1 );
468 # we have tables, propose to select files to upload or updatedatabase
470 $template->param( "count" => $count, "default" => 1 );
472 # 1st part of step 3 : check if there is a databaseversion systempreference
473 # if there is, then we just need to upgrade
474 # if there is none, then we need to install the database
476 if ( C4::Context->preference('Version') ) {
477 my $dbversion = C4::Context->preference('Version');
478 $dbversion =~ /(.*)\.(..)(..)(...)/;
479 $dbversion = "$1.$2.$3.$4";
482 "dbversion" => $dbversion,
483 "kohaversion" => Koha::version(),
491 # LANGUAGE SELECTION page by default
492 # using opendir + language Hash
493 my $languages_loop = getTranslatedLanguages('intranet');
494 $template->param( installer_languages_loop => $languages_loop );
498 "SELECT * from systempreferences WHERE variable='Version'");
499 if ( $rq->execute ) {
500 my ($version) = $rq->fetchrow;
502 print $query->redirect(
503 "/cgi-bin/koha/installer/install.pl?step=3");
509 output_html_with_http_headers $query, $cookie, $template->output;
511 sub chk_log { #returns a logfile in $dir or - if that failed - in temp dir
512 my ( $dir, $name ) = @_;
513 my $fn = $dir . '/' . $name . '.log';
514 if ( !open my $fh, '>', $fn ) {
518 File::Temp::tempfile( $name, TMPDIR => 1, SUFFIX => '.log' );
520 #if this should not work, let croak take over