Bug 14534: Stop overdue_notices.pl from issuing the warning: Use of uninitialized...
[koha.git] / Makefile.PL
blob96d2fb7fa767c4ea85a2a96412cd9a904ced0016
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
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
18 # Current maintainer MJR http://mjr.towers.org.uk/
21 use strict;
22 use warnings;
23 use ExtUtils::MakeMaker;
24 use POSIX;
25 use File::Spec;
26 use Getopt::Long;
27 use FindBin; # we need to enforce which C4::Installer::PerlModule is used in case more than one is installed
29 use lib $FindBin::Bin;
31 use C4::Installer;
33 my $koha_pm = C4::Installer::PerlModules->new;
35 my $DEBUG = 0;
36 die "perl 5.10 or later required" unless ($] >= 5.010000);
38 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
40 my $dirtree = hashdir('.');
41 my %result = ();
43 =head1 NAME
45 Makefile.PL - Koha packager and installer
47 =head1 SYNOPSIS
49 =head2 BASIC INSTALLATION
51     perl Makefile.PL
52     make
53     make test
54     sudo make install
56 =head2 UPGRADE INSTALLATION
58     NOTE: This option is only available if koha-install-log exists.
60     perl Makefile.PL --prev-install-log /path/to/koha-install-log
62     make
63     make test
64     sudo make upgrade
66 =head2 PACKAGING RELEASE TARBALLS
68     make manifest tardist
69     make manifest zipdist
71 =head2 CLEANING UP
73         make clean
75 =head1 DESCRIPTION
77 This is a packager and installer that uses
78 ExtUtils::MakeMaker, which is fairly common
79 on perl systems.
80 As well as building tar or zip files
81 and installing with the above commands,
82 it allows us to check pre-requisites
83 and generate configuration files.
85 =head1 VARIABLES
87 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
89 Basic metadata about this software.
91 =head2 NO_META
93 Suppress generation of META.yml file.
95 =head2 PREREQ_PM
97 Hash of perl modules and versions required.
99 =head2 PM
101 Hash of file mappings
103 =head2 PL_FILES
105 This is a hash of PL scripts to run after installation and
106 the files to ask them to generate.
107 Maybe use the values from CONFIGURE
108 to generate initial configuration files in future.
110 =cut
112 =head2 target_map
114 This is a hash mapping directories and files in the
115 source tree to installation target directories.  The rules
116 for this mapping are:
118 =over 4
120 =item If a directory or file is specified, it and its
121 contents will be copied to the installation target directory.
123 =item If a subdirectory of a mapped directory is specified,
124 its target overrides the parent's target for that subdirectory.
126 =item The value of each map entry may either be a scalar containing
127 one target or a reference to a hash containing 'target' and 'trimdir'
128 keys.
130 =item Any files at the top level of the source tree that are
131 not included in the map will not be installed.
133 =item Any directories at the top level of the source tree
134 that are not included in the map will be installed in
135 INTRANET_CGI_DIR.  This is a sensible default given the
136 current organization of the source tree, but (FIXME) it
137 would be better to reorganize the source tree to better
138 match the installation system, to allow adding new directories
139 without having to adjust Makefile.PL each time.  The idea
140 is to make the C<$target_map> hash as minimal as possible.
142 =back
144 The permitted installation targets are:
146 =over 4
148 =item INTRANET_CGI_DIR
150 CGI scripts for intranet (staff) interface.
152 =item INTRANET_TMPL_DIR
154 HTML templates for the intranet interface.
156 =item INTRANET_WWW_DIR
158 HTML files, images, etc. for DocumentRoot for the intranet interface.
160 =item OPAC_CGI_DIR
162 CGI scripts for OPAC (public) interface.
164 =item OPAC_TMPL_DIR
166 HTML templates for the OPAC interface.
168 =item OPAC_WWW_DIR
170 HTML files, images, etc. for DocumentRoot for the OPAC interface.
172 =item PERL_MODULE_DIR
174 Perl modules (at present just the C4 modules) that are intimately
175 tied to Koha.  Depending on the installation options, these
176 may or may not be installed one of the standard directories
177 in Perl's default @LIB.
179 =item KOHA_CONF_DIR
181 Directory for Koha configuration files.
183 =item ZEBRA_CONF_DIR
185 Directory for Zebra configuration files.
187 =item ZEBRA_LOCK_DIR
189 Directory for Zebra's lock files.  This includes subdirs for authorities,
190 biblios, and the zebra rebuild function.  Any activity to reindex
191 zebra from koha should interlock here with rebuild_zebra.pl.
193 =item ZEBRA_DATA_DIR
195 Directory for Zebra's data files.
197 =item ZEBRA_RUN_DIR
199 Directory for Zebra's UNIX-domain sockets.
201 =item MISC_DIR
203 Directory for for miscellaenous scripts, among other
204 things the translation toolkit and RSS feed tools.
206 =item SCRIPT_DIR
208 Directory for command-line scripts and daemons to
209 be set up all for installation modes.
211 =item SCRIPT_NONDEV_DIR
213 Directory for command-line scripts that should
214 be installed in the same directory as the
215 SCRIPT_DIR target except 'dev' installs.
217 =item MAN_DIR
219 Directory for man pages created from POD -- will mostly
220 contain information of interest to Koha developers.
222 =item DOC_DIR
224 Directory for Koha documentation accessed from the
225 command-line, e.g., READMEs.
227 =item LOG_DIR
229 Directory for Apache and Zebra logs produced by Koha.
231 =item BACKUP_DIR
233 Directory for backup files produced by Koha.
235 =item PLUGINS_DIR
237 Directory for external Koha plugins.
239 =item PAZPAR2_CONF_DIR
241 Directory for PazPar2 configuration files.
243 =item NONE
245 This is a dummy target used to explicitly state
246 that a given file or directory is not to be installed.
247 This is used either for parts of the installer itself
248 or for development tools that are not applicable to a
249 production installation.
251 =back
253 =cut
255 my $target_map = {
256   './about.pl'                  => 'INTRANET_CGI_DIR',
257   './acqui'                     => 'INTRANET_CGI_DIR',
258   './admin'                     => 'INTRANET_CGI_DIR',
259   './authorities'               => 'INTRANET_CGI_DIR',
260   './basket'                    => 'INTRANET_CGI_DIR',
261   './C4'                        => 'PERL_MODULE_DIR',
262   './C4/SIP/t'                  => 'NONE',
263   './C4/SIP/koha_test'          => 'NONE',
264   './C4/tests'                  => 'NONE',
265   './catalogue'                 => 'INTRANET_CGI_DIR',
266   './cataloguing'               => 'INTRANET_CGI_DIR',
267   './changelanguage.pl'         => 'INTRANET_CGI_DIR',
268   './check_sysprefs.pl'         => 'NONE',
269   './circ'                      => 'INTRANET_CGI_DIR',
270   './course_reserves'           => 'INTRANET_CGI_DIR',
271   './docs/history.txt'          => { target => 'DOC_DIR', trimdir => -1 },
272   './offline_circ'              => 'INTRANET_CGI_DIR',
273   './edithelp.pl'               => 'INTRANET_CGI_DIR',
274   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
275   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
276   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
277   './help.pl'                   => 'INTRANET_CGI_DIR',
278   './installer-CPAN.pl'         => 'NONE',
279   './installer'                 => 'INTRANET_CGI_DIR',
280   './errors'                    => {target => 'INTRANET_CGI_DIR'},
281   './Koha'                      => 'PERL_MODULE_DIR',
282   './Koha.pm'                   => 'PERL_MODULE_DIR',
283   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
284   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
285   './kohaversion.pl'            => 'INTRANET_CGI_DIR', 
286   './labels'                    => 'INTRANET_CGI_DIR',
287   './mainpage.pl'               => 'INTRANET_CGI_DIR',
288   './Makefile.PL'               => 'NONE',
289   './MANIFEST.SKIP'             => 'NONE',
290   './members'                   => 'INTRANET_CGI_DIR',
291   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
292   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
293   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
294   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
295   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
296   './misc/installer_devel_notes' => 'NONE',
297   './opac'                      => 'OPAC_CGI_DIR',
298   './OpenILS'                   => 'PERL_MODULE_DIR',
299   './README.txt'                => 'NONE',
300   './patroncards'               => 'INTRANET_CGI_DIR',
301   './patron_lists'              => 'INTRANET_CGI_DIR',
302   './plugins'                   => 'INTRANET_CGI_DIR',
303   './reports'                   => 'INTRANET_CGI_DIR',
304   './reserve'                   => 'INTRANET_CGI_DIR',
305   './reviews'                   => 'INTRANET_CGI_DIR',
306   './rewrite-config.PL'         => 'NONE',
307   './reviews'                   => 'INTRANET_CGI_DIR',
308   './rotating_collections'      => 'INTRANET_CGI_DIR',
309   './serials'                   => 'INTRANET_CGI_DIR',
310   './services'                  => 'INTRANET_CGI_DIR',
311   './skel'                      => 'NONE',
312   './skel/var/log/koha'         => { target => 'LOG_DIR', trimdir => -1 },
313   './skel/var/spool/koha'       => { target => 'BACKUP_DIR', trimdir => -1 },
314   './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
315   './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
316   './skel/var/lib/koha/zebradb/authorities/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
317   './skel/var/lib/koha/zebradb/authorities/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
318   './skel/var/lib/koha/zebradb/authorities/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
319   './skel/var/lib/koha/zebradb/authorities/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
320   './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
321   './skel/var/lib/koha/zebradb/biblios/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
322   './skel/var/lib/koha/zebradb/biblios/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
323   './skel/var/lib/koha/zebradb/biblios/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
324   './skel/var/lib/koha/zebradb/biblios/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
325   './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
326   './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
327   './sms'                       => 'INTRANET_CGI_DIR',
328   './suggestion'                => 'INTRANET_CGI_DIR',
329   './svc'                       => 'INTRANET_CGI_DIR',
330   './t'                         => 'NONE',
331   './tags'                      => 'INTRANET_CGI_DIR',
332   './tmp'                       => 'NONE', # FIXME need to determine whether
333                                            # Koha generates any persistent temp files
334                                            # that should go in /var/tmp/koha
335   './tools'                     => 'INTRANET_CGI_DIR',
336   './virtualshelves'            => 'INTRANET_CGI_DIR',
337   './xml_sax.pl'                => 'PERL_MODULE_DIR',
338   # ignore files and directories created by the install itself
339   './pm_to_blib'                => 'NONE',
340   './blib'                      => 'NONE',
343 =head1 CONFIGURATION OPTIONS
345 The following configuration options are used by the installer.
347 =over 4
349 =item INSTALL_MODE
351 Specifies whether installation will be FHS-compliant (default,
352 assumes user has root), put everything under
353 a single directory (for users installing on a web host
354 that allows CGI scripts and a MySQL database but not root
355 access), or development (for a developer who wants to run
356 Koha from a git clone with no fuss).
358 =item INSTALL_BASE
360 Directory under which most components will go.  Default
361 value will vary depending on INSTALL_MODE.
363 =item DB_TYPE
365 Type of DBMS (e.g., mysql or Pg).
367 =item DB_HOST
369 Name of DBMS server.
371 =item DB_PORT
373 Port that DBMS server is listening on.
375 =item DB_NAME
377 Name of the DBMS database for Koha.
379 =item DB_USER
381 Name of DBMS user account for Koha's database.
383 =item DB_PASS
385 Pasword of DMBS user account for Koha's database.
387 =item ZEBRA_MARC_FORMAT
389 Specifies format of MARC records to be indexed by Zebra.
391 =item ZEBRA_LANGUAGE
393 Specifies primary language of records that will be
394 indexed by Zebra.
396 =item ZEBRA_USER
398 Internal Zebra user account for the index.
400 =item ZEBRA_PASS
402 Internal Zebra user account's password.
404 =item KOHA_USER
406 System user account that will own Koha's files.
408 =item KOHA_GROUP
410 System group that will own Koha's files.
412 =back
414 =cut
416 # default configuration options
417 my %config_defaults = (
418   'DB_TYPE'           => 'mysql',
419   'DB_HOST'           => 'localhost',
420   'DB_NAME'           => 'koha',
421   'DB_USER'           => 'kohaadmin',
422   'DB_PASS'           => 'katikoan',
423   'INSTALL_SRU'       => 'yes',
424   'INSTALL_PAZPAR2'   => 'no',
425   'AUTH_INDEX_MODE'   => 'dom',
426   'BIB_INDEX_MODE'    => 'dom',
427   'ZEBRA_MARC_FORMAT' => 'marc21',
428   'ZEBRA_LANGUAGE'    => 'en',
429   'ZEBRA_TOKENIZER'   => 'chr',
430   'ZEBRA_USER'        => 'kohauser',
431   'ZEBRA_PASS'        => 'zebrastripes',
432   'ZEBRA_SRU_HOST'    => 'localhost',
433   'ZEBRA_SRU_BIBLIOS_PORT'    => '9998',
434   'ZEBRA_SRU_AUTHORITIES_PORT'    => '9999',
435   'KOHA_USER'         => 'koha',
436   'KOHA_GROUP'        => 'koha',
437   'MERGE_SERVER_HOST' => 'localhost',
438   'MERGE_SERVER_PORT' => '11001',
439   'PAZPAR2_HOST' => 'localhost',
440   'PAZPAR2_PORT' => '11002',
441   'RUN_DATABASE_TESTS' => 'no',
442   'PATH_TO_ZEBRA' => '',
443   'USE_MEMCACHED'     => 'no',
444   'MEMCACHED_SERVERS' => '127.0.0.1:11211',
445   'MEMCACHED_NAMESPACE' => 'KOHA'
448 # set some default configuration options based on OS
449 # more conditions need to be added for other OS's
451 warn "Your platform appears to be $^O.\n" if $DEBUG;
453 if ( $^O eq 'cygwin' ) {
454         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
455         # this could be changed to put some files (ie. libraries) into system32, etc.
456         $config_defaults{'INSTALL_MODE'} = 'single';
457         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
459 else {
460         $config_defaults{'INSTALL_MODE'} = 'standard';
461         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
464 # valid values for certain configuration options
465 my %valid_config_values = (
466   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
467   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
468   'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
469   'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
470   'BIB_INDEX_MODE'  => { 'grs1' => 1, 'dom' => 1 },
471   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
472   'ZEBRA_LANGUAGE'    => { 'en' => 1, 'es' => 1, 'fr' => 1, 'gr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
473   'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
474   'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
475   'USE_MEMCACHED'      => { 'yes' => 1, 'no' => 1 },
478 # get settings from command-line
479 my $koha_install_log = "";
480 Getopt::Long::Configure('pass_through');
481 my $results = GetOptions(
482     "prev-install-log=s" => \$koha_install_log
485 my %install_log_values = ();
486 if ($koha_install_log ne "") {
487     get_install_log_values($koha_install_log, \%install_log_values);
490 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
491 my ($target_directories, $skip_directories) = get_target_directories(\%config);
492 display_configuration(\%config, $target_directories);
493 my $file_map = {};
494 get_file_map($target_map, $dirtree, $file_map);
496 my $pl_files = {
497       'rewrite-config.PL' => [
498          'blib/KOHA_CONF_DIR/koha-conf.xml',
499          'blib/KOHA_CONF_DIR/koha-httpd.conf',
500          'blib/ZEBRA_CONF_DIR/etc/default.idx',
501          'blib/MISC_DIR/koha-install-log'
502          ],
503           'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
504                  'blib'
505                  ],
508 push @{ $pl_files->{'rewrite-config.PL'} }, (
509     'blib/ZEBRA_CONF_DIR/etc/passwd',
510     'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
511     'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
512     'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
513     'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
514     'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
515     'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
516     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
517     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
518     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
519     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
521 push @{ $pl_files->{'rewrite-config.PL'} }, (
522     'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
523     'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
524     'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
526 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
527     push @{ $pl_files->{'rewrite-config.PL'} }, (
528         'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
529         'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
530     );
532 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
533                               ? 'zebra-authorities-dom.cfg'
534                               : 'zebra-authorities.cfg';
535 $config{'ZEBRA_BIB_CFG'}  = $config{'BIB_INDEX_MODE'} eq 'dom'
536                               ? 'zebra-biblios-dom.cfg'
537                               : 'zebra-biblios.cfg';
538 $config{'AUTH_RETRIEVAL_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
539                                   ? 'retrieval-info-auth-dom.xml'
540                                   : 'retrieval-info-auth-grs1.xml';
541 $config{'BIB_RETRIEVAL_CFG'}  = $config{'BIB_INDEX_MODE'} eq 'dom'
542                                   ? 'retrieval-info-bib-dom.xml'
543                                   : 'retrieval-info-bib-grs1.xml';
546 if ($config{'INSTALL_MODE'} ne "dev") {
547     push @{ $pl_files->{'rewrite-config.PL'} }, (
548         'blib/PERL_MODULE_DIR/C4/Context.pm',
549         'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
550     );
553 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
554     ? 'icuchain words-icu.xml'
555     : 'charmap word-phrase-utf.chr';
557 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
558     ? 'icuchain phrases-icu.xml'
559     : 'charmap word-phrase-utf.chr';
561 my %test_suite_override_dirs = (
562     KOHA_CONF_DIR  => ['etc'],
563     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
564     LOG_DIR        => ['var', 'log'],
565     BACKUP_DIR     => ['var', 'spool'],
566     SCRIPT_DIR     => ['bin'],
567     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
568     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
569     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
572 WriteMakefile(
573               NAME         => 'koha',
574               #VERSION     => strftime('2.9.%Y%m%d%H',gmtime),
575               VERSION_FROM => 'kohaversion.pl',
576               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
577               AUTHOR       => 'Koha Contributors <http://koha-community.org/>',
578               NO_META      => 1,
579               PREREQ_PM    => $koha_pm->prereq_pm,
581               # File tree mapping
582               PM => $file_map,
584               # Man pages generated from POD
585               # ExtUtils::MakeMaker already manage $(DESTDIR)
586               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
587               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
589               PL_FILES => $pl_files,
592 =head1 FUNCTIONS
594 =head2 hashdir
596 This function recurses through the directory structure and builds
597 a hash of hashes containing the structure with arrays holding filenames.
598 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
600 =cut
602 sub hashdir{
603     my $dir = shift;
604     opendir my $dh, $dir or die $!;
605     my $tree = {}->{$dir} = {};
606     while( my $file = readdir($dh) ) {
607         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
608         my $path = $dir .'/' . $file;
609         $tree->{$file} = hashdir($path), next if -d $path;
610         push @{$tree->{'.'}}, $file;
611     }
612     return $tree;
615 =head2 get_file_map
617 This function combines the target_map and file hash to
618 map each source file to its destination relative to
619 the set of installation targets.
621 Output will be a hash mapping from each source file
622 to its destination value, like this:
624 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
626 =cut
628 sub get_file_map {
629     my $target_map = shift;
630     my $dirtree = shift;
631     my $file_map = shift;
632     my $curr_path = @_ ? shift : ['.'];
634     # Traverse the directory tree.
635     # For each file or directory, identify the
636     # most specific match in the target_map
637     foreach my $dir (sort keys %{ $dirtree }) {
638         if ($dir eq '.') {
639             # deal with files in directory
640             foreach my $file (sort @{ $dirtree->{$dir} }) {
641                 my $targetdir = undef;
642                 my $matchlevel = undef;
643                 # first, see if there is a match on this specific
644                 # file in the target map
645                 my $filepath = join("/", @$curr_path, $file);
646                 if (exists $target_map->{$filepath}) {
647                     $targetdir = $target_map->{$filepath};
648                     $matchlevel = scalar(@$curr_path) + 1;
649                 } else {
650                     # no match on the specific file; look for
651                     # a directory match
652                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
653                         my $dirpath = join("/", @$curr_path[0..$i]);
654                         if (exists $target_map->{$dirpath}) {
655                             $targetdir = $target_map->{$dirpath};
656                             $matchlevel = $i + 1;
657                             last;
658                         }
659                     }
660                 }
661                 if (defined $targetdir) {
662                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
663                 } else {
664                     my $path = join("/", @$curr_path);
665                     print "failed to map: $path/$file\n" if $DEBUG;
666                 }
667             }
668         } else {
669             # dealing with subdirectory
670             push @$curr_path, $dir;
671             get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
672             pop @$curr_path;
673         }
674     }
677 sub _add_to_file_map {
678     my $file_map = shift;
679     my $targetdir = shift;
680     my $curr_path = shift;
681     my $file = shift;
682     my $matchlevel = shift;
683     my $dest_path = @_ ? shift : $curr_path;
685     # The target can be one of the following:
686     # 1. scalar representing target symbol
687     # 2. hash ref containing target and trimdir keys
688     #
689     # Consequently, this routine traverses this structure,
690     # calling itself recursively, until it deals with
691     # all of the scalar target symbols.
692     if (ref $targetdir eq 'HASH') {
693         my $subtarget = $targetdir->{target};
694         if (exists $targetdir->{trimdir}) {
695             # if we get here, we've specified that
696             # rather than installing the file to
697             # $(TARGET)/matching/dirs/subdirs/file,
698             # we want to install it to
699             # $(TARGET)/subdirs/file
700             #
701             # Note that this the only place where
702             # $matchlevel is used.
703             my @new_dest_path = @$dest_path;
704             if ($targetdir->{trimdir} == -1)  {
705                 splice @new_dest_path, 0, $matchlevel;
706             } else {
707                 splice @new_dest_path, 0, $targetdir->{trimdir};
708             }
709             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
710         } else {
711             # actually getting here means that the
712             # target was unnecessarily listed
713             # as a hash, but we'll forgive that
714             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
715         }
716     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
717         my $source = File::Spec->catfile(@$curr_path, $file);
718         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
719         #print "$source => $destination\n"; # DEBUG
720         # quote spaces in file names
721         # FIXME: this is of questionable portability and
722         # probably depends on user's make recognizing this
723         # quoting syntax -- probably better to remove
724         # spaces and shell metacharacters from all file names
725         $source =~ s/ /\\ /g;
726         $destination =~ s/ /\\ /g;
728         $file_map->{$source} = $destination;
729     }
732 =head2 get_install_log_values
734 Reads value from the Koha install log specified by
735 --prev-install-log
737 =cut
739 sub get_install_log_values {
740     my $install_log = shift;
741     my $values = shift;
743     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
744     while (<LOG>) {
745         chomp;
746         next if /^#/ or /^\s*$/;
747         next if /^=/;
748         next unless m/=/;
749         s/\s+$//g;
750         my ($key, $value) = split /=/, $_, 2;
751         $values->{$key} = $value;
752     }
753     close LOG;
755     print <<_EXPLAIN_INSTALL_LOG_;
756 Reading values from install log $install_log.  You
757 will be prompted only for settings that have been
758 added since the last time you installed Koha.  To
759 be prompted for all settings, run 'perl Makefile.PL'
760 without the --prev-install-log option.
761 _EXPLAIN_INSTALL_LOG_
764 =head2 get_configuration
766 This prompts the user for various configuration options.
768 =cut
770 sub get_configuration {
771   my $defaults = shift;
772   my $valid_values = shift;
773   my $install_log_values = shift;
774   my %config = ();
776   my $msg = q(
777 By default, Koha can be installed in one of three ways:
779 standard: Install files in conformance with the Filesystem
780           Hierarchy Standard (FHS).  This is the default mode
781           and should be used when installing a production
782           Koha system.  On Unix systems, root access is
783           needed to complete a standard installation.
785 single:   Install files under a single directory.  This option
786           is useful for installing Koha without root access, e.g.,
787           on a web host that allows CGI scripts and MySQL databases
788           but requires the user to keep all files under the user's
789           HOME directory.
791 dev:      Create a set of symbolic links and configuration files to
792           allow Koha to run directly from the source distribution.
793           This mode is useful for developers who want to run
794           Koha from a git clone.
796 Installation mode);
797     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
798     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
800     # set message and default value for INSTALL_BASE
801     # depending on value of INSTALL_MODE
802     my $install_base_default = $defaults->{'INSTALL_BASE'};
803     if ($config{'INSTALL_MODE'} eq 'dev') {
804         $msg = q(
805 Please specify the directory in which to install Koha's
806 active configuration files and (if applicable) the
807 Zebra database.  Koha's CGI scripts and templates will
808 be run from the current directory.
810 Configuration directory:);
811         # FIXME - home directory portability consideration apply
812         $install_base_default =
813             $ENV{DESTDIR}
814             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
815         ;
816     } elsif ($config{'INSTALL_MODE'} eq 'single') {
817         $msg = "\nPlease specify the directory in which to install Koha";
818         # FIXME -- we're assuming under a 'single' mode install
819         # that user will likely want to install under the home
820         # directory.  This is OK in and of itself, but we should
821         # use File::HomeDir to locate the home directory portably.
822         # This is deferred for now because File::HomeDir is not yet
823         # core.
824                 # --we must also keep this portable to the major OS's -fbcit
825         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
826     } else {
827         # must be standard
828         $msg = q(
829 Please specify the directory under which most Koha files
830 will be installed.
832 Note that if you are planning in installing more than
833 one instance of Koha, you may want to modify the last
834 component of the directory path, which will be used
835 as the package name in the FHS layout.
837 Base installation directory);
838     }
839     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
841     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
842         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
843     if ($config{'INSTALL_MODE'} eq "standard") {
844         $msg = q(
845 Since you are using the 'standard' install
846 mode, you should run 'make install' as root.
847 However, it is recommended that a non-root
848 user (on Unix and Linux platforms) have
849 ownership of Koha's files, including the
850 Zebra indexes if applicable.
852 Please specify a user account.  This
853 user account does not need to exist
854 right now, but it needs to exist
855 before you run 'make install'.  Please
856 note that for security reasons, this
857 user should not be the same as the user
858 account Apache runs under.
860 User account);
861         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
863         $msg = q(
864 Please specify the group that should own
865 Koha's files.  As above, this group need
866 not exist right now, but should be created
867 before you run 'make install'.
869 Group);
870         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
871     }
873     $msg = q(
874 Please specify which database engine you will use
875 to store data in Koha.  The choices are MySQL and
876 PostgreSQL; please note that at the moment
877 PostgreSQL support is highly experimental.
879 DBMS to use);
880     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
881     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
883     $msg = q(
884 Please specify the name or address of your
885 database server.  Note that the database
886 does not have to exist at this point, it
887 can be created after running 'make install'
888 and before you try using Koha for the first time.
890 Database server);
891     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
893     $msg = q(
894 Please specify the port used to connect to the
895 DMBS);
896     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
897     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
899     $msg = q(
900 Please specify the name of the database to be
901 used by Koha);
902     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
904     $msg = q(
905 Please specify the user that owns the database to be
906 used by Koha);
907     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
909     $msg = q(
910 Please specify the password of the user that owns the
911 database to be used by Koha);
912     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
914     print q(
915 Koha uses the Zebra search engine for high-performance
916 searching of bibliographic and authority records.  Checking
917 to see if you have installed the Zebra software...
920     if (defined(my $zebra_path = find_zebra())) {
921         $config{'PATH_TO_ZEBRA'} = $zebra_path;
922         print qq(
923 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
925     } else {
926         print q(
927 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
928 in your PATH or in some of the usual places.  If you haven't
929 installed Zebra yet, please do so and run Makefile.PL again.
932     }
934     $msg = q(
935 You must specify the primary MARC format of the
936 records to be indexed by Zebra.
938 Koha provides Zebra configuration files for MARC21,
939 NORMARC and UNIMARC.
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);
944     $msg = q(
945 Koha supplies Zebra configuration files tuned for
946 searching either English (en) or French (fr) MARC
947 records.
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);
953     $msg = q(
954 Koha can use one of  two different indexing modes
955 for the MARC bibliographic records:
957 dom  - uses the DOM XML filter; offers improved
958        functionality.
959 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
960        available for legacy support
962 Bibliographic indexing mode);
963     $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
964     $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
967     $msg = q(
968 Koha can use one of  two different indexing modes
969 for the MARC authorities records:
971 dom  - uses the DOM XML filter; offers improved
972        functionality.
973 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
974        available for legacy support
976 Authorities indexing mode);
977     $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
978     $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
980     $msg = q(
981 Zebra has two methods to perform records tokenization
982 and characters normalization: CHR and ICU. ICU is
983 recommended for catalogs containing non-Latin
984 characters.);
986     $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
987     $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
989     $msg = q(
990 Please specify Zebra database user);
991     $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
993     $msg = q(
994 Please specify the Zebra database password);
995     $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
997     $msg = q(
998 Since you've chosen to use Zebra, you can enable the SRU/
999 Z39.50 Server if you so choose, but you must specify a
1000 few configuration options for it.
1002 Please note that if you choose *NOT* to configure SRU,
1003 koha-conf.xml will still contain some references to SRU
1004 settings.  Those references will be ignored by Koha.
1006 Install the SRU configuration files?);
1007     $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1008     $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1010     if ($config{'INSTALL_SRU'} eq 'yes') {
1011         $msg = q(
1012 Since you've chosen to configure SRU, you must
1013 specify the host and port(s) that the SRU
1014 Servers (bibliographic and authority) should run on.
1016         $msg = q(
1017 SRU Database host?);
1018         $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1020         $msg = q(
1021 SRU port for bibliographic data?);
1022         $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1024         $msg = q(
1025 SRU port for authority data?);
1026         $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1028     }
1030     $msg = q(
1031 Along with Zebra, you can also choose to install PazPar2,
1032 which is a metasearch tool.  With PazPar2,
1033 Koha can perform on-the-fly merging of bibliographic
1034 records during searching, allowing for FRBRization of
1035 the results list.
1037 Install the PazPar2 configuration files?);
1038     $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1039     $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1041     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1042         $msg = q(
1043 Since you've chosen to configure PazPar2, you must
1044 specify the host and port(s) that PazPar2
1045 uses:
1047         $msg = q(
1048 Zebra bibliographic server host?);
1049         $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1051         $msg = q(
1052 Zebra bibliographic port for PazPar2 to use?);
1053         $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1055         $msg = q(
1056 PazPar2 host?);
1057         $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1059         $msg = q(
1060 PazPar2 port?);
1061         $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1063     }
1065   $msg = q(
1066 Use memcached and memoize to cache the results of some function calls?
1067 This provides a signficant performance improvement.
1068 You will need a Memcached server running.);
1069   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1070   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1071   if ($config{'USE_MEMCACHED'} eq 'yes'){
1072       $msg = q(
1073 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1075       $msg = q(
1076 Memcached server address?);
1077       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1079       $msg = q(
1080 Memcached namespace?);
1081       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1082   }
1086   $msg = q(
1087 Would you like to run the database-dependent test suite?);
1088   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1089     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1091   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1092       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1093       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1094       $msg = q(TEST DATABASE
1096 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1097 testing. Please don't do this on your production database. It is not
1098 reversable.
1100 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1101 database. You are better off not running this optional test suite than
1102 doing it in a database that you don't want to lose.
1104 Please specify the name of the test database to be
1105 used by Koha);
1107       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1108       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1109           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1110           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1111       }
1113       $msg = q(
1114 Please specify the user that owns the database to be
1115 used by Koha);
1116     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1118       $msg = q(
1119 Please specify the password of the user that owns the
1120 database to be used by Koha);
1121       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1122   }
1124     print "\n\n";
1126     # add version number
1127     my $version = "no_version_found";
1128     eval {
1129         require 'kohaversion.pl';
1130         $version = kohaversion();
1131     };
1132     $config{'KOHA_INSTALLED_VERSION'} = $version;
1134     return %config;
1137 sub _add_valid_values_disp {
1138     my $key = shift;
1139     my $valid_values = shift;
1141     my $disp = "";
1142     if (exists $valid_values->{$key}) {
1143         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1144     }
1145     return $disp;
1148 sub _get_value {
1149     my $key = shift;
1150     my $msg = shift;
1151     my $default = shift;
1152     my $valid_values = shift;
1153     my $install_log_values = shift;
1155     # take value from install log if present
1156     if (exists $install_log_values{$key}) {
1157         $install_log_values{$key} =~ s/\$/\$\$/g;
1158         return $install_log_values{$key};
1159     }
1161     # override default value from environment
1162     if (exists $ENV{$key}) {
1163         $default = $ENV{$key};
1164         $msg .= " (default from environment)";
1165     }
1167     my $val = prompt($msg, $default);
1169     while (exists $valid_values->{$key} and
1170            $val ne $default and
1171            not exists $valid_values->{$key}->{$val}) {
1172         my $retry_msg = "Value '$val' is not a valid option.\n";
1173         $retry_msg .= "Please enter a value";
1174         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1175         $val = prompt($retry_msg, $default);
1176     }
1177     $val =~ s/\$/\$\$/g;
1178     return $val;
1181 =head2 get_target_directories
1183 Creates a hash mapping from symbols for installation target
1184 directories to actual directory paths.
1186 Also returns a hash indicating targets for which
1187 files need not be copied -- this is used for the 'dev'
1188 mode installation, where some files are installed in place.
1190 =cut
1192 sub get_target_directories {
1193     my $config = shift;
1195     my $base = $config->{'INSTALL_BASE'};
1196     my $mode = $config->{'INSTALL_MODE'};
1198     # get last component of install base directory
1199     # to treat as package name
1200     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1202     my @basedir = File::Spec->splitdir($directories);
1204     if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1206     my $package = pop @basedir;
1209     my %dirmap = ();
1210     my %skipdirs = ();
1211     if ($mode eq 'single') {
1212         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1213         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1214         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1215         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1216         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1217         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1218         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1219         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1220         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1221         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1222         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1223         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1224         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1225         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1226         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1227         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1228         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1229         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1230         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1231         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1232         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1233     } elsif ($mode eq 'dev') {
1234         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1235         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1236         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1237         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1238         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1239         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1240         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1241         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1242         $skipdirs{'OPAC_CGI_DIR'} = 1;
1243         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1244         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1245         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1246         $skipdirs{'OPAC_WWW_DIR'} = 1;
1247         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1248         $skipdirs{'PERL_MODULE_DIR'} = 1;
1249         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1250         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1251         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1252         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1253         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1254         #For dev install, point NONDEV_DIR to misc in current dir (not base)
1255         #Used by supportdir in koha-conf.xml (BZ 12031)
1256         $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1257         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1258         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1259         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1260         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1261         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1262         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1263         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1264         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1265         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1266     } else {
1267         # mode is standard, i.e., 'fhs'
1268         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1269         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1270         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1271         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1272         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1273         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1274         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1275         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1276         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1277         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1278         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1279         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1280         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1281         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1282         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1283         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1284         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1285         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1286         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1287         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1288         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1289     }
1291     _get_env_overrides(\%dirmap);
1292     _get_argv_overrides(\%dirmap);
1293     _add_destdir(\%dirmap);
1295     return \%dirmap, \%skipdirs;
1298 =head2 get_test_dir
1300 Map a directory target to the corresponding path for
1301 the test suite.
1303 =cut
1305 sub get_test_dir {
1306     my ($dirname) = @_;
1308     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1309     if (exists $test_suite_override_dirs{$dirname}) {
1310         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1311     } else {
1312         return;
1313     }
1317 sub _get_env_overrides {
1318     my $dirmap = shift;
1320     foreach my $key (keys %$dirmap) {
1321         if (exists $ENV{$key}) {
1322             $dirmap->{$key} = $ENV{$key};
1323             print "Setting $key from environment\n";
1324         }
1325     }
1328 sub _get_argv_overrides {
1329     my $dirmap = shift;
1331     my @new_argv = ();
1332     for (my $i = 0; $i <= $#ARGV; $i++) {
1333         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1334             $dirmap->{$1} = $2;
1335         } else {
1336             push @new_argv, $ARGV[$i];
1337         }
1338     }
1339     @ARGV = @new_argv;
1342 sub _strip_destdir {
1343     my $dir = shift;
1344     $dir =~ s/^\$\(DESTDIR\)//;
1345     return $dir;
1348 sub _add_destdir {
1349     my $dirmap = shift;
1351     foreach my $key (keys %$dirmap) {
1352         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1353     }
1356 sub display_configuration {
1357     my $config = shift;
1358     my $dirmap = shift;
1359     my @version = grep /\/usr\/share\/perl\//, @INC;
1360     push @version, ('/usr/share/perl/5.10') if !$version[0];
1361     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1362     foreach my $key (sort keys %$config) {
1363         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1364     }
1366     print "\nand in the following directories:\n\n";
1367     foreach my $key (sort keys %$dirmap) {
1368         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1369     }
1370     print "\n\nTo change any configuration setting, please run\n";
1371     print "perl Makefile.PL again.  To override one of the target\n";
1372     print "directories, you can do so on the command line like this:\n";
1373     print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1374     print "You can also set different default values for parameters\n";
1375     print "or override directory locations by using environment variables.\n";
1376     print "\nFor example:\n\n";
1377     print "export DB_USER=my_koha\n";
1378     print "perl Makefile.PL\n";
1379     print "\nor\n\n";
1380     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1383 =head2 find_zebra
1385 Attempt to find Zebra - check user's PATH and
1386 a few other directories for zebrasrv and zebraidx.
1388 =cut
1390 sub find_zebra {
1391     my @search_dirs = map {
1392                             my $abs = File::Spec->rel2abs($_);
1393                             my ($toss, $directories);
1394                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1395                             $directories;
1396                         }  split /:/, $ENV{PATH};
1397     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1398     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1399     return unless @zebrasrv_dirs;
1400     # verify that directory that contains zebrasrv also contains zebraidx
1401     foreach my $dir (@zebrasrv_dirs) {
1402         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1403     }
1404     return;
1407 package MY;
1409 sub test {
1410     my $self = shift;
1411     my $test = $self->SUPER::test(@_);
1412     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1414     # set KOHA_CONF
1415     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1416     return $test;
1419 sub install {
1420     my $self = shift;
1421     my $install = "";
1422     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1423     # This means that we're completely overriding EU::MM's default
1424     # installation and uninstallation targets.
1426 # If installation is on Win32, we need to do permissions different from *nix
1427     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1428             foreach my $key (sort keys %$target_directories) {
1429                     $install .= qq(
1430 KOHA_INST_$key = blib/$key
1431 KOHA_DEST_$key = $target_directories->{$key}
1432 ) unless exists $skip_directories->{$key};
1433                 }
1434                 $install .= qq(
1435 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1436 \t\$(NOECHO) \$(NOOP)
1438                         $install .= "install_koha ::\n";
1439                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1440                         foreach my $key (sort keys %$target_directories) {
1441                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1442           unless exists $skip_directories->{$key};
1443                         }
1444                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1445                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1447                         $install .= "\n";
1448                         $install .= "set_koha_ownership ::\n";
1449 # Do not try to change ownership if DESTDIR is set
1450                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1451                                 foreach my $key (sort keys %$target_directories) {
1452             $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1453             unless exists $skip_directories->{$key};
1454                                 }
1455                         } else {
1456                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1457                         }
1459                         $install .= "\n";
1460                         $install .= "set_koha_permissions ::\n";
1461                         # This is necessary because EU::MM installs files
1462                         # as either 0444 or 0555, and we want the owner
1463                         # of Koha's files to have write permission by default.
1464                         foreach my $key (sort keys %$target_directories) {
1465                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1466           unless exists $skip_directories->{$key};
1467                         }
1468         }
1470         $install .= "\n";
1472     $install .= "warn_koha_env_vars ::\n";
1473     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1474     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1475     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1476     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1477     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1478     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1479     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1480     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1481     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1482     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1483     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1485     $install .= _update_zebra_conf_target();
1487     $install .= upgrade();
1489     return $install;
1492 =head2 _update_zebra_conf_target
1494 Add an installation target for updating
1495 Zebra's configuration files.
1497 =cut
1499 sub _update_zebra_conf_target {
1501     my $target = "\nupdate_zebra_conf ::\n";
1502     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1503     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1504     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1505     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1506     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1507     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1509     return $target;
1512 sub upgrade {
1513     my $upgrade = "";
1515     my $backup_suffix;
1516     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1517         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1518         $version =~ s/\./_/g;
1519         $backup_suffix = "_koha_$version";
1520     } else {
1521         $backup_suffix = "_upgrade_backup";
1522     }
1524     $upgrade .= qq/
1525 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1527 upgrade :: make_upgrade_backup install
1528 \t\$(NOECHO) \$(NOOP)
1529 make_upgrade_backup ::
1530 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1532     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1533                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1534         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1535             unless exists $skip_directories->{$key} or
1536                    not exists $target_directories->{$key};
1537     }
1538     $upgrade =~ s/\\\n$/\n/;
1540     return $upgrade;
1542 sub postamble {
1543     # put directory mappings into Makefile
1544     # so that Make will export as environment
1545     # variables -- this is for the use of
1546     # rewrite-confg.PL
1548     my $env;
1549         # Hereagain, we must alter syntax per platform...
1550         {
1551                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1552                 $env .= "\n\n";
1553                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1554         }
1556     return "$env\n";
1560 __END__
1563 =head1 SEE ALSO
1565 ExtUtils::MakeMaker(3)
1567 =head1 AUTHORS
1569 MJ Ray mjr at phonecoop.coop
1570 Galen Charlton galen.charlton at liblime.com
1572 =cut
1574 FIXME: deal with .htaccess