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