3 # Copyright (C) 2008 LibLime
5 # This file is part of Koha.
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>.
22 use Encode qw( encode is_utf8 );
24 use YAML::Syck qw( LoadFile );
29 use vars qw(@ISA @EXPORT);
32 @ISA = qw( Exporter );
33 push @EXPORT, qw( foreign_key_exists index_exists column_exists TableExists);
43 my $installer = C4::Installer->new();
44 my $all_languages = getAllLanguages();
45 my $error = $installer->load_db_schema();
47 #fill $list with list of sql files
48 my ($fwk_language, $error_list) = $installer->load_sql_in_order($all_languages, @$list);
49 $installer->set_version_syspref();
50 $installer->set_marcflavour_syspref('MARC21');
60 my $installer = C4::Installer->new();
62 Creates a new installer.
71 # get basic information from context
72 $self->{'dbname'} = C4::Context->config("database");
73 $self->{'dbms'} = C4::Context->config("db_scheme") ? C4::Context->config("db_scheme") : "mysql";
74 $self->{'hostname'} = C4::Context->config("hostname");
75 $self->{'port'} = C4::Context->config("port");
76 $self->{'user'} = C4::Context->config("user");
77 $self->{'password'} = C4::Context->config("pass");
78 $self->{'tls'} = C4::Context->config("tls");
79 if( $self->{'tls'} && $self->{'tls'} eq 'yes' ) {
80 $self->{'ca'} = C4::Context->config('ca');
81 $self->{'cert'} = C4::Context->config('cert');
82 $self->{'key'} = C4::Context->config('key');
83 $self->{'tlsoptions'} = ";mysql_ssl=1;mysql_ssl_client_key=".$self->{key}.";mysql_ssl_client_cert=".$self->{cert}.";mysql_ssl_ca_file=".$self->{ca};
84 $self->{'tlscmdline'} = " --ssl-cert ". $self->{cert} . " --ssl-key " . $self->{key} . " --ssl-ca ".$self->{ca}." "
86 $self->{'dbh'} = DBI->connect("DBI:$self->{dbms}:dbname=$self->{dbname};host=$self->{hostname}" .
87 ( $self->{port} ? ";port=$self->{port}" : "" ).
88 ( $self->{tlsoptions} ? $self->{tlsoptions} : ""),
89 $self->{'user'}, $self->{'password'});
90 $self->{'language'} = undef;
91 $self->{'marcflavour'} = undef;
92 $self->{'dbh'}->do('set NAMES "utf8"');
93 $self->{'dbh'}->{'mysql_enable_utf8'}=1;
99 =head2 marc_framework_sql_list
101 my ($defaulted_to_en, $list) =
102 $installer->marc_framework_sql_list($lang, $marcflavour);
104 Returns in C<$list> a structure listing the filename, description, section,
105 and mandatory/optional status of MARC framework scripts available for C<$lang>
108 If the C<$defaulted_to_en> return value is true, no scripts are available
109 for language C<$lang> and the 'en' ones are returned.
113 sub marc_framework_sql_list {
116 my $marcflavour = shift;
118 my $defaulted_to_en = 0;
121 my $dir = C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}/$lang/marcflavour/".lc($marcflavour);
122 unless (opendir( MYDIR, $dir )) {
124 warn "cannot open MARC frameworks directory $dir";
126 # if no translated MARC framework is available,
128 $dir = C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}/en/marcflavour/".lc($marcflavour);
129 opendir(MYDIR, $dir) or warn "cannot open English MARC frameworks directory $dir";
130 $defaulted_to_en = 1;
133 my @listdir = sort grep { !/^\.|marcflavour/ && -d "$dir/$_" } readdir(MYDIR);
137 my $request = $self->{'dbh'}->prepare("SELECT value FROM systempreferences WHERE variable='FrameworksLoaded'");
139 my ($frameworksloaded) = $request->fetchrow;
140 $frameworksloaded = '' unless defined $frameworksloaded; # avoid warning
141 my %frameworksloaded;
142 foreach ( split( /\|/, $frameworksloaded ) ) {
143 $frameworksloaded{$_} = 1;
146 foreach my $requirelevel (@listdir) {
147 opendir( MYDIR, "$dir/$requirelevel" );
148 my @listname = grep { !/^\./ && -f "$dir/$requirelevel/$_" && $_ =~ m/\.(sql|yml)$/ } readdir(MYDIR);
153 my ( $name, $ext ) = split /\./, $_;
155 if ( $ext =~ /yml/ ) {
156 my $yaml = LoadFile("$dir/$requirelevel/$name\.$ext");
157 @lines = map { Encode::decode('UTF-8', $_) } @{ $yaml->{'description'} };
159 open my $fh, "<:encoding(UTF-8)", "$dir/$requirelevel/$name.txt";
161 $line = Encode::encode('UTF-8', $line) unless ( Encode::is_utf8($line) );
162 @lines = split /\n/, $line;
164 my $mandatory = ($requirelevel =~ /(mandatory|requi|oblig|necess)/i);
168 'fwkfile' => "$dir/$requirelevel/$_",
169 'fwkdescription' => \@lines,
170 'checked' => ( ( $frameworksloaded{$_} || $mandatory ) ? 1 : 0 ),
171 'mandatory' => $mandatory,
175 sort { $a->{'fwkname'} cmp $b->{'fwkname'} } @frameworklist;
177 $cell{"frameworks"} = \@fwks;
178 $cell{"label"} = ($requirelevel =~ /(mandatory|requi|oblig|necess)/i)?'mandatory':'optional';
179 $cell{"code"} = lc($requirelevel);
180 push @fwklist, \%cell;
183 return ($defaulted_to_en, \@fwklist);
186 =head2 sample_data_sql_list
188 my ($defaulted_to_en, $list) = $installer->sample_data_sql_list($lang);
190 Returns in C<$list> a structure listing the filename, description, section,
191 and mandatory/optional status of sample data scripts available for C<$lang>.
192 If the C<$defaulted_to_en> return value is true, no scripts are available
193 for language C<$lang> and the 'en' ones are returned.
197 sub sample_data_sql_list {
201 my $defaulted_to_en = 0;
204 my $dir = C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}/$lang";
205 unless (opendir( MYDIR, $dir )) {
207 warn "cannot open sample data directory $dir";
209 # if no sample data is available,
211 $dir = C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}/en";
212 opendir(MYDIR, $dir) or warn "cannot open English sample data directory $dir";
213 $defaulted_to_en = 1;
216 my @listdir = sort grep { !/^\.|marcflavour/ && -d "$dir/$_" } readdir(MYDIR);
220 my $request = $self->{'dbh'}->prepare("SELECT value FROM systempreferences WHERE variable='FrameworksLoaded'");
222 my ($frameworksloaded) = $request->fetchrow;
223 $frameworksloaded = '' unless defined $frameworksloaded; # avoid warning
224 my %frameworksloaded;
225 foreach ( split( /\|/, $frameworksloaded ) ) {
226 $frameworksloaded{$_} = 1;
229 foreach my $requirelevel (@listdir) {
230 opendir( MYDIR, "$dir/$requirelevel" );
231 my @listname = grep { !/^\./ && -f "$dir/$requirelevel/$_" && $_ =~ m/\.(sql|yml)$/ } readdir(MYDIR);
236 my ( $name, $ext ) = split /\./, $_;
238 if ( $ext =~ /yml/ ) {
239 my $yaml = LoadFile("$dir/$requirelevel/$name\.$ext");
240 @lines = map { Encode::decode('UTF-8', $_) } @{ $yaml->{'description'} };
242 open my $fh, "<:encoding(UTF-8)", "$dir/$requirelevel/$name.txt";
244 $line = Encode::encode('UTF-8', $line) unless ( Encode::is_utf8($line) );
245 @lines = split /\n/, $line;
247 my $mandatory = ($requirelevel =~ /(mandatory|requi|oblig|necess)/i);
251 'fwkfile' => "$dir/$requirelevel/$_",
252 'fwkdescription' => \@lines,
253 'checked' => ( ( $frameworksloaded{$_} || $mandatory ) ? 1 : 0 ),
254 'mandatory' => $mandatory,
257 my @fwks = sort { $a->{'fwkname'} cmp $b->{'fwkname'} } @frameworklist;
259 $cell{"frameworks"} = \@fwks;
260 $cell{"label"} = ($requirelevel =~ /(mandatory|requi|oblig|necess)/i)?'mandatory':'optional';
261 $cell{"code"} = lc($requirelevel);
262 push @levellist, \%cell;
265 return ($defaulted_to_en, \@levellist);
268 =head2 load_db_schema
270 my $error = $installer->load_db_schema();
272 Loads the SQL script that creates Koha's tables and indexes. The
273 return value is a string containing error messages reported by the
281 my $datadir = C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}";
282 my $error = $self->load_sql("$datadir/kohastructure.sql");
287 =head2 load_sql_in_order
289 my ($fwk_language, $list) = $installer->load_sql_in_order($all_languages, @sql_list);
291 Given a list of SQL scripts supplied in C<@sql_list>, loads each of them
292 into the database and sets the FrameworksLoaded system preference to names
293 of the scripts that were loaded.
295 The SQL files are loaded in alphabetical order by filename (not including
296 directory path). This means that dependencies among the scripts are to
297 be resolved by carefully naming them, keeping in mind that the directory name
298 does *not* currently count.
300 B<FIXME:> this is a rather delicate way of dealing with dependencies between
303 The return value C<$list> is an arrayref containing a hashref for each
304 "level" or directory containing SQL scripts; the hashref in turns contains
305 a list of hashrefs containing a list of each script load and any error
306 messages associated with the loading of each script.
308 B<FIXME:> The C<$fwk_language> code probably doesn't belong and needs to be
309 moved to a different method.
313 sub load_sql_in_order {
315 my $all_languages = shift;
321 my @aa = split /\/|\\/, ($a);
322 my @bb = split /\/|\\/, ($b);
325 my $request = $self->{'dbh'}->prepare( "SELECT value FROM systempreferences WHERE variable='FrameworksLoaded'" );
327 my ($systempreference) = $request->fetchrow;
328 $systempreference = '' unless defined $systempreference; # avoid warning
330 my $global_mandatory_dir = C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}/mandatory";
332 # Make sure some stuffs are loaded first
333 unshift(@fnames, C4::Context->config('intranetdir') . "/installer/data/$self->{dbms}/sysprefs.sql");
335 "$global_mandatory_dir/subtag_registry.sql",
336 "$global_mandatory_dir/auth_val_cat.sql",
337 "$global_mandatory_dir/message_transport_types.sql",
338 "$global_mandatory_dir/sample_notices_message_attributes.sql",
339 "$global_mandatory_dir/sample_notices_message_transports.sql",
340 "$global_mandatory_dir/keyboard_shortcuts.sql",
343 push @fnames, C4::Context->config('intranetdir') . "/installer/data/mysql/userflags.sql";
344 push @fnames, C4::Context->config('intranetdir') . "/installer/data/mysql/userpermissions.sql";
345 push @fnames, C4::Context->config('intranetdir') . "/installer/data/mysql/audio_alerts.sql";
346 push @fnames, C4::Context->config('intranetdir') . "/installer/data/mysql/account_offset_types.sql";
347 push @fnames, C4::Context->config('intranetdir') . "/installer/data/mysql/account_credit_types.sql";
348 push @fnames, C4::Context->config('intranetdir') . "/installer/data/mysql/account_debit_types.sql";
349 foreach my $file (@fnames) {
352 my $error = $self->load_sql($file);
353 my @file = split qr(\/|\\), $file;
354 $lang = $file[ scalar(@file) - 3 ] unless ($lang);
355 my $level = $file[ scalar(@file) - 2 ];
357 $systempreference .= "$file[scalar(@file)-1]|"
358 unless ( index( $systempreference, $file[ scalar(@file) - 1 ] ) >= 0 );
361 #Bulding here a hierarchy to display files by level.
362 push @{ $hashlevel{$level} },
363 { "fwkname" => $file[ scalar(@file) - 1 ], "error" => $error };
366 #systempreference contains an ending |
367 chop $systempreference;
369 map { push @list, { "level" => $_, "fwklist" => $hashlevel{$_} } } keys %hashlevel;
371 for my $each_language (@$all_languages) {
373 # warn "CODE".$each_language->{'language_code'};
374 # warn "LANG:".$lang;
375 if ( $lang eq $each_language->{'language_code'} ) {
376 $fwk_language = $each_language->{language_locale_name};
381 "UPDATE systempreferences set value=\"$systempreference\" where variable='FrameworksLoaded'"
384 unless ( $updateflag == 1 ) {
386 "INSERT INTO systempreferences (value, variable, explanation, type) VALUES (\"$systempreference\",'FrameworksLoaded','Frameworks loaded through webinstaller','choice')";
387 my $rq = $self->{'dbh'}->prepare($string);
390 return ($fwk_language, \@list);
393 =head2 set_marcflavour_syspref
395 $installer->set_marcflavour_syspref($marcflavour);
397 Set the 'marcflavour' system preference. The incoming
398 C<$marcflavour> references to a subdirectory of
399 installer/data/$dbms/$lang/marcflavour, and is
400 normalized to MARC21, UNIMARC or NORMARC.
402 FIXME: this method assumes that the MARC flavour will be either
403 MARC21, UNIMARC or NORMARC.
407 sub set_marcflavour_syspref {
409 my $marcflavour = shift;
411 # we can have some variants of marc flavour, by having different directories, like : unimarc_small and unimarc_full, for small and complete unimarc frameworks.
412 # marc_cleaned finds the marcflavour, without the variant.
413 my $marc_cleaned = 'MARC21';
414 $marc_cleaned = 'UNIMARC' if $marcflavour =~ /unimarc/i;
415 $marc_cleaned = 'NORMARC' if $marcflavour =~ /normarc/i;
417 $self->{'dbh'}->prepare(
418 "INSERT IGNORE INTO `systempreferences` (variable,value,explanation,options,type) VALUES('marcflavour','$marc_cleaned','Define global MARC flavor (MARC21, UNIMARC or NORMARC) used for character encoding','MARC21|UNIMARC|NORMARC','Choice');"
423 =head2 set_version_syspref
425 $installer->set_version_syspref();
427 Set or update the 'Version' system preference to the current
428 Koha software version.
432 sub set_version_syspref {
435 my $kohaversion = Koha::version();
436 # remove the 3 last . to have a Perl number
437 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
438 if (C4::Context->preference('Version')) {
439 warn "UPDATE Version";
440 my $finish=$self->{'dbh'}->prepare("UPDATE systempreferences SET value=? WHERE variable='Version'");
441 $finish->execute($kohaversion);
443 warn "INSERT Version";
444 my $finish=$self->{'dbh'}->prepare("INSERT into systempreferences (variable,value,explanation) values ('Version',?,'The Koha database version. WARNING: Do not change this value manually, it is maintained by the webinstaller')");
445 $finish->execute($kohaversion);
447 C4::Context->clear_syspref_cache();
450 =head2 set_languages_syspref
452 $installer->set_languages_syspref();
454 Add the installation language to 'language' and 'opaclanguages' system preferences
455 if different from 'en'
459 sub set_languages_syspref {
461 my $language = shift;
463 return if ( not $language or $language eq 'en' );
465 warn "UPDATE Languages";
467 my $pref = $self->{'dbh'}->prepare("UPDATE systempreferences SET value=? WHERE variable='language'");
468 $pref->execute("en,$language");
470 $pref = $self->{'dbh'}->prepare("UPDATE systempreferences SET value=? WHERE variable='opaclanguages'");
471 $pref->execute("en,$language");
473 C4::Context->clear_syspref_cache();
478 my $error = $installer->load_sql($filename);
480 Runs the specified input file using a sql loader DBIx::RunSQL, or a yaml loader
481 Returns any strings sent to STDERR
483 # FIXME This should be improved: sometimes the caller and load_sql warn the same
488 sub process_yml_table {
490 my $table_name = ( keys %$table )[0]; # table name
491 my @rows = @{ $table->{$table_name}->{rows} }; #
492 my @columns = ( sort keys %{$rows[0]} ); # column names
493 my $fields = join ",", map{sprintf("`%s`", $_)} @columns; # idem, joined
494 my $query = "INSERT INTO $table_name ( $fields ) VALUES ";
495 my @multiline = @{ $table->{$table_name}->{'multiline'} }; # to check multiline values;
496 my $placeholders = '(' . join ( ",", map { "?" } @columns ) . ')'; # '(?,..,?)' string
498 foreach my $row ( @rows ) {
501 ( @multiline and grep { $_ eq $col } @multiline )
502 ? join "\r\n", @{$row->{$col}} # join multiline values
506 return { query => $query, placeholders => $placeholders, values => \@values };
511 my $filename = shift;
514 my $dbh = $self->{ dbh };
519 open STDERR, ">>", \$dup_stderr;
521 if ( $filename =~ /sql$/ ) { # SQL files
523 DBIx::RunSQL->run_sql_file(
531 my $yaml = LoadFile( $filename ); # Load YAML
532 for my $table ( @{ $yaml->{'tables'} } ) {
533 my $query_info = process_yml_table($table);
534 my $query = $query_info->{query};
535 my $placeholders = $query_info->{placeholders};
536 my $values = $query_info->{values};
537 # Doing only 1 INSERT query for the whole table
538 $query .= join ', ', ( $placeholders ) x scalar @values;
539 $dbh->do( $query, undef, @values );
541 for my $statement ( @{ $yaml->{'sql_statements'} } ) { # extra SQL statements
542 $dbh->do($statement);
547 warn "Something went wrong loading file $filename ($@)";
550 # errors thrown while loading installer data should be logged
552 warn "C4::Installer::load_sql returned the following errors while attempting to load $filename:\n";
553 $error = $dup_stderr;
559 =head2 get_file_path_from_name
561 my $filename = $installer->get_file_path_from_name('script_name');
563 searches through the set of known SQL scripts and finds the fully
564 qualified path name for the script that mathches the input.
566 returns undef if no match was found.
571 sub get_file_path_from_name {
573 my $partialname = shift;
575 my $lang = 'en'; # FIXME: how do I know what language I want?
577 my ($defaulted_to_en, $list) = $self->sample_data_sql_list($lang);
578 # warn( Data::Dumper->Dump( [ $list ], [ 'list' ] ) );
581 foreach my $frameworklist ( @$list ) {
582 push @found, grep { $_->{'fwkfile'} =~ /$partialname$/ } @{$frameworklist->{'frameworks'}};
585 # warn( Data::Dumper->Dump( [ \@found ], [ 'found' ] ) );
586 if ( 0 == scalar @found ) {
588 } elsif ( 1 < scalar @found ) {
589 warn "multiple results found for $partialname";
592 return $found[0]->{'fwkfile'};
597 sub foreign_key_exists {
598 my ( $table_name, $constraint_name ) = @_;
599 my $dbh = C4::Context->dbh;
600 my (undef, $infos) = $dbh->selectrow_array(qq|SHOW CREATE TABLE $table_name|);
601 return $infos =~ m|CONSTRAINT `$constraint_name` FOREIGN KEY|;
605 my ( $table_name, $key_name ) = @_;
606 my $dbh = C4::Context->dbh;
607 my ($exists) = $dbh->selectrow_array(
609 SHOW INDEX FROM $table_name
617 my ( $table_name, $column_name ) = @_;
618 return unless TableExists($table_name);
619 my $dbh = C4::Context->dbh;
620 my ($exists) = $dbh->selectrow_array(
622 SHOW COLUMNS FROM $table_name
624 |, undef, $column_name
629 sub TableExists { # Could be renamed table_exists for consistency
632 my $dbh = C4::Context->dbh;
633 local $dbh->{PrintError} = 0;
634 local $dbh->{RaiseError} = 1;
635 $dbh->do(qq{SELECT * FROM $table WHERE 1 = 0 });
644 C4::Installer is a refactoring of logic originally from installer/installer.pl, which was
645 originally written by Henri-Damien Laurant.
647 Koha Development Team <http://koha-community.org/>
649 Galen Charlton <galen.charlton@liblime.com>