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 perl Makefile.PL --prev-install-log /path/to/koha-install-log
54 perl Makefile.PL # if no koha-install-log available
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.
204 Directory for man pages created from POD -- will mostly
205 contain information of interest to Koha developers.
209 Directory for Koha documentation accessed from the
210 command-line, e.g., READMEs.
214 Directory for Apache and Zebra logs produced by Koha.
216 =item PAZPAR2_CONF_DIR
218 Directory for PazPar2 configuration files.
222 This is a dummy target used to explicitly state
223 that a given file or directory is not to be installed.
224 This is used either for parts of the installer itself
225 or for development tools that are not applicable to a
226 production installation.
233 './about.pl' => 'INTRANET_CGI_DIR',
234 './acqui' => 'INTRANET_CGI_DIR',
235 './admin' => 'INTRANET_CGI_DIR',
236 './authorities' => 'INTRANET_CGI_DIR',
237 './C4' => 'PERL_MODULE_DIR',
238 './C4/SIP/t' => 'NONE',
239 './C4/SIP/koha_test' => 'NONE',
240 './C4/tests' => 'NONE',
241 './catalogue' => 'INTRANET_CGI_DIR',
242 './cataloguing' => 'INTRANET_CGI_DIR',
243 './changelanguage.pl' => 'INTRANET_CGI_DIR',
244 './check_sysprefs.pl' => 'NONE',
245 './circ' => 'INTRANET_CGI_DIR',
246 './edithelp.pl' => 'INTRANET_CGI_DIR',
247 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
248 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
249 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
250 './help.pl' => 'INTRANET_CGI_DIR',
251 './installer-CPAN.pl' => 'NONE',
252 './installer' => 'INTRANET_CGI_DIR',
253 './koha-tmpl/errors' => {target => 'INTRANET_CGI_DIR', trimdir => 2},
254 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
255 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
256 './kohaversion.pl' => 'INTRANET_CGI_DIR',
257 './labels' => 'INTRANET_CGI_DIR',
258 './mainpage.pl' => 'INTRANET_CGI_DIR',
259 './Makefile.PL' => 'NONE',
260 './MANIFEST.SKIP' => 'NONE',
261 './members' => 'INTRANET_CGI_DIR',
262 './misc' => { target => 'SCRIPT_DIR', trimdir => -1 },
263 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
264 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
265 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
266 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
267 './misc/installer_devel_notes' => 'NONE',
268 './opac' => 'OPAC_CGI_DIR',
269 './README.txt' => 'NONE',
270 './reports' => 'INTRANET_CGI_DIR',
271 './reserve' => 'INTRANET_CGI_DIR',
272 './reviews' => 'INTRANET_CGI_DIR',
273 './rewrite-config.PL' => 'NONE',
274 './reviews' => 'INTRANET_CGI_DIR',
275 './rss' => 'MISC_DIR',
276 './serials' => 'INTRANET_CGI_DIR',
278 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
279 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
280 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
281 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
282 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
283 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
284 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
285 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
286 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
287 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
288 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
289 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
290 './sms' => 'INTRANET_CGI_DIR',
291 './suggestion' => 'INTRANET_CGI_DIR',
292 './svc' => 'INTRANET_CGI_DIR',
294 './tmp' => 'NONE', # FIXME need to determine whether
295 # Koha generates any persistent temp files
296 # that should go in /var/tmp/koha
297 './tools' => 'INTRANET_CGI_DIR',
298 './virtualshelves' => 'INTRANET_CGI_DIR',
299 # ignore files and directories created by the install itself
300 './pm_to_blib' => 'NONE',
304 =head1 CONFIGURATION OPTIONS
306 The following configuration options are used by the installer.
312 Specifies whether installation will be FHS-compliant (default,
313 assumes user has root), put everything under
314 a single directory (for users installing on a web host
315 that allows CGI scripts and a MySQL database but not root
316 access), or development (for a developer who wants to run
317 Koha from a git clone with no fuss).
321 Directory under which most components will go. Default
322 value will vary depending on INSTALL_MODE.
326 Type of DBMS (e.g., mysql or Pg).
334 Port that DBMS server is listening on.
338 Name of the DBMS database for Koha.
342 Name of DBMS user account for Koha's database.
346 Pasword of DMBS user account for Koha's database.
350 Whether to install Zebra configuration files and data
353 =item ZEBRA_MARC_FORMAT
355 Specifies format of MARC records to be indexed by Zebra.
359 Specifies primary language of records that will be
364 Internal Zebra user account for the index.
368 Internal Zebra user account's password.
372 System user account that will own Koha's files.
376 System group that will own Koha's files.
382 # default configuration options
383 my %config_defaults = (
384 'DB_TYPE' => 'mysql',
385 'DB_HOST' => 'localhost',
387 'DB_USER' => 'kohaadmin',
388 'DB_PASS' => 'katikoan',
389 'INSTALL_ZEBRA' => 'yes',
390 'INSTALL_SRU' => 'yes',
391 'INSTALL_PAZPAR2' => 'no',
392 'AUTH_INDEX_MODE' => 'grs1',
393 'ZEBRA_MARC_FORMAT' => 'marc21',
394 'ZEBRA_LANGUAGE' => 'en',
395 'ZEBRA_USER' => 'kohauser',
396 'ZEBRA_PASS' => 'zebrastripes',
397 'ZEBRA_SRU_HOST' => 'localhost',
398 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
399 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
400 'KOHA_USER' => 'koha',
401 'KOHA_GROUP' => 'koha',
402 'MERGE_SERVER_HOST' => 'localhost',
403 'MERGE_SERVER_PORT' => '11001',
404 'PAZPAR2_HOST' => 'localhost',
405 'PAZPAR2_PORT' => '11002',
408 # set some default configuratio options based on OS
409 # more conditions need to be added for other OS's
410 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
411 # to allow for more granular decisions based on which Win32 platform
413 warn "Your platform appears to be $^O.\n" if $DEBUG;
415 if ( $^O eq 'MSWin32' ) {
416 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
417 # this could be changed to put some files (ie. libraries) into system32, etc.
418 $config_defaults{'INSTALL_MODE'} = 'single';
419 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
421 elsif ( $^O eq 'cygwin' ) {
422 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
423 # this could be changed to put some files (ie. libraries) into system32, etc.
424 $config_defaults{'INSTALL_MODE'} = 'single';
425 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
428 $config_defaults{'INSTALL_MODE'} = 'standard';
429 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
432 # valid values for certain configuration options
433 my %valid_config_values = (
434 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
435 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
436 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
437 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
438 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
439 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
440 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
443 # get settings from command-line
444 my $koha_install_log = "";
445 Getopt::Long::Configure('pass_through');
446 my $results = GetOptions(
447 "prev-install-log=s" => \$koha_install_log
450 my %install_log_values = ();
451 if ($koha_install_log ne "") {
452 get_install_log_values($koha_install_log, \%install_log_values);
455 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
456 my ($target_directories, $skip_directories) = get_target_directories(\%config);
457 display_configuration(\%config, $target_directories);
459 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
462 'rewrite-config.PL' => [
463 'blib/KOHA_CONF_DIR/koha-conf.xml',
464 'blib/KOHA_CONF_DIR/koha-httpd.conf',
465 'blib/MISC_DIR/koha-install-log'
467 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
472 if ($config{'INSTALL_ZEBRA'} eq "yes") {
473 push @{ $pl_files->{'rewrite-config.PL'} }, (
474 'blib/ZEBRA_CONF_DIR/etc/passwd',
475 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
476 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
477 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
478 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
479 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
480 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
481 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
483 if ($config{'INSTALL_MODE'} ne 'dev') {
484 push @{ $pl_files->{'rewrite-config.PL'} }, (
485 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
486 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
487 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
490 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
491 push @{ $pl_files->{'rewrite-config.PL'} }, (
492 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
493 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
496 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
497 $config{'AUTH_RETRIEVAL_CFG'} =
498 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
501 if ($config{'INSTALL_MODE'} ne "dev") {
502 push @{ $pl_files->{'rewrite-config.PL'} }, (
503 'blib/PERL_MODULE_DIR/C4/Context.pm',
504 'blib/SCRIPT_DIR/kohalib.pl'
510 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
511 VERSION_FROM => 'kohaversion.pl',
512 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
513 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
516 # awaiting package maintainer's use of $VERSION
517 #'Algorithm::CheckDigits' => 0.48,
518 #'Algorithm::CheckDigits::M43_001' => 0.48,
519 'Biblio::EndnoteStyle' => 0.05,
522 'CGI::Session' => '4.10',
523 'Class::Factory::Util' => 1.6,
524 'Class::Accessor' => 0.30,
525 'DBD::mysql' => 4.004,
527 'Data::ICal' => 0.13,
528 'Data::Dumper' => 2.121_08,
530 'Date::ICal' => 1.72,
531 'Date::Manip' => 5.44,
532 'Digest::MD5' => 2.36,
533 'File::Temp' => 0.16,
534 'GD::Barcode::UPCE' => 1.1,
535 'Getopt::Long' => 2.35,
536 'Getopt::Std' => 1.05,
537 'HTML::Template::Pro' => 0.65,
538 'HTTP::Cookies' => 1.39,
539 'HTTP::Request::Common' => 1.26,
540 'LWP::Simple' => 1.41,
541 'LWP::UserAgent' => 2.033,
542 'Lingua::Stem' => 0.82,
543 'List::Util' => 1.18,
544 'List::MoreUtils' => 0.21,
545 'Locale::Language' => 2.07,
546 'MARC::Charset' => 0.98,
547 'MARC::Crosswalk::DublinCore' => 0.02,
548 'MARC::File::XML' => 0.88,
549 'MARC::Record' => 2.00,
550 'MIME::Base64' => 3.07,
551 'MIME::QuotedPrint' => 3.07,
552 'Mail::Sendmail' => 0.79,
554 'Net::LDAP::Filter' => 0.14,
555 'Net::Z3950::ZOOM' => 1.16,
556 'PDF::API2' => 2.000,
557 'PDF::API2::Page' => 2.000,
558 'PDF::API2::Util' => 2.000,
559 'PDF::Reuse' => 0.33,
560 'PDF::Reuse::Barcode' => 0.05,
563 'Schedule::At' => 1.06,
564 'Term::ANSIColor' => 1.10,
566 'Test::Harness' => 2.56,
567 'Test::More' => 0.62,
569 'Text::CSV_XS' => 0.32,
570 'Text::Iconv' => 1.7,
571 'Text::Wrap' => 2005.082401,
572 'Time::HiRes' => 1.86,
573 'Time::localtime' => 1.02,
574 'Unicode::Normalize' => 0.32,
575 'XML::Dumper' => 0.81,
576 'XML::LibXML' => 1.59,
577 'XML::LibXSLT' => 1.59,
578 'XML::SAX::ParserFactory' => 1.01,
579 'XML::Simple' => 2.14,
581 'YAML::Syck' => 0.71,
587 # Man pages generated from POD
588 INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
589 INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
591 PL_FILES => $pl_files,
599 This function recurses through the directory structure and builds
600 a hash of hashes containing the structure with arrays holding filenames.
601 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
607 opendir my $dh, $dir or die $!;
608 my $tree = {}->{$dir} = {};
609 while( my $file = readdir($dh) ) {
610 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
611 my $path = $dir .'/' . $file;
612 $tree->{$file} = hashdir($path), next if -d $path;
613 push @{$tree->{'.'}}, $file;
620 This function combines the target_map and file hash to
621 map each source file to its destination relative to
622 the set of installation targets.
624 Output will be a hash mapping from each source file
625 to its destination value, like this:
627 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
632 my $target_map = shift;
634 my $file_map = shift;
635 my $install_zebra = shift;
636 my $curr_path = @_ ? shift : ['.'];
638 # Traverse the directory tree.
639 # For each file or directory, identify the
640 # most specific match in the target_map
641 foreach my $dir (sort keys %{ $dirtree }) {
643 # deal with files in directory
644 foreach my $file (sort @{ $dirtree->{$dir} }) {
645 my $targetdir = undef;
646 my $matchlevel = undef;
647 # first, see if there is a match on this specific
648 # file in the target map
649 my $filepath = join("/", @$curr_path, $file);
650 if (exists $target_map->{$filepath}) {
651 $targetdir = $target_map->{$filepath};
652 $matchlevel = scalar(@$curr_path) + 1;
654 # no match on the specific file; look for
656 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
657 my $dirpath = join("/", @$curr_path[0..$i]);
658 if (exists $target_map->{$dirpath}) {
659 $targetdir = $target_map->{$dirpath};
660 $matchlevel = $i + 1;
665 if (defined $targetdir) {
666 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
668 my $path = join("/", @$curr_path);
669 print "failed to map: $path/$file\n" if $DEBUG;
673 # dealing with subdirectory
674 push @$curr_path, $dir;
675 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
681 sub _add_to_file_map {
682 my $file_map = shift;
683 my $targetdir = shift;
684 my $curr_path = shift;
686 my $matchlevel = shift;
687 my $install_zebra = shift;
688 my $dest_path = @_ ? shift : $curr_path;
690 # The target can be one of the following:
691 # 1. scalar representing target symbol
692 # 2. hash ref containing target and trimdir keys
694 # Consequently, this routine traverses this structure,
695 # calling itself recursively, until it deals with
696 # all of the scalar target symbols.
697 if (ref $targetdir eq 'HASH') {
698 my $subtarget = $targetdir->{target};
699 if (exists $targetdir->{trimdir}) {
700 # if we get here, we've specified that
701 # rather than installing the file to
702 # $(TARGET)/matching/dirs/subdirs/file,
703 # we want to install it to
704 # $(TARGET)/subdirs/file
706 # Note that this the only place where
707 # $matchlevel is used.
708 my @new_dest_path = @$dest_path;
709 if ($targetdir->{trimdir} == -1) {
710 splice @new_dest_path, 0, $matchlevel;
712 splice @new_dest_path, 0, $targetdir->{trimdir};
714 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
716 # actually getting here means that the
717 # target was unnecessarily listed
718 # as a hash, but we'll forgive that
719 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
721 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
722 my $source = File::Spec->catfile(@$curr_path, $file);
723 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
724 #print "$source => $destination\n"; # DEBUG
725 # quote spaces in file names
726 # FIXME: this is of questionable portability and
727 # probably depends on user's make recognizing this
728 # quoting syntax -- probably better to remove
729 # spaces and shell metacharacters from all file names
730 $source =~ s/ /\\ /g;
731 $destination =~ s/ /\\ /g;
733 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
737 =head2 get_install_log_values
739 Reads value from the Koha install log specified by
744 sub get_install_log_values {
745 my $install_log = shift;
748 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
751 next if /^#/ or /^\s*$/;
754 my ($key, $value) = split /=/, $_, 2;
755 $values->{$key} = $value;
759 print <<_EXPLAIN_INSTALL_LOG_;
760 Reading values from install log $install_log. You
761 will be prompted only for settings that have been
762 added since the last time you installed Koha. To
763 be prompted for all settings, run 'perl Makefile.PL'
764 without the --prev-install-log option.
765 _EXPLAIN_INSTALL_LOG_
768 =head2 get_configuration
770 This prompts the user for various configuration options.
774 sub get_configuration {
775 my $defaults = shift;
776 my $valid_values = shift;
777 my $install_log_values = shift;
781 By default, Koha can be installed in one of three ways:
783 standard: Install files in conformance with the Filesystem
784 Hierarchy Standard (FHS). This is the default mode
785 and should be used when installing a production
786 Koha system. On Unix systems, root access is
787 needed to complete a standard installation.
789 single: Install files under a single directory. This option
790 is useful for installing Koha without root access, e.g.,
791 on a web host that allows CGI scripts and MySQL databases
792 but requires the user to keep all files under the user's
795 dev: Create a set of symbolic links and configuration files to
796 allow Koha to run directly from the source distribution.
797 This mode is useful for developers who want to run
798 Koha from a git clone.
801 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
802 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
804 # set message and default value for INSTALL_BASE
805 # depending on value of INSTALL_MODE
806 my $install_base_default = $defaults->{'INSTALL_BASE'};
807 if ($config{'INSTALL_MODE'} eq 'dev') {
809 Please specify the directory in which to install Koha's
810 active configuration files and (if applicable) the
811 Zebra database. Koha's CGI scripts and templates will
812 be run from the current directory.
814 Configuration directory:);
815 # FIXME - home directory portability consideration apply
816 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
817 } elsif ($config{'INSTALL_MODE'} eq 'single') {
818 $msg = "\nPlease specify the directory in which to install Koha";
819 # FIXME -- we're assuming under a 'single' mode install
820 # that user will likely want to install under the home
821 # directory. This is OK in and of itself, but we should
822 # use File::HomeDir to locate the home directory portably.
823 # This is deferred for now because File::HomeDir is not yet
825 # --we must also keep this portable to the major OS's -fbcit
826 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
830 Please specify the directory under which most Koha files
833 Note that if you are planning in installing more than
834 one instance of Koha, you may want to modify the last
835 component of the directory path, which will be used
836 as the package name in the FHS layout.
838 Base installation directory);
840 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
842 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
843 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
844 if ($config{'INSTALL_MODE'} eq "standard") {
846 Since you are using the 'standard' install
847 mode, you should run 'make install' as root.
848 However, it is recommended that a non-root
849 user (on Unix and Linux platforms) have
850 ownership of Koha's files, including the
851 Zebra indexes if applicable.
853 Please specify a user account. This
854 user account does not need to exist
855 right now, but it needs to exist
856 before you run 'make install'. Please
857 note that for security reasons, this
858 user should not be the same as the user
859 account Apache runs under.
862 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
865 Please specify the group that should own
866 Koha's files. As above, this group need
867 not exist right now, but should be created
868 before you run 'make install'.
871 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
875 Please specify which database engine you will use
876 to store data in Koha. The choices are MySQL and
877 PostgreSQL; please note that at the moment
878 PostgreSQL support is highly experimental.
881 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
882 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
885 Please specify the name or address of your
886 database server. Note that the database
887 does not have to exist at this point, it
888 can be created after running 'make install'
889 and before you try using Koha for the first time.
892 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
895 Please specify the port used to connect to the
897 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
898 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
901 Please specify the name of the database to be
903 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
906 Please specify the user that owns the database to be
908 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
911 Please specify the password of the user that owns the
912 database to be used by Koha);
913 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
916 Koha can use the Zebra search engine for high-performance
917 searching of bibliographic and authority records. If you
918 have installed the Zebra software and would like to use it,
919 please answer 'yes' to the following question. Otherwise,
920 Koha will default to using its internal search engine.
922 Please note that if you choose *NOT* to install Zebra,
923 koha-conf.xml will still contain some references to Zebra
924 settings. Those references will be ignored by Koha.
926 Install the Zebra configuration files?);
927 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
928 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
930 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
932 Since you've chosen to use Zebra with Koha,
933 you must specify the primary MARC format of the
934 records to be indexed by Zebra.
936 Koha provides Zebra configuration files for MARC 21
939 MARC format for Zebra indexing);
940 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
941 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
943 Koha supplies Zebra configuration files tuned for
944 searching either English (en) or French (fr) MARC
947 Primary language for Zebra indexing);
948 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
949 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
952 Koha can use one of two different indexing modes
953 for the MARC authorities records:
955 grs1 - uses the Zebra GRS-1 filter, available
957 dom - uses the DOM XML filter; offers improved
960 Authorities indexing mode);
961 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
962 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
965 Please specify Zebra database user);
966 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
969 Please specify the Zebra database password);
970 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
973 Since you've chosen to use Zebra, you can enable the SRU/
974 Z39.50 Server if you so choose, but you must specify a
975 few configuration options for it.
977 Please note that if you choose *NOT* to configure SRU,
978 koha-conf.xml will still contain some references to SRU
979 settings. Those references will be ignored by Koha.
981 Install the SRU configuration files?);
982 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
983 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
985 if ($config{'INSTALL_SRU'} eq 'yes') {
987 Since you've chosen to configure SRU, you must
988 specify the host and port(s) that the SRU
989 Servers (bibliographic and authority) should run on.
993 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
996 SRU port for bibliographic data?);
997 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1000 SRU port for authority data?);
1001 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1006 Since you've chosen to use Zebra, you can also choose to
1007 install PazPar2, which is a metasearch tool. With PazPar2,
1008 Koha can perform on-the-fly merging of bibliographic
1009 records during searching, allowing for FRBRization of
1012 Install the PazPar2 configuration files?);
1013 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1014 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1016 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1018 Since you've chosen to configure PazPar2, you must
1019 specify the host and port(s) that PazPar2
1023 Zebra bibliographic server host?);
1024 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1027 Zebra bibliographic port for PazPar2 to use?);
1028 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1032 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1036 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1043 # add version number
1044 my $version = "no_version_found";
1046 require 'kohaversion.pl';
1047 $version = kohaversion();
1049 $config{'KOHA_INSTALLED_VERSION'} = $version;
1054 sub _add_valid_values_disp {
1056 my $valid_values = shift;
1059 if (exists $valid_values->{$key}) {
1060 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1068 my $default = shift;
1069 my $valid_values = shift;
1070 my $install_log_values = shift;
1072 # take value from install log if present
1073 if (exists $install_log_values{$key}) {
1074 return $install_log_values{$key};
1077 # override default value from environment
1078 if (exists $ENV{$key}) {
1079 $default = $ENV{$key};
1080 $msg .= " (default from environment)";
1083 my $val = prompt($msg, $default);
1085 while (exists $valid_values->{$key} and
1086 $val ne $default and
1087 not exists $valid_values->{$key}->{$val}) {
1088 my $retry_msg = "Value '$val' is not a valid option.\n";
1089 $retry_msg .= "Please enter a value";
1090 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1091 $val = prompt($retry_msg, $default);
1096 =head2 get_target_directories
1098 Creates a hash mapping from symbols for installation target
1099 directories to actual directory paths.
1101 Also returns a hash indicating targets for which
1102 files need not be copied -- this is used for the 'dev'
1103 mode installation, where some files are installed in place.
1107 sub get_target_directories {
1110 my $base = $config->{'INSTALL_BASE'};
1111 my $mode = $config->{'INSTALL_MODE'};
1113 # get last component of install base directory
1114 # to treat as package name
1115 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1117 my @basedir = File::Spec->splitdir($directories);
1119 # for Win32 we need to prepend the volume to the directory path
1120 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1121 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1123 my $package = pop @basedir;
1128 if ($mode eq 'single') {
1129 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1130 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1131 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1132 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1133 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1134 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1135 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1136 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1137 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1138 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1139 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1140 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1141 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1142 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1143 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1144 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1145 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1146 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1147 } elsif ($mode eq 'dev') {
1148 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1149 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1150 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1151 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1152 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1153 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1154 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1155 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1156 $skipdirs{'OPAC_CGI_DIR'} = 1;
1157 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1158 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1159 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1160 $skipdirs{'OPAC_WWW_DIR'} = 1;
1161 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1162 $skipdirs{'PERL_MODULE_DIR'} = 1;
1163 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1164 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1165 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1166 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1167 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1168 $skipdirs{'SCRIPT_DIR'} = 1;
1169 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1170 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1171 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1172 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1173 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1174 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1176 # mode is standard, i.e., 'fhs'
1177 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1178 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1179 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1180 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1181 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1182 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1183 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1184 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1185 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1186 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1187 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1188 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1189 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1190 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1191 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1192 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1193 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1194 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1197 _get_env_overrides(\%dirmap);
1198 _get_argv_overrides(\%dirmap);
1200 return \%dirmap, \%skipdirs;
1203 sub _get_env_overrides {
1206 foreach my $key (keys %$dirmap) {
1207 if (exists $ENV{$key}) {
1208 $dirmap->{$key} = $ENV{$key};
1209 print "Setting $key from environment\n";
1214 sub _get_argv_overrides {
1218 for (my $i = 0; $i <= $#ARGV; $i++) {
1219 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1222 push @new_argv, $ARGV[$i];
1228 sub display_configuration {
1231 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1232 foreach my $key (sort keys %$config) {
1233 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1236 print "\nand in the following directories:\n\n";
1237 foreach my $key (sort keys %$dirmap) {
1238 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1240 print "\n\nTo change any configuration setting, please run\n";
1241 print "perl Makefile.PL again. To override one of the target\n";
1242 print "directories, you can do so on the command line like this:\n";
1243 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1244 print "You can also set different default values for parameters\n";
1245 print "or override directory locations by using environment variables.\n";
1246 print "\nFor example:\n\n";
1247 print "export DB_USER=my_koha\n";
1248 print "perl Makefile.PL\n";
1250 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1255 # This will have to be reworked in order to accommodate Win32...
1259 my $test = $self->SUPER::test(@_);
1260 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1263 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1270 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1271 # This means that we're completely overriding EU::MM's default
1272 # installation and uninstallation targets.
1274 # If installation is on Win32, we need to do permissions different from *nix
1275 if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1276 foreach my $key (sort keys %$target_directories) {
1278 KOHA_INST_$key = blib/$key
1279 KOHA_DEST_$key = $target_directories->{$key}
1280 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1283 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1284 \t\$(NOECHO) \$(NOOP)
1286 $install .= "install_koha ::\n";
1287 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1288 foreach my $key (sort keys %$target_directories) {
1289 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1290 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1292 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1293 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1296 $install .= "set_koha_ownership ::\n";
1297 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1298 foreach my $key (sort keys %$target_directories) {
1299 $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1300 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1303 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1307 $install .= "set_koha_permissions ::\n";
1308 # This is necessary because EU::MM installs files
1309 # as either 0444 or 0555, and we want the owner
1310 # of Koha's files to have write permission by default.
1311 foreach my $key (sort keys %$target_directories) {
1312 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1313 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1316 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1317 # We can attempt some creative things with command line utils such as CACLS which allows permission
1318 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1319 foreach my $key (sort keys %$target_directories) {
1321 KOHA_INST_$key = blib/$key
1322 KOHA_DEST_$key = $target_directories->{$key}
1323 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1326 install :: all install_koha warn_koha_env_vars
1327 \t\$(NOECHO) \$(NOOP)
1329 $install .= "install_koha ::\n";
1330 $install .= "\t\$(MOD_INSTALL) \\\n";
1331 foreach my $key (sort keys %$target_directories) {
1332 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1333 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1338 $install .= "warn_koha_env_vars ::\n";
1339 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1340 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1341 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1342 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1343 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1344 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1345 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1346 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1347 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1348 $install .= "\t\$(NOECHO) \$(ECHO) If installing on a Win32 platform, be sure to use:\n";
1349 $install .= "\t\$(NOECHO) \$(ECHO) 'dmake -x MAXLINELENGTH=300000'\n";
1350 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1351 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1352 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1354 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1355 $install .= _update_zebra_conf_target();
1361 =head2 _update_zebra_conf_target
1363 Add an installation target for updating
1364 Zebra's configuration files.
1368 sub _update_zebra_conf_target {
1370 my $target = "\nupdate_zebra_conf ::\n";
1371 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1372 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1373 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1374 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1375 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1376 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1382 # put directory mappings into Makefile
1383 # so that Make will export as environment
1384 # variables -- this is for the use of
1387 # quote '$' in the two password parameters
1388 my %config = %config;
1389 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1390 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1391 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1394 # Hereagain, we must alter syntax per platform...
1395 if ( $^O eq 'MSWin32' ) {
1396 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1397 my $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1399 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1403 my $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1405 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1416 ExtUtils::MakeMaker(3)
1420 MJ Ray mjr at phonecoop.coop
1421 Galen Charlton galen.charlton at liblime.com
1424 FIXME: deal with .htaccess