Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/installer/install.pl
Galen Charlton ecc779fa50 refactor web installer code to created C4::Installer 
Created a new module, C4::Installer, which embodies
most of the code from installer/install.pl that handles
identifying and loading SQL scripts and setting the
Version, marcflavour, FrameworksLoad, and NoZebra
system preferences.

With C4::Installer, it is now easier to automate
initializing and populating a Koha database.  This will
help allow the test suite to set up a test database
in order to run DB-dependent tests, as well as write
a command-line installer which may be of use to hosts
that need to support multiple Koha databases.

Signed-off-by: Galen Charlton <galen.charlton@liblime.com>
Signed-off-by: Joshua Ferraro <jmf@liblime.com>
2008-04-21 11:26:23 -05:00

475 lines
18 KiB
Perl
Executable file
Raw Blame History

#!/usr/bin/perl -w # please develop with -w
use diagnostics;
# use Install;
use InstallAuth;
use C4::Context;
use C4::Output;
use C4::Languages qw(getAllLanguages getTranslatedLanguages);
use C4::Installer;
use strict; # please develop with the strict pragma
use CGI;
my $query = new CGI;
my $step = $query->param('step');
my $language = $query->param('language');
my ( $template, $loggedinuser, $cookie );
my $all_languages = getAllLanguages();
if ( defined($language) ) {
setlanguagecookie( $query, $language, "install.pl?step=1" );
}
( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "installer/step" . ( $step ? $step : 1 ) . ".tmpl",
query => $query,
type => "intranet",
authnotrequired => 0,
debug => 1,
}
);
my $installer = C4::Installer->new();
my %info;
$info{'dbname'} = C4::Context->config("database");
$info{'dbms'} =
( C4::Context->config("db_scheme")
? C4::Context->config("db_scheme")
: "mysql" );
$info{'hostname'} = C4::Context->config("hostname");
$info{'port'} = C4::Context->config("port");
$info{'user'} = C4::Context->config("user");
$info{'password'} = C4::Context->config("pass");
my $dbh = DBI->connect(
"DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
. ( $info{port} ? ";port=$info{port}" : "" ),
$info{'user'}, $info{'password'}
);
if ( $step && $step == 1 ) {
#First Step
#Checking ALL perl Modules and services needed are installed.
#Whenever there is an error, adding a report to the page
$template->param( language => 1 );
my $problem;
unless ( $] >= 5.006001 ) { # Bug 179
$template->param( "problems" => 1, "perlversion" => 1 );
$problem = 1;
}
# We could here use a special find
my @missing = ();
unless ( eval { require ZOOM } ) {
push @missing, { name => "ZOOM" };
}
unless ( eval { require YAML::Syck } ) {
push @missing, { name => "YAML::Syck" };
}
unless ( eval { require LWP::Simple } ) {
push @missing, { name => "LWP::Simple" };
}
unless ( eval { require XML::Simple } ) {
push @missing, { name => "XML::Simple" };
}
unless ( eval { require MARC::File::XML } ) {
push @missing, { name => "MARC::File::XML" };
}
unless ( eval { require MARC::File::USMARC } ) {
push @missing, { name => "MARC::File::USMARC" };
}
unless ( eval { require DBI } ) {
push @missing, { name => "DBI" };
}
unless ( eval { require Date::Manip } ) {
push @missing, { name => "Date::Manip" };
}
unless ( eval { require DBD::mysql } ) {
push @missing, { name => "DBD::mysql" };
}
unless ( eval { require HTML::Template::Pro } ) {
push @missing, { name => "HTML::Template::Pro" };
}
unless ( eval { require Date::Calc } ) {
push @missing, { name => "Date::Calc" };
}
unless ( eval { require Digest::MD5 } ) {
push @missing, { name => "Digest::MD5" };
}
unless ( eval { require MARC::Record } ) {
push @missing, { name => "MARC::Record" };
}
unless ( eval { require Mail::Sendmail } ) {
push @missing, { name => "Mail::Sendmail", usagemail => 1 };
}
unless ( eval { require List::MoreUtils } ) {
push @missing, { name => "List::MoreUtils" };
}
unless ( eval { require XML::RSS } ) {
push @missing, { name => "XML::RSS" };
}
unless ( eval { require CGI::Carp } ) {
push @missing, { name => "CGI::Carp" };
}
# The following modules are not mandatory, depends on how the library want to use Koha
unless ( eval { require PDF::API2 } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "PDF::API2", usagebarcode => 1 };
}
}
unless ( eval { require GD::Barcorde } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing,
{ name => "GD::Barcode", usagebarcode => 1, usagespine => 1 };
}
}
unless ( eval { require Data::Random } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "Data::Random", usagebarcode => 1 };
}
}
unless ( eval { require PDF::Reuse::Barcode } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "PDF::Reuse::Barcode", usagebarcode => 1 };
}
}
unless ( eval { require PDF::Report } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "PDF::Report", usagebarcode => 1 };
}
}
unless ( eval { require Algorithm::CheckDigits } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "Algorithm::CheckDigits", usagebarcode => 1 };
}
}
unless ( eval { require GD::Barcode::UPCE } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "GD::Barcode::UPCE", usagepine => 1 };
}
}
unless ( eval { require Net::LDAP } ) {
if ( $#missing >= 0 ) { # only when $#missing >= 0 so this isn't fatal
push @missing, { name => "Net::LDAP", usageLDAP => 1 };
}
}
$template->param( missings => \@missing ) if ( scalar(@missing) > 0 );
$template->param( 'checkmodule' => 1 )
unless ( scalar(@missing) && $problem );
}
elsif ( $step && $step == 2 ) {
#
#STEP 2 Check Database connection and access
#
$template->param(%info);
my $checkdb = $query->param("checkdb");
$template->param( 'dbconnection' => $checkdb );
if ($checkdb) {
if ($dbh) {
# Can connect to the mysql
$template->param( "checkdatabaseaccess" => 1 );
if ( $info{dbms} eq "mysql" ) {
#Check if database created
my $rv = $dbh->do("SHOW DATABASES LIKE \'$info{dbname}\'");
if ( $rv == 1 ) {
$template->param( 'checkdatabasecreated' => 1 );
}
#Check if user have all necessary grants on this database.
my $rq =
$dbh->prepare(
"SHOW GRANTS FOR \'$info{user}\'\@'$info{hostname}'");
$rq->execute;
my $grantaccess;
while ( my ($line) = $rq->fetchrow ) {
my $dbname = $info{dbname};
if ( $line =~ m/^GRANT (.*?) ON `$dbname`\.\*/ || index( $line, '*.*' ) > 0 ) {
$grantaccess = 1
if (
index( $line, 'ALL PRIVILEGES' ) > 0
|| ( ( index( $line, 'SELECT' ) > 0 )
&& ( index( $line, 'INSERT' ) > 0 )
&& ( index( $line, 'UPDATE' ) > 0 )
&& ( index( $line, 'DELETE' ) > 0 )
&& ( index( $line, 'CREATE' ) > 0 )
&& ( index( $line, 'DROP' ) > 0 ) )
);
}
}
unless ($grantaccess) {
$rq =
$dbh->prepare("SHOW GRANTS FOR \'$info{user}\'\@'\%'");
$rq->execute;
while ( my ($line) = $rq->fetchrow ) {
my $dbname = $info{dbname};
if ( $line =~ m/$dbname/ || index( $line, '*.*' ) > 0 )
{
$grantaccess = 1
if (
index( $line, 'ALL PRIVILEGES' ) > 0
|| ( ( index( $line, 'SELECT' ) > 0 )
&& ( index( $line, 'INSERT' ) > 0 )
&& ( index( $line, 'UPDATE' ) > 0 )
&& ( index( $line, 'DELETE' ) > 0 )
&& ( index( $line, 'CREATE' ) > 0 )
&& ( index( $line, 'DROP' ) > 0 ) )
);
}
}
}
$template->param( "checkgrantaccess" => $grantaccess );
} # End mysql connect check...
elsif ( $info{dbms} eq "Pg" ) {
# Check if database has been created...
my $rv = $dbh->do( "SELECT * FROM pg_catalog.pg_database WHERE datname = \'$info{dbname}\';" );
if ( $rv == 1 ) {
$template->param( 'checkdatabasecreated' => 1 );
}
# Check if user has all necessary grants on this database...
my $rq = $dbh->do( "SELECT u.usesuper
FROM pg_catalog.pg_user as u
WHERE u.usename = \'$info{user}\';" );
if ( $rq == 1 ) {
$template->param( "checkgrantaccess" => 1 );
}
} # End Pg connect check...
}
else {
$template->param( "error" => DBI::err, "message" => DBI::errstr );
}
}
}
elsif ( $step && $step == 3 ) {
#
#
# STEP 3 : database setup
#
#
my $op = $query->param('op');
if ( $op && $op eq 'finished' ) {
#
# we have finished, just redirect to mainpage.
#
print $query->redirect("/cgi-bin/koha/mainpage.pl");
exit 1;
}
elsif ( $op && $op eq 'finish' ) {
$installer->set_version_syspref();
# Installation is finished.
# We just deny anybody access to install
# And we redirect people to mainpage.
# The installer will have to relogin since we do not pass cookie to redirection.
$template->param( "$op" => 1 );
}
elsif ( $op && $op eq 'SetIndexingEngine' ) {
$installer->set_indexing_engine($query->param('NoZebra'));
$template->param( "$op" => 1 );
}
elsif ( $op && $op eq 'addframeworks' ) {
#
# 1ST install, 3rd sub-step : insert the SQL files the user has selected
#
my ($fwk_language, $list) = $installer->load_sql_in_order($all_languages, $query->param('framework'));
$template->param(
"fwklanguage" => $fwk_language,
"list" => $list
);
$template->param( "$op" => 1 );
}
elsif ( $op && $op eq 'selectframeworks' ) {
#
#
# 1ST install, 2nd sub-step : show the user the sql datas he can insert in the database.
#
#
# (note that the term "selectframeworks is not correct. The user can select various files, not only frameworks)
#Framework Selection
#sql data for import are supposed to be located in installer/data/<language>/<level>
# Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
# Where <level> is a category of requirement : required, recommended optional
# level should contain :
# SQL File for import With a readable name.
# txt File taht explains what this SQL File is meant for.
# Could be VERY useful to have A Big file for a kind of library.
# But could also be useful to have some Authorised values data set prepared here.
# Framework Selection is achieved through checking boxes.
my $langchoice = $query->param('fwklanguage');
$langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
my $marcflavour = $query->param('marcflavour');
if ($marcflavour){
$installer->set_marcflavour_syspref($marcflavour);
};
$marcflavour = C4::Context->preference('marcflavour') unless ($marcflavour);
#Insert into database the selected marcflavour
undef $/;
my ($marc_defaulted_to_en, $fwklist) = $installer->marc_framework_sql_list($langchoice, $marcflavour);
$template->param('en_marc_frameworks' => $marc_defaulted_to_en);
$template->param( "frameworksloop" => $fwklist );
$template->param( "marcflavour" => ucfirst($marcflavour));
my ($sample_defaulted_to_en, $levellist) = $installer->sample_data_sql_list($langchoice, $marcflavour);
$template->param( "en_sample_data" => $sample_defaulted_to_en);
$template->param( "levelloop" => $levellist );
$template->param( "$op" => 1 );
}
elsif ( $op && $op eq 'choosemarc' ) {
#
#
# 1ST install, 2nd sub-step : show the user the marcflavour available.
#
#
#Choose Marc Flavour
#sql data are supposed to be located in installer/data/<dbms>/<language>/marcflavour/marcflavourname
# Where <dbms> is database type according to DBD syntax
# Where <language> is en|fr or any international abbreviation (provided language hash is updated... This will be a problem with internationlisation.)
# Where <level> is a category of requirement : required, recommended optional
# level should contain :
# SQL File for import With a readable name.
# txt File taht explains what this SQL File is meant for.
# Could be VERY useful to have A Big file for a kind of library.
# But could also be useful to have some Authorised values data set prepared here.
# Marcflavour Selection is achieved through radiobuttons.
my $langchoice = $query->param('fwklanguage');
$langchoice = $query->cookie('KohaOpacLanguage') unless ($langchoice);
my $dir =
C4::Context->config('intranetdir') . "/installer/data/$info{dbms}/$langchoice/marcflavour";
unless (opendir( MYDIR, $dir )) {
if ($langchoice eq 'en') {
warn "cannot open MARC frameworks directory $dir";
} else {
# if no translated MARC framework is available,
# default to English
$dir = C4::Context->config('intranetdir') . "/installer/data/$info{dbms}/en/marcflavour";
opendir(MYDIR, $dir) or warn "cannot open English MARC frameworks directory $dir";
}
}
my @listdir = grep { !/^\./ && -d "$dir/$_" } readdir(MYDIR);
closedir MYDIR;
my $marcflavour=C4::Context->preference("marcflavour");
my @flavourlist;
foreach my $marc (@listdir) {
my %cell=(
"label"=> ucfirst($marc),
"code"=>uc($marc),
"checked"=> defined($marcflavour) ? uc($marc) eq $marcflavour : 0);
# $cell{"description"}= do { local $/ = undef; open INPUT "<$dir/$marc.txt"||"";<INPUT> };
push @flavourlist, \%cell;
}
$template->param( "flavourloop" => \@flavourlist );
$template->param( "$op" => 1 );
}
elsif ( $op && $op eq 'importdatastructure' ) {
#
#
# 1st install, 1st "sub-step" : import kohastructure
#
#
my $error = $installer->load_db_schema();
$template->param(
"error" => $error,
"$op" => 1,
);
}
elsif ( $op && $op eq 'updatestructure' ) {
#
# Not 1st install, the only sub-step : update database
#
#Do updatedatabase And report
my $execstring =
C4::Context->config("intranetdir") . "/installer/data/$info{dbms}/updatedatabase.pl";
undef $/;
my $string = qx($execstring 2>&1 1>/dev/null); # added '1>/dev/null' to return only stderr in $string. Needs testing here. -fbcit
if ($string) {
$string =~ s/\n|\r/<br \/>/g;
$string =~
s/(DBD::mysql.*? failed: .*? line [0-9]*.|=================.*?====================)/<font color=red>$1<\/font>/g;
$template->param( "updatereport" => $string );
}
$template->param( $op => 1 );
}
else {
#
# check wether it's a 1st install or an update
#
#Check if there are enough tables.
# Paul has cleaned up tables so reduced the count
#I put it there because it implied a data import if condition was not satisfied.
my $dbh = DBI->connect(
"DBI:$info{dbms}:dbname=$info{dbname};host=$info{hostname}"
. ( $info{port} ? ";port=$info{port}" : "" ),
$info{'user'}, $info{'password'}
);
my $rq;
if ( $info{dbms} eq 'mysql' ) { $rq = $dbh->prepare( "SHOW TABLES FROM " . $info{'dbname'} ); }
elsif ( $info{dbms} eq 'Pg' ) { $rq = $dbh->prepare( "SELECT *
FROM information_schema.tables
WHERE table_schema='public' and table_type='BASE TABLE';" ); }
$rq->execute;
my $data = $rq->fetchall_arrayref( {} );
my $count = scalar(@$data);
#
# we don't have tables, propose DB import
#
if ( $count < 70 ) {
$template->param( "count" => $count, "proposeimport" => 1 );
}
else {
#
# we have tables, propose to select files to upload or updatedatabase
#
$template->param( "count" => $count, "default" => 1 );
#
# 1st part of step 3 : check if there is a databaseversion systempreference
# if there is, then we just need to upgrade
# if there is none, then we need to install the database
#
if (C4::Context->preference('Version')) {
my $dbversion = C4::Context->preference('Version');
$dbversion =~ /(.*)\.(..)(..)(...)/;
$dbversion = "$1.$2.$3.$4";
$template->param("upgrading" => 1,
"dbversion" => $dbversion,
"kohaversion" => C4::Context->KOHAVERSION,
);
}
}
$dbh->disconnect;
}
}
else {
# LANGUAGE SELECTION page by default
# using opendir + language Hash
my $languages_loop = getTranslatedLanguages('intranet');
$template->param( installer_languages_loop => $languages_loop );
if ($dbh) {
my $rq =
$dbh->prepare(
"SELECT * from systempreferences WHERE variable='Version'");
if ( $rq->execute ) {
my ($version) = $rq->fetchrow;
if ($version) {
$query->redirect("install.pl?step=3");
exit;
}
}
}
}
output_html_with_http_headers $query, $cookie, $template->output;
View git blame Copy permalink