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-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
270 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
271 './kohaversion.pl' => 'INTRANET_CGI_DIR',
272 './labels' => 'INTRANET_CGI_DIR',
273 './mainpage.pl' => 'INTRANET_CGI_DIR',
274 './Makefile.PL' => 'NONE',
275 './MANIFEST.SKIP' => 'NONE',
276 './members' => 'INTRANET_CGI_DIR',
277 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
278 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
279 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
280 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
281 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
282 './misc/installer_devel_notes' => 'NONE',
283 './opac' => 'OPAC_CGI_DIR',
284 './README.txt' => 'NONE',
285 './patroncards' => 'INTRANET_CGI_DIR',
286 './reports' => 'INTRANET_CGI_DIR',
287 './reserve' => 'INTRANET_CGI_DIR',
288 './reviews' => 'INTRANET_CGI_DIR',
289 './rewrite-config.PL' => 'NONE',
290 './reviews' => 'INTRANET_CGI_DIR',
291 './serials' => 'INTRANET_CGI_DIR',
293 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
294 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
295 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
296 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
297 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
298 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
299 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
300 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
301 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
302 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
303 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
304 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
305 './sms' => 'INTRANET_CGI_DIR',
306 './suggestion' => 'INTRANET_CGI_DIR',
307 './svc' => 'INTRANET_CGI_DIR',
309 './tags' => 'INTRANET_CGI_DIR',
310 './tmp' => 'NONE', # FIXME need to determine whether
311 # Koha generates any persistent temp files
312 # that should go in /var/tmp/koha
313 './tools' => 'INTRANET_CGI_DIR',
314 './virtualshelves' => 'INTRANET_CGI_DIR',
315 './xml_sax.pl' => 'PERL_MODULE_DIR',
316 # ignore files and directories created by the install itself
317 './pm_to_blib' => 'NONE',
321 =head1 CONFIGURATION OPTIONS
323 The following configuration options are used by the installer.
329 Specifies whether installation will be FHS-compliant (default,
330 assumes user has root), put everything under
331 a single directory (for users installing on a web host
332 that allows CGI scripts and a MySQL database but not root
333 access), or development (for a developer who wants to run
334 Koha from a git clone with no fuss).
338 Directory under which most components will go. Default
339 value will vary depending on INSTALL_MODE.
343 Type of DBMS (e.g., mysql or Pg).
351 Port that DBMS server is listening on.
355 Name of the DBMS database for Koha.
359 Name of DBMS user account for Koha's database.
363 Pasword of DMBS user account for Koha's database.
367 Whether to install Zebra configuration files and data
370 =item ZEBRA_MARC_FORMAT
372 Specifies format of MARC records to be indexed by Zebra.
376 Specifies primary language of records that will be
381 Internal Zebra user account for the index.
385 Internal Zebra user account's password.
389 System user account that will own Koha's files.
393 System group that will own Koha's files.
399 # default configuration options
400 my %config_defaults = (
401 'DB_TYPE' => 'mysql',
402 'DB_HOST' => 'localhost',
404 'DB_USER' => 'kohaadmin',
405 'DB_PASS' => 'katikoan',
406 'INSTALL_ZEBRA' => 'yes',
407 'INSTALL_SRU' => 'yes',
408 'INSTALL_PAZPAR2' => 'no',
409 'AUTH_INDEX_MODE' => 'dom',
410 'ZEBRA_MARC_FORMAT' => 'marc21',
411 'ZEBRA_LANGUAGE' => 'en',
412 'ZEBRA_USER' => 'kohauser',
413 'ZEBRA_PASS' => 'zebrastripes',
414 'ZEBRA_SRU_HOST' => 'localhost',
415 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
416 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
417 'KOHA_USER' => 'koha',
418 'KOHA_GROUP' => 'koha',
419 'MERGE_SERVER_HOST' => 'localhost',
420 'MERGE_SERVER_PORT' => '11001',
421 'PAZPAR2_HOST' => 'localhost',
422 'PAZPAR2_PORT' => '11002',
423 'RUN_DATABASE_TESTS' => 'no',
424 'PATH_TO_ZEBRA' => '',
425 'USE_MEMCACHED' => 'no',
426 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
427 'MEMCACHED_NAMESPACE' => 'KOHA'
430 # set some default configuration options based on OS
431 # more conditions need to be added for other OS's
432 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
433 # to allow for more granular decisions based on which Win32 platform
435 warn "Your platform appears to be $^O.\n" if $DEBUG;
437 if ( $^O eq 'MSWin32' ) {
438 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
439 # this could be changed to put some files (ie. libraries) into system32, etc.
440 $config_defaults{'INSTALL_MODE'} = 'single';
441 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
443 elsif ( $^O eq 'cygwin' ) {
444 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
445 # this could be changed to put some files (ie. libraries) into system32, etc.
446 $config_defaults{'INSTALL_MODE'} = 'single';
447 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
450 $config_defaults{'INSTALL_MODE'} = 'standard';
451 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
454 # valid values for certain configuration options
455 my %valid_config_values = (
456 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
457 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
458 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
459 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
460 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
461 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
462 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1, 'nb' => 1 }, # FIXME should generate from contents of distribution
463 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
464 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
467 # get settings from command-line
468 my $koha_install_log = "";
469 Getopt::Long::Configure('pass_through');
470 my $results = GetOptions(
471 "prev-install-log=s" => \$koha_install_log
474 my %install_log_values = ();
475 if ($koha_install_log ne "") {
476 get_install_log_values($koha_install_log, \%install_log_values);
479 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
480 my ($target_directories, $skip_directories) = get_target_directories(\%config);
481 display_configuration(\%config, $target_directories);
483 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
486 'rewrite-config.PL' => [
487 'blib/KOHA_CONF_DIR/koha-conf.xml',
488 'blib/KOHA_CONF_DIR/koha-httpd.conf',
489 'blib/MISC_DIR/koha-install-log'
491 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
496 if ($config{'INSTALL_ZEBRA'} eq "yes") {
497 push @{ $pl_files->{'rewrite-config.PL'} }, (
498 'blib/ZEBRA_CONF_DIR/etc/passwd',
499 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
500 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
501 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
502 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
503 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
504 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
505 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
507 push @{ $pl_files->{'rewrite-config.PL'} }, (
508 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
509 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
510 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
512 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
513 push @{ $pl_files->{'rewrite-config.PL'} }, (
514 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
515 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
518 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
519 $config{'AUTH_RETRIEVAL_CFG'} =
520 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
523 if ($config{'INSTALL_MODE'} ne "dev") {
524 push @{ $pl_files->{'rewrite-config.PL'} }, (
525 'blib/PERL_MODULE_DIR/C4/Context.pm',
526 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
530 my %test_suite_override_dirs = (
531 KOHA_CONF_DIR => ['etc'],
532 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
533 LOG_DIR => ['var', 'log'],
534 SCRIPT_DIR => ['bin'],
535 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
536 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
537 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
542 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
543 VERSION_FROM => 'kohaversion.pl',
544 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
545 AUTHOR => 'Koha Contributors <http://koha-community.org/>',
547 PREREQ_PM => $koha_pm->prereq_pm,
552 # Man pages generated from POD
553 # ExtUtils::MakeMaker already manage $(DESTDIR)
554 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
555 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
557 PL_FILES => $pl_files,
564 This function recurses through the directory structure and builds
565 a hash of hashes containing the structure with arrays holding filenames.
566 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
572 opendir my $dh, $dir or die $!;
573 my $tree = {}->{$dir} = {};
574 while( my $file = readdir($dh) ) {
575 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
576 my $path = $dir .'/' . $file;
577 $tree->{$file} = hashdir($path), next if -d $path;
578 push @{$tree->{'.'}}, $file;
585 This function combines the target_map and file hash to
586 map each source file to its destination relative to
587 the set of installation targets.
589 Output will be a hash mapping from each source file
590 to its destination value, like this:
592 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
597 my $target_map = shift;
599 my $file_map = shift;
600 my $install_zebra = shift;
601 my $curr_path = @_ ? shift : ['.'];
603 # Traverse the directory tree.
604 # For each file or directory, identify the
605 # most specific match in the target_map
606 foreach my $dir (sort keys %{ $dirtree }) {
608 # deal with files in directory
609 foreach my $file (sort @{ $dirtree->{$dir} }) {
610 my $targetdir = undef;
611 my $matchlevel = undef;
612 # first, see if there is a match on this specific
613 # file in the target map
614 my $filepath = join("/", @$curr_path, $file);
615 if (exists $target_map->{$filepath}) {
616 $targetdir = $target_map->{$filepath};
617 $matchlevel = scalar(@$curr_path) + 1;
619 # no match on the specific file; look for
621 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
622 my $dirpath = join("/", @$curr_path[0..$i]);
623 if (exists $target_map->{$dirpath}) {
624 $targetdir = $target_map->{$dirpath};
625 $matchlevel = $i + 1;
630 if (defined $targetdir) {
631 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
633 my $path = join("/", @$curr_path);
634 print "failed to map: $path/$file\n" if $DEBUG;
638 # dealing with subdirectory
639 push @$curr_path, $dir;
640 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
646 sub _add_to_file_map {
647 my $file_map = shift;
648 my $targetdir = shift;
649 my $curr_path = shift;
651 my $matchlevel = shift;
652 my $install_zebra = shift;
653 my $dest_path = @_ ? shift : $curr_path;
655 # The target can be one of the following:
656 # 1. scalar representing target symbol
657 # 2. hash ref containing target and trimdir keys
659 # Consequently, this routine traverses this structure,
660 # calling itself recursively, until it deals with
661 # all of the scalar target symbols.
662 if (ref $targetdir eq 'HASH') {
663 my $subtarget = $targetdir->{target};
664 if (exists $targetdir->{trimdir}) {
665 # if we get here, we've specified that
666 # rather than installing the file to
667 # $(TARGET)/matching/dirs/subdirs/file,
668 # we want to install it to
669 # $(TARGET)/subdirs/file
671 # Note that this the only place where
672 # $matchlevel is used.
673 my @new_dest_path = @$dest_path;
674 if ($targetdir->{trimdir} == -1) {
675 splice @new_dest_path, 0, $matchlevel;
677 splice @new_dest_path, 0, $targetdir->{trimdir};
679 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
681 # actually getting here means that the
682 # target was unnecessarily listed
683 # as a hash, but we'll forgive that
684 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
686 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
687 my $source = File::Spec->catfile(@$curr_path, $file);
688 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
689 #print "$source => $destination\n"; # DEBUG
690 # quote spaces in file names
691 # FIXME: this is of questionable portability and
692 # probably depends on user's make recognizing this
693 # quoting syntax -- probably better to remove
694 # spaces and shell metacharacters from all file names
695 $source =~ s/ /\\ /g;
696 $destination =~ s/ /\\ /g;
698 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
702 =head2 get_install_log_values
704 Reads value from the Koha install log specified by
709 sub get_install_log_values {
710 my $install_log = shift;
713 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
716 next if /^#/ or /^\s*$/;
720 my ($key, $value) = split /=/, $_, 2;
721 $values->{$key} = $value;
725 print <<_EXPLAIN_INSTALL_LOG_;
726 Reading values from install log $install_log. You
727 will be prompted only for settings that have been
728 added since the last time you installed Koha. To
729 be prompted for all settings, run 'perl Makefile.PL'
730 without the --prev-install-log option.
731 _EXPLAIN_INSTALL_LOG_
734 =head2 get_configuration
736 This prompts the user for various configuration options.
740 sub get_configuration {
741 my $defaults = shift;
742 my $valid_values = shift;
743 my $install_log_values = shift;
747 By default, Koha can be installed in one of three ways:
749 standard: Install files in conformance with the Filesystem
750 Hierarchy Standard (FHS). This is the default mode
751 and should be used when installing a production
752 Koha system. On Unix systems, root access is
753 needed to complete a standard installation.
755 single: Install files under a single directory. This option
756 is useful for installing Koha without root access, e.g.,
757 on a web host that allows CGI scripts and MySQL databases
758 but requires the user to keep all files under the user's
761 dev: Create a set of symbolic links and configuration files to
762 allow Koha to run directly from the source distribution.
763 This mode is useful for developers who want to run
764 Koha from a git clone.
767 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
768 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
770 # set message and default value for INSTALL_BASE
771 # depending on value of INSTALL_MODE
772 my $install_base_default = $defaults->{'INSTALL_BASE'};
773 if ($config{'INSTALL_MODE'} eq 'dev') {
775 Please specify the directory in which to install Koha's
776 active configuration files and (if applicable) the
777 Zebra database. Koha's CGI scripts and templates will
778 be run from the current directory.
780 Configuration directory:);
781 # FIXME - home directory portability consideration apply
782 $install_base_default =
784 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
786 } elsif ($config{'INSTALL_MODE'} eq 'single') {
787 $msg = "\nPlease specify the directory in which to install Koha";
788 # FIXME -- we're assuming under a 'single' mode install
789 # that user will likely want to install under the home
790 # directory. This is OK in and of itself, but we should
791 # use File::HomeDir to locate the home directory portably.
792 # This is deferred for now because File::HomeDir is not yet
794 # --we must also keep this portable to the major OS's -fbcit
795 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
799 Please specify the directory under which most Koha files
802 Note that if you are planning in installing more than
803 one instance of Koha, you may want to modify the last
804 component of the directory path, which will be used
805 as the package name in the FHS layout.
807 Base installation directory);
809 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
811 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
812 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
813 if ($config{'INSTALL_MODE'} eq "standard") {
815 Since you are using the 'standard' install
816 mode, you should run 'make install' as root.
817 However, it is recommended that a non-root
818 user (on Unix and Linux platforms) have
819 ownership of Koha's files, including the
820 Zebra indexes if applicable.
822 Please specify a user account. This
823 user account does not need to exist
824 right now, but it needs to exist
825 before you run 'make install'. Please
826 note that for security reasons, this
827 user should not be the same as the user
828 account Apache runs under.
831 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
834 Please specify the group that should own
835 Koha's files. As above, this group need
836 not exist right now, but should be created
837 before you run 'make install'.
840 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
844 Please specify which database engine you will use
845 to store data in Koha. The choices are MySQL and
846 PostgreSQL; please note that at the moment
847 PostgreSQL support is highly experimental.
850 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
851 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
854 Please specify the name or address of your
855 database server. Note that the database
856 does not have to exist at this point, it
857 can be created after running 'make install'
858 and before you try using Koha for the first time.
861 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
864 Please specify the port used to connect to the
866 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
867 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
870 Please specify the name of the database to be
872 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
875 Please specify the user that owns the database to be
877 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
880 Please specify the password of the user that owns the
881 database to be used by Koha);
882 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
885 Koha can use the Zebra search engine for high-performance
886 searching of bibliographic and authority records. If you
887 have installed the Zebra software and would like to use it,
888 please answer 'yes' to the following question. Otherwise,
889 Koha will default to using its internal search engine.
891 Please note that if you choose *NOT* to install Zebra,
892 koha-conf.xml will still contain some references to Zebra
893 settings. Those references will be ignored by Koha.
895 Install the Zebra configuration files?);
896 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
897 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
899 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
901 if (defined(my $zebra_path = find_zebra())) {
902 $config{'PATH_TO_ZEBRA'} = $zebra_path;
904 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
908 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
909 in your PATH or in some of the usual places. If you haven't
910 installed Zebra yet, please do so and run Makefile.PL again.
916 Since you've chosen to use Zebra with Koha,
917 you must specify the primary MARC format of the
918 records to be indexed by Zebra.
920 Koha provides Zebra configuration files for MARC 21
923 MARC format for Zebra indexing);
924 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
925 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
927 Koha supplies Zebra configuration files tuned for
928 searching either English (en) or French (fr) MARC
931 Primary language for Zebra indexing);
932 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
933 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
936 Koha can use one of two different indexing modes
937 for the MARC authorities records:
939 grs1 - uses the Zebra GRS-1 filter, available
941 dom - uses the DOM XML filter; offers improved
944 Authorities indexing mode);
945 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
946 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
949 Please specify Zebra database user);
950 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
953 Please specify the Zebra database password);
954 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
957 Since you've chosen to use Zebra, you can enable the SRU/
958 Z39.50 Server if you so choose, but you must specify a
959 few configuration options for it.
961 Please note that if you choose *NOT* to configure SRU,
962 koha-conf.xml will still contain some references to SRU
963 settings. Those references will be ignored by Koha.
965 Install the SRU configuration files?);
966 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
967 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
969 if ($config{'INSTALL_SRU'} eq 'yes') {
971 Since you've chosen to configure SRU, you must
972 specify the host and port(s) that the SRU
973 Servers (bibliographic and authority) should run on.
977 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
980 SRU port for bibliographic data?);
981 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
984 SRU port for authority data?);
985 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
990 Since you've chosen to use Zebra, you can also choose to
991 install PazPar2, which is a metasearch tool. With PazPar2,
992 Koha can perform on-the-fly merging of bibliographic
993 records during searching, allowing for FRBRization of
996 Install the PazPar2 configuration files?);
997 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
998 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1000 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1002 Since you've chosen to configure PazPar2, you must
1003 specify the host and port(s) that PazPar2
1007 Zebra bibliographic server host?);
1008 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1011 Zebra bibliographic port for PazPar2 to use?);
1012 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1016 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1020 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1025 Use memcached and memoize to cache the results of some function calls?
1026 This provides a signficant performance improvement.
1027 You will need a Memcached server running.);
1028 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1029 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1030 if ($config{'USE_MEMCACHED'} eq 'yes'){
1032 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1035 Memcached server address?);
1036 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1039 Memcached namespace?);
1040 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1046 Would you like to run the database-dependent test suite?);
1047 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1048 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1050 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1051 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1052 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1053 $msg = q(TEST DATABASE
1055 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1056 testing. Please don't do this on your production database. It is not
1059 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1060 database. You are better off not running this optional test suite than
1061 doing it in a database that you don't want to lose.
1063 Please specify the name of the test database to be
1066 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1067 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1068 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1069 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1073 Please specify the user that owns the database to be
1075 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1078 Please specify the password of the user that owns the
1079 database to be used by Koha);
1080 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1085 # add version number
1086 my $version = "no_version_found";
1088 require 'kohaversion.pl';
1089 $version = kohaversion();
1091 $config{'KOHA_INSTALLED_VERSION'} = $version;
1096 sub _add_valid_values_disp {
1098 my $valid_values = shift;
1101 if (exists $valid_values->{$key}) {
1102 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1110 my $default = shift;
1111 my $valid_values = shift;
1112 my $install_log_values = shift;
1114 # take value from install log if present
1115 if (exists $install_log_values{$key}) {
1116 $install_log_values{$key} =~ s/\$/\$\$/g;
1117 return $install_log_values{$key};
1120 # override default value from environment
1121 if (exists $ENV{$key}) {
1122 $default = $ENV{$key};
1123 $msg .= " (default from environment)";
1126 my $val = prompt($msg, $default);
1128 while (exists $valid_values->{$key} and
1129 $val ne $default and
1130 not exists $valid_values->{$key}->{$val}) {
1131 my $retry_msg = "Value '$val' is not a valid option.\n";
1132 $retry_msg .= "Please enter a value";
1133 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1134 $val = prompt($retry_msg, $default);
1136 $val =~ s/\$/\$\$/g;
1140 =head2 get_target_directories
1142 Creates a hash mapping from symbols for installation target
1143 directories to actual directory paths.
1145 Also returns a hash indicating targets for which
1146 files need not be copied -- this is used for the 'dev'
1147 mode installation, where some files are installed in place.
1151 sub get_target_directories {
1154 my $base = $config->{'INSTALL_BASE'};
1155 my $mode = $config->{'INSTALL_MODE'};
1157 # get last component of install base directory
1158 # to treat as package name
1159 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1161 my @basedir = File::Spec->splitdir($directories);
1163 # for Win32 we need to prepend the volume to the directory path
1164 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1165 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1167 my $package = pop @basedir;
1172 if ($mode eq 'single') {
1173 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1174 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1175 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1176 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1177 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1178 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1179 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1180 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1181 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1182 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1183 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1184 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1185 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1186 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1187 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1188 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1189 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1190 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1191 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1192 } elsif ($mode eq 'dev') {
1193 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1194 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1195 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1196 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1197 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1198 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1199 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1200 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1201 $skipdirs{'OPAC_CGI_DIR'} = 1;
1202 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1203 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1204 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1205 $skipdirs{'OPAC_WWW_DIR'} = 1;
1206 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1207 $skipdirs{'PERL_MODULE_DIR'} = 1;
1208 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1209 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1210 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1211 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1212 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1213 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1214 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1215 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1216 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1217 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1218 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1219 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1220 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1222 # mode is standard, i.e., 'fhs'
1223 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1224 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1225 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1226 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1227 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1228 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1229 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1230 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1231 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1232 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1233 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1234 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1235 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1236 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1237 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1238 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1239 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1240 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1241 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1244 _get_env_overrides(\%dirmap);
1245 _get_argv_overrides(\%dirmap);
1246 _add_destdir(\%dirmap) unless ($^O eq 'MSWin32');
1248 return \%dirmap, \%skipdirs;
1253 Map a directory target to the corresponding path for
1261 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1262 if (exists $test_suite_override_dirs{$dirname}) {
1263 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1270 sub _get_env_overrides {
1273 foreach my $key (keys %$dirmap) {
1274 if (exists $ENV{$key}) {
1275 $dirmap->{$key} = $ENV{$key};
1276 print "Setting $key from environment\n";
1281 sub _get_argv_overrides {
1285 for (my $i = 0; $i <= $#ARGV; $i++) {
1286 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1289 push @new_argv, $ARGV[$i];
1295 sub _strip_destdir {
1297 $dir =~ s/^\$\(DESTDIR\)//;
1304 foreach my $key (keys %$dirmap) {
1305 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1309 sub display_configuration {
1312 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1313 foreach my $key (sort keys %$config) {
1314 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1317 print "\nand in the following directories:\n\n";
1318 foreach my $key (sort keys %$dirmap) {
1319 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1321 print "\n\nTo change any configuration setting, please run\n";
1322 print "perl Makefile.PL again. To override one of the target\n";
1323 print "directories, you can do so on the command line like this:\n";
1324 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1325 print "You can also set different default values for parameters\n";
1326 print "or override directory locations by using environment variables.\n";
1327 print "\nFor example:\n\n";
1328 print "export DB_USER=my_koha\n";
1329 print "perl Makefile.PL\n";
1331 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1332 print "If installing on a Win32 platform, be sure to use:\n";
1333 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1338 Attempt to find Zebra - check user's PATH and
1339 a few other directories for zebrasrv and zebraidx.
1341 FIXME: doesn't handle Win32
1346 my @search_dirs = map {
1347 my $abs = File::Spec->rel2abs($_);
1348 my ($toss, $directories);
1349 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1351 } split /:/, $ENV{PATH};
1352 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1353 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1354 return unless @zebrasrv_dirs;
1355 # verify that directory that contains zebrasrv also contains zebraidx
1356 foreach my $dir (@zebrasrv_dirs) {
1357 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1364 # This will have to be reworked in order to accommodate Win32...
1368 my $test = $self->SUPER::test(@_);
1369 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1372 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1379 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1380 # This means that we're completely overriding EU::MM's default
1381 # installation and uninstallation targets.
1383 # If installation is on Win32, we need to do permissions different from *nix
1384 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1385 foreach my $key (sort keys %$target_directories) {
1387 KOHA_INST_$key = blib/$key
1388 KOHA_DEST_$key = $target_directories->{$key}
1389 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1392 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1393 \t\$(NOECHO) \$(NOOP)
1395 $install .= "install_koha ::\n";
1396 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1397 foreach my $key (sort keys %$target_directories) {
1398 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1399 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1401 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1402 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1405 $install .= "set_koha_ownership ::\n";
1406 # Do not try to change ownership if DESTDIR is set
1407 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1408 foreach my $key (sort keys %$target_directories) {
1409 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1410 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1413 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1417 $install .= "set_koha_permissions ::\n";
1418 # This is necessary because EU::MM installs files
1419 # as either 0444 or 0555, and we want the owner
1420 # of Koha's files to have write permission by default.
1421 foreach my $key (sort keys %$target_directories) {
1422 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1423 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1426 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1427 # We can attempt some creative things with command line utils such as CACLS which allows permission
1428 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1429 foreach my $key (sort keys %$target_directories) {
1431 KOHA_INST_$key = blib/$key
1432 KOHA_DEST_$key = $target_directories->{$key}
1433 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1436 install :: all install_koha warn_koha_env_vars
1437 \t\$(NOECHO) \$(NOOP)
1439 $install .= "install_koha ::\n";
1440 $install .= "\t\$(MOD_INSTALL) \\\n";
1441 foreach my $key (sort keys %$target_directories) {
1442 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1443 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1448 $install .= "warn_koha_env_vars ::\n";
1449 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1450 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1451 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1452 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1453 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1454 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1455 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1456 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1457 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1458 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1459 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1461 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1462 $install .= _update_zebra_conf_target();
1465 $install .= upgrade();
1470 =head2 _update_zebra_conf_target
1472 Add an installation target for updating
1473 Zebra's configuration files.
1477 sub _update_zebra_conf_target {
1479 my $target = "\nupdate_zebra_conf ::\n";
1480 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1481 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1482 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1483 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1484 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1485 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1494 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1495 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1496 $version =~ s/\./_/g;
1497 $backup_suffix = "_koha_$version";
1499 $backup_suffix = "_upgrade_backup";
1503 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1505 upgrade :: make_upgrade_backup install
1506 \t\$(NOECHO) \$(NOOP)
1507 make_upgrade_backup ::
1508 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1510 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1511 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1512 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1513 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1514 exists $skip_directories->{$key} or
1515 not exists $target_directories->{$key};
1517 $upgrade =~ s/\\\n$/\n/;
1523 # put directory mappings into Makefile
1524 # so that Make will export as environment
1525 # variables -- this is for the use of
1529 # Hereagain, we must alter syntax per platform...
1530 if ( $^O eq 'MSWin32' ) {
1531 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1532 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1534 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1537 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1539 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1542 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1543 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1544 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1545 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1546 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";
1548 # these directories will be relocated to the 't' directory
1549 foreach my $dirname ( keys %$target_directories ) {
1550 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1551 if ( exists $test_suite_override_dirs{$dirname} ) {
1552 $dir = main::get_test_dir($dirname);
1554 print $confhandle "$dirname = $dir\n"
1556 print $confhandle "\n";
1558 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1559 close( $confhandle );
1561 warn 'unable to open conf file for database dependent tests: $!';
1574 ExtUtils::MakeMaker(3)
1578 MJ Ray mjr at phonecoop.coop
1579 Galen Charlton galen.charlton at liblime.com
1583 FIXME: deal with .htaccess