Line 0
Link Here
|
|
|
1 |
#!/usr/bin/perl |
2 |
package Koha::DublinCore; |
3 |
|
4 |
# |
5 |
# This file is part of Koha. |
6 |
# |
7 |
# Copyright (C) 2014 Universidad de El Salvador, |
8 |
# Facultad Multidisciplinaria Oriental |
9 |
# |
10 |
# Koha is free software; you can redistribute it and/or modify it |
11 |
# under the terms of the GNU General Public License as published by |
12 |
# the Free Software Foundation; either version 3 of the License, or |
13 |
# (at your option) any later version. |
14 |
# |
15 |
# Koha is distributed in the hope that it will be useful, but |
16 |
# WITHOUT ANY WARRANTY; without even the implied warranty of |
17 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
18 |
# GNU General Public License for more details. |
19 |
# |
20 |
# You should have received a copy of the GNU General Public License |
21 |
# along with Koha; if not, see <http://www.gnu.org/licenses>. |
22 |
# |
23 |
|
24 |
use Modern::Perl; |
25 |
use strict; |
26 |
use warnings::register; |
27 |
use utf8; |
28 |
use version; |
29 |
|
30 |
BEGIN { |
31 |
require Exporter; |
32 |
|
33 |
# set the version for version checking |
34 |
our $VERSION = version->declare("v0.01"); |
35 |
|
36 |
# Inherit from Exporter to export functions and variables |
37 |
our @ISA = qw(Exporter); |
38 |
|
39 |
# Functions and variables which are exported by default |
40 |
our @EXPORT = qw(new get_xml_data get_rdf_data write_xml write_rdf); |
41 |
|
42 |
# Functions and variables which can be optionally exported |
43 |
our @EXPORT_OK = |
44 |
qw(type qualified get_marc_record root xsi_schemaLocation rdf_subject rdf_format opt_namespace opt_namespace_url); |
45 |
|
46 |
} |
47 |
|
48 |
use MARC::File::USMARC; |
49 |
use MARC::Crosswalk::DublinCore; |
50 |
use XML::LibXML; |
51 |
use C4::Record; |
52 |
use RDF::Trine; |
53 |
use base qw(Class::Accessor); |
54 |
__PACKAGE__->mk_accessors( |
55 |
qw(type qualified get_marc_record root xsi_schemaLocation rdf_subject rdf_format entities opt_namespace opt_namespace_url) |
56 |
); |
57 |
|
58 |
# Defining some constants |
59 |
my $xsi_schema = qq(http://www.w3.org/2001/XMLSchema-instance); |
60 |
my $unqualified = qq(http://purl.org/dc/elements/1.1/); |
61 |
my $qualified = qq(http://purl.org/dc/terms/); |
62 |
my $dcam = qq(http://purl.org/dc/dcam/); |
63 |
my $rdfNS = qq(http://www.w3.org/1999/02/22-rdf-syntax-ns#); |
64 |
my @elementupcase = |
65 |
qw/tableOfContents dateAccepted dateCopyrighted dateSubmitted isVersionOf hasVersion isReplacedBy isRequiredBy isPartOf hasPart isReferencedBy isFormatOf hasFormat conformsTo accrualMethod accrualPeriodicity accrualPolicy instructionalMethod rightsHolder educationLevel accessRights bibliographicCitation/; |
66 |
my $map; |
67 |
|
68 |
#USAGE: Koha::DublinCore->new({ |
69 |
# type => 'xml|rdf', |
70 |
# qualified => 0|1, |
71 |
# get_marc_record => $record |
72 |
#}); |
73 |
|
74 |
sub new { |
75 |
my ( $class, $args ) = @_; |
76 |
$args = {} unless defined $args; |
77 |
return bless( $args, $class ); |
78 |
} |
79 |
|
80 |
sub get_xml_data { |
81 |
|
82 |
#USAGE: oop->get_xml_data({ |
83 |
# root => 'root', |
84 |
# xsi_schemaLocation => 'http://example.org/myapp/ http://example.org/myapp/schema.xsd', |
85 |
# entities => 0|1, |
86 |
# opt_namespace => 'oai_dc' |
87 |
# opt_namespace_url => 'http://www.openarchives.org/OAI/2.0/oai_dc/' |
88 |
#}); |
89 |
my $self = shift; |
90 |
my ($args) = @_; |
91 |
|
92 |
if (@_) { |
93 |
$self->root( $args->{root} ); |
94 |
$self->xsi_schemaLocation( $args->{xsi_schemaLocation} ); |
95 |
$self->entities( $args->{entities} ); |
96 |
$self->opt_namespace( $args->{opt_namespace} ); |
97 |
$self->opt_namespace_url( $args->{opt_namespace_url} ); |
98 |
} |
99 |
|
100 |
#if data not filled |
101 |
$self->{root} = "metadata" unless ( defined $self->{root} ); |
102 |
$self->{entities} = 0 unless ( defined $self->{entities} ); |
103 |
my %dataxml = ( |
104 |
xmlroot => $self->{root}, |
105 |
entities => $self->{entities}, |
106 |
opt_namespace => $self->{opt_namespace}, |
107 |
opt_namespace_url => $self->{opt_namespace_url}, |
108 |
); |
109 |
|
110 |
if ( exists $self->{xsi_schemaLocation} ) { |
111 |
$dataxml{'xsi_schemaLocation'} = $self->{xsi_schemaLocation}; |
112 |
} |
113 |
if ( exists $self->{xsi_schemaLocation} ) { |
114 |
$dataxml{'opt_namespace'} = $self->{opt_namespace}; |
115 |
} |
116 |
if ( exists $self->{xsi_schemaLocation} ) { |
117 |
$dataxml{'opt_namespace_url'} = $self->{opt_namespace_url}; |
118 |
} |
119 |
return \%dataxml; |
120 |
} |
121 |
|
122 |
sub get_rdf_data { |
123 |
|
124 |
#USAGE: oop->get_rdf_data({ |
125 |
# rdf_subject => 'http://opac.mydomain.edu/cgi-bin/koha/opac-detail.pl?biblionumber=17589', |
126 |
# rdf_format => 'ntriples | nquads| rdfxml | rdfjson | ntriples-canonical | turtle', |
127 |
# entities => 0|1, |
128 |
#}) |
129 |
|
130 |
my $self = shift; |
131 |
my ($args) = @_; |
132 |
|
133 |
if (@_) { |
134 |
$self->rdf_subject( $args->{rdf_subject} ); |
135 |
$self->rdf_format( $args->{rdf_format} ); |
136 |
$self->entities( $args->{entities} ); |
137 |
} |
138 |
|
139 |
#if data not filled |
140 |
$self->{rdf_subject} = "http://koha-community.org/" |
141 |
unless ( defined $self->{rdf_subject} ); |
142 |
$self->{rdf_format} = "rdfxml" unless ( defined $self->{rdf_format} ); |
143 |
$self->{entities} = 0 unless ( defined $self->{entities} ); |
144 |
my %rdfdescription = ( |
145 |
rdf_subject => $self->{rdf_subject}, |
146 |
rdf_format => $self->{rdf_format}, |
147 |
entities => $self->{entities}, |
148 |
); |
149 |
|
150 |
return \%rdfdescription; |
151 |
} |
152 |
|
153 |
sub conversion_to_dc { |
154 |
|
155 |
#Get the MARC record and return a Dublin Core elements, passed as argument in dc_order_execution method. |
156 |
#USAGE: |
157 |
#my dc = $self->conversion_to_dc(); |
158 |
#$self->dc_order_execution ($dc, $dcxml, $root); |
159 |
my $self = shift; |
160 |
my $marc_record_obj = $self->get_marc_record(); |
161 |
my $crosswalk; |
162 |
my $dc; |
163 |
|
164 |
#if data not filled |
165 |
$self->qualified(0) unless ( exists $self->{qualified} ); |
166 |
if ( ( $self->qualified() != 0 and $self->qualified() != 1 ) |
167 |
&& warnings::enabled($self) ) |
168 |
{ |
169 |
warnings::warn( $self, "Only the 0 or 1 values are accepted" ); |
170 |
die "Set qualified => " . $self->qualified() . " is no good, stopped"; |
171 |
} |
172 |
if ( $self->qualified() == 1 ) { |
173 |
$crosswalk = MARC::Crosswalk::DublinCore->new( qualified => 1 ); |
174 |
} |
175 |
elsif ( $self->qualified() == 0 ) { |
176 |
$crosswalk = MARC::Crosswalk::DublinCore->new( qualified => 0 ); |
177 |
} |
178 |
if ( $marc_record_obj =~ /^MARC::Record/ ) { |
179 |
$dc = $crosswalk->as_dublincore($marc_record_obj); |
180 |
} |
181 |
else { |
182 |
warnings::warn( $self, |
183 |
"MARC::Record object failed or not a MARC::Record" ); |
184 |
die "Stopped due get_marc_record => is not a MARC::Record"; |
185 |
} |
186 |
|
187 |
return $dc; |
188 |
|
189 |
} |
190 |
|
191 |
sub write_xml { |
192 |
my $self = shift; |
193 |
my $dataxml = $self->get_xml_data(); |
194 |
my $dc = $self->conversion_to_dc(); |
195 |
|
196 |
#Looking for bad data |
197 |
if ( ( $self->type() ne 'xml' and $self->type() ne 'rdf' ) |
198 |
&& warnings::enabled($self) ) |
199 |
{ |
200 |
warnings::warn( $self, "Only the xml or rdf values are accepted" ); |
201 |
die "Set type => " . $self->type() . " is no good, stopped"; |
202 |
} |
203 |
elsif ( $self->type() eq 'rdf' && warnings::enabled($self) ) { |
204 |
warnings::warn( $self, "The constructor specified rdf" ); |
205 |
die "Cannot use this method with rdf. This is no good, stopped"; |
206 |
} |
207 |
|
208 |
if ( ( $self->entities() != 0 and $self->entities() != 1 ) |
209 |
&& warnings::enabled($self) ) |
210 |
{ |
211 |
warnings::warn( $self, "Only the 0 or 1 values are accepted" ); |
212 |
die "Set entities => " . $self->entities() . " is no good, stopped"; |
213 |
} |
214 |
|
215 |
#Creating XML object |
216 |
my $doc = XML::LibXML::Document->new( '1.0', 'utf-8' ); |
217 |
my $root = $doc->createElement( $dataxml->{'xmlroot'} ); |
218 |
$root->setNamespace( $xsi_schema, 'xsi', 0 ); |
219 |
|
220 |
if ( defined $dataxml->{'opt_namespace'} ) { |
221 |
$root->setNamespace( $dataxml->{'opt_namespace_url'}, |
222 |
$dataxml->{'opt_namespace'}, 0 ); |
223 |
} |
224 |
|
225 |
if ( $self->type() eq 'xml' ) { |
226 |
if ( $self->qualified() == 0 ) { |
227 |
if ( defined $dataxml->{'xsi_schemaLocation'} ) { |
228 |
$root->setAttribute( |
229 |
'xsi:schemaLocation' => $dataxml->{'xsi_schemaLocation'} ); |
230 |
$root->setNamespace( $unqualified, 'dc', 0 ); |
231 |
$self->dc_order_execution( $dc, $doc, $root ); |
232 |
} |
233 |
else { |
234 |
$root->setNamespace( $unqualified, 'dc', 0 ); |
235 |
$self->dc_order_execution( $dc, $doc, $root ); |
236 |
} |
237 |
} |
238 |
elsif ( $self->qualified() == 1 ) { |
239 |
if ( defined $dataxml->{'xsi_schemaLocation'} ) { |
240 |
$root->setAttribute( |
241 |
'xsi:schemaLocation' => $dataxml->{'xsi_schemaLocation'} ); |
242 |
$root->setNamespace( $unqualified, 'dc', 0 ); |
243 |
$root->setNamespace( $qualified, 'dcterms', 0 ); |
244 |
$self->dc_order_execution( $dc, $doc, $root ); |
245 |
} |
246 |
else { |
247 |
$root->setNamespace( $unqualified, 'dc', 0 ); |
248 |
$root->setNamespace( $qualified, 'dcterms', 0 ); |
249 |
$self->dc_order_execution( $dc, $doc, $root ); |
250 |
} |
251 |
} |
252 |
} |
253 |
|
254 |
$doc->setDocumentElement($root); |
255 |
|
256 |
#Enabling or desabling entities and print the xml and, decoding string to utf8 |
257 |
if ( $dataxml->{'entities'} == 1 ) { |
258 |
my $serialized_data = $doc->toString(1); |
259 |
utf8::decode($serialized_data); |
260 |
my ($dcxml_entity_encoded) = C4::Record::_entity_encode($serialized_data); |
261 |
$serialized_data = $dcxml_entity_encoded; |
262 |
return $serialized_data; |
263 |
} |
264 |
else { |
265 |
return $doc->toString(1); |
266 |
} |
267 |
} |
268 |
|
269 |
sub write_rdf { |
270 |
my $self = shift; |
271 |
my $rdfdescription = $self->get_rdf_data(); |
272 |
my $dc = $self->conversion_to_dc(); |
273 |
my $serializer; |
274 |
my %namespaces; |
275 |
|
276 |
#Looking for bad data |
277 |
if ( ( $self->type() ne 'xml' and $self->type() ne 'rdf' ) |
278 |
&& warnings::enabled($self) ) |
279 |
{ |
280 |
warnings::warn( $self, "Only the xml or rdf values are accepted" ); |
281 |
die "Set type => " . $self->type() . " is no good, stopped"; |
282 |
} |
283 |
elsif ( $self->type() eq 'xml' && warnings::enabled($self) ) { |
284 |
warnings::warn( $self, "The constructor specified xml" ); |
285 |
die "Cannot use this method with xml. This is no good, stopped"; |
286 |
} |
287 |
|
288 |
if ( ( $self->entities() != 0 and $self->entities() != 1 ) |
289 |
&& warnings::enabled($self) ) |
290 |
{ |
291 |
warnings::warn( $self, "Only the 0 or 1 values are accepted" ); |
292 |
die "Set entities => " . $self->entities() . " is no good, stopped"; |
293 |
} |
294 |
|
295 |
# Creating the triple store in temporary data |
296 |
my $store = RDF::Trine::Store::Memory->new(); |
297 |
|
298 |
# Creating the model |
299 |
my $rdf = RDF::Trine::Model->new($store); |
300 |
|
301 |
# Creating the subject |
302 |
my $subject = |
303 |
RDF::Trine::Node::Resource->new( $rdfdescription->{'rdf_subject'} ); |
304 |
|
305 |
$namespaces{'rdf'} = $rdfNS; |
306 |
|
307 |
if ( $self->qualified() == 0 ) { |
308 |
|
309 |
# Declaring all namespaces in a hash |
310 |
$namespaces{'dc'} = $unqualified; |
311 |
} |
312 |
else { |
313 |
|
314 |
# Declaring all namespaces in a hash |
315 |
$namespaces{'dcterms'} = $qualified; |
316 |
$namespaces{'dcam'} = $dcam; |
317 |
} |
318 |
|
319 |
# Creating namespaces |
320 |
$map = RDF::Trine::NamespaceMap->new( \%namespaces ); |
321 |
|
322 |
if ( $self->type() eq 'rdf' ) { |
323 |
$self->dc_order_execution( $dc, $rdf, $subject ); |
324 |
} |
325 |
|
326 |
#Enabling or desabling entities and print the xml and, decoding string to utf8 |
327 |
if ( $rdfdescription->{'rdf_format'} eq 'rdfxml' ) { |
328 |
if ( $rdfdescription->{'entities'} == 1 ) { |
329 |
$serializer = |
330 |
RDF::Trine::Serializer::RDFXML->new( |
331 |
namespaces => {%namespaces} ); |
332 |
my $serialized_data = $serializer->serialize_model_to_string($rdf); |
333 |
utf8::decode($serialized_data); |
334 |
my ($dcxml_entity_encoded) = C4::Record::_entity_encode($serialized_data); |
335 |
return $serialized_data = $dcxml_entity_encoded; |
336 |
} |
337 |
else { |
338 |
$serializer = |
339 |
RDF::Trine::Serializer::RDFXML->new( |
340 |
namespaces => {%namespaces} ); |
341 |
return $serializer->serialize_model_to_string($rdf); |
342 |
} |
343 |
} |
344 |
elsif ( $rdfdescription->{'rdf_format'} eq 'turtle' ) { |
345 |
$serializer = |
346 |
RDF::Trine::Serializer::Turtle->new( namespaces => {%namespaces} ); |
347 |
return $serializer->serialize_model_to_string($rdf); |
348 |
} |
349 |
else { |
350 |
$serializer = |
351 |
RDF::Trine::Serializer->new( $rdfdescription->{'rdf_format'} ); |
352 |
return $serializer->serialize_model_to_string($rdf); |
353 |
} |
354 |
} |
355 |
|
356 |
sub upper_or_lowercase { |
357 |
|
358 |
#This subroutine define if is necessary to convert lowercase some qualifiers or let them as crosswalk method basis |
359 |
#USAGE: upper_or_lowercase (element->qualifier()) |
360 |
my $dcelement = $_[0]; |
361 |
my $count = 0; |
362 |
my $result; |
363 |
while ( $count <= $#elementupcase ) { |
364 |
if ( $elementupcase[$count] eq $dcelement ) { |
365 |
$result = $dcelement; |
366 |
last; |
367 |
} |
368 |
elsif ( $dcelement ne $elementupcase[$count] ) { |
369 |
$result = lc($dcelement); |
370 |
$count++; |
371 |
next; |
372 |
} |
373 |
} |
374 |
|
375 |
return $result; |
376 |
|
377 |
} |
378 |
|
379 |
sub xml_constructor { |
380 |
|
381 |
#xml_constructor ( doc, root, namespace, attr, element_name, element_content, element_qualifier, element_scheme ) |
382 |
#USAGE: define all posible elements (name, content, qualifier, scheme) as neccesary |
383 |
#doc: the XML object |
384 |
#root: append root to doc |
385 |
#namespace: defined as "dc" or "dcterms" |
386 |
#attr: a boolean value to determinate xsi:type xml namespace for dcterms |
387 |
#examples: |
388 |
#xml_constructor ( $dcxml, $root, "dc", 0, element->name(), element->content() ); |
389 |
#xml_constructor ( $dcxml, $root, "dcterms", 1, element->name(), element->content(), $element->qualifier() ); |
390 |
|
391 |
my ( $doc, $root, $namespace, $attr, $element_name, $element_content, |
392 |
$element_qualifier, $element_scheme ) |
393 |
= @_; |
394 |
|
395 |
# This scalar is used for deleting spaces in scheme elements |
396 |
my $deletespaces; |
397 |
|
398 |
# This scalar is used for making upper or lowercase the qualifier elements |
399 |
my $lowercase; |
400 |
my $tagxml; |
401 |
|
402 |
if ( $namespace eq "dc" ) { |
403 |
$lowercase = lc($element_name); |
404 |
} |
405 |
elsif ( $namespace eq "dcterms" ) { |
406 |
$lowercase = upper_or_lowercase($element_qualifier); |
407 |
|
408 |
#replacing spacial to spatial, bug from dublin or crosswalk. |
409 |
$lowercase =~ s/spacial/spatial/; |
410 |
} |
411 |
|
412 |
if ( ( $namespace eq "dc" or "dcterms" ) and $attr == 0 ) { |
413 |
|
414 |
# This will do something like: <dc:title>Title</dc:title> |
415 |
$tagxml = XML::LibXML::Element->new($lowercase); |
416 |
$tagxml->setNamespace( undef, $namespace, 1 ); |
417 |
$tagxml->appendTextNode($element_content); |
418 |
$root->appendChild($tagxml); |
419 |
} |
420 |
elsif ( ( $namespace eq "dcterms" ) and $attr == 1 ) { |
421 |
|
422 |
# This will do something like: <dcterms:spatial xsi:type="dcterms:ISO3166">us</dcterms:spatial> |
423 |
$deletespaces = $element_scheme; |
424 |
$deletespaces =~ s/\s//; |
425 |
$tagxml = XML::LibXML::Element->new($lowercase); |
426 |
$tagxml->setNamespace( undef, $namespace, 1 ); |
427 |
my $attribute = $namespace . ':' . $deletespaces; |
428 |
$tagxml->setAttribute( 'xsi:type', $attribute ); |
429 |
$tagxml->appendTextNode($element_content); |
430 |
$root->appendChild($tagxml); |
431 |
} |
432 |
elsif ( ( $namespace eq "dc" ) and $attr == 1 ) { |
433 |
|
434 |
# This will do something like: <dc:subject xsi:type="dcterms:LCSH">Water supply.</dc:subject> |
435 |
if ( $element_scheme ne "DCMI Type Vocabulary" ) |
436 |
{ #Dublin core returns DCMI Type Vocabulary |
437 |
$deletespaces = $element_scheme; |
438 |
$deletespaces =~ s/\s//; |
439 |
$tagxml = XML::LibXML::Element->new($lowercase); |
440 |
$tagxml->setNamespace( undef, $namespace, 1 ); |
441 |
my $attribute = 'dcterms:' . $deletespaces; |
442 |
$tagxml->setAttribute( 'xsi:type', $attribute ); |
443 |
$tagxml->appendTextNode($element_content); |
444 |
$root->appendChild($tagxml); |
445 |
} |
446 |
elsif ( $element_scheme eq "DCMI Type Vocabulary" ) |
447 |
{ #Changing for DCMIType |
448 |
# This will do something like: <dc:type xsi:type="dcterms:DCMIType">Text</dc:type> |
449 |
$tagxml = XML::LibXML::Element->new($lowercase); |
450 |
$tagxml->setNamespace( undef, $namespace, 1 ); |
451 |
$tagxml->setAttribute( 'xsi:type', 'dcterms:DCMIType' ); |
452 |
$tagxml->appendTextNode($element_content); |
453 |
$root->appendChild($tagxml); |
454 |
} |
455 |
} #if...elsif |
456 |
|
457 |
return $tagxml; |
458 |
|
459 |
} #subroutine |
460 |
|
461 |
sub rdf_constructor { |
462 |
|
463 |
#xml_constructor ( rdf, subject, namespace, attr, element_name, element_content, element_qualifier, element_scheme ) |
464 |
#USAGE: define all posible elements (name, content, qualifier, scheme) as neccesary |
465 |
#rdf: the RDF object |
466 |
#subject: the subject for the triples |
467 |
#namespace: defined as "dc" or "dcterms". This is for Simple DC or DC-RDF recommendations. |
468 |
#attr: a boolean value to determine the nodeID attribute for dcterms |
469 |
|
470 |
my ( $rdf, $subject, $namespace, $attr, $element_name, $element_content, |
471 |
$element_qualifier, $element_scheme ) |
472 |
= @_; |
473 |
|
474 |
#This scalar is used for deleting spaces in scheme elements |
475 |
my $deletespaces; |
476 |
|
477 |
#This scalar is used for making upper or lowercase the qualifier elements |
478 |
my $lowercase; |
479 |
|
480 |
if ( $namespace eq "dc" ) { |
481 |
$lowercase = lc($element_name); |
482 |
} |
483 |
elsif ( $namespace eq "dcterms" ) { |
484 |
$lowercase = upper_or_lowercase($element_qualifier); |
485 |
|
486 |
#replacing spacial to spatial, bug from dublin or crosswalk. |
487 |
$lowercase =~ s/spacial/spatial/; |
488 |
} |
489 |
|
490 |
if ( ( $namespace eq "dc" or "dcterms" ) and $attr == 0 ) { |
491 |
|
492 |
# This will do something like: <dc:title>Title</dc:title> |
493 |
my $predicate = undef; |
494 |
if ( $namespace eq "dc" ) { |
495 |
$predicate = $map->dc($lowercase); |
496 |
} |
497 |
else { |
498 |
$predicate = $map->dcterms($lowercase); |
499 |
} |
500 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
501 |
my $statement = |
502 |
RDF::Trine::Statement->new( $subject, $predicate, $object ); |
503 |
$rdf->add_statement($statement); |
504 |
} |
505 |
elsif ( ( $namespace eq "dc" ) and $attr == 2 ) { |
506 |
|
507 |
# This will do something like: <dcterms:title>Title</dcterms:title> |
508 |
my $predicate = $map->dcterms($lowercase); |
509 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
510 |
my $statement = |
511 |
RDF::Trine::Statement->new( $subject, $predicate, $object ); |
512 |
$rdf->add_statement($statement); |
513 |
} |
514 |
elsif ( ( $namespace eq "dc" ) and $attr == 1 ) { |
515 |
$deletespaces = $element_scheme; |
516 |
$deletespaces =~ s/\s//; |
517 |
SWITCH: |
518 |
for ($element_scheme) { |
519 |
if (/^ISO 3166/) { |
520 |
|
521 |
# Dublin core returns DCMI Type Vocabulary |
522 |
# This will do something like: |
523 |
# <rdf:Description rdf:nodeID="country"> |
524 |
# <dcam:memberOf rdf:resource="http://purl.org/dc/terms/ISO3166"/> |
525 |
# <rdf:value>us</rdf:value> |
526 |
# </rdf:Description> |
527 |
# <dcterms:spatial rdf:nodeID="country"/> |
528 |
my $objectbnode = RDF::Trine::Node::Blank->new('country'); |
529 |
my $predicate = $map->dcterms($lowercase); |
530 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
531 |
my $dcam_member_of = $map->dcam('memberOf'); |
532 |
my $resource_schema = $map->dcterms($deletespaces); |
533 |
my $rdf_value = $map->rdf('value'); |
534 |
my $statement1 = |
535 |
RDF::Trine::Statement->new( $subject, $predicate, |
536 |
$objectbnode ); |
537 |
my $statement2 = |
538 |
RDF::Trine::Statement->new( $objectbnode, $dcam_member_of, |
539 |
$resource_schema ); |
540 |
my $statement3 = |
541 |
RDF::Trine::Statement->new( $objectbnode, $rdf_value, |
542 |
$object ); |
543 |
$rdf->add_statement($statement1); |
544 |
$rdf->add_statement($statement2); |
545 |
$rdf->add_statement($statement3); |
546 |
last SWITCH; |
547 |
} |
548 |
if (/^DCMI Type Vocabulary/) { #Changing for DCMIType |
549 |
my $objectbnode = RDF::Trine::Node::Blank->new('DCMIType'); |
550 |
my $predicate = $map->dcterms($lowercase); |
551 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
552 |
my $dcam_member_of = $map->dcam('memberOf'); |
553 |
my $resource_schema = $map->dcterms('DCMIType'); |
554 |
my $rdf_value = $map->rdf('value'); |
555 |
my $statement1 = |
556 |
RDF::Trine::Statement->new( $subject, $predicate, |
557 |
$objectbnode ); |
558 |
my $statement2 = |
559 |
RDF::Trine::Statement->new( $objectbnode, $dcam_member_of, |
560 |
$resource_schema ); |
561 |
my $statement3 = |
562 |
RDF::Trine::Statement->new( $objectbnode, $rdf_value, |
563 |
$object ); |
564 |
$rdf->add_statement($statement1); |
565 |
$rdf->add_statement($statement2); |
566 |
$rdf->add_statement($statement3); |
567 |
last SWITCH; |
568 |
} |
569 |
if (/^ISO 639-2/) { #Changing bnodeId ISO639-2 for language |
570 |
my $objectbnode = RDF::Trine::Node::Blank->new('language'); |
571 |
my $predicate = $map->dcterms($lowercase); |
572 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
573 |
my $dcam_member_of = $map->dcam('memberOf'); |
574 |
my $resource_schema = $map->dcterms($deletespaces); |
575 |
my $rdf_value = $map->rdf('value'); |
576 |
my $statement1 = |
577 |
RDF::Trine::Statement->new( $subject, $predicate, |
578 |
$objectbnode ); |
579 |
my $statement2 = |
580 |
RDF::Trine::Statement->new( $objectbnode, $dcam_member_of, |
581 |
$resource_schema ); |
582 |
my $statement3 = |
583 |
RDF::Trine::Statement->new( $objectbnode, $rdf_value, |
584 |
$object ); |
585 |
$rdf->add_statement($statement1); |
586 |
$rdf->add_statement($statement2); |
587 |
$rdf->add_statement($statement3); |
588 |
last SWITCH; |
589 |
} |
590 |
if (/^RFC 1766/) { #Changing bnodeId RFC1766 for languagetag |
591 |
my $objectbnode = RDF::Trine::Node::Blank->new('languagetag'); |
592 |
my $predicate = $map->dcterms($lowercase); |
593 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
594 |
my $dcam_member_of = $map->dcam('memberOf'); |
595 |
my $resource_schema = $map->dcterms($deletespaces); |
596 |
my $rdf_value = $map->rdf('value'); |
597 |
my $statement1 = |
598 |
RDF::Trine::Statement->new( $subject, $predicate, |
599 |
$objectbnode ); |
600 |
my $statement2 = |
601 |
RDF::Trine::Statement->new( $objectbnode, $dcam_member_of, |
602 |
$resource_schema ); |
603 |
my $statement3 = |
604 |
RDF::Trine::Statement->new( $objectbnode, $rdf_value, |
605 |
$object ); |
606 |
$rdf->add_statement($statement1); |
607 |
$rdf->add_statement($statement2); |
608 |
$rdf->add_statement($statement3); |
609 |
last SWITCH; |
610 |
} |
611 |
if ( /^LCSH/ || /^MeSH/ || /^LCC/ || /^DDC/ || |
612 |
/^UDC/ || /^IMT/ || /^URI/ || /^TGN/ ) |
613 |
{ #Scheme sharing common elements |
614 |
my $objectbnode = RDF::Trine::Node::Blank->new($deletespaces); |
615 |
my $predicate = $map->dcterms($lowercase); |
616 |
my $object = RDF::Trine::Node::Literal->new($element_content); |
617 |
my $dcam_member_of = $map->dcam('memberOf'); |
618 |
my $resource_schema = $map->dcterms($deletespaces); |
619 |
my $rdf_value = $map->rdf('value'); |
620 |
my $statement1 = |
621 |
RDF::Trine::Statement->new( $subject, $predicate, |
622 |
$objectbnode ); |
623 |
my $statement2 = |
624 |
RDF::Trine::Statement->new( $objectbnode, $dcam_member_of, |
625 |
$resource_schema ); |
626 |
my $statement3 = |
627 |
RDF::Trine::Statement->new( $objectbnode, $rdf_value, |
628 |
$object ); |
629 |
$rdf->add_statement($statement1); |
630 |
$rdf->add_statement($statement2); |
631 |
$rdf->add_statement($statement3); |
632 |
last SWITCH; |
633 |
} |
634 |
} |
635 |
} #if-elsif |
636 |
return $rdf; |
637 |
} #subroutine |
638 |
|
639 |
sub dc_order_execution { |
640 |
|
641 |
#USAGE: USAGE: Get the parameters for xml or rdf and execute in order. |
642 |
my $self = shift; |
643 |
|
644 |
if ( $self->type() eq 'xml' ) { #Order for xml |
645 |
my ( $dc, $dcxml, $root ) = @_; |
646 |
foreach my $element ( $dc->elements() ) { |
647 |
SWITCH: { |
648 |
if ( $element->name() |
649 |
and not defined $element->scheme() |
650 |
and not defined $element->qualifier() ) |
651 |
{ |
652 |
$dcxml = |
653 |
xml_constructor( $dcxml, $root, "dc", 0, $element->name(), |
654 |
$element->content() ); |
655 |
last SWITCH; |
656 |
} |
657 |
|
658 |
if ( $element->name() |
659 |
and not defined $element->scheme() |
660 |
and not defined $element->qualifier() ) |
661 |
{ |
662 |
$dcxml = |
663 |
xml_constructor( $dcxml, $root, "dcterms", 0, |
664 |
$element->name(), $element->content() ); |
665 |
last SWITCH; |
666 |
} |
667 |
|
668 |
if ( $element->name() |
669 |
and $element->scheme() |
670 |
and $element->qualifier() ) |
671 |
{ |
672 |
$dcxml = xml_constructor( |
673 |
$dcxml, $root, |
674 |
"dcterms", 1, |
675 |
$element->name(), $element->content(), |
676 |
$element->qualifier(), $element->scheme() |
677 |
); |
678 |
last SWITCH; |
679 |
} |
680 |
|
681 |
if ( $element->name() |
682 |
and $element->scheme() |
683 |
and ( $element->scheme ne "DCMI Type Vocabulary" ) ) |
684 |
{ |
685 |
$dcxml = |
686 |
xml_constructor( $dcxml, $root, "dc", 1, $element->name(), |
687 |
$element->content(), $element->qualifier(), |
688 |
$element->scheme() ); |
689 |
last SWITCH; |
690 |
} |
691 |
|
692 |
if ( $element->name() |
693 |
and $element->scheme() |
694 |
and ( $element->scheme() eq "DCMI Type Vocabulary" ) ) |
695 |
{ |
696 |
$dcxml = |
697 |
xml_constructor( $dcxml, $root, "dc", 1, $element->name(), |
698 |
$element->content(), $element->qualifier(), |
699 |
$element->scheme() ); |
700 |
last SWITCH; |
701 |
} |
702 |
|
703 |
if ( $element->name() and $element->qualifier() ) { |
704 |
$dcxml = xml_constructor( |
705 |
$dcxml, $root, |
706 |
"dcterms", 0, |
707 |
$element->name(), $element->content(), |
708 |
$element->qualifier(), $element->scheme() |
709 |
); |
710 |
last SWITCH; |
711 |
} #if |
712 |
} #SWITCH |
713 |
} #foreach 1 |
714 |
} |
715 |
elsif ( $self->type() eq 'rdf' ) { #Order for rdf/xml |
716 |
my ( $dc, $rdf, $subject ) = @_; |
717 |
foreach my $element ( $dc->elements() ) { |
718 |
SWITCH: { |
719 |
if ( $element->name() |
720 |
and not defined $element->scheme() |
721 |
and not defined $element->qualifier() ) |
722 |
{ |
723 |
rdf_constructor( $rdf, $subject, "dc", 0, $element->name(), |
724 |
$element->content() ) |
725 |
unless $self->qualified() == 1; |
726 |
rdf_constructor( $rdf, $subject, "dc", 2, $element->name(), |
727 |
$element->content() ) |
728 |
unless $self->qualified() == 0; |
729 |
last SWITCH; |
730 |
} |
731 |
|
732 |
if ( $element->name() |
733 |
and $element->scheme() |
734 |
and ( $element->scheme ne "DCMI Type Vocabulary" ) ) |
735 |
{ |
736 |
rdf_constructor( $rdf, $subject, "dc", 1, $element->name(), |
737 |
$element->content(), $element->qualifier(), |
738 |
$element->scheme() ); |
739 |
last SWITCH; |
740 |
} |
741 |
|
742 |
if ( $element->name() |
743 |
and $element->scheme() |
744 |
and ( $element->scheme() eq "DCMI Type Vocabulary" ) ) |
745 |
{ |
746 |
rdf_constructor( $rdf, $subject, "dc", 1, $element->name(), |
747 |
$element->content(), $element->qualifier(), |
748 |
$element->scheme() ); |
749 |
last SWITCH; |
750 |
} |
751 |
|
752 |
if ( $element->name() and $element->qualifier() ) { |
753 |
rdf_constructor( |
754 |
$rdf, $subject, |
755 |
"dcterms", 0, |
756 |
$element->name(), $element->content(), |
757 |
$element->qualifier(), $element->scheme() |
758 |
); |
759 |
last SWITCH; |
760 |
} #if |
761 |
} #SWITCH |
762 |
} #foreach 2 |
763 |
} |
764 |
return; |
765 |
} |
766 |
|
767 |
END { |
768 |
|
769 |
#When opened with MARC::File::USMARC, close marc record if not closed |
770 |
sub DESTROY { |
771 |
my $self = shift; |
772 |
if ( $self->{get_marc_record} =~ /^MARC:File::USMARC/ ) { |
773 |
$self->{get_marc_record}->close(); |
774 |
undef $self->{get_marc_record}; |
775 |
} |
776 |
} |
777 |
} |
778 |
1; |
779 |
__END__ |
780 |
|
781 |
=pod |
782 |
|
783 |
=encoding UTF-8 |
784 |
|
785 |
=head1 NAME |
786 |
|
787 |
Koha::DublinCore - transform the values of MARC::Crosswalk::DublinCore |
788 |
into metadata in XML or RDF format. |
789 |
|
790 |
=head1 SYNOPSIS |
791 |
|
792 |
=head2 XML-DC |
793 |
|
794 |
use Koha::DublinCore; |
795 |
use MARC::File::USMARC; |
796 |
my $batch = MARC::File::USMARC->in('in.mrc'); |
797 |
|
798 |
## the $record will be a MARC::Record object. |
799 |
my $record = $batch->next(); |
800 |
|
801 |
#For Simple DC-XML |
802 |
my $objectDC = Koha::DublinCore->new({ |
803 |
type => 'xml', |
804 |
qualified => 0, |
805 |
get_marc_record => $record}); |
806 |
|
807 |
#For Qualified DC-XML |
808 |
my $objectDC = Koha::DublinCore->new({ |
809 |
type => 'xml', |
810 |
qualified => 1, |
811 |
get_marc_record => $record}); |
812 |
|
813 |
#After call constructor you need to pass the root element and |
814 |
#the schema in .xsd format. If you prefer or you don't know nothing |
815 |
#about it pass the method in blank, i.e., without arguments. |
816 |
#Also you can determine if you want to encode with xml entities or |
817 |
#just with the five basics entities. |
818 |
#Set entities to 0 for the five basics or 1 to encode with the |
819 |
#complete xml entities. |
820 |
$objectDC->get_xml_data({ |
821 |
root => 'metadata', |
822 |
xsi_schemaLocation => 'http://example.org/myapp/' . |
823 |
' http://example.org/myapp/schema.xsd', |
824 |
}); |
825 |
#This print your xml file in STDOUT |
826 |
my $XML-DC = $objectDC->write_xml(); |
827 |
print $XML-DC; |
828 |
|
829 |
#Close the file according to MARC::File::USMARC |
830 |
$batch->close(); |
831 |
undef $batch; |
832 |
|
833 |
#Or if you want to generate a file |
834 |
open (OUTPUT, '> dc2xml.xml') or die $!; |
835 |
print OUTPUT $XML-DC; |
836 |
close(OUTPUT); |
837 |
|
838 |
=head2 DC-RDF |
839 |
|
840 |
use Koha::DublinCore; |
841 |
use MARC::File::USMARC; |
842 |
my $marc = MARC::File::USMARC->in('in.mrc'); |
843 |
my $record = $marc->next(); |
844 |
|
845 |
#Simple DC-RDF is not used but not deprecated, DublinCore |
846 |
#can generate it as follow: |
847 |
my $objectDC = Koha::DublinCore->new({ |
848 |
type => 'rdf', |
849 |
qualified => 0, |
850 |
get_marc_record => $record}); |
851 |
|
852 |
#DC-RDF |
853 |
my $objectDC = Koha::DublinCore->new({ |
854 |
type => 'rdf', |
855 |
qualified => 1, |
856 |
get_marc_record => $record}); |
857 |
|
858 |
#The get_rdf_data method for RDF does not need to use the root element |
859 |
#and the schema, but you need to declare the resource being described, |
860 |
#i.e., the record. |
861 |
#Note: For Koha is the IRI identifier of the record |
862 |
$objectDC->get_rdf_data({ |
863 |
rdf_subject => 'http://opac.mydomain.edu/cgi-bin/koha/opac-detail.pl?biblionumber=17589', |
864 |
}); |
865 |
|
866 |
my $XML-RDF = $objectDC->write_rdf(); |
867 |
print $XML-RDF; |
868 |
#Close the file according to MARC::File::USMARC |
869 |
$batch->close(); |
870 |
undef $marc; |
871 |
|
872 |
=head1 DESCRIPTION |
873 |
|
874 |
The Koha::DublinCore defines the interface to transform |
875 |
and manipulate MARC records into DC-XML or DC-RDF recommendation. |
876 |
This package transform MARC records to XML or RDF/XML Dublin Core |
877 |
and follows the recommendations listed below: |
878 |
|
879 |
L<DC-XML-GUIDELINES [DCMI Recommendation]|http://dublincore.org/documents/dc-xml-guidelines/> |
880 |
|
881 |
L<Expressing Simple Dublin Core in RDF-XML|http://dublincore.org/documents/dcmes-xml/> |
882 |
This recommendation is superseded by DC-RDFrecommendation but not obsoleted at all. |
883 |
|
884 |
L<DC-RDF [DCMI Recommendation]|http://dublincore.org/documents/dc-rdf/> |
885 |
|
886 |
=head2 Methods |
887 |
|
888 |
=over 12 |
889 |
|
890 |
=item C<new> |
891 |
|
892 |
Return a new Koha::DublinCore object. |
893 |
This constructor sets the output type (RDF or XML), the level of the standard (Simple DC or Qualified DC) and the MARC record to be transformed to DC. |
894 |
|
895 |
my $objectDC = Koha::DublinCore->new({ |
896 |
type => 'rdf', |
897 |
qualified => 0, |
898 |
get_marc_record => $record}); |
899 |
|
900 |
=item C<get_xml_data> |
901 |
|
902 |
This method is just for DC-XML: Fetch the xml root element and the schema in .xsd format. |
903 |
|
904 |
$objectDC->get_xml_data({ |
905 |
root => 'metadata', |
906 |
xsi_schemaLocation => 'http://example.org/myapp/ http://example.org/myapp/schema.xsd', |
907 |
entities => 1, |
908 |
}); |
909 |
|
910 |
The entities argument is for extended xml entities, i.e., placing entities to zero will codify only the five basic entities e.g., <, >, ", &, and &apos. Conversely if it is encoded to one, all entities will coded into decimal. |
911 |
|
912 |
Additionally, has been included the opt_namespace and opt_namespace_url arguments to include another XML name space, like OAI-DC or SRW-DC. |
913 |
|
914 |
NOTE: This method is only for use of the DC-XML recommendation, i.e., type => 'xml'. |
915 |
See C<new> method or the section SYNOPSIS. |
916 |
|
917 |
=item C<get_rdf_data> |
918 |
|
919 |
This method is only for DC-RDF: Fetch the IRI identifier of the resource being described. As well, you can pass the format you want to generate with the rdf, by default the DC-RDF specify RDF/XML but RDF can represent in other formats listed below: |
920 |
|
921 |
. ntriples |
922 |
|
923 |
. nquads |
924 |
|
925 |
. rdfxml |
926 |
|
927 |
. rdfjson |
928 |
|
929 |
. ntriples-canonical |
930 |
|
931 |
. turtle |
932 |
|
933 |
$objectDC->get_rdf_data({ |
934 |
rdf_subject => 'http://opac.mydomain.edu/cgi-bin/koha/opac-detail.pl?biblionumber=17589', |
935 |
rdf_format => 'rdfxml', |
936 |
entities => 0|1, |
937 |
}); |
938 |
|
939 |
NOTE: The entities is needed only for rdfxml value and is used like C<get_xml_data> method. |
940 |
|
941 |
=item C<write_xml> |
942 |
|
943 |
Return the xml object as string. |
944 |
|
945 |
NOTE: This method is only for use of the DC-XML recommendation, i.e., type => 'xml'. |
946 |
See C<new> and C<get_xml_data> methods or the section SYNOPSIS. |
947 |
|
948 |
=item C<write_rdf> |
949 |
|
950 |
Return the rdf object as string. |
951 |
|
952 |
NOTE: This method is only for use of the DC-RDF recommendation, i.e., type => 'rdf'. |
953 |
See C<new> and C<get_rdf_data> methods or the section SYNOPSIS. |
954 |
|
955 |
=back |
956 |
|
957 |
=head1 VERSION |
958 |
|
959 |
version 0.01 |
960 |
|
961 |
=head1 RELATES MODULES |
962 |
|
963 |
This package requires the following modules: |
964 |
|
965 |
L<DublinCore::Record> |
966 |
|
967 |
L<MARC::Record> |
968 |
|
969 |
L<MARC::File::USMARC> |
970 |
|
971 |
L<MARC::Crosswalk::DublinCore> |
972 |
|
973 |
L<XML::LibXML> |
974 |
|
975 |
L<RDF::Trine> |
976 |
|
977 |
L<C4::Record> |
978 |
|
979 |
=head2 SEE ALSO |
980 |
|
981 |
Dublin Core Web Page L<http://dublincore.org>. |
982 |
|
983 |
=head1 LICENSE |
984 |
|
985 |
Copyright (c) 2014 Koha Community. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. |
986 |
|
987 |
=head1 AUTHOR |
988 |
|
989 |
Hector Eduardo Catro Avalos E<lt> hector.hecaxmmx at gmail dot com E<gt> |
990 |
and the Koha Development Team. |
991 |
|
992 |
=cut |