Makefile.PL

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