Open-ILS/src/perlmods/OpenILS/Application/Cat/Authority.pm

   1 package OpenILS::Application::Cat::Authority;
   2 use strict; use warnings;
   3 use base qw/OpenILS::Application/;
   4 use OpenILS::Utils::CStoreEditor q/:funcs/;
   5 use OpenILS::Application::Cat::AuthCommon;
   6 use OpenSRF::Utils::Logger qw($logger);
   7 use OpenILS::Application::AppUtils;
   8 use OpenILS::Utils::Fieldmapper;
   9 use OpenILS::Const qw/:const/;
  10 use OpenILS::Event;
  11 my $U = 'OpenILS::Application::AppUtils';
  12 my $MARC_NAMESPACE = 'http://www.loc.gov/MARC21/slim';
  13
  14
  15 # generate a MARC XML document from a MARC XML string
  16 sub marc_xml_to_doc {
  17         my $xml = shift;
  18         my $marc_doc = XML::LibXML->new->parse_string($xml);
  19         $marc_doc->documentElement->setNamespace($MARC_NAMESPACE, 'marc', 1);
  20         $marc_doc->documentElement->setNamespace($MARC_NAMESPACE);
  21         return $marc_doc;
  22 }
  23
  24
  25 __PACKAGE__->register_method(
  26         method  => 'import_authority_record',
  27         api_name        => 'open-ils.cat.authority.record.import',
  28 );
  29
  30 sub import_authority_record {
  31     my($self, $conn, $auth, $marc_xml, $source) = @_;
  32         my $e = new_editor(authtoken=>$auth, xact=>1);
  33         return $e->die_event unless $e->checkauth;
  34         return $e->die_event unless $e->allowed('CREATE_AUTHORITY_RECORD');
  35     my $rec = OpenILS::Application::Cat::AuthCommon->import_authority_record($marc_xml, $source);
  36     $e->commit unless $U->event_code($rec);
  37     return $rec;
  38 }
  39
  40 __PACKAGE__->register_method(
  41     method => 'create_authority_record_from_bib_field',
  42     api_name => 'open-ils.cat.authority.record.create_from_bib',
  43     signature => {
  44         desc => q/Create an authority record entry from a field in a bibliographic record/,
  45         params => q/
  46             @param field A hash representing the field to control, consisting of: { tag: string, ind1: string, ind2: string, subfields: [ [code, value] ... ] }
  47             @param authtoken A valid authentication token
  48             @returns The new record object
  49  /}
  50 );
  51
  52 __PACKAGE__->register_method(
  53     method => 'create_authority_record_from_bib_field',
  54     api_name => 'open-ils.cat.authority.record.create_from_bib.readonly',
  55     signature => {
  56         desc => q/Creates MARCXML for an authority record entry from a field in a bibliographic record/,
  57         params => q/
  58             @param field A hash representing the field to control, consisting of: { tag: string, ind1: string, ind2: string, subfields: [ [code, value] ... ] }
  59             @returns The MARCXML for the authority record
  60  /}
  61 );
  62
  63 sub create_authority_record_from_bib_field {
  64     my($self, $conn, $field, $auth) = @_;
  65
  66     # Change the first character of the incoming bib field tag to a '1'
  67     # for use in our authority record; close enough for now?
  68     my $tag = $field->{'tag'};
  69     $tag =~ s/^./1/;
  70
  71     my $ind1 = $field->{ind1} || ' ';
  72     my $ind2 = $field->{ind2} || ' ';
  73
  74     my $control = qq{<datafield tag="$tag" ind1="$ind1" ind2="$ind2">};
  75     foreach my $sf (@{$field->{subfields}}) {
  76         my $code = $sf->[0];
  77         my $val = $U->entityize($sf->[1]);
  78         $control .= qq{<subfield code="$code">$val</subfield>};
  79     }
  80     $control .= '</datafield>';
  81
  82     # ARN, or "authority record number", used to need to be unique across the database.
  83     # Of course, we have no idea what's in the database, and if the
  84     # cat.maintain_control_numbers flag is set to "TRUE" then the 001 will
  85     # be reset to the record ID anyway.
  86     my $arn = 'AUTOGEN-' . time();
  87
  88     # Placeholder MARCXML;
  89     #   001/003 can be filled in via database triggers
  90     #   005 will be filled in automatically at creation time
  91     #   008 needs to be set by a cataloguer (could be some OU settings, I suppose)
  92     #   040 should come from OU settings / OU shortname
  93     #
  94     my $marc_xml = <<MARCXML;
  95 <record xmlns:marc="http://www.loc.gov/MARC21/slim" xmlns="http://www.loc.gov/MARC21/slim"><leader>     nz  a22     o  4500</leader>
  96 <controlfield tag="001">$arn</controlfield>
  97 <controlfield tag="003">CONS</controlfield>
  98 <controlfield tag="008">      ||||||||||||||||||||||||||||||||||</controlfield>
  99 <datafield tag="040" ind1=" " ind2=" "><subfield code="a">CONS</subfield><subfield code="c">CONS</subfield></datafield>
 100 $control
 101 </record>
 102 MARCXML
 103
 104     if ($self->api_name =~ m/readonly$/) {
 105         return $marc_xml;
 106     } else {
 107         my $e = new_editor(authtoken=>$auth, xact=>1);
 108         return $e->die_event unless $e->checkauth;
 109         return $e->die_event unless $e->allowed('CREATE_AUTHORITY_RECORD');
 110         my $rec = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $marc_xml);
 111         $e->commit unless $U->event_code($rec);
 112         return $rec;
 113     }
 114 }
 115
 116 __PACKAGE__->register_method(
 117         method  => 'overlay_authority_record',
 118         api_name        => 'open-ils.cat.authority.record.overlay',
 119 );
 120
 121 sub overlay_authority_record {
 122     my($self, $conn, $auth, $rec_id, $marc_xml, $source) = @_;
 123         my $e = new_editor(authtoken=>$auth, xact=>1);
 124         return $e->die_event unless $e->checkauth;
 125         return $e->die_event unless $e->allowed('UPDATE_AUTHORITY_RECORD');
 126     my $rec = OpenILS::Application::Cat::AuthCommon->overlay_authority_record($rec_id, $marc_xml, $source);
 127     $e->commit unless $U->event_code($rec);
 128     return $rec;
 129
 130 }
 131
 132 __PACKAGE__->register_method(
 133         method  => 'retrieve_authority_record',
 134         api_name        => 'open-ils.cat.authority.record.retrieve',
 135     signature => {
 136         desc => q/Retrieve an authority record entry/,
 137         params => [
 138             {desc => q/hash of options.  Options include "clear_marc" which clears
 139                 the MARC xml from the record before it is returned/}
 140         ]
 141     }
 142 );
 143 sub retrieve_authority_record {
 144     my($self, $conn, $auth, $rec_id, $options) = @_;
 145         my $e = new_editor(authtoken=>$auth);
 146         return $e->die_event unless $e->checkauth;
 147     my $rec = $e->retrieve_authority_record($rec_id) or return $e->event;
 148     $rec->clear_marc if $$options{clear_marc};
 149     return $rec;
 150 }
 151
 152 __PACKAGE__->register_method(
 153         method  => 'batch_retrieve_authority_record',
 154         api_name        => 'open-ils.cat.authority.record.batch.retrieve',
 155     stream => 1,
 156     signature => {
 157         desc => q/Retrieve a set of authority record entry objects/,
 158         params => [
 159             {desc => q/hash of options.  Options include "clear_marc" which clears
 160                 the MARC xml from the record before it is returned/}
 161         ]
 162     }
 163 );
 164 sub batch_retrieve_authority_record {
 165     my($self, $conn, $auth, $rec_id_list, $options) = @_;
 166         my $e = new_editor(authtoken=>$auth);
 167         return $e->die_event unless $e->checkauth;
 168     for my $rec_id (@$rec_id_list) {
 169         my $rec = $e->retrieve_authority_record($rec_id) or return $e->event;
 170         $rec->clear_marc if $$options{clear_marc};
 171         $conn->respond($rec);
 172     }
 173     return undef;
 174 }
 175
 176 __PACKAGE__->register_method(
 177     method    => 'count_linked_bibs',
 178     api_name  => 'open-ils.cat.authority.records.count_linked_bibs',
 179     signature => q/
 180         Counts the number of bib records linked to each authority record in the input list
 181         @param records Array of authority records to return counts
 182         @return A list of hashes containing the authority record ID ("id") and linked bib count ("bibs")
 183     /
 184 );
 185
 186 sub count_linked_bibs {
 187     my( $self, $conn, $records ) = @_;
 188
 189     my $editor = new_editor();
 190
 191     my $link_count;
 192     my @clean_records;
 193     for my $auth ( @$records ) {
 194         # Protection against SQL injection? Might be overkill.
 195         my $intauth = int($auth);
 196         if ($intauth) {
 197             push(@clean_records, $intauth);
 198         }
 199     }
 200     return $link_count if !@clean_records;
 201
 202     $link_count = $editor->json_query({
 203         "select" => {
 204             "abl" => [
 205                 {
 206                     "column" => "authority"
 207                 },
 208                 {
 209                     "alias" => "bibs",
 210                     "transform" => "count",
 211                     "column" => "bib",
 212                     "aggregate" => 1
 213                 }
 214             ]
 215         },
 216         "from" => "abl",
 217         "where" => { "authority" => \@clean_records }
 218     });
 219
 220     return $link_count;
 221 }
 222
 223 1;