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