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 './offline_circ' => 'INTRANET_CGI_DIR',
254 './edithelp.pl' => 'INTRANET_CGI_DIR',
255 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
256 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
257 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
258 './help.pl' => 'INTRANET_CGI_DIR',
259 './installer-CPAN.pl' => 'NONE',
260 './installer' => 'INTRANET_CGI_DIR',
261 './errors' => {target => 'INTRANET_CGI_DIR'},
262 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
263 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
264 './kohaversion.pl' => 'INTRANET_CGI_DIR',
265 './labels' => 'INTRANET_CGI_DIR',
266 './mainpage.pl' => 'INTRANET_CGI_DIR',
267 './Makefile.PL' => 'NONE',
268 './MANIFEST.SKIP' => 'NONE',
269 './members' => 'INTRANET_CGI_DIR',
270 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
271 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
272 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
273 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
274 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
275 './misc/installer_devel_notes' => 'NONE',
276 './opac' => 'OPAC_CGI_DIR',
277 './README.txt' => 'NONE',
278 './reports' => 'INTRANET_CGI_DIR',
279 './reserve' => 'INTRANET_CGI_DIR',
280 './reviews' => 'INTRANET_CGI_DIR',
281 './rewrite-config.PL' => 'NONE',
282 './reviews' => 'INTRANET_CGI_DIR',
283 './serials' => 'INTRANET_CGI_DIR',
285 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
286 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
287 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
288 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
289 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
290 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
291 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
292 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
293 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
294 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
295 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
296 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
297 './sms' => 'INTRANET_CGI_DIR',
298 './suggestion' => 'INTRANET_CGI_DIR',
299 './svc' => 'INTRANET_CGI_DIR',
301 './tags' => 'INTRANET_CGI_DIR',
302 './tmp' => 'NONE', # FIXME need to determine whether
303 # Koha generates any persistent temp files
304 # that should go in /var/tmp/koha
305 './tools' => 'INTRANET_CGI_DIR',
306 './virtualshelves' => 'INTRANET_CGI_DIR',
307 # ignore files and directories created by the install itself
308 './pm_to_blib' => 'NONE',
312 =head1 CONFIGURATION OPTIONS
314 The following configuration options are used by the installer.
320 Specifies whether installation will be FHS-compliant (default,
321 assumes user has root), put everything under
322 a single directory (for users installing on a web host
323 that allows CGI scripts and a MySQL database but not root
324 access), or development (for a developer who wants to run
325 Koha from a git clone with no fuss).
329 Directory under which most components will go. Default
330 value will vary depending on INSTALL_MODE.
334 Type of DBMS (e.g., mysql or Pg).
342 Port that DBMS server is listening on.
346 Name of the DBMS database for Koha.
350 Name of DBMS user account for Koha's database.
354 Pasword of DMBS user account for Koha's database.
358 Whether to install Zebra configuration files and data
361 =item ZEBRA_MARC_FORMAT
363 Specifies format of MARC records to be indexed by Zebra.
367 Specifies primary language of records that will be
372 Internal Zebra user account for the index.
376 Internal Zebra user account's password.
380 System user account that will own Koha's files.
384 System group that will own Koha's files.
390 # default configuration options
391 my %config_defaults = (
392 'DB_TYPE' => 'mysql',
393 'DB_HOST' => 'localhost',
395 'DB_USER' => 'kohaadmin',
396 'DB_PASS' => 'katikoan',
397 'INSTALL_ZEBRA' => 'yes',
398 'INSTALL_SRU' => 'yes',
399 'INSTALL_PAZPAR2' => 'no',
400 'AUTH_INDEX_MODE' => 'grs1',
401 'ZEBRA_MARC_FORMAT' => 'marc21',
402 'ZEBRA_LANGUAGE' => 'en',
403 'ZEBRA_USER' => 'kohauser',
404 'ZEBRA_PASS' => 'zebrastripes',
405 'ZEBRA_SRU_HOST' => 'localhost',
406 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
407 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
408 'KOHA_USER' => 'koha',
409 'KOHA_GROUP' => 'koha',
410 'MERGE_SERVER_HOST' => 'localhost',
411 'MERGE_SERVER_PORT' => '11001',
412 'PAZPAR2_HOST' => 'localhost',
413 'PAZPAR2_PORT' => '11002',
414 'RUN_DATABASE_TESTS' => 'no',
415 'PATH_TO_ZEBRA' => '',
416 'USE_MEMCACHED' => 'no',
417 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
418 'MEMCACHED_NAMESPACE' => 'KOHA'
421 # set some default configuration options based on OS
422 # more conditions need to be added for other OS's
423 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
424 # to allow for more granular decisions based on which Win32 platform
426 warn "Your platform appears to be $^O.\n" if $DEBUG;
428 if ( $^O eq 'MSWin32' ) {
429 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
430 # this could be changed to put some files (ie. libraries) into system32, etc.
431 $config_defaults{'INSTALL_MODE'} = 'single';
432 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
434 elsif ( $^O eq 'cygwin' ) {
435 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
436 # this could be changed to put some files (ie. libraries) into system32, etc.
437 $config_defaults{'INSTALL_MODE'} = 'single';
438 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
441 $config_defaults{'INSTALL_MODE'} = 'standard';
442 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
445 # valid values for certain configuration options
446 my %valid_config_values = (
447 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
448 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
449 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
450 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
451 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
452 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
453 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
454 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
455 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
458 # get settings from command-line
459 my $koha_install_log = "";
460 Getopt::Long::Configure('pass_through');
461 my $results = GetOptions(
462 "prev-install-log=s" => \$koha_install_log
465 my %install_log_values = ();
466 if ($koha_install_log ne "") {
467 get_install_log_values($koha_install_log, \%install_log_values);
470 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
471 my ($target_directories, $skip_directories) = get_target_directories(\%config);
472 display_configuration(\%config, $target_directories);
474 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
477 'rewrite-config.PL' => [
478 'blib/KOHA_CONF_DIR/koha-conf.xml',
479 'blib/KOHA_CONF_DIR/koha-httpd.conf',
480 'blib/MISC_DIR/koha-install-log'
482 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
487 if ($config{'INSTALL_ZEBRA'} eq "yes") {
488 push @{ $pl_files->{'rewrite-config.PL'} }, (
489 'blib/ZEBRA_CONF_DIR/etc/passwd',
490 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
491 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
492 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
493 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
494 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
495 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
496 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
498 push @{ $pl_files->{'rewrite-config.PL'} }, (
499 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
500 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
501 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
503 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
504 push @{ $pl_files->{'rewrite-config.PL'} }, (
505 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
506 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
509 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
510 $config{'AUTH_RETRIEVAL_CFG'} =
511 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
514 if ($config{'INSTALL_MODE'} ne "dev") {
515 push @{ $pl_files->{'rewrite-config.PL'} }, (
516 'blib/PERL_MODULE_DIR/C4/Context.pm',
517 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
521 my %test_suite_override_dirs = (
522 KOHA_CONF_DIR => ['etc'],
523 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
524 LOG_DIR => ['var', 'log'],
525 SCRIPT_DIR => ['bin'],
526 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
527 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
528 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
533 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
534 VERSION_FROM => 'kohaversion.pl',
535 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
536 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
539 'Algorithm::CheckDigits' => 0.50,
540 'Biblio::EndnoteStyle' => 0.05,
543 'CGI::Session' => 4.20,
544 'CGI::Session::Serialize::yaml' => 4.20,
545 'Class::Factory::Util' => 1.6,
546 'Class::Accessor' => 0.30,
547 'DBD::mysql' => 4.004,
548 'DBD::SQLite2' => 0.33, # optional, used for offline circulation
550 'Data::Dumper' => 2.121,
551 'Data::ICal' => 0.13,
553 'Date::ICal' => 1.72,
554 'Date::Manip' => 5.44,
555 'Digest::MD5' => 2.36,
556 'Digest::SHA' => 5.43,
557 'Email::Date' => 1.103,
558 'File::Temp' => 0.16,
559 'GD' => 2.39, #optional
560 'GD::Barcode::UPCE' => 1.1,
561 'Getopt::Long' => 2.35,
562 'Getopt::Std' => 1.05,
563 'HTML::Template::Pro' => 0.69,
564 'HTML::Scrubber' => 0.08,
565 'HTTP::Cookies' => 1.39,
567 'HTTP::Request::Common' => 1.26,
569 'JSON' => 2.07, # Needed by admin/item_circulation_alerts.pl
570 'LWP::Simple' => 1.41,
571 'LWP::UserAgent' => 2.033,
572 'Lingua::Stem' => 0.82,
573 'Lingua::Stem::Snowball' => 0.952,
574 'List::Util' => 1.18,
575 'List::MoreUtils' => 0.21,
576 'Locale::Language' => 2.07,
577 'MARC::Charset' => 0.98,
578 'MARC::Crosswalk::DublinCore' => 0.02,
579 'MARC::File::XML' => 0.88,
580 'MARC::Record' => 2.00,
581 'MIME::Base64' => 3.07,
582 'MIME::Lite' => 3.00,
583 'MIME::QuotedPrint' => 3.07,
584 'Mail::Sendmail' => 0.79,
585 'Memoize::Memcached' => 0.03, # optional
586 'Net::LDAP' => 0.33, # optional
587 'Net::LDAP::Filter' => 0.14, # optional
588 'Net::Z3950::ZOOM' => 1.16,
589 'Number::Format' => 1.52,
590 'PDF::API2' => 2.000,
591 'PDF::API2::Page' => 2.000,
592 'PDF::API2::Util' => 2.000,
593 'PDF::API2::Simple' => 1.000,
594 'PDF::Table' => 0.9.3,
595 'PDF::Reuse' => 0.33,
596 'PDF::Reuse::Barcode' => 0.05,
599 'Schedule::At' => 1.06,
601 'SMS::Send' => 0.05, # optional
602 'Term::ANSIColor' => 1.10,
604 'Test::Harness' => 2.56,
605 'Test::More' => 0.80,
607 'Text::CSV_XS' => 0.32,
608 'Text::Iconv' => 1.7,
609 'Text::Wrap' => 2005.082401,
610 'Time::HiRes' => 1.86,
611 'Time::localtime' => 1.02,
612 'Unicode::Normalize' => 0.32,
613 'URI::Escape' => 1.36,
614 'XML::Dumper' => 0.81,
615 'XML::LibXML' => 1.59,
616 'XML::LibXSLT' => 1.59,
617 'XML::SAX::ParserFactory' => 1.01,
618 'XML::SAX::Writer' => 0.44,
619 'XML::Simple' => 2.14,
621 'YAML::Syck' => 0.71,
627 # Man pages generated from POD
628 # ExtUtils::MakeMaker already manage $(DESTDIR)
629 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
630 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
632 PL_FILES => $pl_files,
639 This function recurses through the directory structure and builds
640 a hash of hashes containing the structure with arrays holding filenames.
641 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
647 opendir my $dh, $dir or die $!;
648 my $tree = {}->{$dir} = {};
649 while( my $file = readdir($dh) ) {
650 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
651 my $path = $dir .'/' . $file;
652 $tree->{$file} = hashdir($path), next if -d $path;
653 push @{$tree->{'.'}}, $file;
660 This function combines the target_map and file hash to
661 map each source file to its destination relative to
662 the set of installation targets.
664 Output will be a hash mapping from each source file
665 to its destination value, like this:
667 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
672 my $target_map = shift;
674 my $file_map = shift;
675 my $install_zebra = shift;
676 my $curr_path = @_ ? shift : ['.'];
678 # Traverse the directory tree.
679 # For each file or directory, identify the
680 # most specific match in the target_map
681 foreach my $dir (sort keys %{ $dirtree }) {
683 # deal with files in directory
684 foreach my $file (sort @{ $dirtree->{$dir} }) {
685 my $targetdir = undef;
686 my $matchlevel = undef;
687 # first, see if there is a match on this specific
688 # file in the target map
689 my $filepath = join("/", @$curr_path, $file);
690 if (exists $target_map->{$filepath}) {
691 $targetdir = $target_map->{$filepath};
692 $matchlevel = scalar(@$curr_path) + 1;
694 # no match on the specific file; look for
696 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
697 my $dirpath = join("/", @$curr_path[0..$i]);
698 if (exists $target_map->{$dirpath}) {
699 $targetdir = $target_map->{$dirpath};
700 $matchlevel = $i + 1;
705 if (defined $targetdir) {
706 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
708 my $path = join("/", @$curr_path);
709 print "failed to map: $path/$file\n" if $DEBUG;
713 # dealing with subdirectory
714 push @$curr_path, $dir;
715 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
721 sub _add_to_file_map {
722 my $file_map = shift;
723 my $targetdir = shift;
724 my $curr_path = shift;
726 my $matchlevel = shift;
727 my $install_zebra = shift;
728 my $dest_path = @_ ? shift : $curr_path;
730 # The target can be one of the following:
731 # 1. scalar representing target symbol
732 # 2. hash ref containing target and trimdir keys
734 # Consequently, this routine traverses this structure,
735 # calling itself recursively, until it deals with
736 # all of the scalar target symbols.
737 if (ref $targetdir eq 'HASH') {
738 my $subtarget = $targetdir->{target};
739 if (exists $targetdir->{trimdir}) {
740 # if we get here, we've specified that
741 # rather than installing the file to
742 # $(TARGET)/matching/dirs/subdirs/file,
743 # we want to install it to
744 # $(TARGET)/subdirs/file
746 # Note that this the only place where
747 # $matchlevel is used.
748 my @new_dest_path = @$dest_path;
749 if ($targetdir->{trimdir} == -1) {
750 splice @new_dest_path, 0, $matchlevel;
752 splice @new_dest_path, 0, $targetdir->{trimdir};
754 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
756 # actually getting here means that the
757 # target was unnecessarily listed
758 # as a hash, but we'll forgive that
759 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
761 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
762 my $source = File::Spec->catfile(@$curr_path, $file);
763 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
764 #print "$source => $destination\n"; # DEBUG
765 # quote spaces in file names
766 # FIXME: this is of questionable portability and
767 # probably depends on user's make recognizing this
768 # quoting syntax -- probably better to remove
769 # spaces and shell metacharacters from all file names
770 $source =~ s/ /\\ /g;
771 $destination =~ s/ /\\ /g;
773 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
777 =head2 get_install_log_values
779 Reads value from the Koha install log specified by
784 sub get_install_log_values {
785 my $install_log = shift;
788 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
791 next if /^#/ or /^\s*$/;
795 my ($key, $value) = split /=/, $_, 2;
796 $values->{$key} = $value;
800 print <<_EXPLAIN_INSTALL_LOG_;
801 Reading values from install log $install_log. You
802 will be prompted only for settings that have been
803 added since the last time you installed Koha. To
804 be prompted for all settings, run 'perl Makefile.PL'
805 without the --prev-install-log option.
806 _EXPLAIN_INSTALL_LOG_
809 =head2 get_configuration
811 This prompts the user for various configuration options.
815 sub get_configuration {
816 my $defaults = shift;
817 my $valid_values = shift;
818 my $install_log_values = shift;
822 By default, Koha can be installed in one of three ways:
824 standard: Install files in conformance with the Filesystem
825 Hierarchy Standard (FHS). This is the default mode
826 and should be used when installing a production
827 Koha system. On Unix systems, root access is
828 needed to complete a standard installation.
830 single: Install files under a single directory. This option
831 is useful for installing Koha without root access, e.g.,
832 on a web host that allows CGI scripts and MySQL databases
833 but requires the user to keep all files under the user's
836 dev: Create a set of symbolic links and configuration files to
837 allow Koha to run directly from the source distribution.
838 This mode is useful for developers who want to run
839 Koha from a git clone.
842 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
843 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
845 # set message and default value for INSTALL_BASE
846 # depending on value of INSTALL_MODE
847 my $install_base_default = $defaults->{'INSTALL_BASE'};
848 if ($config{'INSTALL_MODE'} eq 'dev') {
850 Please specify the directory in which to install Koha's
851 active configuration files and (if applicable) the
852 Zebra database. Koha's CGI scripts and templates will
853 be run from the current directory.
855 Configuration directory:);
856 # FIXME - home directory portability consideration apply
857 $install_base_default =
859 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
861 } elsif ($config{'INSTALL_MODE'} eq 'single') {
862 $msg = "\nPlease specify the directory in which to install Koha";
863 # FIXME -- we're assuming under a 'single' mode install
864 # that user will likely want to install under the home
865 # directory. This is OK in and of itself, but we should
866 # use File::HomeDir to locate the home directory portably.
867 # This is deferred for now because File::HomeDir is not yet
869 # --we must also keep this portable to the major OS's -fbcit
870 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
874 Please specify the directory under which most Koha files
877 Note that if you are planning in installing more than
878 one instance of Koha, you may want to modify the last
879 component of the directory path, which will be used
880 as the package name in the FHS layout.
882 Base installation directory);
884 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
886 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
887 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
888 if ($config{'INSTALL_MODE'} eq "standard") {
890 Since you are using the 'standard' install
891 mode, you should run 'make install' as root.
892 However, it is recommended that a non-root
893 user (on Unix and Linux platforms) have
894 ownership of Koha's files, including the
895 Zebra indexes if applicable.
897 Please specify a user account. This
898 user account does not need to exist
899 right now, but it needs to exist
900 before you run 'make install'. Please
901 note that for security reasons, this
902 user should not be the same as the user
903 account Apache runs under.
906 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
909 Please specify the group that should own
910 Koha's files. As above, this group need
911 not exist right now, but should be created
912 before you run 'make install'.
915 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
919 Please specify which database engine you will use
920 to store data in Koha. The choices are MySQL and
921 PostgreSQL; please note that at the moment
922 PostgreSQL support is highly experimental.
925 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
926 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
929 Please specify the name or address of your
930 database server. Note that the database
931 does not have to exist at this point, it
932 can be created after running 'make install'
933 and before you try using Koha for the first time.
936 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
939 Please specify the port used to connect to the
941 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
942 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
945 Please specify the name of the database to be
947 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
950 Please specify the user that owns the database to be
952 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
955 Please specify the password of the user that owns the
956 database to be used by Koha);
957 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
960 Koha can use the Zebra search engine for high-performance
961 searching of bibliographic and authority records. If you
962 have installed the Zebra software and would like to use it,
963 please answer 'yes' to the following question. Otherwise,
964 Koha will default to using its internal search engine.
966 Please note that if you choose *NOT* to install Zebra,
967 koha-conf.xml will still contain some references to Zebra
968 settings. Those references will be ignored by Koha.
970 Install the Zebra configuration files?);
971 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
972 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
974 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
976 if (defined(my $zebra_path = find_zebra())) {
977 $config{'PATH_TO_ZEBRA'} = $zebra_path;
979 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
983 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
984 in your PATH or in some of the usual places. If you haven't
985 installed Zebra yet, please do so and run Makefile.PL again.
991 Since you've chosen to use Zebra with Koha,
992 you must specify the primary MARC format of the
993 records to be indexed by Zebra.
995 Koha provides Zebra configuration files for MARC 21
998 MARC format for Zebra indexing);
999 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1000 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1002 Koha supplies Zebra configuration files tuned for
1003 searching either English (en) or French (fr) MARC
1006 Primary language for Zebra indexing);
1007 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1008 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1011 Koha can use one of two different indexing modes
1012 for the MARC authorities records:
1014 grs1 - uses the Zebra GRS-1 filter, available
1016 dom - uses the DOM XML filter; offers improved
1019 Authorities indexing mode);
1020 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1021 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1024 Please specify Zebra database user);
1025 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1028 Please specify the Zebra database password);
1029 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1032 Since you've chosen to use Zebra, you can enable the SRU/
1033 Z39.50 Server if you so choose, but you must specify a
1034 few configuration options for it.
1036 Please note that if you choose *NOT* to configure SRU,
1037 koha-conf.xml will still contain some references to SRU
1038 settings. Those references will be ignored by Koha.
1040 Install the SRU configuration files?);
1041 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1042 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1044 if ($config{'INSTALL_SRU'} eq 'yes') {
1046 Since you've chosen to configure SRU, you must
1047 specify the host and port(s) that the SRU
1048 Servers (bibliographic and authority) should run on.
1051 SRU Database host?);
1052 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1055 SRU port for bibliographic data?);
1056 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1059 SRU port for authority data?);
1060 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1065 Since you've chosen to use Zebra, you can also choose to
1066 install PazPar2, which is a metasearch tool. With PazPar2,
1067 Koha can perform on-the-fly merging of bibliographic
1068 records during searching, allowing for FRBRization of
1071 Install the PazPar2 configuration files?);
1072 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1073 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1075 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1077 Since you've chosen to configure PazPar2, you must
1078 specify the host and port(s) that PazPar2
1082 Zebra bibliographic server host?);
1083 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1086 Zebra bibliographic port for PazPar2 to use?);
1087 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1091 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1095 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1100 Use memcached and memoize to cache the results of some function calls?
1101 This provides a signficant performance improvement.
1102 You will need a Memcached server running.);
1103 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1104 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1105 if ($config{'USE_MEMCACHED'} eq 'yes'){
1107 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1110 Memcached server address?);
1111 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1114 Memcached namespace?);
1115 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1121 Would you like to run the database-dependent test suite?);
1122 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1123 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1125 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1126 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1127 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1128 $msg = q(TEST DATABASE
1130 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1131 testing. Please don't do this on your production database. It is not
1134 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1135 database. You are better off not running this optional test suite than
1136 doing it in a database that you don't want to lose.
1138 Please specify the name of the test database to be
1141 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1142 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1143 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1144 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1148 Please specify the user that owns the database to be
1150 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1153 Please specify the password of the user that owns the
1154 database to be used by Koha);
1155 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1160 # add version number
1161 my $version = "no_version_found";
1163 require 'kohaversion.pl';
1164 $version = kohaversion();
1166 $config{'KOHA_INSTALLED_VERSION'} = $version;
1171 sub _add_valid_values_disp {
1173 my $valid_values = shift;
1176 if (exists $valid_values->{$key}) {
1177 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1185 my $default = shift;
1186 my $valid_values = shift;
1187 my $install_log_values = shift;
1189 # take value from install log if present
1190 if (exists $install_log_values{$key}) {
1191 return $install_log_values{$key};
1194 # override default value from environment
1195 if (exists $ENV{$key}) {
1196 $default = $ENV{$key};
1197 $msg .= " (default from environment)";
1200 my $val = prompt($msg, $default);
1202 while (exists $valid_values->{$key} and
1203 $val ne $default and
1204 not exists $valid_values->{$key}->{$val}) {
1205 my $retry_msg = "Value '$val' is not a valid option.\n";
1206 $retry_msg .= "Please enter a value";
1207 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1208 $val = prompt($retry_msg, $default);
1213 =head2 get_target_directories
1215 Creates a hash mapping from symbols for installation target
1216 directories to actual directory paths.
1218 Also returns a hash indicating targets for which
1219 files need not be copied -- this is used for the 'dev'
1220 mode installation, where some files are installed in place.
1224 sub get_target_directories {
1227 my $base = $config->{'INSTALL_BASE'};
1228 my $mode = $config->{'INSTALL_MODE'};
1230 # get last component of install base directory
1231 # to treat as package name
1232 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1234 my @basedir = File::Spec->splitdir($directories);
1236 # for Win32 we need to prepend the volume to the directory path
1237 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1238 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1240 my $package = pop @basedir;
1245 if ($mode eq 'single') {
1246 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1247 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1248 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1249 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1250 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1251 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1252 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1253 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1254 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1255 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1256 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1257 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1258 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1259 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1260 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1261 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1262 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
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');
1265 } elsif ($mode eq 'dev') {
1266 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1267 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1268 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1269 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1270 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1271 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1272 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1273 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1274 $skipdirs{'OPAC_CGI_DIR'} = 1;
1275 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1276 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1277 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1278 $skipdirs{'OPAC_WWW_DIR'} = 1;
1279 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1280 $skipdirs{'PERL_MODULE_DIR'} = 1;
1281 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1282 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1283 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1284 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1285 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1286 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1287 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1288 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1289 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1290 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1291 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1292 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1293 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1295 # mode is standard, i.e., 'fhs'
1296 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1297 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1298 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1299 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1300 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1301 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1302 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1303 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1304 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1305 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1306 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1307 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1308 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1309 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1310 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1311 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1312 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1313 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1314 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1317 _get_env_overrides(\%dirmap);
1318 _get_argv_overrides(\%dirmap);
1319 _add_destdir(\%dirmap) unless ($^O eq 'MSWin32');
1321 return \%dirmap, \%skipdirs;
1326 Map a directory target to the corresponding path for
1334 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1335 if (exists $test_suite_override_dirs{$dirname}) {
1336 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1343 sub _get_env_overrides {
1346 foreach my $key (keys %$dirmap) {
1347 if (exists $ENV{$key}) {
1348 $dirmap->{$key} = $ENV{$key};
1349 print "Setting $key from environment\n";
1354 sub _get_argv_overrides {
1358 for (my $i = 0; $i <= $#ARGV; $i++) {
1359 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1362 push @new_argv, $ARGV[$i];
1368 sub _strip_destdir {
1370 $dir =~ s/^\$\(DESTDIR\)//;
1377 foreach my $key (keys %$dirmap) {
1378 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1382 sub display_configuration {
1385 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1386 foreach my $key (sort keys %$config) {
1387 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1390 print "\nand in the following directories:\n\n";
1391 foreach my $key (sort keys %$dirmap) {
1392 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1394 print "\n\nTo change any configuration setting, please run\n";
1395 print "perl Makefile.PL again. To override one of the target\n";
1396 print "directories, you can do so on the command line like this:\n";
1397 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1398 print "You can also set different default values for parameters\n";
1399 print "or override directory locations by using environment variables.\n";
1400 print "\nFor example:\n\n";
1401 print "export DB_USER=my_koha\n";
1402 print "perl Makefile.PL\n";
1404 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1405 print "If installing on a Win32 platform, be sure to use:\n";
1406 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1411 Attempt to find Zebra - check user's PATH and
1412 a few other directories for zebrasrv and zebraidx.
1414 FIXME: doesn't handle Win32
1419 my @search_dirs = map {
1420 my $abs = File::Spec->rel2abs($_);
1421 my ($toss, $directories);
1422 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1424 } split /:/, $ENV{PATH};
1425 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1426 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1427 return unless @zebrasrv_dirs;
1428 # verify that directory that contains zebrasrv also contains zebraidx
1429 foreach my $dir (@zebrasrv_dirs) {
1430 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1437 # This will have to be reworked in order to accommodate Win32...
1441 my $test = $self->SUPER::test(@_);
1442 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1445 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1452 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1453 # This means that we're completely overriding EU::MM's default
1454 # installation and uninstallation targets.
1456 # If installation is on Win32, we need to do permissions different from *nix
1457 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1458 foreach my $key (sort keys %$target_directories) {
1460 KOHA_INST_$key = blib/$key
1461 KOHA_DEST_$key = $target_directories->{$key}
1462 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1465 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1466 \t\$(NOECHO) \$(NOOP)
1468 $install .= "install_koha ::\n";
1469 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1470 foreach my $key (sort keys %$target_directories) {
1471 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1472 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1474 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1475 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1478 $install .= "set_koha_ownership ::\n";
1479 # Do not try to change ownership if DESTDIR is set
1480 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1481 foreach my $key (sort keys %$target_directories) {
1482 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1483 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1486 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1490 $install .= "set_koha_permissions ::\n";
1491 # This is necessary because EU::MM installs files
1492 # as either 0444 or 0555, and we want the owner
1493 # of Koha's files to have write permission by default.
1494 foreach my $key (sort keys %$target_directories) {
1495 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1496 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1499 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1500 # We can attempt some creative things with command line utils such as CACLS which allows permission
1501 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1502 foreach my $key (sort keys %$target_directories) {
1504 KOHA_INST_$key = blib/$key
1505 KOHA_DEST_$key = $target_directories->{$key}
1506 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1509 install :: all install_koha warn_koha_env_vars
1510 \t\$(NOECHO) \$(NOOP)
1512 $install .= "install_koha ::\n";
1513 $install .= "\t\$(MOD_INSTALL) \\\n";
1514 foreach my $key (sort keys %$target_directories) {
1515 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1516 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1521 $install .= "warn_koha_env_vars ::\n";
1522 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1523 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1524 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1525 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1526 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1527 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1528 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1529 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1530 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1531 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1532 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1534 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1535 $install .= _update_zebra_conf_target();
1538 $install .= upgrade();
1543 =head2 _update_zebra_conf_target
1545 Add an installation target for updating
1546 Zebra's configuration files.
1550 sub _update_zebra_conf_target {
1552 my $target = "\nupdate_zebra_conf ::\n";
1553 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1554 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1555 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1556 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1557 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1558 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1567 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1568 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1569 $version =~ s/\./_/g;
1570 $backup_suffix = "_koha_$version";
1572 $backup_suffix = "_upgrade_backup";
1576 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1578 upgrade :: make_upgrade_backup install
1579 \t\$(NOECHO) \$(NOOP)
1580 make_upgrade_backup ::
1581 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1583 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1584 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1585 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1586 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1587 exists $skip_directories->{$key} or
1588 not exists $target_directories->{$key};
1590 $upgrade =~ s/\\\n$/\n/;
1596 # put directory mappings into Makefile
1597 # so that Make will export as environment
1598 # variables -- this is for the use of
1601 # quote '$' in the two password parameters
1602 my %config = %config;
1603 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1604 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1605 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1609 # Hereagain, we must alter syntax per platform...
1610 if ( $^O eq 'MSWin32' ) {
1611 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1612 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1614 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1617 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1619 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1622 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1623 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1624 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1625 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1626 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";
1628 # these directories will be relocated to the 't' directory
1629 foreach my $dirname ( keys %$target_directories ) {
1630 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1631 if ( exists $test_suite_override_dirs{$dirname} ) {
1632 $dir = main::get_test_dir($dirname);
1634 print $confhandle "$dirname = $dir\n"
1636 print $confhandle "\n";
1638 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1639 close( $confhandle );
1641 warn 'unable to open conf file for database dependent tests: $!';
1654 ExtUtils::MakeMaker(3)
1658 MJ Ray mjr at phonecoop.coop
1659 Galen Charlton galen.charlton at liblime.com
1662 FIXME: deal with .htaccess