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.
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 './errors' => {target => 'INTRANET_CGI_DIR'},
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.69,
538 'HTTP::Cookies' => 1.39,
539 'HTTP::Request::Common' => 1.26,
540 'Image::Magick' => 6.2,
541 'LWP::Simple' => 1.41,
542 'LWP::UserAgent' => 2.033,
543 'Lingua::Stem' => 0.82,
544 'List::Util' => 1.18,
545 'List::MoreUtils' => 0.21,
546 'Locale::Language' => 2.07,
547 'MARC::Charset' => 0.98,
548 'MARC::Crosswalk::DublinCore' => 0.02,
549 'MARC::File::XML' => 0.88,
550 'MARC::Record' => 2.00,
551 'MIME::Base64' => 3.07,
552 'MIME::QuotedPrint' => 3.07,
553 'Mail::Sendmail' => 0.79,
555 'Net::LDAP::Filter' => 0.14,
556 'Net::Z3950::ZOOM' => 1.16,
557 'PDF::API2' => 2.000,
558 'PDF::API2::Page' => 2.000,
559 'PDF::API2::Util' => 2.000,
560 'PDF::Reuse' => 0.33,
561 'PDF::Reuse::Barcode' => 0.05,
564 'Schedule::At' => 1.06,
565 'Term::ANSIColor' => 1.10,
567 'Test::Harness' => 2.56,
568 'Test::More' => 0.62,
570 'Text::CSV_XS' => 0.32,
571 'Text::Iconv' => 1.7,
572 'Text::Wrap' => 2005.082401,
573 'Time::HiRes' => 1.86,
574 'Time::localtime' => 1.02,
575 'Unicode::Normalize' => 0.32,
576 'XML::Dumper' => 0.81,
577 'XML::LibXML' => 1.59,
578 'XML::LibXSLT' => 1.59,
579 'XML::SAX::ParserFactory' => 1.01,
580 'XML::Simple' => 2.14,
582 'YAML::Syck' => 0.71,
588 # Man pages generated from POD
589 INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
590 INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
592 PL_FILES => $pl_files,
600 This function recurses through the directory structure and builds
601 a hash of hashes containing the structure with arrays holding filenames.
602 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
608 opendir my $dh, $dir or die $!;
609 my $tree = {}->{$dir} = {};
610 while( my $file = readdir($dh) ) {
611 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
612 my $path = $dir .'/' . $file;
613 $tree->{$file} = hashdir($path), next if -d $path;
614 push @{$tree->{'.'}}, $file;
621 This function combines the target_map and file hash to
622 map each source file to its destination relative to
623 the set of installation targets.
625 Output will be a hash mapping from each source file
626 to its destination value, like this:
628 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
633 my $target_map = shift;
635 my $file_map = shift;
636 my $install_zebra = shift;
637 my $curr_path = @_ ? shift : ['.'];
639 # Traverse the directory tree.
640 # For each file or directory, identify the
641 # most specific match in the target_map
642 foreach my $dir (sort keys %{ $dirtree }) {
644 # deal with files in directory
645 foreach my $file (sort @{ $dirtree->{$dir} }) {
646 my $targetdir = undef;
647 my $matchlevel = undef;
648 # first, see if there is a match on this specific
649 # file in the target map
650 my $filepath = join("/", @$curr_path, $file);
651 if (exists $target_map->{$filepath}) {
652 $targetdir = $target_map->{$filepath};
653 $matchlevel = scalar(@$curr_path) + 1;
655 # no match on the specific file; look for
657 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
658 my $dirpath = join("/", @$curr_path[0..$i]);
659 if (exists $target_map->{$dirpath}) {
660 $targetdir = $target_map->{$dirpath};
661 $matchlevel = $i + 1;
666 if (defined $targetdir) {
667 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
669 my $path = join("/", @$curr_path);
670 print "failed to map: $path/$file\n" if $DEBUG;
674 # dealing with subdirectory
675 push @$curr_path, $dir;
676 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
682 sub _add_to_file_map {
683 my $file_map = shift;
684 my $targetdir = shift;
685 my $curr_path = shift;
687 my $matchlevel = shift;
688 my $install_zebra = shift;
689 my $dest_path = @_ ? shift : $curr_path;
691 # The target can be one of the following:
692 # 1. scalar representing target symbol
693 # 2. hash ref containing target and trimdir keys
695 # Consequently, this routine traverses this structure,
696 # calling itself recursively, until it deals with
697 # all of the scalar target symbols.
698 if (ref $targetdir eq 'HASH') {
699 my $subtarget = $targetdir->{target};
700 if (exists $targetdir->{trimdir}) {
701 # if we get here, we've specified that
702 # rather than installing the file to
703 # $(TARGET)/matching/dirs/subdirs/file,
704 # we want to install it to
705 # $(TARGET)/subdirs/file
707 # Note that this the only place where
708 # $matchlevel is used.
709 my @new_dest_path = @$dest_path;
710 if ($targetdir->{trimdir} == -1) {
711 splice @new_dest_path, 0, $matchlevel;
713 splice @new_dest_path, 0, $targetdir->{trimdir};
715 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
717 # actually getting here means that the
718 # target was unnecessarily listed
719 # as a hash, but we'll forgive that
720 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
722 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
723 my $source = File::Spec->catfile(@$curr_path, $file);
724 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
725 #print "$source => $destination\n"; # DEBUG
726 # quote spaces in file names
727 # FIXME: this is of questionable portability and
728 # probably depends on user's make recognizing this
729 # quoting syntax -- probably better to remove
730 # spaces and shell metacharacters from all file names
731 $source =~ s/ /\\ /g;
732 $destination =~ s/ /\\ /g;
734 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
738 =head2 get_install_log_values
740 Reads value from the Koha install log specified by
745 sub get_install_log_values {
746 my $install_log = shift;
749 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
752 next if /^#/ or /^\s*$/;
756 my ($key, $value) = split /=/, $_, 2;
757 $values->{$key} = $value;
761 print <<_EXPLAIN_INSTALL_LOG_;
762 Reading values from install log $install_log. You
763 will be prompted only for settings that have been
764 added since the last time you installed Koha. To
765 be prompted for all settings, run 'perl Makefile.PL'
766 without the --prev-install-log option.
767 _EXPLAIN_INSTALL_LOG_
770 =head2 get_configuration
772 This prompts the user for various configuration options.
776 sub get_configuration {
777 my $defaults = shift;
778 my $valid_values = shift;
779 my $install_log_values = shift;
783 By default, Koha can be installed in one of three ways:
785 standard: Install files in conformance with the Filesystem
786 Hierarchy Standard (FHS). This is the default mode
787 and should be used when installing a production
788 Koha system. On Unix systems, root access is
789 needed to complete a standard installation.
791 single: Install files under a single directory. This option
792 is useful for installing Koha without root access, e.g.,
793 on a web host that allows CGI scripts and MySQL databases
794 but requires the user to keep all files under the user's
797 dev: Create a set of symbolic links and configuration files to
798 allow Koha to run directly from the source distribution.
799 This mode is useful for developers who want to run
800 Koha from a git clone.
803 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
804 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
806 # set message and default value for INSTALL_BASE
807 # depending on value of INSTALL_MODE
808 my $install_base_default = $defaults->{'INSTALL_BASE'};
809 if ($config{'INSTALL_MODE'} eq 'dev') {
811 Please specify the directory in which to install Koha's
812 active configuration files and (if applicable) the
813 Zebra database. Koha's CGI scripts and templates will
814 be run from the current directory.
816 Configuration directory:);
817 # FIXME - home directory portability consideration apply
818 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
819 } elsif ($config{'INSTALL_MODE'} eq 'single') {
820 $msg = "\nPlease specify the directory in which to install Koha";
821 # FIXME -- we're assuming under a 'single' mode install
822 # that user will likely want to install under the home
823 # directory. This is OK in and of itself, but we should
824 # use File::HomeDir to locate the home directory portably.
825 # This is deferred for now because File::HomeDir is not yet
827 # --we must also keep this portable to the major OS's -fbcit
828 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
832 Please specify the directory under which most Koha files
835 Note that if you are planning in installing more than
836 one instance of Koha, you may want to modify the last
837 component of the directory path, which will be used
838 as the package name in the FHS layout.
840 Base installation directory);
842 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
844 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
845 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
846 if ($config{'INSTALL_MODE'} eq "standard") {
848 Since you are using the 'standard' install
849 mode, you should run 'make install' as root.
850 However, it is recommended that a non-root
851 user (on Unix and Linux platforms) have
852 ownership of Koha's files, including the
853 Zebra indexes if applicable.
855 Please specify a user account. This
856 user account does not need to exist
857 right now, but it needs to exist
858 before you run 'make install'. Please
859 note that for security reasons, this
860 user should not be the same as the user
861 account Apache runs under.
864 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
867 Please specify the group that should own
868 Koha's files. As above, this group need
869 not exist right now, but should be created
870 before you run 'make install'.
873 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
877 Please specify which database engine you will use
878 to store data in Koha. The choices are MySQL and
879 PostgreSQL; please note that at the moment
880 PostgreSQL support is highly experimental.
883 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
884 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
887 Please specify the name or address of your
888 database server. Note that the database
889 does not have to exist at this point, it
890 can be created after running 'make install'
891 and before you try using Koha for the first time.
894 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
897 Please specify the port used to connect to the
899 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
900 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
903 Please specify the name of the database to be
905 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
908 Please specify the user that owns the database to be
910 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
913 Please specify the password of the user that owns the
914 database to be used by Koha);
915 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
918 Koha can use the Zebra search engine for high-performance
919 searching of bibliographic and authority records. If you
920 have installed the Zebra software and would like to use it,
921 please answer 'yes' to the following question. Otherwise,
922 Koha will default to using its internal search engine.
924 Please note that if you choose *NOT* to install Zebra,
925 koha-conf.xml will still contain some references to Zebra
926 settings. Those references will be ignored by Koha.
928 Install the Zebra configuration files?);
929 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
930 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
932 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
934 Since you've chosen to use Zebra with Koha,
935 you must specify the primary MARC format of the
936 records to be indexed by Zebra.
938 Koha provides Zebra configuration files for MARC 21
941 MARC format for Zebra indexing);
942 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
943 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
945 Koha supplies Zebra configuration files tuned for
946 searching either English (en) or French (fr) MARC
949 Primary language for Zebra indexing);
950 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
951 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
954 Koha can use one of two different indexing modes
955 for the MARC authorities records:
957 grs1 - uses the Zebra GRS-1 filter, available
959 dom - uses the DOM XML filter; offers improved
962 Authorities indexing mode);
963 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
964 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
967 Please specify Zebra database user);
968 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
971 Please specify the Zebra database password);
972 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
975 Since you've chosen to use Zebra, you can enable the SRU/
976 Z39.50 Server if you so choose, but you must specify a
977 few configuration options for it.
979 Please note that if you choose *NOT* to configure SRU,
980 koha-conf.xml will still contain some references to SRU
981 settings. Those references will be ignored by Koha.
983 Install the SRU configuration files?);
984 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
985 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
987 if ($config{'INSTALL_SRU'} eq 'yes') {
989 Since you've chosen to configure SRU, you must
990 specify the host and port(s) that the SRU
991 Servers (bibliographic and authority) should run on.
995 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
998 SRU port for bibliographic data?);
999 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1002 SRU port for authority data?);
1003 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1008 Since you've chosen to use Zebra, you can also choose to
1009 install PazPar2, which is a metasearch tool. With PazPar2,
1010 Koha can perform on-the-fly merging of bibliographic
1011 records during searching, allowing for FRBRization of
1014 Install the PazPar2 configuration files?);
1015 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1016 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1018 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1020 Since you've chosen to configure PazPar2, you must
1021 specify the host and port(s) that PazPar2
1025 Zebra bibliographic server host?);
1026 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1029 Zebra bibliographic port for PazPar2 to use?);
1030 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1034 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1038 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1045 # add version number
1046 my $version = "no_version_found";
1048 require 'kohaversion.pl';
1049 $version = kohaversion();
1051 $config{'KOHA_INSTALLED_VERSION'} = $version;
1056 sub _add_valid_values_disp {
1058 my $valid_values = shift;
1061 if (exists $valid_values->{$key}) {
1062 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1070 my $default = shift;
1071 my $valid_values = shift;
1072 my $install_log_values = shift;
1074 # take value from install log if present
1075 if (exists $install_log_values{$key}) {
1076 return $install_log_values{$key};
1079 # override default value from environment
1080 if (exists $ENV{$key}) {
1081 $default = $ENV{$key};
1082 $msg .= " (default from environment)";
1085 my $val = prompt($msg, $default);
1087 while (exists $valid_values->{$key} and
1088 $val ne $default and
1089 not exists $valid_values->{$key}->{$val}) {
1090 my $retry_msg = "Value '$val' is not a valid option.\n";
1091 $retry_msg .= "Please enter a value";
1092 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1093 $val = prompt($retry_msg, $default);
1098 =head2 get_target_directories
1100 Creates a hash mapping from symbols for installation target
1101 directories to actual directory paths.
1103 Also returns a hash indicating targets for which
1104 files need not be copied -- this is used for the 'dev'
1105 mode installation, where some files are installed in place.
1109 sub get_target_directories {
1112 my $base = $config->{'INSTALL_BASE'};
1113 my $mode = $config->{'INSTALL_MODE'};
1115 # get last component of install base directory
1116 # to treat as package name
1117 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1119 my @basedir = File::Spec->splitdir($directories);
1121 # for Win32 we need to prepend the volume to the directory path
1122 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1123 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1125 my $package = pop @basedir;
1130 if ($mode eq 'single') {
1131 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1132 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1133 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1134 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1135 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1136 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1137 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1138 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1139 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1140 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1141 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1142 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1143 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1144 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1145 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1146 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1147 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1148 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1149 } elsif ($mode eq 'dev') {
1150 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1151 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1152 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1153 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1154 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1155 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1156 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1157 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1158 $skipdirs{'OPAC_CGI_DIR'} = 1;
1159 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1160 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1161 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1162 $skipdirs{'OPAC_WWW_DIR'} = 1;
1163 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1164 $skipdirs{'PERL_MODULE_DIR'} = 1;
1165 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1166 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1167 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1168 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1169 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1170 $skipdirs{'SCRIPT_DIR'} = 1;
1171 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1172 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1173 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1174 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1175 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1176 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1178 # mode is standard, i.e., 'fhs'
1179 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1180 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1181 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1182 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1183 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1184 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1185 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1186 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1187 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1188 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1189 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1190 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1191 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1192 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1193 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1194 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1195 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1196 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1199 _get_env_overrides(\%dirmap);
1200 _get_argv_overrides(\%dirmap);
1202 return \%dirmap, \%skipdirs;
1205 sub _get_env_overrides {
1208 foreach my $key (keys %$dirmap) {
1209 if (exists $ENV{$key}) {
1210 $dirmap->{$key} = $ENV{$key};
1211 print "Setting $key from environment\n";
1216 sub _get_argv_overrides {
1220 for (my $i = 0; $i <= $#ARGV; $i++) {
1221 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1224 push @new_argv, $ARGV[$i];
1230 sub display_configuration {
1233 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1234 foreach my $key (sort keys %$config) {
1235 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1238 print "\nand in the following directories:\n\n";
1239 foreach my $key (sort keys %$dirmap) {
1240 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1242 print "\n\nTo change any configuration setting, please run\n";
1243 print "perl Makefile.PL again. To override one of the target\n";
1244 print "directories, you can do so on the command line like this:\n";
1245 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1246 print "You can also set different default values for parameters\n";
1247 print "or override directory locations by using environment variables.\n";
1248 print "\nFor example:\n\n";
1249 print "export DB_USER=my_koha\n";
1250 print "perl Makefile.PL\n";
1252 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1253 print "If installing on a Win32 platform, be sure to use:\n";
1254 print "'dmake -x MAXLINELENGTH=300000'\n\n";
1259 # This will have to be reworked in order to accommodate Win32...
1263 my $test = $self->SUPER::test(@_);
1264 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1267 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1274 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1275 # This means that we're completely overriding EU::MM's default
1276 # installation and uninstallation targets.
1278 # If installation is on Win32, we need to do permissions different from *nix
1279 if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1280 foreach my $key (sort keys %$target_directories) {
1282 KOHA_INST_$key = blib/$key
1283 KOHA_DEST_$key = $target_directories->{$key}
1284 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1287 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1288 \t\$(NOECHO) \$(NOOP)
1290 $install .= "install_koha ::\n";
1291 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1292 foreach my $key (sort keys %$target_directories) {
1293 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1294 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1296 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1297 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1300 $install .= "set_koha_ownership ::\n";
1301 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1302 foreach my $key (sort keys %$target_directories) {
1303 $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1304 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1307 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1311 $install .= "set_koha_permissions ::\n";
1312 # This is necessary because EU::MM installs files
1313 # as either 0444 or 0555, and we want the owner
1314 # of Koha's files to have write permission by default.
1315 foreach my $key (sort keys %$target_directories) {
1316 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1317 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1320 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1321 # We can attempt some creative things with command line utils such as CACLS which allows permission
1322 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1323 foreach my $key (sort keys %$target_directories) {
1325 KOHA_INST_$key = blib/$key
1326 KOHA_DEST_$key = $target_directories->{$key}
1327 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1330 install :: all install_koha warn_koha_env_vars
1331 \t\$(NOECHO) \$(NOOP)
1333 $install .= "install_koha ::\n";
1334 $install .= "\t\$(MOD_INSTALL) \\\n";
1335 foreach my $key (sort keys %$target_directories) {
1336 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1337 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1342 $install .= "warn_koha_env_vars ::\n";
1343 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1344 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1345 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1346 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1347 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1348 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1349 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1350 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1351 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1352 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1353 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1355 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1356 $install .= _update_zebra_conf_target();
1359 $install .= upgrade();
1364 =head2 _update_zebra_conf_target
1366 Add an installation target for updating
1367 Zebra's configuration files.
1371 sub _update_zebra_conf_target {
1373 my $target = "\nupdate_zebra_conf ::\n";
1374 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1375 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1376 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1377 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1378 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1379 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1388 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1389 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1390 $version =~ s/\./_/g;
1391 $backup_suffix = "_koha_$version";
1393 $backup_suffix = "_upgrade_backup";
1397 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1399 upgrade :: make_upgrade_backup install
1400 \t\$(NOECHO) \$(NOOP)
1401 make_upgrade_backup ::
1402 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1404 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1405 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1406 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1407 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1408 exists $skip_directories->{$key} or
1409 not exists $target_directories->{$key};
1411 $upgrade =~ s/\\\n$/\n/;
1417 # put directory mappings into Makefile
1418 # so that Make will export as environment
1419 # variables -- this is for the use of
1422 # quote '$' in the two password parameters
1423 my %config = %config;
1424 $config{'DB_PASS'} =~ s/\$/\$\$/g;
1425 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1426 $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1429 # Hereagain, we must alter syntax per platform...
1430 if ( $^O eq 'MSWin32' ) {
1431 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1432 my $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1434 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1438 my $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1440 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1451 ExtUtils::MakeMaker(3)
1455 MJ Ray mjr at phonecoop.coop
1456 Galen Charlton galen.charlton at liblime.com
1459 FIXME: deal with .htaccess