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