1 # Copyright 2007 MJ Ray
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along with
15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
16 # Suite 330, Boston, MA 02111-1307 USA
18 # Current maintainer MJR http://mjr.towers.org.uk/
19 # See http://www.koha.org/wiki/?page=KohaInstaller
24 use ExtUtils::MakeMaker;
30 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
32 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
34 my $dirtree = hashdir('.');
39 Makefile.PL - Koha packager and installer
43 =head2 BASIC INSTALLATION
50 =head2 UPGRADE INSTALLATION
52 NOTE: This option is only available if koha-install-log exists.
54 perl Makefile.PL --prev-install-log /path/to/koha-install-log
60 =head2 PACKAGING RELEASE TARBALLS
71 This is a packager and installer that uses
72 ExtUtils::MakeMaker, which is fairly common
74 As well as building tar or zip files
75 and installing with the above commands,
76 it allows us to check pre-requisites
77 and generate configuration files.
81 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
83 Basic metadata about this software.
87 Suppress generation of META.yml file.
91 Hash of perl modules and versions required.
99 This is a hash of PL scripts to run after installation and
100 the files to ask them to generate.
101 Maybe use the values from CONFIGURE
102 to generate initial configuration files in future.
108 This is a hash mapping directories and files in the
109 source tree to installation target directories. The rules
110 for this mapping are:
114 =item If a directory or file is specified, it and its
115 contents will be copied to the installation target directory.
117 =item If a subdirectory of a mapped directory is specified,
118 its target overrides the parent's target for that subdirectory.
120 =item The value of each map entry may either be a scalar containing
121 one target or a reference to a hash containing 'target' and 'trimdir'
124 =item Any files at the top level of the source tree that are
125 not included in the map will not be installed.
127 =item Any directories at the top level of the source tree
128 that are not included in the map will be installed in
129 INTRANET_CGI_DIR. This is a sensible default given the
130 current organization of the source tree, but (FIXME) it
131 would be better to reorganize the source tree to better
132 match the installation system, to allow adding new directories
133 without having to adjust Makefile.PL each time. The idea
134 is to make the C<$target_map> hash as minimal as possible.
138 The permitted installation targets are:
142 =item INTRANET_CGI_DIR
144 CGI scripts for intranet (staff) interface.
146 =item INTRANET_TMPL_DIR
148 HTML templates for the intranet interface.
150 =item INTRANET_WWW_DIR
152 HTML files, images, etc. for DocumentRoot for the intranet interface.
156 CGI scripts for OPAC (public) interface.
160 HTML templates for the OPAC interface.
164 HTML files, images, etc. for DocumentRoot for the OPAC interface.
166 =item PERL_MODULE_DIR
168 Perl modules (at present just the C4 modules) that are intimately
169 tied to Koha. Depending on the installation options, these
170 may or may not be installed one of the standard directories
171 in Perl's default @LIB.
175 Directory for Koha configuration files.
179 Directory for Zebra configuration files.
183 Directory for Zebra's lock files.
187 Directory for Zebra's data files.
191 Directory for Zebra's UNIX-domain sockets.
195 Directory for for miscellaenous scripts, among other
196 things the translation toolkit and RSS feed tools.
200 Directory for command-line scripts and daemons to
201 be set up all for installation modes.
203 =item SCRIPT_NONDEV_DIR
205 Directory for command-line scripts that should
206 be installed in the same directory as the
207 SCRIPT_DIR target except 'dev' installs.
211 Directory for man pages created from POD -- will mostly
212 contain information of interest to Koha developers.
216 Directory for Koha documentation accessed from the
217 command-line, e.g., READMEs.
221 Directory for Apache and Zebra logs produced by Koha.
223 =item PAZPAR2_CONF_DIR
225 Directory for PazPar2 configuration files.
229 This is a dummy target used to explicitly state
230 that a given file or directory is not to be installed.
231 This is used either for parts of the installer itself
232 or for development tools that are not applicable to a
233 production installation.
240 './about.pl' => 'INTRANET_CGI_DIR',
241 './acqui' => 'INTRANET_CGI_DIR',
242 './admin' => 'INTRANET_CGI_DIR',
243 './authorities' => 'INTRANET_CGI_DIR',
244 './C4' => 'PERL_MODULE_DIR',
245 './C4/SIP/t' => 'NONE',
246 './C4/SIP/koha_test' => 'NONE',
247 './C4/tests' => 'NONE',
248 './catalogue' => 'INTRANET_CGI_DIR',
249 './cataloguing' => 'INTRANET_CGI_DIR',
250 './changelanguage.pl' => 'INTRANET_CGI_DIR',
251 './check_sysprefs.pl' => 'NONE',
252 './circ' => 'INTRANET_CGI_DIR',
253 './edithelp.pl' => 'INTRANET_CGI_DIR',
254 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
255 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
256 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
257 './help.pl' => 'INTRANET_CGI_DIR',
258 './installer-CPAN.pl' => 'NONE',
259 './installer' => 'INTRANET_CGI_DIR',
260 './errors' => {target => 'INTRANET_CGI_DIR'},
261 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
262 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
263 './kohaversion.pl' => 'INTRANET_CGI_DIR',
264 './labels' => 'INTRANET_CGI_DIR',
265 './mainpage.pl' => 'INTRANET_CGI_DIR',
266 './Makefile.PL' => 'NONE',
267 './MANIFEST.SKIP' => 'NONE',
268 './members' => 'INTRANET_CGI_DIR',
269 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
270 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
271 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
272 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
273 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
274 './misc/installer_devel_notes' => 'NONE',
275 './opac' => 'OPAC_CGI_DIR',
276 './README.txt' => 'NONE',
277 './reports' => 'INTRANET_CGI_DIR',
278 './reserve' => 'INTRANET_CGI_DIR',
279 './reviews' => 'INTRANET_CGI_DIR',
280 './rewrite-config.PL' => 'NONE',
281 './reviews' => 'INTRANET_CGI_DIR',
282 './serials' => 'INTRANET_CGI_DIR',
284 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
285 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
286 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
287 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
288 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
289 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
290 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
291 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
292 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
293 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
294 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
295 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
296 './sms' => 'INTRANET_CGI_DIR',
297 './suggestion' => 'INTRANET_CGI_DIR',
298 './svc' => 'INTRANET_CGI_DIR',
300 './tags' => 'INTRANET_CGI_DIR',
301 './tmp' => 'NONE', # FIXME need to determine whether
302 # Koha generates any persistent temp files
303 # that should go in /var/tmp/koha
304 './tools' => 'INTRANET_CGI_DIR',
305 './virtualshelves' => 'INTRANET_CGI_DIR',
306 # ignore files and directories created by the install itself
307 './pm_to_blib' => 'NONE',
311 =head1 CONFIGURATION OPTIONS
313 The following configuration options are used by the installer.
319 Specifies whether installation will be FHS-compliant (default,
320 assumes user has root), put everything under
321 a single directory (for users installing on a web host
322 that allows CGI scripts and a MySQL database but not root
323 access), or development (for a developer who wants to run
324 Koha from a git clone with no fuss).
328 Directory under which most components will go. Default
329 value will vary depending on INSTALL_MODE.
333 Type of DBMS (e.g., mysql or Pg).
341 Port that DBMS server is listening on.
345 Name of the DBMS database for Koha.
349 Name of DBMS user account for Koha's database.
353 Pasword of DMBS user account for Koha's database.
357 Whether to install Zebra configuration files and data
360 =item ZEBRA_MARC_FORMAT
362 Specifies format of MARC records to be indexed by Zebra.
366 Specifies primary language of records that will be
371 Internal Zebra user account for the index.
375 Internal Zebra user account's password.
379 System user account that will own Koha's files.
383 System group that will own Koha's files.
389 # default configuration options
390 my %config_defaults = (
391 'DB_TYPE' => 'mysql',
392 'DB_HOST' => 'localhost',
394 'DB_USER' => 'kohaadmin',
395 'DB_PASS' => 'katikoan',
396 'INSTALL_ZEBRA' => 'yes',
397 'INSTALL_SRU' => 'yes',
398 'INSTALL_PAZPAR2' => 'no',
399 'AUTH_INDEX_MODE' => 'grs1',
400 'ZEBRA_MARC_FORMAT' => 'marc21',
401 'ZEBRA_LANGUAGE' => 'en',
402 'ZEBRA_USER' => 'kohauser',
403 'ZEBRA_PASS' => 'zebrastripes',
404 'ZEBRA_SRU_HOST' => 'localhost',
405 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
406 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
407 'KOHA_USER' => 'koha',
408 'KOHA_GROUP' => 'koha',
409 'MERGE_SERVER_HOST' => 'localhost',
410 'MERGE_SERVER_PORT' => '11001',
411 'PAZPAR2_HOST' => 'localhost',
412 'PAZPAR2_PORT' => '11002',
413 'RUN_DATABASE_TESTS' => 'no',
414 'PATH_TO_ZEBRA' => '',
417 # set some default configuration options based on OS
418 # more conditions need to be added for other OS's
419 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
420 # to allow for more granular decisions based on which Win32 platform
422 warn "Your platform appears to be $^O.\n" if $DEBUG;
424 if ( $^O eq 'MSWin32' ) {
425 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
426 # this could be changed to put some files (ie. libraries) into system32, etc.
427 $config_defaults{'INSTALL_MODE'} = 'single';
428 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
430 elsif ( $^O eq 'cygwin' ) {
431 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
432 # this could be changed to put some files (ie. libraries) into system32, etc.
433 $config_defaults{'INSTALL_MODE'} = 'single';
434 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
437 $config_defaults{'INSTALL_MODE'} = 'standard';
438 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
441 # valid values for certain configuration options
442 my %valid_config_values = (
443 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
444 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
445 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
446 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
447 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
448 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
449 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
450 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
453 # get settings from command-line
454 my $koha_install_log = "";
455 Getopt::Long::Configure('pass_through');
456 my $results = GetOptions(
457 "prev-install-log=s" => \$koha_install_log
460 my %install_log_values = ();
461 if ($koha_install_log ne "") {
462 get_install_log_values($koha_install_log, \%install_log_values);
465 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
466 my ($target_directories, $skip_directories) = get_target_directories(\%config);
467 display_configuration(\%config, $target_directories);
469 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
472 'rewrite-config.PL' => [
473 'blib/KOHA_CONF_DIR/koha-conf.xml',
474 'blib/KOHA_CONF_DIR/koha-httpd.conf',
475 'blib/MISC_DIR/koha-install-log'
477 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
482 if ($config{'INSTALL_ZEBRA'} eq "yes") {
483 push @{ $pl_files->{'rewrite-config.PL'} }, (
484 'blib/ZEBRA_CONF_DIR/etc/passwd',
485 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
486 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
487 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
488 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
489 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
490 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
491 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
493 push @{ $pl_files->{'rewrite-config.PL'} }, (
494 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
495 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
496 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
498 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
499 push @{ $pl_files->{'rewrite-config.PL'} }, (
500 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
501 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
504 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
505 $config{'AUTH_RETRIEVAL_CFG'} =
506 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
509 if ($config{'INSTALL_MODE'} ne "dev") {
510 push @{ $pl_files->{'rewrite-config.PL'} }, (
511 'blib/PERL_MODULE_DIR/C4/Context.pm',
512 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
516 my %test_suite_override_dirs = (
517 KOHA_CONF_DIR => ['etc'],
518 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
519 LOG_DIR => ['var', 'log'],
520 SCRIPT_DIR => ['bin'],
521 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
522 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
523 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
528 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
529 VERSION_FROM => 'kohaversion.pl',
530 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
531 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
534 'Algorithm::CheckDigits' => 0.50,
535 'Biblio::EndnoteStyle' => 0.05,
538 'CGI::Session' => 4.20,
539 'CGI::Session::Serialize::yaml' => 4.20,
540 'Class::Factory::Util' => 1.6,
541 'Class::Accessor' => 0.30,
542 'DBD::mysql' => 4.004,
543 'DBD::SQLite' => 1.13, # optional, used for offline circulation
545 'Data::Dumper' => 2.121,
546 'Data::ICal' => 0.13,
548 'Date::ICal' => 1.72,
549 'Date::Manip' => 5.44,
550 'Digest::MD5' => 2.36,
551 'Email::Date' => 1.103,
552 'File::Temp' => 0.16,
553 'GD' => 2.39, #optional
554 'GD::Barcode::UPCE' => 1.1,
555 'Getopt::Long' => 2.35,
556 'Getopt::Std' => 1.05,
557 'HTML::Template::Pro' => 0.69,
558 'HTML::Scrubber' => 0.08,
559 'HTTP::Cookies' => 1.39,
560 'HTTP::Request::Common' => 1.26,
561 'JSON' => 2.07, # Needed by admin/item_circulation_alerts.pl
562 'LWP::Simple' => 1.41,
563 'LWP::UserAgent' => 2.033,
564 'Lingua::Stem' => 0.82,
565 'List::Util' => 1.18,
566 'List::MoreUtils' => 0.21,
567 'Locale::Language' => 2.07,
568 'MARC::Charset' => 0.98,
569 'MARC::Crosswalk::DublinCore' => 0.02,
570 'MARC::File::XML' => 0.88,
571 'MARC::Record' => 2.00,
572 'MIME::Base64' => 3.07,
573 'MIME::Lite' => 3.00,
574 'MIME::QuotedPrint' => 3.07,
575 'Mail::Sendmail' => 0.79,
576 'Net::LDAP' => 0.33, # optional
577 'Net::LDAP::Filter' => 0.14, # optional
578 'Net::Z3950::ZOOM' => 1.16,
579 'PDF::API2' => 2.000,
580 'PDF::API2::Page' => 2.000,
581 'PDF::API2::Util' => 2.000,
582 'PDF::Reuse' => 0.33,
583 'PDF::Reuse::Barcode' => 0.05,
586 'Schedule::At' => 1.06,
587 'SMS::Send' => 0.05, # optional
588 'Term::ANSIColor' => 1.10,
590 'Test::Harness' => 2.56,
591 'Test::More' => 0.62,
593 'Text::CSV_XS' => 0.32,
594 'Text::Iconv' => 1.7,
595 'Text::Wrap' => 2005.082401,
596 'Time::HiRes' => 1.86,
597 'Time::localtime' => 1.02,
598 'Unicode::Normalize' => 0.32,
599 'XML::Dumper' => 0.81,
600 'XML::LibXML' => 1.59,
601 'XML::LibXSLT' => 1.59,
602 'XML::SAX::ParserFactory' => 1.01,
603 'XML::Simple' => 2.14,
605 'YAML::Syck' => 0.71,
611 # Man pages generated from POD
612 # ExtUtils::MakeMaker already manage $(DESTDIR)
613 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
614 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
616 PL_FILES => $pl_files,
623 This function recurses through the directory structure and builds
624 a hash of hashes containing the structure with arrays holding filenames.
625 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
631 opendir my $dh, $dir or die $!;
632 my $tree = {}->{$dir} = {};
633 while( my $file = readdir($dh) ) {
634 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
635 my $path = $dir .'/' . $file;
636 $tree->{$file} = hashdir($path), next if -d $path;
637 push @{$tree->{'.'}}, $file;
644 This function combines the target_map and file hash to
645 map each source file to its destination relative to
646 the set of installation targets.
648 Output will be a hash mapping from each source file
649 to its destination value, like this:
651 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
656 my $target_map = shift;
658 my $file_map = shift;
659 my $install_zebra = shift;
660 my $curr_path = @_ ? shift : ['.'];
662 # Traverse the directory tree.
663 # For each file or directory, identify the
664 # most specific match in the target_map
665 foreach my $dir (sort keys %{ $dirtree }) {
667 # deal with files in directory
668 foreach my $file (sort @{ $dirtree->{$dir} }) {
669 my $targetdir = undef;
670 my $matchlevel = undef;
671 # first, see if there is a match on this specific
672 # file in the target map
673 my $filepath = join("/", @$curr_path, $file);
674 if (exists $target_map->{$filepath}) {
675 $targetdir = $target_map->{$filepath};
676 $matchlevel = scalar(@$curr_path) + 1;
678 # no match on the specific file; look for
680 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
681 my $dirpath = join("/", @$curr_path[0..$i]);
682 if (exists $target_map->{$dirpath}) {
683 $targetdir = $target_map->{$dirpath};
684 $matchlevel = $i + 1;
689 if (defined $targetdir) {
690 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
692 my $path = join("/", @$curr_path);
693 print "failed to map: $path/$file\n" if $DEBUG;
697 # dealing with subdirectory
698 push @$curr_path, $dir;
699 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
705 sub _add_to_file_map {
706 my $file_map = shift;
707 my $targetdir = shift;
708 my $curr_path = shift;
710 my $matchlevel = shift;
711 my $install_zebra = shift;
712 my $dest_path = @_ ? shift : $curr_path;
714 # The target can be one of the following:
715 # 1. scalar representing target symbol
716 # 2. hash ref containing target and trimdir keys
718 # Consequently, this routine traverses this structure,
719 # calling itself recursively, until it deals with
720 # all of the scalar target symbols.
721 if (ref $targetdir eq 'HASH') {
722 my $subtarget = $targetdir->{target};
723 if (exists $targetdir->{trimdir}) {
724 # if we get here, we've specified that
725 # rather than installing the file to
726 # $(TARGET)/matching/dirs/subdirs/file,
727 # we want to install it to
728 # $(TARGET)/subdirs/file
730 # Note that this the only place where
731 # $matchlevel is used.
732 my @new_dest_path = @$dest_path;
733 if ($targetdir->{trimdir} == -1) {
734 splice @new_dest_path, 0, $matchlevel;
736 splice @new_dest_path, 0, $targetdir->{trimdir};
738 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
740 # actually getting here means that the
741 # target was unnecessarily listed
742 # as a hash, but we'll forgive that
743 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
745 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
746 my $source = File::Spec->catfile(@$curr_path, $file);
747 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
748 #print "$source => $destination\n"; # DEBUG
749 # quote spaces in file names
750 # FIXME: this is of questionable portability and
751 # probably depends on user's make recognizing this
752 # quoting syntax -- probably better to remove
753 # spaces and shell metacharacters from all file names
754 $source =~ s/ /\\ /g;
755 $destination =~ s/ /\\ /g;
757 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
761 =head2 get_install_log_values
763 Reads value from the Koha install log specified by
768 sub get_install_log_values {
769 my $install_log = shift;
772 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
775 next if /^#/ or /^\s*$/;
779 my ($key, $value) = split /=/, $_, 2;
780 $values->{$key} = $value;
784 print <<_EXPLAIN_INSTALL_LOG_;
785 Reading values from install log $install_log. You
786 will be prompted only for settings that have been
787 added since the last time you installed Koha. To
788 be prompted for all settings, run 'perl Makefile.PL'
789 without the --prev-install-log option.
790 _EXPLAIN_INSTALL_LOG_
793 =head2 get_configuration
795 This prompts the user for various configuration options.
799 sub get_configuration {
800 my $defaults = shift;
801 my $valid_values = shift;
802 my $install_log_values = shift;
806 By default, Koha can be installed in one of three ways:
808 standard: Install files in conformance with the Filesystem
809 Hierarchy Standard (FHS). This is the default mode
810 and should be used when installing a production
811 Koha system. On Unix systems, root access is
812 needed to complete a standard installation.
814 single: Install files under a single directory. This option
815 is useful for installing Koha without root access, e.g.,
816 on a web host that allows CGI scripts and MySQL databases
817 but requires the user to keep all files under the user's
820 dev: Create a set of symbolic links and configuration files to
821 allow Koha to run directly from the source distribution.
822 This mode is useful for developers who want to run
823 Koha from a git clone.
826 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
827 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
829 # set message and default value for INSTALL_BASE
830 # depending on value of INSTALL_MODE
831 my $install_base_default = $defaults->{'INSTALL_BASE'};
832 if ($config{'INSTALL_MODE'} eq 'dev') {
834 Please specify the directory in which to install Koha's
835 active configuration files and (if applicable) the
836 Zebra database. Koha's CGI scripts and templates will
837 be run from the current directory.
839 Configuration directory:);
840 # FIXME - home directory portability consideration apply
841 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
842 } elsif ($config{'INSTALL_MODE'} eq 'single') {
843 $msg = "\nPlease specify the directory in which to install Koha";
844 # FIXME -- we're assuming under a 'single' mode install
845 # that user will likely want to install under the home
846 # directory. This is OK in and of itself, but we should
847 # use File::HomeDir to locate the home directory portably.
848 # This is deferred for now because File::HomeDir is not yet
850 # --we must also keep this portable to the major OS's -fbcit
851 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
855 Please specify the directory under which most Koha files
858 Note that if you are planning in installing more than
859 one instance of Koha, you may want to modify the last
860 component of the directory path, which will be used
861 as the package name in the FHS layout.
863 Base installation directory);
865 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
867 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
868 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
869 if ($config{'INSTALL_MODE'} eq "standard") {
871 Since you are using the 'standard' install
872 mode, you should run 'make install' as root.
873 However, it is recommended that a non-root
874 user (on Unix and Linux platforms) have
875 ownership of Koha's files, including the
876 Zebra indexes if applicable.
878 Please specify a user account. This
879 user account does not need to exist
880 right now, but it needs to exist
881 before you run 'make install'. Please
882 note that for security reasons, this
883 user should not be the same as the user
884 account Apache runs under.
887 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
890 Please specify the group that should own
891 Koha's files. As above, this group need
892 not exist right now, but should be created
893 before you run 'make install'.
896 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
900 Please specify which database engine you will use
901 to store data in Koha. The choices are MySQL and
902 PostgreSQL; please note that at the moment
903 PostgreSQL support is highly experimental.
906 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
907 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
910 Please specify the name or address of your
911 database server. Note that the database
912 does not have to exist at this point, it
913 can be created after running 'make install'
914 and before you try using Koha for the first time.
917 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
920 Please specify the port used to connect to the
922 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
923 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
926 Please specify the name of the database to be
928 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
931 Please specify the user that owns the database to be
933 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
936 Please specify the password of the user that owns the
937 database to be used by Koha);
938 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
941 Koha can use the Zebra search engine for high-performance
942 searching of bibliographic and authority records. If you
943 have installed the Zebra software and would like to use it,
944 please answer 'yes' to the following question. Otherwise,
945 Koha will default to using its internal search engine.
947 Please note that if you choose *NOT* to install Zebra,
948 koha-conf.xml will still contain some references to Zebra
949 settings. Those references will be ignored by Koha.
951 Install the Zebra configuration files?);
952 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
953 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
955 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
957 if (defined(my $zebra_path = find_zebra())) {
958 $config{'PATH_TO_ZEBRA'} = $zebra_path;
960 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
964 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
965 in your PATH or in some of the usual places. If you haven't
966 installed Zebra yet, please do so and run Makefile.PL again.
972 Since you've chosen to use Zebra with Koha,
973 you must specify the primary MARC format of the
974 records to be indexed by Zebra.
976 Koha provides Zebra configuration files for MARC 21
979 MARC format for Zebra indexing);
980 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
981 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
983 Koha supplies Zebra configuration files tuned for
984 searching either English (en) or French (fr) MARC
987 Primary language for Zebra indexing);
988 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
989 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
992 Koha can use one of two different indexing modes
993 for the MARC authorities records:
995 grs1 - uses the Zebra GRS-1 filter, available
997 dom - uses the DOM XML filter; offers improved
1000 Authorities indexing mode);
1001 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1002 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1005 Please specify Zebra database user);
1006 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1009 Please specify the Zebra database password);
1010 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1013 Since you've chosen to use Zebra, you can enable the SRU/
1014 Z39.50 Server if you so choose, but you must specify a
1015 few configuration options for it.
1017 Please note that if you choose *NOT* to configure SRU,
1018 koha-conf.xml will still contain some references to SRU
1019 settings. Those references will be ignored by Koha.
1021 Install the SRU configuration files?);
1022 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1023 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1025 if ($config{'INSTALL_SRU'} eq 'yes') {
1027 Since you've chosen to configure SRU, you must
1028 specify the host and port(s) that the SRU
1029 Servers (bibliographic and authority) should run on.
1032 SRU Database host?);
1033 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1036 SRU port for bibliographic data?);
1037 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1040 SRU port for authority data?);
1041 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1046 Since you've chosen to use Zebra, you can also choose to
1047 install PazPar2, which is a metasearch tool. With PazPar2,
1048 Koha can perform on-the-fly merging of bibliographic
1049 records during searching, allowing for FRBRization of
1052 Install the PazPar2 configuration files?);
1053 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1054 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1056 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1058 Since you've chosen to configure PazPar2, you must
1059 specify the host and port(s) that PazPar2
1063 Zebra bibliographic server host?);
1064 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1067 Zebra bibliographic port for PazPar2 to use?);
1068 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1072 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1076 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1082 Would you like to run the database-dependent test suite?);
1083 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1084 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1086 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1087 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1088 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1089 $msg = q(TEST DATABASE
1091 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1092 testing. Please don't do this on your production database. It is not
1095 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1096 database. You are better off not running this optional test suite than
1097 doing it in a database that you don't want to lose.
1099 Please specify the name of the test database to be
1102 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1103 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1104 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1105 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1109 Please specify the user that owns the database to be
1111 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1114 Please specify the password of the user that owns the
1115 database to be used by Koha);
1116 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1121 # add version number
1122 my $version = "no_version_found";
1124 require 'kohaversion.pl';
1125 $version = kohaversion();
1127 $config{'KOHA_INSTALLED_VERSION'} = $version;
1132 sub _add_valid_values_disp {
1134 my $valid_values = shift;
1137 if (exists $valid_values->{$key}) {
1138 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1146 my $default = shift;
1147 my $valid_values = shift;
1148 my $install_log_values = shift;
1150 # take value from install log if present
1151 if (exists $install_log_values{$key}) {
1152 return $install_log_values{$key};
1155 # override default value from environment
1156 if (exists $ENV{$key}) {
1157 $default = $ENV{$key};
1158 $msg .= " (default from environment)";
1161 my $val = prompt($msg, $default);
1163 while (exists $valid_values->{$key} and
1164 $val ne $default and
1165 not exists $valid_values->{$key}->{$val}) {
1166 my $retry_msg = "Value '$val' is not a valid option.\n";
1167 $retry_msg .= "Please enter a value";
1168 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1169 $val = prompt($retry_msg, $default);
1174 =head2 get_target_directories
1176 Creates a hash mapping from symbols for installation target
1177 directories to actual directory paths.
1179 Also returns a hash indicating targets for which
1180 files need not be copied -- this is used for the 'dev'
1181 mode installation, where some files are installed in place.
1185 sub get_target_directories {
1188 my $base = $config->{'INSTALL_BASE'};
1189 my $mode = $config->{'INSTALL_MODE'};
1191 # get last component of install base directory
1192 # to treat as package name
1193 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1195 my @basedir = File::Spec->splitdir($directories);
1197 # for Win32 we need to prepend the volume to the directory path
1198 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1199 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1201 my $package = pop @basedir;
1206 if ($mode eq 'single') {
1207 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1208 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1209 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1210 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1211 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1212 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1213 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1214 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1215 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1216 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1217 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1218 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1219 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1220 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1221 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1222 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1223 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1224 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1225 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1226 } elsif ($mode eq 'dev') {
1227 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1228 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1229 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1230 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1231 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1232 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1233 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1234 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1235 $skipdirs{'OPAC_CGI_DIR'} = 1;
1236 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1237 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1238 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1239 $skipdirs{'OPAC_WWW_DIR'} = 1;
1240 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1241 $skipdirs{'PERL_MODULE_DIR'} = 1;
1242 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1243 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1244 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1245 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1246 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1247 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1248 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1249 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1250 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1251 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1252 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1253 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1254 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1256 # mode is standard, i.e., 'fhs'
1257 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1258 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1259 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1260 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1261 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1262 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1263 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1264 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1265 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1266 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1267 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1268 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1269 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1270 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1271 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1272 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1273 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1274 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1275 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1278 _get_env_overrides(\%dirmap);
1279 _get_argv_overrides(\%dirmap);
1280 _add_destdir(\%dirmap);
1282 return \%dirmap, \%skipdirs;
1287 Map a directory target to the corresponding path for
1295 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1296 if (exists $test_suite_override_dirs{$dirname}) {
1297 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1304 sub _get_env_overrides {
1307 foreach my $key (keys %$dirmap) {
1308 if (exists $ENV{$key}) {
1309 $dirmap->{$key} = $ENV{$key};
1310 print "Setting $key from environment\n";
1315 sub _get_argv_overrides {
1319 for (my $i = 0; $i <= $#ARGV; $i++) {
1320 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1323 push @new_argv, $ARGV[$i];
1329 sub _strip_destdir {
1331 $dir =~ s/^\$\(DESTDIR\)//;
1338 foreach my $key (keys %$dirmap) {
1339 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1343 sub display_configuration {
1346 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1347 foreach my $key (sort keys %$config) {
1348 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1351 print "\nand in the following directories:\n\n";
1352 foreach my $key (sort keys %$dirmap) {
1353 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1355 print "\n\nTo change any configuration setting, please run\n";
1356 print "perl Makefile.PL again. To override one of the target\n";
1357 print "directories, you can do so on the command line like this:\n";
1358 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1359 print "You can also set different default values for parameters\n";
1360 print "or override directory locations by using environment variables.\n";
1361 print "\nFor example:\n\n";
1362 print "export DB_USER=my_koha\n";
1363 print "perl Makefile.PL\n";
1365 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1366 print "If installing on a Win32 platform, be sure to use:\n";
1367 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1372 Attempt to find Zebra - check user's PATH and
1373 a few other directories for zebrasrv and zebraidx.
1375 FIXME: doesn't handle Win32
1380 my @search_dirs = map {
1381 my $abs = File::Spec->rel2abs($_);
1382 my ($toss, $directories);
1383 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1385 } split /:/, $ENV{PATH};
1386 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1387 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1388 return unless @zebrasrv_dirs;
1389 # verify that directory that contains zebrasrv also contains zebraidx
1390 foreach my $dir (@zebrasrv_dirs) {
1391 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1398 # This will have to be reworked in order to accommodate Win32...
1402 my $test = $self->SUPER::test(@_);
1403 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1406 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1413 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1414 # This means that we're completely overriding EU::MM's default
1415 # installation and uninstallation targets.
1417 # If installation is on Win32, we need to do permissions different from *nix
1418 if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1419 foreach my $key (sort keys %$target_directories) {
1421 KOHA_INST_$key = blib/$key
1422 KOHA_DEST_$key = $target_directories->{$key}
1423 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1426 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1427 \t\$(NOECHO) \$(NOOP)
1429 $install .= "install_koha ::\n";
1430 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1431 foreach my $key (sort keys %$target_directories) {
1432 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1433 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1435 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1436 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1439 $install .= "set_koha_ownership ::\n";
1440 # Do not try to change ownership if DESTDIR is set
1441 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1442 foreach my $key (sort keys %$target_directories) {
1443 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1444 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1447 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1451 $install .= "set_koha_permissions ::\n";
1452 # This is necessary because EU::MM installs files
1453 # as either 0444 or 0555, and we want the owner
1454 # of Koha's files to have write permission by default.
1455 foreach my $key (sort keys %$target_directories) {
1456 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1457 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1460 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1461 # We can attempt some creative things with command line utils such as CACLS which allows permission
1462 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1463 foreach my $key (sort keys %$target_directories) {
1465 KOHA_INST_$key = blib/$key
1466 KOHA_DEST_$key = $target_directories->{$key}
1467 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1470 install :: all install_koha warn_koha_env_vars
1471 \t\$(NOECHO) \$(NOOP)
1473 $install .= "install_koha ::\n";
1474 $install .= "\t\$(MOD_INSTALL) \\\n";
1475 foreach my $key (sort keys %$target_directories) {
1476 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1477 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1482 $install .= "warn_koha_env_vars ::\n";
1483 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1484 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1485 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1486 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1487 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1488 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1489 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1490 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1491 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1492 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1493 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1495 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1496 $install .= _update_zebra_conf_target();
1499 $install .= upgrade();
1504 =head2 _update_zebra_conf_target
1506 Add an installation target for updating
1507 Zebra's configuration files.
1511 sub _update_zebra_conf_target {
1513 my $target = "\nupdate_zebra_conf ::\n";
1514 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1515 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1516 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1517 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1518 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1519 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1528 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1529 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1530 $version =~ s/\./_/g;
1531 $backup_suffix = "_koha_$version";
1533 $backup_suffix = "_upgrade_backup";
1537 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1539 upgrade :: make_upgrade_backup install
1540 \t\$(NOECHO) \$(NOOP)
1541 make_upgrade_backup ::
1542 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1544 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1545 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1546 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1547 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1548 exists $skip_directories->{$key} or
1549 not exists $target_directories->{$key};
1551 $upgrade =~ s/\\\n$/\n/;
1557 # put directory mappings into Makefile
1558 # so that Make will export as environment
1559 # variables -- this is for the use of
1562 # quote '$' in the two password parameters
1563 my %config = %config;
1564 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1565 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1566 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1570 # Hereagain, we must alter syntax per platform...
1571 if ( $^O eq 'MSWin32' ) {
1572 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1573 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1575 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1578 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1580 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1583 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1584 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1585 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1586 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1587 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";
1589 # these directories will be relocated to the 't' directory
1590 foreach my $dirname ( keys %$target_directories ) {
1591 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1592 if ( exists $test_suite_override_dirs{$dirname} ) {
1593 $dir = main::get_test_dir($dirname);
1595 print $confhandle "$dirname = $dir\n"
1597 print $confhandle "\n";
1599 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1600 close( $confhandle );
1602 warn 'unable to open conf file for database dependent tests: $!';
1615 ExtUtils::MakeMaker(3)
1619 MJ Ray mjr at phonecoop.coop
1620 Galen Charlton galen.charlton at liblime.com
1623 FIXME: deal with .htaccess