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 to
201 be set up all for installation modes.
203 =item SCRIPT_NONDEV_DIR
205 Directory for command-line scripts that should
206 be installed in the same directory as the
207 SCRIPT_DIR target except 'dev' installs.
211 Directory for man pages created from POD -- will mostly
212 contain information of interest to Koha developers.
216 Directory for Koha documentation accessed from the
217 command-line, e.g., READMEs.
221 Directory for Apache and Zebra logs produced by Koha.
223 =item PAZPAR2_CONF_DIR
225 Directory for PazPar2 configuration files.
229 This is a dummy target used to explicitly state
230 that a given file or directory is not to be installed.
231 This is used either for parts of the installer itself
232 or for development tools that are not applicable to a
233 production installation.
240 './about.pl' => 'INTRANET_CGI_DIR',
241 './acqui' => 'INTRANET_CGI_DIR',
242 './admin' => 'INTRANET_CGI_DIR',
243 './authorities' => 'INTRANET_CGI_DIR',
244 './C4' => 'PERL_MODULE_DIR',
245 './C4/SIP/t' => 'NONE',
246 './C4/SIP/koha_test' => 'NONE',
247 './C4/tests' => 'NONE',
248 './catalogue' => 'INTRANET_CGI_DIR',
249 './cataloguing' => 'INTRANET_CGI_DIR',
250 './changelanguage.pl' => 'INTRANET_CGI_DIR',
251 './check_sysprefs.pl' => 'NONE',
252 './circ' => 'INTRANET_CGI_DIR',
253 './edithelp.pl' => 'INTRANET_CGI_DIR',
254 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
255 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
256 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
257 './help.pl' => 'INTRANET_CGI_DIR',
258 './installer-CPAN.pl' => 'NONE',
259 './installer' => 'INTRANET_CGI_DIR',
260 './errors' => {target => 'INTRANET_CGI_DIR'},
261 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
262 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
263 './kohaversion.pl' => 'INTRANET_CGI_DIR',
264 './labels' => 'INTRANET_CGI_DIR',
265 './mainpage.pl' => 'INTRANET_CGI_DIR',
266 './Makefile.PL' => 'NONE',
267 './MANIFEST.SKIP' => 'NONE',
268 './members' => 'INTRANET_CGI_DIR',
269 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
270 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
271 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
272 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
273 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
274 './misc/installer_devel_notes' => 'NONE',
275 './opac' => 'OPAC_CGI_DIR',
276 './README.txt' => 'NONE',
277 './reports' => 'INTRANET_CGI_DIR',
278 './reserve' => 'INTRANET_CGI_DIR',
279 './reviews' => 'INTRANET_CGI_DIR',
280 './rewrite-config.PL' => 'NONE',
281 './reviews' => 'INTRANET_CGI_DIR',
282 './rss' => 'MISC_DIR',
283 './serials' => 'INTRANET_CGI_DIR',
285 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
286 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
287 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
288 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
289 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
290 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
291 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
292 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
293 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
294 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
295 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
296 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
297 './sms' => 'INTRANET_CGI_DIR',
298 './suggestion' => 'INTRANET_CGI_DIR',
299 './svc' => 'INTRANET_CGI_DIR',
301 './tmp' => 'NONE', # FIXME need to determine whether
302 # Koha generates any persistent temp files
303 # that should go in /var/tmp/koha
304 './tools' => 'INTRANET_CGI_DIR',
305 './virtualshelves' => 'INTRANET_CGI_DIR',
306 # ignore files and directories created by the install itself
307 './pm_to_blib' => 'NONE',
311 =head1 CONFIGURATION OPTIONS
313 The following configuration options are used by the installer.
319 Specifies whether installation will be FHS-compliant (default,
320 assumes user has root), put everything under
321 a single directory (for users installing on a web host
322 that allows CGI scripts and a MySQL database but not root
323 access), or development (for a developer who wants to run
324 Koha from a git clone with no fuss).
328 Directory under which most components will go. Default
329 value will vary depending on INSTALL_MODE.
333 Type of DBMS (e.g., mysql or Pg).
341 Port that DBMS server is listening on.
345 Name of the DBMS database for Koha.
349 Name of DBMS user account for Koha's database.
353 Pasword of DMBS user account for Koha's database.
357 Whether to install Zebra configuration files and data
360 =item ZEBRA_MARC_FORMAT
362 Specifies format of MARC records to be indexed by Zebra.
366 Specifies primary language of records that will be
371 Internal Zebra user account for the index.
375 Internal Zebra user account's password.
379 System user account that will own Koha's files.
383 System group that will own Koha's files.
389 # default configuration options
390 my %config_defaults = (
391 'DB_TYPE' => 'mysql',
392 'DB_HOST' => 'localhost',
394 'DB_USER' => 'kohaadmin',
395 'DB_PASS' => 'katikoan',
396 'INSTALL_ZEBRA' => 'yes',
397 'INSTALL_SRU' => 'yes',
398 'INSTALL_PAZPAR2' => 'no',
399 'AUTH_INDEX_MODE' => 'grs1',
400 'ZEBRA_MARC_FORMAT' => 'marc21',
401 'ZEBRA_LANGUAGE' => 'en',
402 'ZEBRA_USER' => 'kohauser',
403 'ZEBRA_PASS' => 'zebrastripes',
404 'ZEBRA_SRU_HOST' => 'localhost',
405 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
406 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
407 'KOHA_USER' => 'koha',
408 'KOHA_GROUP' => 'koha',
409 'MERGE_SERVER_HOST' => 'localhost',
410 'MERGE_SERVER_PORT' => '11001',
411 'PAZPAR2_HOST' => 'localhost',
412 'PAZPAR2_PORT' => '11002',
413 'RUN_DATABASE_TESTS' => 'no',
416 # set some default configuratio options based on OS
417 # more conditions need to be added for other OS's
418 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
419 # to allow for more granular decisions based on which Win32 platform
421 warn "Your platform appears to be $^O.\n" if $DEBUG;
423 if ( $^O eq 'MSWin32' ) {
424 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
425 # this could be changed to put some files (ie. libraries) into system32, etc.
426 $config_defaults{'INSTALL_MODE'} = 'single';
427 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
429 elsif ( $^O eq 'cygwin' ) {
430 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
431 # this could be changed to put some files (ie. libraries) into system32, etc.
432 $config_defaults{'INSTALL_MODE'} = 'single';
433 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
436 $config_defaults{'INSTALL_MODE'} = 'standard';
437 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
440 # valid values for certain configuration options
441 my %valid_config_values = (
442 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
443 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
444 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
445 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
446 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
447 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
448 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
449 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
452 # get settings from command-line
453 my $koha_install_log = "";
454 Getopt::Long::Configure('pass_through');
455 my $results = GetOptions(
456 "prev-install-log=s" => \$koha_install_log
459 my %install_log_values = ();
460 if ($koha_install_log ne "") {
461 get_install_log_values($koha_install_log, \%install_log_values);
464 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
465 my ($target_directories, $skip_directories) = get_target_directories(\%config);
466 display_configuration(\%config, $target_directories);
468 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
471 'rewrite-config.PL' => [
472 'blib/KOHA_CONF_DIR/koha-conf.xml',
473 'blib/KOHA_CONF_DIR/koha-httpd.conf',
474 'blib/MISC_DIR/koha-install-log'
476 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
481 if ($config{'INSTALL_ZEBRA'} eq "yes") {
482 push @{ $pl_files->{'rewrite-config.PL'} }, (
483 'blib/ZEBRA_CONF_DIR/etc/passwd',
484 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
485 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
486 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
487 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
488 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
489 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
490 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
492 push @{ $pl_files->{'rewrite-config.PL'} }, (
493 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
494 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
495 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
497 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
498 push @{ $pl_files->{'rewrite-config.PL'} }, (
499 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
500 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
503 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
504 $config{'AUTH_RETRIEVAL_CFG'} =
505 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
508 if ($config{'INSTALL_MODE'} ne "dev") {
509 push @{ $pl_files->{'rewrite-config.PL'} }, (
510 'blib/PERL_MODULE_DIR/C4/Context.pm',
511 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
515 my %test_suite_override_dirs = (
516 KOHA_CONF_DIR => ['etc'],
517 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
518 LOG_DIR => ['var', 'log'],
519 SCRIPT_DIR => ['bin'],
520 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
521 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
522 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
527 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
528 VERSION_FROM => 'kohaversion.pl',
529 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
530 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
533 # awaiting package maintainer's use of $VERSION
534 #'Algorithm::CheckDigits' => 0.48,
535 #'Algorithm::CheckDigits::M43_001' => 0.48,
536 'Biblio::EndnoteStyle' => 0.05,
539 'CGI::Session' => '4.10',
540 'Class::Factory::Util' => 1.6,
541 'Class::Accessor' => 0.30,
542 'DBD::mysql' => 4.004,
544 'Data::ICal' => 0.13,
545 'Data::Dumper' => 2.121,
547 'Date::ICal' => 1.72,
548 'Date::Manip' => 5.44,
549 'Digest::MD5' => 2.36,
550 'File::Temp' => 0.16,
551 'GD::Barcode::UPCE' => 1.1,
552 'Getopt::Long' => 2.35,
553 'Getopt::Std' => 1.05,
554 'HTML::Template::Pro' => 0.69,
555 'HTTP::Cookies' => 1.39,
556 'HTTP::Request::Common' => 1.26,
557 'Image::Magick' => 6.2,
558 'LWP::Simple' => 1.41,
559 'LWP::UserAgent' => 2.033,
560 'Lingua::Stem' => 0.82,
561 'List::Util' => 1.18,
562 'List::MoreUtils' => 0.21,
563 'Locale::Language' => 2.07,
564 'MARC::Charset' => 0.98,
565 'MARC::Crosswalk::DublinCore' => 0.02,
566 'MARC::File::XML' => 0.88,
567 'MARC::Record' => 2.00,
568 'MIME::Base64' => 3.07,
569 'MIME::QuotedPrint' => 3.07,
570 'Mail::Sendmail' => 0.79,
572 'Net::LDAP::Filter' => 0.14,
573 'Net::Z3950::ZOOM' => 1.16,
574 'PDF::API2' => 2.000,
575 'PDF::API2::Page' => 2.000,
576 'PDF::API2::Util' => 2.000,
577 'PDF::Reuse' => 0.33,
578 'PDF::Reuse::Barcode' => 0.05,
581 'Schedule::At' => 1.06,
582 'Term::ANSIColor' => 1.10,
584 'Test::Harness' => 2.56,
585 'Test::More' => 0.62,
587 'Text::CSV_XS' => 0.32,
588 'Text::Iconv' => 1.7,
589 'Text::Wrap' => 2005.082401,
590 'Time::HiRes' => 1.86,
591 'Time::localtime' => 1.02,
592 'Unicode::Normalize' => 0.32,
593 'XML::Dumper' => 0.81,
594 'XML::LibXML' => 1.59,
595 'XML::LibXSLT' => 1.59,
596 'XML::SAX::ParserFactory' => 1.01,
597 'XML::Simple' => 2.14,
599 'YAML::Syck' => 0.71,
605 # Man pages generated from POD
606 INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
607 INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
609 PL_FILES => $pl_files,
617 This function recurses through the directory structure and builds
618 a hash of hashes containing the structure with arrays holding filenames.
619 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
625 opendir my $dh, $dir or die $!;
626 my $tree = {}->{$dir} = {};
627 while( my $file = readdir($dh) ) {
628 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
629 my $path = $dir .'/' . $file;
630 $tree->{$file} = hashdir($path), next if -d $path;
631 push @{$tree->{'.'}}, $file;
638 This function combines the target_map and file hash to
639 map each source file to its destination relative to
640 the set of installation targets.
642 Output will be a hash mapping from each source file
643 to its destination value, like this:
645 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
650 my $target_map = shift;
652 my $file_map = shift;
653 my $install_zebra = shift;
654 my $curr_path = @_ ? shift : ['.'];
656 # Traverse the directory tree.
657 # For each file or directory, identify the
658 # most specific match in the target_map
659 foreach my $dir (sort keys %{ $dirtree }) {
661 # deal with files in directory
662 foreach my $file (sort @{ $dirtree->{$dir} }) {
663 my $targetdir = undef;
664 my $matchlevel = undef;
665 # first, see if there is a match on this specific
666 # file in the target map
667 my $filepath = join("/", @$curr_path, $file);
668 if (exists $target_map->{$filepath}) {
669 $targetdir = $target_map->{$filepath};
670 $matchlevel = scalar(@$curr_path) + 1;
672 # no match on the specific file; look for
674 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
675 my $dirpath = join("/", @$curr_path[0..$i]);
676 if (exists $target_map->{$dirpath}) {
677 $targetdir = $target_map->{$dirpath};
678 $matchlevel = $i + 1;
683 if (defined $targetdir) {
684 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
686 my $path = join("/", @$curr_path);
687 print "failed to map: $path/$file\n" if $DEBUG;
691 # dealing with subdirectory
692 push @$curr_path, $dir;
693 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
699 sub _add_to_file_map {
700 my $file_map = shift;
701 my $targetdir = shift;
702 my $curr_path = shift;
704 my $matchlevel = shift;
705 my $install_zebra = shift;
706 my $dest_path = @_ ? shift : $curr_path;
708 # The target can be one of the following:
709 # 1. scalar representing target symbol
710 # 2. hash ref containing target and trimdir keys
712 # Consequently, this routine traverses this structure,
713 # calling itself recursively, until it deals with
714 # all of the scalar target symbols.
715 if (ref $targetdir eq 'HASH') {
716 my $subtarget = $targetdir->{target};
717 if (exists $targetdir->{trimdir}) {
718 # if we get here, we've specified that
719 # rather than installing the file to
720 # $(TARGET)/matching/dirs/subdirs/file,
721 # we want to install it to
722 # $(TARGET)/subdirs/file
724 # Note that this the only place where
725 # $matchlevel is used.
726 my @new_dest_path = @$dest_path;
727 if ($targetdir->{trimdir} == -1) {
728 splice @new_dest_path, 0, $matchlevel;
730 splice @new_dest_path, 0, $targetdir->{trimdir};
732 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
734 # actually getting here means that the
735 # target was unnecessarily listed
736 # as a hash, but we'll forgive that
737 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
739 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
740 my $source = File::Spec->catfile(@$curr_path, $file);
741 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
742 #print "$source => $destination\n"; # DEBUG
743 # quote spaces in file names
744 # FIXME: this is of questionable portability and
745 # probably depends on user's make recognizing this
746 # quoting syntax -- probably better to remove
747 # spaces and shell metacharacters from all file names
748 $source =~ s/ /\\ /g;
749 $destination =~ s/ /\\ /g;
751 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
755 =head2 get_install_log_values
757 Reads value from the Koha install log specified by
762 sub get_install_log_values {
763 my $install_log = shift;
766 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
769 next if /^#/ or /^\s*$/;
773 my ($key, $value) = split /=/, $_, 2;
774 $values->{$key} = $value;
778 print <<_EXPLAIN_INSTALL_LOG_;
779 Reading values from install log $install_log. You
780 will be prompted only for settings that have been
781 added since the last time you installed Koha. To
782 be prompted for all settings, run 'perl Makefile.PL'
783 without the --prev-install-log option.
784 _EXPLAIN_INSTALL_LOG_
787 =head2 get_configuration
789 This prompts the user for various configuration options.
793 sub get_configuration {
794 my $defaults = shift;
795 my $valid_values = shift;
796 my $install_log_values = shift;
800 By default, Koha can be installed in one of three ways:
802 standard: Install files in conformance with the Filesystem
803 Hierarchy Standard (FHS). This is the default mode
804 and should be used when installing a production
805 Koha system. On Unix systems, root access is
806 needed to complete a standard installation.
808 single: Install files under a single directory. This option
809 is useful for installing Koha without root access, e.g.,
810 on a web host that allows CGI scripts and MySQL databases
811 but requires the user to keep all files under the user's
814 dev: Create a set of symbolic links and configuration files to
815 allow Koha to run directly from the source distribution.
816 This mode is useful for developers who want to run
817 Koha from a git clone.
820 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
821 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
823 # set message and default value for INSTALL_BASE
824 # depending on value of INSTALL_MODE
825 my $install_base_default = $defaults->{'INSTALL_BASE'};
826 if ($config{'INSTALL_MODE'} eq 'dev') {
828 Please specify the directory in which to install Koha's
829 active configuration files and (if applicable) the
830 Zebra database. Koha's CGI scripts and templates will
831 be run from the current directory.
833 Configuration directory:);
834 # FIXME - home directory portability consideration apply
835 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
836 } elsif ($config{'INSTALL_MODE'} eq 'single') {
837 $msg = "\nPlease specify the directory in which to install Koha";
838 # FIXME -- we're assuming under a 'single' mode install
839 # that user will likely want to install under the home
840 # directory. This is OK in and of itself, but we should
841 # use File::HomeDir to locate the home directory portably.
842 # This is deferred for now because File::HomeDir is not yet
844 # --we must also keep this portable to the major OS's -fbcit
845 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
849 Please specify the directory under which most Koha files
852 Note that if you are planning in installing more than
853 one instance of Koha, you may want to modify the last
854 component of the directory path, which will be used
855 as the package name in the FHS layout.
857 Base installation directory);
859 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
861 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
862 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
863 if ($config{'INSTALL_MODE'} eq "standard") {
865 Since you are using the 'standard' install
866 mode, you should run 'make install' as root.
867 However, it is recommended that a non-root
868 user (on Unix and Linux platforms) have
869 ownership of Koha's files, including the
870 Zebra indexes if applicable.
872 Please specify a user account. This
873 user account does not need to exist
874 right now, but it needs to exist
875 before you run 'make install'. Please
876 note that for security reasons, this
877 user should not be the same as the user
878 account Apache runs under.
881 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
884 Please specify the group that should own
885 Koha's files. As above, this group need
886 not exist right now, but should be created
887 before you run 'make install'.
890 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
894 Please specify which database engine you will use
895 to store data in Koha. The choices are MySQL and
896 PostgreSQL; please note that at the moment
897 PostgreSQL support is highly experimental.
900 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
901 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
904 Please specify the name or address of your
905 database server. Note that the database
906 does not have to exist at this point, it
907 can be created after running 'make install'
908 and before you try using Koha for the first time.
911 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
914 Please specify the port used to connect to the
916 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
917 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
920 Please specify the name of the database to be
922 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
925 Please specify the user that owns the database to be
927 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
930 Please specify the password of the user that owns the
931 database to be used by Koha);
932 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
935 Koha can use the Zebra search engine for high-performance
936 searching of bibliographic and authority records. If you
937 have installed the Zebra software and would like to use it,
938 please answer 'yes' to the following question. Otherwise,
939 Koha will default to using its internal search engine.
941 Please note that if you choose *NOT* to install Zebra,
942 koha-conf.xml will still contain some references to Zebra
943 settings. Those references will be ignored by Koha.
945 Install the Zebra configuration files?);
946 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
947 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
949 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
951 Since you've chosen to use Zebra with Koha,
952 you must specify the primary MARC format of the
953 records to be indexed by Zebra.
955 Koha provides Zebra configuration files for MARC 21
958 MARC format for Zebra indexing);
959 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
960 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
962 Koha supplies Zebra configuration files tuned for
963 searching either English (en) or French (fr) MARC
966 Primary language for Zebra indexing);
967 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
968 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
971 Koha can use one of two different indexing modes
972 for the MARC authorities records:
974 grs1 - uses the Zebra GRS-1 filter, available
976 dom - uses the DOM XML filter; offers improved
979 Authorities indexing mode);
980 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
981 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
984 Please specify Zebra database user);
985 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
988 Please specify the Zebra database password);
989 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
992 Since you've chosen to use Zebra, you can enable the SRU/
993 Z39.50 Server if you so choose, but you must specify a
994 few configuration options for it.
996 Please note that if you choose *NOT* to configure SRU,
997 koha-conf.xml will still contain some references to SRU
998 settings. Those references will be ignored by Koha.
1000 Install the SRU configuration files?);
1001 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1002 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1004 if ($config{'INSTALL_SRU'} eq 'yes') {
1006 Since you've chosen to configure SRU, you must
1007 specify the host and port(s) that the SRU
1008 Servers (bibliographic and authority) should run on.
1011 SRU Database host?);
1012 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1015 SRU port for bibliographic data?);
1016 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1019 SRU port for authority data?);
1020 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1025 Since you've chosen to use Zebra, you can also choose to
1026 install PazPar2, which is a metasearch tool. With PazPar2,
1027 Koha can perform on-the-fly merging of bibliographic
1028 records during searching, allowing for FRBRization of
1031 Install the PazPar2 configuration files?);
1032 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1033 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1035 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1037 Since you've chosen to configure PazPar2, you must
1038 specify the host and port(s) that PazPar2
1042 Zebra bibliographic server host?);
1043 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1046 Zebra bibliographic port for PazPar2 to use?);
1047 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1051 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1055 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1061 Would you like to run the database-dependent test suite?);
1062 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1063 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1065 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1066 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1067 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1068 $msg = q(TEST DATABASE
1070 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1071 testing. Please don't do this on your production database. It is not
1074 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1075 database. You are better off not running this optional test suite than
1076 doing it in a database that you don't want to lose.
1078 Please specify the name of the test database to be
1081 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1084 Please specify the user that owns the database to be
1086 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1089 Please specify the password of the user that owns the
1090 database to be used by Koha);
1091 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1096 # add version number
1097 my $version = "no_version_found";
1099 require 'kohaversion.pl';
1100 $version = kohaversion();
1102 $config{'KOHA_INSTALLED_VERSION'} = $version;
1107 sub _add_valid_values_disp {
1109 my $valid_values = shift;
1112 if (exists $valid_values->{$key}) {
1113 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1121 my $default = shift;
1122 my $valid_values = shift;
1123 my $install_log_values = shift;
1125 # take value from install log if present
1126 if (exists $install_log_values{$key}) {
1127 return $install_log_values{$key};
1130 # override default value from environment
1131 if (exists $ENV{$key}) {
1132 $default = $ENV{$key};
1133 $msg .= " (default from environment)";
1136 my $val = prompt($msg, $default);
1138 while (exists $valid_values->{$key} and
1139 $val ne $default and
1140 not exists $valid_values->{$key}->{$val}) {
1141 my $retry_msg = "Value '$val' is not a valid option.\n";
1142 $retry_msg .= "Please enter a value";
1143 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1144 $val = prompt($retry_msg, $default);
1149 =head2 get_target_directories
1151 Creates a hash mapping from symbols for installation target
1152 directories to actual directory paths.
1154 Also returns a hash indicating targets for which
1155 files need not be copied -- this is used for the 'dev'
1156 mode installation, where some files are installed in place.
1160 sub get_target_directories {
1163 my $base = $config->{'INSTALL_BASE'};
1164 my $mode = $config->{'INSTALL_MODE'};
1166 # get last component of install base directory
1167 # to treat as package name
1168 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1170 my @basedir = File::Spec->splitdir($directories);
1172 # for Win32 we need to prepend the volume to the directory path
1173 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1174 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1176 my $package = pop @basedir;
1181 if ($mode eq 'single') {
1182 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1183 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1184 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1185 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1186 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1187 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1188 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1189 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1190 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1191 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1192 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1193 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1194 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1195 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1196 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1197 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1198 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1199 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1200 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1201 } elsif ($mode eq 'dev') {
1202 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1203 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1204 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1205 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1206 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1207 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1208 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1209 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1210 $skipdirs{'OPAC_CGI_DIR'} = 1;
1211 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1212 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1213 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1214 $skipdirs{'OPAC_WWW_DIR'} = 1;
1215 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1216 $skipdirs{'PERL_MODULE_DIR'} = 1;
1217 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1218 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1219 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1220 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1221 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1222 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1223 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1224 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1225 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1226 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1227 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1228 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1229 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1231 # mode is standard, i.e., 'fhs'
1232 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1233 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1234 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1235 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1236 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1237 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1238 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1239 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1240 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1241 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1242 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1243 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1244 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1245 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1246 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1247 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1248 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1249 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1250 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1253 _get_env_overrides(\%dirmap);
1254 _get_argv_overrides(\%dirmap);
1256 return \%dirmap, \%skipdirs;
1261 Map a directory target to the corresponding path for
1269 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1270 if (exists $test_suite_override_dirs{$dirname}) {
1271 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1278 sub _get_env_overrides {
1281 foreach my $key (keys %$dirmap) {
1282 if (exists $ENV{$key}) {
1283 $dirmap->{$key} = $ENV{$key};
1284 print "Setting $key from environment\n";
1289 sub _get_argv_overrides {
1293 for (my $i = 0; $i <= $#ARGV; $i++) {
1294 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1297 push @new_argv, $ARGV[$i];
1303 sub display_configuration {
1306 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1307 foreach my $key (sort keys %$config) {
1308 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1311 print "\nand in the following directories:\n\n";
1312 foreach my $key (sort keys %$dirmap) {
1313 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1315 print "\n\nTo change any configuration setting, please run\n";
1316 print "perl Makefile.PL again. To override one of the target\n";
1317 print "directories, you can do so on the command line like this:\n";
1318 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1319 print "You can also set different default values for parameters\n";
1320 print "or override directory locations by using environment variables.\n";
1321 print "\nFor example:\n\n";
1322 print "export DB_USER=my_koha\n";
1323 print "perl Makefile.PL\n";
1325 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1326 print "If installing on a Win32 platform, be sure to use:\n";
1327 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1332 # This will have to be reworked in order to accommodate Win32...
1336 my $test = $self->SUPER::test(@_);
1337 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1340 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1347 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1348 # This means that we're completely overriding EU::MM's default
1349 # installation and uninstallation targets.
1351 # If installation is on Win32, we need to do permissions different from *nix
1352 if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1353 foreach my $key (sort keys %$target_directories) {
1355 KOHA_INST_$key = blib/$key
1356 KOHA_DEST_$key = $target_directories->{$key}
1357 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1360 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1361 \t\$(NOECHO) \$(NOOP)
1363 $install .= "install_koha ::\n";
1364 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1365 foreach my $key (sort keys %$target_directories) {
1366 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1367 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1369 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1370 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1373 $install .= "set_koha_ownership ::\n";
1374 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1375 foreach my $key (sort keys %$target_directories) {
1376 $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1377 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1380 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1384 $install .= "set_koha_permissions ::\n";
1385 # This is necessary because EU::MM installs files
1386 # as either 0444 or 0555, and we want the owner
1387 # of Koha's files to have write permission by default.
1388 foreach my $key (sort keys %$target_directories) {
1389 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1390 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1393 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1394 # We can attempt some creative things with command line utils such as CACLS which allows permission
1395 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1396 foreach my $key (sort keys %$target_directories) {
1398 KOHA_INST_$key = blib/$key
1399 KOHA_DEST_$key = $target_directories->{$key}
1400 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1403 install :: all install_koha warn_koha_env_vars
1404 \t\$(NOECHO) \$(NOOP)
1406 $install .= "install_koha ::\n";
1407 $install .= "\t\$(MOD_INSTALL) \\\n";
1408 foreach my $key (sort keys %$target_directories) {
1409 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1410 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1415 $install .= "warn_koha_env_vars ::\n";
1416 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1417 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1418 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1419 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1420 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1421 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1422 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1423 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1424 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1425 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1426 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1428 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1429 $install .= _update_zebra_conf_target();
1432 $install .= upgrade();
1437 =head2 _update_zebra_conf_target
1439 Add an installation target for updating
1440 Zebra's configuration files.
1444 sub _update_zebra_conf_target {
1446 my $target = "\nupdate_zebra_conf ::\n";
1447 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1448 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1449 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1450 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1451 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1452 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1461 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1462 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1463 $version =~ s/\./_/g;
1464 $backup_suffix = "_koha_$version";
1466 $backup_suffix = "_upgrade_backup";
1470 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1472 upgrade :: make_upgrade_backup install
1473 \t\$(NOECHO) \$(NOOP)
1474 make_upgrade_backup ::
1475 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1477 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1478 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1479 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1480 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1481 exists $skip_directories->{$key} or
1482 not exists $target_directories->{$key};
1484 $upgrade =~ s/\\\n$/\n/;
1490 # put directory mappings into Makefile
1491 # so that Make will export as environment
1492 # variables -- this is for the use of
1495 # quote '$' in the two password parameters
1496 my %config = %config;
1497 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1498 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1499 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1503 # Hereagain, we must alter syntax per platform...
1504 if ( $^O eq 'MSWin32' ) {
1505 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1506 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1508 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1511 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1513 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1516 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1517 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1518 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1519 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1520 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";
1522 # these directories will be relocated to the 't' directory
1523 foreach my $dirname ( keys %$target_directories ) {
1524 my $dir = $target_directories->{$dirname};
1525 if ( exists $test_suite_override_dirs{$dirname} ) {
1526 $dir = main::get_test_dir($dirname);
1528 print $confhandle "$dirname = $dir\n"
1530 print $confhandle "\n";
1532 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1533 close( $confhandle );
1535 warn 'unable to open conf file for database dependent tests: $!';
1548 ExtUtils::MakeMaker(3)
1552 MJ Ray mjr at phonecoop.coop
1553 Galen Charlton galen.charlton at liblime.com
1556 FIXME: deal with .htaccess