Bug 19973: Fix SQL syntax error in uk-UA/mandatory/sample_notices.sql
[koha.git] / Makefile.PL
blobada42246ff19e2f094bed147c8da273b7ceddfc9
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   './clubs'                     => 'INTRANET_CGI_DIR',
307   './course_reserves'           => 'INTRANET_CGI_DIR',
308   './docs/history.txt'          => { target => 'DOC_DIR', trimdir => -1 },
309   './offline_circ'              => 'INTRANET_CGI_DIR',
310   './edithelp.pl'               => 'INTRANET_CGI_DIR',
311   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
312   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
313   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
314   './help.pl'                   => 'INTRANET_CGI_DIR',
315   './ill'                       => 'INTRANET_CGI_DIR',
316   './installer-CPAN.pl'         => 'NONE',
317   './installer'                 => 'INTRANET_CGI_DIR',
318   './errors'                    => {target => 'INTRANET_CGI_DIR'},
319   './Koha'                      => 'PERL_MODULE_DIR',
320   './Koha.pm'                   => 'PERL_MODULE_DIR',
321   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
322   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
323   './kohaversion.pl'            => 'INTRANET_CGI_DIR',
324   './labels'                    => 'INTRANET_CGI_DIR',
325   './mainpage.pl'               => 'INTRANET_CGI_DIR',
326   './Makefile.PL'               => 'NONE',
327   './MANIFEST.SKIP'             => 'NONE',
328   './members'                   => 'INTRANET_CGI_DIR',
329   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
330   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
331   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
332   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
333   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
334   './misc/installer_devel_notes' => 'NONE',
335   './opac'                      => 'OPAC_CGI_DIR',
336   './OpenILS'                   => 'PERL_MODULE_DIR',
337   './README.txt'                => 'NONE',
338   './patroncards'               => 'INTRANET_CGI_DIR',
339   './patron_lists'              => 'INTRANET_CGI_DIR',
340   './plugins'                   => 'INTRANET_CGI_DIR',
341   './reports'                   => 'INTRANET_CGI_DIR',
342   './reserve'                   => 'INTRANET_CGI_DIR',
343   './reviews'                   => 'INTRANET_CGI_DIR',
344   './rewrite-config.PL'         => 'NONE',
345   './reviews'                   => 'INTRANET_CGI_DIR',
346   './rotating_collections'      => 'INTRANET_CGI_DIR',
347   './serials'                   => 'INTRANET_CGI_DIR',
348   './services'                  => 'INTRANET_CGI_DIR',
349   './skel'                      => 'NONE',
350   './skel/var/log/koha'         => { target => 'LOG_DIR', trimdir => -1 },
351   './skel/var/spool/koha'       => { target => 'BACKUP_DIR', trimdir => -1 },
352   './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
353   './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
354   './skel/var/lib/koha/zebradb/authorities/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
355   './skel/var/lib/koha/zebradb/authorities/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
356   './skel/var/lib/koha/zebradb/authorities/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
357   './skel/var/lib/koha/zebradb/authorities/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
358   './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
359   './skel/var/lib/koha/zebradb/biblios/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
360   './skel/var/lib/koha/zebradb/biblios/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
361   './skel/var/lib/koha/zebradb/biblios/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
362   './skel/var/lib/koha/zebradb/biblios/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
363   './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
364   './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
365   './sms'                       => 'INTRANET_CGI_DIR',
366   './suggestion'                => 'INTRANET_CGI_DIR',
367   './svc'                       => 'INTRANET_CGI_DIR',
368   './t'                         => 'NONE',
369   './tags'                      => 'INTRANET_CGI_DIR',
370   './tmp'                       => 'NONE', # FIXME need to determine whether
371                                            # Koha generates any persistent temp files
372                                            # that should go in /var/tmp/koha
373   './tools'                     => 'INTRANET_CGI_DIR',
374   './virtualshelves'            => 'INTRANET_CGI_DIR',
375   './xml_sax.pl'                => 'PERL_MODULE_DIR',
376   # ignore files and directories created by the install itself
377   './pm_to_blib'                => 'NONE',
378   './blib'                      => 'NONE',
381 =head1 CONFIGURATION OPTIONS
383 The following configuration options are used by the installer.
385 =over 4
387 =item INSTALL_MODE
389 Specifies whether installation will be FHS-compliant (default,
390 assumes user has root), put everything under
391 a single directory (for users installing on a web host
392 that allows CGI scripts and a MySQL database but not root
393 access), or development (for a developer who wants to run
394 Koha from a git clone with no fuss).
396 =item INSTALL_BASE
398 Directory under which most components will go.  Default
399 value will vary depending on INSTALL_MODE.
401 =item DB_TYPE
403 Type of DBMS (e.g., mysql or Pg).
405 =item DB_HOST
407 Name of DBMS server.
409 =item DB_PORT
411 Port that DBMS server is listening on.
413 =item DB_NAME
415 Name of the DBMS database for Koha.
417 =item DB_USER
419 Name of DBMS user account for Koha's database.
421 =item DB_PASS
423 Pasword of DMBS user account for Koha's database.
425 =item ZEBRA_MARC_FORMAT
427 Specifies format of MARC records to be indexed by Zebra.
429 =item ZEBRA_LANGUAGE
431 Specifies primary language of records that will be
432 indexed by Zebra.
434 =item ZEBRA_USER
436 Internal Zebra user account for the index.
438 =item ZEBRA_PASS
440 Internal Zebra user account's password.
442 =item KOHA_USER
444 System user account that will own Koha's files.
446 =item KOHA_GROUP
448 System group that will own Koha's files.
450 =back
452 =cut
454 # default configuration options
455 my %config_defaults = (
456   'DB_TYPE'           => 'mysql',
457   'DB_HOST'           => 'localhost',
458   'DB_NAME'           => 'koha',
459   'DB_USER'           => 'kohaadmin',
460   'DB_PASS'           => 'katikoan',
461   'DB_USE_TLS'        => 'no',
462   'DB_TLS_CA_CERTIFICATE'  => '/etc/mysql-ssl/server-ca.pem',
463   'DB_TLS_CLIENT_CERTIFICATE'  => '/etc/mysql-ssl/client-cert.pem',
464   'DB_TLS_CLIENT_KEY' => '/etc/mysql-ssl/client-key.pem',
465   'INSTALL_SRU'       => 'yes',
466   'INSTALL_PAZPAR2'   => 'no',
467   'AUTH_INDEX_MODE'   => 'dom',
468   'BIB_INDEX_MODE'    => 'dom',
469   'ZEBRA_MARC_FORMAT' => 'marc21',
470   'ZEBRA_LANGUAGE'    => 'en',
471   'ZEBRA_TOKENIZER'   => 'chr',
472   'ZEBRA_USER'        => 'kohauser',
473   'ZEBRA_PASS'        => 'zebrastripes',
474   'ZEBRA_SRU_HOST'    => 'localhost',
475   'ZEBRA_SRU_BIBLIOS_PORT'    => '9998',
476   'ZEBRA_SRU_AUTHORITIES_PORT'    => '9999',
477   'KOHA_USER'         => 'koha',
478   'KOHA_GROUP'        => 'koha',
479   'MERGE_SERVER_HOST' => 'localhost',
480   'MERGE_SERVER_PORT' => '11001',
481   'PAZPAR2_HOST' => 'localhost',
482   'PAZPAR2_PORT' => '11002',
483   'RUN_DATABASE_TESTS' => 'no',
484   'PATH_TO_ZEBRA' => '',
485   'USE_MEMCACHED'     => 'no',
486   'MEMCACHED_SERVERS' => '127.0.0.1:11211',
487   'MEMCACHED_NAMESPACE' => 'KOHA',
488   'FONT_DIR'          => '/usr/share/fonts/truetype/ttf-dejavu'
491 # set some default configuration options based on OS
492 # more conditions need to be added for other OS's
494 warn "Your platform appears to be $^O.\n" if $DEBUG;
496 if ( $^O eq 'cygwin' ) {
497         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
498         # this could be changed to put some files (ie. libraries) into system32, etc.
499         $config_defaults{'INSTALL_MODE'} = 'single';
500         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
502 else {
503         $config_defaults{'INSTALL_MODE'} = 'standard';
504         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
507 # valid values for certain configuration options
508 my %valid_config_values = (
509   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
510   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
511   'DB_USE_TLS' => {'yes', 'no'},
512   'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
513   'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
514   'BIB_INDEX_MODE'  => { 'grs1' => 1, 'dom' => 1 },
515   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
516   '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
517   'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
518   'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
519   'USE_MEMCACHED'      => { 'yes' => 1, 'no' => 1 },
522 # get settings from command-line
523 my $koha_install_log = "";
524 my $cli_koha_install_mode = "";
525 my $cli_koha_db_type = "";
526 my $cli_koha_db_host = "";
527 my $cli_koha_db_port = "";
528 my $cli_koha_db_name = "";
529 my $cli_koha_db_user = "";
530 my $cli_koha_db_pass = "";
531 my $cli_zebra_marc_format = "";
532 my $cli_zebra_language = "",
533 my $cli_zebra_tokenizer = "";
534 my $cli_zebra_user = "";
535 my $cli_zebra_pass = "";
536 my $cli_zebra_sru_host = "";
537 my $cli_zebra_sru_bib_port = "";
538 my $cli_zebra_sru_auth_port = "";
539 my $cli_koha_auth_index_mode = "";
540 my $cli_koha_bib_index_mode = "";
541 my $cli_koha_user = "";
542 my $cli_koha_group = "";
543 my $cli_koha_install_sru = "";
544 my $cli_koha_install_pazpar2 = "";
545 my $cli_koha_use_memcached = "";
546 my $cli_koha_font_dir = "";
547 my $cli_koha_run_database_tests = "";
548 my $cli_koha_install_base = "";
549 Getopt::Long::Configure('pass_through');
550 my $results = GetOptions(
551     "prev-install-log=s"           => \$koha_install_log,
552     "install_mode=s"               => \$cli_koha_install_mode,
553     "db_type=s"                    => \$cli_koha_db_type,
554     "db_host=s"                    => \$cli_koha_db_host,
555     "db_port=s"                    => \$cli_koha_db_port,
556     "db_name=s"                    => \$cli_koha_db_name,
557     "db_user=s"                    => \$cli_koha_db_user,
558     "db_pass=s"                    => \$cli_koha_db_pass,
559     "zebra_marc_format=s"          => \$cli_zebra_marc_format,
560     "zebra_language=s"             => \$cli_zebra_language,
561     "zebra_tokenizer=s"            => \$cli_zebra_tokenizer,
562     "zebra_user=s"                 => \$cli_zebra_user,
563     "zebra_pass=s"                 => \$cli_zebra_pass,
564     "zebra_sru_host=s"             => \$cli_zebra_sru_host,
565     "zebra_sru_biblios_port=s"     => \$cli_zebra_sru_bib_port,
566     "zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
567     "auth_index_mode=s"            => \$cli_koha_auth_index_mode,
568     "bib_index_mode=s"             => \$cli_koha_bib_index_mode,
569     "koha_user=s"                  => \$cli_koha_user,
570     "koha_group=s"                 => \$cli_koha_group,
571     "install_sru=s"                => \$cli_koha_install_sru,
572     "install_pazpar2=s"            => \$cli_koha_install_pazpar2,
573     "use_memcached=s"              => \$cli_koha_use_memcached,
574     "font_dir=s"                   => \$cli_koha_font_dir,
575     "run_database_tests=s"         => \$cli_koha_run_database_tests,
576     "install_base=s"               => \$cli_koha_install_base,
577     "help"                         => sub { HelpMessage(0) },
578 ) or HelpMessage(1);
580 my %install_log_values = ();
581 if ($koha_install_log ne "") {
582     get_install_log_values($koha_install_log, \%install_log_values);
583 } else {
584     # Try to set install_log_values for provided values;
585     get_cli_values(\%install_log_values);
588 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
589 my ($target_directories, $skip_directories) = get_target_directories(\%config);
590 display_configuration(\%config, $target_directories);
591 my $file_map = {};
592 get_file_map($target_map, $dirtree, $file_map);
594 my $pl_files = {
595       'rewrite-config.PL' => [
596          'blib/KOHA_CONF_DIR/koha-conf.xml',
597          'blib/KOHA_CONF_DIR/koha-httpd.conf',
598          'blib/KOHA_CONF_DIR/log4perl.conf',
599          'blib/ZEBRA_CONF_DIR/etc/default.idx',
600          'blib/MISC_DIR/koha-install-log'
601          ],
602           'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
603                  'blib'
604                  ],
607 push @{ $pl_files->{'rewrite-config.PL'} }, (
608     'blib/ZEBRA_CONF_DIR/etc/passwd',
609     'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
610     'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
611     'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
612     'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
613     'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
614     'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
615     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
616     'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
617     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
618     'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
620 push @{ $pl_files->{'rewrite-config.PL'} }, (
621     'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
622     'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
623     'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
625 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
626     push @{ $pl_files->{'rewrite-config.PL'} }, (
627         'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
628         'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
629     );
631 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
632                               ? 'zebra-authorities-dom.cfg'
633                               : 'zebra-authorities.cfg';
634 $config{'ZEBRA_BIB_CFG'}  = $config{'BIB_INDEX_MODE'} eq 'dom'
635                               ? 'zebra-biblios-dom.cfg'
636                               : 'zebra-biblios.cfg';
637 $config{'AUTH_RETRIEVAL_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
638                                   ? 'retrieval-info-auth-dom.xml'
639                                   : 'retrieval-info-auth-grs1.xml';
640 $config{'BIB_RETRIEVAL_CFG'}  = $config{'BIB_INDEX_MODE'} eq 'dom'
641                                   ? 'retrieval-info-bib-dom.xml'
642                                   : 'retrieval-info-bib-grs1.xml';
645 if ($config{'INSTALL_MODE'} ne "dev") {
646     push @{ $pl_files->{'rewrite-config.PL'} }, (
647         'blib/PERL_MODULE_DIR/C4/Context.pm',
648         'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
649     );
652 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
653     ? 'icuchain words-icu.xml'
654     : 'charmap word-phrase-utf.chr';
656 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
657     ? 'icuchain phrases-icu.xml'
658     : 'charmap word-phrase-utf.chr';
660 my %test_suite_override_dirs = (
661     KOHA_CONF_DIR  => ['etc'],
662     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
663     LOG_DIR        => ['var', 'log'],
664     BACKUP_DIR     => ['var', 'spool'],
665     SCRIPT_DIR     => ['bin'],
666     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
667     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
668     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
671 WriteMakefile(
672               NAME         => 'koha',
673               #VERSION     => strftime('2.9.%Y%m%d%H',gmtime),
674               VERSION_FROM => 'kohaversion.pl',
675               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
676               AUTHOR       => 'Koha Contributors <http://koha-community.org/>',
677               NO_META      => 1,
678               PREREQ_PM    => $koha_pm->prereq_pm,
680               # File tree mapping
681               PM => $file_map,
683               # Man pages generated from POD
684               # ExtUtils::MakeMaker already manage $(DESTDIR)
685               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
686               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
688               PL_FILES => $pl_files,
691 =head1 FUNCTIONS
693 =head2 hashdir
695 This function recurses through the directory structure and builds
696 a hash of hashes containing the structure with arrays holding filenames.
697 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
699 =cut
701 sub hashdir{
702     my $dir = shift;
703     opendir my $dh, $dir or die $!;
704     my $tree = {}->{$dir} = {};
705     while( my $file = readdir($dh) ) {
706         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
707         my $path = $dir .'/' . $file;
708         $tree->{$file} = hashdir($path), next if -d $path;
709         push @{$tree->{'.'}}, $file;
710     }
711     return $tree;
714 =head2 get_file_map
716 This function combines the target_map and file hash to
717 map each source file to its destination relative to
718 the set of installation targets.
720 Output will be a hash mapping from each source file
721 to its destination value, like this:
723 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
725 =cut
727 sub get_file_map {
728     my $target_map = shift;
729     my $dirtree = shift;
730     my $file_map = shift;
731     my $curr_path = @_ ? shift : ['.'];
733     # Traverse the directory tree.
734     # For each file or directory, identify the
735     # most specific match in the target_map
736     foreach my $dir (sort keys %{ $dirtree }) {
737         if ($dir eq '.') {
738             # deal with files in directory
739             foreach my $file (sort @{ $dirtree->{$dir} }) {
740                 my $targetdir = undef;
741                 my $matchlevel = undef;
742                 # first, see if there is a match on this specific
743                 # file in the target map
744                 my $filepath = join("/", @$curr_path, $file);
745                 if (exists $target_map->{$filepath}) {
746                     $targetdir = $target_map->{$filepath};
747                     $matchlevel = scalar(@$curr_path) + 1;
748                 } else {
749                     # no match on the specific file; look for
750                     # a directory match
751                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
752                         my $dirpath = join("/", @$curr_path[0..$i]);
753                         if (exists $target_map->{$dirpath}) {
754                             $targetdir = $target_map->{$dirpath};
755                             $matchlevel = $i + 1;
756                             last;
757                         }
758                     }
759                 }
760                 if (defined $targetdir) {
761                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
762                 } else {
763                     my $path = join("/", @$curr_path);
764                     print "failed to map: $path/$file\n" if $DEBUG;
765                 }
766             }
767         } else {
768             # dealing with subdirectory
769             push @$curr_path, $dir;
770             get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
771             pop @$curr_path;
772         }
773     }
776 sub _add_to_file_map {
777     my $file_map = shift;
778     my $targetdir = shift;
779     my $curr_path = shift;
780     my $file = shift;
781     my $matchlevel = shift;
782     my $dest_path = @_ ? shift : $curr_path;
784     # The target can be one of the following:
785     # 1. scalar representing target symbol
786     # 2. hash ref containing target and trimdir keys
787     #
788     # Consequently, this routine traverses this structure,
789     # calling itself recursively, until it deals with
790     # all of the scalar target symbols.
791     if (ref $targetdir eq 'HASH') {
792         my $subtarget = $targetdir->{target};
793         if (exists $targetdir->{trimdir}) {
794             # if we get here, we've specified that
795             # rather than installing the file to
796             # $(TARGET)/matching/dirs/subdirs/file,
797             # we want to install it to
798             # $(TARGET)/subdirs/file
799             #
800             # Note that this the only place where
801             # $matchlevel is used.
802             my @new_dest_path = @$dest_path;
803             if ($targetdir->{trimdir} == -1)  {
804                 splice @new_dest_path, 0, $matchlevel;
805             } else {
806                 splice @new_dest_path, 0, $targetdir->{trimdir};
807             }
808             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
809         } else {
810             # actually getting here means that the
811             # target was unnecessarily listed
812             # as a hash, but we'll forgive that
813             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
814         }
815     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
816         my $source = File::Spec->catfile(@$curr_path, $file);
817         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
818         #print "$source => $destination\n"; # DEBUG
819         # quote spaces in file names
820         # FIXME: this is of questionable portability and
821         # probably depends on user's make recognizing this
822         # quoting syntax -- probably better to remove
823         # spaces and shell metacharacters from all file names
824         $source =~ s/ /\\ /g;
825         $destination =~ s/ /\\ /g;
827         $file_map->{$source} = $destination;
828     }
831 =head2 get_cli_values
833 Reads values provided on cli for configuration values
835 =cut
837 sub get_cli_values {
838     my $values = shift;
839     my $map = {
840         INSTALL_MODE               => $cli_koha_install_mode,
841         DB_TYPE                    => $cli_koha_db_type,
842         DB_HOST                    => $cli_koha_db_host,
843         DB_PORT                    => $cli_koha_db_port,
844         DB_NAME                    => $cli_koha_db_name,
845         DB_USER                    => $cli_koha_db_user,
846         DB_PASS                    => $cli_koha_db_pass,
847         ZEBRA_MARC_FORMAT          => $cli_zebra_marc_format,
848         ZEBRA_LANGUAGE             => $cli_zebra_language,
849         ZEBRA_TOKENIZER            => $cli_zebra_tokenizer,
850         ZEBRA_USER                 => $cli_zebra_user,
851         ZEBRA_PASS                 => $cli_zebra_pass,
852         ZEBRA_SRU_HOST             => $cli_zebra_sru_host,
853         ZEBRA_SRU_BIBLIOS_PORT     => $cli_zebra_sru_bib_port,
854         ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
855         AUTH_INDEX_MODE            => $cli_koha_auth_index_mode,
856         BIB_INDEX_MODE             => $cli_koha_bib_index_mode,
857         KOHA_USER                  => $cli_koha_user,
858         KOHA_GROUP                 => $cli_koha_group,
859         INSTALL_SRU                => $cli_koha_install_sru,
860         INSTALL_PAZPAR2            => $cli_koha_install_pazpar2,
861         USE_MEMCACHED              => $cli_koha_use_memcached,
862         FONT_DIR                   => $cli_koha_font_dir,
863         RUN_DATABASE_TESTS         => $cli_koha_run_database_tests,
864         INSTALL_BASE               => $cli_koha_install_base
865     };
866     foreach my $key (keys %{$map}) {
867         $values->{$key} = $map->{$key} if ($map->{$key});
868     }
871 =head2 get_install_log_values
873 Reads value from the Koha install log specified by
874 --prev-install-log
876 =cut
878 sub get_install_log_values {
879     my $install_log = shift;
880     my $values = shift;
882     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
883     while (<LOG>) {
884         chomp;
885         next if /^#/ or /^\s*$/;
886         next if /^=/;
887         next unless m/=/;
888         s/\s+$//g;
889         my ($key, $value) = split /=/, $_, 2;
890         $values->{$key} = $value;
891     }
892     close LOG;
894     print <<_EXPLAIN_INSTALL_LOG_;
895 Reading values from install log $install_log.  You
896 will be prompted only for settings that have been
897 added since the last time you installed Koha.  To
898 be prompted for all settings, run 'perl Makefile.PL'
899 without the --prev-install-log option.
900 _EXPLAIN_INSTALL_LOG_
903 =head2 get_configuration
905 This prompts the user for various configuration options.
907 =cut
909 sub get_configuration {
910   my $defaults = shift;
911   my $valid_values = shift;
912   my $install_log_values = shift;
913   my %config = ();
915   my $msg = q(
916 By default, Koha can be installed in one of three ways:
918 standard: Install files in conformance with the Filesystem
919           Hierarchy Standard (FHS).  This is the default mode
920           and should be used when installing a production
921           Koha system.  On Unix systems, root access is
922           needed to complete a standard installation.
924 single:   Install files under a single directory.  This option
925           is useful for installing Koha without root access, e.g.,
926           on a web host that allows CGI scripts and MySQL databases
927           but requires the user to keep all files under the user's
928           HOME directory.
930 dev:      Create a set of symbolic links and configuration files to
931           allow Koha to run directly from the source distribution.
932           This mode is useful for developers who want to run
933           Koha from a git clone.
935 Installation mode);
936     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
937     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
939     # set message and default value for INSTALL_BASE
940     # depending on value of INSTALL_MODE
941     my $install_base_default = $defaults->{'INSTALL_BASE'};
942     if ($config{'INSTALL_MODE'} eq 'dev') {
943         $msg = q(
944 Please specify the directory in which to install Koha's
945 active configuration files and (if applicable) the
946 Zebra database.  Koha's CGI scripts and templates will
947 be run from the current directory.
949 Configuration directory:);
950         # FIXME - home directory portability consideration apply
951         $install_base_default =
952             $ENV{DESTDIR}
953             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
954         ;
955     } elsif ($config{'INSTALL_MODE'} eq 'single') {
956         $msg = "\nPlease specify the directory in which to install Koha";
957         # FIXME -- we're assuming under a 'single' mode install
958         # that user will likely want to install under the home
959         # directory.  This is OK in and of itself, but we should
960         # use File::HomeDir to locate the home directory portably.
961         # This is deferred for now because File::HomeDir is not yet
962         # core.
963                 # --we must also keep this portable to the major OS's -fbcit
964         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
965     } else {
966         # must be standard
967         $msg = q(
968 Please specify the directory under which most Koha files
969 will be installed.
971 Note that if you are planning in installing more than
972 one instance of Koha, you may want to modify the last
973 component of the directory path, which will be used
974 as the package name in the FHS layout.
976 Base installation directory);
977     }
978     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
980     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
981         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
982     if ($config{'INSTALL_MODE'} eq "standard") {
983         $msg = q(
984 Since you are using the 'standard' install
985 mode, you should run 'make install' as root.
986 However, it is recommended that a non-root
987 user (on Unix and Linux platforms) have
988 ownership of Koha's files, including the
989 Zebra indexes if applicable.
991 Please specify a user account.  This
992 user account does not need to exist
993 right now, but it needs to exist
994 before you run 'make install'.  Please
995 note that for security reasons, this
996 user should not be the same as the user
997 account Apache runs under.
999 User account);
1000         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
1002         $msg = q(
1003 Please specify the group that should own
1004 Koha's files.  As above, this group need
1005 not exist right now, but should be created
1006 before you run 'make install'.
1008 Group);
1009         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
1010     }
1012     $msg = q(
1013 Please specify which database engine you will use
1014 to store data in Koha.  The choices are MySQL and
1015 PostgreSQL; please note that at the moment
1016 PostgreSQL support is highly experimental.
1018 DBMS to use);
1019     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
1020     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
1022     $msg = q(
1023 Please specify the name or address of your
1024 database server.  Note that the database
1025 does not have to exist at this point, it
1026 can be created after running 'make install'
1027 and before you try using Koha for the first time.
1029 Database server);
1030     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
1032     $msg = q(
1033 Please specify the port used to connect to the
1034 DMBS);
1035     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
1036     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
1038     $msg = q(
1039 Please specify the name of the database to be
1040 used by Koha);
1041     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
1042     if ($config{'DB_TYPE'} eq 'mysql'){
1043         $msg = q(
1044 Please specify whether the connection to MySQL will use TLS
1045         );
1046         $config{'DB_USE_TLS'} = _get_value('DB_USE_TLS', $msg, $defaults->{'DB_USE_TLS'}, $valid_values, $install_log_values);
1047     }
1048     if ($config{'DB_USE_TLS'} eq 'yes'){
1049         $msg = q(
1050 Please enter the path to the CA certificate for TLS
1051         );
1052         $config{'DB_TLS_CA_CERTIFICATE'} = _get_value('DB_TLS_CA_CERTIFICATE', $msg, $defaults->{'DB_TLS_CA_CERTIFICATE'}, $valid_values, $install_log_values);
1054         $msg = q(
1055 Please enter the path to the client certificate for TLS
1056         );
1057         $config{'DB_TLS_CLIENT_CERTIFICATE'} = _get_value('DB_TLS_CLIENT_CERTIFICATE', $msg, $defaults->{'DB_TLS_CLIENT_CERTIFICATE'}, $valid_values, $install_log_values);
1058         $msg = q(
1059 Please enter the path to the client key for TLS
1060         );
1061         $config{'DB_TLS_CLIENT_KEY'} = _get_value('DB_TLS_CLIENT_KEY', $msg, $defaults->{'DB_TLS_CLIENT_KEY'}, $valid_values, $install_log_values);
1062     }
1064     $msg = q(
1065 Please specify the user that owns the database to be
1066 used by Koha);
1067     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
1069     $msg = q(
1070 Please specify the password of the user that owns the
1071 database to be used by Koha);
1072     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
1074     print q(
1075 Koha uses the Zebra search engine for high-performance
1076 searching of bibliographic and authority records.  Checking
1077 to see if you have installed the Zebra software...
1080     if (defined(my $zebra_path = find_zebra())) {
1081         $config{'PATH_TO_ZEBRA'} = $zebra_path;
1082         print qq(
1083 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
1085     } else {
1086         print q(
1087 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
1088 in your PATH or in some of the usual places.  If you haven't
1089 installed Zebra yet, please do so and run Makefile.PL again.
1092     }
1094     $msg = q(
1095 You must specify the primary MARC format of the
1096 records to be indexed by Zebra.
1098 Koha provides Zebra configuration files for MARC21,
1099 NORMARC and UNIMARC.
1101 MARC format for Zebra indexing);
1102     $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1103     $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1104     $msg = q(
1105 Koha supplies Zebra configuration files tuned for
1106 searching either English (en) or French (fr) MARC
1107 records.
1109 Primary language for Zebra indexing);
1110     $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1111     $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1113     $msg = q(
1114 Koha can use one of  two different indexing modes
1115 for the MARC bibliographic records:
1117 dom  - uses the DOM XML filter; offers improved
1118        functionality.
1119 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
1120        available for legacy support
1122 Bibliographic indexing mode);
1123     $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
1124     $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
1127     $msg = q(
1128 Koha can use one of  two different indexing modes
1129 for the MARC authorities records:
1131 dom  - uses the DOM XML filter; offers improved
1132        functionality.
1133 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
1134        available for legacy support
1136 Authorities indexing mode);
1137     $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1138     $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1140     $msg = q(
1141 Zebra has two methods to perform records tokenization
1142 and characters normalization: CHR and ICU. ICU is
1143 recommended for catalogs containing non-Latin
1144 characters.);
1146     $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
1147     $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
1149     $msg = q(
1150 Please specify Zebra database user);
1151     $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1153     $msg = q(
1154 Please specify the Zebra database password);
1155     $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1157     $msg = q(
1158 Since you've chosen to use Zebra, you can enable the SRU/
1159 Z39.50 Server if you so choose, but you must specify a
1160 few configuration options for it.
1162 Please note that if you choose *NOT* to configure SRU,
1163 koha-conf.xml will still contain some references to SRU
1164 settings.  Those references will be ignored by Koha.
1166 Install the SRU configuration files?);
1167     $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1168     $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1170     if ($config{'INSTALL_SRU'} eq 'yes') {
1171         $msg = q(
1172 Since you've chosen to configure SRU, you must
1173 specify the host and port(s) that the SRU
1174 Servers (bibliographic and authority) should run on.
1176         $msg = q(
1177 SRU Database host?);
1178         $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1180         $msg = q(
1181 SRU port for bibliographic data?);
1182         $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1184         $msg = q(
1185 SRU port for authority data?);
1186         $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1188     }
1190     $msg = q(
1191 Along with Zebra, you can also choose to install PazPar2,
1192 which is a metasearch tool.  With PazPar2,
1193 Koha can perform on-the-fly merging of bibliographic
1194 records during searching, allowing for FRBRization of
1195 the results list.
1197 Install the PazPar2 configuration files?);
1198     $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1199     $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1201     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1202         $msg = q(
1203 Since you've chosen to configure PazPar2, you must
1204 specify the host and port(s) that PazPar2
1205 uses:
1207         $msg = q(
1208 Zebra bibliographic server host?);
1209         $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1211         $msg = q(
1212 Zebra bibliographic port for PazPar2 to use?);
1213         $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1215         $msg = q(
1216 PazPar2 host?);
1217         $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1219         $msg = q(
1220 PazPar2 port?);
1221         $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1223     }
1225   $msg = q(
1226 Use memcached to cache the results of some function calls?
1227 This provides a signficant performance improvement.
1228 You will need a Memcached server running.);
1229   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1230   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1231   if ($config{'USE_MEMCACHED'} eq 'yes'){
1232       $msg = q(
1233 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1235       $msg = q(
1236 Memcached server address?);
1237       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1239       $msg = q(
1240 Memcached namespace?);
1241       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1242   }
1244   $msg = q(
1245 Path to DejaVu fonts?);
1246   $config{'FONT_DIR'} = _get_value('FONT_DIR', $msg, $defaults->{'FONT_DIR'}, $valid_values, $install_log_values);
1249   $msg = q(
1250 Would you like to run the database-dependent test suite?);
1251   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1252     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1254   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1255       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1256       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1257       $msg = q(TEST DATABASE
1259 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1260 testing. Please don't do this on your production database. It is not
1261 reversable.
1263 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1264 database. You are better off not running this optional test suite than
1265 doing it in a database that you don't want to lose.
1267 Please specify the name of the test database to be
1268 used by Koha);
1270       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1271       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1272           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1273           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1274       }
1276       $msg = q(
1277 Please specify the user that owns the database to be
1278 used by Koha);
1279     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1281       $msg = q(
1282 Please specify the password of the user that owns the
1283 database to be used by Koha);
1284       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1285   }
1287     print "\n\n";
1289     # add version number
1290     my $version = "no_version_found";
1291     eval {
1292         require 'kohaversion.pl';
1293         $version = kohaversion();
1294     };
1295     $config{'KOHA_INSTALLED_VERSION'} = $version;
1297     return %config;
1300 sub _add_valid_values_disp {
1301     my $key = shift;
1302     my $valid_values = shift;
1304     my $disp = "";
1305     if (exists $valid_values->{$key}) {
1306         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1307     }
1308     return $disp;
1311 sub _get_value {
1312     my $key = shift;
1313     my $msg = shift;
1314     my $default = shift;
1315     my $valid_values = shift;
1316     my $install_log_values = shift;
1318     # take value from install log if present
1319     if (exists $install_log_values{$key}) {
1320         $install_log_values{$key} =~ s/\$/\$\$/g;
1321         return $install_log_values{$key};
1322     }
1324     # override default value from environment
1325     if (exists $ENV{$key}) {
1326         $default = $ENV{$key};
1327         $msg .= " (default from environment)";
1328     }
1330     my $val = prompt($msg, $default);
1332     while (exists $valid_values->{$key} and
1333            $val ne $default and
1334            not exists $valid_values->{$key}->{$val}) {
1335         my $retry_msg = "Value '$val' is not a valid option.\n";
1336         $retry_msg .= "Please enter a value";
1337         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1338         $val = prompt($retry_msg, $default);
1339     }
1340     $val =~ s/\$/\$\$/g;
1341     return $val;
1344 =head2 get_target_directories
1346 Creates a hash mapping from symbols for installation target
1347 directories to actual directory paths.
1349 Also returns a hash indicating targets for which
1350 files need not be copied -- this is used for the 'dev'
1351 mode installation, where some files are installed in place.
1353 =cut
1355 sub get_target_directories {
1356     my $config = shift;
1358     my $base = $config->{'INSTALL_BASE'};
1359     my $mode = $config->{'INSTALL_MODE'};
1361     # get last component of install base directory
1362     # to treat as package name
1363     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1365     my @basedir = File::Spec->splitdir($directories);
1367     if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1369     my $package = pop @basedir;
1372     my %dirmap = ();
1373     my %skipdirs = ();
1374     if ($mode eq 'single') {
1375         $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1376         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1377         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1378         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1379         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1380         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1381         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1382         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1383         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1384         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1385         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1386         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1387         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1388         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1389         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1390         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1391         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1392         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1393         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1394         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1395         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1396         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1397     } elsif ($mode eq 'dev') {
1398         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1399         $dirmap{'API_CGI_DIR'} = File::Spec->catdir($curdir, 'api');
1400         $skipdirs{'API_CGI_DIR'} = 1;
1401         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1402         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1403         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1404         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1405         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1406         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1407         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1408         $skipdirs{'OPAC_CGI_DIR'} = 1;
1409         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1410         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1411         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1412         $skipdirs{'OPAC_WWW_DIR'} = 1;
1413         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1414         $skipdirs{'PERL_MODULE_DIR'} = 1;
1415         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1416         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1417         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1418         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1419         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1420         #For dev install, point NONDEV_DIR to misc in current dir (not base)
1421         #Used by supportdir in koha-conf.xml (BZ 12031)
1422         $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1423         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1424         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1425         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1426         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1427         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1428         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1429         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1430         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1431         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1432     } else {
1433         # mode is standard, i.e., 'fhs'
1434         $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1435         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1436         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1437         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1438         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1439         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1440         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1441         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1442         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1443         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1444         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1445         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1446         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1447         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1448         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1449         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1450         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1451         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1452         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1453         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1454         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1455         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1456     }
1458     _get_env_overrides(\%dirmap);
1459     _get_argv_overrides(\%dirmap);
1460     _add_destdir(\%dirmap);
1462     return \%dirmap, \%skipdirs;
1465 =head2 get_test_dir
1467 Map a directory target to the corresponding path for
1468 the test suite.
1470 =cut
1472 sub get_test_dir {
1473     my ($dirname) = @_;
1475     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1476     if (exists $test_suite_override_dirs{$dirname}) {
1477         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1478     } else {
1479         return;
1480     }
1484 sub _get_env_overrides {
1485     my $dirmap = shift;
1487     foreach my $key (keys %$dirmap) {
1488         if (exists $ENV{$key}) {
1489             $dirmap->{$key} = $ENV{$key};
1490             print "Setting $key from environment\n";
1491         }
1492     }
1495 sub _get_argv_overrides {
1496     my $dirmap = shift;
1498     my @new_argv = ();
1499     for (my $i = 0; $i <= $#ARGV; $i++) {
1500         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1501             $dirmap->{$1} = $2;
1502         } else {
1503             push @new_argv, $ARGV[$i];
1504         }
1505     }
1506     @ARGV = @new_argv;
1509 sub _strip_destdir {
1510     my $dir = shift;
1511     $dir =~ s/^\$\(DESTDIR\)//;
1512     return $dir;
1515 sub _add_destdir {
1516     my $dirmap = shift;
1518     foreach my $key (keys %$dirmap) {
1519         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1520     }
1523 sub display_configuration {
1524     my $config = shift;
1525     my $dirmap = shift;
1526     my @version = grep /\/usr\/share\/perl\//, @INC;
1527     push @version, ('/usr/share/perl/5.10') if !$version[0];
1528     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1529     foreach my $key (sort keys %$config) {
1530         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1531     }
1533     print "\nand in the following directories:\n\n";
1534     foreach my $key (sort keys %$dirmap) {
1535         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1536     }
1537     print "\n\nTo change any configuration setting, please run\n";
1538     print "perl Makefile.PL again.  To override one of the target\n";
1539     print "directories, you can do so on the command line like this:\n";
1540     print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1541     print "You can also set different default values for parameters\n";
1542     print "or override directory locations by using environment variables.\n";
1543     print "\nFor example:\n\n";
1544     print "export DB_USER=my_koha\n";
1545     print "perl Makefile.PL\n";
1546     print "\nor\n\n";
1547     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1550 =head2 find_zebra
1552 Attempt to find Zebra - check user's PATH and
1553 a few other directories for zebrasrv and zebraidx.
1555 =cut
1557 sub find_zebra {
1558     my @search_dirs = map {
1559                             my $abs = File::Spec->rel2abs($_);
1560                             my ($toss, $directories);
1561                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1562                             $directories;
1563                         }  split /:/, $ENV{PATH};
1564     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1565     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1566     return unless @zebrasrv_dirs;
1567     # verify that directory that contains zebrasrv also contains zebraidx
1568     foreach my $dir (@zebrasrv_dirs) {
1569         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1570     }
1571     return;
1574 package MY;
1576 sub test {
1577     my $self = shift;
1578     my $test = $self->SUPER::test(@_);
1579     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1581     # set KOHA_CONF
1582     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1583     return $test;
1586 sub install {
1587     my $self = shift;
1588     my $install = "";
1589     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1590     # This means that we're completely overriding EU::MM's default
1591     # installation and uninstallation targets.
1593 # If installation is on Win32, we need to do permissions different from *nix
1594     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1595             foreach my $key (sort keys %$target_directories) {
1596                     $install .= qq(
1597 KOHA_INST_$key = blib/$key
1598 KOHA_DEST_$key = $target_directories->{$key}
1599 ) unless exists $skip_directories->{$key};
1600                 }
1601                 $install .= qq(
1602 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1603 \t\$(NOECHO) \$(NOOP)
1605                         $install .= "install_koha ::\n";
1606                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1607                         foreach my $key (sort keys %$target_directories) {
1608                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1609           unless exists $skip_directories->{$key};
1610                         }
1611                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1612                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1614                         $install .= "\n";
1615                         $install .= "set_koha_ownership ::\n";
1616 # Do not try to change ownership if DESTDIR is set
1617                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1618                                 foreach my $key (sort keys %$target_directories) {
1619             $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1620             unless exists $skip_directories->{$key};
1621                                 }
1622                         } else {
1623                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1624                         }
1626                         $install .= "\n";
1627                         $install .= "set_koha_permissions ::\n";
1628                         # This is necessary because EU::MM installs files
1629                         # as either 0444 or 0555, and we want the owner
1630                         # of Koha's files to have write permission by default.
1631                         foreach my $key (sort keys %$target_directories) {
1632                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1633           unless exists $skip_directories->{$key};
1634                         }
1635         }
1637         $install .= "\n";
1639     $install .= "warn_koha_env_vars ::\n";
1640     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1641     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1642     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1643     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1644     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1645     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1646     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1647     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1648     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1649     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1650     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1652     $install .= _update_zebra_conf_target();
1654     $install .= upgrade();
1656     return $install;
1659 =head2 _update_zebra_conf_target
1661 Add an installation target for updating
1662 Zebra's configuration files.
1664 =cut
1666 sub _update_zebra_conf_target {
1668     my $target = "\nupdate_zebra_conf ::\n";
1669     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1670     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1671     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1672     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1673     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1674     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1676     return $target;
1679 sub upgrade {
1680     my $upgrade = "";
1682     my $backup_suffix;
1683     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1684         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1685         $version =~ s/\./_/g;
1686         $backup_suffix = "_koha_$version";
1687     } else {
1688         $backup_suffix = "_upgrade_backup";
1689     }
1691     $upgrade .= qq/
1692 MOD_BACKUP = \$(ABSPERLRUN) -MC4::Installer::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1694 upgrade :: make_upgrade_backup install
1695 \t\$(NOECHO) \$(NOOP)
1696 make_upgrade_backup ::
1697 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1699     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1700                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1701         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1702             unless exists $skip_directories->{$key} or
1703                    not exists $target_directories->{$key};
1704     }
1705     $upgrade =~ s/\\\n$/\n/;
1707     return $upgrade;
1709 sub postamble {
1710     # put directory mappings into Makefile
1711     # so that Make will export as environment
1712     # variables -- this is for the use of
1713     # rewrite-confg.PL
1715     my $env;
1716         # Hereagain, we must alter syntax per platform...
1717         {
1718                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1719                 $env .= "\n\n";
1720                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1721         }
1723     return "$env\n";
1727 __END__
1730 =head1 SEE ALSO
1732 ExtUtils::MakeMaker(3)
1734 =head1 AUTHORS
1736 MJ Ray mjr at phonecoop.coop
1737 Galen Charlton galen.charlton at liblime.com
1739 =cut
1741 FIXME: deal with .htaccess