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, used for patron image feature
560 'GD::Barcode::UPCE' => 1.1,
561 'Graphics::Magick' => 1.3.7, #optional, used for patron cards creator
562 'Getopt::Long' => 2.35,
563 'Getopt::Std' => 1.05,
564 'HTML::Template::Pro' => 0.69,
565 'HTML::Scrubber' => 0.08,
566 'HTTP::Cookies' => 1.39,
568 'HTTP::Request::Common' => 1.26,
570 'JSON' => 2.07, # Needed by admin/item_circulation_alerts.pl
571 'LWP::Simple' => 1.41,
572 'LWP::UserAgent' => 2.033,
573 'Lingua::Stem' => 0.82,
574 'Lingua::Stem::Snowball' => 0.952,
575 'List::Util' => 1.18,
576 'List::MoreUtils' => 0.21,
577 'Locale::Language' => 2.07,
578 'MARC::Charset' => 0.98,
579 'MARC::Crosswalk::DublinCore' => 0.02,
580 'MARC::File::XML' => 0.88,
581 'MARC::Record' => 2.00,
582 'MIME::Base64' => 3.07,
583 'MIME::Lite' => 3.00,
584 'MIME::QuotedPrint' => 3.07,
585 'Mail::Sendmail' => 0.79,
586 'Memoize::Memcached' => 0.03, # optional
587 'Net::LDAP' => 0.33, # optional
588 'Net::LDAP::Filter' => 0.14, # optional
589 'Net::Z3950::ZOOM' => 1.16,
590 'Number::Format' => 1.52,
591 'PDF::API2' => 2.000,
592 'PDF::API2::Page' => 2.000,
593 'PDF::API2::Util' => 2.000,
594 'PDF::API2::Simple' => 1.000,
595 'PDF::Table' => 0.9.3,
596 'PDF::Reuse' => 0.33,
597 'PDF::Reuse::Barcode' => 0.05,
600 'Schedule::At' => 1.06,
602 'SMS::Send' => 0.05, # optional
603 'Term::ANSIColor' => 1.10,
605 'Test::Harness' => 2.56,
606 'Test::More' => 0.80,
608 'Text::CSV_XS' => 0.32,
609 'Text::CSV::Encoded' => 0.09,
610 'Text::Iconv' => 1.7,
611 'Text::Wrap' => 2005.082401,
612 'Time::HiRes' => 1.86,
613 'Time::localtime' => 1.02,
614 'Unicode::Normalize' => 0.32,
615 'URI::Escape' => 1.36,
616 'XML::Dumper' => 0.81,
617 'XML::LibXML' => 1.59,
618 'XML::LibXSLT' => 1.59,
619 'XML::SAX::ParserFactory' => 1.01,
620 'XML::SAX::Writer' => 0.44,
621 'XML::Simple' => 2.14,
623 'YAML::Syck' => 0.71,
629 # Man pages generated from POD
630 # ExtUtils::MakeMaker already manage $(DESTDIR)
631 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
632 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
634 PL_FILES => $pl_files,
641 This function recurses through the directory structure and builds
642 a hash of hashes containing the structure with arrays holding filenames.
643 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
649 opendir my $dh, $dir or die $!;
650 my $tree = {}->{$dir} = {};
651 while( my $file = readdir($dh) ) {
652 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
653 my $path = $dir .'/' . $file;
654 $tree->{$file} = hashdir($path), next if -d $path;
655 push @{$tree->{'.'}}, $file;
662 This function combines the target_map and file hash to
663 map each source file to its destination relative to
664 the set of installation targets.
666 Output will be a hash mapping from each source file
667 to its destination value, like this:
669 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
674 my $target_map = shift;
676 my $file_map = shift;
677 my $install_zebra = shift;
678 my $curr_path = @_ ? shift : ['.'];
680 # Traverse the directory tree.
681 # For each file or directory, identify the
682 # most specific match in the target_map
683 foreach my $dir (sort keys %{ $dirtree }) {
685 # deal with files in directory
686 foreach my $file (sort @{ $dirtree->{$dir} }) {
687 my $targetdir = undef;
688 my $matchlevel = undef;
689 # first, see if there is a match on this specific
690 # file in the target map
691 my $filepath = join("/", @$curr_path, $file);
692 if (exists $target_map->{$filepath}) {
693 $targetdir = $target_map->{$filepath};
694 $matchlevel = scalar(@$curr_path) + 1;
696 # no match on the specific file; look for
698 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
699 my $dirpath = join("/", @$curr_path[0..$i]);
700 if (exists $target_map->{$dirpath}) {
701 $targetdir = $target_map->{$dirpath};
702 $matchlevel = $i + 1;
707 if (defined $targetdir) {
708 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
710 my $path = join("/", @$curr_path);
711 print "failed to map: $path/$file\n" if $DEBUG;
715 # dealing with subdirectory
716 push @$curr_path, $dir;
717 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
723 sub _add_to_file_map {
724 my $file_map = shift;
725 my $targetdir = shift;
726 my $curr_path = shift;
728 my $matchlevel = shift;
729 my $install_zebra = shift;
730 my $dest_path = @_ ? shift : $curr_path;
732 # The target can be one of the following:
733 # 1. scalar representing target symbol
734 # 2. hash ref containing target and trimdir keys
736 # Consequently, this routine traverses this structure,
737 # calling itself recursively, until it deals with
738 # all of the scalar target symbols.
739 if (ref $targetdir eq 'HASH') {
740 my $subtarget = $targetdir->{target};
741 if (exists $targetdir->{trimdir}) {
742 # if we get here, we've specified that
743 # rather than installing the file to
744 # $(TARGET)/matching/dirs/subdirs/file,
745 # we want to install it to
746 # $(TARGET)/subdirs/file
748 # Note that this the only place where
749 # $matchlevel is used.
750 my @new_dest_path = @$dest_path;
751 if ($targetdir->{trimdir} == -1) {
752 splice @new_dest_path, 0, $matchlevel;
754 splice @new_dest_path, 0, $targetdir->{trimdir};
756 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
758 # actually getting here means that the
759 # target was unnecessarily listed
760 # as a hash, but we'll forgive that
761 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
763 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
764 my $source = File::Spec->catfile(@$curr_path, $file);
765 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
766 #print "$source => $destination\n"; # DEBUG
767 # quote spaces in file names
768 # FIXME: this is of questionable portability and
769 # probably depends on user's make recognizing this
770 # quoting syntax -- probably better to remove
771 # spaces and shell metacharacters from all file names
772 $source =~ s/ /\\ /g;
773 $destination =~ s/ /\\ /g;
775 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
779 =head2 get_install_log_values
781 Reads value from the Koha install log specified by
786 sub get_install_log_values {
787 my $install_log = shift;
790 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
793 next if /^#/ or /^\s*$/;
797 my ($key, $value) = split /=/, $_, 2;
798 $values->{$key} = $value;
802 print <<_EXPLAIN_INSTALL_LOG_;
803 Reading values from install log $install_log. You
804 will be prompted only for settings that have been
805 added since the last time you installed Koha. To
806 be prompted for all settings, run 'perl Makefile.PL'
807 without the --prev-install-log option.
808 _EXPLAIN_INSTALL_LOG_
811 =head2 get_configuration
813 This prompts the user for various configuration options.
817 sub get_configuration {
818 my $defaults = shift;
819 my $valid_values = shift;
820 my $install_log_values = shift;
824 By default, Koha can be installed in one of three ways:
826 standard: Install files in conformance with the Filesystem
827 Hierarchy Standard (FHS). This is the default mode
828 and should be used when installing a production
829 Koha system. On Unix systems, root access is
830 needed to complete a standard installation.
832 single: Install files under a single directory. This option
833 is useful for installing Koha without root access, e.g.,
834 on a web host that allows CGI scripts and MySQL databases
835 but requires the user to keep all files under the user's
838 dev: Create a set of symbolic links and configuration files to
839 allow Koha to run directly from the source distribution.
840 This mode is useful for developers who want to run
841 Koha from a git clone.
844 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
845 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
847 # set message and default value for INSTALL_BASE
848 # depending on value of INSTALL_MODE
849 my $install_base_default = $defaults->{'INSTALL_BASE'};
850 if ($config{'INSTALL_MODE'} eq 'dev') {
852 Please specify the directory in which to install Koha's
853 active configuration files and (if applicable) the
854 Zebra database. Koha's CGI scripts and templates will
855 be run from the current directory.
857 Configuration directory:);
858 # FIXME - home directory portability consideration apply
859 $install_base_default =
861 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
863 } elsif ($config{'INSTALL_MODE'} eq 'single') {
864 $msg = "\nPlease specify the directory in which to install Koha";
865 # FIXME -- we're assuming under a 'single' mode install
866 # that user will likely want to install under the home
867 # directory. This is OK in and of itself, but we should
868 # use File::HomeDir to locate the home directory portably.
869 # This is deferred for now because File::HomeDir is not yet
871 # --we must also keep this portable to the major OS's -fbcit
872 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
876 Please specify the directory under which most Koha files
879 Note that if you are planning in installing more than
880 one instance of Koha, you may want to modify the last
881 component of the directory path, which will be used
882 as the package name in the FHS layout.
884 Base installation directory);
886 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
888 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
889 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
890 if ($config{'INSTALL_MODE'} eq "standard") {
892 Since you are using the 'standard' install
893 mode, you should run 'make install' as root.
894 However, it is recommended that a non-root
895 user (on Unix and Linux platforms) have
896 ownership of Koha's files, including the
897 Zebra indexes if applicable.
899 Please specify a user account. This
900 user account does not need to exist
901 right now, but it needs to exist
902 before you run 'make install'. Please
903 note that for security reasons, this
904 user should not be the same as the user
905 account Apache runs under.
908 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
911 Please specify the group that should own
912 Koha's files. As above, this group need
913 not exist right now, but should be created
914 before you run 'make install'.
917 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
921 Please specify which database engine you will use
922 to store data in Koha. The choices are MySQL and
923 PostgreSQL; please note that at the moment
924 PostgreSQL support is highly experimental.
927 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
928 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
931 Please specify the name or address of your
932 database server. Note that the database
933 does not have to exist at this point, it
934 can be created after running 'make install'
935 and before you try using Koha for the first time.
938 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
941 Please specify the port used to connect to the
943 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
944 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
947 Please specify the name of the database to be
949 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
952 Please specify the user that owns the database to be
954 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
957 Please specify the password of the user that owns the
958 database to be used by Koha);
959 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
962 Koha can use the Zebra search engine for high-performance
963 searching of bibliographic and authority records. If you
964 have installed the Zebra software and would like to use it,
965 please answer 'yes' to the following question. Otherwise,
966 Koha will default to using its internal search engine.
968 Please note that if you choose *NOT* to install Zebra,
969 koha-conf.xml will still contain some references to Zebra
970 settings. Those references will be ignored by Koha.
972 Install the Zebra configuration files?);
973 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
974 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
976 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
978 if (defined(my $zebra_path = find_zebra())) {
979 $config{'PATH_TO_ZEBRA'} = $zebra_path;
981 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
985 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
986 in your PATH or in some of the usual places. If you haven't
987 installed Zebra yet, please do so and run Makefile.PL again.
993 Since you've chosen to use Zebra with Koha,
994 you must specify the primary MARC format of the
995 records to be indexed by Zebra.
997 Koha provides Zebra configuration files for MARC 21
1000 MARC format for Zebra indexing);
1001 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1002 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1004 Koha supplies Zebra configuration files tuned for
1005 searching either English (en) or French (fr) MARC
1008 Primary language for Zebra indexing);
1009 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1010 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1013 Koha can use one of two different indexing modes
1014 for the MARC authorities records:
1016 grs1 - uses the Zebra GRS-1 filter, available
1018 dom - uses the DOM XML filter; offers improved
1021 Authorities indexing mode);
1022 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1023 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1026 Please specify Zebra database user);
1027 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1030 Please specify the Zebra database password);
1031 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1034 Since you've chosen to use Zebra, you can enable the SRU/
1035 Z39.50 Server if you so choose, but you must specify a
1036 few configuration options for it.
1038 Please note that if you choose *NOT* to configure SRU,
1039 koha-conf.xml will still contain some references to SRU
1040 settings. Those references will be ignored by Koha.
1042 Install the SRU configuration files?);
1043 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1044 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1046 if ($config{'INSTALL_SRU'} eq 'yes') {
1048 Since you've chosen to configure SRU, you must
1049 specify the host and port(s) that the SRU
1050 Servers (bibliographic and authority) should run on.
1053 SRU Database host?);
1054 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1057 SRU port for bibliographic data?);
1058 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1061 SRU port for authority data?);
1062 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1067 Since you've chosen to use Zebra, you can also choose to
1068 install PazPar2, which is a metasearch tool. With PazPar2,
1069 Koha can perform on-the-fly merging of bibliographic
1070 records during searching, allowing for FRBRization of
1073 Install the PazPar2 configuration files?);
1074 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1075 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1077 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1079 Since you've chosen to configure PazPar2, you must
1080 specify the host and port(s) that PazPar2
1084 Zebra bibliographic server host?);
1085 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1088 Zebra bibliographic port for PazPar2 to use?);
1089 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1093 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1097 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1102 Use memcached and memoize to cache the results of some function calls?
1103 This provides a signficant performance improvement.
1104 You will need a Memcached server running.);
1105 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1106 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1107 if ($config{'USE_MEMCACHED'} eq 'yes'){
1109 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1112 Memcached server address?);
1113 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1116 Memcached namespace?);
1117 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1123 Would you like to run the database-dependent test suite?);
1124 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1125 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1127 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1128 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1129 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1130 $msg = q(TEST DATABASE
1132 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1133 testing. Please don't do this on your production database. It is not
1136 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1137 database. You are better off not running this optional test suite than
1138 doing it in a database that you don't want to lose.
1140 Please specify the name of the test database to be
1143 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1144 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1145 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1146 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1150 Please specify the user that owns the database to be
1152 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1155 Please specify the password of the user that owns the
1156 database to be used by Koha);
1157 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1162 # add version number
1163 my $version = "no_version_found";
1165 require 'kohaversion.pl';
1166 $version = kohaversion();
1168 $config{'KOHA_INSTALLED_VERSION'} = $version;
1173 sub _add_valid_values_disp {
1175 my $valid_values = shift;
1178 if (exists $valid_values->{$key}) {
1179 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1187 my $default = shift;
1188 my $valid_values = shift;
1189 my $install_log_values = shift;
1191 # take value from install log if present
1192 if (exists $install_log_values{$key}) {
1193 return $install_log_values{$key};
1196 # override default value from environment
1197 if (exists $ENV{$key}) {
1198 $default = $ENV{$key};
1199 $msg .= " (default from environment)";
1202 my $val = prompt($msg, $default);
1204 while (exists $valid_values->{$key} and
1205 $val ne $default and
1206 not exists $valid_values->{$key}->{$val}) {
1207 my $retry_msg = "Value '$val' is not a valid option.\n";
1208 $retry_msg .= "Please enter a value";
1209 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1210 $val = prompt($retry_msg, $default);
1215 =head2 get_target_directories
1217 Creates a hash mapping from symbols for installation target
1218 directories to actual directory paths.
1220 Also returns a hash indicating targets for which
1221 files need not be copied -- this is used for the 'dev'
1222 mode installation, where some files are installed in place.
1226 sub get_target_directories {
1229 my $base = $config->{'INSTALL_BASE'};
1230 my $mode = $config->{'INSTALL_MODE'};
1232 # get last component of install base directory
1233 # to treat as package name
1234 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1236 my @basedir = File::Spec->splitdir($directories);
1238 # for Win32 we need to prepend the volume to the directory path
1239 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1240 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1242 my $package = pop @basedir;
1247 if ($mode eq 'single') {
1248 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1249 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1250 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1251 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1252 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1253 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1254 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1255 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1256 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1257 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1258 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1259 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1260 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1261 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1262 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1263 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1264 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1265 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1266 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1267 } elsif ($mode eq 'dev') {
1268 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1269 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1270 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1271 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1272 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1273 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1274 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1275 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1276 $skipdirs{'OPAC_CGI_DIR'} = 1;
1277 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1278 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1279 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1280 $skipdirs{'OPAC_WWW_DIR'} = 1;
1281 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1282 $skipdirs{'PERL_MODULE_DIR'} = 1;
1283 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1284 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1285 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1286 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1287 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1288 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1289 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1290 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1291 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1292 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1293 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1294 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1295 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1297 # mode is standard, i.e., 'fhs'
1298 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1299 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1300 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1301 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1302 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1303 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1304 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1305 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1306 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1307 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1308 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1309 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1310 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1311 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1312 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1313 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1314 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1315 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1316 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1319 _get_env_overrides(\%dirmap);
1320 _get_argv_overrides(\%dirmap);
1321 _add_destdir(\%dirmap) unless ($^O eq 'MSWin32');
1323 return \%dirmap, \%skipdirs;
1328 Map a directory target to the corresponding path for
1336 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1337 if (exists $test_suite_override_dirs{$dirname}) {
1338 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1345 sub _get_env_overrides {
1348 foreach my $key (keys %$dirmap) {
1349 if (exists $ENV{$key}) {
1350 $dirmap->{$key} = $ENV{$key};
1351 print "Setting $key from environment\n";
1356 sub _get_argv_overrides {
1360 for (my $i = 0; $i <= $#ARGV; $i++) {
1361 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1364 push @new_argv, $ARGV[$i];
1370 sub _strip_destdir {
1372 $dir =~ s/^\$\(DESTDIR\)//;
1379 foreach my $key (keys %$dirmap) {
1380 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1384 sub display_configuration {
1387 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1388 foreach my $key (sort keys %$config) {
1389 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1392 print "\nand in the following directories:\n\n";
1393 foreach my $key (sort keys %$dirmap) {
1394 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1396 print "\n\nTo change any configuration setting, please run\n";
1397 print "perl Makefile.PL again. To override one of the target\n";
1398 print "directories, you can do so on the command line like this:\n";
1399 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1400 print "You can also set different default values for parameters\n";
1401 print "or override directory locations by using environment variables.\n";
1402 print "\nFor example:\n\n";
1403 print "export DB_USER=my_koha\n";
1404 print "perl Makefile.PL\n";
1406 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1407 print "If installing on a Win32 platform, be sure to use:\n";
1408 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1413 Attempt to find Zebra - check user's PATH and
1414 a few other directories for zebrasrv and zebraidx.
1416 FIXME: doesn't handle Win32
1421 my @search_dirs = map {
1422 my $abs = File::Spec->rel2abs($_);
1423 my ($toss, $directories);
1424 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1426 } split /:/, $ENV{PATH};
1427 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1428 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1429 return unless @zebrasrv_dirs;
1430 # verify that directory that contains zebrasrv also contains zebraidx
1431 foreach my $dir (@zebrasrv_dirs) {
1432 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1439 # This will have to be reworked in order to accommodate Win32...
1443 my $test = $self->SUPER::test(@_);
1444 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1447 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1454 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1455 # This means that we're completely overriding EU::MM's default
1456 # installation and uninstallation targets.
1458 # If installation is on Win32, we need to do permissions different from *nix
1459 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1460 foreach my $key (sort keys %$target_directories) {
1462 KOHA_INST_$key = blib/$key
1463 KOHA_DEST_$key = $target_directories->{$key}
1464 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1467 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1468 \t\$(NOECHO) \$(NOOP)
1470 $install .= "install_koha ::\n";
1471 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1472 foreach my $key (sort keys %$target_directories) {
1473 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1474 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1476 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1477 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1480 $install .= "set_koha_ownership ::\n";
1481 # Do not try to change ownership if DESTDIR is set
1482 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1483 foreach my $key (sort keys %$target_directories) {
1484 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1485 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1488 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1492 $install .= "set_koha_permissions ::\n";
1493 # This is necessary because EU::MM installs files
1494 # as either 0444 or 0555, and we want the owner
1495 # of Koha's files to have write permission by default.
1496 foreach my $key (sort keys %$target_directories) {
1497 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1498 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1501 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1502 # We can attempt some creative things with command line utils such as CACLS which allows permission
1503 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1504 foreach my $key (sort keys %$target_directories) {
1506 KOHA_INST_$key = blib/$key
1507 KOHA_DEST_$key = $target_directories->{$key}
1508 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1511 install :: all install_koha warn_koha_env_vars
1512 \t\$(NOECHO) \$(NOOP)
1514 $install .= "install_koha ::\n";
1515 $install .= "\t\$(MOD_INSTALL) \\\n";
1516 foreach my $key (sort keys %$target_directories) {
1517 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1518 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1523 $install .= "warn_koha_env_vars ::\n";
1524 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1525 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1526 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1527 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1528 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1529 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1530 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1531 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1532 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1533 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1534 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1536 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1537 $install .= _update_zebra_conf_target();
1540 $install .= upgrade();
1545 =head2 _update_zebra_conf_target
1547 Add an installation target for updating
1548 Zebra's configuration files.
1552 sub _update_zebra_conf_target {
1554 my $target = "\nupdate_zebra_conf ::\n";
1555 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1556 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1557 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1558 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1559 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1560 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1569 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1570 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1571 $version =~ s/\./_/g;
1572 $backup_suffix = "_koha_$version";
1574 $backup_suffix = "_upgrade_backup";
1578 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1580 upgrade :: make_upgrade_backup install
1581 \t\$(NOECHO) \$(NOOP)
1582 make_upgrade_backup ::
1583 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1585 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1586 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1587 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1588 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1589 exists $skip_directories->{$key} or
1590 not exists $target_directories->{$key};
1592 $upgrade =~ s/\\\n$/\n/;
1598 # put directory mappings into Makefile
1599 # so that Make will export as environment
1600 # variables -- this is for the use of
1603 # quote '$' in the two password parameters
1604 my %config = %config;
1605 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1606 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1607 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1611 # Hereagain, we must alter syntax per platform...
1612 if ( $^O eq 'MSWin32' ) {
1613 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1614 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1616 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1619 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1621 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1624 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1625 if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1626 print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1627 print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1628 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";
1630 # these directories will be relocated to the 't' directory
1631 foreach my $dirname ( keys %$target_directories ) {
1632 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1633 if ( exists $test_suite_override_dirs{$dirname} ) {
1634 $dir = main::get_test_dir($dirname);
1636 print $confhandle "$dirname = $dir\n"
1638 print $confhandle "\n";
1640 print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1641 close( $confhandle );
1643 warn 'unable to open conf file for database dependent tests: $!';
1656 ExtUtils::MakeMaker(3)
1660 MJ Ray mjr at phonecoop.coop
1661 Galen Charlton galen.charlton at liblime.com
1664 FIXME: deal with .htaccess