1 # Copyright 2007 MJ Ray
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along with
15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
16 # Suite 330, Boston, MA 02111-1307 USA
18 # Current maintainer MJR http://mjr.towers.org.uk/
19 # See http://www.koha.org/wiki/?page=KohaInstaller
24 use ExtUtils::MakeMaker;
30 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
32 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
34 my $dirtree = hashdir('.');
39 Makefile.PL - Koha packager and installer
43 =head2 BASIC INSTALLATION
50 =head2 UPGRADE INSTALLATION
52 NOTE: This option is only available if koha-install-log exists.
54 perl Makefile.PL --prev-install-log /path/to/koha-install-log
60 =head2 PACKAGING RELEASE TARBALLS
71 This is a packager and installer that uses
72 ExtUtils::MakeMaker, which is fairly common
74 As well as building tar or zip files
75 and installing with the above commands,
76 it allows us to check pre-requisites
77 and generate configuration files.
81 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
83 Basic metadata about this software.
87 Suppress generation of META.yml file.
91 Hash of perl modules and versions required.
99 This is a hash of PL scripts to run after installation and
100 the files to ask them to generate.
101 Maybe use the values from CONFIGURE
102 to generate initial configuration files in future.
108 This is a hash mapping directories and files in the
109 source tree to installation target directories. The rules
110 for this mapping are:
114 =item If a directory or file is specified, it and its
115 contents will be copied to the installation target directory.
117 =item If a subdirectory of a mapped directory is specified,
118 its target overrides the parent's target for that subdirectory.
120 =item The value of each map entry may either be a scalar containing
121 one target or a reference to a hash containing 'target' and 'trimdir'
124 =item Any files at the top level of the source tree that are
125 not included in the map will not be installed.
127 =item Any directories at the top level of the source tree
128 that are not included in the map will be installed in
129 INTRANET_CGI_DIR. This is a sensible default given the
130 current organization of the source tree, but (FIXME) it
131 would be better to reorganize the source tree to better
132 match the installation system, to allow adding new directories
133 without having to adjust Makefile.PL each time. The idea
134 is to make the C<$target_map> hash as minimal as possible.
138 The permitted installation targets are:
142 =item INTRANET_CGI_DIR
144 CGI scripts for intranet (staff) interface.
146 =item INTRANET_TMPL_DIR
148 HTML templates for the intranet interface.
150 =item INTRANET_WWW_DIR
152 HTML files, images, etc. for DocumentRoot for the intranet interface.
156 CGI scripts for OPAC (public) interface.
160 HTML templates for the OPAC interface.
164 HTML files, images, etc. for DocumentRoot for the OPAC interface.
166 =item PERL_MODULE_DIR
168 Perl modules (at present just the C4 modules) that are intimately
169 tied to Koha. Depending on the installation options, these
170 may or may not be installed one of the standard directories
171 in Perl's default @LIB.
175 Directory for Koha configuration files.
179 Directory for Zebra configuration files.
183 Directory for Zebra's lock files.
187 Directory for Zebra's data files.
191 Directory for Zebra's UNIX-domain sockets.
195 Directory for for miscellaenous scripts, among other
196 things the translation toolkit and RSS feed tools.
200 Directory for command-line scripts and daemons.
204 Directory for man pages created from POD -- will mostly
205 contain information of interest to Koha developers.
209 Directory for Koha documentation accessed from the
210 command-line, e.g., READMEs.
214 Directory for Apache and Zebra logs produced by Koha.
216 =item PAZPAR2_CONF_DIR
218 Directory for PazPar2 configuration files.
222 This is a dummy target used to explicitly state
223 that a given file or directory is not to be installed.
224 This is used either for parts of the installer itself
225 or for development tools that are not applicable to a
226 production installation.
233 './about.pl' => 'INTRANET_CGI_DIR',
234 './acqui' => 'INTRANET_CGI_DIR',
235 './admin' => 'INTRANET_CGI_DIR',
236 './authorities' => 'INTRANET_CGI_DIR',
237 './C4' => 'PERL_MODULE_DIR',
238 './C4/SIP/t' => 'NONE',
239 './C4/SIP/koha_test' => 'NONE',
240 './C4/tests' => 'NONE',
241 './catalogue' => 'INTRANET_CGI_DIR',
242 './cataloguing' => 'INTRANET_CGI_DIR',
243 './changelanguage.pl' => 'INTRANET_CGI_DIR',
244 './check_sysprefs.pl' => 'NONE',
245 './circ' => 'INTRANET_CGI_DIR',
246 './edithelp.pl' => 'INTRANET_CGI_DIR',
247 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
248 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
249 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
250 './help.pl' => 'INTRANET_CGI_DIR',
251 './installer-CPAN.pl' => 'NONE',
252 './installer' => 'INTRANET_CGI_DIR',
253 './errors' => {target => 'INTRANET_CGI_DIR'},
254 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
255 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
256 './kohaversion.pl' => 'INTRANET_CGI_DIR',
257 './labels' => 'INTRANET_CGI_DIR',
258 './mainpage.pl' => 'INTRANET_CGI_DIR',
259 './Makefile.PL' => 'NONE',
260 './MANIFEST.SKIP' => 'NONE',
261 './members' => 'INTRANET_CGI_DIR',
262 './misc' => { target => 'SCRIPT_DIR', trimdir => -1 },
263 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
264 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
265 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
266 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
267 './misc/installer_devel_notes' => 'NONE',
268 './opac' => 'OPAC_CGI_DIR',
269 './README.txt' => 'NONE',
270 './reports' => 'INTRANET_CGI_DIR',
271 './reserve' => 'INTRANET_CGI_DIR',
272 './reviews' => 'INTRANET_CGI_DIR',
273 './rewrite-config.PL' => 'NONE',
274 './reviews' => 'INTRANET_CGI_DIR',
275 './rss' => 'MISC_DIR',
276 './serials' => 'INTRANET_CGI_DIR',
278 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
279 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
280 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
281 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
282 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
283 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
284 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
285 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
286 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
287 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
288 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
289 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
290 './sms' => 'INTRANET_CGI_DIR',
291 './suggestion' => 'INTRANET_CGI_DIR',
292 './svc' => 'INTRANET_CGI_DIR',
294 './tmp' => 'NONE', # FIXME need to determine whether
295 # Koha generates any persistent temp files
296 # that should go in /var/tmp/koha
297 './tools' => 'INTRANET_CGI_DIR',
298 './virtualshelves' => 'INTRANET_CGI_DIR',
299 # ignore files and directories created by the install itself
300 './pm_to_blib' => 'NONE',
304 =head1 CONFIGURATION OPTIONS
306 The following configuration options are used by the installer.
312 Specifies whether installation will be FHS-compliant (default,
313 assumes user has root), put everything under
314 a single directory (for users installing on a web host
315 that allows CGI scripts and a MySQL database but not root
316 access), or development (for a developer who wants to run
317 Koha from a git clone with no fuss).
321 Directory under which most components will go. Default
322 value will vary depending on INSTALL_MODE.
326 Type of DBMS (e.g., mysql or Pg).
334 Port that DBMS server is listening on.
338 Name of the DBMS database for Koha.
342 Name of DBMS user account for Koha's database.
346 Pasword of DMBS user account for Koha's database.
350 Whether to install Zebra configuration files and data
353 =item ZEBRA_MARC_FORMAT
355 Specifies format of MARC records to be indexed by Zebra.
359 Specifies primary language of records that will be
364 Internal Zebra user account for the index.
368 Internal Zebra user account's password.
372 System user account that will own Koha's files.
376 System group that will own Koha's files.
382 # default configuration options
383 my %config_defaults = (
384 'DB_TYPE' => 'mysql',
385 'DB_HOST' => 'localhost',
387 'DB_USER' => 'kohaadmin',
388 'DB_PASS' => 'katikoan',
389 'INSTALL_ZEBRA' => 'yes',
390 'INSTALL_SRU' => 'yes',
391 'INSTALL_PAZPAR2' => 'no',
392 'AUTH_INDEX_MODE' => 'grs1',
393 'ZEBRA_MARC_FORMAT' => 'marc21',
394 'ZEBRA_LANGUAGE' => 'en',
395 'ZEBRA_USER' => 'kohauser',
396 'ZEBRA_PASS' => 'zebrastripes',
397 'ZEBRA_SRU_HOST' => 'localhost',
398 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
399 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
400 'KOHA_USER' => 'koha',
401 'KOHA_GROUP' => 'koha',
402 'MERGE_SERVER_HOST' => 'localhost',
403 'MERGE_SERVER_PORT' => '11001',
404 'PAZPAR2_HOST' => 'localhost',
405 'PAZPAR2_PORT' => '11002',
406 'RUN_DATABASE_TESTS' => 'no',
409 # set some default configuratio options based on OS
410 # more conditions need to be added for other OS's
411 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
412 # to allow for more granular decisions based on which Win32 platform
414 warn "Your platform appears to be $^O.\n" if $DEBUG;
416 if ( $^O eq 'MSWin32' ) {
417 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
418 # this could be changed to put some files (ie. libraries) into system32, etc.
419 $config_defaults{'INSTALL_MODE'} = 'single';
420 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
422 elsif ( $^O eq 'cygwin' ) {
423 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
424 # this could be changed to put some files (ie. libraries) into system32, etc.
425 $config_defaults{'INSTALL_MODE'} = 'single';
426 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
429 $config_defaults{'INSTALL_MODE'} = 'standard';
430 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
433 # valid values for certain configuration options
434 my %valid_config_values = (
435 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
436 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
437 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
438 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
439 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
440 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
441 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
442 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
445 # get settings from command-line
446 my $koha_install_log = "";
447 Getopt::Long::Configure('pass_through');
448 my $results = GetOptions(
449 "prev-install-log=s" => \$koha_install_log
452 my %install_log_values = ();
453 if ($koha_install_log ne "") {
454 get_install_log_values($koha_install_log, \%install_log_values);
457 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
458 my ($target_directories, $skip_directories) = get_target_directories(\%config);
459 display_configuration(\%config, $target_directories);
461 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
464 'rewrite-config.PL' => [
465 'blib/KOHA_CONF_DIR/koha-conf.xml',
466 'blib/KOHA_CONF_DIR/koha-httpd.conf',
467 'blib/MISC_DIR/koha-install-log'
469 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
474 if ($config{'INSTALL_ZEBRA'} eq "yes") {
475 push @{ $pl_files->{'rewrite-config.PL'} }, (
476 'blib/ZEBRA_CONF_DIR/etc/passwd',
477 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
478 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
479 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
480 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
481 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
482 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
483 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
485 if ($config{'INSTALL_MODE'} ne 'dev') {
486 push @{ $pl_files->{'rewrite-config.PL'} }, (
487 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
488 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
489 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
492 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
493 push @{ $pl_files->{'rewrite-config.PL'} }, (
494 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
495 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
498 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
499 $config{'AUTH_RETRIEVAL_CFG'} =
500 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
503 if ($config{'INSTALL_MODE'} ne "dev") {
504 push @{ $pl_files->{'rewrite-config.PL'} }, (
505 'blib/PERL_MODULE_DIR/C4/Context.pm',
506 'blib/SCRIPT_DIR/kohalib.pl'
512 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
513 VERSION_FROM => 'kohaversion.pl',
514 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
515 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
518 # awaiting package maintainer's use of $VERSION
519 #'Algorithm::CheckDigits' => 0.48,
520 #'Algorithm::CheckDigits::M43_001' => 0.48,
521 'Biblio::EndnoteStyle' => 0.05,
524 'CGI::Session' => '4.10',
525 'Class::Factory::Util' => 1.6,
526 'Class::Accessor' => 0.30,
527 'DBD::mysql' => 4.004,
529 'Data::ICal' => 0.13,
530 'Data::Dumper' => 2.121,
532 'Date::ICal' => 1.72,
533 'Date::Manip' => 5.44,
534 'Digest::MD5' => 2.36,
535 'File::Temp' => 0.16,
536 'GD::Barcode::UPCE' => 1.1,
537 'Getopt::Long' => 2.35,
538 'Getopt::Std' => 1.05,
539 'HTML::Template::Pro' => 0.69,
540 'HTTP::Cookies' => 1.39,
541 'HTTP::Request::Common' => 1.26,
542 'Image::Magick' => 6.2,
543 'LWP::Simple' => 1.41,
544 'LWP::UserAgent' => 2.033,
545 'Lingua::Stem' => 0.82,
546 'List::Util' => 1.18,
547 'List::MoreUtils' => 0.21,
548 'Locale::Language' => 2.07,
549 'MARC::Charset' => 0.98,
550 'MARC::Crosswalk::DublinCore' => 0.02,
551 'MARC::File::XML' => 0.88,
552 'MARC::Record' => 2.00,
553 'MIME::Base64' => 3.07,
554 'MIME::QuotedPrint' => 3.07,
555 'Mail::Sendmail' => 0.79,
557 'Net::LDAP::Filter' => 0.14,
558 'Net::Z3950::ZOOM' => 1.16,
559 'PDF::API2' => 2.000,
560 'PDF::API2::Page' => 2.000,
561 'PDF::API2::Util' => 2.000,
562 'PDF::Reuse' => 0.33,
563 'PDF::Reuse::Barcode' => 0.05,
566 'Schedule::At' => 1.06,
567 'Term::ANSIColor' => 1.10,
569 'Test::Harness' => 2.56,
570 'Test::More' => 0.62,
572 'Text::CSV_XS' => 0.32,
573 'Text::Iconv' => 1.7,
574 'Text::Wrap' => 2005.082401,
575 'Time::HiRes' => 1.86,
576 'Time::localtime' => 1.02,
577 'Unicode::Normalize' => 0.32,
578 'XML::Dumper' => 0.81,
579 'XML::LibXML' => 1.59,
580 'XML::LibXSLT' => 1.59,
581 'XML::SAX::ParserFactory' => 1.01,
582 'XML::Simple' => 2.14,
584 'YAML::Syck' => 0.71,
590 # Man pages generated from POD
591 INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
592 INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
594 PL_FILES => $pl_files,
602 This function recurses through the directory structure and builds
603 a hash of hashes containing the structure with arrays holding filenames.
604 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
610 opendir my $dh, $dir or die $!;
611 my $tree = {}->{$dir} = {};
612 while( my $file = readdir($dh) ) {
613 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
614 my $path = $dir .'/' . $file;
615 $tree->{$file} = hashdir($path), next if -d $path;
616 push @{$tree->{'.'}}, $file;
623 This function combines the target_map and file hash to
624 map each source file to its destination relative to
625 the set of installation targets.
627 Output will be a hash mapping from each source file
628 to its destination value, like this:
630 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
635 my $target_map = shift;
637 my $file_map = shift;
638 my $install_zebra = shift;
639 my $curr_path = @_ ? shift : ['.'];
641 # Traverse the directory tree.
642 # For each file or directory, identify the
643 # most specific match in the target_map
644 foreach my $dir (sort keys %{ $dirtree }) {
646 # deal with files in directory
647 foreach my $file (sort @{ $dirtree->{$dir} }) {
648 my $targetdir = undef;
649 my $matchlevel = undef;
650 # first, see if there is a match on this specific
651 # file in the target map
652 my $filepath = join("/", @$curr_path, $file);
653 if (exists $target_map->{$filepath}) {
654 $targetdir = $target_map->{$filepath};
655 $matchlevel = scalar(@$curr_path) + 1;
657 # no match on the specific file; look for
659 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
660 my $dirpath = join("/", @$curr_path[0..$i]);
661 if (exists $target_map->{$dirpath}) {
662 $targetdir = $target_map->{$dirpath};
663 $matchlevel = $i + 1;
668 if (defined $targetdir) {
669 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
671 my $path = join("/", @$curr_path);
672 print "failed to map: $path/$file\n" if $DEBUG;
676 # dealing with subdirectory
677 push @$curr_path, $dir;
678 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
684 sub _add_to_file_map {
685 my $file_map = shift;
686 my $targetdir = shift;
687 my $curr_path = shift;
689 my $matchlevel = shift;
690 my $install_zebra = shift;
691 my $dest_path = @_ ? shift : $curr_path;
693 # The target can be one of the following:
694 # 1. scalar representing target symbol
695 # 2. hash ref containing target and trimdir keys
697 # Consequently, this routine traverses this structure,
698 # calling itself recursively, until it deals with
699 # all of the scalar target symbols.
700 if (ref $targetdir eq 'HASH') {
701 my $subtarget = $targetdir->{target};
702 if (exists $targetdir->{trimdir}) {
703 # if we get here, we've specified that
704 # rather than installing the file to
705 # $(TARGET)/matching/dirs/subdirs/file,
706 # we want to install it to
707 # $(TARGET)/subdirs/file
709 # Note that this the only place where
710 # $matchlevel is used.
711 my @new_dest_path = @$dest_path;
712 if ($targetdir->{trimdir} == -1) {
713 splice @new_dest_path, 0, $matchlevel;
715 splice @new_dest_path, 0, $targetdir->{trimdir};
717 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
719 # actually getting here means that the
720 # target was unnecessarily listed
721 # as a hash, but we'll forgive that
722 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
724 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
725 my $source = File::Spec->catfile(@$curr_path, $file);
726 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
727 #print "$source => $destination\n"; # DEBUG
728 # quote spaces in file names
729 # FIXME: this is of questionable portability and
730 # probably depends on user's make recognizing this
731 # quoting syntax -- probably better to remove
732 # spaces and shell metacharacters from all file names
733 $source =~ s/ /\\ /g;
734 $destination =~ s/ /\\ /g;
736 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
740 =head2 get_install_log_values
742 Reads value from the Koha install log specified by
747 sub get_install_log_values {
748 my $install_log = shift;
751 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
754 next if /^#/ or /^\s*$/;
758 my ($key, $value) = split /=/, $_, 2;
759 $values->{$key} = $value;
763 print <<_EXPLAIN_INSTALL_LOG_;
764 Reading values from install log $install_log. You
765 will be prompted only for settings that have been
766 added since the last time you installed Koha. To
767 be prompted for all settings, run 'perl Makefile.PL'
768 without the --prev-install-log option.
769 _EXPLAIN_INSTALL_LOG_
772 =head2 get_configuration
774 This prompts the user for various configuration options.
778 sub get_configuration {
779 my $defaults = shift;
780 my $valid_values = shift;
781 my $install_log_values = shift;
785 By default, Koha can be installed in one of three ways:
787 standard: Install files in conformance with the Filesystem
788 Hierarchy Standard (FHS). This is the default mode
789 and should be used when installing a production
790 Koha system. On Unix systems, root access is
791 needed to complete a standard installation.
793 single: Install files under a single directory. This option
794 is useful for installing Koha without root access, e.g.,
795 on a web host that allows CGI scripts and MySQL databases
796 but requires the user to keep all files under the user's
799 dev: Create a set of symbolic links and configuration files to
800 allow Koha to run directly from the source distribution.
801 This mode is useful for developers who want to run
802 Koha from a git clone.
805 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
806 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
808 # set message and default value for INSTALL_BASE
809 # depending on value of INSTALL_MODE
810 my $install_base_default = $defaults->{'INSTALL_BASE'};
811 if ($config{'INSTALL_MODE'} eq 'dev') {
813 Please specify the directory in which to install Koha's
814 active configuration files and (if applicable) the
815 Zebra database. Koha's CGI scripts and templates will
816 be run from the current directory.
818 Configuration directory:);
819 # FIXME - home directory portability consideration apply
820 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
821 } elsif ($config{'INSTALL_MODE'} eq 'single') {
822 $msg = "\nPlease specify the directory in which to install Koha";
823 # FIXME -- we're assuming under a 'single' mode install
824 # that user will likely want to install under the home
825 # directory. This is OK in and of itself, but we should
826 # use File::HomeDir to locate the home directory portably.
827 # This is deferred for now because File::HomeDir is not yet
829 # --we must also keep this portable to the major OS's -fbcit
830 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
834 Please specify the directory under which most Koha files
837 Note that if you are planning in installing more than
838 one instance of Koha, you may want to modify the last
839 component of the directory path, which will be used
840 as the package name in the FHS layout.
842 Base installation directory);
844 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
846 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
847 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
848 if ($config{'INSTALL_MODE'} eq "standard") {
850 Since you are using the 'standard' install
851 mode, you should run 'make install' as root.
852 However, it is recommended that a non-root
853 user (on Unix and Linux platforms) have
854 ownership of Koha's files, including the
855 Zebra indexes if applicable.
857 Please specify a user account. This
858 user account does not need to exist
859 right now, but it needs to exist
860 before you run 'make install'. Please
861 note that for security reasons, this
862 user should not be the same as the user
863 account Apache runs under.
866 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
869 Please specify the group that should own
870 Koha's files. As above, this group need
871 not exist right now, but should be created
872 before you run 'make install'.
875 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
879 Please specify which database engine you will use
880 to store data in Koha. The choices are MySQL and
881 PostgreSQL; please note that at the moment
882 PostgreSQL support is highly experimental.
885 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
886 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
889 Please specify the name or address of your
890 database server. Note that the database
891 does not have to exist at this point, it
892 can be created after running 'make install'
893 and before you try using Koha for the first time.
896 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
899 Please specify the port used to connect to the
901 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
902 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
905 Please specify the name of the database to be
907 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
910 Please specify the user that owns the database to be
912 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
915 Please specify the password of the user that owns the
916 database to be used by Koha);
917 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
920 Koha can use the Zebra search engine for high-performance
921 searching of bibliographic and authority records. If you
922 have installed the Zebra software and would like to use it,
923 please answer 'yes' to the following question. Otherwise,
924 Koha will default to using its internal search engine.
926 Please note that if you choose *NOT* to install Zebra,
927 koha-conf.xml will still contain some references to Zebra
928 settings. Those references will be ignored by Koha.
930 Install the Zebra configuration files?);
931 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
932 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
934 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
936 Since you've chosen to use Zebra with Koha,
937 you must specify the primary MARC format of the
938 records to be indexed by Zebra.
940 Koha provides Zebra configuration files for MARC 21
943 MARC format for Zebra indexing);
944 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
945 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
947 Koha supplies Zebra configuration files tuned for
948 searching either English (en) or French (fr) MARC
951 Primary language for Zebra indexing);
952 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
953 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
956 Koha can use one of two different indexing modes
957 for the MARC authorities records:
959 grs1 - uses the Zebra GRS-1 filter, available
961 dom - uses the DOM XML filter; offers improved
964 Authorities indexing mode);
965 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
966 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
969 Please specify Zebra database user);
970 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
973 Please specify the Zebra database password);
974 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
977 Since you've chosen to use Zebra, you can enable the SRU/
978 Z39.50 Server if you so choose, but you must specify a
979 few configuration options for it.
981 Please note that if you choose *NOT* to configure SRU,
982 koha-conf.xml will still contain some references to SRU
983 settings. Those references will be ignored by Koha.
985 Install the SRU configuration files?);
986 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
987 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
989 if ($config{'INSTALL_SRU'} eq 'yes') {
991 Since you've chosen to configure SRU, you must
992 specify the host and port(s) that the SRU
993 Servers (bibliographic and authority) should run on.
997 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1000 SRU port for bibliographic data?);
1001 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1004 SRU port for authority data?);
1005 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1010 Since you've chosen to use Zebra, you can also choose to
1011 install PazPar2, which is a metasearch tool. With PazPar2,
1012 Koha can perform on-the-fly merging of bibliographic
1013 records during searching, allowing for FRBRization of
1016 Install the PazPar2 configuration files?);
1017 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1018 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1020 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1022 Since you've chosen to configure PazPar2, you must
1023 specify the host and port(s) that PazPar2
1027 Zebra bibliographic server host?);
1028 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1031 Zebra bibliographic port for PazPar2 to use?);
1032 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1036 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1040 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1046 Would you like to run the database-dependent test suite?);
1047 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1048 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1050 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1051 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1052 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1054 Please specify the name of the test database to be
1056 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1059 Please specify the user that owns the database to be
1061 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1064 Please specify the password of the user that owns the
1065 database to be used by Koha);
1066 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1071 # add version number
1072 my $version = "no_version_found";
1074 require 'kohaversion.pl';
1075 $version = kohaversion();
1077 $config{'KOHA_INSTALLED_VERSION'} = $version;
1082 sub _add_valid_values_disp {
1084 my $valid_values = shift;
1087 if (exists $valid_values->{$key}) {
1088 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1096 my $default = shift;
1097 my $valid_values = shift;
1098 my $install_log_values = shift;
1100 # take value from install log if present
1101 if (exists $install_log_values{$key}) {
1102 return $install_log_values{$key};
1105 # override default value from environment
1106 if (exists $ENV{$key}) {
1107 $default = $ENV{$key};
1108 $msg .= " (default from environment)";
1111 my $val = prompt($msg, $default);
1113 while (exists $valid_values->{$key} and
1114 $val ne $default and
1115 not exists $valid_values->{$key}->{$val}) {
1116 my $retry_msg = "Value '$val' is not a valid option.\n";
1117 $retry_msg .= "Please enter a value";
1118 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1119 $val = prompt($retry_msg, $default);
1124 =head2 get_target_directories
1126 Creates a hash mapping from symbols for installation target
1127 directories to actual directory paths.
1129 Also returns a hash indicating targets for which
1130 files need not be copied -- this is used for the 'dev'
1131 mode installation, where some files are installed in place.
1135 sub get_target_directories {
1138 my $base = $config->{'INSTALL_BASE'};
1139 my $mode = $config->{'INSTALL_MODE'};
1141 # get last component of install base directory
1142 # to treat as package name
1143 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1145 my @basedir = File::Spec->splitdir($directories);
1147 # for Win32 we need to prepend the volume to the directory path
1148 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1149 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1151 my $package = pop @basedir;
1156 if ($mode eq 'single') {
1157 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1158 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1159 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1160 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1161 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1162 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1163 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1164 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1165 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1166 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1167 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1168 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1169 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1170 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1171 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1172 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1173 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1174 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1175 } elsif ($mode eq 'dev') {
1176 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1177 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1178 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1179 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1180 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1181 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1182 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1183 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1184 $skipdirs{'OPAC_CGI_DIR'} = 1;
1185 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1186 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1187 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1188 $skipdirs{'OPAC_WWW_DIR'} = 1;
1189 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1190 $skipdirs{'PERL_MODULE_DIR'} = 1;
1191 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1192 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1193 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1194 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1195 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1196 $skipdirs{'SCRIPT_DIR'} = 1;
1197 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1198 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1199 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1200 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1201 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1202 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1204 # mode is standard, i.e., 'fhs'
1205 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1206 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1207 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1208 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1209 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1210 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1211 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1212 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1213 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1214 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1215 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1216 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1217 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1218 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1219 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1220 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1221 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1222 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1225 _get_env_overrides(\%dirmap);
1226 _get_argv_overrides(\%dirmap);
1228 return \%dirmap, \%skipdirs;
1231 sub _get_env_overrides {
1234 foreach my $key (keys %$dirmap) {
1235 if (exists $ENV{$key}) {
1236 $dirmap->{$key} = $ENV{$key};
1237 print "Setting $key from environment\n";
1242 sub _get_argv_overrides {
1246 for (my $i = 0; $i <= $#ARGV; $i++) {
1247 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1250 push @new_argv, $ARGV[$i];
1256 sub display_configuration {
1259 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1260 foreach my $key (sort keys %$config) {
1261 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1264 print "\nand in the following directories:\n\n";
1265 foreach my $key (sort keys %$dirmap) {
1266 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1268 print "\n\nTo change any configuration setting, please run\n";
1269 print "perl Makefile.PL again. To override one of the target\n";
1270 print "directories, you can do so on the command line like this:\n";
1271 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1272 print "You can also set different default values for parameters\n";
1273 print "or override directory locations by using environment variables.\n";
1274 print "\nFor example:\n\n";
1275 print "export DB_USER=my_koha\n";
1276 print "perl Makefile.PL\n";
1278 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1279 print "If installing on a Win32 platform, be sure to use:\n";
1280 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1285 # This will have to be reworked in order to accommodate Win32...
1289 my $test = $self->SUPER::test(@_);
1290 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1293 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1300 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1301 # This means that we're completely overriding EU::MM's default
1302 # installation and uninstallation targets.
1304 # If installation is on Win32, we need to do permissions different from *nix
1305 if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1306 foreach my $key (sort keys %$target_directories) {
1308 KOHA_INST_$key = blib/$key
1309 KOHA_DEST_$key = $target_directories->{$key}
1310 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1313 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1314 \t\$(NOECHO) \$(NOOP)
1316 $install .= "install_koha ::\n";
1317 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1318 foreach my $key (sort keys %$target_directories) {
1319 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1320 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1322 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1323 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1326 $install .= "set_koha_ownership ::\n";
1327 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1328 foreach my $key (sort keys %$target_directories) {
1329 $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1330 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1333 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1337 $install .= "set_koha_permissions ::\n";
1338 # This is necessary because EU::MM installs files
1339 # as either 0444 or 0555, and we want the owner
1340 # of Koha's files to have write permission by default.
1341 foreach my $key (sort keys %$target_directories) {
1342 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1343 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1346 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1347 # We can attempt some creative things with command line utils such as CACLS which allows permission
1348 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1349 foreach my $key (sort keys %$target_directories) {
1351 KOHA_INST_$key = blib/$key
1352 KOHA_DEST_$key = $target_directories->{$key}
1353 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1356 install :: all install_koha warn_koha_env_vars
1357 \t\$(NOECHO) \$(NOOP)
1359 $install .= "install_koha ::\n";
1360 $install .= "\t\$(MOD_INSTALL) \\\n";
1361 foreach my $key (sort keys %$target_directories) {
1362 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1363 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1368 $install .= "warn_koha_env_vars ::\n";
1369 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1370 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1371 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1372 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1373 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1374 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1375 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1376 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1377 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1378 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1379 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1381 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1382 $install .= _update_zebra_conf_target();
1385 $install .= upgrade();
1390 =head2 _update_zebra_conf_target
1392 Add an installation target for updating
1393 Zebra's configuration files.
1397 sub _update_zebra_conf_target {
1399 my $target = "\nupdate_zebra_conf ::\n";
1400 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1401 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1402 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1403 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1404 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1405 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1414 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1415 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1416 $version =~ s/\./_/g;
1417 $backup_suffix = "_koha_$version";
1419 $backup_suffix = "_upgrade_backup";
1423 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1425 upgrade :: make_upgrade_backup install
1426 \t\$(NOECHO) \$(NOOP)
1427 make_upgrade_backup ::
1428 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1430 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1431 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1432 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1433 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1434 exists $skip_directories->{$key} or
1435 not exists $target_directories->{$key};
1437 $upgrade =~ s/\\\n$/\n/;
1443 # put directory mappings into Makefile
1444 # so that Make will export as environment
1445 # variables -- this is for the use of
1448 # quote '$' in the two password parameters
1449 my %config = %config;
1450 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1451 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1452 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1456 # Hereagain, we must alter syntax per platform...
1457 if ( $^O eq 'MSWin32' ) {
1458 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1459 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1461 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1464 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1466 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1469 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1470 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1471 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1472 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1473 print $confhandle "# It is separate from the standard koha-conf.xml so that you can edit this by hand and test with different configurations.\n";
1475 # these directories will be relocated to the 't' directory
1476 my %move_to_t = map { $_ => 1 } qw( KOHA_CONF_DIR LOG_DIR SCRIPT_DIR ZEBRA_CONF_DIR ZEBRA_LOCK_DIR ZEBRA_DATA_DIR ZEBRA_RUN_DIR );
1477 my $oldbasedir = substr( $target_directories->{'KOHA_CONF_DIR'}, 0, - length( '/etc' ) );
1478 my $newbasedir = $target_directories->{'KOHA_CONF_DIR'};
1479 $newbasedir =~ s/etc$/t/;
1480 foreach my $dirname ( keys %$target_directories ) {
1481 my $dir = $target_directories->{ $dirname };
1482 if ( $move_to_t{ $dirname } ) {
1483 $dir =~ s/$oldbasedir/$newbasedir/;
1485 print $confhandle "$dirname = $dir\n"
1487 print $confhandle "\n";
1489 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1490 close( $confhandle );
1492 warn 'unable to open conf file for database dependent tests: $!';
1505 ExtUtils::MakeMaker(3)
1509 MJ Ray mjr at phonecoop.coop
1510 Galen Charlton galen.charlton at liblime.com
1513 FIXME: deal with .htaccess