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;
29 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
31 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
33 my $dirtree = hashdir('.');
38 Makefile.PL - Koha packager and installer
42 =head2 BASIC INSTALLATION
48 =head2 PACKAGING RELEASE TARBALLS
59 This is a packager and installer that uses
60 ExtUtils::MakeMaker, which is fairly common
62 As well as building tar or zip files
63 and installing with the above commands,
64 it allows us to check pre-requisites
65 and generate configuration files.
69 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
71 Basic metadata about this software.
75 Suppress generation of META.yml file.
79 Hash of perl modules and versions required.
87 This is a hash of PL scripts to run after installation and
88 the files to ask them to generate.
89 Maybe use the values from CONFIGURE
90 to generate initial configuration files in future.
96 This is a hash mapping directories and files in the
97 source tree to installation target directories. The rules
102 =item If a directory or file is specified, it and its
103 contents will be copied to the installation target directory.
105 =item If a subdirectory of a mapped directory is specified,
106 its target overrides the parent's target for that subdirectory.
108 =item The value of each map entry may either be a scalar containing
109 one target or a reference to a hash containing 'target' and 'trimdir'
112 =item Any files at the top level of the source tree that are
113 not included in the map will not be installed.
115 =item Any directories at the top level of the source tree
116 that are not included in the map will be installed in
117 INTRANET_CGI_DIR. This is a sensible default given the
118 current organization of the source tree, but (FIXME) it
119 would be better to reorganize the source tree to better
120 match the installation system, to allow adding new directories
121 without having to adjust Makefile.PL each time. The idea
122 is to make the C<$target_map> hash as minimal as possible.
126 The permitted installation targets are:
130 =item INTRANET_CGI_DIR
132 CGI scripts for intranet (staff) interface.
134 =item INTRANET_TMPL_DIR
136 HTML templates for the intranet interface.
138 =item INTRANET_WWW_DIR
140 HTML files, images, etc. for DocumentRoot for the intranet interface.
144 CGI scripts for OPAC (public) interface.
148 HTML templates for the OPAC interface.
152 HTML files, images, etc. for DocumentRoot for the OPAC interface.
154 =item PERL_MODULE_DIR
156 Perl modules (at present just the C4 modules) that are intimately
157 tied to Koha. Depending on the installation options, these
158 may or may not be installed one of the standard directories
159 in Perl's default @LIB.
163 Directory for Koha configuration files.
167 Directory for Zebra configuration files.
171 Directory for Zebra's lock files.
175 Directory for Zebra's data files.
179 Directory for Zebra's UNIX-domain sockets.
183 Directory for for miscellaenous scripts, among other
184 things the translation toolkit and RSS feed tools.
188 Directory for command-line scripts and daemons.
192 Directory for man pages created from POD -- will mostly
193 contain information of interest to Koha developers.
197 Directory for Koha documentation accessed from the
198 command-line, e.g., READMEs.
202 Directory for Apache and Zebra logs produced by Koha.
206 This is a dummy target used to explicitly state
207 that a given file or directory is not to be installed.
208 This is used either for parts of the installer itself
209 or for development tools that are not applicable to a
210 production installation.
217 './about.pl' => 'INTRANET_CGI_DIR',
218 './acqui' => 'INTRANET_CGI_DIR',
219 './admin' => 'INTRANET_CGI_DIR',
220 './authorities' => 'INTRANET_CGI_DIR',
221 './C4' => 'PERL_MODULE_DIR',
222 './C4/SIP/t' => 'NONE',
223 './C4/SIP/koha_test' => 'NONE',
224 './C4/tests' => 'NONE',
225 './catalogue' => 'INTRANET_CGI_DIR',
226 './cataloguing' => 'INTRANET_CGI_DIR',
227 './changelanguage.pl' => 'INTRANET_CGI_DIR',
228 './check_sysprefs.pl' => 'NONE',
229 './circ' => 'INTRANET_CGI_DIR',
230 './edithelp.pl' => 'INTRANET_CGI_DIR',
231 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
232 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
233 './help.pl' => 'INTRANET_CGI_DIR',
234 './installer-CPAN.pl' => 'NONE',
235 './installer' => 'INTRANET_CGI_DIR',
236 './koha-tmpl/errors' => {target => 'INTRANET_CGI_DIR', trimdir => 2},
237 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
238 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
239 './kohaversion.pl' => 'INTRANET_CGI_DIR',
240 './labels' => 'INTRANET_CGI_DIR',
241 './mainpage.pl' => 'INTRANET_CGI_DIR',
242 './Makefile.PL' => 'NONE',
243 './MANIFEST.SKIP' => 'NONE',
244 './members' => 'INTRANET_CGI_DIR',
245 './misc' => { target => 'SCRIPT_DIR', trimdir => -1 },
246 './misc/info' => { target => 'DOC_DIR', trimdir => 2 },
247 './misc/release notes' => { target => 'DOC_DIR', trimdir => 2 },
248 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
249 './misc/installer_devel_notes' => 'NONE',
250 './opac' => 'OPAC_CGI_DIR',
251 './README.txt' => 'NONE',
252 './reports' => 'INTRANET_CGI_DIR',
253 './reserve' => 'INTRANET_CGI_DIR',
254 './reviews' => 'INTRANET_CGI_DIR',
255 './rewrite-config.PL' => 'NONE',
256 './reviews' => 'INTRANET_CGI_DIR',
257 './rss' => 'MISC_DIR',
258 './serials' => 'INTRANET_CGI_DIR',
260 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
261 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
262 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
263 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
264 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
265 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
266 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
267 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
268 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
269 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
270 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
271 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
272 './sms' => 'INTRANET_CGI_DIR',
273 './suggestion' => 'INTRANET_CGI_DIR',
274 './svc' => 'INTRANET_CGI_DIR',
276 './tmp' => 'NONE', # FIXME need to determine whether
277 # Koha generates any persistent temp files
278 # that should go in /var/tmp/koha
279 './tools' => 'INTRANET_CGI_DIR',
280 './virtualshelves' => 'INTRANET_CGI_DIR',
281 # ignore files and directories created by the install itself
282 './pm_to_blib' => 'NONE',
286 =head1 CONFIGURATION OPTIONS
288 The following configuration options are used by the installer.
294 Specifies whether installation will be FHS-compliant (default,
295 assumes user has root), put everything under
296 a single directory (for users installing on a web host
297 that allows CGI scripts and a MySQL database but not root
298 access), or development (for a developer who wants to run
299 Koha from a git clone with no fuss).
303 Directory under which most components will go. Default
304 value will vary depending on INSTALL_MODE.
308 Type of DBMS (e.g., mysql or Pg).
316 Port that DBMS server is listening on.
320 Name of the DBMS database for Koha.
324 Name of DBMS user account for Koha's database.
328 Pasword of DMBS user account for Koha's database.
332 Whether to install Zebra configuration files and data
335 =item ZEBRA_MARC_FORMAT
337 Specifies format of MARC records to be indexed by Zebra.
341 Specifies primary language of records that will be
346 Internal Zebra user account for the index.
350 Internal Zebra user account's password.
354 System user account that will own Koha's files.
358 System group that will own Koha's files.
364 # default configuration options
365 my %config_defaults = (
366 'INSTALL_MODE' => 'standard',
367 'INSTALL_BASE' => '/usr/share/koha',
368 'DB_TYPE' => 'mysql',
369 'DB_HOST' => 'localhost',
371 'DB_USER' => 'kohaadmin',
372 'DB_PASS' => 'katikoan',
373 'INSTALL_ZEBRA' => 'yes',
374 'ZEBRA_MARC_FORMAT' => 'marc21',
375 'ZEBRA_LANGUAGE' => 'en',
376 'ZEBRA_USER' => 'kohauser',
377 'ZEBRA_PASS' => 'zebrastripes',
378 'KOHA_USER' => 'koha',
379 'KOHA_GROUP' => 'koha',
382 # valid values for certain configuration options
383 my %valid_config_values = (
384 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
385 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
386 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
387 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
388 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
391 my %config = get_configuration(\%config_defaults, \%valid_config_values);
392 my ($target_directories, $skip_directories) = get_target_directories(\%config);
393 display_configuration(\%config, $target_directories);
395 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
398 'rewrite-config.PL' => [
399 'blib/KOHA_CONF_DIR/koha-conf.xml',
400 'blib/KOHA_CONF_DIR/koha-httpd.conf',
404 if ($config{'INSTALL_ZEBRA'} eq "yes") {
405 push @{ $pl_files->{'rewrite-config.PL'} }, (
406 'blib/ZEBRA_CONF_DIR/etc/passwd',
407 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
408 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg'
414 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
415 VERSION_FROM => 'kohaversion.pl',
416 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
417 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
422 'CGI::Session' => '4.10',
423 'Class::Factory::Util' => 1.7,
424 'Class::Accessor' => 0.30,
425 'DBD::mysql' => 3.0008,
427 'Data::Dumper' => 2.121_08,
429 'Date::Manip' => 5.44,
430 'Digest::MD5' => 2.36,
431 'File::Temp' => 0.16,
432 'GD::Barcode::UPCE' => 1.1,
433 'Getopt::Long' => 2.35,
434 'Getopt::Std' => 1.05,
435 'HTML::Template::Pro' => 0.65,
436 'HTTP::Cookies' => 1.39,
437 'HTTP::Request::Common' => 1.26,
438 'LWP::Simple' => 1.41,
439 'LWP::UserAgent' => 2.033,
440 'Lingua::Stem' => 0.82,
441 'List::Util' => 1.18,
442 'Locale::Language' => 2.07,
443 'MARC::Charset' => 0.98,
444 'MARC::Crosswalk::DublinCore' => 0.03,
445 'MARC::File::XML' => 0.88,
446 'MARC::Record' => 2.00,
447 'MIME::Base64' => 3.07,
448 'MIME::QuotedPrint' => 3.07,
449 'Mail::Sendmail' => 0.79,
450 'Net::Z3950::ZOOM' => 1.16,
451 'PDF::API2' => 2.000,
452 'PDF::API2::Page' => 2.000,
453 'PDF::API2::Util' => 2.000,
454 'PDF::Reuse' => 0.33,
455 'PDF::Reuse::Barcode' => 0.05,
457 'Schedule::At' => 1.06,
458 'Term::ANSIColor' => 1.10,
460 'Test::Harness' => 2.56,
461 'Test::More' => 0.62,
463 'Text::CSV_XS' => 0.32,
464 'Text::Wrap' => 2005.082401,
465 'Time::HiRes' => 1.86,
466 'Time::localtime' => 1.02,
467 'Unicode::Normalize' => 0.32,
468 'XML::Dumper' => 0.81,
469 'XML::LibXML' => 1.59,
470 'XML::SAX::ParserFactory' => 1.01,
471 'XML::Simple' => 2.14,
478 # Man pages generated from POD
479 INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
480 INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
482 PL_FILES => $pl_files,
490 This function recurses through the directory structure and builds
491 a hash of hashes containing the structure with arrays holding filenames.
492 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
498 opendir my $dh, $dir or die $!;
499 my $tree = {}->{$dir} = {};
500 while( my $file = readdir($dh) ) {
501 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
502 my $path = $dir .'/' . $file;
503 $tree->{$file} = hashdir($path), next if -d $path;
504 push @{$tree->{'.'}}, $file;
511 This function combines the target_map and file hash to
512 map each source file to its destination relative to
513 the set of installation targets.
515 Output will be a hash mapping from each source file
516 to its destination value, like this:
518 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
523 my $target_map = shift;
525 my $file_map = shift;
526 my $install_zebra = shift;
527 my $curr_path = @_ ? shift : ['.'];
529 # Traverse the directory tree.
530 # For each file or directory, identify the
531 # most specific match in the target_map
532 foreach my $dir (sort keys %{ $dirtree }) {
534 # deal with files in directory
535 foreach my $file (sort @{ $dirtree->{$dir} }) {
536 my $targetdir = undef;
537 my $matchlevel = undef;
538 # first, see if there is a match on this specific
539 # file in the target map
540 my $filepath = join("/", @$curr_path, $file);
541 if (exists $target_map->{$filepath}) {
542 $targetdir = $target_map->{$filepath};
543 $matchlevel = scalar(@$curr_path) + 1;
545 # no match on the specific file; look for
547 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
548 my $dirpath = join("/", @$curr_path[0..$i]);
549 if (exists $target_map->{$dirpath}) {
550 $targetdir = $target_map->{$dirpath};
551 $matchlevel = $i + 1;
556 if (defined $targetdir) {
557 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
559 my $path = join("/", @$curr_path);
560 print "failed to map: $path/$file\n" if $DEBUG;
564 # dealing with subdirectory
565 push @$curr_path, $dir;
566 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
572 sub _add_to_file_map {
573 my $file_map = shift;
574 my $targetdir = shift;
575 my $curr_path = shift;
577 my $matchlevel = shift;
578 my $install_zebra = shift;
579 my $dest_path = @_ ? shift : $curr_path;
581 # The target can be one of the following:
582 # 1. scalar representing target symbol
583 # 2. hash ref containing target and trimdir keys
585 # Consequently, this routine traverses this structure,
586 # calling itself recursively, until it deals with
587 # all of the scalar target symbols.
588 if (ref $targetdir eq 'HASH') {
589 my $subtarget = $targetdir->{target};
590 if (exists $targetdir->{trimdir}) {
591 # if we get here, we've specified that
592 # rather than installing the file to
593 # $(TARGET)/matching/dirs/subdirs/file,
594 # we want to install it to
595 # $(TARGET)/subdirs/file
597 # Note that this the only place where
598 # $matchlevel is used.
599 my @new_dest_path = @$dest_path;
600 if ($targetdir->{trimdir} == -1) {
601 splice @new_dest_path, 0, $matchlevel;
603 splice @new_dest_path, 0, $targetdir->{trimdir};
605 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
607 # actually getting here means that the
608 # target was unnecessarily listed
609 # as a hash, but we'll forgive that
610 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
612 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
613 my $source = File::Spec->catfile(@$curr_path, $file);
614 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
615 #print "$source => $destination\n"; # DEBUG
616 # quote spaces in file names
617 # FIXME: this is of questionable portability and
618 # probably depends on user's make recognizing this
619 # quoting syntax -- probably better to remove
620 # spaces and shell metacharacters from all file names
621 $source =~ s/ /\\ /g;
622 $destination =~ s/ /\\ /g;
624 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
628 =head2 get_configuration_options
630 This prompts the user for various configuration options.
634 sub get_configuration {
635 my $defaults = shift;
636 my $valid_values = shift;
640 By default, Koha can be installed in one of three ways:
642 standard: Install files in conformance with the Filesystem
643 Hierarchy Standard (FHS). This is the default mode
644 and should be used when installing a production
645 Koha system. On Unix systems, root access is
646 needed to complete a standard installation.
648 single: Install files under a single directory. This option
649 is useful for installing Koha without root access, e.g.,
650 on a web host that allows CGI scripts and MySQL databases
651 but requires the user to keep all files under the user's
654 dev: Create a set of symbolic links and configuration files to
655 allow Koha to run directly from the source distribution.
656 This mode is useful for developers who want to run
657 Koha from a git clone.
660 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
661 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values);
663 # set message and default value for INSTALL_BASE
664 # depending on value of INSTALL_MODE
665 my $install_base_default = $defaults->{'INSTALL_BASE'};
666 if ($config{'INSTALL_MODE'} eq 'dev') {
668 Please specify the directory in which to install Koha's
669 active configuration files and (if applicable) the
670 Zebra database. Koha's CGI scripts and templates will
671 be run from the current directory.
673 Configuration directory:);
674 # FIXME - home directory portability consideration apply
675 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "/usr/share/koha-dev";
676 } elsif ($config{'INSTALL_MODE'} eq 'single') {
677 $msg = "\nPlease specify the directory in which to install Koha";
678 # FIXME -- we're assuming under a 'single' mode install
679 # that user will likely want to install under the home
680 # directory. This is OK in and of itself, but we should
681 # use File::HomeDir to locate the home directory portably.
682 # This is deferred for now because File::HomeDir is not yet
684 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : "/usr/share/koha";
688 Please specify the directory under which most Koha files
691 Note that if you are planning in installing more than
692 one instance of Koha, you may want to modify the last
693 component of the directory path, which will be used
694 as the package name in the FHS layout.
696 Base installation directory);
698 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values);
699 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
701 if ($config{'INSTALL_MODE'} eq "standard") {
703 Since you are using the 'standard' install
704 mode, you should run 'make install' as root.
705 However, it is recommended that a non-root
706 user (on Unix and Linux platforms) have
707 ownership of Koha's files, including the
708 Zebra indexes if applicable.
710 Please specify a user account. This
711 user account does not need to exist
712 right now, but it needs to exist
713 before you run 'make install'. Please
714 note that for security reasons, this
715 user should not be the same as the user
716 account Apache runs under.
719 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values);
722 Please specify the group that should own
723 Koha's files. As above, this group need
724 not exist right now, but should be created
725 before you run 'make install'.
728 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values);
732 Please specify which database engine you will use
733 to store data in Koha. The choices are MySQL and
734 PostgreSQL; please note that at the moment
735 PostgreSQL support is highly experimental.
738 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
739 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values);
742 Please specify the name or address of your
743 database server. Note that the database
744 does not have to exist at this point, it
745 can be created after running 'make install'
746 and before you try using Koha for the first time.
749 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values);
752 Please specify the port used to connect to the
754 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
755 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values);
758 Please specify the name of the database to be
760 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values);
763 Please specify the user that owns the database to be
765 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values);
768 Please specify the password of the user that owns the
769 database to be used by Koha);
770 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values);
773 Koha can use the Zebra search engine for high-performance
774 searching of bibliographic and authority records. If you
775 have installed the Zebra software and would like to use it,
776 please answer 'yes' to the following question. Otherwise,
777 Koha will default to using its internal search engine.
779 Please note that if you choose *NOT* to install Zebra,
780 koha-conf.xml will still contain some references to Zebra
781 settings. Those references will be ignored by Koha.
783 Install the Zebra configuration files?);
784 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
785 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values);
787 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
789 Since you've chosen to use Zebra with Koha,
790 you must specify the primary MARC format of the
791 records to be indexed by Zebra.
793 Koha provides Zebra configuration files for MARC 21
796 MARC format for Zebra indexing);
797 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
798 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values);
800 Koha supplies Zebra configuration files tuned for
801 searching either English (en) or French (fr) MARC
804 Primary language for Zebra indexing);
805 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
806 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values);
809 Please specify Zebra database user);
810 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values);
813 Please specify the Zebra database password);
814 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values);
820 sub _add_valid_values_disp {
822 my $valid_values = shift;
825 if (exists $valid_values->{$key}) {
826 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
835 my $valid_values = shift;
837 my $val = prompt($msg, $default);
838 while (exists $valid_values->{$key} and not exists $valid_values->{$key}->{$val}) {
839 my $retry_msg = "Value '$val' is not a valid option.\n";
840 $retry_msg .= "Please enter a value";
841 $retry_msg .= _add_valid_values_disp($key, $valid_values);
842 $val = prompt($retry_msg, $default);
847 =head2 get_target_directories
849 Creates a hash mapping from symbols for installation target
850 directories to actual directory paths.
852 Also returns a hash indicating targets for which
853 files need not be copied -- this is used for the 'dev'
854 mode installation, where some files are installed in place.
858 sub get_target_directories {
861 my $base = $config->{'INSTALL_BASE'};
862 my $mode = $config->{'INSTALL_MODE'};
864 # get last component of install base directory
865 # to treat as package name
866 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
867 my @basedir = File::Spec->splitdir($directories);
868 my $package = pop @basedir;
872 if ($mode eq 'single') {
873 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
874 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
875 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
876 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
877 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
878 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
879 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
880 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
881 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
882 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
883 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
884 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
885 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
886 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
887 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
888 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
889 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
890 } elsif ($mode eq 'dev') {
891 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
892 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
893 $skipdirs{'INTRANET_CGI_DIR'} = 1;
894 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
895 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
896 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
897 $skipdirs{'INTRANET_WWW_DIR'} = 1;
898 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir, 'opac');
899 $skipdirs{'OPAC_CGI_DIR'} = 1;
900 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
901 $skipdirs{'OPAC_TMPL_DIR'} = 1;
902 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
903 $skipdirs{'OPAC_WWW_DIR'} = 1;
904 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
905 $skipdirs{'PERL_MODULE_DIR'} = 1;
906 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
907 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
908 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
909 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
910 $skipdirs{'SCRIPT_DIR'} = 1;
911 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
912 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
913 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
914 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
915 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
916 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
918 # mode is standard, i.e., 'fhs'
919 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
920 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
921 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
922 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
923 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
924 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
925 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
926 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
927 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
928 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
929 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
930 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
931 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
932 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
933 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
934 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
935 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
938 _get_argv_overrides(\%dirmap);
940 return \%dirmap, \%skipdirs;
943 sub _get_argv_overrides {
947 for (my $i = 0; $i <= $#ARGV; $i++) {
948 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
951 push @new_argv, $ARGV[$i];
957 sub display_configuration {
960 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
961 foreach my $key (sort keys %$config) {
962 print sprintf("%-25.25s%s\n", $key, $config->{$key});
965 print "\nand in the following directories:\n\n";
966 foreach my $key (sort keys %$dirmap) {
967 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
969 print "\n\nTo change any configuration setting, please run\n";
970 print "perl Makefile.PL again. To override one of the target\n";
971 print "directories, you can do so on the command line like this:\n";
972 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
979 my $test = $self->SUPER::test(@_);
980 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
987 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
988 # This means that we're completely overriding EU::MM's default
989 # installation and uninstallation targets.
990 foreach my $key (sort keys %$target_directories) {
992 KOHA_INST_$key = blib/$key
993 KOHA_DEST_$key = $target_directories->{$key}
994 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
998 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
999 \t\$(NOECHO) \$(NOOP)
1001 $install .= "install_koha ::\n";
1002 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1003 foreach my $key (sort keys %$target_directories) {
1004 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1005 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1007 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1008 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1011 $install .= "set_koha_ownership ::\n";
1012 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1013 foreach my $key (sort keys %$target_directories) {
1014 $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1015 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1018 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1022 $install .= "set_koha_permissions ::\n";
1023 # This is necessary because EU::MM installs files
1024 # as either 0444 or 0555, and we want the owner
1025 # of Koha's files to have write permission by default.
1026 foreach my $key (sort keys %$target_directories) {
1027 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1028 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1032 $install .= "warn_koha_env_vars ::\n";
1033 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1034 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1035 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1036 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1037 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1038 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1039 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1040 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1041 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1042 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1043 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1049 # put directory mappings into Makefile
1050 # so that Make will export as environment
1051 # variables -- this is for the use of
1053 my $env = join("\n", map { "export __${_}__ = $target_directories->{$_}" } keys %$target_directories);
1055 $env .= join("\n", map { "export __${_}__ = $config{$_}" } keys %config);
1064 ExtUtils::MakeMaker(3)
1068 MJ Ray mjr at phonecoop.coop
1069 Galen Charlton galen.charlton at liblime.com
1072 FIXME: deal with .htaccess