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;
32 use C4::Installer::PerlModules;
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 --koha_user Koha Unix user (e.g. koha)
95 --koha_group Koha Unix group (e.g. koha)
96 --install_sru Install the SRU server (yes, no)
97 --install_pazpar2 Install PazPar2 (yes, no)
98 --use_memcached Use Memcached (yes, no)
99 --font_dir Location of fonts (e.g. /usr/share/fonts/truetype/dejavu)
100 --run_database_tests Run database dependent tests (yes, no)
101 --install_base Base directory of installation (e.g. /usr/share/koha)
102 --template-cache-dir Specify a template cache directory (e.g. /var/cache/koha)
103 --help Display this help message
107 This is a packager and installer that uses
108 ExtUtils::MakeMaker, which is fairly common
110 As well as building tar or zip files
111 and installing with the above commands,
112 it allows us to check pre-requisites
113 and generate configuration files.
117 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
119 Basic metadata about this software.
123 Suppress generation of META.yml file.
127 Hash of perl modules and versions required.
131 Hash of file mappings
135 This is a hash of PL scripts to run after installation and
136 the files to ask them to generate.
137 Maybe use the values from CONFIGURE
138 to generate initial configuration files in future.
144 This is a hash mapping directories and files in the
145 source tree to installation target directories. The rules
146 for this mapping are:
150 =item If a directory or file is specified, it and its
151 contents will be copied to the installation target directory.
153 =item If a subdirectory of a mapped directory is specified,
154 its target overrides the parent's target for that subdirectory.
156 =item The value of each map entry may either be a scalar containing
157 one target or a reference to a hash containing 'target' and 'trimdir'
160 =item Any files at the top level of the source tree that are
161 not included in the map will not be installed.
163 =item Any directories at the top level of the source tree
164 that are not included in the map will be installed in
165 INTRANET_CGI_DIR. This is a sensible default given the
166 current organization of the source tree, but (FIXME) it
167 would be better to reorganize the source tree to better
168 match the installation system, to allow adding new directories
169 without having to adjust Makefile.PL each time. The idea
170 is to make the C<$target_map> hash as minimal as possible.
174 The permitted installation targets are:
178 =item INTRANET_CGI_DIR
180 CGI scripts for intranet (staff) interface.
182 =item INTRANET_TMPL_DIR
184 HTML templates for the intranet interface.
186 =item INTRANET_WWW_DIR
188 HTML files, images, etc. for DocumentRoot for the intranet interface.
192 CGI scripts for OPAC (public) interface.
196 HTML templates for the OPAC interface.
200 HTML files, images, etc. for DocumentRoot for the OPAC interface.
202 =item PERL_MODULE_DIR
204 Perl modules (at present just the C4 modules) that are intimately
205 tied to Koha. Depending on the installation options, these
206 may or may not be installed one of the standard directories
207 in Perl's default @LIB.
211 Directory for Koha configuration files.
215 Directory for Zebra configuration files.
219 Directory for Zebra's lock files. This includes subdirs for authorities,
220 biblios, and the zebra rebuild function. Any activity to reindex
221 zebra from koha should interlock here with rebuild_zebra.pl.
225 Directory for Zebra's data files.
229 Directory for Zebra's UNIX-domain sockets.
231 =item ELASTICSEARCH_SERVERS
233 Server:port of the Elasticsearch server to use, as a comma separated list:
234 eg. 192.168.0.100:9200, localhost:9200
236 =item ELASTICSEARCH_INDEX
238 Unique index in Elasticsearch, for this Koha-instance
239 eg. koha-mykoha or just koha
243 Directory for for miscellaenous scripts, among other
244 things the translation toolkit and RSS feed tools.
248 Directory for command-line scripts and daemons to
249 be set up all for installation modes.
251 =item SCRIPT_NONDEV_DIR
253 Directory for command-line scripts that should
254 be installed in the same directory as the
255 SCRIPT_DIR target except 'dev' installs.
259 Directory for man pages created from POD -- will mostly
260 contain information of interest to Koha developers.
264 Directory for Koha documentation accessed from the
265 command-line, e.g., READMEs.
269 Directory for Koha scripts to put their locks.
273 Directory for Apache and Zebra logs produced by Koha.
277 Directory for backup files produced by Koha.
281 Directory for external Koha plugins.
283 =item PAZPAR2_CONF_DIR
285 Directory for PazPar2 configuration files.
289 Directory where DejaVu fonts are installed.
293 This is a dummy target used to explicitly state
294 that a given file or directory is not to be installed.
295 This is used either for parts of the installer itself
296 or for development tools that are not applicable to a
297 production installation.
304 './about.pl' => 'INTRANET_CGI_DIR',
305 './acqui' => 'INTRANET_CGI_DIR',
306 './admin' => 'INTRANET_CGI_DIR',
307 './api' => { target => 'API_CGI_DIR', trimdir => -1 },
308 './authorities' => 'INTRANET_CGI_DIR',
309 './basket' => 'INTRANET_CGI_DIR',
310 './C4' => 'PERL_MODULE_DIR',
311 './C4/SIP/t' => 'NONE',
312 './C4/SIP/koha_test' => 'NONE',
313 './C4/tests' => 'NONE',
314 './catalogue' => 'INTRANET_CGI_DIR',
315 './cataloguing' => 'INTRANET_CGI_DIR',
316 './changelanguage.pl' => 'INTRANET_CGI_DIR',
317 './check_sysprefs.pl' => 'NONE',
318 './circ' => 'INTRANET_CGI_DIR',
319 './clubs' => 'INTRANET_CGI_DIR',
320 './course_reserves' => 'INTRANET_CGI_DIR',
321 './cpanfile' => 'PERL_MODULE_DIR',
322 './docs/history.txt' => { target => 'DOC_DIR', trimdir => -1 },
323 './docs/contributors.yaml' => { target => 'DOC_DIR', trimdir => -1 },
324 './docs/teams.yaml' => { target => 'DOC_DIR', trimdir => -1 },
325 './offline_circ' => 'INTRANET_CGI_DIR',
326 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
327 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
328 './etc/z3950' => { target => 'Z3950_CONF_DIR', trimdir => -1 },
329 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
330 './help.pl' => 'INTRANET_CGI_DIR',
331 './ill' => 'INTRANET_CGI_DIR',
332 './installer-CPAN.pl' => 'NONE',
333 './installer' => 'INTRANET_CGI_DIR',
334 './errors' => {target => 'INTRANET_CGI_DIR'},
335 './Koha' => 'PERL_MODULE_DIR',
336 './Koha.pm' => 'PERL_MODULE_DIR',
337 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
338 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
339 './kohaversion.pl' => 'INTRANET_CGI_DIR',
340 './labels' => 'INTRANET_CGI_DIR',
341 './mainpage.pl' => 'INTRANET_CGI_DIR',
342 './Makefile.PL' => 'NONE',
343 './MANIFEST.SKIP' => 'NONE',
344 './members' => 'INTRANET_CGI_DIR',
345 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
346 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
347 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
348 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
349 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
350 './misc/installer_devel_notes' => 'NONE',
351 './opac' => 'OPAC_CGI_DIR',
352 './OpenILS' => 'PERL_MODULE_DIR',
353 './README.txt' => 'NONE',
354 './patroncards' => 'INTRANET_CGI_DIR',
355 './patron_lists' => 'INTRANET_CGI_DIR',
356 './plugins' => 'INTRANET_CGI_DIR',
357 './pos' => 'INTRANET_CGI_DIR',
358 './reports' => 'INTRANET_CGI_DIR',
359 './reserve' => 'INTRANET_CGI_DIR',
360 './reviews' => 'INTRANET_CGI_DIR',
361 './rewrite-config.PL' => 'NONE',
362 './reviews' => 'INTRANET_CGI_DIR',
363 './rotating_collections' => 'INTRANET_CGI_DIR',
364 './serials' => 'INTRANET_CGI_DIR',
365 './services' => 'INTRANET_CGI_DIR',
367 './skel/var/lock/koha' => { target => 'LOCK_DIR', trimdir => -1 },
368 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
369 './skel/var/spool/koha' => { target => 'BACKUP_DIR', trimdir => -1 },
370 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
371 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
372 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
373 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
374 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
375 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
376 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
377 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
378 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
379 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
380 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
381 './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
382 './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
383 './sms' => 'INTRANET_CGI_DIR',
384 './suggestion' => 'INTRANET_CGI_DIR',
385 './svc' => 'INTRANET_CGI_DIR',
387 './tags' => 'INTRANET_CGI_DIR',
388 './tmp' => 'NONE', # FIXME need to determine whether
389 # Koha generates any persistent temp files
390 # that should go in /var/tmp/koha
391 './tools' => 'INTRANET_CGI_DIR',
392 './virtualshelves' => 'INTRANET_CGI_DIR',
393 # ignore files and directories created by the install itself
394 './pm_to_blib' => 'NONE',
396 '.sass-lint.yml' => 'NONE',
397 '.scss-lint.yml' => 'NONE',
398 '.eslintrc.json' => 'NONE',
399 'gulpfile.js' => 'NONE',
400 'package.json' => 'NONE',
401 'yarn.lock' => 'NONE',
404 =head1 CONFIGURATION OPTIONS
406 The following configuration options are used by the installer.
412 Specifies whether installation will be FHS-compliant (default,
413 assumes user has root), put everything under
414 a single directory (for users installing on a web host
415 that allows CGI scripts and a MySQL database but not root
416 access), or development (for a developer who wants to run
417 Koha from a git clone with no fuss).
421 Directory under which most components will go. Default
422 value will vary depending on INSTALL_MODE.
426 Type of DBMS (e.g., mysql or Pg).
434 Port that DBMS server is listening on.
438 Name of the DBMS database for Koha.
442 Name of DBMS user account for Koha's database.
446 Pasword of DMBS user account for Koha's database.
448 =item ZEBRA_MARC_FORMAT
450 Specifies format of MARC records to be indexed by Zebra.
454 Specifies primary language of records that will be
459 Internal Zebra user account for the index.
463 Internal Zebra user account's password.
467 System user account that will own Koha's files.
471 System group that will own Koha's files.
477 # default configuration options
478 my %config_defaults = (
479 'DB_TYPE' => 'mysql',
480 'DB_HOST' => 'localhost',
482 'DB_USER' => 'kohaadmin',
483 'DB_PASS' => 'katikoan',
484 'DB_USE_TLS' => 'no',
485 'DB_TLS_CA_CERTIFICATE' => '/etc/mysql-ssl/server-ca.pem',
486 'DB_TLS_CLIENT_CERTIFICATE' => '/etc/mysql-ssl/client-cert.pem',
487 'DB_TLS_CLIENT_KEY' => '/etc/mysql-ssl/client-key.pem',
488 'INSTALL_SRU' => 'yes',
489 'INSTALL_PAZPAR2' => 'no',
490 'ZEBRA_MARC_FORMAT' => 'marc21',
491 'ZEBRA_LANGUAGE' => 'en',
492 'ZEBRA_TOKENIZER' => 'chr',
493 'ZEBRA_USER' => 'kohauser',
494 'ZEBRA_PASS' => 'zebrastripes',
495 'ZEBRA_SRU_HOST' => 'localhost',
496 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
497 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
498 'KOHA_USER' => 'koha',
499 'KOHA_GROUP' => 'koha',
500 'MERGE_SERVER_HOST' => 'localhost',
501 'MERGE_SERVER_PORT' => '11001',
502 'PAZPAR2_HOST' => 'localhost',
503 'PAZPAR2_PORT' => '11002',
504 'RUN_DATABASE_TESTS' => 'no',
505 'PATH_TO_ZEBRA' => '',
506 'USE_MEMCACHED' => 'yes',
507 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
508 'MEMCACHED_NAMESPACE' => 'KOHA',
509 'TEMPLATE_CACHE_DIR' => '/tmp/koha',
510 'USE_ELASTICSEARCH' => 'no',
511 'ELASTICSEARCH_SERVERS' => 'localhost:9200',
512 'ELASTICSEARCH_INDEX' => 'koha',
513 'FONT_DIR' => '/usr/share/fonts/truetype/dejavu'
516 # set some default configuration options based on OS
517 # more conditions need to be added for other OS's
519 warn "Your platform appears to be $^O.\n" if $DEBUG;
521 if ( $^O eq 'cygwin' ) {
522 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
523 # this could be changed to put some files (ie. libraries) into system32, etc.
524 $config_defaults{'INSTALL_MODE'} = 'single';
525 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
528 $config_defaults{'INSTALL_MODE'} = 'standard';
529 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
532 # valid values for certain configuration options
533 my %valid_config_values = (
534 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
535 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
536 'DB_USE_TLS' => {'yes', 'no'},
537 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
538 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
539 'ZEBRA_LANGUAGE' => { 'cs' => 1, 'el' => 1, 'en' => 1, 'es' => 1, 'fr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
540 'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
541 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
542 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
543 'USE_ELASTICSEARCH' => { 'yes' => 1, 'no' => 1 },
546 # get settings from command-line
547 my $koha_install_log = "";
548 my $cli_koha_install_mode = "";
549 my $cli_koha_db_type = "";
550 my $cli_koha_db_host = "";
551 my $cli_koha_db_port = "";
552 my $cli_koha_db_name = "";
553 my $cli_koha_db_user = "";
554 my $cli_koha_db_pass = "";
555 my $cli_zebra_marc_format = "";
556 my $cli_zebra_language = "",
557 my $cli_zebra_tokenizer = "";
558 my $cli_zebra_user = "";
559 my $cli_zebra_pass = "";
560 my $cli_zebra_sru_host = "";
561 my $cli_zebra_sru_bib_port = "";
562 my $cli_zebra_sru_auth_port = "";
563 my $cli_koha_user = "";
564 my $cli_koha_group = "";
565 my $cli_koha_install_sru = "";
566 my $cli_koha_install_pazpar2 = "";
567 my $cli_koha_use_memcached = "";
568 my $cli_koha_font_dir = "";
569 my $cli_koha_run_database_tests = "";
570 my $cli_koha_install_base = "";
571 my $cli_koha_template_cache_dir = "";
572 Getopt::Long::Configure('pass_through');
573 my $results = GetOptions(
574 "prev-install-log=s" => \$koha_install_log,
575 "install_mode=s" => \$cli_koha_install_mode,
576 "db_type=s" => \$cli_koha_db_type,
577 "db_host=s" => \$cli_koha_db_host,
578 "db_port=s" => \$cli_koha_db_port,
579 "db_name=s" => \$cli_koha_db_name,
580 "db_user=s" => \$cli_koha_db_user,
581 "db_pass=s" => \$cli_koha_db_pass,
582 "zebra_marc_format=s" => \$cli_zebra_marc_format,
583 "zebra_language=s" => \$cli_zebra_language,
584 "zebra_tokenizer=s" => \$cli_zebra_tokenizer,
585 "zebra_user=s" => \$cli_zebra_user,
586 "zebra_pass=s" => \$cli_zebra_pass,
587 "zebra_sru_host=s" => \$cli_zebra_sru_host,
588 "zebra_sru_biblios_port=s" => \$cli_zebra_sru_bib_port,
589 "zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
590 "koha_user=s" => \$cli_koha_user,
591 "koha_group=s" => \$cli_koha_group,
592 "install_sru=s" => \$cli_koha_install_sru,
593 "install_pazpar2=s" => \$cli_koha_install_pazpar2,
594 "use_memcached=s" => \$cli_koha_use_memcached,
595 "font_dir=s" => \$cli_koha_font_dir,
596 "run_database_tests=s" => \$cli_koha_run_database_tests,
597 "install_base=s" => \$cli_koha_install_base,
598 "template-cache-dir=s" => \$cli_koha_template_cache_dir,
599 "help" => sub { HelpMessage(0) },
602 my %install_log_values = ();
603 if ($koha_install_log ne "") {
604 get_install_log_values($koha_install_log, \%install_log_values);
606 # Try to set install_log_values for provided values;
607 get_cli_values(\%install_log_values);
610 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
611 my ($target_directories, $skip_directories) = get_target_directories(\%config);
612 display_configuration(\%config, $target_directories);
614 get_file_map($target_map, $dirtree, $file_map);
617 'rewrite-config.PL' => [
618 'blib/KOHA_CONF_DIR/koha-conf.xml',
619 'blib/KOHA_CONF_DIR/koha-httpd.conf',
620 'blib/KOHA_CONF_DIR/log4perl.conf',
621 'blib/ZEBRA_CONF_DIR/etc/default.idx',
622 'blib/MISC_DIR/koha-install-log'
624 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
629 push @{ $pl_files->{'rewrite-config.PL'} }, (
630 'blib/ZEBRA_CONF_DIR/etc/passwd',
631 'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
632 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
633 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
634 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
635 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
636 'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
638 push @{ $pl_files->{'rewrite-config.PL'} }, (
639 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
640 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
641 'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
643 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
644 push @{ $pl_files->{'rewrite-config.PL'} }, (
645 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
646 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
649 $config{'ZEBRA_AUTH_CFG'} = 'zebra-authorities-dom.cfg';
650 $config{'ZEBRA_BIB_CFG'} = 'zebra-biblios-dom.cfg';
651 $config{'AUTH_RETRIEVAL_CFG'} = 'retrieval-info-auth-dom.xml';
652 $config{'BIB_RETRIEVAL_CFG'} = 'retrieval-info-bib-dom.xml';
654 if ($config{'INSTALL_MODE'} ne "dev") {
655 push @{ $pl_files->{'rewrite-config.PL'} }, (
656 'blib/PERL_MODULE_DIR/C4/Context.pm',
657 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
661 $config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
662 ? 'icuchain words-icu.xml'
663 : 'charmap word-phrase-utf.chr';
665 $config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
666 ? 'icuchain phrases-icu.xml'
667 : 'charmap word-phrase-utf.chr';
669 my %test_suite_override_dirs = (
670 KOHA_CONF_DIR => ['etc'],
671 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
672 Z3950_CONF_DIR => ['etc', 'z3950'],
673 LOCK_DIR => ['var', 'lock'],
674 LOG_DIR => ['var', 'log'],
675 BACKUP_DIR => ['var', 'spool'],
676 SCRIPT_DIR => ['bin'],
677 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
678 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
679 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
684 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
685 VERSION_FROM => 'kohaversion.pl',
686 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
687 AUTHOR => 'Koha Contributors <http://koha-community.org/>',
689 PREREQ_PM => $koha_pm->prereq_pm,
694 # Man pages generated from POD
695 # ExtUtils::MakeMaker already manage $(DESTDIR)
696 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
697 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
699 PL_FILES => $pl_files,
706 This function recurses through the directory structure and builds
707 a hash of hashes containing the structure with arrays holding filenames.
708 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
714 opendir my $dh, $dir or die $!;
715 my $tree = {}->{$dir} = {};
716 while( my $file = readdir($dh) ) {
717 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
718 my $path = $dir .'/' . $file;
719 $tree->{$file} = hashdir($path), next if -d $path;
720 push @{$tree->{'.'}}, $file;
727 This function combines the target_map and file hash to
728 map each source file to its destination relative to
729 the set of installation targets.
731 Output will be a hash mapping from each source file
732 to its destination value, like this:
734 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
739 my $target_map = shift;
741 my $file_map = shift;
742 my $curr_path = @_ ? shift : ['.'];
744 # Traverse the directory tree.
745 # For each file or directory, identify the
746 # most specific match in the target_map
747 foreach my $dir (sort keys %{ $dirtree }) {
749 # deal with files in directory
750 foreach my $file (sort @{ $dirtree->{$dir} }) {
751 my $targetdir = undef;
752 my $matchlevel = undef;
753 # first, see if there is a match on this specific
754 # file in the target map
755 my $filepath = join("/", @$curr_path, $file);
756 if (exists $target_map->{$filepath}) {
757 $targetdir = $target_map->{$filepath};
758 $matchlevel = scalar(@$curr_path) + 1;
760 # no match on the specific file; look for
762 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
763 my $dirpath = join("/", @$curr_path[0..$i]);
764 if (exists $target_map->{$dirpath}) {
765 $targetdir = $target_map->{$dirpath};
766 $matchlevel = $i + 1;
771 if (defined $targetdir) {
772 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
774 my $path = join("/", @$curr_path);
775 print "failed to map: $path/$file\n" if $DEBUG;
779 # dealing with subdirectory
780 push @$curr_path, $dir;
781 get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
787 sub _add_to_file_map {
788 my $file_map = shift;
789 my $targetdir = shift;
790 my $curr_path = shift;
792 my $matchlevel = shift;
793 my $dest_path = @_ ? shift : $curr_path;
795 # The target can be one of the following:
796 # 1. scalar representing target symbol
797 # 2. hash ref containing target and trimdir keys
799 # Consequently, this routine traverses this structure,
800 # calling itself recursively, until it deals with
801 # all of the scalar target symbols.
802 if (ref $targetdir eq 'HASH') {
803 my $subtarget = $targetdir->{target};
804 if (exists $targetdir->{trimdir}) {
805 # if we get here, we've specified that
806 # rather than installing the file to
807 # $(TARGET)/matching/dirs/subdirs/file,
808 # we want to install it to
809 # $(TARGET)/subdirs/file
811 # Note that this the only place where
812 # $matchlevel is used.
813 my @new_dest_path = @$dest_path;
814 if ($targetdir->{trimdir} == -1) {
815 splice @new_dest_path, 0, $matchlevel;
817 splice @new_dest_path, 0, $targetdir->{trimdir};
819 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
821 # actually getting here means that the
822 # target was unnecessarily listed
823 # as a hash, but we'll forgive that
824 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
826 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
827 my $source = File::Spec->catfile(@$curr_path, $file);
828 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
829 #print "$source => $destination\n"; # DEBUG
830 # quote spaces in file names
831 # FIXME: this is of questionable portability and
832 # probably depends on user's make recognizing this
833 # quoting syntax -- probably better to remove
834 # spaces and shell metacharacters from all file names
835 $source =~ s/ /\\ /g;
836 $destination =~ s/ /\\ /g;
838 $file_map->{$source} = $destination;
842 =head2 get_cli_values
844 Reads values provided on cli for configuration values
851 INSTALL_MODE => $cli_koha_install_mode,
852 DB_TYPE => $cli_koha_db_type,
853 DB_HOST => $cli_koha_db_host,
854 DB_PORT => $cli_koha_db_port,
855 DB_NAME => $cli_koha_db_name,
856 DB_USER => $cli_koha_db_user,
857 DB_PASS => $cli_koha_db_pass,
858 ZEBRA_MARC_FORMAT => $cli_zebra_marc_format,
859 ZEBRA_LANGUAGE => $cli_zebra_language,
860 ZEBRA_TOKENIZER => $cli_zebra_tokenizer,
861 ZEBRA_USER => $cli_zebra_user,
862 ZEBRA_PASS => $cli_zebra_pass,
863 ZEBRA_SRU_HOST => $cli_zebra_sru_host,
864 ZEBRA_SRU_BIBLIOS_PORT => $cli_zebra_sru_bib_port,
865 ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
866 KOHA_USER => $cli_koha_user,
867 KOHA_GROUP => $cli_koha_group,
868 INSTALL_SRU => $cli_koha_install_sru,
869 INSTALL_PAZPAR2 => $cli_koha_install_pazpar2,
870 USE_MEMCACHED => $cli_koha_use_memcached,
871 FONT_DIR => $cli_koha_font_dir,
872 RUN_DATABASE_TESTS => $cli_koha_run_database_tests,
873 INSTALL_BASE => $cli_koha_install_base,
874 TEMPLATE_CACHE_DIR => $cli_koha_template_cache_dir
876 foreach my $key (keys %{$map}) {
877 $values->{$key} = $map->{$key} if ($map->{$key});
881 =head2 get_install_log_values
883 Reads value from the Koha install log specified by
888 sub get_install_log_values {
889 my $install_log = shift;
892 open my $log, '<', $install_log or die "Cannot open install log $install_log: $!\n";
895 next if /^#/ or /^\s*$/;
899 my ($key, $value) = split /=/, $_, 2;
900 $values->{$key} = $value;
904 print <<_EXPLAIN_INSTALL_LOG_;
905 Reading values from install log $install_log. You
906 will be prompted only for settings that have been
907 added since the last time you installed Koha. To
908 be prompted for all settings, run 'perl Makefile.PL'
909 without the --prev-install-log option.
910 _EXPLAIN_INSTALL_LOG_
913 =head2 get_configuration
915 This prompts the user for various configuration options.
919 sub get_configuration {
920 my $defaults = shift;
921 my $valid_values = shift;
922 my $install_log_values = shift;
926 By default, Koha can be installed in one of three ways:
928 standard: Install files in conformance with the Filesystem
929 Hierarchy Standard (FHS). This is the default mode
930 and should be used when installing a production
931 Koha system. On Unix systems, root access is
932 needed to complete a standard installation.
934 single: Install files under a single directory. This option
935 is useful for installing Koha without root access, e.g.,
936 on a web host that allows CGI scripts and MySQL databases
937 but requires the user to keep all files under the user's
940 dev: Create a set of symbolic links and configuration files to
941 allow Koha to run directly from the source distribution.
942 This mode is useful for developers who want to run
943 Koha from a git clone.
946 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
947 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
949 # set message and default value for INSTALL_BASE
950 # depending on value of INSTALL_MODE
951 my $install_base_default = $defaults->{'INSTALL_BASE'};
952 if ($config{'INSTALL_MODE'} eq 'dev') {
954 Please specify the directory in which to install Koha's
955 active configuration files and (if applicable) the
956 Zebra database. Koha's CGI scripts and templates will
957 be run from the current directory.
959 Configuration directory:);
960 # FIXME - home directory portability consideration apply
961 $install_base_default =
963 || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
965 } elsif ($config{'INSTALL_MODE'} eq 'single') {
966 $msg = "\nPlease specify the directory in which to install Koha";
967 # FIXME -- we're assuming under a 'single' mode install
968 # that user will likely want to install under the home
969 # directory. This is OK in and of itself, but we should
970 # use File::HomeDir to locate the home directory portably.
971 # This is deferred for now because File::HomeDir is not yet
973 # --we must also keep this portable to the major OS's -fbcit
974 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
978 Please specify the directory under which most Koha files
981 Note that if you are planning in installing more than
982 one instance of Koha, you may want to modify the last
983 component of the directory path, which will be used
984 as the package name in the FHS layout.
986 Base installation directory);
988 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
990 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
991 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
992 if ($config{'INSTALL_MODE'} eq "standard") {
994 Since you are using the 'standard' install
995 mode, you should run 'make install' as root.
996 However, it is recommended that a non-root
997 user (on Unix and Linux platforms) have
998 ownership of Koha's files, including the
999 Zebra indexes if applicable.
1001 Please specify a user account. This
1002 user account does not need to exist
1003 right now, but it needs to exist
1004 before you run 'make install'. Please
1005 note that for security reasons, this
1006 user should not be the same as the user
1007 account Apache runs under.
1010 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
1013 Please specify the group that should own
1014 Koha's files. As above, this group need
1015 not exist right now, but should be created
1016 before you run 'make install'.
1019 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
1023 Please specify which database engine you will use
1024 to store data in Koha. The choices are MySQL and
1025 PostgreSQL; please note that at the moment
1026 PostgreSQL support is highly experimental.
1029 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
1030 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
1033 Please specify the name or address of your
1034 database server. Note that the database
1035 does not have to exist at this point, it
1036 can be created after running 'make install'
1037 and before you try using Koha for the first time.
1040 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
1043 Please specify the port used to connect to the
1045 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
1046 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
1049 Please specify the name of the database to be
1051 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
1052 if ($config{'DB_TYPE'} eq 'mysql'){
1054 Please specify whether the connection to MySQL will use TLS
1056 $config{'DB_USE_TLS'} = _get_value('DB_USE_TLS', $msg, $defaults->{'DB_USE_TLS'}, $valid_values, $install_log_values);
1058 if ($config{'DB_USE_TLS'} eq 'yes'){
1060 Please enter the path to the CA certificate for TLS
1062 $config{'DB_TLS_CA_CERTIFICATE'} = _get_value('DB_TLS_CA_CERTIFICATE', $msg, $defaults->{'DB_TLS_CA_CERTIFICATE'}, $valid_values, $install_log_values);
1065 Please enter the path to the client certificate for TLS
1067 $config{'DB_TLS_CLIENT_CERTIFICATE'} = _get_value('DB_TLS_CLIENT_CERTIFICATE', $msg, $defaults->{'DB_TLS_CLIENT_CERTIFICATE'}, $valid_values, $install_log_values);
1069 Please enter the path to the client key for TLS
1071 $config{'DB_TLS_CLIENT_KEY'} = _get_value('DB_TLS_CLIENT_KEY', $msg, $defaults->{'DB_TLS_CLIENT_KEY'}, $valid_values, $install_log_values);
1075 Please specify the user that owns the database to be
1077 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
1080 Please specify the password of the user that owns the
1081 database to be used by Koha);
1082 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
1085 Koha uses the Zebra search engine for high-performance
1086 searching of bibliographic and authority records. Checking
1087 to see if you have installed the Zebra software...
1090 if (defined(my $zebra_path = find_zebra())) {
1091 $config{'PATH_TO_ZEBRA'} = $zebra_path;
1093 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
1097 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
1098 in your PATH or in some of the usual places. If you haven't
1099 installed Zebra yet, please do so and run Makefile.PL again.
1105 You must specify the primary MARC format of the
1106 records to be indexed by Zebra.
1108 Koha provides Zebra configuration files for MARC21,
1109 NORMARC and UNIMARC.
1111 MARC format for Zebra indexing);
1112 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1113 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1115 Koha supplies Zebra configuration files tuned for
1116 searching either English (en) or French (fr) MARC
1119 Primary language for Zebra indexing);
1120 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1121 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1124 Zebra has two methods to perform records tokenization
1125 and characters normalization: CHR and ICU. ICU is
1126 recommended for catalogs containing non-Latin
1129 $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
1130 $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
1133 Please specify Zebra database user);
1134 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1137 Please specify the Zebra database password);
1138 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1141 Since you've chosen to use Zebra, you can enable the SRU/
1142 Z39.50 Server if you so choose, but you must specify a
1143 few configuration options for it.
1145 Please note that if you choose *NOT* to configure SRU,
1146 koha-conf.xml will still contain some references to SRU
1147 settings. Those references will be ignored by Koha.
1149 Install the SRU configuration files?);
1150 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1151 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1153 if ($config{'INSTALL_SRU'} eq 'yes') {
1155 Since you've chosen to configure SRU, you must
1156 specify the host and port(s) that the SRU
1157 Servers (bibliographic and authority) should run on.
1160 SRU Database host?);
1161 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1164 SRU port for bibliographic data?);
1165 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1168 SRU port for authority data?);
1169 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1174 Along with Zebra, you can also choose to install PazPar2,
1175 which is a metasearch tool. With PazPar2,
1176 Koha can perform on-the-fly merging of bibliographic
1177 records during searching, allowing for FRBRization of
1180 Install the PazPar2 configuration files?);
1181 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1182 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1184 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1186 Since you've chosen to configure PazPar2, you must
1187 specify the host and port(s) that PazPar2
1191 Zebra bibliographic server host?);
1192 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1195 Zebra bibliographic port for PazPar2 to use?);
1196 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1200 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1204 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1209 Use memcached to cache the results of some function calls?
1210 This provides a significant performance improvement.
1211 You will need a Memcached server running.);
1212 $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1213 $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1214 if ($config{'USE_MEMCACHED'} eq 'yes'){
1216 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1219 Memcached server address?);
1220 $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1223 Memcached namespace?);
1224 $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1229 Use Elasticsearch to serve search results?
1230 You will need a Elasticsearch server running.);
1231 $msg .= _add_valid_values_disp('USE_ELASTICSEARCH', $valid_values);
1232 $config{'USE_ELASTICSEARCH'} = _get_value('USE_ELASTICSEARCH', $msg, $defaults->{'USE_ELASTICSEARCH'}, $valid_values, $install_log_values);
1233 if ($config{'USE_ELASTICSEARCH'} eq 'yes'){
1235 Define the ELASTICSEARCH_SERVERS with a comma-separated list. Eg
1236 localhost:9200, 192.168.0.100:9200
1239 Elasticsearch server addresses?);
1240 $config{'ELASTICSEARCH_SERVERS'} = _get_value('ELASTICSEARCH_SERVERS', $msg, $defaults->{'ELASTICSEARCH_SERVERS'}, $valid_values, $install_log_values);
1243 What index name to use for this Koha-instance? It must be unique for each Koha
1244 sharing the same Elasticsearch-cluster
1246 Elasticsearch index?);
1247 $config{'ELASTICSEARCH_INDEX'} = _get_value('ELASTICSEARCH_INDEX', $msg, $defaults->{'ELASTICSEARCH_INDEX'}, $valid_values, $install_log_values);
1251 Template cache directory?);
1252 $config{'TEMPLATE_CACHE_DIR'} = _get_value('TEMPLATE_CACHE_DIR', $msg, $defaults->{'TEMPLATE_CACHE_DIR'}, $valid_values, $install_log_values);
1255 Path to DejaVu fonts?);
1256 $config{'FONT_DIR'} = _get_value('FONT_DIR', $msg, $defaults->{'FONT_DIR'}, $valid_values, $install_log_values);
1260 Would you like to run the database-dependent test suite?);
1261 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1262 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1264 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1265 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1266 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1267 $msg = q(TEST DATABASE
1269 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1270 testing. Please don't do this on your production database. It is not
1273 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1274 database. You are better off not running this optional test suite than
1275 doing it in a database that you don't want to lose.
1277 Please specify the name of the test database to be
1280 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1281 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1282 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1283 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1287 Please specify the user that owns the database to be
1289 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1292 Please specify the password of the user that owns the
1293 database to be used by Koha);
1294 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1299 # add version number
1300 my $version = "no_version_found";
1302 require 'kohaversion.pl';
1303 $version = kohaversion();
1305 $config{'KOHA_INSTALLED_VERSION'} = $version;
1310 sub _add_valid_values_disp {
1312 my $valid_values = shift;
1315 if (exists $valid_values->{$key}) {
1316 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1324 my $default = shift;
1325 my $valid_values = shift;
1326 my $install_log_values = shift;
1328 # take value from install log if present
1329 if (exists $install_log_values{$key}) {
1330 $install_log_values{$key} =~ s/\$/\$\$/g;
1331 return $install_log_values{$key};
1334 # override default value from environment
1335 if (exists $ENV{$key}) {
1336 $default = $ENV{$key};
1337 $msg .= " (default from environment)";
1340 my $val = prompt($msg, $default);
1342 while (exists $valid_values->{$key} and
1343 $val ne $default and
1344 not exists $valid_values->{$key}->{$val}) {
1345 my $retry_msg = "Value '$val' is not a valid option.\n";
1346 $retry_msg .= "Please enter a value";
1347 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1348 $val = prompt($retry_msg, $default);
1350 $val =~ s/\$/\$\$/g;
1354 =head2 get_target_directories
1356 Creates a hash mapping from symbols for installation target
1357 directories to actual directory paths.
1359 Also returns a hash indicating targets for which
1360 files need not be copied -- this is used for the 'dev'
1361 mode installation, where some files are installed in place.
1365 sub get_target_directories {
1368 my $base = $config->{'INSTALL_BASE'};
1369 my $mode = $config->{'INSTALL_MODE'};
1371 # get last component of install base directory
1372 # to treat as package name
1373 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1375 my @basedir = File::Spec->splitdir($directories);
1377 if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1379 my $package = pop @basedir;
1384 if ($mode eq 'single') {
1385 $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1386 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1387 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1388 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1389 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1390 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1391 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1392 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1393 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1394 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1395 $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'z3950');
1396 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1397 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1398 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1399 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1400 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1401 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1402 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1403 $dirmap{'LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock');
1404 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1405 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
1406 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1407 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1408 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1409 } elsif ($mode eq 'dev') {
1410 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1411 $dirmap{'API_CGI_DIR'} = File::Spec->catdir($curdir, 'api');
1412 $skipdirs{'API_CGI_DIR'} = 1;
1413 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1414 $skipdirs{'INTRANET_CGI_DIR'} = 1;
1415 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1416 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1417 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1418 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1419 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1420 $skipdirs{'OPAC_CGI_DIR'} = 1;
1421 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1422 $skipdirs{'OPAC_TMPL_DIR'} = 1;
1423 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1424 $skipdirs{'OPAC_WWW_DIR'} = 1;
1425 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1426 $skipdirs{'PERL_MODULE_DIR'} = 1;
1427 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1428 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1429 $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'z3950');
1430 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1431 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1432 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1433 #For dev install, point NONDEV_DIR to misc in current dir (not base)
1434 #Used by supportdir in koha-conf.xml (BZ 12031)
1435 $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
1436 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1437 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1438 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1439 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1440 $dirmap{'LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock');
1441 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1442 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
1443 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1444 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1445 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1447 # mode is standard, i.e., 'fhs'
1448 $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
1449 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1450 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1451 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1452 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1453 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1454 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1455 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1456 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1457 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1458 $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'z3950');
1459 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1460 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1461 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1462 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1463 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1464 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1465 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1466 $dirmap{'LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package);
1467 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1468 $dirmap{'BACKUP_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1469 $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
1470 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1471 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1474 _get_env_overrides(\%dirmap);
1475 _get_argv_overrides(\%dirmap);
1476 _add_destdir(\%dirmap);
1478 return \%dirmap, \%skipdirs;
1483 Map a directory target to the corresponding path for
1491 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1492 if (exists $test_suite_override_dirs{$dirname}) {
1493 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1500 sub _get_env_overrides {
1503 foreach my $key (keys %$dirmap) {
1504 if (exists $ENV{$key}) {
1505 $dirmap->{$key} = $ENV{$key};
1506 print "Setting $key from environment\n";
1511 sub _get_argv_overrides {
1515 for (my $i = 0; $i <= $#ARGV; $i++) {
1516 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1519 push @new_argv, $ARGV[$i];
1525 sub _strip_destdir {
1527 $dir =~ s/^\$\(DESTDIR\)//;
1534 foreach my $key (keys %$dirmap) {
1535 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1539 sub display_configuration {
1542 my @version = grep /\/usr\/share\/perl\//, @INC;
1543 push @version, ('/usr/share/perl/5.10') if !$version[0];
1544 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1545 foreach my $key (sort keys %$config) {
1546 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1549 print "\nand in the following directories:\n\n";
1550 foreach my $key (sort keys %$dirmap) {
1551 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1553 print "\n\nTo change any configuration setting, please run\n";
1554 print "perl Makefile.PL again. To override one of the target\n";
1555 print "directories, you can do so on the command line like this:\n";
1556 print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
1557 print "You can also set different default values for parameters\n";
1558 print "or override directory locations by using environment variables.\n";
1559 print "\nFor example:\n\n";
1560 print "export DB_USER=my_koha\n";
1561 print "perl Makefile.PL\n";
1563 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1568 Attempt to find Zebra - check user's PATH and
1569 a few other directories for zebrasrv and zebraidx.
1574 my @search_dirs = map {
1575 my $abs = File::Spec->rel2abs($_);
1576 my ($toss, $directories);
1577 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1579 } split /:/, $ENV{PATH};
1580 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1581 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1582 return unless @zebrasrv_dirs;
1583 # verify that directory that contains zebrasrv also contains zebraidx
1584 foreach my $dir (@zebrasrv_dirs) {
1585 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1594 my $test = $self->SUPER::test(@_);
1595 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1598 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1605 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1606 # This means that we're completely overriding EU::MM's default
1607 # installation and uninstallation targets.
1609 # If installation is on Win32, we need to do permissions different from *nix
1610 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1611 foreach my $key (sort keys %$target_directories) {
1613 KOHA_INST_$key = blib/$key
1614 KOHA_DEST_$key = $target_directories->{$key}
1615 ) unless exists $skip_directories->{$key};
1618 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1619 \t\$(NOECHO) \$(NOOP)
1621 $install .= "install_koha ::\n";
1622 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1623 foreach my $key (sort keys %$target_directories) {
1624 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1625 unless exists $skip_directories->{$key};
1627 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1628 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1631 $install .= "set_koha_ownership ::\n";
1632 # Do not try to change ownership if DESTDIR is set
1633 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1634 foreach my $key (sort keys %$target_directories) {
1635 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1636 unless exists $skip_directories->{$key};
1639 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1643 $install .= "set_koha_permissions ::\n";
1644 # This is necessary because EU::MM installs files
1645 # as either 0444 or 0555, and we want the owner
1646 # of Koha's files to have write permission by default.
1647 foreach my $key (sort keys %$target_directories) {
1648 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1649 unless exists $skip_directories->{$key};
1655 $install .= "warn_koha_env_vars ::\n";
1656 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1657 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1658 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1659 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1660 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1661 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1662 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1663 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1664 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1665 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1666 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1668 $install .= _update_zebra_conf_target();
1670 $install .= upgrade();
1675 =head2 _update_zebra_conf_target
1677 Add an installation target for updating
1678 Zebra's configuration files.
1682 sub _update_zebra_conf_target {
1684 my $target = "\nupdate_zebra_conf ::\n";
1685 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1686 $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1687 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
1688 $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1689 $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1690 $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
1699 if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1700 my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1701 $version =~ s/\./_/g;
1702 $backup_suffix = "_koha_$version";
1704 $backup_suffix = "_upgrade_backup";
1708 MOD_BACKUP = \$(ABSPERLRUN) -MC4::Installer::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1710 upgrade :: make_upgrade_backup install
1711 \t\$(NOECHO) \$(NOOP)
1712 make_upgrade_backup ::
1713 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1715 foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1716 PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1717 $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1718 unless exists $skip_directories->{$key} or
1719 not exists $target_directories->{$key};
1721 $upgrade =~ s/\\\n$/\n/;
1726 # put directory mappings into Makefile
1727 # so that Make will export as environment
1728 # variables -- this is for the use of
1732 # Hereagain, we must alter syntax per platform...
1734 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1736 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1748 ExtUtils::MakeMaker(3)
1752 MJ Ray mjr at phonecoop.coop
1753 Galen Charlton galen.charlton at liblime.com
1757 FIXME: deal with .htaccess