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