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