[open-ils-commits] r16899 - in trunk/Open-ILS/src/sql/Pg: . upgrade (dbs)
svn at svn.open-ils.org
svn at svn.open-ils.org
Fri Jul 9 11:42:57 EDT 2010
Author: dbs
Date: 2010-07-09 11:42:54 -0400 (Fri, 09 Jul 2010)
New Revision: 16899
Added:
trunk/Open-ILS/src/sql/Pg/upgrade/0329.schema.maintain_control_numbers.sql
Modified:
trunk/Open-ILS/src/sql/Pg/002.functions.config.sql
trunk/Open-ILS/src/sql/Pg/002.schema.config.sql
trunk/Open-ILS/src/sql/Pg/010.schema.biblio.sql
trunk/Open-ILS/src/sql/Pg/011.schema.authority.sql
trunk/Open-ILS/src/sql/Pg/210.schema.serials.sql
trunk/Open-ILS/src/sql/Pg/950.data.seed-values.sql
Log:
New feature: maintain control numbers (001, 003, 035) for MARC records
If a site wishes to maintain their control numbers and control number
identifiers in authority, bibliographic, and MFHD MARC records according
to the MARC21 specification, they will now be able to:
1. Enable the global flag 'cat.maintain_control_numbers' to turn on
control number maintenance. This is disabled by default, so no changes
will be made by the system until the flag is enabled.
2. (Optionally) Set the cat.marc_control_number_identifier OU setting
to override the control number identifier for records owned by that OU;
if this is not set, then the control number identifier defaults to the
OU shortname.
3. Set the owner field for the records that are to be controlled; otherwise
they will fall back to the global default which is currently hardcoded as
'EVRGRN'.
Modified: trunk/Open-ILS/src/sql/Pg/002.functions.config.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/002.functions.config.sql 2010-07-09 15:00:16 UTC (rev 16898)
+++ trunk/Open-ILS/src/sql/Pg/002.functions.config.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -468,5 +468,125 @@
END;
$func$ LANGUAGE PLPGSQL;
+CREATE OR REPLACE FUNCTION maintain_control_numbers() RETURNS TRIGGER AS $func$
+use strict;
+use MARC::Record;
+use MARC::File::XML;
+use Encode;
+
+my $record = MARC::Record->new_from_xml($_TD->{new}{marc});
+my $schema = $_TD->{table_schema};
+my $rec_id = $_TD->{new}{id};
+
+# Short-circuit if maintaining control numbers per MARC21 spec is not enabled
+my $enable = spi_exec_query("SELECT enabled FROM config.global_flag WHERE name = 'cat.maintain_control_numbers'");
+if (!($enable->{processed}) or $enable->{rows}[0]->{enabled} eq 'f') {
+ return;
+}
+
+# Get the control number identifier from an OU setting based on $_TD->{new}{owner}
+my $ou_cni = 'EVRGRN';
+
+# bre.owner can be null, so fall back to the consortial setting
+my $owner = $_TD->{new}{owner} || 1;
+
+my $ous_rv = spi_exec_query("SELECT value FROM actor.org_unit_ancestor_setting('cat.marc_control_number_identifier', $owner)");
+if ($ous_rv->{processed}) {
+ $ou_cni = $ous_rv->{rows}[0]->{value};
+ $ou_cni =~ s/"//g; # Stupid VIM syntax highlighting"
+} else {
+ # Fall back to the shortname of the OU if there was no OU setting
+ $ous_rv = spi_exec_query("SELECT shortname FROM actor.org_unit WHERE id = $owner");
+ if ($ous_rv->{processed}) {
+ $ou_cni = $ous_rv->{rows}[0]->{shortname};
+ }
+}
+
+my ($create, $munge) = (0, 0);
+my ($orig_001, $orig_003) = ('', '');
+
+# Incoming MARC records may have multiple 001s or 003s, despite the spec
+my @control_ids = $record->field('003');
+my @scns = $record->field('035');
+
+foreach my $id_field ('001', '003') {
+ my $spec_value;
+ my @controls = $record->field($id_field);
+
+ if ($id_field eq '001') {
+ $spec_value = $rec_id;
+ } else {
+ $spec_value = $ou_cni;
+ }
+
+ # Create the 001/003 if none exist
+ if (scalar(@controls) == 0) {
+ $record->insert_fields_ordered(MARC::Field->new($id_field, $spec_value));
+ $create = 1;
+ } elsif (scalar(@controls) > 1) {
+ # Do we already have the right 001/003 value in the existing set?
+ unless (grep $_->data() eq $spec_value, @controls) {
+ $munge = 1;
+ }
+
+ # Delete the other fields, as with more than 1 001/003 we do not know which 003/001 to match
+ foreach my $control (@controls) {
+ unless ($control->data() eq $spec_value) {
+ $record->delete_field($control);
+ }
+ }
+ } else {
+ # Only one field; check to see if we need to munge it
+ unless (grep $_->data() eq $spec_value, @controls) {
+ $munge = 1;
+ }
+ }
+}
+
+# Now, if we need to munge the 001, we will first push the existing 001/003 into the 035
+if ($munge) {
+ my $scn = "(" . $record->field('003')->data() . ")" . $record->field('001')->data();
+
+ # Do not create duplicate 035 fields
+ unless (grep $_->subfield('a') eq $scn, @scns) {
+ $record->insert_fields_ordered(MARC::Field->new('035', '', '', 'a' => $scn));
+ }
+}
+
+# Set the 001/003 and update the MARC
+if ($create or $munge) {
+ $record->field('001')->data($rec_id);
+ $record->field('003')->data($ou_cni);
+
+ my $xml = $record->as_xml_record();
+ $xml =~ s/\n//sgo;
+ $xml =~ s/^<\?xml.+\?\s*>//go;
+ $xml =~ s/>\s+</></go;
+ $xml =~ s/\p{Cc}//go;
+
+ # Embed a version of OpenILS::Application::AppUtils->entityize()
+ # to avoid having to set PERL5LIB for PostgreSQL as well
+
+ # If we are going to convert non-ASCII characters to XML entities,
+ # we had better be dealing with a UTF8 string to begin with
+ $xml = decode_utf8($xml);
+
+ $xml = NFC($xml);
+
+ # Convert raw ampersands to entities
+ $xml =~ s/&(?!\S+;)/&/gso;
+
+ # Convert Unicode characters to entities
+ $xml =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
+
+ $xml =~ s/[\x00-\x1f]//go;
+ $_TD->{new}{marc} = $xml;
+
+ return "MODIFY";
+}
+
+return;
+$func$ LANGUAGE PLPERLU;
+
COMMIT;
Modified: trunk/Open-ILS/src/sql/Pg/002.schema.config.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/002.schema.config.sql 2010-07-09 15:00:16 UTC (rev 16898)
+++ trunk/Open-ILS/src/sql/Pg/002.schema.config.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -68,7 +68,7 @@
install_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
);
-INSERT INTO config.upgrade_log (version) VALUES ('0328'); -- phasefx
+INSERT INTO config.upgrade_log (version) VALUES ('0329'); -- dbs
CREATE TABLE config.bib_source (
id SERIAL PRIMARY KEY,
Modified: trunk/Open-ILS/src/sql/Pg/010.schema.biblio.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/010.schema.biblio.sql 2010-07-09 15:00:16 UTC (rev 16898)
+++ trunk/Open-ILS/src/sql/Pg/010.schema.biblio.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -63,6 +63,7 @@
CREATE UNIQUE INDEX biblio_record_unique_tcn ON biblio.record_entry (tcn_value) WHERE deleted = FALSE OR deleted IS FALSE;
CREATE TRIGGER a_marcxml_is_well_formed BEFORE INSERT OR UPDATE ON biblio.record_entry FOR EACH ROW EXECUTE PROCEDURE biblio.check_marcxml_well_formed();
CREATE TRIGGER b_maintain_901 BEFORE INSERT OR UPDATE ON biblio.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_901();
+CREATE TRIGGER c_maintain_control_numbers BEFORE INSERT OR UPDATE ON biblio.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_control_numbers();
CREATE TABLE biblio.record_note (
id BIGSERIAL PRIMARY KEY,
Modified: trunk/Open-ILS/src/sql/Pg/011.schema.authority.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/011.schema.authority.sql 2010-07-09 15:00:16 UTC (rev 16898)
+++ trunk/Open-ILS/src/sql/Pg/011.schema.authority.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -32,13 +32,15 @@
deleted BOOL NOT NULL DEFAULT FALSE,
source INT,
marc TEXT NOT NULL,
- last_xact_id TEXT NOT NULL
+ last_xact_id TEXT NOT NULL,
+ owner INT
);
CREATE INDEX authority_record_entry_creator_idx ON authority.record_entry ( creator );
CREATE INDEX authority_record_entry_editor_idx ON authority.record_entry ( editor );
CREATE UNIQUE INDEX authority_record_unique_tcn ON authority.record_entry (arn_source,arn_value) WHERE deleted = FALSE OR deleted IS FALSE;
CREATE TRIGGER a_marcxml_is_well_formed BEFORE INSERT OR UPDATE ON authority.record_entry FOR EACH ROW EXECUTE PROCEDURE biblio.check_marcxml_well_formed();
CREATE TRIGGER b_maintain_901 BEFORE INSERT OR UPDATE ON authority.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_901();
+CREATE TRIGGER c_maintain_control_numbers BEFORE INSERT OR UPDATE ON authority.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_control_numbers();
CREATE TABLE authority.bib_linking (
id BIGSERIAL PRIMARY KEY,
Modified: trunk/Open-ILS/src/sql/Pg/210.schema.serials.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/210.schema.serials.sql 2010-07-09 15:00:16 UTC (rev 16898)
+++ trunk/Open-ILS/src/sql/Pg/210.schema.serials.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -18,12 +18,14 @@
active BOOL NOT NULL DEFAULT TRUE,
deleted BOOL NOT NULL DEFAULT FALSE,
marc TEXT,
- last_xact_id TEXT NOT NULL
+ last_xact_id TEXT NOT NULL,
+ owner INT
);
CREATE INDEX serial_record_entry_creator_idx ON serial.record_entry ( creator );
CREATE INDEX serial_record_entry_editor_idx ON serial.record_entry ( editor );
CREATE INDEX serial_record_entry_owning_lib_idx ON serial.record_entry ( owning_lib, deleted );
CREATE TRIGGER b_maintain_901 BEFORE INSERT OR UPDATE ON serial.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_901();
+CREATE TRIGGER c_maintain_control_numbers BEFORE INSERT OR UPDATE ON serial.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_control_numbers();
CREATE RULE protect_mfhd_delete AS ON DELETE TO serial.record_entry DO INSTEAD UPDATE serial.record_entry SET deleted = true WHERE old.id = serial.record_entry.id;
Modified: trunk/Open-ILS/src/sql/Pg/950.data.seed-values.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/950.data.seed-values.sql 2010-07-09 15:00:16 UTC (rev 16898)
+++ trunk/Open-ILS/src/sql/Pg/950.data.seed-values.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -5764,6 +5764,17 @@
TRUE
);
+INSERT INTO config.global_flag (name, label) -- defaults to enabled=FALSE
+ VALUES (
+ 'cat.maintain_control_numbers',
+ oils_i18n_gettext(
+ 'cat.maintain_control_numbers',
+ 'Cat: Maintain 001/003/035 according to the MARC21 specification',
+ 'cgf',
+ 'label'
+ )
+ );
+
INSERT INTO config.usr_setting_type (name,opac_visible,label,description,datatype)
VALUES (
'history.circ.retention_age',
@@ -5809,6 +5820,21 @@
'interval'
);
+INSERT INTO config.org_unit_setting_type ( name, label, description, datatype ) VALUES (
+ 'cat.marc_control_number_identifier',
+ oils_i18n_gettext(
+ 'cat.marc_control_number_identifier',
+ 'Cat: Defines the control number identifier used in 003 and 035 fields.',
+ 'coust',
+ 'label'),
+ oils_i18n_gettext(
+ 'cat.marc_control_number_identifier',
+ 'Cat: Defines the control number identifier used in 003 and 035 fields.',
+ 'coust',
+ 'description'),
+ 'string'
+);
+
-- 0311.data.query-seed-datatypes.sql
-- Define the most common datatypes in query.datatype. Note that none of
-- these stock datatypes specifies a width or precision.
Added: trunk/Open-ILS/src/sql/Pg/upgrade/0329.schema.maintain_control_numbers.sql
===================================================================
--- trunk/Open-ILS/src/sql/Pg/upgrade/0329.schema.maintain_control_numbers.sql (rev 0)
+++ trunk/Open-ILS/src/sql/Pg/upgrade/0329.schema.maintain_control_numbers.sql 2010-07-09 15:42:54 UTC (rev 16899)
@@ -0,0 +1,158 @@
+BEGIN;
+
+INSERT INTO config.upgrade_log (version) VALUES ('0329'); -- dbs
+
+ALTER TABLE authority.record_entry ADD COLUMN owner INT;
+ALTER TABLE serial.record_entry ADD COLUMN owner INT;
+
+INSERT INTO config.global_flag (name, label) -- defaults to enabled=FALSE
+ VALUES (
+ 'cat.maintain_control_numbers',
+ oils_i18n_gettext(
+ 'cat.maintain_control_numbers',
+ 'Cat: Maintain 001/003/035 according to the MARC21 specification',
+ 'cgf',
+ 'label'
+ )
+ );
+
+INSERT INTO config.org_unit_setting_type ( name, label, description, datatype ) VALUES (
+ 'cat.marc_control_number_identifier',
+ oils_i18n_gettext(
+ 'cat.marc_control_number_identifier',
+ 'Cat: Defines the control number identifier used in 003 and 035 fields.',
+ 'coust',
+ 'label'),
+ oils_i18n_gettext(
+ 'cat.marc_control_number_identifier',
+ 'Cat: Defines the control number identifier used in 003 and 035 fields.',
+ 'coust',
+ 'description'),
+ 'string'
+);
+
+CREATE OR REPLACE FUNCTION maintain_control_numbers() RETURNS TRIGGER AS $func$
+use strict;
+use MARC::Record;
+use MARC::File::XML;
+use Encode;
+
+my $record = MARC::Record->new_from_xml($_TD->{new}{marc});
+my $schema = $_TD->{table_schema};
+my $rec_id = $_TD->{new}{id};
+
+# Short-circuit if maintaining control numbers per MARC21 spec is not enabled
+my $enable = spi_exec_query("SELECT enabled FROM config.global_flag WHERE name = 'cat.maintain_control_numbers'");
+if (!($enable->{processed}) or $enable->{rows}[0]->{enabled} eq 'f') {
+ return;
+}
+
+# Get the control number identifier from an OU setting based on $_TD->{new}{owner}
+my $ou_cni = 'EVRGRN';
+
+# bre.owner can be null, so fall back to the consortial setting
+my $owner = $_TD->{new}{owner} || 1;
+
+my $ous_rv = spi_exec_query("SELECT value FROM actor.org_unit_ancestor_setting('cat.marc_control_number_identifier', $owner)");
+if ($ous_rv->{processed}) {
+ $ou_cni = $ous_rv->{rows}[0]->{value};
+ $ou_cni =~ s/"//g; # Stupid VIM syntax highlighting"
+} else {
+ # Fall back to the shortname of the OU if there was no OU setting
+ $ous_rv = spi_exec_query("SELECT shortname FROM actor.org_unit WHERE id = $owner");
+ if ($ous_rv->{processed}) {
+ $ou_cni = $ous_rv->{rows}[0]->{shortname};
+ }
+}
+
+my ($create, $munge) = (0, 0);
+my ($orig_001, $orig_003) = ('', '');
+
+# Incoming MARC records may have multiple 001s or 003s, despite the spec
+my @control_ids = $record->field('003');
+my @scns = $record->field('035');
+
+foreach my $id_field ('001', '003') {
+ my $spec_value;
+ my @controls = $record->field($id_field);
+
+ if ($id_field eq '001') {
+ $spec_value = $rec_id;
+ } else {
+ $spec_value = $ou_cni;
+ }
+
+ # Create the 001/003 if none exist
+ if (scalar(@controls) == 0) {
+ $record->insert_fields_ordered(MARC::Field->new($id_field, $spec_value));
+ $create = 1;
+ } elsif (scalar(@controls) > 1) {
+ # Do we already have the right 001/003 value in the existing set?
+ unless (grep $_->data() eq $spec_value, @controls) {
+ $munge = 1;
+ }
+
+ # Delete the other fields, as with more than 1 001/003 we do not know which 003/001 to match
+ foreach my $control (@controls) {
+ unless ($control->data() eq $spec_value) {
+ $record->delete_field($control);
+ }
+ }
+ } else {
+ # Only one field; check to see if we need to munge it
+ unless (grep $_->data() eq $spec_value, @controls) {
+ $munge = 1;
+ }
+ }
+}
+
+# Now, if we need to munge the 001, we will first push the existing 001/003 into the 035
+if ($munge) {
+ my $scn = "(" . $record->field('003')->data() . ")" . $record->field('001')->data();
+
+ # Do not create duplicate 035 fields
+ unless (grep $_->subfield('a') eq $scn, @scns) {
+ $record->insert_fields_ordered(MARC::Field->new('035', '', '', 'a' => $scn));
+ }
+}
+
+# Set the 001/003 and update the MARC
+if ($create or $munge) {
+ $record->field('001')->data($rec_id);
+ $record->field('003')->data($ou_cni);
+
+ my $xml = $record->as_xml_record();
+ $xml =~ s/\n//sgo;
+ $xml =~ s/^<\?xml.+\?\s*>//go;
+ $xml =~ s/>\s+</></go;
+ $xml =~ s/\p{Cc}//go;
+
+ # Embed a version of OpenILS::Application::AppUtils->entityize()
+ # to avoid having to set PERL5LIB for PostgreSQL as well
+
+ # If we are going to convert non-ASCII characters to XML entities,
+ # we had better be dealing with a UTF8 string to begin with
+ $xml = decode_utf8($xml);
+
+ $xml = NFC($xml);
+
+ # Convert raw ampersands to entities
+ $xml =~ s/&(?!\S+;)/&/gso;
+
+ # Convert Unicode characters to entities
+ $xml =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
+
+ $xml =~ s/[\x00-\x1f]//go;
+ $_TD->{new}{marc} = $xml;
+
+ return "MODIFY";
+}
+
+return;
+$func$ LANGUAGE PLPERLU;
+
+CREATE TRIGGER c_maintain_control_numbers BEFORE INSERT OR UPDATE ON authority.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_control_numbers();
+CREATE TRIGGER c_maintain_control_numbers BEFORE INSERT OR UPDATE ON biblio.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_control_numbers();
+CREATE TRIGGER c_maintain_control_numbers BEFORE INSERT OR UPDATE ON serial.record_entry FOR EACH ROW EXECUTE PROCEDURE maintain_control_numbers();
+
+COMMIT;
More information about the open-ils-commits
mailing list