Merge branch 'bug_9102' into 3.12-master
[koha.git] / Makefile.PL
1 # Copyright 2007 MJ Ray
2 #
3 # This file is part of Koha.
4 #
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
8 # version.
9 #
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.
13 #
14 # You should have received a copy of the GNU General Public License along
15 # with Koha; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 #
18 # Current maintainer MJR http://mjr.towers.org.uk/
19 #
20
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
28
29 use lib $FindBin::Bin;
30
31 use C4::Installer;
32
33 my $koha_pm = C4::Installer::PerlModules->new;
34
35 my $DEBUG = 0;
36 die "perl 5.10 or later required" unless ($] >= 5.010000);
37
38 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
39
40 my $dirtree = hashdir('.');
41 my %result = ();
42
43 =head1 NAME
44
45 Makefile.PL - Koha packager and installer
46
47 =head1 SYNOPSIS
48
49 =head2 BASIC INSTALLATION
50
51     perl Makefile.PL
52     make
53     make test
54     sudo make install
55
56 =head2 UPGRADE INSTALLATION
57
58     NOTE: This option is only available if koha-install-log exists.
59
60     perl Makefile.PL --prev-install-log /path/to/koha-install-log
61
62     make
63     make test
64     sudo make upgrade
65
66 =head2 PACKAGING RELEASE TARBALLS
67
68     make manifest tardist
69     make manifest zipdist
70
71 =head2 CLEANING UP
72
73         make clean
74
75 =head1 DESCRIPTION
76
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.
84
85 =head1 VARIABLES
86
87 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
88
89 Basic metadata about this software.
90
91 =head2 NO_META
92
93 Suppress generation of META.yml file.
94
95 =head2 PREREQ_PM
96
97 Hash of perl modules and versions required.
98
99 =head2 PM
100
101 Hash of file mappings
102
103 =head2 PL_FILES
104
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.
109
110 =cut
111
112 =head2 target_map
113
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:
117
118 =over 4
119
120 =item If a directory or file is specified, it and its
121 contents will be copied to the installation target directory.
122
123 =item If a subdirectory of a mapped directory is specified,
124 its target overrides the parent's target for that subdirectory.
125
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.
129
130 =item Any files at the top level of the source tree that are
131 not included in the map will not be installed.
132
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.
141
142 =back
143
144 The permitted installation targets are:
145
146 =over 4
147
148 =item INTRANET_CGI_DIR
149
150 CGI scripts for intranet (staff) interface.
151
152 =item INTRANET_TMPL_DIR
153
154 HTML templates for the intranet interface.
155
156 =item INTRANET_WWW_DIR
157
158 HTML files, images, etc. for DocumentRoot for the intranet interface.
159
160 =item OPAC_CGI_DIR
161
162 CGI scripts for OPAC (public) interface.
163
164 =item OPAC_TMPL_DIR
165
166 HTML templates for the OPAC interface.
167
168 =item OPAC_WWW_DIR
169
170 HTML files, images, etc. for DocumentRoot for the OPAC interface.
171
172 =item PERL_MODULE_DIR
173
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.
178
179 =item KOHA_CONF_DIR
180
181 Directory for Koha configuration files.
182
183 =item ZEBRA_CONF_DIR
184
185 Directory for Zebra configuration files.
186
187 =item ZEBRA_LOCK_DIR
188
189 Directory for Zebra's lock files.
190
191 =item ZEBRA_DATA_DIR
192
193 Directory for Zebra's data files.
194
195 =item ZEBRA_RUN_DIR
196
197 Directory for Zebra's UNIX-domain sockets.
198
199 =item MISC_DIR
200
201 Directory for for miscellaenous scripts, among other
202 things the translation toolkit and RSS feed tools.
203
204 =item SCRIPT_DIR
205
206 Directory for command-line scripts and daemons to
207 be set up all for installation modes.
208
209 =item SCRIPT_NONDEV_DIR
210
211 Directory for command-line scripts that should
212 be installed in the same directory as the
213 SCRIPT_DIR target except 'dev' installs.
214
215 =item MAN_DIR
216
217 Directory for man pages created from POD -- will mostly
218 contain information of interest to Koha developers.
219
220 =item DOC_DIR
221
222 Directory for Koha documentation accessed from the
223 command-line, e.g., READMEs.
224
225 =item LOG_DIR
226
227 Directory for Apache and Zebra logs produced by Koha.
228
229 =item BACKUP_DIR
230
231 Directory for backup files produced by Koha.
232
233 =item PAZPAR2_CONF_DIR
234
235 Directory for PazPar2 configuration files.
236
237 =item NONE
238
239 This is a dummy target used to explicitly state
240 that a given file or directory is not to be installed.
241 This is used either for parts of the installer itself
242 or for development tools that are not applicable to a
243 production installation.
244
245 =back
246
247 =cut
248
249 my $target_map = {
250   './about.pl'                  => 'INTRANET_CGI_DIR',
251   './acqui'                     => 'INTRANET_CGI_DIR',
252   './admin'                     => 'INTRANET_CGI_DIR',
253   './authorities'               => 'INTRANET_CGI_DIR',
254   './basket'                    => 'INTRANET_CGI_DIR',
255   './C4'                        => 'PERL_MODULE_DIR',
256   './C4/SIP/t'                  => 'NONE',
257   './C4/SIP/koha_test'          => 'NONE',
258   './C4/tests'                  => 'NONE',
259   './catalogue'                 => 'INTRANET_CGI_DIR',
260   './cataloguing'               => 'INTRANET_CGI_DIR',
261   './changelanguage.pl'         => 'INTRANET_CGI_DIR',
262   './check_sysprefs.pl'         => 'NONE',
263   './circ'                      => 'INTRANET_CGI_DIR',
264   './offline_circ'              => 'INTRANET_CGI_DIR',
265   './edithelp.pl'               => 'INTRANET_CGI_DIR',
266   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
267   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
268   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
269   './help.pl'                   => 'INTRANET_CGI_DIR',
270   './installer-CPAN.pl'         => 'NONE',
271   './installer'                 => 'INTRANET_CGI_DIR',
272   './errors'                    => {target => 'INTRANET_CGI_DIR'},
273   './Koha'                      => 'PERL_MODULE_DIR',
274   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
275   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
276   './kohaversion.pl'            => 'INTRANET_CGI_DIR', 
277   './labels'                    => 'INTRANET_CGI_DIR',
278   './mainpage.pl'               => 'INTRANET_CGI_DIR',
279   './Makefile.PL'               => 'NONE',
280   './MANIFEST.SKIP'             => 'NONE',
281   './members'                   => 'INTRANET_CGI_DIR',
282   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
283   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
284   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
285   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
286   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
287   './misc/installer_devel_notes' => 'NONE',
288   './opac'                      => 'OPAC_CGI_DIR',
289   './README.txt'                => 'NONE',
290   './patroncards'               => 'INTRANET_CGI_DIR',
291   './reports'                   => 'INTRANET_CGI_DIR',
292   './reserve'                   => 'INTRANET_CGI_DIR',
293   './reviews'                   => 'INTRANET_CGI_DIR',
294   './rewrite-config.PL'         => 'NONE',
295   './reviews'                   => 'INTRANET_CGI_DIR',
296   './serials'                   => 'INTRANET_CGI_DIR',
297   './services'                  => 'INTRANET_CGI_DIR',
298   './skel'                      => 'NONE',
299   './skel/var/log/koha'         => { target => 'LOG_DIR', trimdir => -1 },
300   './skel/var/spool/koha'       => { target => 'BACKUP_DIR', trimdir => -1 },
301   './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
302   './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
303   './skel/var/lib/koha/zebradb/authorities/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
304   './skel/var/lib/koha/zebradb/authorities/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
305   './skel/var/lib/koha/zebradb/authorities/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
306   './skel/var/lib/koha/zebradb/authorities/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
307   './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
308   './skel/var/lib/koha/zebradb/biblios/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
309   './skel/var/lib/koha/zebradb/biblios/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
310   './skel/var/lib/koha/zebradb/biblios/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
311   './skel/var/lib/koha/zebradb/biblios/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
312   './sms'                       => 'INTRANET_CGI_DIR',
313   './suggestion'                => 'INTRANET_CGI_DIR',
314   './svc'                       => 'INTRANET_CGI_DIR',
315   './t'                         => 'NONE',
316   './tags'                      => 'INTRANET_CGI_DIR',
317   './tmp'                       => 'NONE', # FIXME need to determine whether
318                                            # Koha generates any persistent temp files
319                                            # that should go in /var/tmp/koha
320   './tools'                     => 'INTRANET_CGI_DIR',
321   './virtualshelves'            => 'INTRANET_CGI_DIR',
322   './xml_sax.pl'                => 'PERL_MODULE_DIR',
323   # ignore files and directories created by the install itself
324   './pm_to_blib'                => 'NONE',
325   './blib'                      => 'NONE',
326 };
327
328 =head1 CONFIGURATION OPTIONS
329
330 The following configuration options are used by the installer.
331
332 =over 4
333
334 =item INSTALL_MODE
335
336 Specifies whether installation will be FHS-compliant (default,
337 assumes user has root), put everything under
338 a single directory (for users installing on a web host
339 that allows CGI scripts and a MySQL database but not root
340 access), or development (for a developer who wants to run
341 Koha from a git clone with no fuss).
342
343 =item INSTALL_BASE
344
345 Directory under which most components will go.  Default
346 value will vary depending on INSTALL_MODE.
347
348 =item DB_TYPE
349
350 Type of DBMS (e.g., mysql or Pg).
351
352 =item DB_HOST
353
354 Name of DBMS server.
355
356 =item DB_PORT
357
358 Port that DBMS server is listening on.
359
360 =item DB_NAME
361
362 Name of the DBMS database for Koha.
363
364 =item DB_USER
365
366 Name of DBMS user account for Koha's database.
367
368 =item DB_PASS
369
370 Pasword of DMBS user account for Koha's database.
371
372 =item INSTALL_ZEBRA
373
374 Whether to install Zebra configuration files and data
375 directories.
376
377 =item ZEBRA_MARC_FORMAT
378
379 Specifies format of MARC records to be indexed by Zebra.
380
381 =item ZEBRA_LANGUAGE
382
383 Specifies primary language of records that will be
384 indexed by Zebra.
385
386 =item ZEBRA_USER
387
388 Internal Zebra user account for the index.
389
390 =item ZEBRA_PASS
391
392 Internal Zebra user account's password.
393
394 =item KOHA_USER
395
396 System user account that will own Koha's files.
397
398 =item KOHA_GROUP
399
400 System group that will own Koha's files.
401
402 =back
403
404 =cut
405
406 # default configuration options
407 my %config_defaults = (
408   'DB_TYPE'           => 'mysql',
409   'DB_HOST'           => 'localhost',
410   'DB_NAME'           => 'koha',
411   'DB_USER'           => 'kohaadmin',
412   'DB_PASS'           => 'katikoan',
413   'INSTALL_ZEBRA'     => 'yes',
414   'INSTALL_SRU'       => 'yes',
415   'INSTALL_PAZPAR2'   => 'no',
416   'AUTH_INDEX_MODE'   => 'dom',
417   'BIB_INDEX_MODE'    => 'dom',
418   'ZEBRA_MARC_FORMAT' => 'marc21',
419   'ZEBRA_LANGUAGE'    => 'en',
420   'ZEBRA_TOKENIZER'   => 'chr',
421   'ZEBRA_USER'        => 'kohauser',
422   'ZEBRA_PASS'        => 'zebrastripes',
423   'ZEBRA_SRU_HOST'    => 'localhost',
424   'ZEBRA_SRU_BIBLIOS_PORT'    => '9998',
425   'ZEBRA_SRU_AUTHORITIES_PORT'    => '9999',
426   'KOHA_USER'         => 'koha',
427   'KOHA_GROUP'        => 'koha',
428   'MERGE_SERVER_HOST' => 'localhost',
429   'MERGE_SERVER_PORT' => '11001',
430   'PAZPAR2_HOST' => 'localhost',
431   'PAZPAR2_PORT' => '11002',
432   'RUN_DATABASE_TESTS' => 'no',
433   'PATH_TO_ZEBRA' => '',
434   'USE_MEMCACHED'     => 'no',
435   'MEMCACHED_SERVERS' => '127.0.0.1:11211',
436   'MEMCACHED_NAMESPACE' => 'KOHA'
437 );
438
439 # set some default configuration options based on OS
440 # more conditions need to be added for other OS's
441 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
442 # to allow for more granular decisions based on which Win32 platform
443
444 warn "Your platform appears to be $^O.\n" if $DEBUG;
445
446 if ( $^O eq 'MSWin32' ) {
447         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
448         # this could be changed to put some files (ie. libraries) into system32, etc.
449         $config_defaults{'INSTALL_MODE'} = 'single';
450         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
451 }
452 elsif ( $^O eq 'cygwin' ) {
453         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
454         # this could be changed to put some files (ie. libraries) into system32, etc.
455         $config_defaults{'INSTALL_MODE'} = 'single';
456         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
457 }
458 else {
459         $config_defaults{'INSTALL_MODE'} = 'standard';
460         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
461 }
462
463 # valid values for certain configuration options
464 my %valid_config_values = (
465   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
466   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
467   'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 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, 'fr' => 1, 'nb' => 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 },
476 );
477
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
483 );
484
485 my %install_log_values = ();
486 if ($koha_install_log ne "") {
487     get_install_log_values($koha_install_log, \%install_log_values);
488 }
489
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, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
495
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                  ],
506 };
507
508 if ($config{'INSTALL_ZEBRA'} eq "yes") {
509     push @{ $pl_files->{'rewrite-config.PL'} }, (
510         'blib/ZEBRA_CONF_DIR/etc/passwd',
511         'blib/ZEBRA_CONF_DIR/etc/usmarc.mar',
512         'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
513         'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
514         'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
515         'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
516         'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
517         'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
518         'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
519         'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
520         'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
521         'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
522     );
523     push @{ $pl_files->{'rewrite-config.PL'} }, (
524         'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
525         'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
526         'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
527     );
528     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
529         push @{ $pl_files->{'rewrite-config.PL'} }, (
530             'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
531             'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
532         );
533     }
534     $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
535     $config{'ZEBRA_BIB_CFG'}  = $config{'BIB_INDEX_MODE'}  eq 'dom' ? 'zebra-biblios-dom.cfg'     : 'zebra-biblios.cfg';
536     $config{'AUTH_RETRIEVAL_CFG'} =
537         $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
538     $config{'BIB_RETRIEVAL_CFG'}  =
539         $config{'BIB_INDEX_MODE'}  eq 'dom' ? 'retrieval-info-bib-dom.xml'  : 'retrieval-info-bib-grs1.xml';
540 }
541
542 if ($config{'INSTALL_MODE'} ne "dev") {
543     push @{ $pl_files->{'rewrite-config.PL'} }, (
544         'blib/PERL_MODULE_DIR/C4/Context.pm',
545         'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
546     );
547 }
548
549 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
550     ? 'icuchain words-icu.xml'
551     : 'charmap word-phrase-utf.chr';
552
553 my %test_suite_override_dirs = (
554     KOHA_CONF_DIR  => ['etc'],
555     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
556     LOG_DIR        => ['var', 'log'],
557     BACKUP_DIR     => ['var', 'spool'],
558     SCRIPT_DIR     => ['bin'],
559     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
560     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
561     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
562 );
563
564 WriteMakefile(
565               NAME         => 'koha',
566               #VERSION     => strftime('2.9.%Y%m%d%H',gmtime),
567               VERSION_FROM => 'kohaversion.pl',
568               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
569               AUTHOR       => 'Koha Contributors <http://koha-community.org/>',
570               NO_META      => 1,
571               PREREQ_PM    => $koha_pm->prereq_pm,
572
573               # File tree mapping
574               PM => $file_map,
575
576               # Man pages generated from POD
577               # ExtUtils::MakeMaker already manage $(DESTDIR)
578               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
579               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
580
581               PL_FILES => $pl_files,
582 );
583
584 =head1 FUNCTIONS
585
586 =head2 hashdir
587
588 This function recurses through the directory structure and builds
589 a hash of hashes containing the structure with arrays holding filenames.
590 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
591
592 =cut
593
594 sub hashdir{
595     my $dir = shift;
596     opendir my $dh, $dir or die $!;
597     my $tree = {}->{$dir} = {};
598     while( my $file = readdir($dh) ) {
599         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
600         my $path = $dir .'/' . $file;
601         $tree->{$file} = hashdir($path), next if -d $path;
602         push @{$tree->{'.'}}, $file;
603     }
604     return $tree;
605 }
606
607 =head2 get_file_map
608
609 This function combines the target_map and file hash to
610 map each source file to its destination relative to
611 the set of installation targets.
612
613 Output will be a hash mapping from each source file
614 to its destination value, like this:
615
616 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
617
618 =cut
619
620 sub get_file_map {
621     my $target_map = shift;
622     my $dirtree = shift;
623     my $file_map = shift;
624     my $install_zebra = shift;
625     my $curr_path = @_ ? shift : ['.'];
626
627     # Traverse the directory tree.
628     # For each file or directory, identify the
629     # most specific match in the target_map
630     foreach my $dir (sort keys %{ $dirtree }) {
631         if ($dir eq '.') {
632             # deal with files in directory
633             foreach my $file (sort @{ $dirtree->{$dir} }) {
634                 my $targetdir = undef;
635                 my $matchlevel = undef;
636                 # first, see if there is a match on this specific
637                 # file in the target map
638                 my $filepath = join("/", @$curr_path, $file);
639                 if (exists $target_map->{$filepath}) {
640                     $targetdir = $target_map->{$filepath};
641                     $matchlevel = scalar(@$curr_path) + 1;
642                 } else {
643                     # no match on the specific file; look for
644                     # a directory match
645                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
646                         my $dirpath = join("/", @$curr_path[0..$i]);
647                         if (exists $target_map->{$dirpath}) {
648                             $targetdir = $target_map->{$dirpath};
649                             $matchlevel = $i + 1;
650                             last;
651                         }
652                     }
653                 }
654                 if (defined $targetdir) {
655                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
656                 } else {
657                     my $path = join("/", @$curr_path);
658                     print "failed to map: $path/$file\n" if $DEBUG;
659                 }
660             }
661         } else {
662             # dealing with subdirectory
663             push @$curr_path, $dir;
664             get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
665             pop @$curr_path;
666         }
667     }
668 }
669
670 sub _add_to_file_map {
671     my $file_map = shift;
672     my $targetdir = shift;
673     my $curr_path = shift;
674     my $file = shift;
675     my $matchlevel = shift;
676     my $install_zebra = shift;
677     my $dest_path = @_ ? shift : $curr_path;
678
679     # The target can be one of the following:
680     # 1. scalar representing target symbol
681     # 2. hash ref containing target and trimdir keys
682     #
683     # Consequently, this routine traverses this structure,
684     # calling itself recursively, until it deals with
685     # all of the scalar target symbols.
686     if (ref $targetdir eq 'HASH') {
687         my $subtarget = $targetdir->{target};
688         if (exists $targetdir->{trimdir}) {
689             # if we get here, we've specified that
690             # rather than installing the file to
691             # $(TARGET)/matching/dirs/subdirs/file,
692             # we want to install it to
693             # $(TARGET)/subdirs/file
694             #
695             # Note that this the only place where
696             # $matchlevel is used.
697             my @new_dest_path = @$dest_path;
698             if ($targetdir->{trimdir} == -1)  {
699                 splice @new_dest_path, 0, $matchlevel;
700             } else {
701                 splice @new_dest_path, 0, $targetdir->{trimdir};
702             }
703             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
704         } else {
705             # actually getting here means that the
706             # target was unnecessarily listed
707             # as a hash, but we'll forgive that
708             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
709         }
710     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
711         my $source = File::Spec->catfile(@$curr_path, $file);
712         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
713         #print "$source => $destination\n"; # DEBUG
714         # quote spaces in file names
715         # FIXME: this is of questionable portability and
716         # probably depends on user's make recognizing this
717         # quoting syntax -- probably better to remove
718         # spaces and shell metacharacters from all file names
719         $source =~ s/ /\\ /g;
720         $destination =~ s/ /\\ /g;
721
722         $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
723     }
724 }
725
726 =head2 get_install_log_values
727
728 Reads value from the Koha install log specified by
729 --prev-install-log
730
731 =cut
732
733 sub get_install_log_values {
734     my $install_log = shift;
735     my $values = shift;
736
737     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
738     while (<LOG>) {
739         chomp;
740         next if /^#/ or /^\s*$/;
741         next if /^=/;
742         next unless m/=/;
743         s/\s+$//g;
744         my ($key, $value) = split /=/, $_, 2;
745         $values->{$key} = $value;
746     }
747     close LOG;
748
749     print <<_EXPLAIN_INSTALL_LOG_;
750 Reading values from install log $install_log.  You
751 will be prompted only for settings that have been
752 added since the last time you installed Koha.  To
753 be prompted for all settings, run 'perl Makefile.PL'
754 without the --prev-install-log option.
755 _EXPLAIN_INSTALL_LOG_
756 }
757
758 =head2 get_configuration
759
760 This prompts the user for various configuration options.
761
762 =cut
763
764 sub get_configuration {
765   my $defaults = shift;
766   my $valid_values = shift;
767   my $install_log_values = shift;
768   my %config = ();
769
770   my $msg = q(
771 By default, Koha can be installed in one of three ways:
772
773 standard: Install files in conformance with the Filesystem
774           Hierarchy Standard (FHS).  This is the default mode
775           and should be used when installing a production
776           Koha system.  On Unix systems, root access is
777           needed to complete a standard installation.
778
779 single:   Install files under a single directory.  This option
780           is useful for installing Koha without root access, e.g.,
781           on a web host that allows CGI scripts and MySQL databases
782           but requires the user to keep all files under the user's
783           HOME directory.
784
785 dev:      Create a set of symbolic links and configuration files to
786           allow Koha to run directly from the source distribution.
787           This mode is useful for developers who want to run
788           Koha from a git clone.
789
790 Installation mode);
791     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
792     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
793
794     # set message and default value for INSTALL_BASE
795     # depending on value of INSTALL_MODE
796     my $install_base_default = $defaults->{'INSTALL_BASE'};
797     if ($config{'INSTALL_MODE'} eq 'dev') {
798         $msg = q(
799 Please specify the directory in which to install Koha's
800 active configuration files and (if applicable) the
801 Zebra database.  Koha's CGI scripts and templates will
802 be run from the current directory.
803
804 Configuration directory:);
805         # FIXME - home directory portability consideration apply
806         $install_base_default =
807             $ENV{DESTDIR}
808             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
809         ;
810     } elsif ($config{'INSTALL_MODE'} eq 'single') {
811         $msg = "\nPlease specify the directory in which to install Koha";
812         # FIXME -- we're assuming under a 'single' mode install
813         # that user will likely want to install under the home
814         # directory.  This is OK in and of itself, but we should
815         # use File::HomeDir to locate the home directory portably.
816         # This is deferred for now because File::HomeDir is not yet
817         # core.
818                 # --we must also keep this portable to the major OS's -fbcit
819         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
820     } else {
821         # must be standard
822         $msg = q(
823 Please specify the directory under which most Koha files
824 will be installed.
825
826 Note that if you are planning in installing more than
827 one instance of Koha, you may want to modify the last
828 component of the directory path, which will be used
829 as the package name in the FHS layout.
830
831 Base installation directory);
832     }
833     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
834
835     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
836         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
837     if ($config{'INSTALL_MODE'} eq "standard") {
838         $msg = q(
839 Since you are using the 'standard' install
840 mode, you should run 'make install' as root.
841 However, it is recommended that a non-root
842 user (on Unix and Linux platforms) have
843 ownership of Koha's files, including the
844 Zebra indexes if applicable.
845
846 Please specify a user account.  This
847 user account does not need to exist
848 right now, but it needs to exist
849 before you run 'make install'.  Please
850 note that for security reasons, this
851 user should not be the same as the user
852 account Apache runs under.
853
854 User account);
855         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
856
857         $msg = q(
858 Please specify the group that should own
859 Koha's files.  As above, this group need
860 not exist right now, but should be created
861 before you run 'make install'.
862
863 Group);
864         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
865     }
866
867     $msg = q(
868 Please specify which database engine you will use
869 to store data in Koha.  The choices are MySQL and
870 PostgreSQL; please note that at the moment
871 PostgreSQL support is highly experimental.
872
873 DBMS to use);
874     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
875     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
876
877     $msg = q(
878 Please specify the name or address of your
879 database server.  Note that the database
880 does not have to exist at this point, it
881 can be created after running 'make install'
882 and before you try using Koha for the first time.
883
884 Database server);
885     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
886
887     $msg = q(
888 Please specify the port used to connect to the
889 DMBS);
890     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
891     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
892
893     $msg = q(
894 Please specify the name of the database to be
895 used by Koha);
896     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
897
898     $msg = q(
899 Please specify the user that owns the database to be
900 used by Koha);
901     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
902
903     $msg = q(
904 Please specify the password of the user that owns the
905 database to be used by Koha);
906     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
907
908     $msg = q(
909 Koha can use the Zebra search engine for high-performance
910 searching of bibliographic and authority records.  If you
911 have installed the Zebra software and would like to use it,
912 please answer 'yes' to the following question.  Otherwise,
913 Koha will default to using its internal search engine.
914
915 Please note that if you choose *NOT* to install Zebra,
916 koha-conf.xml will still contain some references to Zebra
917 settings.  Those references will be ignored by Koha.
918
919 Install the Zebra configuration files?);
920     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
921     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
922
923     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
924
925         if (defined(my $zebra_path = find_zebra())) {
926             $config{'PATH_TO_ZEBRA'} = $zebra_path;
927             print qq(
928 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
929 );
930         } else {
931             print q(
932 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
933 in your PATH or in some of the usual places.  If you haven't
934 installed Zebra yet, please do so and run Makefile.PL again.
935
936 );
937         }
938
939         $msg = q(
940 Since you've chosen to use Zebra with Koha,
941 you must specify the primary MARC format of the
942 records to be indexed by Zebra.
943
944 Koha provides Zebra configuration files for MARC21,
945 NORMARC and UNIMARC.
946
947 MARC format for Zebra indexing);
948         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
949         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
950         $msg = q(
951 Koha supplies Zebra configuration files tuned for
952 searching either English (en) or French (fr) MARC
953 records.
954
955 Primary language for Zebra indexing);
956         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
957         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
958
959         $msg = q(
960 Koha can use one of  two different indexing modes
961 for the MARC bibliographic records:
962
963 grs1 - uses the Zebra GRS-1 filter, available
964        for legacy support
965 dom  - uses the DOM XML filter; offers improved
966        functionality.
967
968 Bibliographic indexing mode);
969         $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
970         $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
971
972
973         $msg = q(
974 Koha can use one of  two different indexing modes
975 for the MARC authorities records:
976
977 grs1 - uses the Zebra GRS-1 filter, available
978        for legacy support
979 dom  - uses the DOM XML filter; offers improved
980        functionality.
981
982 Authorities indexing mode);
983         $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
984         $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
985
986         $msg = q(
987 Zebra has two methods to perform records tokenization
988 and characters normalization: CHR and ICU. ICU is
989 recommended for catalogs containing non-Latin
990 characters.);
991
992         $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
993         $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
994
995         $msg = q(
996 Please specify Zebra database user);
997         $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
998
999         $msg = q(
1000 Please specify the Zebra database password);
1001         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1002
1003         $msg = q(
1004 Since you've chosen to use Zebra, you can enable the SRU/
1005 Z39.50 Server if you so choose, but you must specify a
1006 few configuration options for it.
1007
1008 Please note that if you choose *NOT* to configure SRU,
1009 koha-conf.xml will still contain some references to SRU
1010 settings.  Those references will be ignored by Koha.
1011
1012 Install the SRU configuration files?);
1013         $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1014         $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1015
1016         if ($config{'INSTALL_SRU'} eq 'yes') {
1017             $msg = q(
1018 Since you've chosen to configure SRU, you must
1019 specify the host and port(s) that the SRU
1020 Servers (bibliographic and authority) should run on.
1021 );
1022             $msg = q(
1023 SRU Database host?);
1024             $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1025
1026             $msg = q(
1027 SRU port for bibliographic data?);
1028             $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1029
1030             $msg = q(
1031 SRU port for authority data?);
1032             $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1033
1034         }
1035
1036         $msg = q(
1037 Since you've chosen to use Zebra, you can also choose to
1038 install PazPar2, which is a metasearch tool.  With PazPar2,
1039 Koha can perform on-the-fly merging of bibliographic
1040 records during searching, allowing for FRBRization of
1041 the results list.
1042
1043 Install the PazPar2 configuration files?);
1044         $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1045         $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1046
1047         if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1048             $msg = q(
1049 Since you've chosen to configure PazPar2, you must
1050 specify the host and port(s) that PazPar2
1051 uses:
1052 );
1053             $msg = q(
1054 Zebra bibliographic server host?);
1055             $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1056
1057             $msg = q(
1058 Zebra bibliographic port for PazPar2 to use?);
1059             $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1060
1061             $msg = q(
1062 PazPar2 host?);
1063             $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1064
1065             $msg = q(
1066 PazPar2 port?);
1067             $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1068
1069         }
1070     }
1071   $msg = q(
1072 Use memcached and memoize to cache the results of some function calls?
1073 This provides a signficant performance improvement.
1074 You will need a Memcached server running.);
1075   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1076   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1077   if ($config{'USE_MEMCACHED'} eq 'yes'){
1078       $msg = q(
1079 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1080 );
1081       $msg = q(
1082 Memcached server address?);
1083       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1084
1085       $msg = q(
1086 Memcached namespace?);
1087       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1088   }
1089
1090
1091
1092   $msg = q(
1093 Would you like to run the database-dependent test suite?);
1094   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1095     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1096
1097   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1098       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1099       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1100       $msg = q(TEST DATABASE
1101
1102 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1103 testing. Please don't do this on your production database. It is not
1104 reversable.
1105
1106 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1107 database. You are better off not running this optional test suite than
1108 doing it in a database that you don't want to lose.
1109
1110 Please specify the name of the test database to be
1111 used by Koha);
1112
1113       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1114       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1115           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1116           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1117       }
1118
1119       $msg = q(
1120 Please specify the user that owns the database to be
1121 used by Koha);
1122     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1123
1124       $msg = q(
1125 Please specify the password of the user that owns the
1126 database to be used by Koha);
1127       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1128   }
1129
1130     print "\n\n";
1131
1132     # add version number
1133     my $version = "no_version_found";
1134     eval {
1135         require 'kohaversion.pl';
1136         $version = kohaversion();
1137     };
1138     $config{'KOHA_INSTALLED_VERSION'} = $version;
1139
1140     return %config;
1141 }
1142
1143 sub _add_valid_values_disp {
1144     my $key = shift;
1145     my $valid_values = shift;
1146
1147     my $disp = "";
1148     if (exists $valid_values->{$key}) {
1149         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1150     }
1151     return $disp;
1152 }
1153
1154 sub _get_value {
1155     my $key = shift;
1156     my $msg = shift;
1157     my $default = shift;
1158     my $valid_values = shift;
1159     my $install_log_values = shift;
1160
1161     # take value from install log if present
1162     if (exists $install_log_values{$key}) {
1163         $install_log_values{$key} =~ s/\$/\$\$/g;
1164         return $install_log_values{$key};
1165     }
1166
1167     # override default value from environment
1168     if (exists $ENV{$key}) {
1169         $default = $ENV{$key};
1170         $msg .= " (default from environment)";
1171     }
1172
1173     my $val = prompt($msg, $default);
1174
1175     while (exists $valid_values->{$key} and
1176            $val ne $default and
1177            not exists $valid_values->{$key}->{$val}) {
1178         my $retry_msg = "Value '$val' is not a valid option.\n";
1179         $retry_msg .= "Please enter a value";
1180         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1181         $val = prompt($retry_msg, $default);
1182     }
1183     $val =~ s/\$/\$\$/g;
1184     return $val;
1185 }
1186
1187 =head2 get_target_directories
1188
1189 Creates a hash mapping from symbols for installation target
1190 directories to actual directory paths.
1191
1192 Also returns a hash indicating targets for which
1193 files need not be copied -- this is used for the 'dev'
1194 mode installation, where some files are installed in place.
1195
1196 =cut
1197
1198 sub get_target_directories {
1199     my $config = shift;
1200
1201     my $base = $config->{'INSTALL_BASE'};
1202     my $mode = $config->{'INSTALL_MODE'};
1203
1204     # get last component of install base directory
1205     # to treat as package name
1206     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1207
1208     my @basedir = File::Spec->splitdir($directories);
1209
1210         # for Win32 we need to prepend the volume to the directory path
1211         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1212         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1213
1214     my $package = pop @basedir;
1215
1216
1217     my %dirmap = ();
1218     my %skipdirs = ();
1219     if ($mode eq 'single') {
1220         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1221         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1222         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1223         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1224         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1225         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1226         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1227         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1228         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1229         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1230         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1231         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1232         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1233         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1234         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1235         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1236         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1237         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1238         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1239         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1240     } elsif ($mode eq 'dev') {
1241         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1242         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1243         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1244         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1245         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1246         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1247         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1248         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1249         $skipdirs{'OPAC_CGI_DIR'} = 1;
1250         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1251         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1252         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1253         $skipdirs{'OPAC_WWW_DIR'} = 1;
1254         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1255         $skipdirs{'PERL_MODULE_DIR'} = 1;
1256         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1257         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1258         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1259         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1260         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1261         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1262         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1263         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1264         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1265         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1266         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1267         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1268         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1269         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1270     } else {
1271         # mode is standard, i.e., 'fhs'
1272         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1273         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1274         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1275         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1276         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1277         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1278         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1279         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1280         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1281         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1282         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1283         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1284         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1285         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1286         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1287         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1288         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1289         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1290         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1291         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1292     }
1293
1294     _get_env_overrides(\%dirmap);
1295     _get_argv_overrides(\%dirmap);
1296     _add_destdir(\%dirmap) unless ($^O eq 'MSWin32');
1297
1298     return \%dirmap, \%skipdirs;
1299 }
1300
1301 =head2 get_test_dir
1302
1303 Map a directory target to the corresponding path for
1304 the test suite.
1305
1306 =cut
1307
1308 sub get_test_dir {
1309     my ($dirname) = @_;
1310
1311     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1312     if (exists $test_suite_override_dirs{$dirname}) {
1313         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1314     } else {
1315         return;
1316     }
1317
1318 }
1319
1320 sub _get_env_overrides {
1321     my $dirmap = shift;
1322
1323     foreach my $key (keys %$dirmap) {
1324         if (exists $ENV{$key}) {
1325             $dirmap->{$key} = $ENV{$key};
1326             print "Setting $key from environment\n";
1327         }
1328     }
1329 }
1330
1331 sub _get_argv_overrides {
1332     my $dirmap = shift;
1333
1334     my @new_argv = ();
1335     for (my $i = 0; $i <= $#ARGV; $i++) {
1336         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1337             $dirmap->{$1} = $2;
1338         } else {
1339             push @new_argv, $ARGV[$i];
1340         }
1341     }
1342     @ARGV = @new_argv;
1343 }
1344
1345 sub _strip_destdir {
1346     my $dir = shift;
1347     $dir =~ s/^\$\(DESTDIR\)//;
1348     return $dir;
1349 }
1350
1351 sub _add_destdir {
1352     my $dirmap = shift;
1353
1354     foreach my $key (keys %$dirmap) {
1355         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1356     }
1357 }
1358
1359 sub display_configuration {
1360     my $config = shift;
1361     my $dirmap = shift;
1362     my @version = grep /\/usr\/share\/perl\//, @INC;
1363     push @version, ('/usr/share/perl/5.10') if !$version[0];
1364     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1365     foreach my $key (sort keys %$config) {
1366         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1367     }
1368
1369     print "\nand in the following directories:\n\n";
1370     foreach my $key (sort keys %$dirmap) {
1371         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1372     }
1373     print "\n\nTo change any configuration setting, please run\n";
1374     print "perl Makefile.PL again.  To override one of the target\n";
1375     print "directories, you can do so on the command line like this:\n";
1376     print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1377     print "You can also set different default values for parameters\n";
1378     print "or override directory locations by using environment variables.\n";
1379     print "\nFor example:\n\n";
1380     print "export DB_USER=my_koha\n";
1381     print "perl Makefile.PL\n";
1382     print "\nor\n\n";
1383     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1384     print "If installing on a Win32 platform, be sure to use:\n";
1385     print "'dmake -x MAXLINELENGTH=300000'\n\n";
1386 }
1387
1388 =head2 find_zebra
1389
1390 Attempt to find Zebra - check user's PATH and
1391 a few other directories for zebrasrv and zebraidx.
1392
1393 FIXME: doesn't handle Win32
1394
1395 =cut
1396
1397 sub find_zebra {
1398     my @search_dirs = map {
1399                             my $abs = File::Spec->rel2abs($_);
1400                             my ($toss, $directories);
1401                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1402                             $directories;
1403                         }  split /:/, $ENV{PATH};
1404     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1405     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1406     return unless @zebrasrv_dirs;
1407     # verify that directory that contains zebrasrv also contains zebraidx
1408     foreach my $dir (@zebrasrv_dirs) {
1409         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1410     }
1411     return;
1412 }
1413
1414 package MY;
1415
1416 # This will have to be reworked in order to accommodate Win32...
1417
1418 sub test {
1419     my $self = shift;
1420     my $test = $self->SUPER::test(@_);
1421     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1422
1423     # set KOHA_CONF
1424     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1425     return $test;
1426 }
1427
1428 sub install {
1429     my $self = shift;
1430     my $install = "";
1431     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1432     # This means that we're completely overriding EU::MM's default
1433     # installation and uninstallation targets.
1434
1435 # If installation is on Win32, we need to do permissions different from *nix
1436     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1437             foreach my $key (sort keys %$target_directories) {
1438                     $install .= qq(
1439 KOHA_INST_$key = blib/$key
1440 KOHA_DEST_$key = $target_directories->{$key}
1441 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1442                 }
1443                 $install .= qq(
1444 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1445 \t\$(NOECHO) \$(NOOP)
1446 );
1447                         $install .= "install_koha ::\n";
1448                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1449                         foreach my $key (sort keys %$target_directories) {
1450                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1451                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1452                         }
1453                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1454                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1455
1456                         $install .= "\n";
1457                         $install .= "set_koha_ownership ::\n";
1458 # Do not try to change ownership if DESTDIR is set
1459                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1460                                 foreach my $key (sort keys %$target_directories) {
1461                                         $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1462                                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1463                                 }
1464                         } else {
1465                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1466                         }
1467
1468                         $install .= "\n";
1469                         $install .= "set_koha_permissions ::\n";
1470                         # This is necessary because EU::MM installs files
1471                         # as either 0444 or 0555, and we want the owner
1472                         # of Koha's files to have write permission by default.
1473                         foreach my $key (sort keys %$target_directories) {
1474                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1475                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1476                         }
1477         }
1478         elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
1479                                                                 # We can attempt some creative things with command line utils such as CACLS which allows permission
1480                                                                 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1481             foreach my $key (sort keys %$target_directories) {
1482                     $install .= qq(
1483 KOHA_INST_$key = blib/$key
1484 KOHA_DEST_$key = $target_directories->{$key}
1485 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1486                 }
1487                 $install .= qq(
1488 install :: all install_koha warn_koha_env_vars
1489 \t\$(NOECHO) \$(NOOP)
1490 );
1491                 $install .= "install_koha ::\n";
1492                 $install .= "\t\$(MOD_INSTALL) \\\n";
1493                 foreach my $key (sort keys %$target_directories) {
1494                         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1495                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1496                 }
1497         }
1498         $install .= "\n";
1499
1500     $install .= "warn_koha_env_vars ::\n";
1501     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1502     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1503     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1504     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1505     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1506     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1507     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1508     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1509     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1510     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1511     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1512
1513     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1514         $install .= _update_zebra_conf_target();
1515     }
1516
1517     $install .= upgrade();
1518
1519     return $install;
1520 }
1521
1522 =head2 _update_zebra_conf_target
1523
1524 Add an installation target for updating
1525 Zebra's configuration files.
1526
1527 =cut
1528
1529 sub _update_zebra_conf_target {
1530
1531     my $target = "\nupdate_zebra_conf ::\n";
1532     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1533     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1534     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1535     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1536     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1537     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1538
1539     return $target;
1540 }
1541
1542 sub upgrade {
1543     my $upgrade = "";
1544
1545     my $backup_suffix;
1546     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1547         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1548         $version =~ s/\./_/g;
1549         $backup_suffix = "_koha_$version";
1550     } else {
1551         $backup_suffix = "_upgrade_backup";
1552     }
1553
1554     $upgrade .= qq/
1555 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1556
1557 upgrade :: make_upgrade_backup install
1558 \t\$(NOECHO) \$(NOOP)
1559 make_upgrade_backup ::
1560 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1561 /;
1562     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1563                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1564         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1565             unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1566                    exists $skip_directories->{$key} or
1567                    not exists $target_directories->{$key};
1568     }
1569     $upgrade =~ s/\\\n$/\n/;
1570
1571     return $upgrade;
1572 }
1573
1574 sub postamble {
1575     # put directory mappings into Makefile
1576     # so that Make will export as environment
1577     # variables -- this is for the use of
1578     # rewrite-confg.PL
1579
1580     my $env;
1581         # Hereagain, we must alter syntax per platform...
1582         if ( $^O eq 'MSWin32' ) {
1583                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1584                 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1585                 $env .= "\n\n";
1586                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1587         }
1588     else {
1589                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1590                 $env .= "\n\n";
1591                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1592         }
1593
1594     if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1595         if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1596             print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1597             print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1598             print $confhandle "# It is separate from the standard koha-conf.xml so that you can edit this by hand and test with different configurations.\n";
1599
1600             # these directories will be relocated to the 't' directory
1601             foreach my $dirname ( keys %$target_directories ) {
1602                 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1603                 if ( exists $test_suite_override_dirs{$dirname} ) {
1604                     $dir = main::get_test_dir($dirname);
1605                 }
1606                 print $confhandle "$dirname = $dir\n"
1607             }
1608             print $confhandle "\n";
1609
1610             print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1611             close( $confhandle );
1612         } else {
1613             warn 'unable to open conf file for database dependent tests: $!';
1614         }
1615
1616     }
1617     return "$env\n";
1618 }
1619
1620
1621 __END__
1622
1623
1624 =head1 SEE ALSO
1625
1626 ExtUtils::MakeMaker(3)
1627
1628 =head1 AUTHORS
1629
1630 MJ Ray mjr at phonecoop.coop
1631 Galen Charlton galen.charlton at liblime.com
1632
1633 =cut
1634
1635 FIXME: deal with .htaccess