# Copyright 2007 MJ Ray
+# Copyright 2016 PTFS Europe
#
# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
#
# Current maintainer MJR http://mjr.towers.org.uk/
-# See http://www.koha.org/wiki/?page=KohaInstaller
#
use strict;
use ExtUtils::MakeMaker;
use POSIX;
use File::Spec;
+use Getopt::Long qw/HelpMessage/;
+use FindBin; # we need to enforce which C4::Installer::PerlModule is used in case more than one is installed
+
+use lib $FindBin::Bin;
+
+use C4::Installer::PerlModules;
+
+my $koha_pm = C4::Installer::PerlModules->new;
my $DEBUG = 0;
-die "perl 5.6.1 or later required" unless ($] >= 5.006001);
+die "perl 5.10 or later required" unless ($] >= 5.010000);
# Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
=head2 BASIC INSTALLATION
- perl Makefile.PL
- make
- sudo make install
+ perl Makefile.PL
+ make
+ make test
+ sudo make install
+
+=head2 UPGRADE INSTALLATION
+
+ NOTE: This option is only available if koha-install-log exists.
+
+ perl Makefile.PL --prev-install-log /path/to/koha-install-log
+
+ make
+ make test
+ sudo make upgrade
=head2 PACKAGING RELEASE TARBALLS
- make manifest tardist
- make manifest zipdist
+ make manifest tardist
+ make manifest zipdist
=head2 CLEANING UP
make clean
+=head2 CLI PARAMETERS
+
+ --prev-install-log Read configuration from previous installation
+ --install_mode Installation mode (dev, standard, single)
+ --db_type Database (mysql, Pg)
+ --db_host Database host (e.g. localhost)
+ --db_port Database port (e.g. 3306)
+ --db_name Database name (e.g. koha)
+ --db_user Database user (e.g. kohaadmin)
+ --db_pass Database password (e.g. katikoan)
+ --zebra_marc_format Zebra MARC format (marc21, normarc, unimarc)
+ --zebra_language Zebra language (e.g. en)
+ --zebra_tokenizer Zebra tokenizer (chr, icu)
+ --zebra_user Zebra user (e.g. kohauser)
+ --zebra_pass Zebra password (e.g. zebrastripes)
+ --zebra_sru_host Zebra SRU servername (e.g. localhost)
+ --zebra_sru_biblios_port Zebra SRU biblios port (e.g. 9998)
+ --zebra_sru_authorities_port Zebra SRU biblios port (e.g. 9999)
+ --koha_user Koha Unix user (e.g. koha)
+ --koha_group Koha Unix group (e.g. koha)
+ --install_sru Install the SRU server (yes, no)
+ --install_pazpar2 Install PazPar2 (yes, no)
+ --use_memcached Use Memcached (yes, no)
+ --font_dir Location of fonts (e.g. /usr/share/fonts/truetype/dejavu)
+ --run_database_tests Run database dependent tests (yes, no)
+ --install_base Base directory of installation (e.g. /usr/share/koha)
+ --template-cache-dir Specify a template cache directory (e.g. /var/cache/koha)
+ --help Display this help message
+
=head1 DESCRIPTION
This is a packager and installer that uses
Hash of file mappings
-=head2 CONFIGURE
-
-Maybe use prompt() here in future to get configuration values
-interactively at installation time.
-
=head2 PL_FILES
This is a hash of PL scripts to run after installation and
=item If a subdirectory of a mapped directory is specified,
its target overrides the parent's target for that subdirectory.
-=item The value of each map entry may either be a scalar containing
-one target or a reference to an array of targets, in which case
-the directory or file is copied to each target.
+=item The value of each map entry may either be a scalar containing
+one target or a reference to a hash containing 'target' and 'trimdir'
+keys.
=item Any files at the top level of the source tree that are
not included in the map will not be installed.
=over 4
-=item INTRANET_CGI_DIR
+=item INTRANET_CGI_DIR
CGI scripts for intranet (staff) interface.
=item ZEBRA_LOCK_DIR
-Directory for Zebra's lock files.
+Directory for Zebra's lock files. This includes subdirs for authorities,
+biblios, and the zebra rebuild function. Any activity to reindex
+zebra from koha should interlock here with rebuild_zebra.pl.
=item ZEBRA_DATA_DIR
Directory for Zebra's UNIX-domain sockets.
-=item EXAMPLE_DIR
+=item ELASTICSEARCH_SERVERS
+
+Server:port of the Elasticsearch server to use, as a comma separated list:
+eg. 192.168.0.100:9200, localhost:9200
+
+=item ELASTICSEARCH_INDEX
-Directory for example configuration files. This directory
-exists primarily to make it easier to change the
-MARC format or language of the active Zebra
-indexes.
+Unique index in Elasticsearch, for this Koha-instance
+eg. koha-mykoha or just koha
+
+=item MISC_DIR
+
+Directory for for miscellaenous scripts, among other
+things the translation toolkit and RSS feed tools.
=item SCRIPT_DIR
-Directory for command-line scripts and daemons.
+Directory for command-line scripts and daemons to
+be set up all for installation modes.
+
+=item SCRIPT_NONDEV_DIR
+
+Directory for command-line scripts that should
+be installed in the same directory as the
+SCRIPT_DIR target except 'dev' installs.
=item MAN_DIR
=item DOC_DIR
-Directory for Koha documentation accessed from the
+Directory for Koha documentation accessed from the
command-line, e.g., READMEs.
+=item LOCK_DIR
+
+Directory for Koha scripts to put their locks.
+
=item LOG_DIR
Directory for Apache and Zebra logs produced by Koha.
+=item BACKUP_DIR
+
+Directory for backup files produced by Koha.
+
+=item PLUGINS_DIR
+
+Directory for external Koha plugins.
+
+=item PAZPAR2_CONF_DIR
+
+Directory for PazPar2 configuration files.
+
+=item FONT_DIR
+
+Directory where DejaVu fonts are installed.
+
=item NONE
This is a dummy target used to explicitly state
'./about.pl' => 'INTRANET_CGI_DIR',
'./acqui' => 'INTRANET_CGI_DIR',
'./admin' => 'INTRANET_CGI_DIR',
+ './api' => { target => 'API_CGI_DIR', trimdir => -1 },
'./authorities' => 'INTRANET_CGI_DIR',
+ './basket' => 'INTRANET_CGI_DIR',
'./C4' => 'PERL_MODULE_DIR',
'./C4/SIP/t' => 'NONE',
'./C4/SIP/koha_test' => 'NONE',
'./C4/tests' => 'NONE',
'./catalogue' => 'INTRANET_CGI_DIR',
'./cataloguing' => 'INTRANET_CGI_DIR',
- './changelanguage.pl' => [ 'INTRANET_CGI_DIR', 'OPAC_CGI_DIR' ],
+ './changelanguage.pl' => 'INTRANET_CGI_DIR',
'./check_sysprefs.pl' => 'NONE',
'./circ' => 'INTRANET_CGI_DIR',
- './edithelp.pl' => 'INTRANET_CGI_DIR',
+ './clubs' => 'INTRANET_CGI_DIR',
+ './course_reserves' => 'INTRANET_CGI_DIR',
+ './cpanfile' => 'PERL_MODULE_DIR',
+ './docs/history.txt' => { target => 'DOC_DIR', trimdir => -1 },
+ './docs/contributors.yaml' => { target => 'DOC_DIR', trimdir => -1 },
+ './docs/teams.yaml' => { target => 'DOC_DIR', trimdir => -1 },
+ './offline_circ' => 'INTRANET_CGI_DIR',
'./etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
'./etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
+ './etc/z3950' => { target => 'Z3950_CONF_DIR', trimdir => -1 },
+ './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
+ './help.pl' => 'INTRANET_CGI_DIR',
+ './ill' => 'INTRANET_CGI_DIR',
'./installer-CPAN.pl' => 'NONE',
'./installer' => 'INTRANET_CGI_DIR',
- './koha-tmpl' => 'NONE',
+ './errors' => {target => 'INTRANET_CGI_DIR'},
+ './Koha' => 'PERL_MODULE_DIR',
+ './Koha.pm' => 'PERL_MODULE_DIR',
'./koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
- './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -11},
- './koha-version.pl' => 'INTRANET_CGI_DIR', # FIXME this may need to be in OPAC_CGI_DIR as well, with an update to C4::Context
+ './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
+ './kohaversion.pl' => 'INTRANET_CGI_DIR',
'./labels' => 'INTRANET_CGI_DIR',
'./mainpage.pl' => 'INTRANET_CGI_DIR',
'./Makefile.PL' => 'NONE',
'./MANIFEST.SKIP' => 'NONE',
'./members' => 'INTRANET_CGI_DIR',
- './misc' => { target => 'SCRIPT_DIR', trimdir => -1 },
- './misc/info' => { target => 'DOC_DIR', trimdir => 2 },
- './misc/release notes' => { target => 'DOC_DIR', trimdir => 2 },
- './misc/translator' => { target => 'EXAMPLE_DIR', trimdir => 2 },
+ './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
+ './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
+ './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
+ './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
+ './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
'./misc/installer_devel_notes' => 'NONE',
'./opac' => 'OPAC_CGI_DIR',
+ './OpenILS' => 'PERL_MODULE_DIR',
'./README.txt' => 'NONE',
+ './patroncards' => 'INTRANET_CGI_DIR',
+ './patron_lists' => 'INTRANET_CGI_DIR',
+ './plugins' => 'INTRANET_CGI_DIR',
+ './pos' => 'INTRANET_CGI_DIR',
'./reports' => 'INTRANET_CGI_DIR',
'./reserve' => 'INTRANET_CGI_DIR',
'./reviews' => 'INTRANET_CGI_DIR',
'./rewrite-config.PL' => 'NONE',
'./reviews' => 'INTRANET_CGI_DIR',
- './rss' => 'NONE', # FIXME deal with a little later
+ './rotating_collections' => 'INTRANET_CGI_DIR',
'./serials' => 'INTRANET_CGI_DIR',
+ './services' => 'INTRANET_CGI_DIR',
+ './skel' => 'NONE',
+ './skel/var/lock/koha' => { target => 'LOCK_DIR', trimdir => -1 },
+ './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
+ './skel/var/spool/koha' => { target => 'BACKUP_DIR', trimdir => -1 },
+ './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
+ './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
+ './skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
+ './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
'./sms' => 'INTRANET_CGI_DIR',
'./suggestion' => 'INTRANET_CGI_DIR',
'./svc' => 'INTRANET_CGI_DIR',
'./t' => 'NONE',
- './tmp' => 'NONE', # FIXME deal with later
+ './xt' => 'NONE',
+ './tags' => 'INTRANET_CGI_DIR',
+ './tmp' => 'NONE', # FIXME need to determine whether
+ # Koha generates any persistent temp files
+ # that should go in /var/tmp/koha
'./tools' => 'INTRANET_CGI_DIR',
'./virtualshelves' => 'INTRANET_CGI_DIR',
# ignore files and directories created by the install itself
'./pm_to_blib' => 'NONE',
'./blib' => 'NONE',
+ '.sass-lint.yml' => 'NONE',
+ '.scss-lint.yml' => 'NONE',
+ '.eslintrc.json' => 'NONE',
+ 'gulpfile.js' => 'NONE',
+ 'package.json' => 'NONE',
+ 'yarn.lock' => 'NONE',
};
=head1 CONFIGURATION OPTIONS
Specifies whether installation will be FHS-compliant (default,
assumes user has root), put everything under
a single directory (for users installing on a web host
-that allows CGI scripts and a MySQL database but not root
+that allows CGI scripts and a MySQL database but not root
access), or development (for a developer who wants to run
Koha from a git clone with no fuss).
Directory under which most components will go. Default
value will vary depending on INSTALL_MODE.
-=item INSTALL_ZEBRA
+=item DB_TYPE
+
+Type of DBMS (e.g., mysql or Pg).
+
+=item DB_HOST
+
+Name of DBMS server.
+
+=item DB_PORT
+
+Port that DBMS server is listening on.
-Whether to install Zebra configuration files and data
-directories.
+=item DB_NAME
+
+Name of the DBMS database for Koha.
+
+=item DB_USER
+
+Name of DBMS user account for Koha's database.
+
+=item DB_PASS
+
+Pasword of DMBS user account for Koha's database.
=item ZEBRA_MARC_FORMAT
=item ZEBRA_LANGUAGE
-Specifies primary language of records that will be
+Specifies primary language of records that will be
indexed by Zebra.
+=item ZEBRA_USER
+
+Internal Zebra user account for the index.
+
+=item ZEBRA_PASS
+
+Internal Zebra user account's password.
+
+=item KOHA_USER
+
+System user account that will own Koha's files.
+
+=item KOHA_GROUP
+
+System group that will own Koha's files.
+
=back
=cut
# default configuration options
my %config_defaults = (
- 'INSTALL_MODE' => 'standard',
- 'INSTALL_BASE' => '/usr/share/koha',
- 'INSTALL_ZEBRA' => 'yes',
+ 'DB_TYPE' => 'mysql',
+ 'DB_HOST' => 'localhost',
+ 'DB_NAME' => 'koha',
+ 'DB_USER' => 'kohaadmin',
+ 'DB_PASS' => 'katikoan',
+ 'DB_USE_TLS' => 'no',
+ 'DB_TLS_CA_CERTIFICATE' => '/etc/mysql-ssl/server-ca.pem',
+ 'DB_TLS_CLIENT_CERTIFICATE' => '/etc/mysql-ssl/client-cert.pem',
+ 'DB_TLS_CLIENT_KEY' => '/etc/mysql-ssl/client-key.pem',
+ 'INSTALL_SRU' => 'yes',
+ 'INSTALL_PAZPAR2' => 'no',
'ZEBRA_MARC_FORMAT' => 'marc21',
'ZEBRA_LANGUAGE' => 'en',
+ 'ZEBRA_TOKENIZER' => 'chr',
+ 'ZEBRA_USER' => 'kohauser',
+ 'ZEBRA_PASS' => 'zebrastripes',
+ 'ZEBRA_SRU_HOST' => 'localhost',
+ 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
+ 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
+ 'KOHA_USER' => 'koha',
+ 'KOHA_GROUP' => 'koha',
+ 'MERGE_SERVER_HOST' => 'localhost',
+ 'MERGE_SERVER_PORT' => '11001',
+ 'PAZPAR2_HOST' => 'localhost',
+ 'PAZPAR2_PORT' => '11002',
+ 'RUN_DATABASE_TESTS' => 'no',
+ 'PATH_TO_ZEBRA' => '',
+ 'USE_MEMCACHED' => 'yes',
+ 'MEMCACHED_SERVERS' => '127.0.0.1:11211',
+ 'MEMCACHED_NAMESPACE' => 'KOHA',
+ 'TEMPLATE_CACHE_DIR' => '/tmp/koha',
+ 'USE_ELASTICSEARCH' => 'no',
+ 'ELASTICSEARCH_SERVERS' => 'localhost:9200',
+ 'ELASTICSEARCH_INDEX' => 'koha',
+ 'FONT_DIR' => '/usr/share/fonts/truetype/dejavu'
);
+# set some default configuration options based on OS
+# more conditions need to be added for other OS's
+
+warn "Your platform appears to be $^O.\n" if $DEBUG;
+
+if ( $^O eq 'cygwin' ) {
+ # Most Unix2Win32 ports seem to poke everything into the Program Files directory
+ # this could be changed to put some files (ie. libraries) into system32, etc.
+ $config_defaults{'INSTALL_MODE'} = 'single';
+ $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
+}
+else {
+ $config_defaults{'INSTALL_MODE'} = 'standard';
+ $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
+}
+
# valid values for certain configuration options
my %valid_config_values = (
'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
- 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
- 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
- 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
+ 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
+ 'DB_USE_TLS' => {'yes', 'no'},
+ 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
+ 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
+ 'ZEBRA_LANGUAGE' => { 'cs' => 1, 'el' => 1, 'en' => 1, 'es' => 1, 'fr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
+ 'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
+ 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
+ 'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
+ 'USE_ELASTICSEARCH' => { 'yes' => 1, 'no' => 1 },
);
-my %config = get_configuration(\%config_defaults, \%valid_config_values);
-my %target_directories = get_target_directories(\%config);
+# get settings from command-line
+my $koha_install_log = "";
+my $cli_koha_install_mode = "";
+my $cli_koha_db_type = "";
+my $cli_koha_db_host = "";
+my $cli_koha_db_port = "";
+my $cli_koha_db_name = "";
+my $cli_koha_db_user = "";
+my $cli_koha_db_pass = "";
+my $cli_zebra_marc_format = "";
+my $cli_zebra_language = "",
+my $cli_zebra_tokenizer = "";
+my $cli_zebra_user = "";
+my $cli_zebra_pass = "";
+my $cli_zebra_sru_host = "";
+my $cli_zebra_sru_bib_port = "";
+my $cli_zebra_sru_auth_port = "";
+my $cli_koha_user = "";
+my $cli_koha_group = "";
+my $cli_koha_install_sru = "";
+my $cli_koha_install_pazpar2 = "";
+my $cli_koha_use_memcached = "";
+my $cli_koha_font_dir = "";
+my $cli_koha_run_database_tests = "";
+my $cli_koha_install_base = "";
+my $cli_koha_template_cache_dir = "";
+Getopt::Long::Configure('pass_through');
+my $results = GetOptions(
+ "prev-install-log=s" => \$koha_install_log,
+ "install_mode=s" => \$cli_koha_install_mode,
+ "db_type=s" => \$cli_koha_db_type,
+ "db_host=s" => \$cli_koha_db_host,
+ "db_port=s" => \$cli_koha_db_port,
+ "db_name=s" => \$cli_koha_db_name,
+ "db_user=s" => \$cli_koha_db_user,
+ "db_pass=s" => \$cli_koha_db_pass,
+ "zebra_marc_format=s" => \$cli_zebra_marc_format,
+ "zebra_language=s" => \$cli_zebra_language,
+ "zebra_tokenizer=s" => \$cli_zebra_tokenizer,
+ "zebra_user=s" => \$cli_zebra_user,
+ "zebra_pass=s" => \$cli_zebra_pass,
+ "zebra_sru_host=s" => \$cli_zebra_sru_host,
+ "zebra_sru_biblios_port=s" => \$cli_zebra_sru_bib_port,
+ "zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
+ "koha_user=s" => \$cli_koha_user,
+ "koha_group=s" => \$cli_koha_group,
+ "install_sru=s" => \$cli_koha_install_sru,
+ "install_pazpar2=s" => \$cli_koha_install_pazpar2,
+ "use_memcached=s" => \$cli_koha_use_memcached,
+ "font_dir=s" => \$cli_koha_font_dir,
+ "run_database_tests=s" => \$cli_koha_run_database_tests,
+ "install_base=s" => \$cli_koha_install_base,
+ "template-cache-dir=s" => \$cli_koha_template_cache_dir,
+ "help" => sub { HelpMessage(0) },
+) or HelpMessage(1);
+
+my %install_log_values = ();
+if ($koha_install_log ne "") {
+ get_install_log_values($koha_install_log, \%install_log_values);
+} else {
+ # Try to set install_log_values for provided values;
+ get_cli_values(\%install_log_values);
+}
+
+my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
+my ($target_directories, $skip_directories) = get_target_directories(\%config);
+display_configuration(\%config, $target_directories);
my $file_map = {};
get_file_map($target_map, $dirtree, $file_map);
-WriteMakefile(
- NAME => 'koha',
- #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
- VERSION_FROM => 'C4/Context.pm',
- ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
- AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
- NO_META => 1,
- PREREQ_PM => {
-'CGI' => 3.15,
-'CGI::Carp' => 1.29,
-'CGI::Session' => '4.10',
-'Class::Factory::Util' => 1.7,
-'Class::Accessor' => 0.30,
-'DBD::mysql' => 3.0008,
-'DBI' => 1.53,
-'Data::Dumper' => 2.121_08,
-'Date::Calc' => 5.4,
-'Date::Manip' => 5.44,
-'Digest::MD5' => 2.36,
-'File::Temp' => 0.16,
-'GD::Barcode::UPCE' => 1.1,
-'Getopt::Long' => 2.35,
-'Getopt::Std' => 1.05,
-'HTML::Template::Pro' => 0.65,
-'HTTP::Cookies' => 1.39,
-'HTTP::Request::Common' => 1.26,
-'LWP::Simple' => 1.41,
-'LWP::UserAgent' => 2.033,
-'Lingua::Stem' => 0.82,
-'List::Util' => 1.18,
-'Locale::Language' => 2.07,
-'MARC::Charset' => 0.98,
-'MARC::Crosswalk::DublinCore' => 0.03,
-'MARC::File::XML' => 0.88,
-'MARC::Record' => 2.00,
-'MIME::Base64' => 3.07,
-'MIME::QuotedPrint' => 3.07,
-'Mail::Sendmail' => 0.79,
-'PDF::API2' => 2.000,
-'PDF::API2::Page' => 2.000,
-'PDF::API2::Util' => 2.000,
-'PDF::Reuse' => 0.33,
-'PDF::Reuse::Barcode' => 0.05,
-'POSIX' => 1.09,
-'Schedule::At' => 1.06,
-'Term::ANSIColor' => 1.10,
-'Test' => 1.25,
-'Test::Harness' => 2.56,
-'Test::More' => 0.62,
-'Text::CSV' => 0.01,
-'Text::CSV_XS' => 0.32,
-'Text::Wrap' => 2005.082401,
-'Time::HiRes' => 1.86,
-'Time::localtime' => 1.02,
-'Unicode::Normalize' => 0.32,
-'XML::Dumper' => 0.81,
-'XML::LibXML' => 1.59,
-'XML::SAX::ParserFactory' => 1.01,
-'XML::Simple' => 2.14,
-'XML::RSS' => 1.31,
-'ZOOM' => 1.16,
- },
-
- # File tree mapping
- PM => $file_map,
-
- # Man pages generated from POD
- INSTALLMAN1DIR => File::Spec->catdir($target_directories{'MAN_DIR'}, 'man1'),
- INSTALLMAN3DIR => File::Spec->catdir($target_directories{'MAN_DIR'}, 'man3'),
-
- # disable tests
- 'test' => {TESTS => 't/dummy.t'},
-
-# CONFIGURE => sub {
-# # Ask for options with prompt($question,$default) calls here?
-# return { macro => { 'export TEST' => '755' } }
-# },
-
- PL_FILES => { # generator => target(s)
+my $pl_files = {
'rewrite-config.PL' => [
'blib/KOHA_CONF_DIR/koha-conf.xml',
'blib/KOHA_CONF_DIR/koha-httpd.conf',
- 'blib/ZEBRA_CONF_DIR/etc/passwd',
- 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
- 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg'
- ]
- }
-# 'opac/getfromintranet.PL' => ['$(INST_LIBDIR)/opac/cgi-bin/detail.pl','$(INST_LIBDIR)/opac/cgi-bin/moredetail.pl','$(INST_LIBDIR)/opac/cgi-bin/search.pl','$(INST_LIBDIR)/opac/cgi-bin/subjectsearch.pl','$(INST_LIBDIR)/opac/cgi-bin/logout.pl'],
-# 'misc/koha.conf.PL' => '$(INST_LIBDIR)/../etc/koha.conf',
-# 'misc/apache-koha.conf.PL' => '$(INST_LIBDIR)/../etc/apache-koha.conf',
-# 'misc/koha.sql.PL' => '$(INST_LIBDIR)/intranet/scripts/koha.sql',
-# 'z3950/z3950-daemon-options.PL' => '$(INST_LIBDIR)/intranet/scripts/z3950daemon/z3950-daemon-options',
-# # fake target to check permissions
-# 'misc/chmod.PL' => '$(INST_LIBDIR)/fake-target'
-# }
- # need to set ownerships
- # need to load koha.sql
- # need to link koha-httpd.conf
- # need to start z3950-daemon
+ 'blib/KOHA_CONF_DIR/log4perl.conf',
+ 'blib/ZEBRA_CONF_DIR/etc/default.idx',
+ 'blib/MISC_DIR/koha-install-log'
+ ],
+ 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
+ 'blib'
+ ],
+};
+
+push @{ $pl_files->{'rewrite-config.PL'} }, (
+ 'blib/ZEBRA_CONF_DIR/etc/passwd',
+ 'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
+ 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
+ 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
+ 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
+ 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
+ 'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
+);
+push @{ $pl_files->{'rewrite-config.PL'} }, (
+ 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
+ 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
+ 'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
+);
+if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
+ push @{ $pl_files->{'rewrite-config.PL'} }, (
+ 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
+ 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
+ );
+}
+$config{'ZEBRA_AUTH_CFG'} = 'zebra-authorities-dom.cfg';
+$config{'ZEBRA_BIB_CFG'} = 'zebra-biblios-dom.cfg';
+$config{'AUTH_RETRIEVAL_CFG'} = 'retrieval-info-auth-dom.xml';
+$config{'BIB_RETRIEVAL_CFG'} = 'retrieval-info-bib-dom.xml';
+
+if ($config{'INSTALL_MODE'} ne "dev") {
+ push @{ $pl_files->{'rewrite-config.PL'} }, (
+ 'blib/PERL_MODULE_DIR/C4/Context.pm',
+ 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
+ );
+}
+
+$config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
+ ? 'icuchain words-icu.xml'
+ : 'charmap word-phrase-utf.chr';
+
+$config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
+ ? 'icuchain phrases-icu.xml'
+ : 'charmap word-phrase-utf.chr';
+
+my %test_suite_override_dirs = (
+ KOHA_CONF_DIR => ['etc'],
+ ZEBRA_CONF_DIR => ['etc', 'zebradb'],
+ Z3950_CONF_DIR => ['etc', 'z3950'],
+ LOCK_DIR => ['var', 'lock'],
+ LOG_DIR => ['var', 'log'],
+ BACKUP_DIR => ['var', 'spool'],
+ SCRIPT_DIR => ['bin'],
+ ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
+ ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
+ ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
+);
+
+WriteMakefile(
+ NAME => 'koha',
+ #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
+ VERSION_FROM => 'kohaversion.pl',
+ ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
+ AUTHOR => 'Koha Contributors <http://koha-community.org/>',
+ NO_META => 1,
+ PREREQ_PM => $koha_pm->prereq_pm,
+
+ # File tree mapping
+ PM => $file_map,
+
+ # Man pages generated from POD
+ # ExtUtils::MakeMaker already manage $(DESTDIR)
+ INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
+ INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
+
+ PL_FILES => $pl_files,
);
=head1 FUNCTIONS
opendir my $dh, $dir or die $!;
my $tree = {}->{$dir} = {};
while( my $file = readdir($dh) ) {
- next if $file =~ m/^\.{1,2}/;
+ next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
my $path = $dir .'/' . $file;
$tree->{$file} = hashdir($path), next if -d $path;
push @{$tree->{'.'}}, $file;
return $tree;
}
-=head2 get_file_map
+=head2 get_file_map
This function combines the target_map and file hash to
map each source file to its destination relative to
# The target can be one of the following:
# 1. scalar representing target symbol
# 2. hash ref containing target and trimdir keys
- # 3. array ref containing list of #1 and #2
#
# Consequently, this routine traverses this structure,
# calling itself recursively, until it deals with
# all of the scalar target symbols.
- if (ref $targetdir eq 'ARRAY') {
- foreach my $subtarget (sort @$targetdir) {
- _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
- }
- } elsif (ref $targetdir eq 'HASH') {
+ if (ref $targetdir eq 'HASH') {
my $subtarget = $targetdir->{target};
if (exists $targetdir->{trimdir}) {
# if we get here, we've specified that
}
} elsif ($targetdir ne 'NONE' and $targetdir ne '') {
my $source = File::Spec->catfile(@$curr_path, $file);
- return if $source =~ / /; #FIXME
- #my $destination = File::Spec->catfile("\$($targetdir)", @$dest_path, $file);
my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
#print "$source => $destination\n"; # DEBUG
+ # quote spaces in file names
+ # FIXME: this is of questionable portability and
+ # probably depends on user's make recognizing this
+ # quoting syntax -- probably better to remove
+ # spaces and shell metacharacters from all file names
+ $source =~ s/ /\\ /g;
+ $destination =~ s/ /\\ /g;
+
$file_map->{$source} = $destination;
}
}
-=head2 unhashdir
+=head2 get_cli_values
-This function unhashes the hash of hashes generated by hashdir().
-This directory unhashing routine is the personal work of Chris Nighswonger (fbcit).
-Modified here to build koha makefile. It lists all files and where to install each one.
-It then returns a hash reference suitable for the PM variable above.
+Reads values provided on cli for configuration values
=cut
-sub unhashdir{
- my $dirhash = shift;
- my $dirlevel = shift;
- my $toplevel = $dirlevel;
- for my $k1 ( sort keys %$dirhash ) {
- if ($k1 ne '.' && $k1 ne '') {
- $dirlevel = ( $dirlevel ? $dirlevel . '/' . $k1 : $k1 );
- &unhashdir($dirhash->{ $k1 }, $dirlevel);
- $dirlevel = $toplevel;
- }
- elsif ( $k1 eq '.' ) {
- foreach my $file ( @{$dirhash->{ $k1 }} ) {
-# TODO: There are some hacks here that may be able to be improved... -fbcit
- if ( $file =~ /^./ ) { next; } # skip hidden files and directories.
-
- elsif ( $file =~ /\.pm/ && $dirlevel =~ /C4/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(INST_LIBDIR)/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # C4/*.pm is copied to perl's lib namespace.
-
- elsif ( $dirlevel !~ /koha-tmpl/ && $dirlevel =~ /(installer|errors)/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(PREFIX)/lib/cgi-bin/koha/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # error templates are copied to $(PREFIX)/lib/cgi-bin/koha/
-
- elsif ( $dirlevel =~ /koha-tmpl/ && $dirlevel !~ /errors/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(INST_LIBDIR)/koha/templates/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # error templates are copied to $(INST_LIBDIR)/koha/templates/
-
- elsif ( $dirlevel =~ /(misc|rss)/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(INST_LIBDIR)/koha/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # misc & rss are copied to koha,
+sub get_cli_values {
+ my $values = shift;
+ my $map = {
+ INSTALL_MODE => $cli_koha_install_mode,
+ DB_TYPE => $cli_koha_db_type,
+ DB_HOST => $cli_koha_db_host,
+ DB_PORT => $cli_koha_db_port,
+ DB_NAME => $cli_koha_db_name,
+ DB_USER => $cli_koha_db_user,
+ DB_PASS => $cli_koha_db_pass,
+ ZEBRA_MARC_FORMAT => $cli_zebra_marc_format,
+ ZEBRA_LANGUAGE => $cli_zebra_language,
+ ZEBRA_TOKENIZER => $cli_zebra_tokenizer,
+ ZEBRA_USER => $cli_zebra_user,
+ ZEBRA_PASS => $cli_zebra_pass,
+ ZEBRA_SRU_HOST => $cli_zebra_sru_host,
+ ZEBRA_SRU_BIBLIOS_PORT => $cli_zebra_sru_bib_port,
+ ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
+ KOHA_USER => $cli_koha_user,
+ KOHA_GROUP => $cli_koha_group,
+ INSTALL_SRU => $cli_koha_install_sru,
+ INSTALL_PAZPAR2 => $cli_koha_install_pazpar2,
+ USE_MEMCACHED => $cli_koha_use_memcached,
+ FONT_DIR => $cli_koha_font_dir,
+ RUN_DATABASE_TESTS => $cli_koha_run_database_tests,
+ INSTALL_BASE => $cli_koha_install_base,
+ TEMPLATE_CACHE_DIR => $cli_koha_template_cache_dir
+ };
+ foreach my $key (keys %{$map}) {
+ $values->{$key} = $map->{$key} if ($map->{$key});
+ }
+}
-# elsif ( $dirlevel =~ /(intranet-tmpl|opac-tmpl)/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(INST_LIBDIR)/koha/templates/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # Templates are copied to koha/templates,
+=head2 get_install_log_values
- elsif ( $file !~ /\.pl/ && $dirlevel =~ /etc/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(PREFIX)/share/koha/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # Misc etc to koha/etc
+Reads value from the Koha install log specified by
+--prev-install-log
- elsif ( $file =~ /\.pl/ ) { $result{ ($dirlevel ? $dirlevel . '/' . $file : $file) } = '$(PREFIX)/lib/cgi-bin/koha/' . ($dirlevel ? $dirlevel . '/' . $file : $file); } # CGIs are copied to $(PREFIX)/lib/cgi-bin/koha/ print $result{ ($dirlevel ? $dirlevel . '/' . $file : $file)},"\n\n";
+=cut
- }
- next;
- }
- }
- return \%result;
+sub get_install_log_values {
+ my $install_log = shift;
+ my $values = shift;
+
+ open my $log, '<', $install_log or die "Cannot open install log $install_log: $!\n";
+ while (<$log>) {
+ chomp;
+ next if /^#/ or /^\s*$/;
+ next if /^=/;
+ next unless m/=/;
+ s/\s+$//g;
+ my ($key, $value) = split /=/, $_, 2;
+ $values->{$key} = $value;
+ }
+ close $log;
+
+ print <<_EXPLAIN_INSTALL_LOG_;
+Reading values from install log $install_log. You
+will be prompted only for settings that have been
+added since the last time you installed Koha. To
+be prompted for all settings, run 'perl Makefile.PL'
+without the --prev-install-log option.
+_EXPLAIN_INSTALL_LOG_
}
-=head2 get_configuration_options
+=head2 get_configuration
This prompts the user for various configuration options.
sub get_configuration {
my $defaults = shift;
my $valid_values = shift;
+ my $install_log_values = shift;
my %config = ();
my $msg = q(
standard: Install files in conformance with the Filesystem
Hierarchy Standard (FHS). This is the default mode
and should be used when installing a production
- Koha system. On Unix systems, root access is
+ Koha system. On Unix systems, root access is
needed to complete a standard installation.
single: Install files under a single directory. This option
This mode is useful for developers who want to run
Koha from a git clone.
-Please choose the installation mode);
+Installation mode);
$msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
- $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values);
+ $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
# set message and default value for INSTALL_BASE
# depending on value of INSTALL_MODE
Please specify the directory in which to install Koha's
active configuration files and (if applicable) the
Zebra database. Koha's CGI scripts and templates will
-be run from the current directory.);
+be run from the current directory.
+
+Configuration directory:);
# FIXME - home directory portability consideration apply
- $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "/usr/share/koha-dev";
+ $install_base_default =
+ $ENV{DESTDIR}
+ || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
+ ;
} elsif ($config{'INSTALL_MODE'} eq 'single') {
$msg = "\nPlease specify the directory in which to install Koha";
# FIXME -- we're assuming under a 'single' mode install
# that user will likely want to install under the home
# directory. This is OK in and of itself, but we should
- # use File::HomeDir to locate the home directory portably.
+ # use File::HomeDir to locate the home directory portably.
# This is deferred for now because File::HomeDir is not yet
# core.
- $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : "/usr/share/koha";
+ # --we must also keep this portable to the major OS's -fbcit
+ $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
} else {
# must be standard
$msg = q(
-Please specify the directory under which most Koha files
+Please specify the directory under which most Koha files
will be installed.
-Note that if you are planning in installing more than
+Note that if you are planning in installing more than
one instance of Koha, you may want to modify the last
component of the directory path, which will be used
-as the package name in the FHS layout.);
+as the package name in the FHS layout.
+
+Base installation directory);
}
- $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values);
+ $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
+
$config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
+ print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
+ if ($config{'INSTALL_MODE'} eq "standard") {
+ $msg = q(
+Since you are using the 'standard' install
+mode, you should run 'make install' as root.
+However, it is recommended that a non-root
+user (on Unix and Linux platforms) have
+ownership of Koha's files, including the
+Zebra indexes if applicable.
+
+Please specify a user account. This
+user account does not need to exist
+right now, but it needs to exist
+before you run 'make install'. Please
+note that for security reasons, this
+user should not be the same as the user
+account Apache runs under.
+
+User account);
+ $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify the group that should own
+Koha's files. As above, this group need
+not exist right now, but should be created
+before you run 'make install'.
+
+Group);
+ $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
+ }
$msg = q(
-Koha can use the Zebra search engine for high-performance
-searching of bibliographic and authority records. If you
-have installed the Zebra software and would like to use it,
-please answer 'yes' to the following question. Otherwise,
-Koha will default to using its internal search engine.
+Please specify which database engine you will use
+to store data in Koha. The choices are MySQL and
+PostgreSQL; please note that at the moment
+PostgreSQL support is highly experimental.
-Please specify whether to install the Zebra configuration files);
- $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
- $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values);
+DBMS to use);
+ $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
+ $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
- if ($config{'INSTALL_ZEBRA'} eq 'yes') {
+ $msg = q(
+Please specify the name or address of your
+database server. Note that the database
+does not have to exist at this point, it
+can be created after running 'make install'
+and before you try using Koha for the first time.
+
+Database server);
+ $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify the port used to connect to the
+DMBS);
+ my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
+ $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify the name of the database to be
+used by Koha);
+ $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
+ if ($config{'DB_TYPE'} eq 'mysql'){
$msg = q(
-Since you've chosen to use Zebra with Koha,
-you must specify the primary MARC format of the
+Please specify whether the connection to MySQL will use TLS
+ );
+ $config{'DB_USE_TLS'} = _get_value('DB_USE_TLS', $msg, $defaults->{'DB_USE_TLS'}, $valid_values, $install_log_values);
+ }
+ if ($config{'DB_USE_TLS'} eq 'yes'){
+ $msg = q(
+Please enter the path to the CA certificate for TLS
+ );
+ $config{'DB_TLS_CA_CERTIFICATE'} = _get_value('DB_TLS_CA_CERTIFICATE', $msg, $defaults->{'DB_TLS_CA_CERTIFICATE'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please enter the path to the client certificate for TLS
+ );
+ $config{'DB_TLS_CLIENT_CERTIFICATE'} = _get_value('DB_TLS_CLIENT_CERTIFICATE', $msg, $defaults->{'DB_TLS_CLIENT_CERTIFICATE'}, $valid_values, $install_log_values);
+ $msg = q(
+Please enter the path to the client key for TLS
+ );
+ $config{'DB_TLS_CLIENT_KEY'} = _get_value('DB_TLS_CLIENT_KEY', $msg, $defaults->{'DB_TLS_CLIENT_KEY'}, $valid_values, $install_log_values);
+ }
+
+ $msg = q(
+Please specify the user that owns the database to be
+used by Koha);
+ $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify the password of the user that owns the
+database to be used by Koha);
+ $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
+
+ print q(
+Koha uses the Zebra search engine for high-performance
+searching of bibliographic and authority records. Checking
+to see if you have installed the Zebra software...
+);
+
+ if (defined(my $zebra_path = find_zebra())) {
+ $config{'PATH_TO_ZEBRA'} = $zebra_path;
+ print qq(
+Found 'zebrasrv' and 'zebraidx' in $zebra_path.
+);
+ } else {
+ print q(
+Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
+in your PATH or in some of the usual places. If you haven't
+installed Zebra yet, please do so and run Makefile.PL again.
+
+);
+ }
+
+ $msg = q(
+You must specify the primary MARC format of the
records to be indexed by Zebra.
-Koha provides Zebra configuration files for MARC 21
-and UNIMARC.
+Koha provides Zebra configuration files for MARC21,
+NORMARC and UNIMARC.
-Please specify the MARC format);
- $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
- $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values);
- $msg = q(
+MARC format for Zebra indexing);
+ $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
+ $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
+ $msg = q(
Koha supplies Zebra configuration files tuned for
searching either English (en) or French (fr) MARC
records.
-Please specify the primary language of the MARC records);
- $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
- $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values);
+Primary language for Zebra indexing);
+ $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
+ $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Zebra has two methods to perform records tokenization
+and characters normalization: CHR and ICU. ICU is
+recommended for catalogs containing non-Latin
+characters.);
+
+ $msg .= _add_valid_values_disp('ZEBRA_TOKENIZER', $valid_values);
+ $config{'ZEBRA_TOKENIZER'} = _get_value('ZEBRA_TOKENIZER', $msg, $defaults->{'ZEBRA_TOKENIZER'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify Zebra database user);
+ $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify the Zebra database password);
+ $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Since you've chosen to use Zebra, you can enable the SRU/
+Z39.50 Server if you so choose, but you must specify a
+few configuration options for it.
+
+Please note that if you choose *NOT* to configure SRU,
+koha-conf.xml will still contain some references to SRU
+settings. Those references will be ignored by Koha.
+
+Install the SRU configuration files?);
+ $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
+ $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
+
+ if ($config{'INSTALL_SRU'} eq 'yes') {
+ $msg = q(
+Since you've chosen to configure SRU, you must
+specify the host and port(s) that the SRU
+Servers (bibliographic and authority) should run on.
+);
+ $msg = q(
+SRU Database host?);
+ $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
+
+ $msg = q(
+SRU port for bibliographic data?);
+ $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
+
+ $msg = q(
+SRU port for authority data?);
+ $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
+
}
+
+ $msg = q(
+Along with Zebra, you can also choose to install PazPar2,
+which is a metasearch tool. With PazPar2,
+Koha can perform on-the-fly merging of bibliographic
+records during searching, allowing for FRBRization of
+the results list.
+
+Install the PazPar2 configuration files?);
+ $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
+ $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
+
+ if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
+ $msg = q(
+Since you've chosen to configure PazPar2, you must
+specify the host and port(s) that PazPar2
+uses:
+);
+ $msg = q(
+Zebra bibliographic server host?);
+ $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Zebra bibliographic port for PazPar2 to use?);
+ $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
+
+ $msg = q(
+PazPar2 host?);
+ $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
+
+ $msg = q(
+PazPar2 port?);
+ $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
+
+ }
+
+ $msg = q(
+Use memcached to cache the results of some function calls?
+This provides a significant performance improvement.
+You will need a Memcached server running.);
+ $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
+ $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
+ if ($config{'USE_MEMCACHED'} eq 'yes'){
+ $msg = q(
+Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
+);
+ $msg = q(
+Memcached server address?);
+ $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Memcached namespace?);
+ $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
+ }
+
+
+ $msg = q(
+Use Elasticsearch to serve search results?
+You will need a Elasticsearch server running.);
+ $msg .= _add_valid_values_disp('USE_ELASTICSEARCH', $valid_values);
+ $config{'USE_ELASTICSEARCH'} = _get_value('USE_ELASTICSEARCH', $msg, $defaults->{'USE_ELASTICSEARCH'}, $valid_values, $install_log_values);
+ if ($config{'USE_ELASTICSEARCH'} eq 'yes'){
+ $msg = q(
+Define the ELASTICSEARCH_SERVERS with a comma-separated list. Eg
+localhost:9200, 192.168.0.100:9200
+);
+ $msg = q(
+Elasticsearch server addresses?);
+ $config{'ELASTICSEARCH_SERVERS'} = _get_value('ELASTICSEARCH_SERVERS', $msg, $defaults->{'ELASTICSEARCH_SERVERS'}, $valid_values, $install_log_values);
+
+ $msg = q(
+What index name to use for this Koha-instance? It must be unique for each Koha
+sharing the same Elasticsearch-cluster
+
+Elasticsearch index?);
+ $config{'ELASTICSEARCH_INDEX'} = _get_value('ELASTICSEARCH_INDEX', $msg, $defaults->{'ELASTICSEARCH_INDEX'}, $valid_values, $install_log_values);
+ }
+
+ $msg = q(
+Template cache directory?);
+ $config{'TEMPLATE_CACHE_DIR'} = _get_value('TEMPLATE_CACHE_DIR', $msg, $defaults->{'TEMPLATE_CACHE_DIR'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Path to DejaVu fonts?);
+ $config{'FONT_DIR'} = _get_value('FONT_DIR', $msg, $defaults->{'FONT_DIR'}, $valid_values, $install_log_values);
+
+
+ $msg = q(
+Would you like to run the database-dependent test suite?);
+ $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
+ $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
+
+ if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
+ $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
+ $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
+ $msg = q(TEST DATABASE
+
+THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
+testing. Please don't do this on your production database. It is not
+reversible.
+
+YOU WILL SUFFER DATA LOSS if you run this test suite on your test
+database. You are better off not running this optional test suite than
+doing it in a database that you don't want to lose.
+
+Please specify the name of the test database to be
+used by Koha);
+
+ $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
+ while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
+ $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
+ $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
+ }
+
+ $msg = q(
+Please specify the user that owns the database to be
+used by Koha);
+ $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
+
+ $msg = q(
+Please specify the password of the user that owns the
+database to be used by Koha);
+ $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
+ }
+
+ print "\n\n";
+
+ # add version number
+ my $version = "no_version_found";
+ eval {
+ require 'kohaversion.pl';
+ $version = kohaversion();
+ };
+ $config{'KOHA_INSTALLED_VERSION'} = $version;
+
return %config;
}
sub _add_valid_values_disp {
my $key = shift;
my $valid_values = shift;
-
+
my $disp = "";
if (exists $valid_values->{$key}) {
$disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
my $msg = shift;
my $default = shift;
my $valid_values = shift;
+ my $install_log_values = shift;
+
+ # take value from install log if present
+ if (exists $install_log_values{$key}) {
+ $install_log_values{$key} =~ s/\$/\$\$/g;
+ return $install_log_values{$key};
+ }
+
+ # override default value from environment
+ if (exists $ENV{$key}) {
+ $default = $ENV{$key};
+ $msg .= " (default from environment)";
+ }
my $val = prompt($msg, $default);
- while (exists $valid_values->{$key} and not exists $valid_values->{$key}->{$val}) {
+
+ while (exists $valid_values->{$key} and
+ $val ne $default and
+ not exists $valid_values->{$key}->{$val}) {
my $retry_msg = "Value '$val' is not a valid option.\n";
$retry_msg .= "Please enter a value";
$retry_msg .= _add_valid_values_disp($key, $valid_values);
$val = prompt($retry_msg, $default);
}
+ $val =~ s/\$/\$\$/g;
return $val;
}
-=head2 get_target_directories
+=head2 get_target_directories
Creates a hash mapping from symbols for installation target
directories to actual directory paths.
+Also returns a hash indicating targets for which
+files need not be copied -- this is used for the 'dev'
+mode installation, where some files are installed in place.
+
=cut
sub get_target_directories {
# get last component of install base directory
# to treat as package name
my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
+
my @basedir = File::Spec->splitdir($directories);
+
+ if ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
+
my $package = pop @basedir;
+
my %dirmap = ();
+ my %skipdirs = ();
if ($mode eq 'single') {
+ $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
$dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
- $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'templates');
- $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'www');
+ $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
+ $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
$dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
- $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'templates');
- $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'www');
+ $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
+ $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
$dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
$dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
$dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
- $dirmap{'EXAMPLE_DIR'} = File::Spec->catdir(@basedir, $package, 'example');
+ $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'z3950');
+ $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
+ $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
$dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
+ $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
$dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
$dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
$dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
+ $dirmap{'LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock');
$dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
+ $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
+ $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins');
$dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
$dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
} elsif ($mode eq 'dev') {
my $curdir = File::Spec->rel2abs(File::Spec->curdir());
+ $dirmap{'API_CGI_DIR'} = File::Spec->catdir($curdir, 'api');
+ $skipdirs{'API_CGI_DIR'} = 1;
$dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
+ $skipdirs{'INTRANET_CGI_DIR'} = 1;
$dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
- $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
- $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir, 'opac');
+ $skipdirs{'INTRANET_TMPL_DIR'} = 1;
+ $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
+ $skipdirs{'INTRANET_WWW_DIR'} = 1;
+ $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
+ $skipdirs{'OPAC_CGI_DIR'} = 1;
$dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
- $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
+ $skipdirs{'OPAC_TMPL_DIR'} = 1;
+ $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
+ $skipdirs{'OPAC_WWW_DIR'} = 1;
$dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
+ $skipdirs{'PERL_MODULE_DIR'} = 1;
$dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
$dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
- $dirmap{'EXAMPLE_DIR'} = File::Spec->catdir(@basedir, $package, 'example');
+ $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'z3950');
+ $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
+ $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
$dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
+ #For dev install, point NONDEV_DIR to misc in current dir (not base)
+ #Used by supportdir in koha-conf.xml (BZ 12031)
+ $dirmap{'SCRIPT_NONDEV_DIR'} = File::Spec->catdir($curdir, 'misc');
+ $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
$dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
$dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
$dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
+ $dirmap{'LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock');
$dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
+ $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool');
+ $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins');
$dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
$dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
} else {
# mode is standard, i.e., 'fhs'
+ $dirmap{'API_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'api');
$dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
- $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'templates');
- $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'www');
+ $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
+ $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
$dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
- $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'templates');
- $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'www');
+ $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
+ $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
$dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
$dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
$dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
- $dirmap{'EXAMPLE_DIR'} = File::Spec->catdir(@basedir, $package, 'example');
+ $dirmap{'Z3950_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'z3950');
+ $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
+ $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
$dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
+ $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
$dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
$dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
$dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
+ $dirmap{'LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package);
$dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
+ $dirmap{'BACKUP_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package);
+ $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins');
$dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
$dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
}
- foreach my $key (sort keys %dirmap) {
- print sprintf("%-25.25s%s\n", $key, $dirmap{$key});
+ _get_env_overrides(\%dirmap);
+ _get_argv_overrides(\%dirmap);
+ _add_destdir(\%dirmap);
+
+ return \%dirmap, \%skipdirs;
+}
+
+=head2 get_test_dir
+
+Map a directory target to the corresponding path for
+the test suite.
+
+=cut
+
+sub get_test_dir {
+ my ($dirname) = @_;
+
+ my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
+ if (exists $test_suite_override_dirs{$dirname}) {
+ return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
+ } else {
+ return;
+ }
+
+}
+
+sub _get_env_overrides {
+ my $dirmap = shift;
+
+ foreach my $key (keys %$dirmap) {
+ if (exists $ENV{$key}) {
+ $dirmap->{$key} = $ENV{$key};
+ print "Setting $key from environment\n";
+ }
+ }
+}
+
+sub _get_argv_overrides {
+ my $dirmap = shift;
+
+ my @new_argv = ();
+ for (my $i = 0; $i <= $#ARGV; $i++) {
+ if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
+ $dirmap->{$1} = $2;
+ } else {
+ push @new_argv, $ARGV[$i];
+ }
+ }
+ @ARGV = @new_argv;
+}
+
+sub _strip_destdir {
+ my $dir = shift;
+ $dir =~ s/^\$\(DESTDIR\)//;
+ return $dir;
+}
+
+sub _add_destdir {
+ my $dirmap = shift;
+
+ foreach my $key (keys %$dirmap) {
+ $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
+ }
+}
+
+sub display_configuration {
+ my $config = shift;
+ my $dirmap = shift;
+ my @version = grep /\/usr\/share\/perl\//, @INC;
+ push @version, ('/usr/share/perl/5.10') if !$version[0];
+ print "\n\nKoha will be installed with the following configuration parameters:\n\n";
+ foreach my $key (sort keys %$config) {
+ print sprintf("%-25.25s%s\n", $key, $config->{$key});
+ }
+
+ print "\nand in the following directories:\n\n";
+ foreach my $key (sort keys %$dirmap) {
+ print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
}
- return %dirmap;
+ print "\n\nTo change any configuration setting, please run\n";
+ print "perl Makefile.PL again. To override one of the target\n";
+ print "directories, you can do so on the command line like this:\n";
+ print "\nperl Makefile.PL PERL_MODULE_DIR=$version[0]\n\n";
+ print "You can also set different default values for parameters\n";
+ print "or override directory locations by using environment variables.\n";
+ print "\nFor example:\n\n";
+ print "export DB_USER=my_koha\n";
+ print "perl Makefile.PL\n";
+ print "\nor\n\n";
+ print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
+}
+
+=head2 find_zebra
+
+Attempt to find Zebra - check user's PATH and
+a few other directories for zebrasrv and zebraidx.
+
+=cut
+
+sub find_zebra {
+ my @search_dirs = map {
+ my $abs = File::Spec->rel2abs($_);
+ my ($toss, $directories);
+ ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
+ $directories;
+ } split /:/, $ENV{PATH};
+ push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
+ my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
+ return unless @zebrasrv_dirs;
+ # verify that directory that contains zebrasrv also contains zebraidx
+ foreach my $dir (@zebrasrv_dirs) {
+ return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
+ }
+ return;
}
package MY;
+
+sub test {
+ my $self = shift;
+ my $test = $self->SUPER::test(@_);
+ $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
+
+ # set KOHA_CONF
+ $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
+ return $test;
+}
+
sub install {
my $self = shift;
- my $install = "";
+ my $install = "";
# NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
# This means that we're completely overriding EU::MM's default
# installation and uninstallation targets.
- foreach my $key (sort keys %target_directories) {
- $install .= qq(
+
+# If installation is on Win32, we need to do permissions different from *nix
+ if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
+ foreach my $key (sort keys %$target_directories) {
+ $install .= qq(
KOHA_INST_$key = blib/$key
-KOHA_DEST_$key = $target_directories{$key}
+KOHA_DEST_$key = $target_directories->{$key}
+) unless exists $skip_directories->{$key};
+ }
+ $install .= qq(
+install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
+\t\$(NOECHO) \$(NOOP)
);
+ $install .= "install_koha ::\n";
+ $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
+ foreach my $key (sort keys %$target_directories) {
+ $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
+ unless exists $skip_directories->{$key};
+ }
+ $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
+ $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
+
+ $install .= "\n";
+ $install .= "set_koha_ownership ::\n";
+# Do not try to change ownership if DESTDIR is set
+ if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
+ foreach my $key (sort keys %$target_directories) {
+ $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
+ unless exists $skip_directories->{$key};
+ }
+ } else {
+ $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
+ }
+
+ $install .= "\n";
+ $install .= "set_koha_permissions ::\n";
+ # This is necessary because EU::MM installs files
+ # as either 0444 or 0555, and we want the owner
+ # of Koha's files to have write permission by default.
+ foreach my $key (sort keys %$target_directories) {
+ $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
+ unless exists $skip_directories->{$key};
+ }
+ }
+
+ $install .= "\n";
+
+ $install .= "warn_koha_env_vars ::\n";
+ $install .= "\t\$(NOECHO) \$(ECHO)\n";
+ $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
+ $install .= "\t\$(NOECHO) \$(ECHO)\n";
+ $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
+ $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
+ $install .= "\t\$(NOECHO) \$(ECHO)\n";
+ $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
+ $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
+ $install .= "\t\$(NOECHO) \$(ECHO)\n";
+ $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
+ $install .= "\t\$(NOECHO) \$(ECHO)\n";
+
+ $install .= _update_zebra_conf_target();
+
+ $install .= upgrade();
+
+ return $install;
+}
+
+=head2 _update_zebra_conf_target
+
+Add an installation target for updating
+Zebra's configuration files.
+
+=cut
+
+sub _update_zebra_conf_target {
+
+ my $target = "\nupdate_zebra_conf ::\n";
+ $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
+ $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
+ $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n";
+ $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
+ $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
+ $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n";
+
+ return $target;
+}
+
+sub upgrade {
+ my $upgrade = "";
+
+ my $backup_suffix;
+ if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
+ my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
+ $version =~ s/\./_/g;
+ $backup_suffix = "_koha_$version";
+ } else {
+ $backup_suffix = "_upgrade_backup";
}
- $install .= qq(
-install :: all install_koha
+ $upgrade .= qq/
+MOD_BACKUP = \$(ABSPERLRUN) -MC4::Installer::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
+
+upgrade :: make_upgrade_backup install
\t\$(NOECHO) \$(NOOP)
-);
- $install .= "install_koha ::\n";
- $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
- foreach my $key (sort keys %target_directories) {
- $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n";
+make_upgrade_backup ::
+\t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
+/;
+ foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
+ PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) {
+ $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
+ unless exists $skip_directories->{$key} or
+ not exists $target_directories->{$key};
}
- $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
- $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
- return $install;
-}
+ $upgrade =~ s/\\\n$/\n/;
+ return $upgrade;
+}
sub postamble {
# put directory mappings into Makefile
# so that Make will export as environment
# variables -- this is for the use of
# rewrite-confg.PL
- my $env = join("\n", map { "export __${_}__ = $target_directories{$_}" } keys %target_directories);
+
+ my $env;
+ # Hereagain, we must alter syntax per platform...
+ {
+ $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
+ $env .= "\n\n";
+ $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
+ }
+
return "$env\n";
}
+
__END__
=head1 AUTHORS
MJ Ray mjr at phonecoop.coop
+Galen Charlton galen.charlton at liblime.com
=cut
-FIXME: deal with files that have spaces in names
-FIXME: Zebra lang/MARC mapping
+
FIXME: deal with .htaccess
projects / koha-equinox.git / blobdiff