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