1 #!/usr/bin/perl -w # please develop with -w
11 use strict; # please develop with the strict pragma
16 my $step = $query->param('step');
18 my $language = $query->param('language');
19 my ( $template, $loggedinuser, $cookie );
21 my $all_languages = getAllLanguages();
23 if ( defined($language) ) {
24 setlanguagecookie( $query, $language, "install.pl?step=1" );
26 ( $template, $loggedinuser, $cookie ) = get_template_and_user(
28 template_name => "installer/step" . ( $step ? $step : 1 ) . ".tmpl",
37 $info{'dbname'} = C4::Context->config("database");
39 ( C4::Context->config("db_scheme")
40 ? C4::Context->config("db_scheme")
42 $info{'hostname'} = C4::Context->config("hostname");
43 $info{'port'} = C4::Context->config("port");
44 $info{'user'} = C4::Context->config("user");
45 $info{'password'} = C4::Context->config("pass");
46 my $dbh = DBI->connect(
47 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
48 . ( $info{port} ? ";port=$info{port}" : "" ),
49 $info{'user'}, $info{'password'}
52 if ( $step && $step == 1 ) {
54 #Checking ALL perl Modules and services needed are installed.
55 #Whenever there is an error, adding a report to the page
56 $template->param( language => 1 );
59 unless ( $] >= 5.006001 ) { # Bug 179
60 $template->param( "problems" => 1, "perlversion" => 1 );
64 # We could here use a special find
66 unless ( eval { require ZOOM } ) {
67 push @missing, { name => "ZOOM" };
69 unless ( eval { require LWP::Simple } ) {
70 push @missing, { name => "LWP::Simple" };
72 unless ( eval { require XML::Simple } ) {
73 push @missing, { name => "XML::Simple" };
75 unless ( eval { require MARC::File::XML } ) {
76 push @missing, { name => "MARC::File::XML" };
78 unless ( eval { require MARC::File::USMARC } ) {
79 push @missing, { name => "MARC::File::USMARC" };
81 unless ( eval { require DBI } ) {
82 push @missing, { name => "DBI" };
84 unless ( eval { require Date::Manip } ) {
85 push @missing, { name => "Date::Manip" };
87 unless ( eval { require DBD::mysql } ) {
88 push @missing, { name => "DBD::mysql" };
90 unless ( eval { require HTML::Template::Pro } ) {
91 push @missing, { name => "HTML::Template::Pro" };
93 unless ( eval { require Date::Calc } ) {
94 push @missing, { name => "Date::Calc" };
96 unless ( eval { require Digest::MD5 } ) {
97 push @missing, { name => "Digest::MD5" };
99 unless ( eval { require MARC::Record } ) {
100 push @missing, { name => "MARC::Record" };
102 unless ( eval { require Mail::Sendmail } ) {
103 push @missing, { name => "Mail::Sendmail", usagemail => 1 };
105 unless ( eval { require List::MoreUtils } ) {
106 push @missing, { name => "List::MoreUtils" };
108 unless ( eval { require XML::RSS } ) {
109 push @missing, { name => "XML::RSS" };
111 unless ( eval { require CGI::Carp } ) {
112 push @missing, { name => "CGI::Carp" };
116 # The following modules are not mandatory, depends on how the library want to use Koha
117 unless ( eval { require PDF::API2 } ) {
118 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
119 push @missing, { name => "PDF::API2", usagebarcode => 1 };
122 unless ( eval { require GD::Barcorde } ) {
123 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
125 { name => "GD::Barcode", usagebarcode => 1, usagespine => 1 };
128 unless ( eval { require Data::Random } ) {
129 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
130 push @missing, { name => "Data::Random", usagebarcode => 1 };
133 unless ( eval { require PDF::Reuse::Barcode } ) {
134 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
135 push @missing, { name => "PDF::Reuse::Barcode", usagebarcode => 1 };
138 unless ( eval { require PDF::Report } ) {
139 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
140 push @missing, { name => "PDF::Report", usagebarcode => 1 };
143 unless ( eval { require Algorithm::CheckDigits } ) {
144 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
145 push @missing, { name => "Algorithm::CheckDigits", usagebarcode => 1 };
148 unless ( eval { require GD::Barcode::UPCE } ) {
149 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
150 push @missing, { name => "GD::Barcode::UPCE", usagepine => 1 };
153 unless ( eval { require Net::LDAP } ) {
154 if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
155 push @missing, { name => "Net::LDAP", usageLDAP => 1 };
158 $template->param( missings => \@missing ) if ( scalar(@missing) > 0 );
159 $template->param( 'checkmodule' => 1 )
160 unless ( scalar(@missing) && $problem );
163 elsif ( $step && $step == 2 ) {
165 #STEP 2 Check Database connection and access
167 $template->param(%info);
168 my $checkdb = $query->param("checkdb");
169 $template->param( 'dbconnection' => $checkdb );
173 # Can connect to the mysql
174 $template->param( "checkdatabaseaccess" => 1 );
175 if ( $info{dbms} eq "mysql" ) {
177 #Check if database created
178 my $rv = $dbh->do("SHOW DATABASES LIKE \'$info{dbname}\'");
180 $template->param( 'checkdatabasecreated' => 1 );
183 #Check if user have all necessary grants on this database.
186 "SHOW GRANTS FOR \'$info{user}\'\@'$info{hostname}'");
189 while ( my ($line) = $rq->fetchrow ) {
190 my $dbname = $info{dbname};
191 if ( $line =~ m/^GRANT (.*?) ON `$dbname`\.\*/ || index( $line, '*.*' ) > 0 ) {
194 index( $line, 'ALL PRIVILEGES' ) > 0
195 || ( ( index( $line, 'SELECT' ) > 0 )
196 && ( index( $line, 'INSERT' ) > 0 )
197 && ( index( $line, 'UPDATE' ) > 0 )
198 && ( index( $line, 'DELETE' ) > 0 )
199 && ( index( $line, 'CREATE' ) > 0 )
200 && ( index( $line, 'DROP' ) > 0 ) )
204 unless ($grantaccess) {
206 $dbh->prepare("SHOW GRANTS FOR \'$info{user}\'\@'\%'");
208 while ( my ($line) = $rq->fetchrow ) {
209 my $dbname = $info{dbname};
210 if ( $line =~ m/$dbname/ || index( $line, '*.*' ) > 0 )
214 index( $line, 'ALL PRIVILEGES' ) > 0
215 || ( ( index( $line, 'SELECT' ) > 0 )
216 && ( index( $line, 'INSERT' ) > 0 )
217 && ( index( $line, 'UPDATE' ) > 0 )
218 && ( index( $line, 'DELETE' ) > 0 )
219 && ( index( $line, 'CREATE' ) > 0 )
220 && ( index( $line, 'DROP' ) > 0 ) )
225 $template->param( "checkgrantaccess" => $grantaccess );
226 } # End mysql connect check...
228 elsif ( $info{dbms} eq "Pg" ) {
229 # Check if database has been created...
230 my $rv = $dbh->do( "SELECT * FROM pg_catalog.pg_database WHERE datname = \'$info{dbname}\';" );
232 $template->param( 'checkdatabasecreated' => 1 );
235 # Check if user has all necessary grants on this database...
236 my $rq = $dbh->do( "SELECT u.usesuper
237 FROM pg_catalog.pg_user as u
238 WHERE u.usename = \'$info{user}\';" );
240 $template->param( "checkgrantaccess" => 1 );
242 } # End Pg connect check...
245 $template->param( "error" => DBI::err, "message" => DBI::errstr );
249 elsif ( $step && $step == 3 ) {
252 # STEP 3 : database setup
255 my $op = $query->param('op');
256 if ( $op && $op eq 'finished' ) {
258 # we have finished, just redirect to mainpage.
260 print $query->redirect("/cgi-bin/koha/mainpage.pl");
263 elsif ( $op && $op eq 'finish' ) {
264 my $kohaversion=C4::Context::KOHAVERSION;
265 # remove the 3 last . to have a Perl number
266 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
267 if (C4::Context->preference('Version')) {
268 warn "UPDATE Version";
269 my $finish=$dbh->prepare("UPDATE systempreferences SET value=? WHERE variable='Version'");
270 $finish->execute($kohaversion);
272 warn "INSERT Version";
273 my $finish=$dbh->prepare("INSERT into systempreferences (variable,value,explanation) values ('Version',?,'The Koha database version. Don t change this value manually, it s holded by the webinstaller')");
274 $finish->execute($kohaversion);
277 # Installation is finished.
278 # We just deny anybody access to install
279 # And we redirect people to mainpage.
280 # The installer will have to relogin since we do not pass cookie to redirection.
281 $template->param( "$op" => 1 );
283 elsif ( $op && $op eq 'SetIndexingEngine' ) {
284 if ($query->param('NoZebra')) {
285 $dbh->do("UPDATE systempreferences SET value=1 WHERE variable='NoZebra'");
286 $dbh->do("UPDATE systempreferences SET value=0 WHERE variable in ('QueryFuzzy','QueryWeightFields','QueryStemming')");
288 $dbh->do("UPDATE systempreferences SET value=0 WHERE variable='NoZebra'");
290 $template->param( "$op" => 1 );
292 elsif ( $op && $op eq 'addframeworks' ) {
294 # 1ST install, 3rd sub-step : insert the SQL files the user has selected
297 #Framework importing and reports
301 # sort by filename -> prepend with numbers to specify order of insertion.
303 my @aa = split /\/|\\/, ($a);
304 my @bb = split /\/|\\/, ($b);
306 } $query->param('framework');
309 "SELECT value FROM systempreferences WHERE variable='FrameworksLoaded'"
312 my ($systempreference) = $request->fetchrow;
313 $systempreference = '' unless defined $systempreference; # avoid warning
314 foreach my $file (@fnames) {
319 if ( $info{dbms} eq 'mysql' ) {
320 my $strcmd = "mysql "
321 . ( $info{hostname} ? " -h $info{hostname} " : "" )
322 . ( $info{port} ? " -P $info{port} " : "" )
323 . ( $info{user} ? " -u $info{user} " : "" )
324 . ( $info{password} ? " -p$info{password}" : "" )
326 $error = qx($strcmd < $file 2>&1 1>/dev/null); # We want to send stdout to null and return only stderr... -fbcit
328 elsif ( $info{dbms} eq 'Pg' ) {
330 . ( $info{hostname} ? " -h $info{hostname} " : "" )
331 . ( $info{port} ? " -p $info{port} " : "" )
332 . ( $info{user} ? " -U $info{user} " : "" )
333 # . ( $info{password} ? " -W $info{password}" : "" )
335 $error = qx($strcmd -f $file 2>&1 1>/dev/null); # ...even more so with psql...
337 my @file = split qr(\/|\\), $file;
338 $lang = $file[ scalar(@file) - 3 ] unless ($lang);
339 my $level = $file[ scalar(@file) - 2 ];
341 $systempreference .= "$file[scalar(@file)-1]|"
343 index( $systempreference, $file[ scalar(@file) - 1 ] ) >=
347 #Bulding here a hierarchy to display files by level.
348 push @{ $hashlevel{$level} },
349 { "fwkname" => $file[ scalar(@file) - 1 ], "error" => $error };
352 #systempreference contains an ending |
353 chop $systempreference;
355 map { push @list, { "level" => $_, "fwklist" => $hashlevel{$_} } }
358 for my $each_language (@$all_languages) {
360 # warn "CODE".$each_language->{'language_code'};
361 # warn "LANG:".$lang;
362 if ( $lang eq $each_language->{'language_code'} ) {
363 $fwk_language = $each_language->{language_locale_name};
368 "UPDATE systempreferences set value=\"$systempreference\" where variable='FrameworksLoaded'"
370 unless ( $updateflag == 1 ) {
372 "INSERT INTO systempreferences (value, variable, explanation, type) VALUES (\"$systempreference\",'FrameworksLoaded','Frameworks loaded through webinstaller','choice')";
373 my $rq = $dbh->prepare($string);
377 "fwklanguage" => $fwk_language,
380 $template->param( "$op" => 1 );
382 elsif ( $op && $op eq 'selectframeworks' ) {
385 # 1ST install, 2nd sub-step : show the user the sql datas he can insert in the database.
388 # (note that the term "selectframeworks is not correct. The user can select various files, not only frameworks)
391 #sql data for import are supposed to be located in installer/data/<language>/<level>
392 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
393 # Where <level> is a category of requirement : required, recommended optional
394 # level should contain :
395 # SQL File for import With a readable name.
396 # txt File taht explains what this SQL File is meant for.
397 # Could be VERY useful to have A Big file for a kind of library.
398 # But could also be useful to have some Authorised values data set prepared here.
399 # Framework Selection is achieved through checking boxes.
400 my $langchoice = $query->param('fwklanguage');
401 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
402 my $marcflavour = $query->param('marcflavour');
404 # we can have some variants of marc flavour, by having different directories, like : unimarc_small and unimarc_full, for small and complete unimarc frameworks.
405 # marc_cleaned finds the marcflavour, without the variant.
406 my $marc_cleaned = 'MARC21';
407 $marc_cleaned = 'UNIMARC' if $marcflavour =~ /unimarc/;
410 "INSERT IGNORE INTO `systempreferences` (variable,value,explanation,options,type) VALUES('marcflavour','$marc_cleaned','Define global MARC flavor (MARC21 or UNIMARC) used for character encoding','MARC21|UNIMARC','Choice');"
414 $marcflavour = C4::Context->preference('marcflavour') unless ($marcflavour);
415 #Insert into database the selected marcflavour
419 C4::Context->config('intranetdir') . "/installer/data/$info{dbms}/$langchoice/marcflavour/".lc($marcflavour);
420 opendir( MYDIR, $dir ) || warn "no open $dir";
421 my @listdir = sort grep { !/^\.|marcflavour/ && -d "$dir/$_" } readdir(MYDIR);
427 "SELECT value FROM systempreferences WHERE variable='FrameworksLoaded'"
430 my ($frameworksloaded) = $request->fetchrow;
431 $frameworksloaded = '' unless defined $frameworksloaded; # avoid warning
432 my %frameworksloaded;
433 foreach ( split( /\|/, $frameworksloaded ) ) {
434 $frameworksloaded{$_} = 1;
437 foreach my $requirelevel (@listdir) {
438 opendir( MYDIR, "$dir/$requirelevel" );
440 grep { !/^\./ && -f "$dir/$requirelevel/$_" && $_ =~ m/\.sql$/ }
446 my $name = substr( $_, 0, -4 );
447 open FILE, "<:utf8","$dir/$requirelevel/$name.txt";
449 $lines =~ s/\n|\r/<br \/>/g;
451 utf8::encode($lines) unless ( utf8::is_utf8($lines) );
455 'fwkfile' => "$dir/$requirelevel/$_",
456 'fwkdescription' => $lines,
459 $frameworksloaded{$_}
460 || ( $requirelevel =~
461 /(mandatory|requi|oblig|necess)/i )
467 sort { $a->{'fwkname'} cmp $b->{'fwkname'} } @frameworklist;
469 # $cell{"mandatory"}=($requirelevel=~/(mandatory|requi|oblig|necess)/i);
470 $cell{"frameworks"} = \@fwks;
471 $cell{"label"} = ucfirst($requirelevel);
472 $cell{"code"} = lc($requirelevel);
473 push @fwklist, \%cell;
475 $template->param( "frameworksloop" => \@fwklist );
476 $template->param( "marcflavour" => ucfirst($marcflavour));
479 C4::Context->config('intranetdir') . "/installer/data/$info{dbms}/$langchoice";
480 opendir( MYDIR, $dir ) || warn "no open $dir";
481 @listdir = sort grep { !/^\.|marcflavour/ && -d "$dir/$_" } readdir(MYDIR);
484 foreach my $requirelevel (@listdir) {
485 opendir( MYDIR, "$dir/$requirelevel" );
487 grep { !/^\./ && -f "$dir/$requirelevel/$_" && $_ =~ m/\.sql$/ }
493 my $name = substr( $_, 0, -4 );
494 open FILE, "<:utf8","$dir/$requirelevel/$name.txt";
496 $lines =~ s/\n|\r/<br \/>/g;
498 utf8::encode($lines) unless ( utf8::is_utf8($lines) );
502 'fwkfile' => "$dir/$requirelevel/$_",
503 'fwkdescription' => $lines,
506 $frameworksloaded{$_}
507 || ( $requirelevel =~
508 /(mandatory|requi|oblig|necess)/i )
514 sort { $a->{'fwkname'} cmp $b->{'fwkname'} } @frameworklist;
516 # $cell{"mandatory"}=($requirelevel=~/(mandatory|requi|oblig|necess)/i);
517 $cell{"frameworks"} = \@fwks;
518 $cell{"label"} = ucfirst($requirelevel);
519 $cell{"code"} = lc($requirelevel);
520 push @levellist, \%cell;
522 $template->param( "levelloop" => \@levellist );
523 $template->param( "$op" => 1 );
525 elsif ( $op && $op eq 'choosemarc' ) {
528 # 1ST install, 2nd sub-step : show the user the marcflavour available.
533 #sql data are supposed to be located in installer/data/<dbms>/<language>/marcflavour/marcflavourname
534 # Where <dbms> is database type according to DBD syntax
535 # Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
536 # Where <level> is a category of requirement : required, recommended optional
537 # level should contain :
538 # SQL File for import With a readable name.
539 # txt File taht explains what this SQL File is meant for.
540 # Could be VERY useful to have A Big file for a kind of library.
541 # But could also be useful to have some Authorised values data set prepared here.
542 # Marcflavour Selection is achieved through radiobuttons.
543 my $langchoice = $query->param('fwklanguage');
544 $langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
546 C4::Context->config('intranetdir') . "/installer/data/$info{dbms}/$langchoice/marcflavour";
547 opendir( MYDIR, $dir ) || warn "no open $dir";
548 my @listdir = grep { !/^\./ && -d "$dir/$_" } readdir(MYDIR);
550 my $marcflavour=C4::Context->preference("marcflavour");
552 foreach my $marc (@listdir) {
554 "label"=> ucfirst($marc),
556 "checked"=> defined($marcflavour) ? uc($marc) eq $marcflavour : 0);
557 # $cell{"description"}= do { local $/ = undef; open INPUT "<$dir/$marc.txt"||"";<INPUT> };
558 push @flavourlist, \%cell;
560 $template->param( "flavourloop" => \@flavourlist );
561 $template->param( "$op" => 1 );
563 elsif ( $op && $op eq 'importdatastructure' ) {
566 # 1st install, 1st "sub-step" : import kohastructure
569 my $datadir = C4::Context->config('intranetdir') . "/installer/data/$info{dbms}";
571 if ( $info{dbms} eq 'mysql' ) {
572 my $strcmd = "mysql "
573 . ( $info{hostname} ? " -h $info{hostname} " : "" )
574 . ( $info{port} ? " -P $info{port} " : "" )
575 . ( $info{user} ? " -u $info{user} " : "" )
576 . ( $info{password} ? " -p$info{password}" : "" )
578 $error = qx($strcmd <$datadir/kohastructure.sql 2>&1 1>/dev/null);
580 elsif ( $info{dbms} eq 'Pg' ) {
582 . ( $info{hostname} ? " -h $info{hostname} " : "" )
583 . ( $info{port} ? " -p $info{port} " : "" )
584 . ( $info{user} ? " -U $info{user} " : "" )
585 # . ( $info{password} ? " -W $info{password}" : "" ) # psql will NOT accept a password, but prompts...
586 . " $info{dbname} "; # Therefore, be sure to run 'trust' on localhost in pg_hba.conf -fbcit
587 $error = qx($strcmd -f $datadir/kohastructure.sql 2>&1 1>/dev/null);# Be sure to set 'client_min_messages = error' in postgresql.conf
588 # so that only true errors are returned to stderr or else the installer will
589 # report the import a failure although it really succeded -fbcit
596 elsif ( $op && $op eq 'updatestructure' ) {
598 # Not 1st install, the only sub-step : update database
600 #Do updatedatabase And report
602 C4::Context->config("intranetdir") . "/installer/data/$info{dbms}/updatedatabase.pl";
604 my $string = qx($execstring 2>&1 1>/dev/null); # added '1>/dev/null' to return only stderr in $string. Needs testing here. -fbcit
606 $string =~ s/\n|\r/<br \/>/g;
608 s/(DBD::mysql.*? failed: .*? line [0-9]*.|=================.*?====================)/<font color=red>$1<\/font>/g;
609 $template->param( "updatereport" => $string );
611 $template->param( $op => 1 );
615 # check wether it's a 1st install or an update
617 #Check if there are enough tables.
618 # Paul has cleaned up tables so reduced the count
619 #I put it there because it implied a data import if condition was not satisfied.
620 my $dbh = DBI->connect(
621 "DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
622 . ( $info{port} ? ";port=$info{port}" : "" ),
623 $info{'user'}, $info{'password'}
626 if ( $info{dbms} eq 'mysql' ) { $rq = $dbh->prepare( "SHOW TABLES FROM " . $info{'dbname'} ); }
627 elsif ( $info{dbms} eq 'Pg' ) { $rq = $dbh->prepare( "SELECT *
628 FROM information_schema.tables
629 WHERE table_schema='public' and table_type='BASE TABLE';" ); }
631 my $data = $rq->fetchall_arrayref( {} );
632 my $count = scalar(@$data);
634 # we don't have tables, propose DB import
637 $template->param( "count" => $count, "proposeimport" => 1 );
641 # we have tables, propose to select files to upload or updatedatabase
643 $template->param( "count" => $count, "default" => 1 );
645 # 1st part of step 3 : check if there is a databaseversion systempreference
646 # if there is, then we just need to upgrade
647 # if there is none, then we need to install the database
649 if (C4::Context->preference('Version')) {
650 my $dbversion = C4::Context->preference('Version');
651 $dbversion =~ /(.*)\.(..)(..)(...)/;
652 $dbversion = "$1.$2.$3.$4";
653 $template->param("upgrading" => 1,
654 "dbversion" => $dbversion,
655 "kohaversion" => C4::Context->KOHAVERSION,
665 # LANGUAGE SELECTION page by default
666 # using opendir + language Hash
668 my $langavail = getTranslatedLanguages();
671 foreach (@$langavail) {
674 'value' => $_->{'language_code'},
675 'description' => $_->{'language_name'}
677 if ( $_->{'language_code'} );
679 $template->param( languages => \@languages );
683 "SELECT * from systempreferences WHERE variable='Version'");
684 if ( $rq->execute ) {
685 my ($version) = $rq->fetchrow;
687 $query->redirect("install.pl?step=3");
692 output_html_with_http_headers $query, $cookie, $template->output;