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
15 # with Koha; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 # Current maintainer MJR http://mjr.towers.org.uk/
23 use ExtUtils::MakeMaker;
27 use FindBin; # we need to enforce which C4::Installer::PerlModule is used in case more than one is installed
29 use lib $FindBin::Bin;
33 my $koha_pm = C4::Installer::PerlModules->new;
36 die "perl 5.10 or later required" unless ($] >= 5.010000);
38 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
40 my $dirtree = hashdir('.');
45 Makefile.PL - Koha packager and installer
49 =head2 BASIC INSTALLATION
56 =head2 UPGRADE INSTALLATION
58 NOTE: This option is only available if koha-install-log exists.
60 perl Makefile.PL --prev-install-log /path/to/koha-install-log
66 =head2 PACKAGING RELEASE TARBALLS
77 This is a packager and installer that uses
78 ExtUtils::MakeMaker, which is fairly common
80 As well as building tar or zip files
81 and installing with the above commands,
82 it allows us to check pre-requisites
83 and generate configuration files.
87 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
89 Basic metadata about this software.
93 Suppress generation of META.yml file.
97 Hash of perl modules and versions required.
101 Hash of file mappings
105 This is a hash of PL scripts to run after installation and
106 the files to ask them to generate.
107 Maybe use the values from CONFIGURE
108 to generate initial configuration files in future.
114 This is a hash mapping directories and files in the
115 source tree to installation target directories. The rules
116 for this mapping are:
120 =item If a directory or file is specified, it and its
121 contents will be copied to the installation target directory.
123 =item If a subdirectory of a mapped directory is specified,
124 its target overrides the parent's target for that subdirectory.
126 =item The value of each map entry may either be a scalar containing
127 one target or a reference to a hash containing 'target' and 'trimdir'
130 =item Any files at the top level of the source tree that are
131 not included in the map will not be installed.
133 =item Any directories at the top level of the source tree
134 that are not included in the map will be installed in
135 INTRANET_CGI_DIR. This is a sensible default given the
136 current organization of the source tree, but (FIXME) it
137 would be better to reorganize the source tree to better
138 match the installation system, to allow adding new directories
139 without having to adjust Makefile.PL each time. The idea
140 is to make the C<$target_map> hash as minimal as possible.
144 The permitted installation targets are:
148 =item INTRANET_CGI_DIR
150 CGI scripts for intranet (staff) interface.
152 =item INTRANET_TMPL_DIR
154 HTML templates for the intranet interface.
156 =item INTRANET_WWW_DIR
158 HTML files, images, etc. for DocumentRoot for the intranet interface.
162 CGI scripts for OPAC (public) interface.
166 HTML templates for the OPAC interface.
170 HTML files, images, etc. for DocumentRoot for the OPAC interface.
172 =item PERL_MODULE_DIR
174 Perl modules (at present just the C4 modules) that are intimately
175 tied to Koha. Depending on the installation options, these
176 may or may not be installed one of the standard directories
177 in Perl's default @LIB.
181 Directory for Koha configuration files.
185 Directory for Zebra configuration files.
189 Directory for Zebra's lock files.
193 Directory for Zebra's data files.
197 Directory for Zebra's UNIX-domain sockets.
201 Directory for for miscellaenous scripts, among other
202 things the translation toolkit and RSS feed tools.
206 Directory for command-line scripts and daemons to
207 be set up all for installation modes.
209 =item SCRIPT_NONDEV_DIR
211 Directory for command-line scripts that should
212 be installed in the same directory as the
213 SCRIPT_DIR target except 'dev' installs.
217 Directory for man pages created from POD -- will mostly
218 contain information of interest to Koha developers.
222 Directory for Koha documentation accessed from the
223 command-line, e.g., READMEs.
227 Directory for Apache and Zebra logs produced by Koha.
229 =item PAZPAR2_CONF_DIR
231 Directory for PazPar2 configuration files.
235 This is a dummy target used to explicitly state
236 that a given file or directory is not to be installed.
237 This is used either for parts of the installer itself
238 or for development tools that are not applicable to a
239 production installation.
246 './about.pl' => 'INTRANET_CGI_DIR',
247 './acqui' => 'INTRANET_CGI_DIR',
248 './admin' => 'INTRANET_CGI_DIR',
249 './authorities' => 'INTRANET_CGI_DIR',
250 './basket' => 'INTRANET_CGI_DIR',
251 './C4' => 'PERL_MODULE_DIR',
252 './C4/SIP/t' => 'NONE',
253 './C4/SIP/koha_test' => 'NONE',
254 './C4/tests' => 'NONE',
255 './catalogue' => 'INTRANET_CGI_DIR',
256 './cataloguing' => 'INTRANET_CGI_DIR',
257 './changelanguage.pl' => 'INTRANET_CGI_DIR',
258 './check_sysprefs.pl' => 'NONE',
259 './circ' => 'INTRANET_CGI_DIR',
260 './offline_circ' => 'INTRANET_CGI_DIR',
261 './edithelp.pl' => 'INTRANET_CGI_DIR',
262 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
263 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
264 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
265 './help.pl' => 'INTRANET_CGI_DIR',
266 './installer-CPAN.pl' => 'NONE',
267 './installer' => 'INTRANET_CGI_DIR',
268 './errors' => {target => 'INTRANET_CGI_DIR'},
269 './Koha' => 'PERL_MODULE_DIR',
270 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
271 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
272 './kohaversion.pl' => 'INTRANET_CGI_DIR',
273 './labels' => 'INTRANET_CGI_DIR',
274 './mainpage.pl' => 'INTRANET_CGI_DIR',
275 './Makefile.PL' => 'NONE',
276 './MANIFEST.SKIP' => 'NONE',
277 './members' => 'INTRANET_CGI_DIR',
278 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
279 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
280 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
281 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
282 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
283 './misc/installer_devel_notes' => 'NONE',
284 './opac' => 'OPAC_CGI_DIR',
285 './README.txt' => 'NONE',
286 './patroncards' => 'INTRANET_CGI_DIR',
287 './reports' => 'INTRANET_CGI_DIR',
288 './reserve' => 'INTRANET_CGI_DIR',
289 './reviews' => 'INTRANET_CGI_DIR',
290 './rewrite-config.PL' => 'NONE',
291 './reviews' => 'INTRANET_CGI_DIR',
292 './serials' => 'INTRANET_CGI_DIR',
294 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
295 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
296 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
297 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
298 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
299 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
300 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
301 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
302 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
303 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
304 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
305 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
306 './sms' => 'INTRANET_CGI_DIR',
307 './suggestion' => 'INTRANET_CGI_DIR',
308 './svc' => 'INTRANET_CGI_DIR',
310 './tags' => 'INTRANET_CGI_DIR',
311 './tmp' => 'NONE', # FIXME need to determine whether
312 # Koha generates any persistent temp files
313 # that should go in /var/tmp/koha
314 './tools' => 'INTRANET_CGI_DIR',
315 './virtualshelves' => 'INTRANET_CGI_DIR',
316 './xml_sax.pl' => 'PERL_MODULE_DIR',
317 # ignore files and directories created by the install itself
318 './pm_to_blib' => 'NONE',
322 =head1 CONFIGURATION OPTIONS
324 The following configuration options are used by the installer.
330 Specifies whether installation will be FHS-compliant (default,
331 assumes user has root), put everything under
332 a single directory (for users installing on a web host
333 that allows CGI scripts and a MySQL database but not root
334 access), or development (for a developer who wants to run
335 Koha from a git clone with no fuss).
339 Directory under which most components will go. Default
340 value will vary depending on INSTALL_MODE.
344 Type of DBMS (e.g., mysql or Pg).
352 Port that DBMS server is listening on.
356 Name of the DBMS database for Koha.
360 Name of DBMS user account for Koha's database.
364 Pasword of DMBS user account for Koha's database.
368 Whether to install Zebra configuration files and data
371 =item ZEBRA_MARC_FORMAT
373 Specifies format of MARC records to be indexed by Zebra.
377 Specifies primary language of records that will be
382 Internal Zebra user account for the index.
386 Internal Zebra user account's password.
390 System user account that will own Koha's files.
394 System group that will own Koha's files.
400 # default configuration options
401 my %config_defaults = (
402 'DB_TYPE' => 'mysql',
403 'DB_HOST' => 'localhost',
405 'DB_USER' => 'kohaadmin',
406 'DB_PASS' => 'katikoan',
407 'INSTALL_ZEBRA' => 'yes',
408 'INSTALL_SRU' => 'yes',
409 'INSTALL_PAZPAR2' => 'no',
410 'AUTH_INDEX_MODE' => 'dom',
411 'ZEBRA_MARC_FORMAT' => 'marc21',
412 'ZEBRA_LANGUAGE' => 'en',
413 'ZEBRA_USER' => 'kohauser',
414 'ZEBRA_PASS' => 'zebrastripes',
415 'ZEBRA_SRU_HOST' => 'localhost',
416 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
417 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
418 'KOHA_USER' => 'koha',
419 'KOHA_GROUP' => 'koha',
420 'MERGE_SERVER_HOST' => 'localhost',
421 'MERGE_SERVER_PORT' => '11001',
422 'PAZPAR2_HOST' => 'localhost',
423 'PAZPAR2_PORT' => '11002',
424 'RUN_DATABASE_TESTS' => 'no',
425 'PATH_TO_ZEBRA' => '',
426 'USE_MEMCACHED' => 'no',
427 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
428 'MEMCACHED_NAMESPACE' => 'KOHA'
431 # set some default configuration options based on OS
432 # more conditions need to be added for other OS's
433 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
434 # to allow for more granular decisions based on which Win32 platform
436 warn "Your platform appears to be $^O.\n" if $DEBUG;
438 if ( $^O eq 'MSWin32' ) {
439 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
440 # this could be changed to put some files (ie. libraries) into system32, etc.
441 $config_defaults{'INSTALL_MODE'} = 'single';
442 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
444 elsif ( $^O eq 'cygwin' ) {
445 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
446 # this could be changed to put some files (ie. libraries) into system32, etc.
447 $config_defaults{'INSTALL_MODE'} = 'single';
448 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
451 $config_defaults{'INSTALL_MODE'} = 'standard';
452 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
455 # valid values for certain configuration options
456 my %valid_config_values = (
457 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
458 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
459 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
460 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
461 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
462 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
463 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1, 'nb' => 1 }, # FIXME should generate from contents of distribution
464 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
465 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
468 # get settings from command-line
469 my $koha_install_log = "";
470 Getopt::Long::Configure('pass_through');
471 my $results = GetOptions(
472 "prev-install-log=s" => \$koha_install_log
475 my %install_log_values = ();
476 if ($koha_install_log ne "") {
477 get_install_log_values($koha_install_log, \%install_log_values);
480 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
481 my ($target_directories, $skip_directories) = get_target_directories(\%config);
482 display_configuration(\%config, $target_directories);
484 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
487 'rewrite-config.PL' => [
488 'blib/KOHA_CONF_DIR/koha-conf.xml',
489 'blib/KOHA_CONF_DIR/koha-httpd.conf',
490 'blib/MISC_DIR/koha-install-log'
492 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
497 if ($config{'INSTALL_ZEBRA'} eq "yes") {
498 push @{ $pl_files->{'rewrite-config.PL'} }, (
499 'blib/ZEBRA_CONF_DIR/etc/passwd',
500 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
501 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
502 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
503 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
504 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
505 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
506 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
508 push @{ $pl_files->{'rewrite-config.PL'} }, (
509 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
510 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
511 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
513 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
514 push @{ $pl_files->{'rewrite-config.PL'} }, (
515 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
516 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
519 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
520 $config{'AUTH_RETRIEVAL_CFG'} =
521 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
524 if ($config{'INSTALL_MODE'} ne "dev") {
525 push @{ $pl_files->{'rewrite-config.PL'} }, (
526 'blib/PERL_MODULE_DIR/C4/Context.pm',
527 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
531 my %test_suite_override_dirs = (
532 KOHA_CONF_DIR => ['etc'],
533 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
534 LOG_DIR => ['var', 'log'],
535 SCRIPT_DIR => ['bin'],
536 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
537 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
538 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
543 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
544 VERSION_FROM => 'kohaversion.pl',
545 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
546 AUTHOR => 'Koha Contributors <http://koha-community.org/>',
548 PREREQ_PM => $koha_pm->prereq_pm,
553 # Man pages generated from POD
554 # ExtUtils::MakeMaker already manage $(DESTDIR)
555 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
556 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
558 PL_FILES => $pl_files,
565 This function recurses through the directory structure and builds
566 a hash of hashes containing the structure with arrays holding filenames.
567 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
573 opendir my $dh, $dir or die $!;
574 my $tree = {}->{$dir} = {};
575 while( my $file = readdir($dh) ) {
576 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
577 my $path = $dir .'/' . $file;
578 $tree->{$file} = hashdir($path), next if -d $path;
579 push @{$tree->{'.'}}, $file;
586 This function combines the target_map and file hash to
587 map each source file to its destination relative to
588 the set of installation targets.
590 Output will be a hash mapping from each source file
591 to its destination value, like this:
593 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
598 my $target_map = shift;
600 my $file_map = shift;
601 my $install_zebra = shift;
602 my $curr_path = @_ ? shift : ['.'];
604 # Traverse the directory tree.
605 # For each file or directory, identify the
606 # most specific match in the target_map
607 foreach my $dir (sort keys %{ $dirtree }) {
609 # deal with files in directory
610 foreach my $file (sort @{ $dirtree->{$dir} }) {
611 my $targetdir = undef;
612 my $matchlevel = undef;
613 # first, see if there is a match on this specific
614 # file in the target map
615 my $filepath = join("/", @$curr_path, $file);
616 if (exists $target_map->{$filepath}) {
617 $targetdir = $target_map->{$filepath};
618 $matchlevel = scalar(@$curr_path) + 1;
620 # no match on the specific file; look for
622 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
623 my $dirpath = join("/", @$curr_path[0..$i]);
624 if (exists $target_map->{$dirpath}) {
625 $targetdir = $target_map->{$dirpath};
626 $matchlevel = $i + 1;
631 if (defined $targetdir) {
632 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
634 my $path = join("/", @$curr_path);
635 print "failed to map: $path/$file\n" if $DEBUG;
639 # dealing with subdirectory
640 push @$curr_path, $dir;
641 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
647 sub _add_to_file_map {
648 my $file_map = shift;
649 my $targetdir = shift;
650 my $curr_path = shift;
652 my $matchlevel = shift;
653 my $install_zebra = shift;
654 my $dest_path = @_ ? shift : $curr_path;
656 # The target can be one of the following:
657 # 1. scalar representing target symbol
658 # 2. hash ref containing target and trimdir keys
660 # Consequently, this routine traverses this structure,
661 # calling itself recursively, until it deals with
662 # all of the scalar target symbols.
663 if (ref $targetdir eq 'HASH') {
664 my $subtarget = $targetdir->{target};
665 if (exists $targetdir->{trimdir}) {
666 # if we get here, we've specified that
667 # rather than installing the file to
668 # $(TARGET)/matching/dirs/subdirs/file,
669 # we want to install it to
670 # $(TARGET)/subdirs/file
672 # Note that this the only place where
673 # $matchlevel is used.
674 my @new_dest_path = @$dest_path;
675 if ($targetdir->{trimdir} == -1) {
676 splice @new_dest_path, 0, $matchlevel;
678 splice @new_dest_path, 0, $targetdir->{trimdir};
680 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
682 # actually getting here means that the
683 # target was unnecessarily listed
684 # as a hash, but we'll forgive that
685 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
687 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
688 my $source = File::Spec->catfile(@$curr_path, $file);
689 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
690 #print "$source => $destination\n"; # DEBUG
691 # quote spaces in file names
692 # FIXME: this is of questionable portability and
693 # probably depends on user's make recognizing this
694 # quoting syntax -- probably better to remove
695 # spaces and shell metacharacters from all file names
696 $source =~ s/ /\\ /g;
697 $destination =~ s/ /\\ /g;
699 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
703 =head2 get_install_log_values
705 Reads value from the Koha install log specified by
710 sub get_install_log_values {
711 my $install_log = shift;
714 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
717 next if /^#/ or /^\s*$/;
721 my ($key, $value) = split /=/, $_, 2;
722 $values->{$key} = $value;
726 print <<_EXPLAIN_INSTALL_LOG_;
727 Reading values from install log $install_log. You
728 will be prompted only for settings that have been
729 added since the last time you installed Koha. To
730 be prompted for all settings, run 'perl Makefile.PL'
731 without the --prev-install-log option.
732 _EXPLAIN_INSTALL_LOG_
735 =head2 get_configuration
737 This prompts the user for various configuration options.
741 sub get_configuration {
742 my $defaults = shift;
743 my $valid_values = shift;
744 my $install_log_values = shift;
748 By default, Koha can be installed in one of three ways:
750 standard: Install files in conformance with the Filesystem
751 Hierarchy Standard (FHS). This is the default mode
752 and should be used when installing a production
753 Koha system. On Unix systems, root access is
754 needed to complete a standard installation.
756 single: Install files under a single directory. This option
757 is useful for installing Koha without root access, e.g.,
758 on a web host that allows CGI scripts and MySQL databases
759 but requires the user to keep all files under the user's
762 dev: Create a set of symbolic links and configuration files to
763 allow Koha to run directly from the source distribution.
764 This mode is useful for developers who want to run
765 Koha from a git clone.
768 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
769 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
771 # set message and default value for INSTALL_BASE
772 # depending on value of INSTALL_MODE
773 my $install_base_default = $defaults->{'INSTALL_BASE'};
774 if ($config{'INSTALL_MODE'} eq 'dev') {
776 Please specify the directory in which to install Koha's
777 active configuration files and (if applicable) the
778 Zebra database. Koha's CGI scripts and templates will
779 be run from the current directory.
781 Configuration directory:);
782 # FIXME - home directory portability consideration apply
783 $install_base_default =
785 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
787 } elsif ($config{'INSTALL_MODE'} eq 'single') {
788 $msg = "\nPlease specify the directory in which to install Koha";
789 # FIXME -- we're assuming under a 'single' mode install
790 # that user will likely want to install under the home
791 # directory. This is OK in and of itself, but we should
792 # use File::HomeDir to locate the home directory portably.
793 # This is deferred for now because File::HomeDir is not yet
795 # --we must also keep this portable to the major OS's -fbcit
796 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
800 Please specify the directory under which most Koha files
803 Note that if you are planning in installing more than
804 one instance of Koha, you may want to modify the last
805 component of the directory path, which will be used
806 as the package name in the FHS layout.
808 Base installation directory);
810 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
812 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
813 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
814 if ($config{'INSTALL_MODE'} eq "standard") {
816 Since you are using the 'standard' install
817 mode, you should run 'make install' as root.
818 However, it is recommended that a non-root
819 user (on Unix and Linux platforms) have
820 ownership of Koha's files, including the
821 Zebra indexes if applicable.
823 Please specify a user account. This
824 user account does not need to exist
825 right now, but it needs to exist
826 before you run 'make install'. Please
827 note that for security reasons, this
828 user should not be the same as the user
829 account Apache runs under.
832 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
835 Please specify the group that should own
836 Koha's files. As above, this group need
837 not exist right now, but should be created
838 before you run 'make install'.
841 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
845 Please specify which database engine you will use
846 to store data in Koha. The choices are MySQL and
847 PostgreSQL; please note that at the moment
848 PostgreSQL support is highly experimental.
851 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
852 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
855 Please specify the name or address of your
856 database server. Note that the database
857 does not have to exist at this point, it
858 can be created after running 'make install'
859 and before you try using Koha for the first time.
862 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
865 Please specify the port used to connect to the
867 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
868 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
871 Please specify the name of the database to be
873 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
876 Please specify the user that owns the database to be
878 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
881 Please specify the password of the user that owns the
882 database to be used by Koha);
883 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
886 Koha can use the Zebra search engine for high-performance
887 searching of bibliographic and authority records. If you
888 have installed the Zebra software and would like to use it,
889 please answer 'yes' to the following question. Otherwise,
890 Koha will default to using its internal search engine.
892 Please note that if you choose *NOT* to install Zebra,
893 koha-conf.xml will still contain some references to Zebra
894 settings. Those references will be ignored by Koha.
896 Install the Zebra configuration files?);
897 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
898 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
900 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
902 if (defined(my $zebra_path = find_zebra())) {
903 $config{'PATH_TO_ZEBRA'} = $zebra_path;
905 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
909 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
910 in your PATH or in some of the usual places. If you haven't
911 installed Zebra yet, please do so and run Makefile.PL again.
917 Since you've chosen to use Zebra with Koha,
918 you must specify the primary MARC format of the
919 records to be indexed by Zebra.
921 Koha provides Zebra configuration files for MARC 21
924 MARC format for Zebra indexing);
925 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
926 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
928 Koha supplies Zebra configuration files tuned for
929 searching either English (en) or French (fr) MARC
932 Primary language for Zebra indexing);
933 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
934 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
937 Koha can use one of two different indexing modes
938 for the MARC authorities records:
940 grs1 - uses the Zebra GRS-1 filter, available
942 dom - uses the DOM XML filter; offers improved
945 Authorities indexing mode);
946 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
947 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
950 Please specify Zebra database user);
951 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
954 Please specify the Zebra database password);
955 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
958 Since you've chosen to use Zebra, you can enable the SRU/
959 Z39.50 Server if you so choose, but you must specify a
960 few configuration options for it.
962 Please note that if you choose *NOT* to configure SRU,
963 koha-conf.xml will still contain some references to SRU
964 settings. Those references will be ignored by Koha.
966 Install the SRU configuration files?);
967 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
968 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
970 if ($config{'INSTALL_SRU'} eq 'yes') {
972 Since you've chosen to configure SRU, you must
973 specify the host and port(s) that the SRU
974 Servers (bibliographic and authority) should run on.
978 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
981 SRU port for bibliographic data?);
982 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
985 SRU port for authority data?);
986 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
991 Since you've chosen to use Zebra, you can also choose to
992 install PazPar2, which is a metasearch tool. With PazPar2,
993 Koha can perform on-the-fly merging of bibliographic
994 records during searching, allowing for FRBRization of
997 Install the PazPar2 configuration files?);
998 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
999 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1001 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1003 Since you've chosen to configure PazPar2, you must
1004 specify the host and port(s) that PazPar2
1008 Zebra bibliographic server host?);
1009 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1012 Zebra bibliographic port for PazPar2 to use?);
1013 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1017 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1021 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1026 Use memcached and memoize to cache the results of some function calls?
1027 This provides a signficant performance improvement.
1028 You will need a Memcached server running.);
1029 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1030 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1031 if ($config{'USE_MEMCACHED'} eq 'yes'){
1033 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1036 Memcached server address?);
1037 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1040 Memcached namespace?);
1041 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1047 Would you like to run the database-dependent test suite?);
1048 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1049 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1051 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1052 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1053 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1054 $msg = q(TEST DATABASE
1056 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1057 testing. Please don't do this on your production database. It is not
1060 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1061 database. You are better off not running this optional test suite than
1062 doing it in a database that you don't want to lose.
1064 Please specify the name of the test database to be
1067 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1068 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1069 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1070 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1074 Please specify the user that owns the database to be
1076 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1079 Please specify the password of the user that owns the
1080 database to be used by Koha);
1081 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1086 # add version number
1087 my $version = "no_version_found";
1089 require 'kohaversion.pl';
1090 $version = kohaversion();
1092 $config{'KOHA_INSTALLED_VERSION'} = $version;
1097 sub _add_valid_values_disp {
1099 my $valid_values = shift;
1102 if (exists $valid_values->{$key}) {
1103 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1111 my $default = shift;
1112 my $valid_values = shift;
1113 my $install_log_values = shift;
1115 # take value from install log if present
1116 if (exists $install_log_values{$key}) {
1117 $install_log_values{$key} =~ s/\$/\$\$/g;
1118 return $install_log_values{$key};
1121 # override default value from environment
1122 if (exists $ENV{$key}) {
1123 $default = $ENV{$key};
1124 $msg .= " (default from environment)";
1127 my $val = prompt($msg, $default);
1129 while (exists $valid_values->{$key} and
1130 $val ne $default and
1131 not exists $valid_values->{$key}->{$val}) {
1132 my $retry_msg = "Value '$val' is not a valid option.\n";
1133 $retry_msg .= "Please enter a value";
1134 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1135 $val = prompt($retry_msg, $default);
1137 $val =~ s/\$/\$\$/g;
1141 =head2 get_target_directories
1143 Creates a hash mapping from symbols for installation target
1144 directories to actual directory paths.
1146 Also returns a hash indicating targets for which
1147 files need not be copied -- this is used for the 'dev'
1148 mode installation, where some files are installed in place.
1152 sub get_target_directories {
1155 my $base = $config->{'INSTALL_BASE'};
1156 my $mode = $config->{'INSTALL_MODE'};
1158 # get last component of install base directory
1159 # to treat as package name
1160 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1162 my @basedir = File::Spec->splitdir($directories);
1164 # for Win32 we need to prepend the volume to the directory path
1165 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1166 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1168 my $package = pop @basedir;
1173 if ($mode eq 'single') {
1174 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1175 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1176 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1177 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1178 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1179 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1180 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1181 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1182 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1183 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1184 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1185 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1186 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1187 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1188 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1189 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1190 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1191 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1192 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1193 } elsif ($mode eq 'dev') {
1194 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1195 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1196 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1197 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1198 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1199 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1200 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1201 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1202 $skipdirs{'OPAC_CGI_DIR'} = 1;
1203 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1204 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1205 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1206 $skipdirs{'OPAC_WWW_DIR'} = 1;
1207 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1208 $skipdirs{'PERL_MODULE_DIR'} = 1;
1209 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1210 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1211 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1212 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1213 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1214 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1215 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1216 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1217 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1218 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1219 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1220 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1221 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1223 # mode is standard, i.e., 'fhs'
1224 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1225 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1226 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1227 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1228 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1229 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1230 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1231 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1232 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1233 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1234 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1235 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1236 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1237 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1238 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1239 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1240 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1241 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1242 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1245 _get_env_overrides(\%dirmap);
1246 _get_argv_overrides(\%dirmap);
1247 _add_destdir(\%dirmap) unless ($^O eq 'MSWin32');
1249 return \%dirmap, \%skipdirs;
1254 Map a directory target to the corresponding path for
1262 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1263 if (exists $test_suite_override_dirs{$dirname}) {
1264 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1271 sub _get_env_overrides {
1274 foreach my $key (keys %$dirmap) {
1275 if (exists $ENV{$key}) {
1276 $dirmap->{$key} = $ENV{$key};
1277 print "Setting $key from environment\n";
1282 sub _get_argv_overrides {
1286 for (my $i = 0; $i <= $#ARGV; $i++) {
1287 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1290 push @new_argv, $ARGV[$i];
1296 sub _strip_destdir {
1298 $dir =~ s/^\$\(DESTDIR\)//;
1305 foreach my $key (keys %$dirmap) {
1306 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1310 sub display_configuration {
1313 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1314 foreach my $key (sort keys %$config) {
1315 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1318 print "\nand in the following directories:\n\n";
1319 foreach my $key (sort keys %$dirmap) {
1320 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1322 print "\n\nTo change any configuration setting, please run\n";
1323 print "perl Makefile.PL again. To override one of the target\n";
1324 print "directories, you can do so on the command line like this:\n";
1325 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1326 print "You can also set different default values for parameters\n";
1327 print "or override directory locations by using environment variables.\n";
1328 print "\nFor example:\n\n";
1329 print "export DB_USER=my_koha\n";
1330 print "perl Makefile.PL\n";
1332 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1333 print "If installing on a Win32 platform, be sure to use:\n";
1334 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1339 Attempt to find Zebra - check user's PATH and
1340 a few other directories for zebrasrv and zebraidx.
1342 FIXME: doesn't handle Win32
1347 my @search_dirs = map {
1348 my $abs = File::Spec->rel2abs($_);
1349 my ($toss, $directories);
1350 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1352 } split /:/, $ENV{PATH};
1353 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1354 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1355 return unless @zebrasrv_dirs;
1356 # verify that directory that contains zebrasrv also contains zebraidx
1357 foreach my $dir (@zebrasrv_dirs) {
1358 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1365 # This will have to be reworked in order to accommodate Win32...
1369 my $test = $self->SUPER::test(@_);
1370 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1373 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1380 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1381 # This means that we're completely overriding EU::MM's default
1382 # installation and uninstallation targets.
1384 # If installation is on Win32, we need to do permissions different from *nix
1385 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1386 foreach my $key (sort keys %$target_directories) {
1388 KOHA_INST_$key = blib/$key
1389 KOHA_DEST_$key = $target_directories->{$key}
1390 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1393 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1394 \t\$(NOECHO) \$(NOOP)
1396 $install .= "install_koha ::\n";
1397 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1398 foreach my $key (sort keys %$target_directories) {
1399 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1400 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1402 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1403 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1406 $install .= "set_koha_ownership ::\n";
1407 # Do not try to change ownership if DESTDIR is set
1408 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1409 foreach my $key (sort keys %$target_directories) {
1410 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1411 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1414 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1418 $install .= "set_koha_permissions ::\n";
1419 # This is necessary because EU::MM installs files
1420 # as either 0444 or 0555, and we want the owner
1421 # of Koha's files to have write permission by default.
1422 foreach my $key (sort keys %$target_directories) {
1423 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1424 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1427 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1428 # We can attempt some creative things with command line utils such as CACLS which allows permission
1429 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1430 foreach my $key (sort keys %$target_directories) {
1432 KOHA_INST_$key = blib/$key
1433 KOHA_DEST_$key = $target_directories->{$key}
1434 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1437 install :: all install_koha warn_koha_env_vars
1438 \t\$(NOECHO) \$(NOOP)
1440 $install .= "install_koha ::\n";
1441 $install .= "\t\$(MOD_INSTALL) \\\n";
1442 foreach my $key (sort keys %$target_directories) {
1443 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1444 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1449 $install .= "warn_koha_env_vars ::\n";
1450 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1451 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1452 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1453 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1454 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1455 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1456 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1457 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1458 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1459 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1460 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1462 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1463 $install .= _update_zebra_conf_target();
1466 $install .= upgrade();
1471 =head2 _update_zebra_conf_target
1473 Add an installation target for updating
1474 Zebra's configuration files.
1478 sub _update_zebra_conf_target {
1480 my $target = "\nupdate_zebra_conf ::\n";
1481 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1482 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1483 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1484 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1485 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1486 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1495 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1496 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1497 $version =~ s/\./_/g;
1498 $backup_suffix = "_koha_$version";
1500 $backup_suffix = "_upgrade_backup";
1504 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1506 upgrade :: make_upgrade_backup install
1507 \t\$(NOECHO) \$(NOOP)
1508 make_upgrade_backup ::
1509 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1511 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1512 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1513 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1514 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1515 exists $skip_directories->{$key} or
1516 not exists $target_directories->{$key};
1518 $upgrade =~ s/\\\n$/\n/;
1524 # put directory mappings into Makefile
1525 # so that Make will export as environment
1526 # variables -- this is for the use of
1530 # Hereagain, we must alter syntax per platform...
1531 if ( $^O eq 'MSWin32' ) {
1532 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1533 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1535 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1538 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1540 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1543 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1544 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1545 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1546 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1547 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";
1549 # these directories will be relocated to the 't' directory
1550 foreach my $dirname ( keys %$target_directories ) {
1551 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1552 if ( exists $test_suite_override_dirs{$dirname} ) {
1553 $dir = main::get_test_dir($dirname);
1555 print $confhandle "$dirname = $dir\n"
1557 print $confhandle "\n";
1559 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1560 close( $confhandle );
1562 warn 'unable to open conf file for database dependent tests: $!';
1575 ExtUtils::MakeMaker(3)
1579 MJ Ray mjr at phonecoop.coop
1580 Galen Charlton galen.charlton at liblime.com
1584 FIXME: deal with .htaccess