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 my %test_suite_override_dirs = (
 564     KOHA_CONF_DIR  => ['etc'],
 565     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
 566     LOG_DIR        => ['var', 'log'],
 567     BACKUP_DIR     => ['var', 'spool'],
 568     SCRIPT_DIR     => ['bin'],
 569     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
 570     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
 571     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
 572 );
 573
 574 WriteMakefile(
 575               NAME         => 'koha',
 576               #VERSION     => strftime('2.9.%Y%m%d%H',gmtime),
 577               VERSION_FROM => 'kohaversion.pl',
 578               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
 579               AUTHOR       => 'Koha Contributors <http://koha-community.org/>',
 580               NO_META      => 1,
 581               PREREQ_PM    => $koha_pm->prereq_pm,
 582
 583               # File tree mapping
 584               PM => $file_map,
 585
 586               # Man pages generated from POD
 587               # ExtUtils::MakeMaker already manage $(DESTDIR)
 588               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
 589               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
 590
 591               PL_FILES => $pl_files,
 592 );
 593
 594 =head1 FUNCTIONS
 595
 596 =head2 hashdir
 597
 598 This function recurses through the directory structure and builds
 599 a hash of hashes containing the structure with arrays holding filenames.
 600 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
 601
 602 =cut
 603
 604 sub hashdir{
 605     my $dir = shift;
 606     opendir my $dh, $dir or die $!;
 607     my $tree = {}->{$dir} = {};
 608     while( my $file = readdir($dh) ) {
 609         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
 610         my $path = $dir .'/' . $file;
 611         $tree->{$file} = hashdir($path), next if -d $path;
 612         push @{$tree->{'.'}}, $file;
 613     }
 614     return $tree;
 615 }
 616
 617 =head2 get_file_map
 618
 619 This function combines the target_map and file hash to
 620 map each source file to its destination relative to
 621 the set of installation targets.
 622
 623 Output will be a hash mapping from each source file
 624 to its destination value, like this:
 625
 626 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
 627
 628 =cut
 629
 630 sub get_file_map {
 631     my $target_map = shift;
 632     my $dirtree = shift;
 633     my $file_map = shift;
 634     my $curr_path = @_ ? shift : ['.'];
 635
 636     # Traverse the directory tree.
 637     # For each file or directory, identify the
 638     # most specific match in the target_map
 639     foreach my $dir (sort keys %{ $dirtree }) {
 640         if ($dir eq '.') {
 641             # deal with files in directory
 642             foreach my $file (sort @{ $dirtree->{$dir} }) {
 643                 my $targetdir = undef;
 644                 my $matchlevel = undef;
 645                 # first, see if there is a match on this specific
 646                 # file in the target map
 647                 my $filepath = join("/", @$curr_path, $file);
 648                 if (exists $target_map->{$filepath}) {
 649                     $targetdir = $target_map->{$filepath};
 650                     $matchlevel = scalar(@$curr_path) + 1;
 651                 } else {
 652                     # no match on the specific file; look for
 653                     # a directory match
 654                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
 655                         my $dirpath = join("/", @$curr_path[0..$i]);
 656                         if (exists $target_map->{$dirpath}) {
 657                             $targetdir = $target_map->{$dirpath};
 658                             $matchlevel = $i + 1;
 659                             last;
 660                         }
 661                     }
 662                 }
 663                 if (defined $targetdir) {
 664                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
 665                 } else {
 666                     my $path = join("/", @$curr_path);
 667                     print "failed to map: $path/$file\n" if $DEBUG;
 668                 }
 669             }
 670         } else {
 671             # dealing with subdirectory
 672             push @$curr_path, $dir;
 673             get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
 674             pop @$curr_path;
 675         }
 676     }
 677 }
 678
 679 sub _add_to_file_map {
 680     my $file_map = shift;
 681     my $targetdir = shift;
 682     my $curr_path = shift;
 683     my $file = shift;
 684     my $matchlevel = shift;
 685     my $dest_path = @_ ? shift : $curr_path;
 686
 687     # The target can be one of the following:
 688     # 1. scalar representing target symbol
 689     # 2. hash ref containing target and trimdir keys
 690     #
 691     # Consequently, this routine traverses this structure,
 692     # calling itself recursively, until it deals with
 693     # all of the scalar target symbols.
 694     if (ref $targetdir eq 'HASH') {
 695         my $subtarget = $targetdir->{target};
 696         if (exists $targetdir->{trimdir}) {
 697             # if we get here, we've specified that
 698             # rather than installing the file to
 699             # $(TARGET)/matching/dirs/subdirs/file,
 700             # we want to install it to
 701             # $(TARGET)/subdirs/file
 702             #
 703             # Note that this the only place where
 704             # $matchlevel is used.
 705             my @new_dest_path = @$dest_path;
 706             if ($targetdir->{trimdir} == -1)  {
 707                 splice @new_dest_path, 0, $matchlevel;
 708             } else {
 709                 splice @new_dest_path, 0, $targetdir->{trimdir};
 710             }
 711             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
 712         } else {
 713             # actually getting here means that the
 714             # target was unnecessarily listed
 715             # as a hash, but we'll forgive that
 716             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
 717         }
 718     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
 719         my $source = File::Spec->catfile(@$curr_path, $file);
 720         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
 721         #print "$source => $destination\n"; # DEBUG
 722         # quote spaces in file names
 723         # FIXME: this is of questionable portability and
 724         # probably depends on user's make recognizing this
 725         # quoting syntax -- probably better to remove
 726         # spaces and shell metacharacters from all file names
 727         $source =~ s/ /\\ /g;
 728         $destination =~ s/ /\\ /g;
 729
 730         $file_map->{$source} = $destination;
 731     }
 732 }
 733
 734 =head2 get_install_log_values
 735
 736 Reads value from the Koha install log specified by
 737 --prev-install-log
 738
 739 =cut
 740
 741 sub get_install_log_values {
 742     my $install_log = shift;
 743     my $values = shift;
 744
 745     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
 746     while (<LOG>) {
 747         chomp;
 748         next if /^#/ or /^\s*$/;
 749         next if /^=/;
 750         next unless m/=/;
 751         s/\s+$//g;
 752         my ($key, $value) = split /=/, $_, 2;
 753         $values->{$key} = $value;
 754     }
 755     close LOG;
 756
 757     print <<_EXPLAIN_INSTALL_LOG_;
 758 Reading values from install log $install_log.  You
 759 will be prompted only for settings that have been
 760 added since the last time you installed Koha.  To
 761 be prompted for all settings, run 'perl Makefile.PL'
 762 without the --prev-install-log option.
 763 _EXPLAIN_INSTALL_LOG_
 764 }
 765
 766 =head2 get_configuration
 767
 768 This prompts the user for various configuration options.
 769
 770 =cut
 771
 772 sub get_configuration {
 773   my $defaults = shift;
 774   my $valid_values = shift;
 775   my $install_log_values = shift;
 776   my %config = ();
 777
 778   my $msg = q(
 779 By default, Koha can be installed in one of three ways:
 780
 781 standard: Install files in conformance with the Filesystem
 782           Hierarchy Standard (FHS).  This is the default mode
 783           and should be used when installing a production
 784           Koha system.  On Unix systems, root access is
 785           needed to complete a standard installation.
 786
 787 single:   Install files under a single directory.  This option
 788           is useful for installing Koha without root access, e.g.,
 789           on a web host that allows CGI scripts and MySQL databases
 790           but requires the user to keep all files under the user's
 791           HOME directory.
 792
 793 dev:      Create a set of symbolic links and configuration files to
 794           allow Koha to run directly from the source distribution.
 795           This mode is useful for developers who want to run
 796           Koha from a git clone.
 797
 798 Installation mode);
 799     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
 800     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
 801
 802     # set message and default value for INSTALL_BASE
 803     # depending on value of INSTALL_MODE
 804     my $install_base_default = $defaults->{'INSTALL_BASE'};
 805     if ($config{'INSTALL_MODE'} eq 'dev') {
 806         $msg = q(
 807 Please specify the directory in which to install Koha's
 808 active configuration files and (if applicable) the
 809 Zebra database.  Koha's CGI scripts and templates will
 810 be run from the current directory.
 811
 812 Configuration directory:);
 813         # FIXME - home directory portability consideration apply
 814         $install_base_default =
 815             $ENV{DESTDIR}
 816             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
 817         ;
 818     } elsif ($config{'INSTALL_MODE'} eq 'single') {
 819         $msg = "\nPlease specify the directory in which to install Koha";
 820         # FIXME -- we're assuming under a 'single' mode install
 821         # that user will likely want to install under the home
 822         # directory.  This is OK in and of itself, but we should
 823         # use File::HomeDir to locate the home directory portably.
 824         # This is deferred for now because File::HomeDir is not yet
 825         # core.
 826                 # --we must also keep this portable to the major OS's -fbcit
 827         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
 828     } else {
 829         # must be standard
 830         $msg = q(
 831 Please specify the directory under which most Koha files
 832 will be installed.
 833
 834 Note that if you are planning in installing more than
 835 one instance of Koha, you may want to modify the last
 836 component of the directory path, which will be used
 837 as the package name in the FHS layout.
 838
 839 Base installation directory);
 840     }
 841     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
 842
 843     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 844         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
 845     if ($config{'INSTALL_MODE'} eq "standard") {
 846         $msg = q(
 847 Since you are using the 'standard' install
 848 mode, you should run 'make install' as root.
 849 However, it is recommended that a non-root
 850 user (on Unix and Linux platforms) have
 851 ownership of Koha's files, including the
 852 Zebra indexes if applicable.
 853
 854 Please specify a user account.  This
 855 user account does not need to exist
 856 right now, but it needs to exist
 857 before you run 'make install'.  Please
 858 note that for security reasons, this
 859 user should not be the same as the user
 860 account Apache runs under.
 861
 862 User account);
 863         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
 864
 865         $msg = q(
 866 Please specify the group that should own
 867 Koha's files.  As above, this group need
 868 not exist right now, but should be created
 869 before you run 'make install'.
 870
 871 Group);
 872         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
 873     }
 874
 875     $msg = q(
 876 Please specify which database engine you will use
 877 to store data in Koha.  The choices are MySQL and
 878 PostgreSQL; please note that at the moment
 879 PostgreSQL support is highly experimental.
 880
 881 DBMS to use);
 882     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
 883     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
 884
 885     $msg = q(
 886 Please specify the name or address of your
 887 database server.  Note that the database
 888 does not have to exist at this point, it
 889 can be created after running 'make install'
 890 and before you try using Koha for the first time.
 891
 892 Database server);
 893     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
 894
 895     $msg = q(
 896 Please specify the port used to connect to the
 897 DMBS);
 898     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
 899     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
 900
 901     $msg = q(
 902 Please specify the name of the database to be
 903 used by Koha);
 904     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
 905
 906     $msg = q(
 907 Please specify the user that owns the database to be
 908 used by Koha);
 909     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
 910
 911     $msg = q(
 912 Please specify the password of the user that owns the
 913 database to be used by Koha);
 914     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
 915
 916     print q(
 917 Koha uses the Zebra search engine for high-performance
 918 searching of bibliographic and authority records.  Checking
 919 to see if you have installed the Zebra software...
 920 );
 921
 922     if (defined(my $zebra_path = find_zebra())) {
 923         $config{'PATH_TO_ZEBRA'} = $zebra_path;
 924         print qq(
 925 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
 926 );
 927     } else {
 928         print q(
 929 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
 930 in your PATH or in some of the usual places.  If you haven't
 931 installed Zebra yet, please do so and run Makefile.PL again.
 932
 933 );
 934     }
 935
 936     $msg = q(
 937 You must specify the primary MARC format of the
 938 records to be indexed by Zebra.
 939
 940 Koha provides Zebra configuration files for MARC21,
 941 NORMARC and UNIMARC.
 942
 943 MARC format for Zebra indexing);
 944     $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
 945     $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
 946     $msg = q(
 947 Koha supplies Zebra configuration files tuned for
 948 searching either English (en) or French (fr) MARC
 949 records.
 950
 951 Primary language for Zebra indexing);
 952     $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
 953     $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
 954
 955     $msg = q(
 956 Koha can use one of  two different indexing modes
 957 for the MARC bibliographic records:
 958
 959 grs1 - uses the Zebra GRS-1 filter, available
 960        for legacy support
 961 dom  - uses the DOM XML filter; offers improved
 962        functionality.
 963
 964 Bibliographic indexing mode);
 965     $msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
 966     $config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
 967
 968
 969     $msg = q(
 970 Koha can use one of  two different indexing modes
 971 for the MARC authorities records:
 972
 973 grs1 - uses the Zebra GRS-1 filter, available
 974        for legacy support
 975 dom  - uses the DOM XML filter; offers improved
 976        functionality.
 977
 978 Authorities indexing mode);
 979     $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
 980     $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
 981
 982     $msg = q(
 983 Zebra has two methods to perform records tokenization
 984 and characters normalization: CHR and ICU. ICU is
 985 recommended for catalogs containing non-Latin
 986 characters.);
 987
 988     $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
 989     $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
 990
 991     $msg = q(
 992 Please specify Zebra database user);
 993     $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
 994
 995     $msg = q(
 996 Please specify the Zebra database password);
 997     $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
 998
 999     $msg = q(
1000 Since you've chosen to use Zebra, you can enable the SRU/
1001 Z39.50 Server if you so choose, but you must specify a
1002 few configuration options for it.
1003
1004 Please note that if you choose *NOT* to configure SRU,
1005 koha-conf.xml will still contain some references to SRU
1006 settings.  Those references will be ignored by Koha.
1007
1008 Install the SRU configuration files?);
1009     $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1010     $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1011
1012     if ($config{'INSTALL_SRU'} eq 'yes') {
1013         $msg = q(
1014 Since you've chosen to configure SRU, you must
1015 specify the host and port(s) that the SRU
1016 Servers (bibliographic and authority) should run on.
1017 );
1018         $msg = q(
1019 SRU Database host?);
1020         $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1021
1022         $msg = q(
1023 SRU port for bibliographic data?);
1024         $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1025
1026         $msg = q(
1027 SRU port for authority data?);
1028         $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1029
1030     }
1031
1032     $msg = q(
1033 Along with Zebra, you can also choose to install PazPar2,
1034 which is a metasearch tool.  With PazPar2,
1035 Koha can perform on-the-fly merging of bibliographic
1036 records during searching, allowing for FRBRization of
1037 the results list.
1038
1039 Install the PazPar2 configuration files?);
1040     $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1041     $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1042
1043     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1044         $msg = q(
1045 Since you've chosen to configure PazPar2, you must
1046 specify the host and port(s) that PazPar2
1047 uses:
1048 );
1049         $msg = q(
1050 Zebra bibliographic server host?);
1051         $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1052
1053         $msg = q(
1054 Zebra bibliographic port for PazPar2 to use?);
1055         $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1056
1057         $msg = q(
1058 PazPar2 host?);
1059         $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1060
1061         $msg = q(
1062 PazPar2 port?);
1063         $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1064
1065     }
1066
1067   $msg = q(
1068 Use memcached and memoize to cache the results of some function calls?
1069 This provides a signficant performance improvement.
1070 You will need a Memcached server running.);
1071   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1072   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1073   if ($config{'USE_MEMCACHED'} eq 'yes'){
1074       $msg = q(
1075 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1076 );
1077       $msg = q(
1078 Memcached server address?);
1079       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1080
1081       $msg = q(
1082 Memcached namespace?);
1083       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1084   }
1085
1086
1087
1088   $msg = q(
1089 Would you like to run the database-dependent test suite?);
1090   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1091     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1092
1093   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1094       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1095       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1096       $msg = q(TEST DATABASE
1097
1098 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1099 testing. Please don't do this on your production database. It is not
1100 reversable.
1101
1102 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1103 database. You are better off not running this optional test suite than
1104 doing it in a database that you don't want to lose.
1105
1106 Please specify the name of the test database to be
1107 used by Koha);
1108
1109       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1110       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1111           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1112           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1113       }
1114
1115       $msg = q(
1116 Please specify the user that owns the database to be
1117 used by Koha);
1118     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1119
1120       $msg = q(
1121 Please specify the password of the user that owns the
1122 database to be used by Koha);
1123       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1124   }
1125
1126     print "\n\n";
1127
1128     # add version number
1129     my $version = "no_version_found";
1130     eval {
1131         require 'kohaversion.pl';
1132         $version = kohaversion();
1133     };
1134     $config{'KOHA_INSTALLED_VERSION'} = $version;
1135
1136     return %config;
1137 }
1138
1139 sub _add_valid_values_disp {
1140     my $key = shift;
1141     my $valid_values = shift;
1142
1143     my $disp = "";
1144     if (exists $valid_values->{$key}) {
1145         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1146     }
1147     return $disp;
1148 }
1149
1150 sub _get_value {
1151     my $key = shift;
1152     my $msg = shift;
1153     my $default = shift;
1154     my $valid_values = shift;
1155     my $install_log_values = shift;
1156
1157     # take value from install log if present
1158     if (exists $install_log_values{$key}) {
1159         $install_log_values{$key} =~ s/\$/\$\$/g;
1160         return $install_log_values{$key};
1161     }
1162
1163     # override default value from environment
1164     if (exists $ENV{$key}) {
1165         $default = $ENV{$key};
1166         $msg .= " (default from environment)";
1167     }
1168
1169     my $val = prompt($msg, $default);
1170
1171     while (exists $valid_values->{$key} and
1172            $val ne $default and
1173            not exists $valid_values->{$key}->{$val}) {
1174         my $retry_msg = "Value '$val' is not a valid option.\n";
1175         $retry_msg .= "Please enter a value";
1176         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1177         $val = prompt($retry_msg, $default);
1178     }
1179     $val =~ s/\$/\$\$/g;
1180     return $val;
1181 }
1182
1183 =head2 get_target_directories
1184
1185 Creates a hash mapping from symbols for installation target
1186 directories to actual directory paths.
1187
1188 Also returns a hash indicating targets for which
1189 files need not be copied -- this is used for the 'dev'
1190 mode installation, where some files are installed in place.
1191
1192 =cut
1193
1194 sub get_target_directories {
1195     my $config = shift;
1196
1197     my $base = $config->{'INSTALL_BASE'};
1198     my $mode = $config->{'INSTALL_MODE'};
1199
1200     # get last component of install base directory
1201     # to treat as package name
1202     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1203
1204     my @basedir = File::Spec->splitdir($directories);
1205
1206         # for Win32 we need to prepend the volume to the directory path
1207         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1208         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1209
1210     my $package = pop @basedir;
1211
1212
1213     my %dirmap = ();
1214     my %skipdirs = ();
1215     if ($mode eq 'single') {
1216         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1217         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1218         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1219         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1220         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1221         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1222         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1223         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1224         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1225         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1226         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1227         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1228         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1229         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1230         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1231         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1232         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1233         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1234         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
1235         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1236         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1237     } elsif ($mode eq 'dev') {
1238         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1239         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1240         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1241         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1242         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1243         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1244         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1245         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1246         $skipdirs{'OPAC_CGI_DIR'} = 1;
1247         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1248         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1249         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1250         $skipdirs{'OPAC_WWW_DIR'} = 1;
1251         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1252         $skipdirs{'PERL_MODULE_DIR'} = 1;
1253         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1254         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1255         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1256         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1257         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1258         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1259         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1260         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1261         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1262         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1263         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1264         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'spool');
1265         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
1266         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1267         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1268     } else {
1269         # mode is standard, i.e., 'fhs'
1270         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1271         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1272         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1273         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1274         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1275         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1276         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1277         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1278         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1279         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1280         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1281         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1282         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1283         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1284         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1285         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1286         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1287         $dirmap{'BACKUP_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
1288         $dirmap{'PLUGINS_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
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 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 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 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 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 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 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     $install .= _update_zebra_conf_target();
1513
1514     $install .= upgrade();
1515
1516     return $install;
1517 }
1518
1519 =head2 _update_zebra_conf_target
1520
1521 Add an installation target for updating
1522 Zebra's configuration files.
1523
1524 =cut
1525
1526 sub _update_zebra_conf_target {
1527
1528     my $target = "\nupdate_zebra_conf ::\n";
1529     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1530     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1531     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1532     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1533     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1534     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1535
1536     return $target;
1537 }
1538
1539 sub upgrade {
1540     my $upgrade = "";
1541
1542     my $backup_suffix;
1543     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1544         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1545         $version =~ s/\./_/g;
1546         $backup_suffix = "_koha_$version";
1547     } else {
1548         $backup_suffix = "_upgrade_backup";
1549     }
1550
1551     $upgrade .= qq/
1552 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1553
1554 upgrade :: make_upgrade_backup install
1555 \t\$(NOECHO) \$(NOOP)
1556 make_upgrade_backup ::
1557 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1558 /;
1559     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1560                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
1561         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1562             unless exists $skip_directories->{$key} or
1563                    not exists $target_directories->{$key};
1564     }
1565     $upgrade =~ s/\\\n$/\n/;
1566
1567     return $upgrade;
1568 }
1569
1570 sub postamble {
1571     # put directory mappings into Makefile
1572     # so that Make will export as environment
1573     # variables -- this is for the use of
1574     # rewrite-confg.PL
1575
1576     my $env;
1577         # Hereagain, we must alter syntax per platform...
1578         if ( $^O eq 'MSWin32' ) {
1579                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1580                 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1581                 $env .= "\n\n";
1582                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1583         }
1584     else {
1585                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1586                 $env .= "\n\n";
1587                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1588         }
1589
1590     return "$env\n";
1591 }
1592
1593
1594 __END__
1595
1596
1597 =head1 SEE ALSO
1598
1599 ExtUtils::MakeMaker(3)
1600
1601 =head1 AUTHORS
1602
1603 MJ Ray mjr at phonecoop.coop
1604 Galen Charlton galen.charlton at liblime.com
1605
1606 =cut
1607
1608 FIXME: deal with .htaccess