Bug 7818: update installer for biblio DOM indexing

Adds the necessary bits to enable DOM indexing for bib
records as an option during installation from source.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
Signed-off-by: Paul Poulain <paul.poulain@biblibre.com>
Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
This commit is contained in:
Galen Charlton 2012-03-23 18:52:27 -04:00 committed by Chris Cormack
parent 0b497da9a6
commit 84bf354eea
9 changed files with 266 additions and 4 deletions

View File

@ -409,6 +409,7 @@ my %config_defaults = (
'INSTALL_SRU' => 'yes',
'INSTALL_PAZPAR2' => 'no',
'AUTH_INDEX_MODE' => 'dom',
'BIB_INDEX_MODE' => 'dom',
'ZEBRA_MARC_FORMAT' => 'marc21',
'ZEBRA_LANGUAGE' => 'en',
'ZEBRA_TOKENIZER' => 'chr',
@ -461,6 +462,7 @@ my %valid_config_values = (
'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
'BIB_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1, 'nb' => 1 }, # FIXME should generate from contents of distribution
'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
@ -502,12 +504,15 @@ if ($config{'INSTALL_ZEBRA'} eq "yes") {
push @{ $pl_files->{'rewrite-config.PL'} }, (
'blib/ZEBRA_CONF_DIR/etc/passwd',
'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.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/retrieval-info-auth-grs1.xml',
'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
'blib/ZEBRA_CONF_DIR/retrieval-info-bib-grs1.xml',
'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
);
push @{ $pl_files->{'rewrite-config.PL'} }, (
'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
@ -521,8 +526,11 @@ if ($config{'INSTALL_ZEBRA'} eq "yes") {
);
}
$config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
$config{'ZEBRA_BIB_CFG'} = $config{'BIB_INDEX_MODE'} eq 'dom' ? 'zebra-biblios-dom.cfg' : 'zebra-biblios.cfg';
$config{'AUTH_RETRIEVAL_CFG'} =
$config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
$config{'BIB_RETRIEVAL_CFG'} =
$config{'BIB_INDEX_MODE'} eq 'dom' ? 'retrieval-info-bib-dom.xml' : 'retrieval-info-bib-grs1.xml';
}
if ($config{'INSTALL_MODE'} ne "dev") {
@ -941,6 +949,20 @@ 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(
Koha can use one of two different indexing modes
for the MARC bibliographic records:
grs1 - uses the Zebra GRS-1 filter, available
for legacy support
dom - uses the DOM XML filter; offers improved
functionality.
Bibliographic indexing mode);
$msg .= _add_valid_values_disp('BIB_INDEX_MODE', $valid_values);
$config{'BIB_INDEX_MODE'} = _get_value('BIB_INDEX_MODE', $msg, $defaults->{'BIB_INDEX_MODE'}, $valid_values, $install_log_values);
$msg = q(
Koha can use one of two different indexing modes
for the MARC authorities records:

View File

@ -27,7 +27,7 @@ __PAZPAR2_TOGGLE_XML_PRE__
<listen id="mergeserver">tcp:@:__MERGE_SERVER_PORT__</listen>
<server id="mergeserver" listenref="mergeserver">
<directory>__ZEBRA_DATA_DIR__/biblios</directory>
<config>__ZEBRA_CONF_DIR__/zebra-biblios.cfg</config>
<config>__ZEBRA_CONF_DIR__/__ZEBRA_BIB_CFG__</config>
<cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
</server>
__PAZPAR2_TOGGLE_XML_POST__
@ -35,11 +35,14 @@ __PAZPAR2_TOGGLE_XML_POST__
<!-- BIBLIOGRAPHIC RECORDS -->
<server id="biblioserver" listenref="biblioserver">
<directory>__ZEBRA_DATA_DIR__/biblios</directory>
<config>__ZEBRA_CONF_DIR__/zebra-biblios.cfg</config>
<config>__ZEBRA_CONF_DIR__/__ZEBRA_BIB_CFG__</config>
<cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
<!-- <docpath>xsl</docpath> -->
<!-- <stylesheet>xsl/default.xsl</stylesheet> -->
<!-- <maximumrecordsize>2000000</maximumrecordsize> -->
<xi:include href="__KOHA_CONF_DIR__/zebradb/__BIB_RETRIEVAL_CFG__"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:fallback>
<retrievalinfo>
<retrieval syntax="usmarc" name="F"/>
<retrieval syntax="usmarc" name="B"/>
@ -88,6 +91,8 @@ __PAZPAR2_TOGGLE_XML_POST__
</backend>
</retrieval>
</retrievalinfo>
</xi:fallback>
</xi:include>
<xi:include href="__KOHA_CONF_DIR__/zebradb/explain-biblios.xml"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:fallback>
@ -182,8 +187,11 @@ __PAZPAR2_TOGGLE_XML_POST__
<!--
<server id="publicserver" listenref="publicserver">
<directory>__ZEBRA_DATA_DIR__/biblios</directory>
<config>__ZEBRA_CONF_DIR__/zebra-biblios.cfg</config>
<config>__ZEBRA_CONF_DIR__/__ZEBRA_BIB_CFG__</config>
<cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
<xi:include href="__KOHA_CONF_DIR__/zebradb/__AUTH_RETRIEVAL_CFG__"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:fallback>
<retrievalinfo>
<retrieval syntax="usmarc" name="F"/>
<retrieval syntax="usmarc" name="B"/>
@ -232,6 +240,8 @@ __PAZPAR2_TOGGLE_XML_POST__
</backend>
</retrieval>
</retrievalinfo>
</xi:fallback>
</xi:include>
<xi:include href="__KOHA_CONF_DIR__/zebradb/explain-biblios.xml"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:fallback>

View File

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
$Id: dom-config.xml,v 1.1 2007-12-13 17:42:28 adam Exp $
Copyright (C) 1995-2006
Index Data ApS
This file is part of the Zebra server.
Zebra 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, or (at your option) any later
version.
Zebra 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 Zebra; see the file LICENSE.zebra. If not, write to the
Free Software Foundation, 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301 USA.
-->
<!--
Bibliographic DOM config for MARC ISO2709 input
-->
<dom>
<extract name="index">
<xslt stylesheet="biblio-zebra-indexdefs.xsl"/>
</extract>
<retrieve name="F">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="usmarc">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="marc">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="marcxml">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="zebra">
<xslt stylesheet="zebra.xsl"/>
</retrieve>
<retrieve name="index">
<xslt stylesheet="biblio-zebra-indexdefs.xsl"/>
</retrieve>
<input>
<marc inputcharset="utf-8"/>
</input>
</dom>

View File

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
$Id: dom-config.xml,v 1.1 2007-12-13 17:42:28 adam Exp $
Copyright (C) 1995-2006
Index Data ApS
This file is part of the Zebra server.
Zebra 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, or (at your option) any later
version.
Zebra 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 Zebra; see the file LICENSE.zebra. If not, write to the
Free Software Foundation, 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301 USA.
-->
<!--
Bibliographic DOM config for MARC XML input
-->
<dom>
<extract name="index">
<xslt stylesheet="biblio-zebra-indexdefs.xsl"/>
</extract>
<retrieve name="F">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="usmarc">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="marc">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="marcxml">
<xslt stylesheet="identity.xsl" />
</retrieve>
<retrieve name="zebra">
<xslt stylesheet="zebra.xsl"/>
</retrieve>
<retrieve name="index">
<xslt stylesheet="biblio-zebra-indexdefs.xsl"/>
</retrieve>
<input>
<xmlreader level="0"/>
</input>
</dom>

View File

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<retrievalinfo xmlns="http://indexdata.com/yaz">
<retrieval syntax="usmarc" name="F">
<backend syntax="xml" name="marc">
<marc inputformat="xml" outputformat="marc"
inputcharset="utf-8"
outputcharset="utf-8"/>
</backend>
</retrieval>
<retrieval syntax="usmarc" name="B">
<backend syntax="xml" name="marc">
<marc inputformat="xml" outputformat="marc"
inputcharset="utf-8"
outputcharset="utf-8"/>
</backend>
</retrieval>
<retrieval syntax="xml" name="index"/> <!-- allow viewing index entries -->
<retrieval syntax="xml" name="marc"
identifier="info:srw/schema/1/marcxml-v1.1"/>
<retrieval syntax="xml" name="marcxml"
identifier="info:srw/schema/1/marcxml-v1.1"/>
</retrievalinfo>

View File

@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<retrievalinfo xmlns="http://indexdata.com/yaz">
<retrieval syntax="usmarc" name="F"/>
<retrieval syntax="usmarc" name="B"/>
<retrieval syntax="xml" name="marcxml"
identifier="info:srw/schema/1/marcxml-v1.1">
<backend syntax="usmarc" name="F">
<marc inputformat="marc" outputformat="marcxml"
inputcharset="utf-8"/>
</backend>
</retrieval>
<retrieval syntax="xml" name="dc">
<backend syntax="usmarc" name="F">
<marc inputformat="marc" outputformat="marcxml"
inputcharset="utf-8"/>
<xslt stylesheet="__INTRANET_TMPL_DIR__/prog/en/xslt/MARC21slim2DC.xsl"/>
</backend>
</retrieval>
<retrieval syntax="xml" name="mods">
<backend syntax="usmarc" name="F">
<marc inputformat="marc" outputformat="marcxml"
inputcharset="utf-8"/>
<xslt stylesheet="__INTRANET_TMPL_DIR__/prog/en/xslt/MARC21slim2MODS.xsl"/>
</backend>
</retrieval>
<retrieval syntax="xml" name="rdfdc">
<backend syntax="usmarc" name="F">
<marc inputformat="marc" outputformat="marcxml"
inputcharset="utf-8"/>
<xslt stylesheet="__INTRANET_TMPL_DIR__/prog/en/xslt/MARC21slim2RDFDC.xsl"/>
</backend>
</retrieval>
<retrieval syntax="xml" name="utils">
<backend syntax="usmarc" name="F">
<marc inputformat="marc" outputformat="marcxml"
inputcharset="utf-8"/>
<xslt stylesheet="__INTRANET_TMPL_DIR__/prog/en/xslt/MARC21slimUtils.xsl"/>
</backend>
</retrieval>
</retrievalinfo>

View File

@ -0,0 +1,55 @@
# Simple Zebra configuration file that defines
# a database with MARCXML records.
# $Id: zebra.cfg,v 1.1.2.2 2006/05/09 12:03:16 rangi Exp $
#
# Where are the config files located?
profilePath:__ZEBRA_CONF_DIR__/biblios/etc:__ZEBRA_CONF_DIR__/etc:__ZEBRA_CONF_DIR__/marc_defs/__ZEBRA_MARC_FORMAT__/biblios:__ZEBRA_CONF_DIR__/lang_defs/__ZEBRA_LANGUAGE__:__ZEBRA_CONF_DIR__/xsl
# modulePath - where to look for loadable zebra modules
modulePath: /usr/lib/idzebra-2.0/modules
encoding: UTF-8
# Files that describe the attribute sets supported.
attset: bib1.att
attset: explain.att
attset: gils.att
# systag sysno rank
# Specify record type
# group .recordType[ .name ]: type
# type is split into fundamental type. file-read-type . argument
# http://www.indexdata.dk/zebra/doc/zebra-cfg.tkl
# http://www.indexdata.dk/zebra/doc/grs.tkl
recordtype: dom.__ZEBRA_CONF_DIR__/biblios/etc/dom-config.xml
marcxml.recordtype: dom.__ZEBRA_CONF_DIR__/biblios/etc/dom-config.xml
iso2709.recordtype: dom.__ZEBRA_CONF_DIR__/biblios/etc/dom-config-marc.xml
recordId: (bib1,Local-number)
storeKeys:1
storeData:1
# Lock File Area
lockDir: __ZEBRA_LOCK_DIR__/biblios
perm.anonymous:ar
perm.__ZEBRA_USER__:rw
passwd: __ZEBRA_CONF_DIR__/etc/passwd
register: __ZEBRA_DATA_DIR__/biblios/register:20G
shadow: __ZEBRA_DATA_DIR__/biblios/shadow:20G
# Temp File area for result sets
setTmpDir: __ZEBRA_DATA_DIR__/biblios/tmp
# Temp File area for index program
keyTmpDir: __ZEBRA_DATA_DIR__/biblios/key
# Approx. Memory usage during indexing
memMax: 50M
rank:rank-1
truncmax: 1000000000
# Specifies the maximum number of records that will be sorted in a result set.
# If the result set contains more than that limit, the records after the limit
# will not be sorted. If omitted, the default value is 1,000.
sortmax: 1000

View File

@ -44,7 +44,9 @@ ZEBRA_RUN_DIR=__ZEBRA_RUN_DIR__
ZEBRA_MARC_FORMAT=__ZEBRA_MARC_FORMAT__
ZEBRA_LANGUAGE=__ZEBRA_LANGUAGE__
ZEBRA_AUTH_CFG=__ZEBRA_AUTH_CFG__
ZEBRA_BIB_CFG=__ZEBRA_BIB_CFG__
AUTH_RETRIEVAL_CFG=__AUTH_RETRIEVAL_CFG__
BIB_RETRIEVAL_CFG=__BIB_RETRIEVAL_CFG__
MERGE_SERVER_HOST=__MERGE_SERVER_HOST__
MERGE_SERVER_PORT=__MERGE_SERVER_PORT__
PAZPAR2_HOST=__PAZPAR2_HOST__
@ -54,7 +56,7 @@ INSTALL_BASE=__INSTALL_BASE__
INSTALL_ZEBRA=__INSTALL_ZEBRA__
INSTALL_SRU=__INSTALL_SRU__
INSTALL_PAZPAR2=__INSTALL_PAZPAR2__
AUTH_INDEX_MODE=__AUTH_INDEX_MODE__
BIB_INDEX_MODE=__BIB_INDEX_MODE__
RUN_DATABASE_TESTS=__RUN_DATABASE_TESTS__
PATH_TO_ZEBRA=__PATH_TO_ZEBRA__
USE_MEMCACHED=__USE_MEMCACHED__

View File

@ -122,7 +122,9 @@ $prefix = $ENV{'INSTALL_BASE'} || "/usr";
'__ZEBRA_LANGUAGE__' => 'en',
'__ZEBRA_TOKENIZER_STMT__' => 'charmap word-phrase-utf.chr',
'__ZEBRA_AUTH_CFG__' => 'zebra-authorities.cfg',
'__ZEBRA_BIB_CFG__' => 'zebra-biblios.cfg',
'__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-grs1.xml',
'__BIB_RETRIEVAL_CFG__' => 'retrieval-info-bib-grs1.xml',
"__MERGE_SERVER_HOST__" => $myhost,
"__MERGE_SERVER_PORT__" => '11001',
"__PAZPAR2_HOST__" => $myhost,
@ -135,6 +137,7 @@ $prefix = $ENV{'INSTALL_BASE'} || "/usr";
"__PAZPAR2_TOGGLE_XML_PRE__" => '<!--',
"__PAZPAR2_TOGGLE_XML_POST__" => '-->',
"__AUTH_INDEX_MODE__" => 'grs1',
"__BIB_INDEX_MODE__" => 'grs1',
"__RUN_DATABASE_TESTS__" => 'no',
"__PATH_TO_ZEBRA__" => "",
"__USE_MEMCACHED__" => 'no',