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