add script to install koha on a fresh debian.
[koha.git] / Makefile.PL
1 # Copyright 2007 MJ Ray
2 #
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
8 # version.
9 #
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License along 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 'HTML::Scrubber' => 0.08,
557 'HTTP::Cookies' => 1.39,
558 'HTTP::Request::Common' => 1.26,
559 'Image::Magick' => 6.2,
560 'LWP::Simple' => 1.41,
561 'LWP::UserAgent' => 2.033,
562 'Lingua::Stem' => 0.82,
563 'List::Util' => 1.18,
564 'List::MoreUtils' => 0.21,
565 'Locale::Language' => 2.07,
566 'MARC::Charset' => 0.98,
567 'MARC::Crosswalk::DublinCore' => 0.02,
568 'MARC::File::XML' => 0.88,
569 'MARC::Record' => 2.00,
570 'MIME::Base64' => 3.07,
571 'MIME::QuotedPrint' => 3.07,
572 'Mail::Sendmail' => 0.79,
573 'Net::LDAP' => 0.33,
574 'Net::LDAP::Filter' => 0.14,
575 'Net::Z3950::ZOOM' => 1.16,
576 'PDF::API2' => 2.000,
577 'PDF::API2::Page' => 2.000,
578 'PDF::API2::Util' => 2.000,
579 'PDF::Reuse' => 0.33,
580 'PDF::Reuse::Barcode' => 0.05,
581 'POE' => 0.9999,
582 'POSIX' => 1.09,
583 'Schedule::At' => 1.06,
584 'Term::ANSIColor' => 1.10,
585 'Test' => 1.25,
586 'Test::Harness' => 2.56,
587 'Test::More' => 0.62,
588 'Text::CSV' => 0.01,
589 'Text::CSV_XS' => 0.32,
590 'Text::Iconv' => 1.7,
591 'Text::Wrap' => 2005.082401,
592 'Time::HiRes' => 1.86,
593 'Time::localtime' => 1.02,
594 'Unicode::Normalize' => 0.32,
595 'XML::Dumper' => 0.81,
596 'XML::LibXML' => 1.59,
597 'XML::LibXSLT' => 1.59,
598 'XML::SAX::ParserFactory' => 1.01,
599 'XML::Simple' => 2.14,
600 'XML::RSS' => 1.31,
601 'YAML::Syck' => 0.71,
602         },
603
604         # File tree mapping
605         PM => $file_map,
606
607     # Man pages generated from POD
608     INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
609     INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
610
611     PL_FILES => $pl_files,
612
613 );
614
615 =head1 FUNCTIONS
616
617 =head2 hashdir
618
619 This function recurses through the directory structure and builds
620 a hash of hashes containing the structure with arrays holding filenames.
621 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
622
623 =cut
624
625 sub hashdir{
626     my $dir = shift;
627     opendir my $dh, $dir or die $!;
628     my $tree = {}->{$dir} = {};
629     while( my $file = readdir($dh) ) {
630         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
631         my $path = $dir .'/' . $file;
632         $tree->{$file} = hashdir($path), next if -d $path;
633         push @{$tree->{'.'}}, $file;
634     }
635     return $tree;
636 }
637
638 =head2 get_file_map 
639
640 This function combines the target_map and file hash to
641 map each source file to its destination relative to
642 the set of installation targets.
643
644 Output will be a hash mapping from each source file
645 to its destination value, like this:
646
647 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
648
649 =cut
650
651 sub get_file_map {
652     my $target_map = shift;
653     my $dirtree = shift;
654     my $file_map = shift;
655     my $install_zebra = shift;
656     my $curr_path = @_ ? shift : ['.'];
657
658     # Traverse the directory tree.
659     # For each file or directory, identify the
660     # most specific match in the target_map
661     foreach my $dir (sort keys %{ $dirtree }) {
662         if ($dir eq '.') {
663             # deal with files in directory
664             foreach my $file (sort @{ $dirtree->{$dir} }) {
665                 my $targetdir = undef;
666                 my $matchlevel = undef;
667                 # first, see if there is a match on this specific
668                 # file in the target map
669                 my $filepath = join("/", @$curr_path, $file);
670                 if (exists $target_map->{$filepath}) {
671                     $targetdir = $target_map->{$filepath};
672                     $matchlevel = scalar(@$curr_path) + 1;
673                 } else {
674                     # no match on the specific file; look for
675                     # a directory match
676                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
677                         my $dirpath = join("/", @$curr_path[0..$i]);
678                         if (exists $target_map->{$dirpath}) {
679                             $targetdir = $target_map->{$dirpath};
680                             $matchlevel = $i + 1;
681                             last;
682                         }
683                     }
684                 }
685                 if (defined $targetdir) {
686                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
687                 } else {
688                     my $path = join("/", @$curr_path);
689                     print "failed to map: $path/$file\n" if $DEBUG;
690                 }
691             }
692         } else {
693             # dealing with subdirectory
694             push @$curr_path, $dir;
695             get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
696             pop @$curr_path;
697         }
698     }
699 }
700
701 sub _add_to_file_map {
702     my $file_map = shift;
703     my $targetdir = shift;
704     my $curr_path = shift;
705     my $file = shift;
706     my $matchlevel = shift;
707     my $install_zebra = shift;
708     my $dest_path = @_ ? shift : $curr_path;
709
710     # The target can be one of the following:
711     # 1. scalar representing target symbol
712     # 2. hash ref containing target and trimdir keys
713     #
714     # Consequently, this routine traverses this structure,
715     # calling itself recursively, until it deals with
716     # all of the scalar target symbols.
717     if (ref $targetdir eq 'HASH') {
718         my $subtarget = $targetdir->{target};
719         if (exists $targetdir->{trimdir}) {
720             # if we get here, we've specified that
721             # rather than installing the file to
722             # $(TARGET)/matching/dirs/subdirs/file,
723             # we want to install it to
724             # $(TARGET)/subdirs/file
725             #
726             # Note that this the only place where
727             # $matchlevel is used.
728             my @new_dest_path = @$dest_path;
729             if ($targetdir->{trimdir} == -1)  {
730                 splice @new_dest_path, 0, $matchlevel;
731             } else {
732                 splice @new_dest_path, 0, $targetdir->{trimdir};
733             }
734             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
735         } else {
736             # actually getting here means that the
737             # target was unnecessarily listed
738             # as a hash, but we'll forgive that
739             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
740         }
741     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
742         my $source = File::Spec->catfile(@$curr_path, $file);
743         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
744         #print "$source => $destination\n"; # DEBUG
745         # quote spaces in file names
746         # FIXME: this is of questionable portability and
747         # probably depends on user's make recognizing this
748         # quoting syntax -- probably better to remove
749         # spaces and shell metacharacters from all file names
750         $source =~ s/ /\\ /g;
751         $destination =~ s/ /\\ /g;
752       
753         $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
754     }
755 }
756
757 =head2 get_install_log_values
758
759 Reads value from the Koha install log specified by
760 --prev-install-log
761
762 =cut
763
764 sub get_install_log_values {
765     my $install_log = shift;
766     my $values = shift;
767     
768     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
769     while (<LOG>) {
770         chomp;
771         next if /^#/ or /^\s*$/;
772         next if /^=/;
773         next unless m/=/;
774         s/\s+$//g;
775         my ($key, $value) = split /=/, $_, 2;
776         $values->{$key} = $value;
777     }
778     close LOG;
779
780     print <<_EXPLAIN_INSTALL_LOG_;
781 Reading values from install log $install_log.  You
782 will be prompted only for settings that have been
783 added since the last time you installed Koha.  To
784 be prompted for all settings, run 'perl Makefile.PL'
785 without the --prev-install-log option.
786 _EXPLAIN_INSTALL_LOG_
787 }
788
789 =head2 get_configuration
790
791 This prompts the user for various configuration options.
792
793 =cut
794
795 sub get_configuration {
796   my $defaults = shift;
797   my $valid_values = shift;
798   my $install_log_values = shift;
799   my %config = ();
800
801   my $msg = q(
802 By default, Koha can be installed in one of three ways:
803
804 standard: Install files in conformance with the Filesystem
805           Hierarchy Standard (FHS).  This is the default mode
806           and should be used when installing a production
807           Koha system.  On Unix systems, root access is 
808           needed to complete a standard installation.
809
810 single:   Install files under a single directory.  This option
811           is useful for installing Koha without root access, e.g.,
812           on a web host that allows CGI scripts and MySQL databases
813           but requires the user to keep all files under the user's
814           HOME directory.
815
816 dev:      Create a set of symbolic links and configuration files to
817           allow Koha to run directly from the source distribution.
818           This mode is useful for developers who want to run
819           Koha from a git clone.
820
821 Installation mode);
822     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
823     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
824
825     # set message and default value for INSTALL_BASE
826     # depending on value of INSTALL_MODE
827     my $install_base_default = $defaults->{'INSTALL_BASE'};
828     if ($config{'INSTALL_MODE'} eq 'dev') {
829         $msg = q(
830 Please specify the directory in which to install Koha's
831 active configuration files and (if applicable) the
832 Zebra database.  Koha's CGI scripts and templates will
833 be run from the current directory.
834
835 Configuration directory:);
836         # FIXME - home directory portability consideration apply
837         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
838     } elsif ($config{'INSTALL_MODE'} eq 'single') {
839         $msg = "\nPlease specify the directory in which to install Koha";
840         # FIXME -- we're assuming under a 'single' mode install
841         # that user will likely want to install under the home
842         # directory.  This is OK in and of itself, but we should
843         # use File::HomeDir to locate the home directory portably.  
844         # This is deferred for now because File::HomeDir is not yet
845         # core.
846                 # --we must also keep this portable to the major OS's -fbcit
847         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
848     } else {
849         # must be standard
850         $msg = q(
851 Please specify the directory under which most Koha files 
852 will be installed.
853
854 Note that if you are planning in installing more than 
855 one instance of Koha, you may want to modify the last
856 component of the directory path, which will be used
857 as the package name in the FHS layout.
858
859 Base installation directory);
860     }
861     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
862
863     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
864         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
865     if ($config{'INSTALL_MODE'} eq "standard") {
866         $msg = q(
867 Since you are using the 'standard' install
868 mode, you should run 'make install' as root.
869 However, it is recommended that a non-root
870 user (on Unix and Linux platforms) have 
871 ownership of Koha's files, including the
872 Zebra indexes if applicable.
873
874 Please specify a user account.  This
875 user account does not need to exist
876 right now, but it needs to exist
877 before you run 'make install'.  Please
878 note that for security reasons, this
879 user should not be the same as the user
880 account Apache runs under.
881
882 User account);
883         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
884
885         $msg = q(
886 Please specify the group that should own
887 Koha's files.  As above, this group need
888 not exist right now, but should be created
889 before you run 'make install'.
890
891 Group);
892         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
893     }
894
895     $msg = q(
896 Please specify which database engine you will use
897 to store data in Koha.  The choices are MySQL and
898 PostgreSQL; please note that at the moment
899 PostgreSQL support is highly experimental.
900
901 DBMS to use);
902     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
903     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
904
905     $msg = q(
906 Please specify the name or address of your 
907 database server.  Note that the database 
908 does not have to exist at this point, it
909 can be created after running 'make install'
910 and before you try using Koha for the first time.
911
912 Database server);
913     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
914
915     $msg = q(
916 Please specify the port used to connect to the
917 DMBS);
918     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
919     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
920
921     $msg = q(
922 Please specify the name of the database to be
923 used by Koha);
924     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
925
926     $msg = q(
927 Please specify the user that owns the database to be
928 used by Koha);
929     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
930
931     $msg = q(
932 Please specify the password of the user that owns the 
933 database to be used by Koha);
934     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
935
936     $msg = q(
937 Koha can use the Zebra search engine for high-performance
938 searching of bibliographic and authority records.  If you
939 have installed the Zebra software and would like to use it,
940 please answer 'yes' to the following question.  Otherwise, 
941 Koha will default to using its internal search engine.
942
943 Please note that if you choose *NOT* to install Zebra,
944 koha-conf.xml will still contain some references to Zebra
945 settings.  Those references will be ignored by Koha.
946
947 Install the Zebra configuration files?);
948     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
949     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
950
951     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
952
953         if (defined(my $zebra_path = find_zebra())) {
954             $config{'PATH_TO_ZEBRA'} = $zebra_path;
955             print qq(
956 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
957 );
958         } else {
959             print q(
960 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
961 in your PATH or in some of the usual places.  If you haven't
962 installed Zebra yet, please do so and run Makefile.PL again.
963
964 );
965         }
966
967         $msg = q(
968 Since you've chosen to use Zebra with Koha,
969 you must specify the primary MARC format of the
970 records to be indexed by Zebra.
971
972 Koha provides Zebra configuration files for MARC 21
973 and UNIMARC.
974
975 MARC format for Zebra indexing);
976         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
977         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
978         $msg = q(
979 Koha supplies Zebra configuration files tuned for
980 searching either English (en) or French (fr) MARC
981 records.
982
983 Primary language for Zebra indexing);
984         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
985         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
986    
987         $msg = q(
988 Koha can use one of  two different indexing modes 
989 for the MARC authorities records:
990
991 grs1 - uses the Zebra GRS-1 filter, available 
992        for legacy support
993 dom  - uses the DOM XML filter; offers improved
994        functionality.
995
996 Authorities indexing mode);
997         $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
998         $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
999        
1000         $msg = q(
1001 Please specify Zebra database user);
1002         $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1003
1004         $msg = q(
1005 Please specify the Zebra database password);
1006         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1007
1008         $msg = q(
1009 Since you've chosen to use Zebra, you can enable the SRU/
1010 Z39.50 Server if you so choose, but you must specify a
1011 few configuration options for it.
1012
1013 Please note that if you choose *NOT* to configure SRU,
1014 koha-conf.xml will still contain some references to SRU
1015 settings.  Those references will be ignored by Koha.
1016
1017 Install the SRU configuration files?);
1018         $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1019         $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1020
1021         if ($config{'INSTALL_SRU'} eq 'yes') {
1022             $msg = q(
1023 Since you've chosen to configure SRU, you must
1024 specify the host and port(s) that the SRU
1025 Servers (bibliographic and authority) should run on.
1026 );
1027             $msg = q(
1028 SRU Database host?);
1029             $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1030
1031             $msg = q(
1032 SRU port for bibliographic data?);
1033             $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1034
1035             $msg = q(
1036 SRU port for authority data?);
1037             $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1038
1039         }
1040
1041         $msg = q(
1042 Since you've chosen to use Zebra, you can also choose to
1043 install PazPar2, which is a metasearch tool.  With PazPar2,
1044 Koha can perform on-the-fly merging of bibliographic
1045 records during searching, allowing for FRBRization of
1046 the results list.
1047
1048 Install the PazPar2 configuration files?);
1049         $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1050         $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1051
1052         if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1053             $msg = q(
1054 Since you've chosen to configure PazPar2, you must
1055 specify the host and port(s) that PazPar2
1056 uses:
1057 );
1058             $msg = q(
1059 Zebra bibliographic server host?);
1060             $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1061
1062             $msg = q(
1063 Zebra bibliographic port for PazPar2 to use?);
1064             $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1065
1066             $msg = q(
1067 PazPar2 host?);
1068             $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1069
1070             $msg = q(
1071 PazPar2 port?);
1072             $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1073
1074         }
1075     }
1076
1077   $msg = q(
1078 Would you like to run the database-dependent test suite?);
1079   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1080     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1081
1082   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1083       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1084       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1085       $msg = q(TEST DATABASE
1086
1087 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1088 testing. Please don't do this on your production database. It is not
1089 reversable.
1090
1091 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1092 database. You are better off not running this optional test suite than
1093 doing it in a database that you don't want to lose.
1094
1095 Please specify the name of the test database to be
1096 used by Koha);
1097       
1098       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1099       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1100           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1101           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1102       }
1103
1104       $msg = q(
1105 Please specify the user that owns the database to be
1106 used by Koha);
1107     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1108       
1109       $msg = q(
1110 Please specify the password of the user that owns the 
1111 database to be used by Koha);
1112       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1113   }
1114
1115     print "\n\n";
1116
1117     # add version number
1118     my $version = "no_version_found";
1119     eval {
1120         require 'kohaversion.pl';
1121         $version = kohaversion();
1122     };
1123     $config{'KOHA_INSTALLED_VERSION'} = $version;
1124
1125     return %config;
1126 }
1127
1128 sub _add_valid_values_disp {
1129     my $key = shift;
1130     my $valid_values = shift;
1131    
1132     my $disp = "";
1133     if (exists $valid_values->{$key}) {
1134         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1135     }
1136     return $disp;
1137 }
1138
1139 sub _get_value {
1140     my $key = shift;
1141     my $msg = shift;
1142     my $default = shift;
1143     my $valid_values = shift;
1144     my $install_log_values = shift;
1145
1146     # take value from install log if present
1147     if (exists $install_log_values{$key}) {
1148         return $install_log_values{$key};
1149     }
1150
1151     # override default value from environment
1152     if (exists $ENV{$key}) {
1153         $default = $ENV{$key};
1154         $msg .= " (default from environment)";
1155     }
1156
1157     my $val = prompt($msg, $default);
1158
1159     while (exists $valid_values->{$key} and 
1160            $val ne $default and
1161            not exists $valid_values->{$key}->{$val}) {
1162         my $retry_msg = "Value '$val' is not a valid option.\n";
1163         $retry_msg .= "Please enter a value";
1164         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1165         $val = prompt($retry_msg, $default);
1166     }
1167     return $val;
1168 }
1169
1170 =head2 get_target_directories 
1171
1172 Creates a hash mapping from symbols for installation target
1173 directories to actual directory paths.
1174
1175 Also returns a hash indicating targets for which 
1176 files need not be copied -- this is used for the 'dev'
1177 mode installation, where some files are installed in place.
1178
1179 =cut
1180
1181 sub get_target_directories {
1182     my $config = shift;
1183
1184     my $base = $config->{'INSTALL_BASE'};
1185     my $mode = $config->{'INSTALL_MODE'};
1186
1187     # get last component of install base directory
1188     # to treat as package name
1189     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1190
1191     my @basedir = File::Spec->splitdir($directories);
1192
1193         # for Win32 we need to prepend the volume to the directory path
1194         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1195         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1196
1197     my $package = pop @basedir;
1198
1199
1200     my %dirmap = ();
1201     my %skipdirs = ();
1202     if ($mode eq 'single') {
1203         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1204         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1205         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1206         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1207         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1208         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1209         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1210         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1211         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1212         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1213         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1214         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1215         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1216         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1217         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1218         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1219         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1220         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1221         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1222     } elsif ($mode eq 'dev') {
1223         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1224         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1225         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1226         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1227         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1228         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1229         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1230         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1231         $skipdirs{'OPAC_CGI_DIR'} = 1;
1232         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1233         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1234         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1235         $skipdirs{'OPAC_WWW_DIR'} = 1;
1236         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1237         $skipdirs{'PERL_MODULE_DIR'} = 1;
1238         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1239         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1240         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1241         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1242         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1243         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1244         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1245         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1246         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1247         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1248         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1249         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1250         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1251     } else {
1252         # mode is standard, i.e., 'fhs'
1253         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1254         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1255         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1256         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1257         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1258         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1259         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1260         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1261         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1262         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1263         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1264         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1265         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1266         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1267         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1268         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1269         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1270         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1271         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1272     }
1273
1274     _get_env_overrides(\%dirmap);
1275     _get_argv_overrides(\%dirmap);
1276
1277     return \%dirmap, \%skipdirs;
1278 }
1279
1280 =head2 get_test_dir 
1281
1282 Map a directory target to the corresponding path for
1283 the test suite.
1284
1285 =cut
1286
1287 sub get_test_dir {
1288     my ($dirname) = @_;
1289   
1290     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run'); 
1291     if (exists $test_suite_override_dirs{$dirname}) {
1292         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1293     } else {
1294         return;
1295     }
1296     
1297 }
1298
1299 sub _get_env_overrides {
1300     my $dirmap = shift;
1301
1302     foreach my $key (keys %$dirmap) {
1303         if (exists $ENV{$key}) {
1304             $dirmap->{$key} = $ENV{$key};
1305             print "Setting $key from environment\n";
1306         }
1307     }
1308 }
1309
1310 sub _get_argv_overrides {
1311     my $dirmap = shift;
1312     
1313     my @new_argv = ();
1314     for (my $i = 0; $i <= $#ARGV; $i++) {
1315         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1316             $dirmap->{$1} = $2;
1317         } else {
1318             push @new_argv, $ARGV[$i];
1319         }
1320     }
1321     @ARGV = @new_argv;
1322 }
1323
1324 sub display_configuration {
1325     my $config = shift;
1326     my $dirmap = shift;
1327     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1328     foreach my $key (sort keys %$config) {
1329         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1330     }
1331
1332     print "\nand in the following directories:\n\n";
1333     foreach my $key (sort keys %$dirmap) {
1334         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1335     }
1336     print "\n\nTo change any configuration setting, please run\n";
1337     print "perl Makefile.PL again.  To override one of the target\n";
1338     print "directories, you can do so on the command line like this:\n";
1339     print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1340     print "You can also set different default values for parameters\n";
1341     print "or override directory locations by using environment variables.\n";
1342     print "\nFor example:\n\n";
1343     print "export DB_USER=my_koha\n";
1344     print "perl Makefile.PL\n";
1345     print "\nor\n\n";
1346     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1347     print "If installing on a Win32 platform, be sure to use:\n";
1348     print "'dmake -x MAXLINELENGTH=300000'\n\n";
1349 }
1350
1351 =head2 find_zebra
1352
1353 Attempt to find Zebra - check user's PATH and
1354 a few other directories for zebrasrv and zebraidx.
1355
1356 FIXME: doesn't handle Win32
1357
1358 =cut
1359
1360 sub find_zebra {
1361     my @search_dirs = map {
1362                             my $abs = File::Spec->rel2abs($_);
1363                             my ($toss, $directories);
1364                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1365                             $directories;
1366                         }  split /:/, $ENV{PATH};
1367     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1368     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1369     return unless @zebrasrv_dirs;
1370     # verify that directory that contains zebrasrv also contains zebraidx
1371     foreach my $dir (@zebrasrv_dirs) {
1372         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1373     }
1374     return;
1375 }
1376
1377 package MY;
1378
1379 # This will have to be reworked in order to accommodate Win32...
1380
1381 sub test {
1382     my $self = shift;
1383     my $test = $self->SUPER::test(@_);
1384     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1385
1386     # set KOHA_CONF 
1387     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1388     return $test;
1389 }
1390
1391 sub install {
1392     my $self = shift;
1393     my $install = ""; 
1394     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1395     # This means that we're completely overriding EU::MM's default
1396     # installation and uninstallation targets.
1397
1398 # If installation is on Win32, we need to do permissions different from *nix
1399     if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1400             foreach my $key (sort keys %$target_directories) {
1401                     $install .= qq(
1402 KOHA_INST_$key = blib/$key
1403 KOHA_DEST_$key = $target_directories->{$key}
1404 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1405                 }
1406                 $install .= qq(
1407 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1408 \t\$(NOECHO) \$(NOOP)
1409 );
1410                         $install .= "install_koha ::\n";      
1411                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1412                         foreach my $key (sort keys %$target_directories) {
1413                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" 
1414                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1415                         }
1416                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1417                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1418
1419                         $install .= "\n";
1420                         $install .= "set_koha_ownership ::\n";
1421                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1422                                 foreach my $key (sort keys %$target_directories) {
1423                                         $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1424                                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1425                                 }
1426                         } else {
1427                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1428                         }
1429
1430                         $install .= "\n";
1431                         $install .= "set_koha_permissions ::\n";
1432                         # This is necessary because EU::MM installs files
1433                         # as either 0444 or 0555, and we want the owner
1434                         # of Koha's files to have write permission by default.
1435                         foreach my $key (sort keys %$target_directories) {
1436                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1437                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1438                         }
1439         }
1440         elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
1441                                                                 # We can attempt some creative things with command line utils such as CACLS which allows permission
1442                                                                 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1443             foreach my $key (sort keys %$target_directories) {
1444                     $install .= qq(
1445 KOHA_INST_$key = blib/$key
1446 KOHA_DEST_$key = $target_directories->{$key}
1447 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1448                 }
1449                 $install .= qq(
1450 install :: all install_koha warn_koha_env_vars
1451 \t\$(NOECHO) \$(NOOP)
1452 );
1453                 $install .= "install_koha ::\n";
1454                 $install .= "\t\$(MOD_INSTALL) \\\n";
1455                 foreach my $key (sort keys %$target_directories) {
1456                         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" 
1457                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1458                 }
1459         }
1460         $install .= "\n";
1461
1462     $install .= "warn_koha_env_vars ::\n";
1463     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1464     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1465     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1466     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1467     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1468     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1469     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1470     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1471     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1472     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1473     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1474
1475     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1476         $install .= _update_zebra_conf_target();
1477     }
1478
1479     $install .= upgrade();
1480
1481     return $install;
1482 }
1483
1484 =head2 _update_zebra_conf_target
1485
1486 Add an installation target for updating
1487 Zebra's configuration files.
1488
1489 =cut
1490
1491 sub _update_zebra_conf_target {
1492
1493     my $target = "\nupdate_zebra_conf ::\n";
1494     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1495     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1496     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1497     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1498     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1499     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1500
1501     return $target;
1502 }
1503
1504 sub upgrade {
1505     my $upgrade = ""; 
1506
1507     my $backup_suffix;
1508     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1509         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1510         $version =~ s/\./_/g;
1511         $backup_suffix = "_koha_$version";
1512     } else {
1513         $backup_suffix = "_upgrade_backup";
1514     }
1515
1516     $upgrade .= qq/
1517 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1518
1519 upgrade :: make_upgrade_backup install
1520 \t\$(NOECHO) \$(NOOP)
1521 make_upgrade_backup ::
1522 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1523 /;
1524     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1525                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1526         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" 
1527             unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1528                    exists $skip_directories->{$key} or
1529                    not exists $target_directories->{$key};
1530     }
1531     $upgrade =~ s/\\\n$/\n/;
1532
1533     return $upgrade;
1534 }
1535
1536 sub postamble {
1537     # put directory mappings into Makefile
1538     # so that Make will export as environment
1539     # variables -- this is for the use of
1540     # rewrite-confg.PL
1541
1542     # quote '$' in the two password parameters
1543     my %config = %config;
1544     $config{'DB_PASS'} =~ s/\$/\$\$/g;
1545     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1546         $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1547     }
1548
1549     my $env;
1550         # Hereagain, we must alter syntax per platform...
1551         if ( $^O eq 'MSWin32' ) {
1552                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1553                 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories); 
1554                 $env .= "\n\n";
1555                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1556         }
1557     else {
1558                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories); 
1559                 $env .= "\n\n";
1560                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1561         }
1562     
1563     if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1564         if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1565             print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1566             print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1567             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";
1568
1569             # these directories will be relocated to the 't' directory
1570             foreach my $dirname ( keys %$target_directories ) {
1571                 my $dir = $target_directories->{$dirname};
1572                 if ( exists $test_suite_override_dirs{$dirname} ) {
1573                     $dir = main::get_test_dir($dirname);
1574                 }
1575                 print $confhandle "$dirname = $dir\n"
1576             }
1577             print $confhandle "\n";
1578
1579             print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1580             close( $confhandle );
1581         } else {
1582             warn 'unable to open conf file for database dependent tests: $!';
1583         }
1584           
1585     }
1586     return "$env\n";
1587 }
1588
1589
1590 __END__
1591
1592
1593 =head1 SEE ALSO
1594
1595 ExtUtils::MakeMaker(3)
1596
1597 =head1 AUTHORS
1598
1599 MJ Ray mjr at phonecoop.coop
1600 Galen Charlton galen.charlton at liblime.com
1601
1602 =cut
1603 FIXME: deal with .htaccess