Makefile.PL

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