Makefile.PL

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