Bug 18682 - Translatability: Get rid of [%% in translation for 2 files av-build-dropb...
[koha.git] / Makefile.PL
blob1cd5b89f3b88de25622bbf043687efdcb6cd646a
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;
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     --auth_index_mode            Authority index mode (grs1, dom)
95     --bib_index_mode             Bibliographic index mode (grs1, dom)
96     --koha_user                  Koha Unix user (e.g. koha)
97     --koha_group                 Koha Unix group (e.g. koha)
98     --install_sru                Install the SRU server (yes, no)
99     --install_pazpar2            Install PazPar2 (yes, no)
100     --use_memcached              Use Memcached (yes, no)
101     --font_dir                   Location of fonts (e.g. /usr/share/fonts/truetype/ttf-dejavu)
102     --run_database_tests         Run database dependent tests (yes, no)
103     --install_base               Base directory of installation (e.g. /usr/share/koha)
104     --help                       Display this help message
106 =head1 DESCRIPTION
108 This is a packager and installer that uses
109 ExtUtils::MakeMaker, which is fairly common
110 on perl systems.
111 As well as building tar or zip files
112 and installing with the above commands,
113 it allows us to check pre-requisites
114 and generate configuration files.
116 =head1 VARIABLES
118 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
120 Basic metadata about this software.
122 =head2 NO_META
124 Suppress generation of META.yml file.
126 =head2 PREREQ_PM
128 Hash of perl modules and versions required.
130 =head2 PM
132 Hash of file mappings
134 =head2 PL_FILES
136 This is a hash of PL scripts to run after installation and
137 the files to ask them to generate.
138 Maybe use the values from CONFIGURE
139 to generate initial configuration files in future.
141 =cut
143 =head2 target_map
145 This is a hash mapping directories and files in the
146 source tree to installation target directories.  The rules
147 for this mapping are:
149 =over 4
151 =item If a directory or file is specified, it and its
152 contents will be copied to the installation target directory.
154 =item If a subdirectory of a mapped directory is specified,
155 its target overrides the parent's target for that subdirectory.
157 =item The value of each map entry may either be a scalar containing
158 one target or a reference to a hash containing 'target' and 'trimdir'
159 keys.
161 =item Any files at the top level of the source tree that are
162 not included in the map will not be installed.
164 =item Any directories at the top level of the source tree
165 that are not included in the map will be installed in
166 INTRANET_CGI_DIR.  This is a sensible default given the
167 current organization of the source tree, but (FIXME) it
168 would be better to reorganize the source tree to better
169 match the installation system, to allow adding new directories
170 without having to adjust Makefile.PL each time.  The idea
171 is to make the C<$target_map> hash as minimal as possible.
173 =back
175 The permitted installation targets are:
177 =over 4
179 =item INTRANET_CGI_DIR
181 CGI scripts for intranet (staff) interface.
183 =item INTRANET_TMPL_DIR
185 HTML templates for the intranet interface.
187 =item INTRANET_WWW_DIR
189 HTML files, images, etc. for DocumentRoot for the intranet interface.
191 =item OPAC_CGI_DIR
193 CGI scripts for OPAC (public) interface.
195 =item OPAC_TMPL_DIR
197 HTML templates for the OPAC interface.
199 =item OPAC_WWW_DIR
201 HTML files, images, etc. for DocumentRoot for the OPAC interface.
203 =item PERL_MODULE_DIR
205 Perl modules (at present just the C4 modules) that are intimately
206 tied to Koha.  Depending on the installation options, these
207 may or may not be installed one of the standard directories
208 in Perl's default @LIB.
210 =item KOHA_CONF_DIR
212 Directory for Koha configuration files.
214 =item ZEBRA_CONF_DIR
216 Directory for Zebra configuration files.
218 =item ZEBRA_LOCK_DIR
220 Directory for Zebra's lock files.  This includes subdirs for authorities,
221 biblios, and the zebra rebuild function.  Any activity to reindex
222 zebra from koha should interlock here with rebuild_zebra.pl.
224 =item ZEBRA_DATA_DIR
226 Directory for Zebra's data files.
228 =item ZEBRA_RUN_DIR
230 Directory for Zebra's UNIX-domain sockets.
232 =item MISC_DIR
234 Directory for for miscellaenous scripts, among other
235 things the translation toolkit and RSS feed tools.
237 =item SCRIPT_DIR
239 Directory for command-line scripts and daemons to
240 be set up all for installation modes.
242 =item SCRIPT_NONDEV_DIR
244 Directory for command-line scripts that should
245 be installed in the same directory as the
246 SCRIPT_DIR target except 'dev' installs.
248 =item MAN_DIR
250 Directory for man pages created from POD -- will mostly
251 contain information of interest to Koha developers.
253 =item DOC_DIR
255 Directory for Koha documentation accessed from the
256 command-line, e.g., READMEs.
258 =item LOG_DIR
260 Directory for Apache and Zebra logs produced by Koha.
262 =item BACKUP_DIR
264 Directory for backup files produced by Koha.
266 =item PLUGINS_DIR
268 Directory for external Koha plugins.
270 =item PAZPAR2_CONF_DIR
272 Directory for PazPar2 configuration files.
274 =item FONT_DIR
276 Directory where DejaVu fonts are installed.
278 =item NONE
280 This is a dummy target used to explicitly state
281 that a given file or directory is not to be installed.
282 This is used either for parts of the installer itself
283 or for development tools that are not applicable to a
284 production installation.
286 =back
288 =cut
290 my $target_map = {
291   './about.pl'                  => 'INTRANET_CGI_DIR',
292   './acqui'                     => 'INTRANET_CGI_DIR',
293   './admin'                     => 'INTRANET_CGI_DIR',
294   './api'                       => { target => 'API_CGI_DIR', trimdir => -1 },
295   './authorities'               => 'INTRANET_CGI_DIR',
296   './basket'                    => 'INTRANET_CGI_DIR',
297   './C4'                        => 'PERL_MODULE_DIR',
298   './C4/SIP/t'                  => 'NONE',
299   './C4/SIP/koha_test'          => 'NONE',
300   './C4/tests'                  => 'NONE',
301   './catalogue'                 => 'INTRANET_CGI_DIR',
302   './cataloguing'               => 'INTRANET_CGI_DIR',
303   './changelanguage.pl'         => 'INTRANET_CGI_DIR',
304   './check_sysprefs.pl'         => 'NONE',
305   './circ'                      => 'INTRANET_CGI_DIR',
306   './course_reserves'           => 'INTRANET_CGI_DIR',
307   './docs/history.txt'          => { target => 'DOC_DIR', trimdir => -1 },
308   './offline_circ'              => 'INTRANET_CGI_DIR',
309   './edithelp.pl'               => 'INTRANET_CGI_DIR',
310   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
311   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
312   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
313   './help.pl'                   => 'INTRANET_CGI_DIR',
314   './installer-CPAN.pl'         => 'NONE',
315   './installer'                 => 'INTRANET_CGI_DIR',
316   './errors'                    => {target => 'INTRANET_CGI_DIR'},
317   './Koha'                      => 'PERL_MODULE_DIR',
318   './Koha.pm'                   => 'PERL_MODULE_DIR',
319   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
320   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
321   './kohaversion.pl'            => 'INTRANET_CGI_DIR',
322   './labels'                    => 'INTRANET_CGI_DIR',
323   './mainpage.pl'               => 'INTRANET_CGI_DIR',
324   './Makefile.PL'               => 'NONE',
325   './MANIFEST.SKIP'             => 'NONE',
326   './members'                   => 'INTRANET_CGI_DIR',
327   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
328   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
329   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
330   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
331   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
332   './misc/installer_devel_notes' => 'NONE',
333   './opac'                      => 'OPAC_CGI_DIR',
334   './OpenILS'                   => 'PERL_MODULE_DIR',
335   './README.txt'                => 'NONE',
336   './patroncards'               => 'INTRANET_CGI_DIR',
337   './patron_lists'              => 'INTRANET_CGI_DIR',
338   './plugins'                   => 'INTRANET_CGI_DIR',
339   './reports'                   => 'INTRANET_CGI_DIR',
340   './reserve'                   => 'INTRANET_CGI_DIR',
341   './reviews'                   => 'INTRANET_CGI_DIR',
342   './rewrite-config.PL'         => 'NONE',
343   './reviews'                   => 'INTRANET_CGI_DIR',
344   './rotating_collections'      => 'INTRANET_CGI_DIR',
345   './serials'                   => 'INTRANET_CGI_DIR',
346   './services'                  => 'INTRANET_CGI_DIR',
347   './skel'                      => 'NONE',
348   './skel/var/log/koha'         => { target => 'LOG_DIR', trimdir => -1 },
349   './skel/var/spool/koha'       => { target => 'BACKUP_DIR', trimdir => -1 },
350   './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
351   './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
352   './skel/var/lib/koha/zebradb/authorities/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
353   './skel/var/lib/koha/zebradb/authorities/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
354   './skel/var/lib/koha/zebradb/authorities/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
355   './skel/var/lib/koha/zebradb/authorities/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
356   './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
357   './skel/var/lib/koha/zebradb/biblios/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
358   './skel/var/lib/koha/zebradb/biblios/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
359   './skel/var/lib/koha/zebradb/biblios/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
360   './skel/var/lib/koha/zebradb/biblios/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
361   './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
362   './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
363   './sms'                       => 'INTRANET_CGI_DIR',
364   './suggestion'                => 'INTRANET_CGI_DIR',
365   './svc'                       => 'INTRANET_CGI_DIR',
366   './t'                         => 'NONE',
367   './tags'                      => 'INTRANET_CGI_DIR',
368   './tmp'                       => 'NONE', # FIXME need to determine whether
369                                            # Koha generates any persistent temp files
370                                            # that should go in /var/tmp/koha
371   './tools'                     => 'INTRANET_CGI_DIR',
372   './virtualshelves'            => 'INTRANET_CGI_DIR',
373   './xml_sax.pl'                => 'PERL_MODULE_DIR',
374   # ignore files and directories created by the install itself
375   './pm_to_blib'                => 'NONE',
376   './blib'                      => 'NONE',
379 =head1 CONFIGURATION OPTIONS
381 The following configuration options are used by the installer.
383 =over 4
385 =item INSTALL_MODE
387 Specifies whether installation will be FHS-compliant (default,
388 assumes user has root), put everything under
389 a single directory (for users installing on a web host
390 that allows CGI scripts and a MySQL database but not root
391 access), or development (for a developer who wants to run
392 Koha from a git clone with no fuss).
394 =item INSTALL_BASE
396 Directory under which most components will go.  Default
397 value will vary depending on INSTALL_MODE.
399 =item DB_TYPE
401 Type of DBMS (e.g., mysql or Pg).
403 =item DB_HOST
405 Name of DBMS server.
407 =item DB_PORT
409 Port that DBMS server is listening on.
411 =item DB_NAME
413 Name of the DBMS database for Koha.
415 =item DB_USER
417 Name of DBMS user account for Koha's database.
419 =item DB_PASS
421 Pasword of DMBS user account for Koha's database.
423 =item ZEBRA_MARC_FORMAT
425 Specifies format of MARC records to be indexed by Zebra.
427 =item ZEBRA_LANGUAGE
429 Specifies primary language of records that will be
430 indexed by Zebra.
432 =item ZEBRA_USER
434 Internal Zebra user account for the index.
436 =item ZEBRA_PASS
438 Internal Zebra user account's password.
440 =item KOHA_USER
442 System user account that will own Koha's files.
444 =item KOHA_GROUP
446 System group that will own Koha's files.
448 =back
450 =cut
452 # default configuration options
453 my %config_defaults = (
454   'DB_TYPE'           => 'mysql',
455   'DB_HOST'           => 'localhost',
456   'DB_NAME'           => 'koha',
457   'DB_USER'           => 'kohaadmin',
458   'DB_PASS'           => 'katikoan',
459   'DB_USE_TLS'        => 'no',
460   'DB_TLS_CA_CERTIFICATE'  => '/etc/mysql-ssl/server-ca.pem',
461   'DB_TLS_CLIENT_CERTIFICATE'  => '/etc/mysql-ssl/client-cert.pem',
462   'DB_TLS_CLIENT_KEY' => '/etc/mysql-ssl/client-key.pem',
463   'INSTALL_SRU'       => 'yes',
464   'INSTALL_PAZPAR2'   => 'no',
465   'AUTH_INDEX_MODE'   => 'dom',
466   'BIB_INDEX_MODE'    => 'dom',
467   'ZEBRA_MARC_FORMAT' => 'marc21',
468   'ZEBRA_LANGUAGE'    => 'en',
469   'ZEBRA_TOKENIZER'   => 'chr',
470   'ZEBRA_USER'        => 'kohauser',
471   'ZEBRA_PASS'        => 'zebrastripes',
472   'ZEBRA_SRU_HOST'    => 'localhost',
473   'ZEBRA_SRU_BIBLIOS_PORT'    => '9998',
474   'ZEBRA_SRU_AUTHORITIES_PORT'    => '9999',
475   'KOHA_USER'         => 'koha',
476   'KOHA_GROUP'        => 'koha',
477   'MERGE_SERVER_HOST' => 'localhost',
478   'MERGE_SERVER_PORT' => '11001',
479   'PAZPAR2_HOST' => 'localhost',
480   'PAZPAR2_PORT' => '11002',
481   'RUN_DATABASE_TESTS' => 'no',
482   'PATH_TO_ZEBRA' => '',
483   'USE_MEMCACHED'     => 'no',
484   'MEMCACHED_SERVERS' => '127.0.0.1:11211',
485   'MEMCACHED_NAMESPACE' => 'KOHA',
486   'FONT_DIR'          => '/usr/share/fonts/truetype/ttf-dejavu'
489 # set some default configuration options based on OS
490 # more conditions need to be added for other OS's
492 warn "Your platform appears to be $^O.\n" if $DEBUG;
494 if ( $^O eq 'cygwin' ) {
495         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
496         # this could be changed to put some files (ie. libraries) into system32, etc.
497         $config_defaults{'INSTALL_MODE'} = 'single';
498         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
500 else {
501         $config_defaults{'INSTALL_MODE'} = 'standard';
502         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
505 # valid values for certain configuration options
506 my %valid_config_values = (
507   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
508   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
509   'DB_USE_TLS' => {'yes', 'no'},
510   'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
511   'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
512   'BIB_INDEX_MODE'  => { 'grs1' => 1, 'dom' => 1 },
513   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
514   'ZEBRA_LANGUAGE'    => { 'cs' => 1, 'en' => 1, 'es' => 1, 'fr' => 1, 'gr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
515   'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
516   'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
517   'USE_MEMCACHED'      => { 'yes' => 1, 'no' => 1 },
520 # get settings from command-line
521 my $koha_install_log = "";
522 my $cli_koha_install_mode = "";
523 my $cli_koha_db_type = "";
524 my $cli_koha_db_host = "";
525 my $cli_koha_db_port = "";
526 my $cli_koha_db_name = "";
527 my $cli_koha_db_user = "";
528 my $cli_koha_db_pass = "";
529 my $cli_zebra_marc_format = "";
530 my $cli_zebra_language = "",
531 my $cli_zebra_tokenizer = "";
532 my $cli_zebra_user = "";
533 my $cli_zebra_pass = "";
534 my $cli_zebra_sru_host = "";
535 my $cli_zebra_sru_bib_port = "";
536 my $cli_zebra_sru_auth_port = "";
537 my $cli_koha_auth_index_mode = "";
538 my $cli_koha_bib_index_mode = "";
539 my $cli_koha_user = "";
540 my $cli_koha_group = "";
541 my $cli_koha_install_sru = "";
542 my $cli_koha_install_pazpar2 = "";
543 my $cli_koha_use_memcached = "";
544 my $cli_koha_font_dir = "";
545 my $cli_koha_run_database_tests = "";
546 my $cli_koha_install_base = "";
547 Getopt::Long::Configure('pass_through');
548 my $results = GetOptions(
549     "prev-install-log=s"           => \$koha_install_log,
550     "install_mode=s"               => \$cli_koha_install_mode,
551     "db_type=s"                    => \$cli_koha_db_type,
552     "db_host=s"                    => \$cli_koha_db_host,
553     "db_port=s"                    => \$cli_koha_db_port,
554     "db_name=s"                    => \$cli_koha_db_name,
555     "db_user=s"                    => \$cli_koha_db_user,
556     "db_pass=s"                    => \$cli_koha_db_pass,
557     "zebra_marc_format=s"          => \$cli_zebra_marc_format,
558     "zebra_language=s"             => \$cli_zebra_language,
559     "zebra_tokenizer=s"            => \$cli_zebra_tokenizer,
560     "zebra_user=s"                 => \$cli_zebra_user,
561     "zebra_pass=s"                 => \$cli_zebra_pass,
562     "zebra_sru_host=s"             => \$cli_zebra_sru_host,
563     "zebra_sru_biblios_port=s"     => \$cli_zebra_sru_bib_port,
564     "zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
565     "auth_index_mode=s"            => \$cli_koha_auth_index_mode,
566     "bib_index_mode=s"             => \$cli_koha_bib_index_mode,
567     "koha_user=s"                  => \$cli_koha_user,
568     "koha_group=s"                 => \$cli_koha_group,
569     "install_sru=s"                => \$cli_koha_install_sru,
570     "install_pazpar2=s"            => \$cli_koha_install_pazpar2,
571     "use_memcached=s"              => \$cli_koha_use_memcached,
572     "font_dir=s"                   => \$cli_koha_font_dir,
573     "run_database_tests=s"         => \$cli_koha_run_database_tests,
574     "install_base=s"               => \$cli_koha_install_base,
575     "help"                         => sub { HelpMessage(0) },
576 ) or HelpMessage(1);
578 my %install_log_values = ();
579 if ($koha_install_log ne "") {
580     get_install_log_values($koha_install_log, \%install_log_values);
581 } else {
582     # Try to set install_log_values for provided values;
583     get_cli_values(\%install_log_values);
586 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
587 my ($target_directories, $skip_directories) = get_target_directories(\%config);
588 display_configuration(\%config, $target_directories);
589 my $file_map = {};
590 get_file_map($target_map, $dirtree, $file_map);
592 my $pl_files = {
593       'rewrite-config.PL' => [
594          'blib/KOHA_CONF_DIR/koha-conf.xml',
595          'blib/KOHA_CONF_DIR/koha-httpd.conf',
596          'blib/KOHA_CONF_DIR/log4perl.conf',
597          'blib/ZEBRA_CONF_DIR/etc/default.idx',
598          'blib/MISC_DIR/koha-install-log'
599          ],
600           'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
601                  'blib'
602                  ],
605 push @{ $pl_files->{'rewrite-config.PL'} }, (
606     'blib/ZEBRA_CONF_DIR/etc/passwd',
607     'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
608     'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
609     'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
610     'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
611     'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
612     'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
613     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
614     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
615     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
616     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
618 push @{ $pl_files->{'rewrite-config.PL'} }, (
619     'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
620     'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
621     'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
623 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
624     push @{ $pl_files->{'rewrite-config.PL'} }, (
625         'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
626         'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
627     );
629 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
630                               ? 'zebra-authorities-dom.cfg'
631                               : 'zebra-authorities.cfg';
632 $config{'ZEBRA_BIB_CFG'}  = $config{'BIB_INDEX_MODE'} eq 'dom'
633                               ? 'zebra-biblios-dom.cfg'
634                               : 'zebra-biblios.cfg';
635 $config{'AUTH_RETRIEVAL_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
636                                   ? 'retrieval-info-auth-dom.xml'
637                                   : 'retrieval-info-auth-grs1.xml';
638 $config{'BIB_RETRIEVAL_CFG'}  = $config{'BIB_INDEX_MODE'} eq 'dom'
639                                   ? 'retrieval-info-bib-dom.xml'
640                                   : 'retrieval-info-bib-grs1.xml';
643 if ($config{'INSTALL_MODE'} ne "dev") {
644     push @{ $pl_files->{'rewrite-config.PL'} }, (
645         'blib/PERL_MODULE_DIR/C4/Context.pm',
646         'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
647     );
650 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
651     ? 'icuchain words-icu.xml'
652     : 'charmap word-phrase-utf.chr';
654 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
655     ? 'icuchain phrases-icu.xml'
656     : 'charmap word-phrase-utf.chr';
658 my %test_suite_override_dirs = (
659     KOHA_CONF_DIR  => ['etc'],
660     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
661     LOG_DIR        => ['var', 'log'],
662     BACKUP_DIR     => ['var', 'spool'],
663     SCRIPT_DIR     => ['bin'],
664     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
665     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
666     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
669 WriteMakefile(
670               NAME         => 'koha',
671               #VERSION     => strftime('2.9.%Y%m%d%H',gmtime),
672               VERSION_FROM => 'kohaversion.pl',
673               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
674               AUTHOR       => 'Koha Contributors <http://koha-community.org/>',
675               NO_META      => 1,
676               PREREQ_PM    => $koha_pm->prereq_pm,
678               # File tree mapping
679               PM => $file_map,
681               # Man pages generated from POD
682               # ExtUtils::MakeMaker already manage $(DESTDIR)
683               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
684               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
686               PL_FILES => $pl_files,
689 =head1 FUNCTIONS
691 =head2 hashdir
693 This function recurses through the directory structure and builds
694 a hash of hashes containing the structure with arrays holding filenames.
695 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
697 =cut
699 sub hashdir{
700     my $dir = shift;
701     opendir my $dh, $dir or die $!;
702     my $tree = {}->{$dir} = {};
703     while( my $file = readdir($dh) ) {
704         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
705         my $path = $dir .'/' . $file;
706         $tree->{$file} = hashdir($path), next if -d $path;
707         push @{$tree->{'.'}}, $file;
708     }
709     return $tree;
712 =head2 get_file_map
714 This function combines the target_map and file hash to
715 map each source file to its destination relative to
716 the set of installation targets.
718 Output will be a hash mapping from each source file
719 to its destination value, like this:
721 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
723 =cut
725 sub get_file_map {
726     my $target_map = shift;
727     my $dirtree = shift;
728     my $file_map = shift;
729     my $curr_path = @_ ? shift : ['.'];
731     # Traverse the directory tree.
732     # For each file or directory, identify the
733     # most specific match in the target_map
734     foreach my $dir (sort keys %{ $dirtree }) {
735         if ($dir eq '.') {
736             # deal with files in directory
737             foreach my $file (sort @{ $dirtree->{$dir} }) {
738                 my $targetdir = undef;
739                 my $matchlevel = undef;
740                 # first, see if there is a match on this specific
741                 # file in the target map
742                 my $filepath = join("/", @$curr_path, $file);
743                 if (exists $target_map->{$filepath}) {
744                     $targetdir = $target_map->{$filepath};
745                     $matchlevel = scalar(@$curr_path) + 1;
746                 } else {
747                     # no match on the specific file; look for
748                     # a directory match
749                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
750                         my $dirpath = join("/", @$curr_path[0..$i]);
751                         if (exists $target_map->{$dirpath}) {
752                             $targetdir = $target_map->{$dirpath};
753                             $matchlevel = $i + 1;
754                             last;
755                         }
756                     }
757                 }
758                 if (defined $targetdir) {
759                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
760                 } else {
761                     my $path = join("/", @$curr_path);
762                     print "failed to map: $path/$file\n" if $DEBUG;
763                 }
764             }
765         } else {
766             # dealing with subdirectory
767             push @$curr_path, $dir;
768             get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
769             pop @$curr_path;
770         }
771     }
774 sub _add_to_file_map {
775     my $file_map = shift;
776     my $targetdir = shift;
777     my $curr_path = shift;
778     my $file = shift;
779     my $matchlevel = shift;
780     my $dest_path = @_ ? shift : $curr_path;
782     # The target can be one of the following:
783     # 1. scalar representing target symbol
784     # 2. hash ref containing target and trimdir keys
785     #
786     # Consequently, this routine traverses this structure,
787     # calling itself recursively, until it deals with
788     # all of the scalar target symbols.
789     if (ref $targetdir eq 'HASH') {
790         my $subtarget = $targetdir->{target};
791         if (exists $targetdir->{trimdir}) {
792             # if we get here, we've specified that
793             # rather than installing the file to
794             # $(TARGET)/matching/dirs/subdirs/file,
795             # we want to install it to
796             # $(TARGET)/subdirs/file
797             #
798             # Note that this the only place where
799             # $matchlevel is used.
800             my @new_dest_path = @$dest_path;
801             if ($targetdir->{trimdir} == -1)  {
802                 splice @new_dest_path, 0, $matchlevel;
803             } else {
804                 splice @new_dest_path, 0, $targetdir->{trimdir};
805             }
806             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
807         } else {
808             # actually getting here means that the
809             # target was unnecessarily listed
810             # as a hash, but we'll forgive that
811             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
812         }
813     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
814         my $source = File::Spec->catfile(@$curr_path, $file);
815         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
816         #print "$source => $destination\n"; # DEBUG
817         # quote spaces in file names
818         # FIXME: this is of questionable portability and
819         # probably depends on user's make recognizing this
820         # quoting syntax -- probably better to remove
821         # spaces and shell metacharacters from all file names
822         $source =~ s/ /\\ /g;
823         $destination =~ s/ /\\ /g;
825         $file_map->{$source} = $destination;
826     }
829 =head2 get_cli_values
831 Reads values provided on cli for configuration values
833 =cut
835 sub get_cli_values {
836     my $values = shift;
837     my $map = {
838         INSTALL_MODE               => $cli_koha_install_mode,
839         DB_TYPE                    => $cli_koha_db_type,
840         DB_HOST                    => $cli_koha_db_host,
841         DB_PORT                    => $cli_koha_db_port,
842         DB_NAME                    => $cli_koha_db_name,
843         DB_USER                    => $cli_koha_db_user,
844         DB_PASS                    => $cli_koha_db_pass,
845         ZEBRA_MARC_FORMAT          => $cli_zebra_marc_format,
846         ZEBRA_LANGUAGE             => $cli_zebra_language,
847         ZEBRA_TOKENIZER            => $cli_zebra_tokenizer,
848         ZEBRA_USER                 => $cli_zebra_user,
849         ZEBRA_PASS                 => $cli_zebra_pass,
850         ZEBRA_SRU_HOST             => $cli_zebra_sru_host,
851         ZEBRA_SRU_BIBLIOS_PORT     => $cli_zebra_sru_bib_port,
852         ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
853         AUTH_INDEX_MODE            => $cli_koha_auth_index_mode,
854         BIB_INDEX_MODE             => $cli_koha_bib_index_mode,
855         KOHA_USER                  => $cli_koha_user,
856         KOHA_GROUP                 => $cli_koha_group,
857         INSTALL_SRU                => $cli_koha_install_sru,
858         INSTALL_PAZPAR2            => $cli_koha_install_pazpar2,
859         USE_MEMCACHED              => $cli_koha_use_memcached,
860         FONT_DIR                   => $cli_koha_font_dir,
861         RUN_DATABASE_TESTS         => $cli_koha_run_database_tests,
862         INSTALL_BASE               => $cli_koha_install_base
863     };
864     foreach my $key (keys %{$map}) {
865         $values->{$key} = $map->{$key} if ($map->{$key});
866     }
869 =head2 get_install_log_values
871 Reads value from the Koha install log specified by
872 --prev-install-log
874 =cut
876 sub get_install_log_values {
877     my $install_log = shift;
878     my $values = shift;
880     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
881     while (<LOG>) {
882         chomp;
883         next if /^#/ or /^\s*$/;
884         next if /^=/;
885         next unless m/=/;
886         s/\s+$//g;
887         my ($key, $value) = split /=/, $_, 2;
888         $values->{$key} = $value;
889     }
890     close LOG;
892     print <<_EXPLAIN_INSTALL_LOG_;
893 Reading values from install log $install_log.  You
894 will be prompted only for settings that have been
895 added since the last time you installed Koha.  To
896 be prompted for all settings, run 'perl Makefile.PL'
897 without the --prev-install-log option.
898 _EXPLAIN_INSTALL_LOG_
901 =head2 get_configuration
903 This prompts the user for various configuration options.
905 =cut
907 sub get_configuration {
908   my $defaults = shift;
909   my $valid_values = shift;
910   my $install_log_values = shift;
911   my %config = ();
913   my $msg = q(
914 By default, Koha can be installed in one of three ways:
916 standard: Install files in conformance with the Filesystem
917           Hierarchy Standard (FHS).  This is the default mode
918           and should be used when installing a production
919           Koha system.  On Unix systems, root access is
920           needed to complete a standard installation.
922 single:   Install files under a single directory.  This option
923           is useful for installing Koha without root access, e.g.,
924           on a web host that allows CGI scripts and MySQL databases
925           but requires the user to keep all files under the user's
926           HOME directory.
928 dev:      Create a set of symbolic links and configuration files to
929           allow Koha to run directly from the source distribution.
930           This mode is useful for developers who want to run
931           Koha from a git clone.
933 Installation mode);
934     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
935     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
937     # set message and default value for INSTALL_BASE
938     # depending on value of INSTALL_MODE
939     my $install_base_default = $defaults->{'INSTALL_BASE'};
940     if ($config{'INSTALL_MODE'} eq 'dev') {
941         $msg = q(
942 Please specify the directory in which to install Koha's
943 active configuration files and (if applicable) the
944 Zebra database.  Koha's CGI scripts and templates will
945 be run from the current directory.
947 Configuration directory:);
948         # FIXME - home directory portability consideration apply
949         $install_base_default =
950             $ENV{DESTDIR}
951             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
952         ;
953     } elsif ($config{'INSTALL_MODE'} eq 'single') {
954         $msg = "\nPlease specify the directory in which to install Koha";
955         # FIXME -- we're assuming under a 'single' mode install
956         # that user will likely want to install under the home
957         # directory.  This is OK in and of itself, but we should
958         # use File::HomeDir to locate the home directory portably.
959         # This is deferred for now because File::HomeDir is not yet
960         # core.
961                 # --we must also keep this portable to the major OS's -fbcit
962         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
963     } else {
964         # must be standard
965         $msg = q(
966 Please specify the directory under which most Koha files
967 will be installed.
969 Note that if you are planning in installing more than
970 one instance of Koha, you may want to modify the last
971 component of the directory path, which will be used
972 as the package name in the FHS layout.
974 Base installation directory);
975     }
976     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
978     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
979         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
980     if ($config{'INSTALL_MODE'} eq "standard") {
981         $msg = q(
982 Since you are using the 'standard' install
983 mode, you should run 'make install' as root.
984 However, it is recommended that a non-root
985 user (on Unix and Linux platforms) have
986 ownership of Koha's files, including the
987 Zebra indexes if applicable.
989 Please specify a user account.  This
990 user account does not need to exist
991 right now, but it needs to exist
992 before you run 'make install'.  Please
993 note that for security reasons, this
994 user should not be the same as the user
995 account Apache runs under.
997 User account);
998         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
1000         $msg = q(
1001 Please specify the group that should own
1002 Koha's files.  As above, this group need
1003 not exist right now, but should be created
1004 before you run 'make install'.
1006 Group);
1007         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
1008     }
1010     $msg = q(
1011 Please specify which database engine you will use
1012 to store data in Koha.  The choices are MySQL and
1013 PostgreSQL; please note that at the moment
1014 PostgreSQL support is highly experimental.
1016 DBMS to use);
1017     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
1018     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
1020     $msg = q(
1021 Please specify the name or address of your
1022 database server.  Note that the database
1023 does not have to exist at this point, it
1024 can be created after running 'make install'
1025 and before you try using Koha for the first time.
1027 Database server);
1028     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
1030     $msg = q(
1031 Please specify the port used to connect to the
1032 DMBS);
1033     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
1034     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
1036     $msg = q(
1037 Please specify the name of the database to be
1038 used by Koha);
1039     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
1040     if ($config{'DB_TYPE'} eq 'mysql'){
1041         $msg = q(
1042 Please specify whether the connection to MySQL will use TLS
1043         );
1044         $config{'DB_USE_TLS'} = _get_value('DB_USE_TLS', $msg, $defaults->{'DB_USE_TLS'}, $valid_values, $install_log_values);
1045     }
1046     if ($config{'DB_USE_TLS'} eq 'yes'){
1047         $msg = q(
1048 Please enter the path to the CA certificate for TLS
1049         );
1050         $config{'DB_TLS_CA_CERTIFICATE'} = _get_value('DB_TLS_CA_CERTIFICATE', $msg, $defaults->{'DB_TLS_CA_CERTIFICATE'}, $valid_values, $install_log_values);
1052         $msg = q(
1053 Please enter the path to the client certificate for TLS
1054         );
1055         $config{'DB_TLS_CLIENT_CERTIFICATE'} = _get_value('DB_TLS_CLIENT_CERTIFICATE', $msg, $defaults->{'DB_TLS_CLIENT_CERTIFICATE'}, $valid_values, $install_log_values);
1056         $msg = q(
1057 Please enter the path to the client key for TLS
1058         );
1059         $config{'DB_TLS_CLIENT_KEY'} = _get_value('DB_TLS_CLIENT_KEY', $msg, $defaults->{'DB_TLS_CLIENT_KEY'}, $valid_values, $install_log_values);
1060     }
1062     $msg = q(
1063 Please specify the user that owns the database to be
1064 used by Koha);
1065     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
1067     $msg = q(
1068 Please specify the password of the user that owns the
1069 database to be used by Koha);
1070     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
1072     print q(
1073 Koha uses the Zebra search engine for high-performance
1074 searching of bibliographic and authority records.  Checking
1075 to see if you have installed the Zebra software...
1078     if (defined(my $zebra_path = find_zebra())) {
1079         $config{'PATH_TO_ZEBRA'} = $zebra_path;
1080         print qq(
1081 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
1083     } else {
1084         print q(
1085 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
1086 in your PATH or in some of the usual places.  If you haven't
1087 installed Zebra yet, please do so and run Makefile.PL again.
1090     }
1092     $msg = q(
1093 You must specify the primary MARC format of the
1094 records to be indexed by Zebra.
1096 Koha provides Zebra configuration files for MARC21,
1097 NORMARC and UNIMARC.
1099 MARC format for Zebra indexing);
1100     $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1101     $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1102     $msg = q(
1103 Koha supplies Zebra configuration files tuned for
1104 searching either English (en) or French (fr) MARC
1105 records.
1107 Primary language for Zebra indexing);
1108     $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1109     $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1111     $msg = q(
1112 Koha can use one of  two different indexing modes
1113 for the MARC bibliographic records:
1115 dom  - uses the DOM XML filter; offers improved
1116        functionality.
1117 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
1118        available for legacy support
1120 Bibliographic indexing mode);
1121     $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
1122     $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
1125     $msg = q(
1126 Koha can use one of  two different indexing modes
1127 for the MARC authorities records:
1129 dom  - uses the DOM XML filter; offers improved
1130        functionality.
1131 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
1132        available for legacy support
1134 Authorities indexing mode);
1135     $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1136     $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1138     $msg = q(
1139 Zebra has two methods to perform records tokenization
1140 and characters normalization: CHR and ICU. ICU is
1141 recommended for catalogs containing non-Latin
1142 characters.);
1144     $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
1145     $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
1147     $msg = q(
1148 Please specify Zebra database user);
1149     $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1151     $msg = q(
1152 Please specify the Zebra database password);
1153     $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1155     $msg = q(
1156 Since you've chosen to use Zebra, you can enable the SRU/
1157 Z39.50 Server if you so choose, but you must specify a
1158 few configuration options for it.
1160 Please note that if you choose *NOT* to configure SRU,
1161 koha-conf.xml will still contain some references to SRU
1162 settings.  Those references will be ignored by Koha.
1164 Install the SRU configuration files?);
1165     $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1166     $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1168     if ($config{'INSTALL_SRU'} eq 'yes') {
1169         $msg = q(
1170 Since you've chosen to configure SRU, you must
1171 specify the host and port(s) that the SRU
1172 Servers (bibliographic and authority) should run on.
1174         $msg = q(
1175 SRU Database host?);
1176         $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1178         $msg = q(
1179 SRU port for bibliographic data?);
1180         $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1182         $msg = q(
1183 SRU port for authority data?);
1184         $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1186     }
1188     $msg = q(
1189 Along with Zebra, you can also choose to install PazPar2,
1190 which is a metasearch tool.  With PazPar2,
1191 Koha can perform on-the-fly merging of bibliographic
1192 records during searching, allowing for FRBRization of
1193 the results list.
1195 Install the PazPar2 configuration files?);
1196     $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1197     $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1199     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1200         $msg = q(
1201 Since you've chosen to configure PazPar2, you must
1202 specify the host and port(s) that PazPar2
1203 uses:
1205         $msg = q(
1206 Zebra bibliographic server host?);
1207         $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1209         $msg = q(
1210 Zebra bibliographic port for PazPar2 to use?);
1211         $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1213         $msg = q(
1214 PazPar2 host?);
1215         $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1217         $msg = q(
1218 PazPar2 port?);
1219         $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1221     }
1223   $msg = q(
1224 Use memcached to cache the results of some function calls?
1225 This provides a signficant performance improvement.
1226 You will need a Memcached server running.);
1227   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1228   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1229   if ($config{'USE_MEMCACHED'} eq 'yes'){
1230       $msg = q(
1231 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1233       $msg = q(
1234 Memcached server address?);
1235       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1237       $msg = q(
1238 Memcached namespace?);
1239       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1240   }
1242   $msg = q(
1243 Path to DejaVu fonts?);
1244   $config{'FONT_DIR'} = _get_value('FONT_DIR', $msg, $defaults->{'FONT_DIR'}, $valid_values, $install_log_values);
1247   $msg = q(
1248 Would you like to run the database-dependent test suite?);
1249   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1250     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1252   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1253       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1254       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1255       $msg = q(TEST DATABASE
1257 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1258 testing. Please don't do this on your production database. It is not
1259 reversable.
1261 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1262 database. You are better off not running this optional test suite than
1263 doing it in a database that you don't want to lose.
1265 Please specify the name of the test database to be
1266 used by Koha);
1268       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1269       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1270           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1271           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1272       }
1274       $msg = q(
1275 Please specify the user that owns the database to be
1276 used by Koha);
1277     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1279       $msg = q(
1280 Please specify the password of the user that owns the
1281 database to be used by Koha);
1282       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1283   }
1285     print "\n\n";
1287     # add version number
1288     my $version = "no_version_found";
1289     eval {
1290         require 'kohaversion.pl';
1291         $version = kohaversion();
1292     };
1293     $config{'KOHA_INSTALLED_VERSION'} = $version;
1295     return %config;
1298 sub _add_valid_values_disp {
1299     my $key = shift;
1300     my $valid_values = shift;
1302     my $disp = "";
1303     if (exists $valid_values->{$key}) {
1304         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1305     }
1306     return $disp;
1309 sub _get_value {
1310     my $key = shift;
1311     my $msg = shift;
1312     my $default = shift;
1313     my $valid_values = shift;
1314     my $install_log_values = shift;
1316     # take value from install log if present
1317     if (exists $install_log_values{$key}) {
1318         $install_log_values{$key} =~ s/\$/\$\$/g;
1319         return $install_log_values{$key};
1320     }
1322     # override default value from environment
1323     if (exists $ENV{$key}) {
1324         $default = $ENV{$key};
1325         $msg .= " (default from environment)";
1326     }
1328     my $val = prompt($msg, $default);
1330     while (exists $valid_values->{$key} and
1331            $val ne $default and
1332            not exists $valid_values->{$key}->{$val}) {
1333         my $retry_msg = "Value '$val' is not a valid option.\n";
1334         $retry_msg .= "Please enter a value";
1335         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1336         $val = prompt($retry_msg, $default);
1337     }
1338     $val =~ s/\$/\$\$/g;
1339     return $val;
1342 =head2 get_target_directories
1344 Creates a hash mapping from symbols for installation target
1345 directories to actual directory paths.
1347 Also returns a hash indicating targets for which
1348 files need not be copied -- this is used for the 'dev'
1349 mode installation, where some files are installed in place.
1351 =cut
1353 sub get_target_directories {
1354     my $config = shift;
1356     my $base = $config->{'INSTALL_BASE'};
1357     my $mode = $config->{'INSTALL_MODE'};
1359     # get last component of install base directory
1360     # to treat as package name
1361     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1363     my @basedir = File::Spec->splitdir($directories);
1365     if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1367     my $package = pop @basedir;
1370     my %dirmap = ();
1371     my %skipdirs = ();
1372     if ($mode eq 'single') {
1373         $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1374         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1375         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1376         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1377         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1378         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1379         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1380         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1381         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1382         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1383         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1384         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1385         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1386         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1387         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1388         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1389         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1390         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1391         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1392         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1393         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1394         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1395     } elsif ($mode eq 'dev') {
1396         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1397         $dirmap{'API_CGI_DIR'} = File::Spec->catdir($curdir, 'api');
1398         $skipdirs{'API_CGI_DIR'} = 1;
1399         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1400         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1401         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1402         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1403         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1404         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1405         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1406         $skipdirs{'OPAC_CGI_DIR'} = 1;
1407         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1408         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1409         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1410         $skipdirs{'OPAC_WWW_DIR'} = 1;
1411         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1412         $skipdirs{'PERL_MODULE_DIR'} = 1;
1413         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1414         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1415         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1416         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1417         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1418         #For dev install, point NONDEV_DIR to misc in current dir (not base)
1419         #Used by supportdir in koha-conf.xml (BZ 12031)
1420         $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1421         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1422         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1423         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1424         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1425         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1426         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1427         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1428         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1429         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1430     } else {
1431         # mode is standard, i.e., 'fhs'
1432         $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1433         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1434         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1435         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1436         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1437         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1438         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1439         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1440         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1441         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1442         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1443         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1444         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1445         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1446         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1447         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1448         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1449         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1450         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1451         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1452         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1453         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1454     }
1456     _get_env_overrides(\%dirmap);
1457     _get_argv_overrides(\%dirmap);
1458     _add_destdir(\%dirmap);
1460     return \%dirmap, \%skipdirs;
1463 =head2 get_test_dir
1465 Map a directory target to the corresponding path for
1466 the test suite.
1468 =cut
1470 sub get_test_dir {
1471     my ($dirname) = @_;
1473     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1474     if (exists $test_suite_override_dirs{$dirname}) {
1475         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1476     } else {
1477         return;
1478     }
1482 sub _get_env_overrides {
1483     my $dirmap = shift;
1485     foreach my $key (keys %$dirmap) {
1486         if (exists $ENV{$key}) {
1487             $dirmap->{$key} = $ENV{$key};
1488             print "Setting $key from environment\n";
1489         }
1490     }
1493 sub _get_argv_overrides {
1494     my $dirmap = shift;
1496     my @new_argv = ();
1497     for (my $i = 0; $i <= $#ARGV; $i++) {
1498         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1499             $dirmap->{$1} = $2;
1500         } else {
1501             push @new_argv, $ARGV[$i];
1502         }
1503     }
1504     @ARGV = @new_argv;
1507 sub _strip_destdir {
1508     my $dir = shift;
1509     $dir =~ s/^\$\(DESTDIR\)//;
1510     return $dir;
1513 sub _add_destdir {
1514     my $dirmap = shift;
1516     foreach my $key (keys %$dirmap) {
1517         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1518     }
1521 sub display_configuration {
1522     my $config = shift;
1523     my $dirmap = shift;
1524     my @version = grep /\/usr\/share\/perl\//, @INC;
1525     push @version, ('/usr/share/perl/5.10') if !$version[0];
1526     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1527     foreach my $key (sort keys %$config) {
1528         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1529     }
1531     print "\nand in the following directories:\n\n";
1532     foreach my $key (sort keys %$dirmap) {
1533         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1534     }
1535     print "\n\nTo change any configuration setting, please run\n";
1536     print "perl Makefile.PL again.  To override one of the target\n";
1537     print "directories, you can do so on the command line like this:\n";
1538     print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1539     print "You can also set different default values for parameters\n";
1540     print "or override directory locations by using environment variables.\n";
1541     print "\nFor example:\n\n";
1542     print "export DB_USER=my_koha\n";
1543     print "perl Makefile.PL\n";
1544     print "\nor\n\n";
1545     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1548 =head2 find_zebra
1550 Attempt to find Zebra - check user's PATH and
1551 a few other directories for zebrasrv and zebraidx.
1553 =cut
1555 sub find_zebra {
1556     my @search_dirs = map {
1557                             my $abs = File::Spec->rel2abs($_);
1558                             my ($toss, $directories);
1559                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1560                             $directories;
1561                         }  split /:/, $ENV{PATH};
1562     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1563     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1564     return unless @zebrasrv_dirs;
1565     # verify that directory that contains zebrasrv also contains zebraidx
1566     foreach my $dir (@zebrasrv_dirs) {
1567         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1568     }
1569     return;
1572 package MY;
1574 sub test {
1575     my $self = shift;
1576     my $test = $self->SUPER::test(@_);
1577     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1579     # set KOHA_CONF
1580     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1581     return $test;
1584 sub install {
1585     my $self = shift;
1586     my $install = "";
1587     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1588     # This means that we're completely overriding EU::MM's default
1589     # installation and uninstallation targets.
1591 # If installation is on Win32, we need to do permissions different from *nix
1592     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1593             foreach my $key (sort keys %$target_directories) {
1594                     $install .= qq(
1595 KOHA_INST_$key = blib/$key
1596 KOHA_DEST_$key = $target_directories->{$key}
1597 ) unless exists $skip_directories->{$key};
1598                 }
1599                 $install .= qq(
1600 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1601 \t\$(NOECHO) \$(NOOP)
1603                         $install .= "install_koha ::\n";
1604                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1605                         foreach my $key (sort keys %$target_directories) {
1606                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1607           unless exists $skip_directories->{$key};
1608                         }
1609                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1610                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1612                         $install .= "\n";
1613                         $install .= "set_koha_ownership ::\n";
1614 # Do not try to change ownership if DESTDIR is set
1615                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1616                                 foreach my $key (sort keys %$target_directories) {
1617             $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1618             unless exists $skip_directories->{$key};
1619                                 }
1620                         } else {
1621                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1622                         }
1624                         $install .= "\n";
1625                         $install .= "set_koha_permissions ::\n";
1626                         # This is necessary because EU::MM installs files
1627                         # as either 0444 or 0555, and we want the owner
1628                         # of Koha's files to have write permission by default.
1629                         foreach my $key (sort keys %$target_directories) {
1630                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1631           unless exists $skip_directories->{$key};
1632                         }
1633         }
1635         $install .= "\n";
1637     $install .= "warn_koha_env_vars ::\n";
1638     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1639     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1640     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1641     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1642     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1643     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1644     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1645     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1646     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1647     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1648     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1650     $install .= _update_zebra_conf_target();
1652     $install .= upgrade();
1654     return $install;
1657 =head2 _update_zebra_conf_target
1659 Add an installation target for updating
1660 Zebra's configuration files.
1662 =cut
1664 sub _update_zebra_conf_target {
1666     my $target = "\nupdate_zebra_conf ::\n";
1667     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1668     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1669     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1670     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1671     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1672     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1674     return $target;
1677 sub upgrade {
1678     my $upgrade = "";
1680     my $backup_suffix;
1681     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1682         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1683         $version =~ s/\./_/g;
1684         $backup_suffix = "_koha_$version";
1685     } else {
1686         $backup_suffix = "_upgrade_backup";
1687     }
1689     $upgrade .= qq/
1690 MOD_BACKUP = \$(ABSPERLRUN) -MC4::Installer::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1692 upgrade :: make_upgrade_backup install
1693 \t\$(NOECHO) \$(NOOP)
1694 make_upgrade_backup ::
1695 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1697     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1698                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1699         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1700             unless exists $skip_directories->{$key} or
1701                    not exists $target_directories->{$key};
1702     }
1703     $upgrade =~ s/\\\n$/\n/;
1705     return $upgrade;
1707 sub postamble {
1708     # put directory mappings into Makefile
1709     # so that Make will export as environment
1710     # variables -- this is for the use of
1711     # rewrite-confg.PL
1713     my $env;
1714         # Hereagain, we must alter syntax per platform...
1715         {
1716                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1717                 $env .= "\n\n";
1718                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1719         }
1721     return "$env\n";
1725 __END__
1728 =head1 SEE ALSO
1730 ExtUtils::MakeMaker(3)
1732 =head1 AUTHORS
1734 MJ Ray mjr at phonecoop.coop
1735 Galen Charlton galen.charlton at liblime.com
1737 =cut
1739 FIXME: deal with .htaccess