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