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