installer/install.pl

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright (C) YEAR  YOURNAME-OR-YOUREMPLOYER
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use Modern::Perl;
  21 use diagnostics;
  22
  23 use C4::InstallAuth;
  24 use CGI qw ( -utf8 );
  25 use POSIX qw(strftime);
  26
  27 use C4::Context;
  28 use C4::Output;
  29 use C4::Templates;
  30 use C4::Languages qw(getAllLanguages getTranslatedLanguages);
  31 use C4::Installer;
  32 use C4::Installer::PerlModules;
  33
  34 use Koha;
  35
  36 my $query = new CGI;
  37 my $step  = $query->param('step');
  38
  39 my $language = $query->param('language');
  40 my ( $template, $loggedinuser, $cookie );
  41
  42 my $all_languages = getAllLanguages();
  43
  44 if ( defined($language) ) {
  45     C4::Templates::setlanguagecookie( $query, $language, "install.pl?step=1" );
  46 }
  47 ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  48     {
  49         template_name => "installer/step" . ( $step ? $step : 1 ) . ".tt",
  50         query         => $query,
  51         type          => "intranet",
  52         authnotrequired => 0,
  53         debug           => 1,
  54     }
  55 );
  56
  57 my $installer = C4::Installer->new();
  58 my %info;
  59 $info{'dbname'} = C4::Context->config("database");
  60 $info{'dbms'}   = (
  61       C4::Context->config("db_scheme")
  62     ? C4::Context->config("db_scheme")
  63     : "mysql"
  64 );
  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}." "
  76     }
  77
  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'}
  83 );
  84
  85 if ( $step && $step == 1 ) {
  86
  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     my $checkmodule = 1;
  93     $template->param( 'checkmodule' => 1 )
  94       ; # we start with the assumption that there are no problems and set this to 0 if there are
  95
  96     unless ( $] >= 5.010000 ) {    # Bug 7375
  97         $template->param( problems => 1, perlversion => 1, checkmodule => 0 );
  98         $checkmodule = 0;
  99     }
 100
 101     my $perl_modules = C4::Installer::PerlModules->new;
 102     $perl_modules->versions_info;
 103
 104     my $missing_modules = $perl_modules->get_attr('missing_pm');
 105     my $upgrade_modules = $perl_modules->get_attr('upgrade_pm');
 106     if ( scalar(@$missing_modules) || scalar(@$upgrade_modules) ) {
 107         my @missing  = ();
 108         my @upgrade = ();
 109         foreach (@$missing_modules) {
 110             my ( $module, $stats ) = each %$_;
 111             $checkmodule = 0 if $stats->{'required'};
 112             push(
 113                 @missing,
 114                 {
 115                     name    => $module,
 116                     min_version => $stats->{'min_ver'},
 117                     max_version => $stats->{'max_ver'},
 118                     require => $stats->{'required'}
 119                 }
 120             );
 121         }
 122         foreach (@$upgrade_modules) {
 123             my ( $module, $stats ) = each %$_;
 124             $checkmodule = 0 if $stats->{'required'};
 125             push(
 126                 @upgrade,
 127                 {
 128                     name    => $module,
 129                     min_version => $stats->{'min_ver'},
 130                     max_version => $stats->{'max_ver'},
 131                     require => $stats->{'required'}
 132                 }
 133             );
 134         }
 135         @missing = sort { $a->{'name'} cmp $b->{'name'} } @missing;
 136         @upgrade = sort { $a->{'name'} cmp $b->{'name'} } @upgrade;
 137         $template->param(
 138             missing_modules => \@missing,
 139             upgrade_modules => \@upgrade,
 140             checkmodule     => $checkmodule,
 141             op              => $op
 142         );
 143     }
 144 }
 145 elsif ( $step && $step == 2 ) {
 146
 147     #STEP 2 Check Database connection and access
 148
 149     $template->param(%info);
 150     my $checkdb = $query->param("checkdb");
 151     $template->param( 'dbconnection' => $checkdb );
 152     if ($checkdb) {
 153         if ($dbh) {
 154
 155             # Can connect to the mysql
 156             $template->param( "checkdatabaseaccess" => 1 );
 157             if ( $info{dbms} eq "mysql" ) {
 158
 159                 #Check if database created
 160                 my $rv = $dbh->do("SHOW DATABASES LIKE \'$info{dbname}\'");
 161                 if ( $rv == 1 ) {
 162                     $template->param( 'checkdatabasecreated' => 1 );
 163                 }
 164
 165                 # Check if user have all necessary grants on this database.
 166                 # CURRENT_USER is ANSI SQL, and doesn't require mysql table
 167                 # privileges, making the % check pointless, since they
 168                 # couldn't even check GRANTS if they couldn't connect.
 169                 my $rq = $dbh->prepare('SHOW GRANTS FOR CURRENT_USER');
 170                 $rq->execute;
 171                 my $grantaccess;
 172                 while ( my ($line) = $rq->fetchrow ) {
 173                     my $dbname = $info{dbname};
 174                     if ( $line =~ m/^GRANT (.*?) ON `$dbname`\.\*/
 175                         || index( $line, '*.*' ) > 0 )
 176                     {
 177                         $grantaccess = 1
 178                           if (
 179                             index( $line, 'ALL PRIVILEGES' ) > 0
 180                             || (   ( index( $line, 'SELECT' ) > 0 )
 181                                 && ( index( $line, 'INSERT' ) > 0 )
 182                                 && ( index( $line, 'UPDATE' ) > 0 )
 183                                 && ( index( $line, 'DELETE' ) > 0 )
 184                                 && ( index( $line, 'CREATE' ) > 0 )
 185                                 && ( index( $line, 'DROP' ) > 0 ) )
 186                           );
 187                     }
 188                 }
 189                 $template->param( "checkgrantaccess" => $grantaccess );
 190             }    # End mysql connect check...
 191
 192             elsif ( $info{dbms} eq "Pg" ) {
 193
 194                 # Check if database has been created...
 195                 my $rv = $dbh->do(
 196 "SELECT * FROM pg_catalog.pg_database WHERE datname = \'$info{dbname}\';"
 197                 );
 198                 if ( $rv == 1 ) {
 199                     $template->param( 'checkdatabasecreated' => 1 );
 200                 }
 201
 202                 # Check if user has all necessary grants on this database...
 203                 my $rq = $dbh->do(
 204                     "SELECT u.usesuper
 205             FROM pg_catalog.pg_user as u
 206             WHERE u.usename = \'$info{user}\';"
 207                 );
 208                 if ( $rq == 1 ) {
 209                     $template->param( "checkgrantaccess" => 1 );
 210                 }
 211             }    # End Pg connect check...
 212         }
 213         else {
 214             $template->param( "error" => DBI::err, "message" => DBI::errstr );
 215         }
 216     }
 217 }
 218 elsif ( $step && $step == 3 ) {
 219
 220     # STEP 3 : database setup
 221
 222     my $op = $query->param('op');
 223     if ( $op && $op eq 'finished' ) {
 224         #
 225         # we have finished, just redirect to mainpage.
 226         #
 227         print $query->redirect("/cgi-bin/koha/mainpage.pl");
 228         exit;
 229     }
 230     elsif ( $op && $op eq 'finish' ) {
 231         $installer->set_version_syspref();
 232
 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);
 237
 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 );
 243     }
 244
 245     elsif ( $op && $op eq 'addframeworks' ) {
 246
 247         # 1ST install, 3rd sub-step : insert the SQL files the user has selected
 248
 249         my ( $fwk_language, $list ) =
 250           $installer->load_sql_in_order( $all_languages,
 251             $query->multi_param('framework') );
 252         $template->param(
 253             "fwklanguage" => $fwk_language,
 254             "list"        => $list
 255         );
 256         use Koha::SearchEngine::Elasticsearch;
 257         Koha::SearchEngine::Elasticsearch->reset_elasticsearch_mappings;
 258         $template->param( "$op" => 1 );
 259     }
 260     elsif ( $op && $op eq 'selectframeworks' ) {
 261 #
 262 #
 263 # 1ST install, 2nd sub-step : show the user the sql datas they can insert in the database.
 264 #
 265 #
 266 # (note that the term "selectframeworks is not correct. The user can select various files, not only frameworks)
 267
 268 #Framework Selection
 269 #sql data for import are supposed to be located in installer/data/<language>/<level>
 270 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
 271 # Where <level> is a category of requirement : required, recommended optional
 272 # level should contain :
 273 #   SQL File for import With a readable name.
 274 #   txt File that explains what this SQL File is meant for.
 275 # Could be VERY useful to have A Big file for a kind of library.
 276 # But could also be useful to have some Authorised values data set prepared here.
 277 # Framework Selection is achieved through checking boxes.
 278         my $langchoice = $query->param('fwklanguage');
 279         $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
 280         $langchoice =~ s/[^a-zA-Z_-]*//g;
 281         my $marcflavour = $query->param('marcflavour');
 282         if ($marcflavour) {
 283             $installer->set_marcflavour_syspref($marcflavour);
 284         }
 285         $marcflavour = C4::Context->preference('marcflavour')
 286           unless ($marcflavour);
 287
 288         #Insert into database the selected marcflavour
 289         undef $/;
 290         my ( $marc_defaulted_to_en, $fwklist ) =
 291           $installer->marc_framework_sql_list( $langchoice, $marcflavour );
 292         $template->param( 'en_marc_frameworks' => $marc_defaulted_to_en );
 293         $template->param( "frameworksloop"     => $fwklist );
 294         $template->param( "marcflavour"        => ucfirst($marcflavour) );
 295
 296         my ( $sample_defaulted_to_en, $levellist ) =
 297           $installer->sample_data_sql_list($langchoice);
 298         $template->param( "en_sample_data" => $sample_defaulted_to_en );
 299         $template->param( "levelloop"      => $levellist );
 300         $template->param( "$op"            => 1 );
 301
 302     }
 303     elsif ( $op && $op eq 'choosemarc' ) {
 304         #
 305         #
 306         # 1ST install, 2nd sub-step : show the user the marcflavour available.
 307         #
 308         #
 309
 310 #Choose Marc Flavour
 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 that 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');
 322
 323         $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
 324         $langchoice =~ s/[^a-zA-Z_-]*//g;
 325         my $dir =
 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";
 331             }
 332             else {
 333                 # if no translated MARC framework is available,
 334                 # default to English
 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";
 339             }
 340         }
 341         my @listdir = grep { !/^\./ && -d "$dir/$_" } readdir(MYDIR);
 342         closedir MYDIR;
 343         my $marcflavour = C4::Context->preference("marcflavour");
 344         my @flavourlist;
 345         foreach my $marc (@listdir) {
 346              my %cell=(
 347                  "label"=> ucfirst($marc),
 348                   "code"=>uc($marc),
 349                "checked"=> defined($marcflavour) ? uc($marc) eq $marcflavour : 0);
 350 #             $cell{"description"}= do { local $/ = undef; open INPUT "<$dir/$marc.txt"||"";<INPUT> };
 351              push @flavourlist, \%cell;
 352         }
 353         $template->param( "flavourloop" => \@flavourlist );
 354         $template->param( "$op"         => 1 );
 355     }
 356     elsif ( $op && $op eq 'importdatastructure' ) {
 357         #
 358         #
 359         # 1st install, 1st "sub-step" : import kohastructure
 360         #
 361         #
 362         my $error = $installer->load_db_schema();
 363         $template->param(
 364             "error" => $error,
 365             "$op"   => 1,
 366         );
 367     }
 368     elsif ( $op && $op eq 'updatestructure' ) {
 369         #
 370         # Not 1st install, the only sub-step : update database
 371         #
 372         #Do updatedatabase And report
 373
 374         if ( !defined $ENV{PERL5LIB} ) {
 375             my $find = "C4/Context.pm";
 376             my $path = $INC{$find};
 377             $path =~ s/\Q$find\E//;
 378             $ENV{PERL5LIB} = "$path:$path/installer";
 379             warn "# plack? inserted PERL5LIB $ENV{PERL5LIB}\n";
 380         }
 381
 382         my $now         = POSIX::strftime( "%Y-%m-%dT%H:%M:%S", localtime() );
 383         my $logdir      = C4::Context->config('logdir');
 384         my $dbversion   = C4::Context->preference('Version');
 385         my $kohaversion = Koha::version;
 386         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 387
 388         my $filename_suffix = join '_', $now, $dbversion, $kohaversion;
 389         my ( $logfilepath, $logfilepath_errors ) = (
 390             chk_log( $logdir, "updatedatabase_$filename_suffix" ),
 391             chk_log( $logdir, "updatedatabase-error_$filename_suffix" )
 392         );
 393
 394         my $cmd = C4::Context->config("intranetdir")
 395           . "/installer/data/$info{dbms}/updatedatabase.pl >> $logfilepath 2>> $logfilepath_errors";
 396
 397         system($cmd );
 398
 399         my $fh;
 400         open( $fh, "<:encoding(utf-8)", $logfilepath )
 401           or die "Cannot open log file $logfilepath: $!";
 402         my @report = <$fh>;
 403         close $fh;
 404         if (@report) {
 405             $template->param( update_report =>
 406                   [ map { local $_ = $_; $_ =~ s/\t/&emsp;&emsp;/g; { line => $_ } } split( /\n/, join( '', @report ) ) ]
 407             );
 408             $template->param( has_update_succeeds => 1 );
 409         }
 410         else {
 411             eval { `rm $logfilepath` };
 412         }
 413         open( $fh, "<:encoding(utf-8)", $logfilepath_errors )
 414           or die "Cannot open log file $logfilepath_errors: $!";
 415         @report = <$fh>;
 416         close $fh;
 417         if (@report) {
 418             $template->param( update_errors =>
 419                   [ map { { line => $_ } } split( /\n/, join( '', @report ) ) ]
 420             );
 421             $template->param( has_update_errors => 1 );
 422             warn
 423 "The following errors were returned while attempting to run the updatedatabase.pl script:\n";
 424             foreach my $line (@report) { warn "$line\n"; }
 425         }
 426         else {
 427             eval { `rm $logfilepath_errors` };
 428         }
 429         $template->param( $op => 1 );
 430     }
 431     else {
 432 #
 433 # check whether it's a 1st install or an update
 434 #
 435 #Check if there are enough tables.
 436 # Paul has cleaned up tables so reduced the count
 437 #I put it there because it implied a data import if condition was not satisfied.
 438         my $dbh = DBI->connect(
 439                 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
 440                 . ( $info{port} ? ";port=$info{port}" : "" )
 441                 . ( $info{tlsoptions} ? $info{tlsoptions} : "" ),
 442                 $info{'user'}, $info{'password'}
 443         );
 444         my $rq;
 445         if ( $info{dbms} eq 'mysql' ) { $rq = $dbh->prepare("SHOW TABLES"); }
 446         elsif ( $info{dbms} eq 'Pg' ) {
 447             $rq = $dbh->prepare(
 448                 "SELECT *
 449                 FROM information_schema.tables
 450                 WHERE table_schema='public' and table_type='BASE TABLE';"
 451             );
 452         }
 453         $rq->execute;
 454         my $data = $rq->fetchall_arrayref( {} );
 455         my $count = scalar(@$data);
 456         #
 457         # we don't have tables, propose DB import
 458         #
 459         if ( $count < 70 ) {
 460             $template->param( "count" => $count, "proposeimport" => 1 );
 461         }
 462         else {
 463            #
 464            # we have tables, propose to select files to upload or updatedatabase
 465            #
 466             $template->param( "count" => $count, "default" => 1 );
 467      #
 468      # 1st part of step 3 : check if there is a databaseversion systempreference
 469      # if there is, then we just need to upgrade
 470      # if there is none, then we need to install the database
 471      #
 472             if ( C4::Context->preference('Version') ) {
 473                 my $dbversion = C4::Context->preference('Version');
 474                 $dbversion =~ /(.*)\.(..)(..)(...)/;
 475                 $dbversion = "$1.$2.$3.$4";
 476                 $template->param(
 477                     "upgrading"   => 1,
 478                     "dbversion"   => $dbversion,
 479                     "kohaversion" => Koha::version(),
 480                 );
 481             }
 482         }
 483     }
 484 }
 485 else {
 486
 487     # LANGUAGE SELECTION page by default
 488     # using opendir + language Hash
 489     my $languages_loop = getTranslatedLanguages('intranet');
 490     $template->param( installer_languages_loop => $languages_loop );
 491     if ($dbh) {
 492         my $rq =
 493           $dbh->prepare(
 494             "SELECT * from systempreferences WHERE variable='Version'");
 495         if ( $rq->execute ) {
 496             my ($version) = $rq->fetchrow;
 497             if ($version) {
 498                 print $query->redirect(
 499                     "/cgi-bin/koha/installer/install.pl?step=3");
 500                 exit;
 501             }
 502         }
 503     }
 504 }
 505 output_html_with_http_headers $query, $cookie, $template->output;
 506
 507 sub chk_log {    #returns a logfile in $dir or - if that failed - in temp dir
 508     my ( $dir, $name ) = @_;
 509     my $fn = $dir . '/' . $name . '.log';
 510     if ( !open my $fh, '>', $fn ) {
 511         $name .= '_XXXX';
 512         require File::Temp;
 513         ( $fh, $fn ) =
 514           File::Temp::tempfile( $name, TMPDIR => 1, SUFFIX => '.log' );
 515
 516         #if this should not work, let croak take over
 517     }
 518     return $fn;
 519 }