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/
24 use ExtUtils::MakeMaker;
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;
34 my $koha_pm = C4::Installer::PerlModules->new;
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('.');
46 Makefile.PL - Koha packager and installer
50 =head2 BASIC INSTALLATION
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
67 =head2 PACKAGING RELEASE TARBALLS
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 --template-cache-dir Specify a template cache directory (e.g. /var/cache/koha)
105 --help Display this help message
109 This is a packager and installer that uses
110 ExtUtils::MakeMaker, which is fairly common
112 As well as building tar or zip files
113 and installing with the above commands,
114 it allows us to check pre-requisites
115 and generate configuration files.
119 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
121 Basic metadata about this software.
125 Suppress generation of META.yml file.
129 Hash of perl modules and versions required.
133 Hash of file mappings
137 This is a hash of PL scripts to run after installation and
138 the files to ask them to generate.
139 Maybe use the values from CONFIGURE
140 to generate initial configuration files in future.
146 This is a hash mapping directories and files in the
147 source tree to installation target directories. The rules
148 for this mapping are:
152 =item If a directory or file is specified, it and its
153 contents will be copied to the installation target directory.
155 =item If a subdirectory of a mapped directory is specified,
156 its target overrides the parent's target for that subdirectory.
158 =item The value of each map entry may either be a scalar containing
159 one target or a reference to a hash containing 'target' and 'trimdir'
162 =item Any files at the top level of the source tree that are
163 not included in the map will not be installed.
165 =item Any directories at the top level of the source tree
166 that are not included in the map will be installed in
167 INTRANET_CGI_DIR. This is a sensible default given the
168 current organization of the source tree, but (FIXME) it
169 would be better to reorganize the source tree to better
170 match the installation system, to allow adding new directories
171 without having to adjust Makefile.PL each time. The idea
172 is to make the C<$target_map> hash as minimal as possible.
176 The permitted installation targets are:
180 =item INTRANET_CGI_DIR
182 CGI scripts for intranet (staff) interface.
184 =item INTRANET_TMPL_DIR
186 HTML templates for the intranet interface.
188 =item INTRANET_WWW_DIR
190 HTML files, images, etc. for DocumentRoot for the intranet interface.
194 CGI scripts for OPAC (public) interface.
198 HTML templates for the OPAC interface.
202 HTML files, images, etc. for DocumentRoot for the OPAC interface.
204 =item PERL_MODULE_DIR
206 Perl modules (at present just the C4 modules) that are intimately
207 tied to Koha. Depending on the installation options, these
208 may or may not be installed one of the standard directories
209 in Perl's default @LIB.
213 Directory for Koha configuration files.
217 Directory for Zebra configuration files.
221 Directory for Zebra's lock files. This includes subdirs for authorities,
222 biblios, and the zebra rebuild function. Any activity to reindex
223 zebra from koha should interlock here with rebuild_zebra.pl.
227 Directory for Zebra's data files.
231 Directory for Zebra's UNIX-domain sockets.
235 Directory for for miscellaenous scripts, among other
236 things the translation toolkit and RSS feed tools.
240 Directory for command-line scripts and daemons to
241 be set up all for installation modes.
243 =item SCRIPT_NONDEV_DIR
245 Directory for command-line scripts that should
246 be installed in the same directory as the
247 SCRIPT_DIR target except 'dev' installs.
251 Directory for man pages created from POD -- will mostly
252 contain information of interest to Koha developers.
256 Directory for Koha documentation accessed from the
257 command-line, e.g., READMEs.
261 Directory for Apache and Zebra logs produced by Koha.
265 Directory for backup files produced by Koha.
269 Directory for external Koha plugins.
271 =item PAZPAR2_CONF_DIR
273 Directory for PazPar2 configuration files.
277 Directory where DejaVu fonts are installed.
281 This is a dummy target used to explicitly state
282 that a given file or directory is not to be installed.
283 This is used either for parts of the installer itself
284 or for development tools that are not applicable to a
285 production installation.
292 './about.pl' => 'INTRANET_CGI_DIR',
293 './acqui' => 'INTRANET_CGI_DIR',
294 './admin' => 'INTRANET_CGI_DIR',
295 './api' => { target => 'API_CGI_DIR', trimdir => -1 },
296 './authorities' => 'INTRANET_CGI_DIR',
297 './basket' => 'INTRANET_CGI_DIR',
298 './C4' => 'PERL_MODULE_DIR',
299 './C4/SIP/t' => 'NONE',
300 './C4/SIP/koha_test' => 'NONE',
301 './C4/tests' => 'NONE',
302 './catalogue' => 'INTRANET_CGI_DIR',
303 './cataloguing' => 'INTRANET_CGI_DIR',
304 './changelanguage.pl' => 'INTRANET_CGI_DIR',
305 './check_sysprefs.pl' => 'NONE',
306 './circ' => 'INTRANET_CGI_DIR',
307 './clubs' => 'INTRANET_CGI_DIR',
308 './course_reserves' => 'INTRANET_CGI_DIR',
309 './docs/history.txt' => { target => 'DOC_DIR', trimdir => -1 },
310 './offline_circ' => 'INTRANET_CGI_DIR',
311 './edithelp.pl' => 'INTRANET_CGI_DIR',
312 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
313 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
314 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
315 './help.pl' => 'INTRANET_CGI_DIR',
316 './ill' => 'INTRANET_CGI_DIR',
317 './installer-CPAN.pl' => 'NONE',
318 './installer' => 'INTRANET_CGI_DIR',
319 './errors' => {target => 'INTRANET_CGI_DIR'},
320 './Koha' => 'PERL_MODULE_DIR',
321 './Koha.pm' => 'PERL_MODULE_DIR',
322 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
323 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
324 './kohaversion.pl' => 'INTRANET_CGI_DIR',
325 './labels' => 'INTRANET_CGI_DIR',
326 './mainpage.pl' => 'INTRANET_CGI_DIR',
327 './Makefile.PL' => 'NONE',
328 './MANIFEST.SKIP' => 'NONE',
329 './members' => 'INTRANET_CGI_DIR',
330 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
331 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
332 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
333 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
334 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
335 './misc/installer_devel_notes' => 'NONE',
336 './opac' => 'OPAC_CGI_DIR',
337 './OpenILS' => 'PERL_MODULE_DIR',
338 './README.txt' => 'NONE',
339 './patroncards' => 'INTRANET_CGI_DIR',
340 './patron_lists' => 'INTRANET_CGI_DIR',
341 './plugins' => 'INTRANET_CGI_DIR',
342 './reports' => 'INTRANET_CGI_DIR',
343 './reserve' => 'INTRANET_CGI_DIR',
344 './reviews' => 'INTRANET_CGI_DIR',
345 './rewrite-config.PL' => 'NONE',
346 './reviews' => 'INTRANET_CGI_DIR',
347 './rotating_collections' => 'INTRANET_CGI_DIR',
348 './serials' => 'INTRANET_CGI_DIR',
349 './services' => 'INTRANET_CGI_DIR',
351 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
352 './skel/var/spool/koha' => { target => 'BACKUP_DIR', trimdir => -1 },
353 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
354 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
355 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
356 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
357 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
358 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
359 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
360 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
361 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
362 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
363 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
364 './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
365 './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
366 './sms' => 'INTRANET_CGI_DIR',
367 './suggestion' => 'INTRANET_CGI_DIR',
368 './svc' => 'INTRANET_CGI_DIR',
370 './tags' => 'INTRANET_CGI_DIR',
371 './tmp' => 'NONE', # FIXME need to determine whether
372 # Koha generates any persistent temp files
373 # that should go in /var/tmp/koha
374 './tools' => 'INTRANET_CGI_DIR',
375 './virtualshelves' => 'INTRANET_CGI_DIR',
376 # ignore files and directories created by the install itself
377 './pm_to_blib' => 'NONE',
381 =head1 CONFIGURATION OPTIONS
383 The following configuration options are used by the installer.
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).
398 Directory under which most components will go. Default
399 value will vary depending on INSTALL_MODE.
403 Type of DBMS (e.g., mysql or Pg).
411 Port that DBMS server is listening on.
415 Name of the DBMS database for Koha.
419 Name of DBMS user account for Koha's database.
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.
431 Specifies primary language of records that will be
436 Internal Zebra user account for the index.
440 Internal Zebra user account's password.
444 System user account that will own Koha's files.
448 System group that will own Koha's files.
454 # default configuration options
455 my %config_defaults = (
456 'DB_TYPE' => 'mysql',
457 'DB_HOST' => 'localhost',
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' => 'yes',
486 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
487 'MEMCACHED_NAMESPACE' => 'KOHA',
488 'TEMPLATE_CACHE_DIR' => '/tmp/koha',
489 'FONT_DIR' => '/usr/share/fonts/truetype/ttf-dejavu'
492 # set some default configuration options based on OS
493 # more conditions need to be added for other OS's
495 warn "Your platform appears to be $^O.\n" if $DEBUG;
497 if ( $^O eq 'cygwin' ) {
498 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
499 # this could be changed to put some files (ie. libraries) into system32, etc.
500 $config_defaults{'INSTALL_MODE'} = 'single';
501 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
504 $config_defaults{'INSTALL_MODE'} = 'standard';
505 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
508 # valid values for certain configuration options
509 my %valid_config_values = (
510 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
511 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
512 'DB_USE_TLS' => {'yes', 'no'},
513 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
514 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
515 'BIB_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
516 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
517 '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
518 'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
519 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
520 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
523 # get settings from command-line
524 my $koha_install_log = "";
525 my $cli_koha_install_mode = "";
526 my $cli_koha_db_type = "";
527 my $cli_koha_db_host = "";
528 my $cli_koha_db_port = "";
529 my $cli_koha_db_name = "";
530 my $cli_koha_db_user = "";
531 my $cli_koha_db_pass = "";
532 my $cli_zebra_marc_format = "";
533 my $cli_zebra_language = "",
534 my $cli_zebra_tokenizer = "";
535 my $cli_zebra_user = "";
536 my $cli_zebra_pass = "";
537 my $cli_zebra_sru_host = "";
538 my $cli_zebra_sru_bib_port = "";
539 my $cli_zebra_sru_auth_port = "";
540 my $cli_koha_auth_index_mode = "";
541 my $cli_koha_bib_index_mode = "";
542 my $cli_koha_user = "";
543 my $cli_koha_group = "";
544 my $cli_koha_install_sru = "";
545 my $cli_koha_install_pazpar2 = "";
546 my $cli_koha_use_memcached = "";
547 my $cli_koha_font_dir = "";
548 my $cli_koha_run_database_tests = "";
549 my $cli_koha_install_base = "";
550 my $cli_koha_template_cache_dir = "";
551 Getopt::Long::Configure('pass_through');
552 my $results = GetOptions(
553 "prev-install-log=s" => \$koha_install_log,
554 "install_mode=s" => \$cli_koha_install_mode,
555 "db_type=s" => \$cli_koha_db_type,
556 "db_host=s" => \$cli_koha_db_host,
557 "db_port=s" => \$cli_koha_db_port,
558 "db_name=s" => \$cli_koha_db_name,
559 "db_user=s" => \$cli_koha_db_user,
560 "db_pass=s" => \$cli_koha_db_pass,
561 "zebra_marc_format=s" => \$cli_zebra_marc_format,
562 "zebra_language=s" => \$cli_zebra_language,
563 "zebra_tokenizer=s" => \$cli_zebra_tokenizer,
564 "zebra_user=s" => \$cli_zebra_user,
565 "zebra_pass=s" => \$cli_zebra_pass,
566 "zebra_sru_host=s" => \$cli_zebra_sru_host,
567 "zebra_sru_biblios_port=s" => \$cli_zebra_sru_bib_port,
568 "zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
569 "auth_index_mode=s" => \$cli_koha_auth_index_mode,
570 "bib_index_mode=s" => \$cli_koha_bib_index_mode,
571 "koha_user=s" => \$cli_koha_user,
572 "koha_group=s" => \$cli_koha_group,
573 "install_sru=s" => \$cli_koha_install_sru,
574 "install_pazpar2=s" => \$cli_koha_install_pazpar2,
575 "use_memcached=s" => \$cli_koha_use_memcached,
576 "font_dir=s" => \$cli_koha_font_dir,
577 "run_database_tests=s" => \$cli_koha_run_database_tests,
578 "install_base=s" => \$cli_koha_install_base,
579 "template-cache-dir=s" => \$cli_koha_template_cache_dir,
580 "help" => sub { HelpMessage(0) },
583 my %install_log_values = ();
584 if ($koha_install_log ne "") {
585 get_install_log_values($koha_install_log, \%install_log_values);
587 # Try to set install_log_values for provided values;
588 get_cli_values(\%install_log_values);
591 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
592 my ($target_directories, $skip_directories) = get_target_directories(\%config);
593 display_configuration(\%config, $target_directories);
595 get_file_map($target_map, $dirtree, $file_map);
598 'rewrite-config.PL' => [
599 'blib/KOHA_CONF_DIR/koha-conf.xml',
600 'blib/KOHA_CONF_DIR/koha-httpd.conf',
601 'blib/KOHA_CONF_DIR/log4perl.conf',
602 'blib/ZEBRA_CONF_DIR/etc/default.idx',
603 'blib/MISC_DIR/koha-install-log'
605 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
610 push @{ $pl_files->{'rewrite-config.PL'} }, (
611 'blib/ZEBRA_CONF_DIR/etc/passwd',
612 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
613 'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
614 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
615 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
616 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
617 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
618 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
619 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
620 'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
621 'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
623 push @{ $pl_files->{'rewrite-config.PL'} }, (
624 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
625 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
626 'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
628 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
629 push @{ $pl_files->{'rewrite-config.PL'} }, (
630 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
631 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
634 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
635 ? 'zebra-authorities-dom.cfg'
636 : 'zebra-authorities.cfg';
637 $config{'ZEBRA_BIB_CFG'} = $config{'BIB_INDEX_MODE'} eq 'dom'
638 ? 'zebra-biblios-dom.cfg'
639 : 'zebra-biblios.cfg';
640 $config{'AUTH_RETRIEVAL_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom'
641 ? 'retrieval-info-auth-dom.xml'
642 : 'retrieval-info-auth-grs1.xml';
643 $config{'BIB_RETRIEVAL_CFG'} = $config{'BIB_INDEX_MODE'} eq 'dom'
644 ? 'retrieval-info-bib-dom.xml'
645 : 'retrieval-info-bib-grs1.xml';
648 if ($config{'INSTALL_MODE'} ne "dev") {
649 push @{ $pl_files->{'rewrite-config.PL'} }, (
650 'blib/PERL_MODULE_DIR/C4/Context.pm',
651 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
655 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
656 ? 'icuchain words-icu.xml'
657 : 'charmap word-phrase-utf.chr';
659 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
660 ? 'icuchain phrases-icu.xml'
661 : 'charmap word-phrase-utf.chr';
663 my %test_suite_override_dirs = (
664 KOHA_CONF_DIR => ['etc'],
665 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
666 LOG_DIR => ['var', 'log'],
667 BACKUP_DIR => ['var', 'spool'],
668 SCRIPT_DIR => ['bin'],
669 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
670 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
671 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
676 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
677 VERSION_FROM => 'kohaversion.pl',
678 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
679 AUTHOR => 'Koha Contributors <http://koha-community.org/>',
681 PREREQ_PM => $koha_pm->prereq_pm,
686 # Man pages generated from POD
687 # ExtUtils::MakeMaker already manage $(DESTDIR)
688 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
689 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
691 PL_FILES => $pl_files,
698 This function recurses through the directory structure and builds
699 a hash of hashes containing the structure with arrays holding filenames.
700 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
706 opendir my $dh, $dir or die $!;
707 my $tree = {}->{$dir} = {};
708 while( my $file = readdir($dh) ) {
709 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
710 my $path = $dir .'/' . $file;
711 $tree->{$file} = hashdir($path), next if -d $path;
712 push @{$tree->{'.'}}, $file;
719 This function combines the target_map and file hash to
720 map each source file to its destination relative to
721 the set of installation targets.
723 Output will be a hash mapping from each source file
724 to its destination value, like this:
726 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
731 my $target_map = shift;
733 my $file_map = shift;
734 my $curr_path = @_ ? shift : ['.'];
736 # Traverse the directory tree.
737 # For each file or directory, identify the
738 # most specific match in the target_map
739 foreach my $dir (sort keys %{ $dirtree }) {
741 # deal with files in directory
742 foreach my $file (sort @{ $dirtree->{$dir} }) {
743 my $targetdir = undef;
744 my $matchlevel = undef;
745 # first, see if there is a match on this specific
746 # file in the target map
747 my $filepath = join("/", @$curr_path, $file);
748 if (exists $target_map->{$filepath}) {
749 $targetdir = $target_map->{$filepath};
750 $matchlevel = scalar(@$curr_path) + 1;
752 # no match on the specific file; look for
754 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
755 my $dirpath = join("/", @$curr_path[0..$i]);
756 if (exists $target_map->{$dirpath}) {
757 $targetdir = $target_map->{$dirpath};
758 $matchlevel = $i + 1;
763 if (defined $targetdir) {
764 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
766 my $path = join("/", @$curr_path);
767 print "failed to map: $path/$file\n" if $DEBUG;
771 # dealing with subdirectory
772 push @$curr_path, $dir;
773 get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
779 sub _add_to_file_map {
780 my $file_map = shift;
781 my $targetdir = shift;
782 my $curr_path = shift;
784 my $matchlevel = shift;
785 my $dest_path = @_ ? shift : $curr_path;
787 # The target can be one of the following:
788 # 1. scalar representing target symbol
789 # 2. hash ref containing target and trimdir keys
791 # Consequently, this routine traverses this structure,
792 # calling itself recursively, until it deals with
793 # all of the scalar target symbols.
794 if (ref $targetdir eq 'HASH') {
795 my $subtarget = $targetdir->{target};
796 if (exists $targetdir->{trimdir}) {
797 # if we get here, we've specified that
798 # rather than installing the file to
799 # $(TARGET)/matching/dirs/subdirs/file,
800 # we want to install it to
801 # $(TARGET)/subdirs/file
803 # Note that this the only place where
804 # $matchlevel is used.
805 my @new_dest_path = @$dest_path;
806 if ($targetdir->{trimdir} == -1) {
807 splice @new_dest_path, 0, $matchlevel;
809 splice @new_dest_path, 0, $targetdir->{trimdir};
811 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
813 # actually getting here means that the
814 # target was unnecessarily listed
815 # as a hash, but we'll forgive that
816 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
818 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
819 my $source = File::Spec->catfile(@$curr_path, $file);
820 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
821 #print "$source => $destination\n"; # DEBUG
822 # quote spaces in file names
823 # FIXME: this is of questionable portability and
824 # probably depends on user's make recognizing this
825 # quoting syntax -- probably better to remove
826 # spaces and shell metacharacters from all file names
827 $source =~ s/ /\\ /g;
828 $destination =~ s/ /\\ /g;
830 $file_map->{$source} = $destination;
834 =head2 get_cli_values
836 Reads values provided on cli for configuration values
843 INSTALL_MODE => $cli_koha_install_mode,
844 DB_TYPE => $cli_koha_db_type,
845 DB_HOST => $cli_koha_db_host,
846 DB_PORT => $cli_koha_db_port,
847 DB_NAME => $cli_koha_db_name,
848 DB_USER => $cli_koha_db_user,
849 DB_PASS => $cli_koha_db_pass,
850 ZEBRA_MARC_FORMAT => $cli_zebra_marc_format,
851 ZEBRA_LANGUAGE => $cli_zebra_language,
852 ZEBRA_TOKENIZER => $cli_zebra_tokenizer,
853 ZEBRA_USER => $cli_zebra_user,
854 ZEBRA_PASS => $cli_zebra_pass,
855 ZEBRA_SRU_HOST => $cli_zebra_sru_host,
856 ZEBRA_SRU_BIBLIOS_PORT => $cli_zebra_sru_bib_port,
857 ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
858 AUTH_INDEX_MODE => $cli_koha_auth_index_mode,
859 BIB_INDEX_MODE => $cli_koha_bib_index_mode,
860 KOHA_USER => $cli_koha_user,
861 KOHA_GROUP => $cli_koha_group,
862 INSTALL_SRU => $cli_koha_install_sru,
863 INSTALL_PAZPAR2 => $cli_koha_install_pazpar2,
864 USE_MEMCACHED => $cli_koha_use_memcached,
865 FONT_DIR => $cli_koha_font_dir,
866 RUN_DATABASE_TESTS => $cli_koha_run_database_tests,
867 INSTALL_BASE => $cli_koha_install_base,
868 TEMPLATE_CACHE_DIR => $cli_koha_template_cache_dir
870 foreach my $key (keys %{$map}) {
871 $values->{$key} = $map->{$key} if ($map->{$key});
875 =head2 get_install_log_values
877 Reads value from the Koha install log specified by
882 sub get_install_log_values {
883 my $install_log = shift;
886 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
889 next if /^#/ or /^\s*$/;
893 my ($key, $value) = split /=/, $_, 2;
894 $values->{$key} = $value;
898 print <<_EXPLAIN_INSTALL_LOG_;
899 Reading values from install log $install_log. You
900 will be prompted only for settings that have been
901 added since the last time you installed Koha. To
902 be prompted for all settings, run 'perl Makefile.PL'
903 without the --prev-install-log option.
904 _EXPLAIN_INSTALL_LOG_
907 =head2 get_configuration
909 This prompts the user for various configuration options.
913 sub get_configuration {
914 my $defaults = shift;
915 my $valid_values = shift;
916 my $install_log_values = shift;
920 By default, Koha can be installed in one of three ways:
922 standard: Install files in conformance with the Filesystem
923 Hierarchy Standard (FHS). This is the default mode
924 and should be used when installing a production
925 Koha system. On Unix systems, root access is
926 needed to complete a standard installation.
928 single: Install files under a single directory. This option
929 is useful for installing Koha without root access, e.g.,
930 on a web host that allows CGI scripts and MySQL databases
931 but requires the user to keep all files under the user's
934 dev: Create a set of symbolic links and configuration files to
935 allow Koha to run directly from the source distribution.
936 This mode is useful for developers who want to run
937 Koha from a git clone.
940 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
941 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
943 # set message and default value for INSTALL_BASE
944 # depending on value of INSTALL_MODE
945 my $install_base_default = $defaults->{'INSTALL_BASE'};
946 if ($config{'INSTALL_MODE'} eq 'dev') {
948 Please specify the directory in which to install Koha's
949 active configuration files and (if applicable) the
950 Zebra database. Koha's CGI scripts and templates will
951 be run from the current directory.
953 Configuration directory:);
954 # FIXME - home directory portability consideration apply
955 $install_base_default =
957 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
959 } elsif ($config{'INSTALL_MODE'} eq 'single') {
960 $msg = "\nPlease specify the directory in which to install Koha";
961 # FIXME -- we're assuming under a 'single' mode install
962 # that user will likely want to install under the home
963 # directory. This is OK in and of itself, but we should
964 # use File::HomeDir to locate the home directory portably.
965 # This is deferred for now because File::HomeDir is not yet
967 # --we must also keep this portable to the major OS's -fbcit
968 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
972 Please specify the directory under which most Koha files
975 Note that if you are planning in installing more than
976 one instance of Koha, you may want to modify the last
977 component of the directory path, which will be used
978 as the package name in the FHS layout.
980 Base installation directory);
982 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
984 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
985 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
986 if ($config{'INSTALL_MODE'} eq "standard") {
988 Since you are using the 'standard' install
989 mode, you should run 'make install' as root.
990 However, it is recommended that a non-root
991 user (on Unix and Linux platforms) have
992 ownership of Koha's files, including the
993 Zebra indexes if applicable.
995 Please specify a user account. This
996 user account does not need to exist
997 right now, but it needs to exist
998 before you run 'make install'. Please
999 note that for security reasons, this
1000 user should not be the same as the user
1001 account Apache runs under.
1004 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
1007 Please specify the group that should own
1008 Koha's files. As above, this group need
1009 not exist right now, but should be created
1010 before you run 'make install'.
1013 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
1017 Please specify which database engine you will use
1018 to store data in Koha. The choices are MySQL and
1019 PostgreSQL; please note that at the moment
1020 PostgreSQL support is highly experimental.
1023 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
1024 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
1027 Please specify the name or address of your
1028 database server. Note that the database
1029 does not have to exist at this point, it
1030 can be created after running 'make install'
1031 and before you try using Koha for the first time.
1034 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
1037 Please specify the port used to connect to the
1039 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
1040 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
1043 Please specify the name of the database to be
1045 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
1046 if ($config{'DB_TYPE'} eq 'mysql'){
1048 Please specify whether the connection to MySQL will use TLS
1050 $config{'DB_USE_TLS'} = _get_value('DB_USE_TLS', $msg, $defaults->{'DB_USE_TLS'}, $valid_values, $install_log_values);
1052 if ($config{'DB_USE_TLS'} eq 'yes'){
1054 Please enter the path to the CA certificate for TLS
1056 $config{'DB_TLS_CA_CERTIFICATE'} = _get_value('DB_TLS_CA_CERTIFICATE', $msg, $defaults->{'DB_TLS_CA_CERTIFICATE'}, $valid_values, $install_log_values);
1059 Please enter the path to the client certificate for TLS
1061 $config{'DB_TLS_CLIENT_CERTIFICATE'} = _get_value('DB_TLS_CLIENT_CERTIFICATE', $msg, $defaults->{'DB_TLS_CLIENT_CERTIFICATE'}, $valid_values, $install_log_values);
1063 Please enter the path to the client key for TLS
1065 $config{'DB_TLS_CLIENT_KEY'} = _get_value('DB_TLS_CLIENT_KEY', $msg, $defaults->{'DB_TLS_CLIENT_KEY'}, $valid_values, $install_log_values);
1069 Please specify the user that owns the database to be
1071 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
1074 Please specify the password of the user that owns the
1075 database to be used by Koha);
1076 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
1079 Koha uses the Zebra search engine for high-performance
1080 searching of bibliographic and authority records. Checking
1081 to see if you have installed the Zebra software...
1084 if (defined(my $zebra_path = find_zebra())) {
1085 $config{'PATH_TO_ZEBRA'} = $zebra_path;
1087 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
1091 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
1092 in your PATH or in some of the usual places. If you haven't
1093 installed Zebra yet, please do so and run Makefile.PL again.
1099 You must specify the primary MARC format of the
1100 records to be indexed by Zebra.
1102 Koha provides Zebra configuration files for MARC21,
1103 NORMARC and UNIMARC.
1105 MARC format for Zebra indexing);
1106 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1107 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1109 Koha supplies Zebra configuration files tuned for
1110 searching either English (en) or French (fr) MARC
1113 Primary language for Zebra indexing);
1114 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1115 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1118 Koha can use one of two different indexing modes
1119 for the MARC bibliographic records:
1121 dom - uses the DOM XML filter; offers improved
1123 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
1124 available for legacy support
1126 Bibliographic indexing mode);
1127 $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
1128 $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
1132 Koha can use one of two different indexing modes
1133 for the MARC authorities records:
1135 dom - uses the DOM XML filter; offers improved
1137 grs1 - [DEPRECATED] uses the Zebra GRS-1 filter,
1138 available for legacy support
1140 Authorities indexing mode);
1141 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1142 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1145 Zebra has two methods to perform records tokenization
1146 and characters normalization: CHR and ICU. ICU is
1147 recommended for catalogs containing non-Latin
1150 $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
1151 $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
1154 Please specify Zebra database user);
1155 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1158 Please specify the Zebra database password);
1159 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1162 Since you've chosen to use Zebra, you can enable the SRU/
1163 Z39.50 Server if you so choose, but you must specify a
1164 few configuration options for it.
1166 Please note that if you choose *NOT* to configure SRU,
1167 koha-conf.xml will still contain some references to SRU
1168 settings. Those references will be ignored by Koha.
1170 Install the SRU configuration files?);
1171 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1172 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1174 if ($config{'INSTALL_SRU'} eq 'yes') {
1176 Since you've chosen to configure SRU, you must
1177 specify the host and port(s) that the SRU
1178 Servers (bibliographic and authority) should run on.
1181 SRU Database host?);
1182 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1185 SRU port for bibliographic data?);
1186 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1189 SRU port for authority data?);
1190 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1195 Along with Zebra, you can also choose to install PazPar2,
1196 which is a metasearch tool. With PazPar2,
1197 Koha can perform on-the-fly merging of bibliographic
1198 records during searching, allowing for FRBRization of
1201 Install the PazPar2 configuration files?);
1202 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1203 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1205 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1207 Since you've chosen to configure PazPar2, you must
1208 specify the host and port(s) that PazPar2
1212 Zebra bibliographic server host?);
1213 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1216 Zebra bibliographic port for PazPar2 to use?);
1217 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1221 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1225 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1230 Use memcached to cache the results of some function calls?
1231 This provides a significant performance improvement.
1232 You will need a Memcached server running.);
1233 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1234 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1235 if ($config{'USE_MEMCACHED'} eq 'yes'){
1237 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1240 Memcached server address?);
1241 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1244 Memcached namespace?);
1245 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1249 Template cache directory?);
1250 $config{'TEMPLATE_CACHE_DIR'} = _get_value('TEMPLATE_CACHE_DIR', $msg, $defaults->{'TEMPLATE_CACHE_DIR'}, $valid_values, $install_log_values);
1253 Path to DejaVu fonts?);
1254 $config{'FONT_DIR'} = _get_value('FONT_DIR', $msg, $defaults->{'FONT_DIR'}, $valid_values, $install_log_values);
1258 Would you like to run the database-dependent test suite?);
1259 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1260 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1262 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1263 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1264 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1265 $msg = q(TEST DATABASE
1267 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1268 testing. Please don't do this on your production database. It is not
1271 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1272 database. You are better off not running this optional test suite than
1273 doing it in a database that you don't want to lose.
1275 Please specify the name of the test database to be
1278 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1279 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1280 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1281 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1285 Please specify the user that owns the database to be
1287 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1290 Please specify the password of the user that owns the
1291 database to be used by Koha);
1292 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1297 # add version number
1298 my $version = "no_version_found";
1300 require 'kohaversion.pl';
1301 $version = kohaversion();
1303 $config{'KOHA_INSTALLED_VERSION'} = $version;
1308 sub _add_valid_values_disp {
1310 my $valid_values = shift;
1313 if (exists $valid_values->{$key}) {
1314 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1322 my $default = shift;
1323 my $valid_values = shift;
1324 my $install_log_values = shift;
1326 # take value from install log if present
1327 if (exists $install_log_values{$key}) {
1328 $install_log_values{$key} =~ s/\$/\$\$/g;
1329 return $install_log_values{$key};
1332 # override default value from environment
1333 if (exists $ENV{$key}) {
1334 $default = $ENV{$key};
1335 $msg .= " (default from environment)";
1338 my $val = prompt($msg, $default);
1340 while (exists $valid_values->{$key} and
1341 $val ne $default and
1342 not exists $valid_values->{$key}->{$val}) {
1343 my $retry_msg = "Value '$val' is not a valid option.\n";
1344 $retry_msg .= "Please enter a value";
1345 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1346 $val = prompt($retry_msg, $default);
1348 $val =~ s/\$/\$\$/g;
1352 =head2 get_target_directories
1354 Creates a hash mapping from symbols for installation target
1355 directories to actual directory paths.
1357 Also returns a hash indicating targets for which
1358 files need not be copied -- this is used for the 'dev'
1359 mode installation, where some files are installed in place.
1363 sub get_target_directories {
1366 my $base = $config->{'INSTALL_BASE'};
1367 my $mode = $config->{'INSTALL_MODE'};
1369 # get last component of install base directory
1370 # to treat as package name
1371 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1373 my @basedir = File::Spec->splitdir($directories);
1375 if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1377 my $package = pop @basedir;
1382 if ($mode eq 'single') {
1383 $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1384 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1385 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1386 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1387 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1388 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1389 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1390 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1391 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1392 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1393 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1394 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1395 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1396 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1397 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1398 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1399 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1400 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1401 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
1402 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1403 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1404 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1405 } elsif ($mode eq 'dev') {
1406 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1407 $dirmap{'API_CGI_DIR'} = File::Spec->catdir($curdir, 'api');
1408 $skipdirs{'API_CGI_DIR'} = 1;
1409 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1410 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1411 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1412 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1413 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1414 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1415 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1416 $skipdirs{'OPAC_CGI_DIR'} = 1;
1417 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1418 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1419 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1420 $skipdirs{'OPAC_WWW_DIR'} = 1;
1421 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1422 $skipdirs{'PERL_MODULE_DIR'} = 1;
1423 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1424 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1425 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1426 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1427 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1428 #For dev install, point NONDEV_DIR to misc in current dir (not base)
1429 #Used by supportdir in koha-conf.xml (BZ 12031)
1430 $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1431 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1432 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1433 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1434 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1435 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1436 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
1437 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1438 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1439 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1441 # mode is standard, i.e., 'fhs'
1442 $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1443 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1444 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1445 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1446 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1447 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1448 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1449 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1450 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1451 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1452 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1453 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1454 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1455 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1456 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1457 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1458 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1459 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1460 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1461 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1462 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1463 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1466 _get_env_overrides(\%dirmap);
1467 _get_argv_overrides(\%dirmap);
1468 _add_destdir(\%dirmap);
1470 return \%dirmap, \%skipdirs;
1475 Map a directory target to the corresponding path for
1483 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1484 if (exists $test_suite_override_dirs{$dirname}) {
1485 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1492 sub _get_env_overrides {
1495 foreach my $key (keys %$dirmap) {
1496 if (exists $ENV{$key}) {
1497 $dirmap->{$key} = $ENV{$key};
1498 print "Setting $key from environment\n";
1503 sub _get_argv_overrides {
1507 for (my $i = 0; $i <= $#ARGV; $i++) {
1508 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1511 push @new_argv, $ARGV[$i];
1517 sub _strip_destdir {
1519 $dir =~ s/^\$\(DESTDIR\)//;
1526 foreach my $key (keys %$dirmap) {
1527 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1531 sub display_configuration {
1534 my @version = grep /\/usr\/share\/perl\//, @INC;
1535 push @version, ('/usr/share/perl/5.10') if !$version[0];
1536 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1537 foreach my $key (sort keys %$config) {
1538 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1541 print "\nand in the following directories:\n\n";
1542 foreach my $key (sort keys %$dirmap) {
1543 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1545 print "\n\nTo change any configuration setting, please run\n";
1546 print "perl Makefile.PL again. To override one of the target\n";
1547 print "directories, you can do so on the command line like this:\n";
1548 print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1549 print "You can also set different default values for parameters\n";
1550 print "or override directory locations by using environment variables.\n";
1551 print "\nFor example:\n\n";
1552 print "export DB_USER=my_koha\n";
1553 print "perl Makefile.PL\n";
1555 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1560 Attempt to find Zebra - check user's PATH and
1561 a few other directories for zebrasrv and zebraidx.
1566 my @search_dirs = map {
1567 my $abs = File::Spec->rel2abs($_);
1568 my ($toss, $directories);
1569 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1571 } split /:/, $ENV{PATH};
1572 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1573 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1574 return unless @zebrasrv_dirs;
1575 # verify that directory that contains zebrasrv also contains zebraidx
1576 foreach my $dir (@zebrasrv_dirs) {
1577 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1586 my $test = $self->SUPER::test(@_);
1587 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1590 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1597 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1598 # This means that we're completely overriding EU::MM's default
1599 # installation and uninstallation targets.
1601 # If installation is on Win32, we need to do permissions different from *nix
1602 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1603 foreach my $key (sort keys %$target_directories) {
1605 KOHA_INST_$key = blib/$key
1606 KOHA_DEST_$key = $target_directories->{$key}
1607 ) unless exists $skip_directories->{$key};
1610 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1611 \t\$(NOECHO) \$(NOOP)
1613 $install .= "install_koha ::\n";
1614 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1615 foreach my $key (sort keys %$target_directories) {
1616 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1617 unless exists $skip_directories->{$key};
1619 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1620 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1623 $install .= "set_koha_ownership ::\n";
1624 # Do not try to change ownership if DESTDIR is set
1625 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1626 foreach my $key (sort keys %$target_directories) {
1627 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1628 unless exists $skip_directories->{$key};
1631 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1635 $install .= "set_koha_permissions ::\n";
1636 # This is necessary because EU::MM installs files
1637 # as either 0444 or 0555, and we want the owner
1638 # of Koha's files to have write permission by default.
1639 foreach my $key (sort keys %$target_directories) {
1640 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1641 unless exists $skip_directories->{$key};
1647 $install .= "warn_koha_env_vars ::\n";
1648 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1649 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1650 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1651 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1652 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1653 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1654 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1655 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1656 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1657 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1658 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1660 $install .= _update_zebra_conf_target();
1662 $install .= upgrade();
1667 =head2 _update_zebra_conf_target
1669 Add an installation target for updating
1670 Zebra's configuration files.
1674 sub _update_zebra_conf_target {
1676 my $target = "\nupdate_zebra_conf ::\n";
1677 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1678 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1679 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1680 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1681 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1682 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1691 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1692 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1693 $version =~ s/\./_/g;
1694 $backup_suffix = "_koha_$version";
1696 $backup_suffix = "_upgrade_backup";
1700 MOD_BACKUP = \$(ABSPERLRUN) -MC4::Installer::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1702 upgrade :: make_upgrade_backup install
1703 \t\$(NOECHO) \$(NOOP)
1704 make_upgrade_backup ::
1705 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1707 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1708 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1709 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1710 unless exists $skip_directories->{$key} or
1711 not exists $target_directories->{$key};
1713 $upgrade =~ s/\\\n$/\n/;
1718 # put directory mappings into Makefile
1719 # so that Make will export as environment
1720 # variables -- this is for the use of
1724 # Hereagain, we must alter syntax per platform...
1726 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1728 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1740 ExtUtils::MakeMaker(3)
1744 MJ Ray mjr at phonecoop.coop
1745 Galen Charlton galen.charlton at liblime.com
1749 FIXME: deal with .htaccess