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
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
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. This includes subdirs for authorities,
190 biblios, and the zebra rebuild function. Any activity to reindex
191 zebra from koha should interlock here with rebuild_zebra.pl.
195 Directory for Zebra's data files.
199 Directory for Zebra's UNIX-domain sockets.
203 Directory for for miscellaenous scripts, among other
204 things the translation toolkit and RSS feed tools.
208 Directory for command-line scripts and daemons to
209 be set up all for installation modes.
211 =item SCRIPT_NONDEV_DIR
213 Directory for command-line scripts that should
214 be installed in the same directory as the
215 SCRIPT_DIR target except 'dev' installs.
219 Directory for man pages created from POD -- will mostly
220 contain information of interest to Koha developers.
224 Directory for Koha documentation accessed from the
225 command-line, e.g., READMEs.
229 Directory for Apache and Zebra logs produced by Koha.
233 Directory for backup files produced by Koha.
237 Directory for external Koha plugins.
239 =item PAZPAR2_CONF_DIR
241 Directory for PazPar2 configuration files.
245 This is a dummy target used to explicitly state
246 that a given file or directory is not to be installed.
247 This is used either for parts of the installer itself
248 or for development tools that are not applicable to a
249 production installation.
256 './about.pl' => 'INTRANET_CGI_DIR',
257 './acqui' => 'INTRANET_CGI_DIR',
258 './admin' => 'INTRANET_CGI_DIR',
259 './authorities' => 'INTRANET_CGI_DIR',
260 './basket' => 'INTRANET_CGI_DIR',
261 './C4' => 'PERL_MODULE_DIR',
262 './C4/SIP/t' => 'NONE',
263 './C4/SIP/koha_test' => 'NONE',
264 './C4/tests' => 'NONE',
265 './catalogue' => 'INTRANET_CGI_DIR',
266 './cataloguing' => 'INTRANET_CGI_DIR',
267 './changelanguage.pl' => 'INTRANET_CGI_DIR',
268 './check_sysprefs.pl' => 'NONE',
269 './circ' => 'INTRANET_CGI_DIR',
270 './course_reserves' => 'INTRANET_CGI_DIR',
271 './docs/history.txt' => { target => 'DOC_DIR', trimdir => -1 },
272 './offline_circ' => 'INTRANET_CGI_DIR',
273 './edithelp.pl' => 'INTRANET_CGI_DIR',
274 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
275 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
276 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
277 './help.pl' => 'INTRANET_CGI_DIR',
278 './installer-CPAN.pl' => 'NONE',
279 './installer' => 'INTRANET_CGI_DIR',
280 './errors' => {target => 'INTRANET_CGI_DIR'},
281 './Koha' => 'PERL_MODULE_DIR',
282 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
283 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
284 './kohaversion.pl' => 'INTRANET_CGI_DIR',
285 './labels' => 'INTRANET_CGI_DIR',
286 './mainpage.pl' => 'INTRANET_CGI_DIR',
287 './Makefile.PL' => 'NONE',
288 './MANIFEST.SKIP' => 'NONE',
289 './members' => 'INTRANET_CGI_DIR',
290 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
291 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
292 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
293 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
294 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
295 './misc/installer_devel_notes' => 'NONE',
296 './opac' => 'OPAC_CGI_DIR',
297 './OpenILS' => 'PERL_MODULE_DIR',
298 './README.txt' => 'NONE',
299 './patroncards' => 'INTRANET_CGI_DIR',
300 './patron_lists' => 'INTRANET_CGI_DIR',
301 './plugins' => 'INTRANET_CGI_DIR',
302 './reports' => 'INTRANET_CGI_DIR',
303 './reserve' => 'INTRANET_CGI_DIR',
304 './reviews' => 'INTRANET_CGI_DIR',
305 './rewrite-config.PL' => 'NONE',
306 './reviews' => 'INTRANET_CGI_DIR',
307 './rotating_collections' => 'INTRANET_CGI_DIR',
308 './serials' => 'INTRANET_CGI_DIR',
309 './services' => 'INTRANET_CGI_DIR',
311 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
312 './skel/var/spool/koha' => { target => 'BACKUP_DIR', trimdir => -1 },
313 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
314 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
315 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
316 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
317 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
318 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
319 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
320 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
321 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
322 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
323 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
324 './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
325 './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
326 './sms' => 'INTRANET_CGI_DIR',
327 './suggestion' => 'INTRANET_CGI_DIR',
328 './svc' => 'INTRANET_CGI_DIR',
330 './tags' => 'INTRANET_CGI_DIR',
331 './tmp' => 'NONE', # FIXME need to determine whether
332 # Koha generates any persistent temp files
333 # that should go in /var/tmp/koha
334 './tools' => 'INTRANET_CGI_DIR',
335 './virtualshelves' => 'INTRANET_CGI_DIR',
336 './xml_sax.pl' => 'PERL_MODULE_DIR',
337 # ignore files and directories created by the install itself
338 './pm_to_blib' => 'NONE',
342 =head1 CONFIGURATION OPTIONS
344 The following configuration options are used by the installer.
350 Specifies whether installation will be FHS-compliant (default,
351 assumes user has root), put everything under
352 a single directory (for users installing on a web host
353 that allows CGI scripts and a MySQL database but not root
354 access), or development (for a developer who wants to run
355 Koha from a git clone with no fuss).
359 Directory under which most components will go. Default
360 value will vary depending on INSTALL_MODE.
364 Type of DBMS (e.g., mysql or Pg).
372 Port that DBMS server is listening on.
376 Name of the DBMS database for Koha.
380 Name of DBMS user account for Koha's database.
384 Pasword of DMBS user account for Koha's database.
386 =item ZEBRA_MARC_FORMAT
388 Specifies format of MARC records to be indexed by Zebra.
392 Specifies primary language of records that will be
397 Internal Zebra user account for the index.
401 Internal Zebra user account's password.
405 System user account that will own Koha's files.
409 System group that will own Koha's files.
415 # default configuration options
416 my %config_defaults = (
417 'DB_TYPE' => 'mysql',
418 'DB_HOST' => 'localhost',
420 'DB_USER' => 'kohaadmin',
421 'DB_PASS' => 'katikoan',
422 'INSTALL_SRU' => 'yes',
423 'INSTALL_PAZPAR2' => 'no',
424 'AUTH_INDEX_MODE' => 'dom',
425 'BIB_INDEX_MODE' => 'dom',
426 'ZEBRA_MARC_FORMAT' => 'marc21',
427 'ZEBRA_LANGUAGE' => 'en',
428 'ZEBRA_TOKENIZER' => 'chr',
429 'ZEBRA_USER' => 'kohauser',
430 'ZEBRA_PASS' => 'zebrastripes',
431 'ZEBRA_SRU_HOST' => 'localhost',
432 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
433 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
434 'KOHA_USER' => 'koha',
435 'KOHA_GROUP' => 'koha',
436 'MERGE_SERVER_HOST' => 'localhost',
437 'MERGE_SERVER_PORT' => '11001',
438 'PAZPAR2_HOST' => 'localhost',
439 'PAZPAR2_PORT' => '11002',
440 'RUN_DATABASE_TESTS' => 'no',
441 'PATH_TO_ZEBRA' => '',
442 'USE_MEMCACHED' => 'no',
443 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
444 'MEMCACHED_NAMESPACE' => 'KOHA'
447 # set some default configuration options based on OS
448 # more conditions need to be added for other OS's
450 warn "Your platform appears to be $^O.\n" if $DEBUG;
452 if ( $^O eq 'cygwin' ) {
453 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
454 # this could be changed to put some files (ie. libraries) into system32, etc.
455 $config_defaults{'INSTALL_MODE'} = 'single';
456 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
459 $config_defaults{'INSTALL_MODE'} = 'standard';
460 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
463 # valid values for certain configuration options
464 my %valid_config_values = (
465 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
466 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
467 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
468 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
469 'BIB_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
470 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
471 'ZEBRA_LANGUAGE' => { 'en' => 1, 'es' => 1, 'fr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
472 'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
473 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
474 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
477 # get settings from command-line
478 my $koha_install_log = "";
479 Getopt::Long::Configure('pass_through');
480 my $results = GetOptions(
481 "prev-install-log=s" => \$koha_install_log
484 my %install_log_values = ();
485 if ($koha_install_log ne "") {
486 get_install_log_values($koha_install_log, \%install_log_values);
489 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
490 my ($target_directories, $skip_directories) = get_target_directories(\%config);
491 display_configuration(\%config, $target_directories);
493 get_file_map($target_map, $dirtree, $file_map);
496 'rewrite-config.PL' => [
497 'blib/KOHA_CONF_DIR/koha-conf.xml',
498 'blib/KOHA_CONF_DIR/koha-httpd.conf',
499 'blib/ZEBRA_CONF_DIR/etc/default.idx',
500 'blib/MISC_DIR/koha-install-log'
502 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
507 push @{ $pl_files->{'rewrite-config.PL'} }, (
508 'blib/ZEBRA_CONF_DIR/etc/passwd',
509 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
510 'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
511 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
512 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
513 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
514 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
515 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
516 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
517 'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
518 'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
520 push @{ $pl_files->{'rewrite-config.PL'} }, (
521 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
522 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
523 'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
525 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
526 push @{ $pl_files->{'rewrite-config.PL'} }, (
527 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
528 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
531 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
532 ? 'zebra-authorities-dom.cfg'
533 : 'zebra-authorities.cfg';
534 $config{'ZEBRA_BIB_CFG'} = $config{'BIB_INDEX_MODE'} eq 'dom'
535 ? 'zebra-biblios-dom.cfg'
536 : 'zebra-biblios.cfg';
537 $config{'AUTH_RETRIEVAL_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
538 ? 'retrieval-info-auth-dom.xml'
539 : 'retrieval-info-auth-grs1.xml';
540 $config{'BIB_RETRIEVAL_CFG'} = $config{'BIB_INDEX_MODE'} eq 'dom'
541 ? 'retrieval-info-bib-dom.xml'
542 : 'retrieval-info-bib-grs1.xml';
545 if ($config{'INSTALL_MODE'} ne "dev") {
546 push @{ $pl_files->{'rewrite-config.PL'} }, (
547 'blib/PERL_MODULE_DIR/C4/Context.pm',
548 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
552 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
553 ? 'icuchain words-icu.xml'
554 : 'charmap word-phrase-utf.chr';
556 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
557 ? 'icuchain phrases-icu.xml'
558 : 'charmap word-phrase-utf.chr';
560 my %test_suite_override_dirs = (
561 KOHA_CONF_DIR => ['etc'],
562 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
563 LOG_DIR => ['var', 'log'],
564 BACKUP_DIR => ['var', 'spool'],
565 SCRIPT_DIR => ['bin'],
566 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
567 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
568 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
573 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
574 VERSION_FROM => 'kohaversion.pl',
575 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
576 AUTHOR => 'Koha Contributors <http://koha-community.org/>',
578 PREREQ_PM => $koha_pm->prereq_pm,
583 # Man pages generated from POD
584 # ExtUtils::MakeMaker already manage $(DESTDIR)
585 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
586 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
588 PL_FILES => $pl_files,
595 This function recurses through the directory structure and builds
596 a hash of hashes containing the structure with arrays holding filenames.
597 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
603 opendir my $dh, $dir or die $!;
604 my $tree = {}->{$dir} = {};
605 while( my $file = readdir($dh) ) {
606 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
607 my $path = $dir .'/' . $file;
608 $tree->{$file} = hashdir($path), next if -d $path;
609 push @{$tree->{'.'}}, $file;
616 This function combines the target_map and file hash to
617 map each source file to its destination relative to
618 the set of installation targets.
620 Output will be a hash mapping from each source file
621 to its destination value, like this:
623 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
628 my $target_map = shift;
630 my $file_map = shift;
631 my $curr_path = @_ ? shift : ['.'];
633 # Traverse the directory tree.
634 # For each file or directory, identify the
635 # most specific match in the target_map
636 foreach my $dir (sort keys %{ $dirtree }) {
638 # deal with files in directory
639 foreach my $file (sort @{ $dirtree->{$dir} }) {
640 my $targetdir = undef;
641 my $matchlevel = undef;
642 # first, see if there is a match on this specific
643 # file in the target map
644 my $filepath = join("/", @$curr_path, $file);
645 if (exists $target_map->{$filepath}) {
646 $targetdir = $target_map->{$filepath};
647 $matchlevel = scalar(@$curr_path) + 1;
649 # no match on the specific file; look for
651 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
652 my $dirpath = join("/", @$curr_path[0..$i]);
653 if (exists $target_map->{$dirpath}) {
654 $targetdir = $target_map->{$dirpath};
655 $matchlevel = $i + 1;
660 if (defined $targetdir) {
661 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
663 my $path = join("/", @$curr_path);
664 print "failed to map: $path/$file\n" if $DEBUG;
668 # dealing with subdirectory
669 push @$curr_path, $dir;
670 get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
676 sub _add_to_file_map {
677 my $file_map = shift;
678 my $targetdir = shift;
679 my $curr_path = shift;
681 my $matchlevel = shift;
682 my $dest_path = @_ ? shift : $curr_path;
684 # The target can be one of the following:
685 # 1. scalar representing target symbol
686 # 2. hash ref containing target and trimdir keys
688 # Consequently, this routine traverses this structure,
689 # calling itself recursively, until it deals with
690 # all of the scalar target symbols.
691 if (ref $targetdir eq 'HASH') {
692 my $subtarget = $targetdir->{target};
693 if (exists $targetdir->{trimdir}) {
694 # if we get here, we've specified that
695 # rather than installing the file to
696 # $(TARGET)/matching/dirs/subdirs/file,
697 # we want to install it to
698 # $(TARGET)/subdirs/file
700 # Note that this the only place where
701 # $matchlevel is used.
702 my @new_dest_path = @$dest_path;
703 if ($targetdir->{trimdir} == -1) {
704 splice @new_dest_path, 0, $matchlevel;
706 splice @new_dest_path, 0, $targetdir->{trimdir};
708 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
710 # actually getting here means that the
711 # target was unnecessarily listed
712 # as a hash, but we'll forgive that
713 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
715 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
716 my $source = File::Spec->catfile(@$curr_path, $file);
717 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
718 #print "$source => $destination\n"; # DEBUG
719 # quote spaces in file names
720 # FIXME: this is of questionable portability and
721 # probably depends on user's make recognizing this
722 # quoting syntax -- probably better to remove
723 # spaces and shell metacharacters from all file names
724 $source =~ s/ /\\ /g;
725 $destination =~ s/ /\\ /g;
727 $file_map->{$source} = $destination;
731 =head2 get_install_log_values
733 Reads value from the Koha install log specified by
738 sub get_install_log_values {
739 my $install_log = shift;
742 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
745 next if /^#/ or /^\s*$/;
749 my ($key, $value) = split /=/, $_, 2;
750 $values->{$key} = $value;
754 print <<_EXPLAIN_INSTALL_LOG_;
755 Reading values from install log $install_log. You
756 will be prompted only for settings that have been
757 added since the last time you installed Koha. To
758 be prompted for all settings, run 'perl Makefile.PL'
759 without the --prev-install-log option.
760 _EXPLAIN_INSTALL_LOG_
763 =head2 get_configuration
765 This prompts the user for various configuration options.
769 sub get_configuration {
770 my $defaults = shift;
771 my $valid_values = shift;
772 my $install_log_values = shift;
776 By default, Koha can be installed in one of three ways:
778 standard: Install files in conformance with the Filesystem
779 Hierarchy Standard (FHS). This is the default mode
780 and should be used when installing a production
781 Koha system. On Unix systems, root access is
782 needed to complete a standard installation.
784 single: Install files under a single directory. This option
785 is useful for installing Koha without root access, e.g.,
786 on a web host that allows CGI scripts and MySQL databases
787 but requires the user to keep all files under the user's
790 dev: Create a set of symbolic links and configuration files to
791 allow Koha to run directly from the source distribution.
792 This mode is useful for developers who want to run
793 Koha from a git clone.
796 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
797 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
799 # set message and default value for INSTALL_BASE
800 # depending on value of INSTALL_MODE
801 my $install_base_default = $defaults->{'INSTALL_BASE'};
802 if ($config{'INSTALL_MODE'} eq 'dev') {
804 Please specify the directory in which to install Koha's
805 active configuration files and (if applicable) the
806 Zebra database. Koha's CGI scripts and templates will
807 be run from the current directory.
809 Configuration directory:);
810 # FIXME - home directory portability consideration apply
811 $install_base_default =
813 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
815 } elsif ($config{'INSTALL_MODE'} eq 'single') {
816 $msg = "\nPlease specify the directory in which to install Koha";
817 # FIXME -- we're assuming under a 'single' mode install
818 # that user will likely want to install under the home
819 # directory. This is OK in and of itself, but we should
820 # use File::HomeDir to locate the home directory portably.
821 # This is deferred for now because File::HomeDir is not yet
823 # --we must also keep this portable to the major OS's -fbcit
824 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
828 Please specify the directory under which most Koha files
831 Note that if you are planning in installing more than
832 one instance of Koha, you may want to modify the last
833 component of the directory path, which will be used
834 as the package name in the FHS layout.
836 Base installation directory);
838 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
840 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
841 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
842 if ($config{'INSTALL_MODE'} eq "standard") {
844 Since you are using the 'standard' install
845 mode, you should run 'make install' as root.
846 However, it is recommended that a non-root
847 user (on Unix and Linux platforms) have
848 ownership of Koha's files, including the
849 Zebra indexes if applicable.
851 Please specify a user account. This
852 user account does not need to exist
853 right now, but it needs to exist
854 before you run 'make install'. Please
855 note that for security reasons, this
856 user should not be the same as the user
857 account Apache runs under.
860 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
863 Please specify the group that should own
864 Koha's files. As above, this group need
865 not exist right now, but should be created
866 before you run 'make install'.
869 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
873 Please specify which database engine you will use
874 to store data in Koha. The choices are MySQL and
875 PostgreSQL; please note that at the moment
876 PostgreSQL support is highly experimental.
879 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
880 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
883 Please specify the name or address of your
884 database server. Note that the database
885 does not have to exist at this point, it
886 can be created after running 'make install'
887 and before you try using Koha for the first time.
890 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
893 Please specify the port used to connect to the
895 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
896 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
899 Please specify the name of the database to be
901 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
904 Please specify the user that owns the database to be
906 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
909 Please specify the password of the user that owns the
910 database to be used by Koha);
911 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
914 Koha uses the Zebra search engine for high-performance
915 searching of bibliographic and authority records. Checking
916 to see if you have installed the Zebra software...
919 if (defined(my $zebra_path = find_zebra())) {
920 $config{'PATH_TO_ZEBRA'} = $zebra_path;
922 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
926 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
927 in your PATH or in some of the usual places. If you haven't
928 installed Zebra yet, please do so and run Makefile.PL again.
934 You must specify the primary MARC format of the
935 records to be indexed by Zebra.
937 Koha provides Zebra configuration files for MARC21,
940 MARC format for Zebra indexing);
941 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
942 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
944 Koha supplies Zebra configuration files tuned for
945 searching either English (en) or French (fr) MARC
948 Primary language for Zebra indexing);
949 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
950 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
953 Koha can use one of two different indexing modes
954 for the MARC bibliographic records:
956 dom - uses the DOM XML filter; offers improved
958 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
959 available for legacy support
961 Bibliographic indexing mode);
962 $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
963 $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
967 Koha can use one of two different indexing modes
968 for the MARC authorities records:
970 dom - uses the DOM XML filter; offers improved
972 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
973 available for legacy support
975 Authorities indexing mode);
976 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
977 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
980 Zebra has two methods to perform records tokenization
981 and characters normalization: CHR and ICU. ICU is
982 recommended for catalogs containing non-Latin
985 $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
986 $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
989 Please specify Zebra database user);
990 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
993 Please specify the Zebra database password);
994 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
997 Since you've chosen to use Zebra, you can enable the SRU/
998 Z39.50 Server if you so choose, but you must specify a
999 few configuration options for it.
1001 Please note that if you choose *NOT* to configure SRU,
1002 koha-conf.xml will still contain some references to SRU
1003 settings. Those references will be ignored by Koha.
1005 Install the SRU configuration files?);
1006 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1007 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1009 if ($config{'INSTALL_SRU'} eq 'yes') {
1011 Since you've chosen to configure SRU, you must
1012 specify the host and port(s) that the SRU
1013 Servers (bibliographic and authority) should run on.
1016 SRU Database host?);
1017 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1020 SRU port for bibliographic data?);
1021 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1024 SRU port for authority data?);
1025 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1030 Along with Zebra, you can also choose to install PazPar2,
1031 which is a metasearch tool. With PazPar2,
1032 Koha can perform on-the-fly merging of bibliographic
1033 records during searching, allowing for FRBRization of
1036 Install the PazPar2 configuration files?);
1037 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1038 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1040 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1042 Since you've chosen to configure PazPar2, you must
1043 specify the host and port(s) that PazPar2
1047 Zebra bibliographic server host?);
1048 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1051 Zebra bibliographic port for PazPar2 to use?);
1052 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1056 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1060 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1065 Use memcached and memoize to cache the results of some function calls?
1066 This provides a signficant performance improvement.
1067 You will need a Memcached server running.);
1068 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1069 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1070 if ($config{'USE_MEMCACHED'} eq 'yes'){
1072 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1075 Memcached server address?);
1076 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1079 Memcached namespace?);
1080 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1086 Would you like to run the database-dependent test suite?);
1087 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1088 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1090 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1091 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1092 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1093 $msg = q(TEST DATABASE
1095 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1096 testing. Please don't do this on your production database. It is not
1099 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1100 database. You are better off not running this optional test suite than
1101 doing it in a database that you don't want to lose.
1103 Please specify the name of the test database to be
1106 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1107 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1108 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1109 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1113 Please specify the user that owns the database to be
1115 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1118 Please specify the password of the user that owns the
1119 database to be used by Koha);
1120 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1125 # add version number
1126 my $version = "no_version_found";
1128 require 'kohaversion.pl';
1129 $version = kohaversion();
1131 $config{'KOHA_INSTALLED_VERSION'} = $version;
1136 sub _add_valid_values_disp {
1138 my $valid_values = shift;
1141 if (exists $valid_values->{$key}) {
1142 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1150 my $default = shift;
1151 my $valid_values = shift;
1152 my $install_log_values = shift;
1154 # take value from install log if present
1155 if (exists $install_log_values{$key}) {
1156 $install_log_values{$key} =~ s/\$/\$\$/g;
1157 return $install_log_values{$key};
1160 # override default value from environment
1161 if (exists $ENV{$key}) {
1162 $default = $ENV{$key};
1163 $msg .= " (default from environment)";
1166 my $val = prompt($msg, $default);
1168 while (exists $valid_values->{$key} and
1169 $val ne $default and
1170 not exists $valid_values->{$key}->{$val}) {
1171 my $retry_msg = "Value '$val' is not a valid option.\n";
1172 $retry_msg .= "Please enter a value";
1173 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1174 $val = prompt($retry_msg, $default);
1176 $val =~ s/\$/\$\$/g;
1180 =head2 get_target_directories
1182 Creates a hash mapping from symbols for installation target
1183 directories to actual directory paths.
1185 Also returns a hash indicating targets for which
1186 files need not be copied -- this is used for the 'dev'
1187 mode installation, where some files are installed in place.
1191 sub get_target_directories {
1194 my $base = $config->{'INSTALL_BASE'};
1195 my $mode = $config->{'INSTALL_MODE'};
1197 # get last component of install base directory
1198 # to treat as package name
1199 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1201 my @basedir = File::Spec->splitdir($directories);
1203 if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1205 my $package = pop @basedir;
1210 if ($mode eq 'single') {
1211 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1212 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1213 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1214 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1215 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1216 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1217 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1218 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1219 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1220 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1221 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1222 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1223 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1224 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1225 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1226 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1227 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1228 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
1229 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1230 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1231 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1232 } elsif ($mode eq 'dev') {
1233 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1234 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1235 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1236 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1237 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1238 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1239 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1240 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1241 $skipdirs{'OPAC_CGI_DIR'} = 1;
1242 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1243 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1244 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1245 $skipdirs{'OPAC_WWW_DIR'} = 1;
1246 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1247 $skipdirs{'PERL_MODULE_DIR'} = 1;
1248 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1249 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1250 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1251 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1252 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1253 #For dev install, point NONDEV_DIR to misc in current dir (not base)
1254 #Used by supportdir in koha-conf.xml (BZ 12031)
1255 $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1256 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1257 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1258 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1259 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1260 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1261 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
1262 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1263 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1264 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1266 # mode is standard, i.e., 'fhs'
1267 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1268 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1269 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1270 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1271 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1272 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1273 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1274 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1275 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1276 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1277 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1278 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1279 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1280 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1281 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1282 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1283 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1284 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1285 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1286 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1287 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1290 _get_env_overrides(\%dirmap);
1291 _get_argv_overrides(\%dirmap);
1292 _add_destdir(\%dirmap);
1294 return \%dirmap, \%skipdirs;
1299 Map a directory target to the corresponding path for
1307 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1308 if (exists $test_suite_override_dirs{$dirname}) {
1309 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1316 sub _get_env_overrides {
1319 foreach my $key (keys %$dirmap) {
1320 if (exists $ENV{$key}) {
1321 $dirmap->{$key} = $ENV{$key};
1322 print "Setting $key from environment\n";
1327 sub _get_argv_overrides {
1331 for (my $i = 0; $i <= $#ARGV; $i++) {
1332 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1335 push @new_argv, $ARGV[$i];
1341 sub _strip_destdir {
1343 $dir =~ s/^\$\(DESTDIR\)//;
1350 foreach my $key (keys %$dirmap) {
1351 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1355 sub display_configuration {
1358 my @version = grep /\/usr\/share\/perl\//, @INC;
1359 push @version, ('/usr/share/perl/5.10') if !$version[0];
1360 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1361 foreach my $key (sort keys %$config) {
1362 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1365 print "\nand in the following directories:\n\n";
1366 foreach my $key (sort keys %$dirmap) {
1367 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1369 print "\n\nTo change any configuration setting, please run\n";
1370 print "perl Makefile.PL again. To override one of the target\n";
1371 print "directories, you can do so on the command line like this:\n";
1372 print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1373 print "You can also set different default values for parameters\n";
1374 print "or override directory locations by using environment variables.\n";
1375 print "\nFor example:\n\n";
1376 print "export DB_USER=my_koha\n";
1377 print "perl Makefile.PL\n";
1379 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1384 Attempt to find Zebra - check user's PATH and
1385 a few other directories for zebrasrv and zebraidx.
1390 my @search_dirs = map {
1391 my $abs = File::Spec->rel2abs($_);
1392 my ($toss, $directories);
1393 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1395 } split /:/, $ENV{PATH};
1396 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1397 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1398 return unless @zebrasrv_dirs;
1399 # verify that directory that contains zebrasrv also contains zebraidx
1400 foreach my $dir (@zebrasrv_dirs) {
1401 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1410 my $test = $self->SUPER::test(@_);
1411 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1414 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1421 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1422 # This means that we're completely overriding EU::MM's default
1423 # installation and uninstallation targets.
1425 # If installation is on Win32, we need to do permissions different from *nix
1426 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1427 foreach my $key (sort keys %$target_directories) {
1429 KOHA_INST_$key = blib/$key
1430 KOHA_DEST_$key = $target_directories->{$key}
1431 ) unless exists $skip_directories->{$key};
1434 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1435 \t\$(NOECHO) \$(NOOP)
1437 $install .= "install_koha ::\n";
1438 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1439 foreach my $key (sort keys %$target_directories) {
1440 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1441 unless exists $skip_directories->{$key};
1443 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1444 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1447 $install .= "set_koha_ownership ::\n";
1448 # Do not try to change ownership if DESTDIR is set
1449 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1450 foreach my $key (sort keys %$target_directories) {
1451 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1452 unless exists $skip_directories->{$key};
1455 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1459 $install .= "set_koha_permissions ::\n";
1460 # This is necessary because EU::MM installs files
1461 # as either 0444 or 0555, and we want the owner
1462 # of Koha's files to have write permission by default.
1463 foreach my $key (sort keys %$target_directories) {
1464 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1465 unless exists $skip_directories->{$key};
1471 $install .= "warn_koha_env_vars ::\n";
1472 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1473 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1474 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1475 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1476 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1477 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1478 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1479 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1480 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1481 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1482 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1484 $install .= _update_zebra_conf_target();
1486 $install .= upgrade();
1491 =head2 _update_zebra_conf_target
1493 Add an installation target for updating
1494 Zebra's configuration files.
1498 sub _update_zebra_conf_target {
1500 my $target = "\nupdate_zebra_conf ::\n";
1501 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1502 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1503 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1504 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1505 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1506 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1515 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1516 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1517 $version =~ s/\./_/g;
1518 $backup_suffix = "_koha_$version";
1520 $backup_suffix = "_upgrade_backup";
1524 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1526 upgrade :: make_upgrade_backup install
1527 \t\$(NOECHO) \$(NOOP)
1528 make_upgrade_backup ::
1529 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1531 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1532 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1533 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1534 unless exists $skip_directories->{$key} or
1535 not exists $target_directories->{$key};
1537 $upgrade =~ s/\\\n$/\n/;
1542 # put directory mappings into Makefile
1543 # so that Make will export as environment
1544 # variables -- this is for the use of
1548 # Hereagain, we must alter syntax per platform...
1550 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1552 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1564 ExtUtils::MakeMaker(3)
1568 MJ Ray mjr at phonecoop.coop
1569 Galen Charlton galen.charlton at liblime.com
1573 FIXME: deal with .htaccess