Makefile.PL

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