Bug 26172: (QA follow-up) Add missing filter
[koha.git] / Makefile.PL
blobb2d48ae65f01b975144c9db9d6a5c6c98b1d6d6a
1 # Copyright 2007 MJ Ray
2 # Copyright 2016 PTFS Europe
4 # This file is part of Koha.
6 # Koha is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19 # Current maintainer MJR http://mjr.towers.org.uk/
22 use strict;
23 use warnings;
24 use ExtUtils::MakeMaker;
25 use POSIX;
26 use File::Spec;
27 use Getopt::Long qw/HelpMessage/;
28 use FindBin; # we need to enforce which C4::Installer::PerlModule is used in case more than one is installed
30 use lib $FindBin::Bin;
32 use C4::Installer::PerlModules;
34 my $koha_pm = C4::Installer::PerlModules->new;
36 my $DEBUG = 0;
37 die "perl 5.10 or later required" unless ($] >= 5.010000);
39 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
41 my $dirtree = hashdir('.');
42 my %result = ();
44 =head1 NAME
46 Makefile.PL - Koha packager and installer
48 =head1 SYNOPSIS
50 =head2 BASIC INSTALLATION
52     perl Makefile.PL
53     make
54     make test
55     sudo make install
57 =head2 UPGRADE INSTALLATION
59     NOTE: This option is only available if koha-install-log exists.
61     perl Makefile.PL --prev-install-log /path/to/koha-install-log
63     make
64     make test
65     sudo make upgrade
67 =head2 PACKAGING RELEASE TARBALLS
69     make manifest tardist
70     make manifest zipdist
72 =head2 CLEANING UP
74         make clean
76 =head2 CLI PARAMETERS
78     --prev-install-log           Read configuration from previous installation
79     --install_mode               Installation mode (dev, standard, single)
80     --db_type                    Database (mysql, Pg)
81     --db_host                    Database host (e.g. localhost)
82     --db_port                    Database port (e.g. 3306)
83     --db_name                    Database name (e.g. koha)
84     --db_user                    Database user (e.g. kohaadmin)
85     --db_pass                    Database password (e.g. katikoan)
86     --zebra_marc_format          Zebra MARC format (marc21, normarc, unimarc)
87     --zebra_language             Zebra language (e.g. en)
88     --zebra_tokenizer            Zebra tokenizer (chr, icu)
89     --zebra_user                 Zebra user (e.g. kohauser)
90     --zebra_pass                 Zebra password (e.g. zebrastripes)
91     --zebra_sru_host             Zebra SRU servername (e.g. localhost)
92     --zebra_sru_biblios_port     Zebra SRU biblios port (e.g. 9998)
93     --zebra_sru_authorities_port Zebra SRU biblios port (e.g. 9999)
94     --koha_user                  Koha Unix user (e.g. koha)
95     --koha_group                 Koha Unix group (e.g. koha)
96     --install_sru                Install the SRU server (yes, no)
97     --install_pazpar2            Install PazPar2 (yes, no)
98     --use_memcached              Use Memcached (yes, no)
99     --font_dir                   Location of fonts (e.g. /usr/share/fonts/truetype/dejavu)
100     --run_database_tests         Run database dependent tests (yes, no)
101     --install_base               Base directory of installation (e.g. /usr/share/koha)
102     --template-cache-dir         Specify a template cache directory (e.g. /var/cache/koha)
103     --help                       Display this help message
105 =head1 DESCRIPTION
107 This is a packager and installer that uses
108 ExtUtils::MakeMaker, which is fairly common
109 on perl systems.
110 As well as building tar or zip files
111 and installing with the above commands,
112 it allows us to check pre-requisites
113 and generate configuration files.
115 =head1 VARIABLES
117 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
119 Basic metadata about this software.
121 =head2 NO_META
123 Suppress generation of META.yml file.
125 =head2 PREREQ_PM
127 Hash of perl modules and versions required.
129 =head2 PM
131 Hash of file mappings
133 =head2 PL_FILES
135 This is a hash of PL scripts to run after installation and
136 the files to ask them to generate.
137 Maybe use the values from CONFIGURE
138 to generate initial configuration files in future.
140 =cut
142 =head2 target_map
144 This is a hash mapping directories and files in the
145 source tree to installation target directories.  The rules
146 for this mapping are:
148 =over 4
150 =item If a directory or file is specified, it and its
151 contents will be copied to the installation target directory.
153 =item If a subdirectory of a mapped directory is specified,
154 its target overrides the parent's target for that subdirectory.
156 =item The value of each map entry may either be a scalar containing
157 one target or a reference to a hash containing 'target' and 'trimdir'
158 keys.
160 =item Any files at the top level of the source tree that are
161 not included in the map will not be installed.
163 =item Any directories at the top level of the source tree
164 that are not included in the map will be installed in
165 INTRANET_CGI_DIR.  This is a sensible default given the
166 current organization of the source tree, but (FIXME) it
167 would be better to reorganize the source tree to better
168 match the installation system, to allow adding new directories
169 without having to adjust Makefile.PL each time.  The idea
170 is to make the C<$target_map> hash as minimal as possible.
172 =back
174 The permitted installation targets are:
176 =over 4
178 =item INTRANET_CGI_DIR
180 CGI scripts for intranet (staff) interface.
182 =item INTRANET_TMPL_DIR
184 HTML templates for the intranet interface.
186 =item INTRANET_WWW_DIR
188 HTML files, images, etc. for DocumentRoot for the intranet interface.
190 =item OPAC_CGI_DIR
192 CGI scripts for OPAC (public) interface.
194 =item OPAC_TMPL_DIR
196 HTML templates for the OPAC interface.
198 =item OPAC_WWW_DIR
200 HTML files, images, etc. for DocumentRoot for the OPAC interface.
202 =item PERL_MODULE_DIR
204 Perl modules (at present just the C4 modules) that are intimately
205 tied to Koha.  Depending on the installation options, these
206 may or may not be installed one of the standard directories
207 in Perl's default @LIB.
209 =item KOHA_CONF_DIR
211 Directory for Koha configuration files.
213 =item ZEBRA_CONF_DIR
215 Directory for Zebra configuration files.
217 =item ZEBRA_LOCK_DIR
219 Directory for Zebra's lock files.  This includes subdirs for authorities,
220 biblios, and the zebra rebuild function.  Any activity to reindex
221 zebra from koha should interlock here with rebuild_zebra.pl.
223 =item ZEBRA_DATA_DIR
225 Directory for Zebra's data files.
227 =item ZEBRA_RUN_DIR
229 Directory for Zebra's UNIX-domain sockets.
231 =item ELASTICSEARCH_SERVERS
233 Server:port of the Elasticsearch server to use, as a comma separated list:
234 eg. 192.168.0.100:9200, localhost:9200
236 =item ELASTICSEARCH_INDEX
238 Unique index in Elasticsearch, for this Koha-instance
239 eg. koha-mykoha  or just  koha
241 =item MISC_DIR
243 Directory for for miscellaenous scripts, among other
244 things the translation toolkit and RSS feed tools.
246 =item SCRIPT_DIR
248 Directory for command-line scripts and daemons to
249 be set up all for installation modes.
251 =item SCRIPT_NONDEV_DIR
253 Directory for command-line scripts that should
254 be installed in the same directory as the
255 SCRIPT_DIR target except 'dev' installs.
257 =item MAN_DIR
259 Directory for man pages created from POD -- will mostly
260 contain information of interest to Koha developers.
262 =item DOC_DIR
264 Directory for Koha documentation accessed from the
265 command-line, e.g., READMEs.
267 =item LOCK_DIR
269 Directory for Koha scripts to put their locks.
271 =item LOG_DIR
273 Directory for Apache and Zebra logs produced by Koha.
275 =item BACKUP_DIR
277 Directory for backup files produced by Koha.
279 =item PLUGINS_DIR
281 Directory for external Koha plugins.
283 =item PAZPAR2_CONF_DIR
285 Directory for PazPar2 configuration files.
287 =item FONT_DIR
289 Directory where DejaVu fonts are installed.
291 =item NONE
293 This is a dummy target used to explicitly state
294 that a given file or directory is not to be installed.
295 This is used either for parts of the installer itself
296 or for development tools that are not applicable to a
297 production installation.
299 =back
301 =cut
303 my $target_map = {
304   './about.pl'                  => 'INTRANET_CGI_DIR',
305   './acqui'                     => 'INTRANET_CGI_DIR',
306   './admin'                     => 'INTRANET_CGI_DIR',
307   './api'                       => { target => 'API_CGI_DIR', trimdir => -1 },
308   './app.psgi'                  => 'SCRIPT_DIR',
309   './authorities'               => 'INTRANET_CGI_DIR',
310   './basket'                    => 'INTRANET_CGI_DIR',
311   './bin'                       => { target => 'SCRIPT_DIR', trimdir => -1 },
312   './C4'                        => 'PERL_MODULE_DIR',
313   './C4/SIP/t'                  => 'NONE',
314   './C4/SIP/koha_test'          => 'NONE',
315   './C4/tests'                  => 'NONE',
316   './catalogue'                 => 'INTRANET_CGI_DIR',
317   './cataloguing'               => 'INTRANET_CGI_DIR',
318   './changelanguage.pl'         => 'INTRANET_CGI_DIR',
319   './check_sysprefs.pl'         => 'NONE',
320   './circ'                      => 'INTRANET_CGI_DIR',
321   './clubs'                     => 'INTRANET_CGI_DIR',
322   './course_reserves'           => 'INTRANET_CGI_DIR',
323   './cpanfile'                  => 'PERL_MODULE_DIR',
324   './docs/history.txt'          => { target => 'DOC_DIR', trimdir => -1 },
325   './docs/contributors.yaml'    => { target => 'DOC_DIR', trimdir => -1 },
326   './docs/teams.yaml'           => { target => 'DOC_DIR', trimdir => -1 },
327   './offline_circ'              => 'INTRANET_CGI_DIR',
328   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
329   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
330   './etc/z3950'                 => { target => 'Z3950_CONF_DIR', trimdir => -1 },
331   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
332   './help.pl'                   => 'INTRANET_CGI_DIR',
333   './ill'                       => 'INTRANET_CGI_DIR',
334   './installer-CPAN.pl'         => 'NONE',
335   './installer'                 => 'INTRANET_CGI_DIR',
336   './errors'                    => {target => 'INTRANET_CGI_DIR'},
337   './Koha'                      => 'PERL_MODULE_DIR',
338   './Koha.pm'                   => 'PERL_MODULE_DIR',
339   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
340   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
341   './kohaversion.pl'            => 'INTRANET_CGI_DIR',
342   './labels'                    => 'INTRANET_CGI_DIR',
343   './mainpage.pl'               => 'INTRANET_CGI_DIR',
344   './Makefile.PL'               => 'NONE',
345   './MANIFEST.SKIP'             => 'NONE',
346   './members'                   => 'INTRANET_CGI_DIR',
347   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
348   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
349   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
350   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
351   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
352   './misc/installer_devel_notes' => 'NONE',
353   './opac'                      => 'OPAC_CGI_DIR',
354   './OpenILS'                   => 'PERL_MODULE_DIR',
355   './README.txt'                => 'NONE',
356   './patroncards'               => 'INTRANET_CGI_DIR',
357   './patron_lists'              => 'INTRANET_CGI_DIR',
358   './plugins'                   => 'INTRANET_CGI_DIR',
359   './pos'                       => 'INTRANET_CGI_DIR',
360   './reports'                   => 'INTRANET_CGI_DIR',
361   './reserve'                   => 'INTRANET_CGI_DIR',
362   './reviews'                   => 'INTRANET_CGI_DIR',
363   './rewrite-config.PL'         => 'NONE',
364   './reviews'                   => 'INTRANET_CGI_DIR',
365   './rotating_collections'      => 'INTRANET_CGI_DIR',
366   './serials'                   => 'INTRANET_CGI_DIR',
367   './services'                  => 'INTRANET_CGI_DIR',
368   './skel'                      => 'NONE',
369   './skel/var/lock/koha'        => { target => 'LOCK_DIR', trimdir => -1 },
370   './skel/var/log/koha'         => { target => 'LOG_DIR', trimdir => -1 },
371   './skel/var/spool/koha'       => { target => 'BACKUP_DIR', trimdir => -1 },
372   './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
373   './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
374   './skel/var/lib/koha/zebradb/authorities/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
375   './skel/var/lib/koha/zebradb/authorities/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
376   './skel/var/lib/koha/zebradb/authorities/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
377   './skel/var/lib/koha/zebradb/authorities/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
378   './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
379   './skel/var/lib/koha/zebradb/biblios/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
380   './skel/var/lib/koha/zebradb/biblios/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
381   './skel/var/lib/koha/zebradb/biblios/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
382   './skel/var/lib/koha/zebradb/biblios/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
383   './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
384   './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
385   './sms'                       => 'INTRANET_CGI_DIR',
386   './suggestion'                => 'INTRANET_CGI_DIR',
387   './svc'                       => 'INTRANET_CGI_DIR',
388   './t'                         => 'NONE',
389   './xt'                        => 'NONE',
390   './tags'                      => 'INTRANET_CGI_DIR',
391   './tmp'                       => 'NONE', # FIXME need to determine whether
392                                            # Koha generates any persistent temp files
393                                            # that should go in /var/tmp/koha
394   './tools'                     => 'INTRANET_CGI_DIR',
395   './virtualshelves'            => 'INTRANET_CGI_DIR',
396   # ignore files and directories created by the install itself
397   './pm_to_blib'                => 'NONE',
398   './blib'                      => 'NONE',
399   '.sass-lint.yml'              => 'NONE',
400   '.scss-lint.yml'              => 'NONE',
401   '.eslintrc.json'              => 'NONE',
402   'gulpfile.js'                 => 'NONE',
403   'package.json'                => 'NONE',
404   'yarn.lock'                   => 'NONE',
407 =head1 CONFIGURATION OPTIONS
409 The following configuration options are used by the installer.
411 =over 4
413 =item INSTALL_MODE
415 Specifies whether installation will be FHS-compliant (default,
416 assumes user has root), put everything under
417 a single directory (for users installing on a web host
418 that allows CGI scripts and a MySQL database but not root
419 access), or development (for a developer who wants to run
420 Koha from a git clone with no fuss).
422 =item INSTALL_BASE
424 Directory under which most components will go.  Default
425 value will vary depending on INSTALL_MODE.
427 =item DB_TYPE
429 Type of DBMS (e.g., mysql or Pg).
431 =item DB_HOST
433 Name of DBMS server.
435 =item DB_PORT
437 Port that DBMS server is listening on.
439 =item DB_NAME
441 Name of the DBMS database for Koha.
443 =item DB_USER
445 Name of DBMS user account for Koha's database.
447 =item DB_PASS
449 Pasword of DMBS user account for Koha's database.
451 =item ZEBRA_MARC_FORMAT
453 Specifies format of MARC records to be indexed by Zebra.
455 =item ZEBRA_LANGUAGE
457 Specifies primary language of records that will be
458 indexed by Zebra.
460 =item ZEBRA_USER
462 Internal Zebra user account for the index.
464 =item ZEBRA_PASS
466 Internal Zebra user account's password.
468 =item KOHA_USER
470 System user account that will own Koha's files.
472 =item KOHA_GROUP
474 System group that will own Koha's files.
476 =item SMTP_HOST
478 SMTP server host name (default: localhost)
480 =item SMTP_PORT
482 SMTP server port (default: 25)
484 =item SMTP_TIMEOUT
486 Connection timeour in seconds (default: 120)
488 =item SMTP_SSL_MODE
490 SSL mode. Options are 'disabled' (default), 'ssl' and 'starttls'
492 =item SMTP_USER_NAME
494 SMTP authentication user name
496 =item SMTP_PASSWORD
498 SMTP authentication password
500 =item SMTP_DEBUG
502 Enable debug mode for SMTP (default: no)
504 =back
506 =cut
508 # default configuration options
509 my %config_defaults = (
510   'DB_TYPE'           => 'mysql',
511   'DB_HOST'           => 'localhost',
512   'DB_NAME'           => 'koha',
513   'DB_USER'           => 'kohaadmin',
514   'DB_PASS'           => 'katikoan',
515   'DB_USE_TLS'        => 'no',
516   'DB_TLS_CA_CERTIFICATE'  => '/etc/mysql-ssl/server-ca.pem',
517   'DB_TLS_CLIENT_CERTIFICATE'  => '/etc/mysql-ssl/client-cert.pem',
518   'DB_TLS_CLIENT_KEY' => '/etc/mysql-ssl/client-key.pem',
519   'INSTALL_SRU'       => 'yes',
520   'INSTALL_PAZPAR2'   => 'no',
521   'ZEBRA_MARC_FORMAT' => 'marc21',
522   'ZEBRA_LANGUAGE'    => 'en',
523   'ZEBRA_TOKENIZER'   => 'chr',
524   'ZEBRA_USER'        => 'kohauser',
525   'ZEBRA_PASS'        => 'zebrastripes',
526   'ZEBRA_SRU_HOST'    => 'localhost',
527   'ZEBRA_SRU_BIBLIOS_PORT'    => '9998',
528   'ZEBRA_SRU_AUTHORITIES_PORT'    => '9999',
529   'KOHA_USER'         => 'koha',
530   'KOHA_GROUP'        => 'koha',
531   'MERGE_SERVER_HOST' => 'localhost',
532   'MERGE_SERVER_PORT' => '11001',
533   'PAZPAR2_HOST' => 'localhost',
534   'PAZPAR2_PORT' => '11002',
535   'RUN_DATABASE_TESTS' => 'no',
536   'PATH_TO_ZEBRA' => '',
537   'USE_MEMCACHED'     => 'yes',
538   'MEMCACHED_SERVERS' => '127.0.0.1:11211',
539   'MEMCACHED_NAMESPACE' => 'KOHA',
540   'TEMPLATE_CACHE_DIR' => '/tmp/koha',
541   'USE_ELASTICSEARCH'     => 'no',
542   'ELASTICSEARCH_SERVERS' => 'localhost:9200',
543   'ELASTICSEARCH_INDEX'  => 'koha',
544   'FONT_DIR'          => '/usr/share/fonts/truetype/dejavu',
545   'SMTP_HOST'      => 'localhost',
546   'SMTP_PORT'      => '25',
547   'SMTP_TIMEOUT'   => '120',
548   'SMTP_SSL_MODE'  => 'disabled',
549   'SMTP_USER_NAME' => '',
550   'SMTP_PASSWORD'  => '',
551   'SMTP_DEBUG'     => 'no',
554 # set some default configuration options based on OS
555 # more conditions need to be added for other OS's
557 warn "Your platform appears to be $^O.\n" if $DEBUG;
559 if ( $^O eq 'cygwin' ) {
560         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
561         # this could be changed to put some files (ie. libraries) into system32, etc.
562         $config_defaults{'INSTALL_MODE'} = 'single';
563         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
565 else {
566         $config_defaults{'INSTALL_MODE'} = 'standard';
567         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
570 # valid values for certain configuration options
571 my %valid_config_values = (
572   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
573   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
574   'DB_USE_TLS' => {'yes', 'no'},
575   'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
576   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
577   'ZEBRA_LANGUAGE'    => { 'cs' => 1, 'el' => 1, 'en' => 1, 'es' => 1, 'fr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
578   'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
579   'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
580   'USE_MEMCACHED'      => { 'yes' => 1, 'no' => 1 },
581   'USE_ELASTICSEARCH'  => { 'yes' => 1, 'no' => 1 },
582   'SMTP_SSL_MODE'      => { 'disabled' => 1, 'ssl' => 1, 'starttls' => 1 },
583   'SMTP_DEBUG'         => { 'yes' => 1, 'no' => 1 },
586 # get settings from command-line
587 my $koha_install_log = "";
588 my $cli_koha_install_mode = "";
589 my $cli_koha_db_type = "";
590 my $cli_koha_db_host = "";
591 my $cli_koha_db_port = "";
592 my $cli_koha_db_name = "";
593 my $cli_koha_db_user = "";
594 my $cli_koha_db_pass = "";
595 my $cli_zebra_marc_format = "";
596 my $cli_zebra_language = "",
597 my $cli_zebra_tokenizer = "";
598 my $cli_zebra_user = "";
599 my $cli_zebra_pass = "";
600 my $cli_zebra_sru_host = "";
601 my $cli_zebra_sru_bib_port = "";
602 my $cli_zebra_sru_auth_port = "";
603 my $cli_koha_user = "";
604 my $cli_koha_group = "";
605 my $cli_koha_install_sru = "";
606 my $cli_koha_install_pazpar2 = "";
607 my $cli_koha_use_memcached = "";
608 my $cli_koha_font_dir = "";
609 my $cli_koha_run_database_tests = "";
610 my $cli_koha_install_base = "";
611 my $cli_koha_template_cache_dir = "";
612 my $cli_smtp_host      = "";
613 my $cli_smtp_port      = "";
614 my $cli_smtp_timeout   = "";
615 my $cli_smtp_ssl_mode  = "";
616 my $cli_smtp_user_name = "";
617 my $cli_smtp_password  = "";
618 my $cli_smtp_debug     = "";
620 Getopt::Long::Configure('pass_through');
621 my $results = GetOptions(
622     "prev-install-log=s"           => \$koha_install_log,
623     "install_mode=s"               => \$cli_koha_install_mode,
624     "db_type=s"                    => \$cli_koha_db_type,
625     "db_host=s"                    => \$cli_koha_db_host,
626     "db_port=s"                    => \$cli_koha_db_port,
627     "db_name=s"                    => \$cli_koha_db_name,
628     "db_user=s"                    => \$cli_koha_db_user,
629     "db_pass=s"                    => \$cli_koha_db_pass,
630     "zebra_marc_format=s"          => \$cli_zebra_marc_format,
631     "zebra_language=s"             => \$cli_zebra_language,
632     "zebra_tokenizer=s"            => \$cli_zebra_tokenizer,
633     "zebra_user=s"                 => \$cli_zebra_user,
634     "zebra_pass=s"                 => \$cli_zebra_pass,
635     "zebra_sru_host=s"             => \$cli_zebra_sru_host,
636     "zebra_sru_biblios_port=s"     => \$cli_zebra_sru_bib_port,
637     "zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
638     "koha_user=s"                  => \$cli_koha_user,
639     "koha_group=s"                 => \$cli_koha_group,
640     "install_sru=s"                => \$cli_koha_install_sru,
641     "install_pazpar2=s"            => \$cli_koha_install_pazpar2,
642     "use_memcached=s"              => \$cli_koha_use_memcached,
643     "font_dir=s"                   => \$cli_koha_font_dir,
644     "run_database_tests=s"         => \$cli_koha_run_database_tests,
645     "install_base=s"               => \$cli_koha_install_base,
646     "template-cache-dir=s"         => \$cli_koha_template_cache_dir,
647     "smtp-host=s"                  => \$cli_smtp_host,
648     "smtp-port=s"                  => \$cli_smtp_port,
649     "smtp-timeout=s"               => \$cli_smtp_timeout,
650     "smtp-ssl-mode=s"              => \$cli_smtp_ssl_mode,
651     "smtp-user-name=s"             => \$cli_smtp_user_name,
652     "smtp-password=s"              => \$cli_smtp_password,
653     "smtp-debug"                   => \$cli_smtp_debug,
654     "help"                         => sub { HelpMessage(0) },
655 ) or HelpMessage(1);
657 my %install_log_values = ();
658 if ($koha_install_log ne "") {
659     get_install_log_values($koha_install_log, \%install_log_values);
660 } else {
661     # Try to set install_log_values for provided values;
662     get_cli_values(\%install_log_values);
665 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
666 my ($target_directories, $skip_directories) = get_target_directories(\%config);
667 display_configuration(\%config, $target_directories);
668 my $file_map = {};
669 get_file_map($target_map, $dirtree, $file_map);
671 my $pl_files = {
672       'rewrite-config.PL' => [
673          'blib/KOHA_CONF_DIR/koha-conf.xml',
674          'blib/KOHA_CONF_DIR/koha-httpd.conf',
675          'blib/KOHA_CONF_DIR/log4perl.conf',
676          'blib/ZEBRA_CONF_DIR/etc/default.idx',
677          'blib/MISC_DIR/koha-install-log'
678          ],
679           'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
680                  'blib'
681                  ],
684 push @{ $pl_files->{'rewrite-config.PL'} }, (
685     'blib/ZEBRA_CONF_DIR/etc/passwd',
686     'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
687     'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
688     'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
689     'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
690     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
691     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
693 push @{ $pl_files->{'rewrite-config.PL'} }, (
694     'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
695     'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
696     'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
698 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
699     push @{ $pl_files->{'rewrite-config.PL'} }, (
700         'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
701         'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
702     );
704 $config{'ZEBRA_AUTH_CFG'} = 'zebra-authorities-dom.cfg';
705 $config{'ZEBRA_BIB_CFG'}  = 'zebra-biblios-dom.cfg';
706 $config{'AUTH_RETRIEVAL_CFG'} = 'retrieval-info-auth-dom.xml';
707 $config{'BIB_RETRIEVAL_CFG'}  = 'retrieval-info-bib-dom.xml';
709 if ($config{'INSTALL_MODE'} ne "dev") {
710     push @{ $pl_files->{'rewrite-config.PL'} }, (
711         'blib/PERL_MODULE_DIR/C4/Context.pm',
712         'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
713     );
716 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
717     ? 'icuchain words-icu.xml'
718     : 'charmap word-phrase-utf.chr';
720 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
721     ? 'icuchain phrases-icu.xml'
722     : 'charmap word-phrase-utf.chr';
724 my %test_suite_override_dirs = (
725     KOHA_CONF_DIR  => ['etc'],
726     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
727     Z3950_CONF_DIR => ['etc', 'z3950'],
728     LOCK_DIR       => ['var', 'lock'],
729     LOG_DIR        => ['var', 'log'],
730     BACKUP_DIR     => ['var', 'spool'],
731     SCRIPT_DIR     => ['bin'],
732     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
733     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
734     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
737 WriteMakefile(
738               NAME         => 'koha',
739               #VERSION     => strftime('2.9.%Y%m%d%H',gmtime),
740               VERSION_FROM => 'kohaversion.pl',
741               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
742               AUTHOR       => 'Koha Contributors <https://koha-community.org/>',
743               NO_META      => 1,
744               PREREQ_PM    => $koha_pm->prereq_pm,
746               # File tree mapping
747               PM => $file_map,
749               # Man pages generated from POD
750               # ExtUtils::MakeMaker already manage $(DESTDIR)
751               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
752               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
754               PL_FILES => $pl_files,
757 =head1 FUNCTIONS
759 =head2 hashdir
761 This function recurses through the directory structure and builds
762 a hash of hashes containing the structure with arrays holding filenames.
763 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
765 =cut
767 sub hashdir{
768     my $dir = shift;
769     opendir my $dh, $dir or die $!;
770     my $tree = {}->{$dir} = {};
771     while( my $file = readdir($dh) ) {
772         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
773         my $path = $dir .'/' . $file;
774         $tree->{$file} = hashdir($path), next if -d $path;
775         push @{$tree->{'.'}}, $file;
776     }
777     return $tree;
780 =head2 get_file_map
782 This function combines the target_map and file hash to
783 map each source file to its destination relative to
784 the set of installation targets.
786 Output will be a hash mapping from each source file
787 to its destination value, like this:
789 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
791 =cut
793 sub get_file_map {
794     my $target_map = shift;
795     my $dirtree = shift;
796     my $file_map = shift;
797     my $curr_path = @_ ? shift : ['.'];
799     # Traverse the directory tree.
800     # For each file or directory, identify the
801     # most specific match in the target_map
802     foreach my $dir (sort keys %{ $dirtree }) {
803         if ($dir eq '.') {
804             # deal with files in directory
805             foreach my $file (sort @{ $dirtree->{$dir} }) {
806                 my $targetdir = undef;
807                 my $matchlevel = undef;
808                 # first, see if there is a match on this specific
809                 # file in the target map
810                 my $filepath = join("/", @$curr_path, $file);
811                 if (exists $target_map->{$filepath}) {
812                     $targetdir = $target_map->{$filepath};
813                     $matchlevel = scalar(@$curr_path) + 1;
814                 } else {
815                     # no match on the specific file; look for
816                     # a directory match
817                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
818                         my $dirpath = join("/", @$curr_path[0..$i]);
819                         if (exists $target_map->{$dirpath}) {
820                             $targetdir = $target_map->{$dirpath};
821                             $matchlevel = $i + 1;
822                             last;
823                         }
824                     }
825                 }
826                 if (defined $targetdir) {
827                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
828                 } else {
829                     my $path = join("/", @$curr_path);
830                     print "failed to map: $path/$file\n" if $DEBUG;
831                 }
832             }
833         } else {
834             # dealing with subdirectory
835             push @$curr_path, $dir;
836             get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
837             pop @$curr_path;
838         }
839     }
842 sub _add_to_file_map {
843     my $file_map = shift;
844     my $targetdir = shift;
845     my $curr_path = shift;
846     my $file = shift;
847     my $matchlevel = shift;
848     my $dest_path = @_ ? shift : $curr_path;
850     # The target can be one of the following:
851     # 1. scalar representing target symbol
852     # 2. hash ref containing target and trimdir keys
853     #
854     # Consequently, this routine traverses this structure,
855     # calling itself recursively, until it deals with
856     # all of the scalar target symbols.
857     if (ref $targetdir eq 'HASH') {
858         my $subtarget = $targetdir->{target};
859         if (exists $targetdir->{trimdir}) {
860             # if we get here, we've specified that
861             # rather than installing the file to
862             # $(TARGET)/matching/dirs/subdirs/file,
863             # we want to install it to
864             # $(TARGET)/subdirs/file
865             #
866             # Note that this the only place where
867             # $matchlevel is used.
868             my @new_dest_path = @$dest_path;
869             if ($targetdir->{trimdir} == -1)  {
870                 splice @new_dest_path, 0, $matchlevel;
871             } else {
872                 splice @new_dest_path, 0, $targetdir->{trimdir};
873             }
874             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
875         } else {
876             # actually getting here means that the
877             # target was unnecessarily listed
878             # as a hash, but we'll forgive that
879             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
880         }
881     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
882         my $source = File::Spec->catfile(@$curr_path, $file);
883         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
884         #print "$source => $destination\n"; # DEBUG
885         # quote spaces in file names
886         # FIXME: this is of questionable portability and
887         # probably depends on user's make recognizing this
888         # quoting syntax -- probably better to remove
889         # spaces and shell metacharacters from all file names
890         $source =~ s/ /\\ /g;
891         $destination =~ s/ /\\ /g;
893         $file_map->{$source} = $destination;
894     }
897 =head2 get_cli_values
899 Reads values provided on cli for configuration values
901 =cut
903 sub get_cli_values {
904     my $values = shift;
905     my $map = {
906         INSTALL_MODE               => $cli_koha_install_mode,
907         DB_TYPE                    => $cli_koha_db_type,
908         DB_HOST                    => $cli_koha_db_host,
909         DB_PORT                    => $cli_koha_db_port,
910         DB_NAME                    => $cli_koha_db_name,
911         DB_USER                    => $cli_koha_db_user,
912         DB_PASS                    => $cli_koha_db_pass,
913         ZEBRA_MARC_FORMAT          => $cli_zebra_marc_format,
914         ZEBRA_LANGUAGE             => $cli_zebra_language,
915         ZEBRA_TOKENIZER            => $cli_zebra_tokenizer,
916         ZEBRA_USER                 => $cli_zebra_user,
917         ZEBRA_PASS                 => $cli_zebra_pass,
918         ZEBRA_SRU_HOST             => $cli_zebra_sru_host,
919         ZEBRA_SRU_BIBLIOS_PORT     => $cli_zebra_sru_bib_port,
920         ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
921         KOHA_USER                  => $cli_koha_user,
922         KOHA_GROUP                 => $cli_koha_group,
923         INSTALL_SRU                => $cli_koha_install_sru,
924         INSTALL_PAZPAR2            => $cli_koha_install_pazpar2,
925         USE_MEMCACHED              => $cli_koha_use_memcached,
926         FONT_DIR                   => $cli_koha_font_dir,
927         RUN_DATABASE_TESTS         => $cli_koha_run_database_tests,
928         INSTALL_BASE               => $cli_koha_install_base,
929         TEMPLATE_CACHE_DIR         => $cli_koha_template_cache_dir,
930         SMTP_HOST                  => $cli_smtp_host,
931         SMTP_PORT                  => $cli_smtp_port,
932         SMTP_TIMEOUT               => $cli_smtp_timeout,
933         SMTP_SSL_MODE              => $cli_smtp_ssl_mode,
934         SMTP_USER_NAME             => $cli_smtp_user_name,
935         SMTP_PASSWORD              => $cli_smtp_password,
936         SMTP_DEBUG                 => (defined $cli_smtp_debug) ? ( $cli_smtp_debug ? 'yes' : 'no' ) : $values->{SMTP_DEBUG},
937     };
938     foreach my $key (keys %{$map}) {
939         $values->{$key} = $map->{$key} if ($map->{$key});
940     }
943 =head2 get_install_log_values
945 Reads value from the Koha install log specified by
946 --prev-install-log
948 =cut
950 sub get_install_log_values {
951     my $install_log = shift;
952     my $values = shift;
954     open my $log, '<', $install_log or die "Cannot open install log $install_log: $!\n";
955     while (<$log>) {
956         chomp;
957         next if /^#/ or /^\s*$/;
958         next if /^=/;
959         next unless m/=/;
960         s/\s+$//g;
961         my ($key, $value) = split /=/, $_, 2;
962         $values->{$key} = $value;
963     }
964     close $log;
966     print <<_EXPLAIN_INSTALL_LOG_;
967 Reading values from install log $install_log.  You
968 will be prompted only for settings that have been
969 added since the last time you installed Koha.  To
970 be prompted for all settings, run 'perl Makefile.PL'
971 without the --prev-install-log option.
972 _EXPLAIN_INSTALL_LOG_
975 =head2 get_configuration
977 This prompts the user for various configuration options.
979 =cut
981 sub get_configuration {
982   my $defaults = shift;
983   my $valid_values = shift;
984   my $install_log_values = shift;
985   my %config = ();
987   my $msg = q(
988 By default, Koha can be installed in one of three ways:
990 standard: Install files in conformance with the Filesystem
991           Hierarchy Standard (FHS).  This is the default mode
992           and should be used when installing a production
993           Koha system.  On Unix systems, root access is
994           needed to complete a standard installation.
996 single:   Install files under a single directory.  This option
997           is useful for installing Koha without root access, e.g.,
998           on a web host that allows CGI scripts and MySQL databases
999           but requires the user to keep all files under the user's
1000           HOME directory.
1002 dev:      Create a set of symbolic links and configuration files to
1003           allow Koha to run directly from the source distribution.
1004           This mode is useful for developers who want to run
1005           Koha from a git clone.
1007 Installation mode);
1008     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
1009     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
1011     # set message and default value for INSTALL_BASE
1012     # depending on value of INSTALL_MODE
1013     my $install_base_default = $defaults->{'INSTALL_BASE'};
1014     if ($config{'INSTALL_MODE'} eq 'dev') {
1015         $msg = q(
1016 Please specify the directory in which to install Koha's
1017 active configuration files and (if applicable) the
1018 Zebra database.  Koha's CGI scripts and templates will
1019 be run from the current directory.
1021 Configuration directory:);
1022         # FIXME - home directory portability consideration apply
1023         $install_base_default =
1024             $ENV{DESTDIR}
1025             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
1026         ;
1027     } elsif ($config{'INSTALL_MODE'} eq 'single') {
1028         $msg = "\nPlease specify the directory in which to install Koha";
1029         # FIXME -- we're assuming under a 'single' mode install
1030         # that user will likely want to install under the home
1031         # directory.  This is OK in and of itself, but we should
1032         # use File::HomeDir to locate the home directory portably.
1033         # This is deferred for now because File::HomeDir is not yet
1034         # core.
1035                 # --we must also keep this portable to the major OS's -fbcit
1036         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
1037     } else {
1038         # must be standard
1039         $msg = q(
1040 Please specify the directory under which most Koha files
1041 will be installed.
1043 Note that if you are planning in installing more than
1044 one instance of Koha, you may want to modify the last
1045 component of the directory path, which will be used
1046 as the package name in the FHS layout.
1048 Base installation directory);
1049     }
1050     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
1052     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
1053         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
1054     if ($config{'INSTALL_MODE'} eq "standard") {
1055         $msg = q(
1056 Since you are using the 'standard' install
1057 mode, you should run 'make install' as root.
1058 However, it is recommended that a non-root
1059 user (on Unix and Linux platforms) have
1060 ownership of Koha's files, including the
1061 Zebra indexes if applicable.
1063 Please specify a user account.  This
1064 user account does not need to exist
1065 right now, but it needs to exist
1066 before you run 'make install'.  Please
1067 note that for security reasons, this
1068 user should not be the same as the user
1069 account Apache runs under.
1071 User account);
1072         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
1074         $msg = q(
1075 Please specify the group that should own
1076 Koha's files.  As above, this group need
1077 not exist right now, but should be created
1078 before you run 'make install'.
1080 Group);
1081         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
1082     }
1084     $msg = q(
1085 Please specify which database engine you will use
1086 to store data in Koha.  The choices are MySQL and
1087 PostgreSQL; please note that at the moment
1088 PostgreSQL support is highly experimental.
1090 DBMS to use);
1091     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
1092     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
1094     $msg = q(
1095 Please specify the name or address of your
1096 database server.  Note that the database
1097 does not have to exist at this point, it
1098 can be created after running 'make install'
1099 and before you try using Koha for the first time.
1101 Database server);
1102     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
1104     $msg = q(
1105 Please specify the port used to connect to the
1106 DMBS);
1107     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
1108     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
1110     $msg = q(
1111 Please specify the name of the database to be
1112 used by Koha);
1113     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
1114     if ($config{'DB_TYPE'} eq 'mysql'){
1115         $msg = q(
1116 Please specify whether the connection to MySQL will use TLS
1117         );
1118         $config{'DB_USE_TLS'} = _get_value('DB_USE_TLS', $msg, $defaults->{'DB_USE_TLS'}, $valid_values, $install_log_values);
1119     }
1120     if ($config{'DB_USE_TLS'} eq 'yes'){
1121         $msg = q(
1122 Please enter the path to the CA certificate for TLS
1123         );
1124         $config{'DB_TLS_CA_CERTIFICATE'} = _get_value('DB_TLS_CA_CERTIFICATE', $msg, $defaults->{'DB_TLS_CA_CERTIFICATE'}, $valid_values, $install_log_values);
1126         $msg = q(
1127 Please enter the path to the client certificate for TLS
1128         );
1129         $config{'DB_TLS_CLIENT_CERTIFICATE'} = _get_value('DB_TLS_CLIENT_CERTIFICATE', $msg, $defaults->{'DB_TLS_CLIENT_CERTIFICATE'}, $valid_values, $install_log_values);
1130         $msg = q(
1131 Please enter the path to the client key for TLS
1132         );
1133         $config{'DB_TLS_CLIENT_KEY'} = _get_value('DB_TLS_CLIENT_KEY', $msg, $defaults->{'DB_TLS_CLIENT_KEY'}, $valid_values, $install_log_values);
1134     }
1136     $msg = q(
1137 Please specify the user that owns the database to be
1138 used by Koha);
1139     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
1141     $msg = q(
1142 Please specify the password of the user that owns the
1143 database to be used by Koha);
1144     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
1146     print q(
1147 Koha uses the Zebra search engine for high-performance
1148 searching of bibliographic and authority records.  Checking
1149 to see if you have installed the Zebra software...
1152     if (defined(my $zebra_path = find_zebra())) {
1153         $config{'PATH_TO_ZEBRA'} = $zebra_path;
1154         print qq(
1155 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
1157     } else {
1158         print q(
1159 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
1160 in your PATH or in some of the usual places.  If you haven't
1161 installed Zebra yet, please do so and run Makefile.PL again.
1164     }
1166     $msg = q(
1167 You must specify the primary MARC format of the
1168 records to be indexed by Zebra.
1170 Koha provides Zebra configuration files for MARC21,
1171 NORMARC and UNIMARC.
1173 MARC format for Zebra indexing);
1174     $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1175     $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1176     $msg = q(
1177 Koha supplies Zebra configuration files tuned for
1178 searching either English (en) or French (fr) MARC
1179 records.
1181 Primary language for Zebra indexing);
1182     $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1183     $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1185     $msg = q(
1186 Zebra has two methods to perform records tokenization
1187 and characters normalization: CHR and ICU. ICU is
1188 recommended for catalogs containing non-Latin
1189 characters.);
1191     $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
1192     $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
1194     $msg = q(
1195 Please specify Zebra database user);
1196     $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1198     $msg = q(
1199 Please specify the Zebra database password);
1200     $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1202     $msg = q(
1203 Since you've chosen to use Zebra, you can enable the SRU/
1204 Z39.50 Server if you so choose, but you must specify a
1205 few configuration options for it.
1207 Please note that if you choose *NOT* to configure SRU,
1208 koha-conf.xml will still contain some references to SRU
1209 settings.  Those references will be ignored by Koha.
1211 Install the SRU configuration files?);
1212     $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1213     $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1215     if ($config{'INSTALL_SRU'} eq 'yes') {
1216         $msg = q(
1217 Since you've chosen to configure SRU, you must
1218 specify the host and port(s) that the SRU
1219 Servers (bibliographic and authority) should run on.
1221         $msg = q(
1222 SRU Database host?);
1223         $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1225         $msg = q(
1226 SRU port for bibliographic data?);
1227         $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1229         $msg = q(
1230 SRU port for authority data?);
1231         $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1233     }
1235     $msg = q(
1236 Along with Zebra, you can also choose to install PazPar2,
1237 which is a metasearch tool.  With PazPar2,
1238 Koha can perform on-the-fly merging of bibliographic
1239 records during searching, allowing for FRBRization of
1240 the results list.
1242 Install the PazPar2 configuration files?);
1243     $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1244     $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1246     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1247         $msg = q(
1248 Since you've chosen to configure PazPar2, you must
1249 specify the host and port(s) that PazPar2
1250 uses:
1252         $msg = q(
1253 Zebra bibliographic server host?);
1254         $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1256         $msg = q(
1257 Zebra bibliographic port for PazPar2 to use?);
1258         $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1260         $msg = q(
1261 PazPar2 host?);
1262         $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1264         $msg = q(
1265 PazPar2 port?);
1266         $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1268     }
1270   $msg = q(
1271 Use memcached to cache the results of some function calls?
1272 This provides a significant performance improvement.
1273 You will need a Memcached server running.);
1274   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1275   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1276   if ($config{'USE_MEMCACHED'} eq 'yes'){
1277       $msg = q(
1278 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1280       $msg = q(
1281 Memcached server address?);
1282       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1284       $msg = q(
1285 Memcached namespace?);
1286       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1287   }
1290   $msg = q(
1291 Use Elasticsearch to serve search results?
1292 You will need a Elasticsearch server running.);
1293   $msg .= _add_valid_values_disp('USE_ELASTICSEARCH', $valid_values);
1294   $config{'USE_ELASTICSEARCH'} = _get_value('USE_ELASTICSEARCH', $msg, $defaults->{'USE_ELASTICSEARCH'}, $valid_values, $install_log_values);
1295   if ($config{'USE_ELASTICSEARCH'} eq 'yes'){
1296       $msg = q(
1297 Define the ELASTICSEARCH_SERVERS with a comma-separated list. Eg
1298 localhost:9200, 192.168.0.100:9200
1300       $msg = q(
1301 Elasticsearch server addresses?);
1302       $config{'ELASTICSEARCH_SERVERS'} = _get_value('ELASTICSEARCH_SERVERS', $msg, $defaults->{'ELASTICSEARCH_SERVERS'}, $valid_values, $install_log_values);
1304       $msg = q(
1305 What index name to use for this Koha-instance? It must be unique for each Koha
1306 sharing the same Elasticsearch-cluster
1308 Elasticsearch index?);
1309       $config{'ELASTICSEARCH_INDEX'} = _get_value('ELASTICSEARCH_INDEX', $msg, $defaults->{'ELASTICSEARCH_INDEX'}, $valid_values, $install_log_values);
1310   }
1312   $msg = q(
1313 Template cache directory?);
1314   $config{'TEMPLATE_CACHE_DIR'} = _get_value('TEMPLATE_CACHE_DIR', $msg, $defaults->{'TEMPLATE_CACHE_DIR'}, $valid_values, $install_log_values);
1316   $msg = q(
1317 Path to DejaVu fonts?);
1318   $config{'FONT_DIR'} = _get_value('FONT_DIR', $msg, $defaults->{'FONT_DIR'}, $valid_values, $install_log_values);
1320   $msg = q(
1321 SMTP settings
1322 You will be able to set your default SMTP configuration.);
1323   $msg .= q{
1324 SMTP host name?};
1325   $config{'SMTP_HOST'} = _get_value('SMTP_HOST', $msg, $defaults->{'SMTP_HOST'}, $valid_values, $install_log_values);
1327   $msg = q{
1328 SMTP port?};
1329   $config{'SMTP_PORT'} = _get_value('SMTP_PORT', $msg, $defaults->{'SMTP_PORT'}, $valid_values, $install_log_values);
1331   $msg = q{
1332 SMTP timeout (in seconds)?};
1333   $config{'SMTP_TIMEOUT'} = _get_value('SMTP_TIMEOUT', $msg, $defaults->{'SMTP_TIMEOUT'}, $valid_values, $install_log_values);
1335   $msg = q{
1336 SMTP SSL mode?};
1337   $msg .= _add_valid_values_disp('SMTP_SSL_MODE', $valid_values);
1338   $config{'SMTP_SSL_MODE'} = _get_value('SMTP_SSL_MODE', $msg, $defaults->{'SMTP_SSL_MODE'}, $valid_values, $install_log_values);
1340   $msg = q{
1341 SMTP user name?};
1342   $config{'SMTP_USER_NAME'} = _get_value('SMTP_USER_NAME', $msg, $defaults->{'SMTP_USER_NAME'}, $valid_values, $install_log_values);
1344   $msg = q{
1345 SMTP password?};
1346   $config{'SMTP_PASSWORD'} = _get_value('SMTP_PASSWORD', $msg, $defaults->{'SMTP_PASSWORD'}, $valid_values, $install_log_values);
1348   $msg = q{
1349 SMTP debug mode?};
1350   $msg .= _add_valid_values_disp('SMTP_DEBUG', $valid_values);
1351   $config{'SMTP_DEBUG'} = _get_value('SMTP_DEBUG', $msg, $defaults->{'SMTP_DEBUG'}, $valid_values, $install_log_values);
1353   $config{'SMTP_DEBUG'} = ( $config{'SMTP_DEBUG'} eq 'yes' ) ? 1 : 0;
1355   $msg = q(
1356 Would you like to run the database-dependent test suite?);
1357   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1358     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1360   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1361       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1362       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1363       $msg = q(TEST DATABASE
1365 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1366 testing. Please don't do this on your production database. It is not
1367 reversible.
1369 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1370 database. You are better off not running this optional test suite than
1371 doing it in a database that you don't want to lose.
1373 Please specify the name of the test database to be
1374 used by Koha);
1376       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1377       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1378           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1379           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1380       }
1382       $msg = q(
1383 Please specify the user that owns the database to be
1384 used by Koha);
1385     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1387       $msg = q(
1388 Please specify the password of the user that owns the
1389 database to be used by Koha);
1390       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1391   }
1393     print "\n\n";
1395     # add version number
1396     my $version = "no_version_found";
1397     eval {
1398         require 'kohaversion.pl';
1399         $version = kohaversion();
1400     };
1401     $config{'KOHA_INSTALLED_VERSION'} = $version;
1403     return %config;
1406 sub _add_valid_values_disp {
1407     my $key = shift;
1408     my $valid_values = shift;
1410     my $disp = "";
1411     if (exists $valid_values->{$key}) {
1412         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1413     }
1414     return $disp;
1417 sub _get_value {
1418     my $key = shift;
1419     my $msg = shift;
1420     my $default = shift;
1421     my $valid_values = shift;
1422     my $install_log_values = shift;
1424     # take value from install log if present
1425     if (exists $install_log_values{$key}) {
1426         $install_log_values{$key} =~ s/\$/\$\$/g;
1427         return $install_log_values{$key};
1428     }
1430     # override default value from environment
1431     if (exists $ENV{$key}) {
1432         $default = $ENV{$key};
1433         $msg .= " (default from environment)";
1434     }
1436     my $val = prompt($msg, $default);
1438     while (exists $valid_values->{$key} and
1439            $val ne $default and
1440            not exists $valid_values->{$key}->{$val}) {
1441         my $retry_msg = "Value '$val' is not a valid option.\n";
1442         $retry_msg .= "Please enter a value";
1443         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1444         $val = prompt($retry_msg, $default);
1445     }
1446     $val =~ s/\$/\$\$/g;
1447     return $val;
1450 =head2 get_target_directories
1452 Creates a hash mapping from symbols for installation target
1453 directories to actual directory paths.
1455 Also returns a hash indicating targets for which
1456 files need not be copied -- this is used for the 'dev'
1457 mode installation, where some files are installed in place.
1459 =cut
1461 sub get_target_directories {
1462     my $config = shift;
1464     my $base = $config->{'INSTALL_BASE'};
1465     my $mode = $config->{'INSTALL_MODE'};
1467     # get last component of install base directory
1468     # to treat as package name
1469     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1471     my @basedir = File::Spec->splitdir($directories);
1473     if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1475     my $package = pop @basedir;
1478     my %dirmap = ();
1479     my %skipdirs = ();
1480     if ($mode eq 'single') {
1481         $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1482         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1483         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1484         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1485         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1486         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1487         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1488         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1489         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1490         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1491         $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'z3950');
1492         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1493         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1494         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1495         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1496         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1497         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1498         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1499         $dirmap{'LOCK_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lock');
1500         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1501         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1502         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1503         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1504         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1505     } elsif ($mode eq 'dev') {
1506         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1507         $dirmap{'API_CGI_DIR'} = File::Spec->catdir($curdir, 'api');
1508         $skipdirs{'API_CGI_DIR'} = 1;
1509         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1510         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1511         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1512         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1513         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1514         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1515         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1516         $skipdirs{'OPAC_CGI_DIR'} = 1;
1517         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1518         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1519         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1520         $skipdirs{'OPAC_WWW_DIR'} = 1;
1521         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1522         $skipdirs{'PERL_MODULE_DIR'} = 1;
1523         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1524         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1525         $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'z3950');
1526         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1527         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1528         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1529         #For dev install, point NONDEV_DIR to misc in current dir (not base)
1530         #Used by supportdir in koha-conf.xml (BZ 12031)
1531         $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1532         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1533         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1534         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1535         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1536         $dirmap{'LOCK_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lock');
1537         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1538         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1539         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1540         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1541         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1542     } else {
1543         # mode is standard, i.e., 'fhs'
1544         $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1545         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1546         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1547         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1548         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1549         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1550         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1551         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1552         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1553         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1554         $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'z3950');
1555         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1556         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1557         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1558         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1559         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1560         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1561         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1562         $dirmap{'LOCK_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package);
1563         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1564         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1565         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1566         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1567         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1568     }
1570     _get_env_overrides(\%dirmap);
1571     _get_argv_overrides(\%dirmap);
1572     _add_destdir(\%dirmap);
1574     return \%dirmap, \%skipdirs;
1577 =head2 get_test_dir
1579 Map a directory target to the corresponding path for
1580 the test suite.
1582 =cut
1584 sub get_test_dir {
1585     my ($dirname) = @_;
1587     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1588     if (exists $test_suite_override_dirs{$dirname}) {
1589         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1590     } else {
1591         return;
1592     }
1596 sub _get_env_overrides {
1597     my $dirmap = shift;
1599     foreach my $key (keys %$dirmap) {
1600         if (exists $ENV{$key}) {
1601             $dirmap->{$key} = $ENV{$key};
1602             print "Setting $key from environment\n";
1603         }
1604     }
1607 sub _get_argv_overrides {
1608     my $dirmap = shift;
1610     my @new_argv = ();
1611     for (my $i = 0; $i <= $#ARGV; $i++) {
1612         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1613             $dirmap->{$1} = $2;
1614         } else {
1615             push @new_argv, $ARGV[$i];
1616         }
1617     }
1618     @ARGV = @new_argv;
1621 sub _strip_destdir {
1622     my $dir = shift;
1623     $dir =~ s/^\$\(DESTDIR\)//;
1624     return $dir;
1627 sub _add_destdir {
1628     my $dirmap = shift;
1630     foreach my $key (keys %$dirmap) {
1631         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1632     }
1635 sub display_configuration {
1636     my $config = shift;
1637     my $dirmap = shift;
1638     my @version = grep /\/usr\/share\/perl\//, @INC;
1639     push @version, ('/usr/share/perl/5.10') if !$version[0];
1640     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1641     foreach my $key (sort keys %$config) {
1642         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1643     }
1645     print "\nand in the following directories:\n\n";
1646     foreach my $key (sort keys %$dirmap) {
1647         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1648     }
1649     print "\n\nTo change any configuration setting, please run\n";
1650     print "perl Makefile.PL again.  To override one of the target\n";
1651     print "directories, you can do so on the command line like this:\n";
1652     print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1653     print "You can also set different default values for parameters\n";
1654     print "or override directory locations by using environment variables.\n";
1655     print "\nFor example:\n\n";
1656     print "export DB_USER=my_koha\n";
1657     print "perl Makefile.PL\n";
1658     print "\nor\n\n";
1659     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1662 =head2 find_zebra
1664 Attempt to find Zebra - check user's PATH and
1665 a few other directories for zebrasrv and zebraidx.
1667 =cut
1669 sub find_zebra {
1670     my @search_dirs = map {
1671                             my $abs = File::Spec->rel2abs($_);
1672                             my ($toss, $directories);
1673                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1674                             $directories;
1675                         }  split /:/, $ENV{PATH};
1676     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1677     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1678     return unless @zebrasrv_dirs;
1679     # verify that directory that contains zebrasrv also contains zebraidx
1680     foreach my $dir (@zebrasrv_dirs) {
1681         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1682     }
1683     return;
1686 package MY;
1688 sub test {
1689     my $self = shift;
1690     my $test = $self->SUPER::test(@_);
1691     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1693     # set KOHA_CONF
1694     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1695     return $test;
1698 sub install {
1699     my $self = shift;
1700     my $install = "";
1701     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1702     # This means that we're completely overriding EU::MM's default
1703     # installation and uninstallation targets.
1705 # If installation is on Win32, we need to do permissions different from *nix
1706     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1707             foreach my $key (sort keys %$target_directories) {
1708                     $install .= qq(
1709 KOHA_INST_$key = blib/$key
1710 KOHA_DEST_$key = $target_directories->{$key}
1711 ) unless exists $skip_directories->{$key};
1712                 }
1713                 $install .= qq(
1714 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1715 \t\$(NOECHO) \$(NOOP)
1717                         $install .= "install_koha ::\n";
1718                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1719                         foreach my $key (sort keys %$target_directories) {
1720                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1721           unless exists $skip_directories->{$key};
1722                         }
1723                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1724                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1726                         $install .= "\n";
1727                         $install .= "set_koha_ownership ::\n";
1728 # Do not try to change ownership if DESTDIR is set
1729                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1730                                 foreach my $key (sort keys %$target_directories) {
1731             $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1732             unless exists $skip_directories->{$key};
1733                                 }
1734                         } else {
1735                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1736                         }
1738                         $install .= "\n";
1739                         $install .= "set_koha_permissions ::\n";
1740                         # This is necessary because EU::MM installs files
1741                         # as either 0444 or 0555, and we want the owner
1742                         # of Koha's files to have write permission by default.
1743                         foreach my $key (sort keys %$target_directories) {
1744                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1745           unless exists $skip_directories->{$key};
1746                         }
1747         }
1749         $install .= "\n";
1751     $install .= "warn_koha_env_vars ::\n";
1752     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1753     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1754     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1755     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1756     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1757     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1758     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1759     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1760     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1761     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1762     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1764     $install .= _update_zebra_conf_target();
1766     $install .= upgrade();
1768     return $install;
1771 =head2 _update_zebra_conf_target
1773 Add an installation target for updating
1774 Zebra's configuration files.
1776 =cut
1778 sub _update_zebra_conf_target {
1780     my $target = "\nupdate_zebra_conf ::\n";
1781     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1782     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1783     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1784     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1785     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1786     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1788     return $target;
1791 sub upgrade {
1792     my $upgrade = "";
1794     my $backup_suffix;
1795     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1796         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1797         $version =~ s/\./_/g;
1798         $backup_suffix = "_koha_$version";
1799     } else {
1800         $backup_suffix = "_upgrade_backup";
1801     }
1803     $upgrade .= qq/
1804 MOD_BACKUP = \$(ABSPERLRUN) -MC4::Installer::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1806 upgrade :: make_upgrade_backup install
1807 \t\$(NOECHO) \$(NOOP)
1808 make_upgrade_backup ::
1809 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1811     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1812                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1813         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1814             unless exists $skip_directories->{$key} or
1815                    not exists $target_directories->{$key};
1816     }
1817     $upgrade =~ s/\\\n$/\n/;
1819     return $upgrade;
1821 sub postamble {
1822     # put directory mappings into Makefile
1823     # so that Make will export as environment
1824     # variables -- this is for the use of
1825     # rewrite-confg.PL
1827     my $env;
1828         # Hereagain, we must alter syntax per platform...
1829         {
1830                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1831                 $env .= "\n\n";
1832                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1833         }
1835     return "$env\n";
1839 __END__
1842 =head1 SEE ALSO
1844 ExtUtils::MakeMaker(3)
1846 =head1 AUTHORS
1848 MJ Ray mjr at phonecoop.coop
1849 Galen Charlton galen.charlton at liblime.com
1851 =cut
1853 FIXME: deal with .htaccess