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