X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=Makefile.PL;h=06a38263f70f5c4636b842c95ef161a6fb13f822;hb=4b04de209aa25816f5d97c05ce71ea9619027484;hp=01122e4848bb0ff11acf365d9043f1aee7a193cd;hpb=5d6cc9c3a3e7d3e9ee2065e580df51d60fd7e50f;p=koha.git diff --git a/Makefile.PL b/Makefile.PL index 01122e4848..06a38263f7 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -24,6 +24,7 @@ use warnings; use ExtUtils::MakeMaker; use POSIX; use File::Spec; +use Getopt::Long; my $DEBUG = 0; die "perl 5.6.1 or later required" unless ($] >= 5.006001); @@ -41,14 +42,25 @@ Makefile.PL - Koha packager and installer =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 @@ -185,7 +197,14 @@ 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 @@ -201,6 +220,10 @@ command-line, e.g., READMEs. Directory for Apache and Zebra logs produced by Koha. +=item PAZPAR2_CONF_DIR + +Directory for PazPar2 configuration files. + =item NONE This is a dummy target used to explicitly state @@ -227,13 +250,15 @@ my $target_map = { './changelanguage.pl' => 'INTRANET_CGI_DIR', './check_sysprefs.pl' => 'NONE', './circ' => 'INTRANET_CGI_DIR', + './offline_circ' => 'INTRANET_CGI_DIR', './edithelp.pl' => 'INTRANET_CGI_DIR', './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 }, './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 }, + './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 }, './help.pl' => 'INTRANET_CGI_DIR', './installer-CPAN.pl' => 'NONE', './installer' => 'INTRANET_CGI_DIR', - './koha-tmpl/errors' => {target => 'INTRANET_CGI_DIR', trimdir => 2}, + './errors' => {target => 'INTRANET_CGI_DIR'}, './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1}, './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1}, './kohaversion.pl' => 'INTRANET_CGI_DIR', @@ -242,10 +267,11 @@ my $target_map = { './Makefile.PL' => 'NONE', './MANIFEST.SKIP' => 'NONE', './members' => 'INTRANET_CGI_DIR', - './misc' => { target => 'SCRIPT_DIR', trimdir => -1 }, + './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', './README.txt' => 'NONE', @@ -254,7 +280,6 @@ my $target_map = { './reviews' => 'INTRANET_CGI_DIR', './rewrite-config.PL' => 'NONE', './reviews' => 'INTRANET_CGI_DIR', - './rss' => 'MISC_DIR', './serials' => 'INTRANET_CGI_DIR', './skel' => 'NONE', './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 }, @@ -273,6 +298,7 @@ my $target_map = { './suggestion' => 'INTRANET_CGI_DIR', './svc' => 'INTRANET_CGI_DIR', './t' => '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 @@ -370,6 +396,8 @@ my %config_defaults = ( 'DB_PASS' => 'katikoan', 'INSTALL_ZEBRA' => 'yes', 'INSTALL_SRU' => 'yes', + 'INSTALL_PAZPAR2' => 'no', + 'AUTH_INDEX_MODE' => 'grs1', 'ZEBRA_MARC_FORMAT' => 'marc21', 'ZEBRA_LANGUAGE' => 'en', 'ZEBRA_USER' => 'kohauser', @@ -379,9 +407,15 @@ my %config_defaults = ( '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' => '', ); -# set some default configuratio options based on OS +# set some default configuration options based on OS # more conditions need to be added for other OS's # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion() # to allow for more granular decisions based on which Win32 platform @@ -411,11 +445,25 @@ my %valid_config_values = ( 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 }, 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 }, 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 }, + 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 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 + 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 }, +); + +# get settings from command-line +my $koha_install_log = ""; +Getopt::Long::Configure('pass_through'); +my $results = GetOptions( + "prev-install-log=s" => \$koha_install_log ); -my %config = get_configuration(\%config_defaults, \%valid_config_values); +my %install_log_values = (); +if ($koha_install_log ne "") { + get_install_log_values($koha_install_log, \%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 = {}; @@ -424,7 +472,8 @@ get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" my $pl_files = { 'rewrite-config.PL' => [ 'blib/KOHA_CONF_DIR/koha-conf.xml', - 'blib/KOHA_CONF_DIR/koha-httpd.conf' + 'blib/KOHA_CONF_DIR/koha-httpd.conf', + 'blib/MISC_DIR/koha-install-log' ], 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on... 'blib' @@ -436,109 +485,141 @@ if ($config{'INSTALL_ZEBRA'} eq "yes") { 'blib/ZEBRA_CONF_DIR/etc/passwd', 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg', 'blib/ZEBRA_CONF_DIR/zebra-authorities.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/explain-biblios.xml', + 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml', + 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-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-zebraqueue-ctl.sh', ); - if ($config{'INSTALL_MODE'} ne 'dev') { + if ($config{'INSTALL_PAZPAR2'} eq 'yes') { push @{ $pl_files->{'rewrite-config.PL'} }, ( - 'blib/SCRIPT_DIR/koha-zebra-ctl.sh', - 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh', + 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml', + 'blib/PAZPAR2_CONF_DIR/pazpar2.xml' ); } + $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg'; + $config{'AUTH_RETRIEVAL_CFG'} = + $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml'; } if ($config{'INSTALL_MODE'} ne "dev") { push @{ $pl_files->{'rewrite-config.PL'} }, ( 'blib/PERL_MODULE_DIR/C4/Context.pm', - 'blib/SCRIPT_DIR/kohalib.pl' + 'blib/SCRIPT_NONDEV_DIR/kohalib.pl' ); } +my %test_suite_override_dirs = ( + KOHA_CONF_DIR => ['etc'], + ZEBRA_CONF_DIR => ['etc', 'zebradb'], + LOG_DIR => ['var', 'log'], + 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 Developers ', - NO_META => 1, - PREREQ_PM => { -# awaiting package maintainer's use of $VERSION -#'Algorithm::CheckDigits' => 0.48, -#'Algorithm::CheckDigits::M43_001' => 0.48, -'Biblio::EndnoteStyle' => 0.05, -'CGI' => 3.15, -'CGI::Carp' => 1.29, -'CGI::Session' => '4.10', -'Class::Factory::Util' => 1.6, -'Class::Accessor' => 0.30, -'DBD::mysql' => 4.004, -'DBI' => 1.53, -'Data::ICal' => 0.13, -'Data::Dumper' => 2.121_08, -'Date::Calc' => 5.4, -'Date::ICal' => 1.72, -'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, -'List::MoreUtils' => 0.21, -'Locale::Language' => 2.07, -'MARC::Charset' => 0.98, -'MARC::Crosswalk::DublinCore' => 0.02, -'MARC::File::XML' => 0.88, -'MARC::Record' => 2.00, -'MIME::Base64' => 3.07, -'MIME::QuotedPrint' => 3.07, -'Mail::Sendmail' => 0.79, -'Net::LDAP' => 0.33, -'Net::LDAP::Filter' => 0.14, -'Net::Z3950::ZOOM' => 1.16, -'PDF::API2' => 2.000, -'PDF::API2::Page' => 2.000, -'PDF::API2::Util' => 2.000, -'PDF::Reuse' => 0.33, -'PDF::Reuse::Barcode' => 0.05, -'POE' => 0.9999, -'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::Iconv' => 1.7, -'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::LibXSLT' => 1.59, -'XML::SAX::ParserFactory' => 1.01, -'XML::Simple' => 2.14, -'XML::RSS' => 1.31, -'YAML::Syck' => 0.71, - }, - - # 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'), - - PL_FILES => $pl_files, - + NAME => 'koha', + VERSION => '3.00.05', + #VERSION_FROM => 'kohaversion.pl', + ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC', + AUTHOR => 'Koha Developers ', + NO_META => 1, + PREREQ_PM => { + 'Algorithm::CheckDigits' => 0.50, + 'Biblio::EndnoteStyle' => 0.05, + 'CGI' => 3.15, + 'CGI::Carp' => 1.29, + 'CGI::Session' => 4.20, + 'CGI::Session::Serialize::yaml' => 4.20, + 'Class::Factory::Util' => 1.6, + 'Class::Accessor' => 0.30, + 'DBD::mysql' => 4.004, + 'DBI' => 1.53, + 'Data::Dumper' => 2.121, + 'Data::ICal' => 0.13, + 'Date::Calc' => 5.4, + 'Date::ICal' => 1.72, + 'Date::Manip' => 5.44, + 'Digest::MD5' => 2.36, + 'Digest::SHA' => 5.43, + 'Email::Date' => 1.103, + 'File::Temp' => 0.16, + 'GD' => 2.39, #optional + 'GD::Barcode::UPCE' => 1.1, + 'Getopt::Long' => 2.35, + 'Getopt::Std' => 1.05, + 'HTML::Template::Pro' => 0.69, + 'HTML::Scrubber' => 0.08, + 'HTTP::Cookies' => 1.39, + 'HTTP::OAI' => 3.20, + 'HTTP::Request::Common' => 1.26, + 'IPC::Cmd' => 0.46, + 'JSON' => 2.07, # Needed by admin/item_circulation_alerts.pl + 'LWP::Simple' => 1.41, + 'LWP::UserAgent' => 2.033, + 'Lingua::Stem' => 0.82, + 'List::Util' => 1.18, + 'List::MoreUtils' => 0.21, + 'Locale::Language' => 2.07, + 'MARC::Charset' => 0.98, + 'MARC::Crosswalk::DublinCore' => 0.02, + 'MARC::File::XML' => 0.88, + 'MARC::Record' => 2.00, + 'MIME::Base64' => 3.07, + 'MIME::Lite' => 3.00, + 'MIME::QuotedPrint' => 3.07, + 'Mail::Sendmail' => 0.79, + 'Net::LDAP' => 0.33, # optional + 'Net::LDAP::Filter' => 0.14, # optional + 'Net::Z3950::ZOOM' => 1.16, + 'PDF::API2' => 2.000, + 'PDF::API2::Page' => 2.000, + 'PDF::API2::Util' => 2.000, + 'PDF::Reuse' => 0.33, + 'PDF::Reuse::Barcode' => 0.05, + 'POE' => 0.9999, + 'POSIX' => 1.09, + 'Schedule::At' => 1.06, + 'SMS::Send' => 0.05, # optional + '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::CSV::Encoded' => 0.09, + 'Text::Iconv' => 1.7, + 'Text::Wrap' => 2005.082401, + 'Time::HiRes' => 1.86, + 'Time::localtime' => 1.02, + 'Unicode::Normalize' => 0.32, + 'URI::Escape' => 1.36, + 'XML::Dumper' => 0.81, + 'XML::LibXML' => 1.59, + 'XML::LibXSLT' => 1.59, + 'XML::SAX::ParserFactory' => 1.01, + 'XML::SAX::Writer' => 0.44, + 'XML::Simple' => 2.14, + 'XML::RSS' => 1.31, + 'YAML::Syck' => 0.71, + }, + + # 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 @@ -683,6 +764,38 @@ sub _add_to_file_map { } } +=head2 get_install_log_values + +Reads value from the Koha install log specified by +--prev-install-log + +=cut + +sub get_install_log_values { + my $install_log = shift; + my $values = shift; + + open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n"; + while () { + 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 This prompts the user for various configuration options. @@ -692,6 +805,7 @@ 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( @@ -716,7 +830,7 @@ dev: Create a set of symbolic links and configuration files to 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 @@ -754,7 +868,7 @@ 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; @@ -776,7 +890,7 @@ 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); + $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 @@ -785,7 +899,7 @@ 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); + $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values); } $msg = q( @@ -796,7 +910,7 @@ PostgreSQL support is highly experimental. 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); + $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values); $msg = q( Please specify the name or address of your @@ -806,28 +920,28 @@ 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); + $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); + $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); + $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $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); + $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); + $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values); $msg = q( Koha can use the Zebra search engine for high-performance @@ -842,9 +956,24 @@ settings. Those references will be ignored by Koha. 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); + $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values); if ($config{'INSTALL_ZEBRA'} eq 'yes') { + + 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( Since you've chosen to use Zebra with Koha, you must specify the primary MARC format of the @@ -855,7 +984,7 @@ and UNIMARC. 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); + $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 @@ -863,15 +992,28 @@ records. 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); - + $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values); + + $msg = q( +Koha can use one of two different indexing modes +for the MARC authorities records: + +grs1 - uses the Zebra GRS-1 filter, available + for legacy support +dom - uses the DOM XML filter; offers improved + functionality. + +Authorities indexing mode); + $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values); + $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $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); + $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); + $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/ @@ -884,7 +1026,7 @@ 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); + $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values); if ($config{'INSTALL_SRU'} eq 'yes') { $msg = q( @@ -894,20 +1036,102 @@ 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); + $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); + $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); + $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values); + + } + + $msg = q( +Since you've chosen to use 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( +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 +reversable. + +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; } @@ -927,6 +1151,12 @@ sub _get_value { 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}) { + return $install_log_values{$key}; + } # override default value from environment if (exists $ENV{$key}) { @@ -989,8 +1219,10 @@ sub get_target_directories { $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{'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'); @@ -1015,9 +1247,11 @@ sub get_target_directories { $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{'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'); - $skipdirs{'SCRIPT_DIR'} = 1; + $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'}; + $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'); @@ -1035,8 +1269,10 @@ sub get_target_directories { $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{'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'); @@ -1047,10 +1283,30 @@ sub get_target_directories { _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; @@ -1076,6 +1332,20 @@ sub _get_argv_overrides { @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; @@ -1099,6 +1369,34 @@ sub display_configuration { print "perl Makefile.PL\n"; print "\nor\n\n"; print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n"; + print "If installing on a Win32 platform, be sure to use:\n"; + print "'dmake -x MAXLINELENGTH=300000'\n\n"; +} + +=head2 find_zebra + +Attempt to find Zebra - check user's PATH and +a few other directories for zebrasrv and zebraidx. + +FIXME: doesn't handle Win32 + +=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; @@ -1123,7 +1421,7 @@ sub install { # installation and uninstallation targets. # If installation is on Win32, we need to do permissions different from *nix - if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly + 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 @@ -1145,9 +1443,10 @@ install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_en $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) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n" + $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n" unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key}; } } else { @@ -1196,9 +1495,6 @@ install :: all install_koha warn_koha_env_vars $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) If installing on a Win32 platform, be sure to use:\n"; - $install .= "\t\$(NOECHO) \$(ECHO) 'dmake -x MAXLINELENGTH=300000'\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"; @@ -1206,10 +1502,12 @@ install :: all install_koha warn_koha_env_vars $install .= _update_zebra_conf_target(); } + $install .= upgrade(); + return $install; } -=head 2 _update_zebra_conf_target +=head2 _update_zebra_conf_target Add an installation target for updating Zebra's configuration files. @@ -1219,12 +1517,48 @@ Zebra's configuration files. sub _update_zebra_conf_target { my $target = "\nupdate_zebra_conf ::\n"; - $target .= "\tumask 022; \$(MOD_INSTALL) \\\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" unless $^O eq "MSWin32"; + $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" unless $^O eq "MSWin32"; 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"; + } + + $upgrade .= qq/ +MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' -- + +upgrade :: make_upgrade_backup install +\t\$(NOECHO) \$(NOOP) +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/) { + $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" + unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or + exists $skip_directories->{$key} or + not exists $target_directories->{$key}; + } + $upgrade =~ s/\\\n$/\n/; + + return $upgrade; +} + sub postamble { # put directory mappings into Makefile # so that Make will export as environment @@ -1238,20 +1572,44 @@ sub postamble { $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g; } + my $env; # Hereagain, we must alter syntax per platform... if ( $^O eq 'MSWin32' ) { # NOTE: it is imperative that there be no whitespaces in ENV=value... - my $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories); + $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories); $env .= "\n\n"; $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config); - return "$env\n"; } else { - my $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories); + $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories); $env .= "\n\n"; $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config); - return "$env\n"; } + + if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) { + if ( open( my $confhandle, '>', 't/test-config.txt' ) ) { + print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n"; + print $confhandle "# It is generated by the top-level Makefile.PL.\n"; + print $confhandle "# It is separate from the standard koha-conf.xml so that you can edit this by hand and test with different configurations.\n"; + + # these directories will be relocated to the 't' directory + foreach my $dirname ( keys %$target_directories ) { + my $dir = main::_strip_destdir( $target_directories->{$dirname} ); + if ( exists $test_suite_override_dirs{$dirname} ) { + $dir = main::get_test_dir($dirname); + } + print $confhandle "$dirname = $dir\n" + } + print $confhandle "\n"; + + print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n"; + close( $confhandle ); + } else { + warn 'unable to open conf file for database dependent tests: $!'; + } + + } + return "$env\n"; }