[12330] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
[17202] | 3 | # BasePlugout.pm -- base class for all the plugout modules
|
---|
[12330] | 4 | # A component of the Greenstone digital library software
|
---|
| 5 | # from the New Zealand Digital Library Project at the
|
---|
| 6 | # University of Waikato, New Zealand.
|
---|
| 7 | #
|
---|
| 8 | # Copyright (C) 2006 New Zealand Digital Library Project
|
---|
| 9 | #
|
---|
| 10 | # This program is free software; you can redistribute it and/or modify
|
---|
| 11 | # it under the terms of the GNU General Public License as published by
|
---|
| 12 | # the Free Software Foundation; either version 2 of the License, or
|
---|
| 13 | # (at your option) any later version.
|
---|
| 14 | #
|
---|
| 15 | # This program is distributed in the hope that it will be useful,
|
---|
| 16 | # but 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 this program; if not, write to the Free Software
|
---|
| 22 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 23 | #
|
---|
| 24 | ###########################################################################
|
---|
| 25 |
|
---|
[17202] | 26 | package BasePlugout;
|
---|
[12330] | 27 |
|
---|
| 28 | eval {require bytes};
|
---|
| 29 |
|
---|
| 30 | use strict;
|
---|
| 31 | no strict 'subs';
|
---|
[12459] | 32 | no strict 'refs';
|
---|
[12330] | 33 |
|
---|
| 34 | use gsprintf 'gsprintf';
|
---|
| 35 | use printusage;
|
---|
[12546] | 36 | use parse2;
|
---|
[17087] | 37 | use GDBMUtils;
|
---|
[12330] | 38 |
|
---|
[17087] | 39 |
|
---|
[12330] | 40 | # suppress the annoying "subroutine redefined" warning that various
|
---|
| 41 | # gets cause under perl 5.6
|
---|
| 42 | $SIG{__WARN__} = sub {warn($_[0]) unless ($_[0] =~ /Subroutine\s+\S+\sredefined/)};
|
---|
| 43 |
|
---|
| 44 | my $arguments = [
|
---|
[13172] | 45 | { 'name' => "group_size",
|
---|
[12330] | 46 | 'desc' => "{BasPlugout.group_size}",
|
---|
| 47 | 'type' => "int",
|
---|
| 48 | 'deft' => "1",
|
---|
| 49 | 'reqd' => "no",
|
---|
| 50 | 'hiddengli' => "no"},
|
---|
| 51 | { 'name' => "output_info",
|
---|
| 52 | 'desc' => "{BasPlugout.output_info}",
|
---|
| 53 | 'type' => "string",
|
---|
| 54 | 'reqd' => "yes",
|
---|
| 55 | 'hiddengli' => "yes"},
|
---|
| 56 | { 'name' => "xslt_file",
|
---|
| 57 | 'desc' => "{BasPlugout.xslt_file}",
|
---|
| 58 | 'type' => "string",
|
---|
| 59 | 'reqd' => "no",
|
---|
| 60 | 'hiddengli' => "no"},
|
---|
| 61 | { 'name' => "output_handle",
|
---|
| 62 | 'desc' => "{BasPlugout.output_handle}",
|
---|
| 63 | 'type' => "string",
|
---|
| 64 | 'deft' => 'STDERR',
|
---|
| 65 | 'reqd' => "no",
|
---|
| 66 | 'hiddengli' => "yes"},
|
---|
| 67 | { 'name' => "verbosity",
|
---|
| 68 | 'desc' => "{BasPlugout.verbosity}",
|
---|
| 69 | 'type' => "int",
|
---|
| 70 | 'deft' => "0",
|
---|
| 71 | 'reqd' => "no",
|
---|
| 72 | 'hiddengli' => "no"},
|
---|
| 73 | { 'name' => "gzip_output",
|
---|
| 74 | 'desc' => "{BasPlugout.gzip_output}",
|
---|
| 75 | 'type' => "flag",
|
---|
| 76 | 'reqd' => "no",
|
---|
[13172] | 77 | 'hiddengli' => "no"},
|
---|
| 78 | { 'name' => "debug",
|
---|
| 79 | 'desc' => "{BasPlugout.debug}",
|
---|
| 80 | 'type' => "flag",
|
---|
| 81 | 'reqd' => "no",
|
---|
| 82 | 'hiddengli' => "yes"}
|
---|
[12330] | 83 | ];
|
---|
| 84 |
|
---|
[17202] | 85 | my $options = { 'name' => "BasePlugout",
|
---|
[12330] | 86 | 'desc' => "{BasPlugout.desc}",
|
---|
| 87 | 'abstract' => "yes",
|
---|
| 88 | 'inherits' => "no",
|
---|
| 89 | 'args' => $arguments};
|
---|
| 90 |
|
---|
| 91 | sub new
|
---|
| 92 | {
|
---|
| 93 | my $class = shift (@_);
|
---|
| 94 |
|
---|
| 95 | my ($plugoutlist,$args,$hashArgOptLists) = @_;
|
---|
| 96 | push(@$plugoutlist, $class);
|
---|
| 97 |
|
---|
| 98 | my $strPlugoutName = (defined $plugoutlist->[0]) ? $plugoutlist->[0] : $class;
|
---|
| 99 |
|
---|
[17202] | 100 | push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
|
---|
| 101 | push(@{$hashArgOptLists->{"OptList"}},$options);
|
---|
[12330] | 102 |
|
---|
| 103 | my $self = {};
|
---|
| 104 | $self->{'plugout_type'} = $class;
|
---|
| 105 | $self->{'option_list'} = $hashArgOptLists->{"OptList"};
|
---|
| 106 | $self->{"info_only"} = 0;
|
---|
| 107 |
|
---|
| 108 | # Check if gsdlinfo is in the argument list or not - if it is, don't parse
|
---|
| 109 | # the args, just return the object.
|
---|
| 110 | foreach my $strArg (@{$args})
|
---|
| 111 | {
|
---|
| 112 | if(defined $strArg && $strArg eq "-gsdlinfo")
|
---|
| 113 | {
|
---|
| 114 | $self->{"info_only"} = 1;
|
---|
| 115 | return bless $self, $class;
|
---|
| 116 | }
|
---|
| 117 | }
|
---|
| 118 |
|
---|
| 119 | delete $self->{"info_only"};
|
---|
| 120 |
|
---|
[12546] | 121 | if(parse2::parse($args,$hashArgOptLists->{"ArgList"},$self) == -1)
|
---|
[12330] | 122 | {
|
---|
| 123 | my $classTempClass = bless $self, $class;
|
---|
| 124 | print STDERR "<BadPlugout d=$self->{'plugout_name'}>\n";
|
---|
| 125 | &gsprintf(STDERR, "\n{BasPlugout.bad_general_option}\n", $self->{'plugout_name'});
|
---|
| 126 | $classTempClass->print_txt_usage(""); # Use default resource bundle
|
---|
| 127 | die "\n";
|
---|
| 128 | }
|
---|
| 129 |
|
---|
| 130 |
|
---|
[12603] | 131 | if(defined $self->{'xslt_file'} && $self->{'xslt_file'} ne "")
|
---|
[12330] | 132 | {
|
---|
| 133 | ##$self->{'xslt_file'} =~ s/\"//g;##working on Windows???
|
---|
| 134 | print STDERR "Can not find $self->{'xslt_file'}, please make sure you have supplied the correct file path\n" and die "\n" unless (-e $self->{'xslt_file'});
|
---|
| 135 | }
|
---|
| 136 |
|
---|
| 137 | $self->{'gs_count'} = 0;
|
---|
| 138 |
|
---|
[12459] | 139 | $self->{'keep_import_structure'} = 0;
|
---|
[12330] | 140 |
|
---|
| 141 | return bless $self, $class;
|
---|
| 142 |
|
---|
| 143 | }
|
---|
| 144 |
|
---|
| 145 | sub print_xml_usage
|
---|
| 146 | {
|
---|
| 147 | my $self = shift(@_);
|
---|
| 148 | my $header = shift(@_);
|
---|
[12628] | 149 | my $high_level_information_only = shift(@_);
|
---|
[12330] | 150 |
|
---|
| 151 | # XML output is always in UTF-8
|
---|
| 152 | gsprintf::output_strings_in_UTF8;
|
---|
| 153 |
|
---|
| 154 | if ($header) {
|
---|
| 155 | &PrintUsage::print_xml_header("plugout");
|
---|
| 156 | }
|
---|
[12628] | 157 | $self->print_xml($high_level_information_only);
|
---|
[12330] | 158 | }
|
---|
| 159 |
|
---|
| 160 |
|
---|
| 161 | sub print_xml
|
---|
| 162 | {
|
---|
| 163 | my $self = shift(@_);
|
---|
[12628] | 164 | my $high_level_information_only = shift(@_);
|
---|
| 165 |
|
---|
[12330] | 166 | my $optionlistref = $self->{'option_list'};
|
---|
| 167 | my @optionlist = @$optionlistref;
|
---|
| 168 | my $plugoutoptions = shift(@$optionlistref);
|
---|
| 169 | return if (!defined($plugoutoptions));
|
---|
| 170 |
|
---|
| 171 | gsprintf(STDERR, "<PlugoutInfo>\n");
|
---|
| 172 | gsprintf(STDERR, " <Name>$plugoutoptions->{'name'}</Name>\n");
|
---|
| 173 | my $desc = gsprintf::lookup_string($plugoutoptions->{'desc'});
|
---|
| 174 | $desc =~ s/</&lt;/g; # doubly escaped
|
---|
| 175 | $desc =~ s/>/&gt;/g;
|
---|
| 176 | gsprintf(STDERR, " <Desc>$desc</Desc>\n");
|
---|
| 177 | gsprintf(STDERR, " <Abstract>$plugoutoptions->{'abstract'}</Abstract>\n");
|
---|
| 178 | gsprintf(STDERR, " <Inherits>$plugoutoptions->{'inherits'}</Inherits>\n");
|
---|
[12628] | 179 | unless (defined($high_level_information_only)) {
|
---|
| 180 | gsprintf(STDERR, " <Arguments>\n");
|
---|
| 181 | if (defined($plugoutoptions->{'args'})) {
|
---|
| 182 | &PrintUsage::print_options_xml($plugoutoptions->{'args'});
|
---|
| 183 | }
|
---|
| 184 | gsprintf(STDERR, " </Arguments>\n");
|
---|
[12330] | 185 |
|
---|
[12628] | 186 | # Recurse up the plugout hierarchy
|
---|
| 187 | $self->print_xml();
|
---|
[12330] | 188 | }
|
---|
| 189 | gsprintf(STDERR, "</PlugoutInfo>\n");
|
---|
| 190 | }
|
---|
| 191 |
|
---|
| 192 |
|
---|
| 193 | sub print_txt_usage
|
---|
| 194 | {
|
---|
| 195 | my $self = shift(@_);
|
---|
| 196 |
|
---|
| 197 | # Print the usage message for a plugout (recursively)
|
---|
| 198 | my $descoffset = $self->determine_description_offset(0);
|
---|
| 199 | $self->print_plugout_usage($descoffset, 1);
|
---|
| 200 | }
|
---|
| 201 |
|
---|
| 202 | sub determine_description_offset
|
---|
| 203 | {
|
---|
| 204 | my $self = shift(@_);
|
---|
| 205 | my $maxoffset = shift(@_);
|
---|
| 206 |
|
---|
| 207 | my $optionlistref = $self->{'option_list'};
|
---|
| 208 | my @optionlist = @$optionlistref;
|
---|
| 209 | my $plugoutoptions = pop(@$optionlistref);
|
---|
| 210 | return $maxoffset if (!defined($plugoutoptions));
|
---|
| 211 |
|
---|
| 212 | # Find the length of the longest option string of this download
|
---|
| 213 | my $plugoutargs = $plugoutoptions->{'args'};
|
---|
| 214 | if (defined($plugoutargs)) {
|
---|
| 215 | my $longest = &PrintUsage::find_longest_option_string($plugoutargs);
|
---|
| 216 | if ($longest > $maxoffset) {
|
---|
| 217 | $maxoffset = $longest;
|
---|
| 218 | }
|
---|
| 219 | }
|
---|
| 220 |
|
---|
| 221 | # Recurse up the download hierarchy
|
---|
| 222 | $maxoffset = $self->determine_description_offset($maxoffset);
|
---|
| 223 | $self->{'option_list'} = \@optionlist;
|
---|
| 224 | return $maxoffset;
|
---|
| 225 | }
|
---|
| 226 |
|
---|
| 227 |
|
---|
| 228 | sub print_plugout_usage
|
---|
| 229 | {
|
---|
| 230 | my $self = shift(@_);
|
---|
| 231 | my $descoffset = shift(@_);
|
---|
| 232 | my $isleafclass = shift(@_);
|
---|
| 233 |
|
---|
| 234 | my $optionlistref = $self->{'option_list'};
|
---|
| 235 | my @optionlist = @$optionlistref;
|
---|
| 236 | my $plugoutoptions = shift(@$optionlistref);
|
---|
| 237 | return if (!defined($plugoutoptions));
|
---|
| 238 |
|
---|
| 239 | my $plugoutname = $plugoutoptions->{'name'};
|
---|
| 240 | my $plugoutargs = $plugoutoptions->{'args'};
|
---|
| 241 | my $plugoutdesc = $plugoutoptions->{'desc'};
|
---|
| 242 |
|
---|
| 243 | # Produce the usage information using the data structure above
|
---|
| 244 | if ($isleafclass) {
|
---|
| 245 | if (defined($plugoutdesc)) {
|
---|
| 246 | gsprintf(STDERR, "$plugoutdesc\n\n");
|
---|
| 247 | }
|
---|
| 248 | gsprintf(STDERR, " {common.usage}: plugout $plugoutname [{common.options}]\n\n");
|
---|
| 249 | }
|
---|
| 250 |
|
---|
| 251 | # Display the download options, if there are some
|
---|
| 252 | if (defined($plugoutargs)) {
|
---|
| 253 | # Calculate the column offset of the option descriptions
|
---|
| 254 | my $optiondescoffset = $descoffset + 2; # 2 spaces between options & descriptions
|
---|
| 255 |
|
---|
| 256 | if ($isleafclass) {
|
---|
| 257 | gsprintf(STDERR, " {common.specific_options}:\n");
|
---|
| 258 | }
|
---|
| 259 | else {
|
---|
| 260 | gsprintf(STDERR, " {common.general_options}:\n", $plugoutname);
|
---|
| 261 | }
|
---|
| 262 |
|
---|
| 263 | # Display the download options
|
---|
| 264 | &PrintUsage::print_options_txt($plugoutargs, $optiondescoffset);
|
---|
| 265 | }
|
---|
| 266 |
|
---|
| 267 | # Recurse up the download hierarchy
|
---|
| 268 | $self->print_plugout_usage($descoffset, 0);
|
---|
| 269 | $self->{'option_list'} = \@optionlist;
|
---|
| 270 | }
|
---|
| 271 |
|
---|
| 272 |
|
---|
| 273 | sub error
|
---|
| 274 | {
|
---|
| 275 | my ($strFunctionName,$strError) = @_;
|
---|
| 276 | {
|
---|
[17202] | 277 | print "Error occoured in BasePlugout.pm\n".
|
---|
[12330] | 278 | "In Function: ".$strFunctionName."\n".
|
---|
| 279 | "Error Message: ".$strError."\n";
|
---|
| 280 | exit(-1);
|
---|
| 281 | }
|
---|
| 282 | }
|
---|
| 283 |
|
---|
| 284 | # OIDtype may be "hash" or "incremental" or "dirname" or "assigned"
|
---|
| 285 | sub set_OIDtype {
|
---|
| 286 | my $self = shift (@_);
|
---|
[12618] | 287 | my ($type, $metadata) = @_;
|
---|
[12330] | 288 |
|
---|
| 289 | if ($type =~ /^(hash|incremental|dirname|assigned)$/) {
|
---|
| 290 | $self->{'OIDtype'} = $type;
|
---|
| 291 | } else {
|
---|
| 292 | $self->{'OIDtype'} = "hash";
|
---|
| 293 | }
|
---|
[12618] | 294 | if ($type =~ /^assigned$/) {
|
---|
| 295 | if (defined $metadata) {
|
---|
| 296 | $self->{'OIDmetadata'} = $metadata;
|
---|
| 297 | } else {
|
---|
| 298 | $self->{'OIDmetadata'} = "dc.Identifier";
|
---|
| 299 | }
|
---|
| 300 | }
|
---|
[12330] | 301 | }
|
---|
| 302 |
|
---|
| 303 | sub set_output_dir
|
---|
| 304 | {
|
---|
| 305 | my $self = shift @_;
|
---|
| 306 | my ($output_dir) = @_;
|
---|
| 307 |
|
---|
| 308 | $self->{'output_dir'} = $output_dir;
|
---|
| 309 | }
|
---|
| 310 |
|
---|
| 311 | sub setoutputdir
|
---|
| 312 | {
|
---|
| 313 | my $self = shift @_;
|
---|
| 314 | my ($output_dir) = @_;
|
---|
| 315 |
|
---|
| 316 | $self->{'output_dir'} = $output_dir;
|
---|
| 317 | }
|
---|
| 318 |
|
---|
| 319 | sub get_output_dir
|
---|
| 320 | {
|
---|
| 321 | my $self = shift (@_);
|
---|
| 322 |
|
---|
| 323 | return $self->{'output_dir'};
|
---|
| 324 | }
|
---|
| 325 |
|
---|
| 326 | sub getoutputdir
|
---|
| 327 | {
|
---|
| 328 | my $self = shift (@_);
|
---|
| 329 |
|
---|
| 330 | return $self->{'output_dir'};
|
---|
| 331 | }
|
---|
| 332 |
|
---|
| 333 | sub getoutputinfo
|
---|
| 334 | {
|
---|
| 335 | my $self = shift (@_);
|
---|
| 336 |
|
---|
| 337 | return $self->{'output_info'};
|
---|
| 338 | }
|
---|
| 339 |
|
---|
| 340 |
|
---|
| 341 | sub get_output_handler
|
---|
| 342 | {
|
---|
| 343 | my $self = shift (@_);
|
---|
| 344 |
|
---|
| 345 | my ($output_file_name) = @_;
|
---|
| 346 |
|
---|
| 347 | open(*OUTPUT, ">$output_file_name") or die "Can not open a file handler for $output_file_name\n";
|
---|
| 348 |
|
---|
| 349 | return *OUTPUT;
|
---|
| 350 | }
|
---|
| 351 |
|
---|
| 352 | sub release_output_handler
|
---|
| 353 | {
|
---|
| 354 | my $self = shift (@_);
|
---|
| 355 | my ($outhandler) = @_;
|
---|
| 356 |
|
---|
| 357 | close($outhandler);
|
---|
| 358 |
|
---|
| 359 | }
|
---|
| 360 |
|
---|
| 361 | sub output_xml_header {
|
---|
| 362 | my $self = shift (@_);
|
---|
| 363 | my ($handle,$docroot,$nondoctype) = @_;
|
---|
| 364 |
|
---|
| 365 | print $handle '<?xml version="1.0" encoding="UTF-8" standalone="no"?>' . "\n";
|
---|
| 366 |
|
---|
| 367 | if (!defined $nondoctype){
|
---|
| 368 | print $handle '<!DOCTYPE Archive SYSTEM "http://greenstone.org/dtd/Archive/1.0/Archive.dtd">' . "\n";
|
---|
| 369 | }
|
---|
| 370 |
|
---|
| 371 | print $handle "<$docroot>\n" if defined $docroot;
|
---|
| 372 | }
|
---|
| 373 |
|
---|
| 374 | sub output_xml_footer {
|
---|
| 375 | my $self = shift (@_);
|
---|
| 376 | my ($handle,$docroot) = @_;
|
---|
| 377 | print $handle "</$docroot>\n" if defined $docroot;
|
---|
| 378 | }
|
---|
| 379 |
|
---|
| 380 | sub process {
|
---|
| 381 | my $self = shift (@_);
|
---|
| 382 | my ($doc_obj) = @_;
|
---|
[12459] | 383 |
|
---|
[12330] | 384 | $doc_obj->set_lastmodified();
|
---|
| 385 |
|
---|
| 386 | if ($self->{'group_size'} > 1) {
|
---|
[12459] | 387 | $self->group_process ($doc_obj);
|
---|
[12330] | 388 | return;
|
---|
| 389 | }
|
---|
| 390 |
|
---|
| 391 | my $OID = $doc_obj->get_OID();
|
---|
| 392 | $OID = "NULL" unless defined $OID;
|
---|
| 393 |
|
---|
| 394 | my $top_section = $doc_obj->get_top_section();
|
---|
| 395 |
|
---|
| 396 | #get document's directory
|
---|
| 397 | my $doc_dir = $self->get_doc_dir ($OID, $doc_obj->get_source_filename());
|
---|
| 398 |
|
---|
| 399 | my $output_info = $self->{'output_info'};
|
---|
| 400 | return if (!defined $output_info);
|
---|
| 401 |
|
---|
| 402 | ##############################
|
---|
| 403 | # call subclass' saveas method
|
---|
| 404 | ##############################
|
---|
| 405 | $self->saveas($doc_obj,$doc_dir);
|
---|
[17880] | 406 | $self->archiveinf_gdbm($doc_obj,$doc_dir);
|
---|
[17087] | 407 |
|
---|
[12330] | 408 | }
|
---|
| 409 |
|
---|
[12363] | 410 | sub store_output_info_reference {
|
---|
[12330] | 411 | my $self = shift (@_);
|
---|
| 412 | my ($doc_obj) = @_;
|
---|
| 413 |
|
---|
[12363] | 414 | my $output_info = $self->{'output_info'};
|
---|
| 415 | my $metaname = $self->{'sortmeta'};
|
---|
| 416 | if (!defined $metaname || $metaname !~ /\S/) {
|
---|
| 417 | $output_info->add_info($doc_obj->get_OID(),$self->{'short_doc_file'}, undef, "");
|
---|
| 418 | return;
|
---|
| 419 | }
|
---|
[12330] | 420 |
|
---|
[12363] | 421 | my $metadata = "";
|
---|
| 422 | my $top_section = $doc_obj->get_top_section();
|
---|
| 423 |
|
---|
| 424 | my @commameta_list = split(/,/, $metaname);
|
---|
| 425 | foreach my $cmn (@commameta_list) {
|
---|
| 426 | my $meta = $doc_obj->get_metadata_element($top_section, $cmn);
|
---|
| 427 | if ($meta) {
|
---|
| 428 | # do remove prefix/suffix - this will apply to all values
|
---|
| 429 | $meta =~ s/^$self->{'removeprefix'}// if defined $self->{'removeprefix'};
|
---|
| 430 | $meta =~ s/$self->{'removesuffix'}$// if defined $self->{'removesuffix'};
|
---|
| 431 | $meta = &sorttools::format_metadata_for_sorting($cmn, $meta, $doc_obj);
|
---|
| 432 | $metadata .= $meta if ($meta);
|
---|
| 433 | }
|
---|
[12330] | 434 | }
|
---|
| 435 |
|
---|
| 436 | # store reference in the output_info
|
---|
| 437 | $output_info->add_info($doc_obj->get_OID(),$self->{'short_doc_file'}, undef, $metadata);
|
---|
| 438 |
|
---|
| 439 | }
|
---|
| 440 |
|
---|
| 441 | sub group_process {
|
---|
| 442 |
|
---|
| 443 | my $self = shift (@_);
|
---|
| 444 | my ($doc_obj) = @_;
|
---|
| 445 |
|
---|
| 446 | my $OID = $doc_obj->get_OID();
|
---|
| 447 | $OID = "NULL" unless defined $OID;
|
---|
| 448 |
|
---|
| 449 | my $groupsize = $self->{'group_size'};
|
---|
| 450 | my $gs_count = $self->{'gs_count'};
|
---|
| 451 | my $open_new_file = (($gs_count % $groupsize)==0);
|
---|
| 452 | my $outhandle = $self->{'output_handle'};
|
---|
| 453 |
|
---|
| 454 | # opening a new file, or document has assoicated files => directory needed
|
---|
[12459] | 455 | if (($open_new_file) || (scalar(@{$doc_obj->get_assoc_files()})>0)) {
|
---|
| 456 |
|
---|
[12330] | 457 | # The directory the archive file (doc.xml) and all associated files
|
---|
| 458 | # should end up in
|
---|
| 459 | my $doc_dir;
|
---|
| 460 | # If we've determined its time for a new file, open it now
|
---|
| 461 | if ($open_new_file || !defined($self->{'gs_doc_dir'}))
|
---|
| 462 | {
|
---|
| 463 | $doc_dir = $self->get_doc_dir ($OID, $doc_obj->get_source_filename());
|
---|
| 464 | # only if opening new file
|
---|
| 465 | my $output_dir = $self->get_output_dir();
|
---|
[12459] | 466 | &util::mk_all_dir ($output_dir) unless -e $output_dir;
|
---|
[12330] | 467 | my $doc_file = &util::filename_cat ($output_dir, $doc_dir, "doc.xml");
|
---|
| 468 | my $short_doc_file = &util::filename_cat ($doc_dir, "doc.xml");
|
---|
[12459] | 469 |
|
---|
[12330] | 470 | if ($gs_count>0)
|
---|
| 471 | {
|
---|
| 472 | return if (!$self->close_file_output());
|
---|
| 473 | }
|
---|
| 474 |
|
---|
[17202] | 475 | open (GROUPPROCESS, ">$doc_file") or (print $outhandle "BasePlugout::group_process could not write to file $doc_file\n" and return);
|
---|
[12330] | 476 |
|
---|
| 477 |
|
---|
| 478 | $self->{'gs_filename'} = $doc_file;
|
---|
[12459] | 479 | $self->{'short_doc_file'} = $short_doc_file;
|
---|
[12330] | 480 | $self->{'gs_OID'} = $OID;
|
---|
| 481 | $self->{'gs_doc_dir'} = $doc_dir;
|
---|
| 482 |
|
---|
[17202] | 483 | $self->output_xml_header('BasePlugout::GROUPPROCESS','Archive');
|
---|
[12330] | 484 | }
|
---|
| 485 | # Otherwise load the same archive document directory used last time
|
---|
| 486 | else
|
---|
| 487 | {
|
---|
| 488 | $doc_dir = $self->{'gs_doc_dir'};
|
---|
| 489 | }
|
---|
| 490 |
|
---|
| 491 | # copy all the associated files, add this information as metadata
|
---|
| 492 | # to the document
|
---|
[13172] | 493 | print $outhandle "Writing associated files to $doc_dir\n";
|
---|
[12330] | 494 | $self->process_assoc_files ($doc_obj, $doc_dir);
|
---|
| 495 | }
|
---|
| 496 |
|
---|
| 497 | # save this document
|
---|
[13172] | 498 | my $section_text = &docprint::get_section_xml($doc_obj,$doc_obj->get_top_section());
|
---|
| 499 | print GROUPPROCESS $section_text;
|
---|
[12330] | 500 |
|
---|
| 501 | $self->{'gs_count'}++;
|
---|
| 502 | }
|
---|
| 503 |
|
---|
| 504 |
|
---|
| 505 | sub saveas {
|
---|
| 506 | my $self = shift (@_);
|
---|
| 507 |
|
---|
| 508 | die "Basplug::saveas function must be implemented in sub classes\n";
|
---|
| 509 | }
|
---|
| 510 |
|
---|
| 511 | sub get_doc_dir {
|
---|
| 512 | my $self = shift (@_);
|
---|
| 513 | my ($OID, $source_filename) = @_;
|
---|
| 514 |
|
---|
| 515 | my $working_dir = $self->get_output_dir();
|
---|
| 516 | my $working_info = $self->{output_info};
|
---|
| 517 | return if (!defined $working_info);
|
---|
| 518 |
|
---|
| 519 | my $doc_info = $working_info->get_info($OID);
|
---|
| 520 | my $doc_dir = '';
|
---|
| 521 |
|
---|
[16252] | 522 | if (defined $doc_info && scalar(@$doc_info) >= 1)
|
---|
| 523 | {
|
---|
| 524 | # This OID already has an archives directory, so use it again
|
---|
[12330] | 525 | $doc_dir = $doc_info->[0];
|
---|
| 526 | $doc_dir =~ s/\/?((doc(mets)?)|(dublin_core))\.xml(\.gz)?$//;
|
---|
[16252] | 527 | }
|
---|
| 528 | elsif ($self->{'keep_import_structure'})
|
---|
| 529 | {
|
---|
[12330] | 530 | $source_filename = &File::Basename::dirname($source_filename);
|
---|
| 531 | $source_filename =~ s/[\\\/]+/\//g;
|
---|
| 532 | $source_filename =~ s/\/$//;
|
---|
| 533 |
|
---|
| 534 | $doc_dir = substr($source_filename, length($ENV{'GSDLIMPORTDIR'}) + 1);
|
---|
[16252] | 535 | }
|
---|
[12330] | 536 |
|
---|
[16252] | 537 | # We have to use a new archives directory for this document
|
---|
| 538 | if ($doc_dir eq "")
|
---|
| 539 | {
|
---|
| 540 | $doc_dir = $self->get_new_doc_dir ($working_info, $working_dir, $OID);
|
---|
[12330] | 541 | }
|
---|
| 542 |
|
---|
[12603] | 543 | if (!defined $self->{'group'} || !$self->{'group'}){
|
---|
| 544 | &util::mk_all_dir (&util::filename_cat ($working_dir, $doc_dir));
|
---|
| 545 | }
|
---|
[16252] | 546 |
|
---|
[12330] | 547 | return $doc_dir;
|
---|
| 548 | }
|
---|
| 549 |
|
---|
| 550 | sub get_new_doc_dir{
|
---|
| 551 | my $self = shift (@_);
|
---|
| 552 | my($working_info,$working_dir,$OID) = @_;
|
---|
| 553 |
|
---|
| 554 | my $doc_dir = "";
|
---|
| 555 | my $doc_dir_rest = $OID;
|
---|
| 556 | my $doc_dir_num = 0;
|
---|
| 557 |
|
---|
| 558 | do {
|
---|
| 559 | $doc_dir .= "/" if $doc_dir_num > 0;
|
---|
| 560 | if ($doc_dir_rest =~ s/^(.{1,8})//) {
|
---|
| 561 | $doc_dir .= $1;
|
---|
| 562 | $doc_dir_num++;
|
---|
| 563 | }
|
---|
| 564 | } while ($doc_dir_rest ne "" &&
|
---|
| 565 | ((-d &util::filename_cat ($working_dir, "$doc_dir.dir")) ||
|
---|
| 566 | ($working_info->size() >= 1024 && $doc_dir_num < 2)));
|
---|
[17294] | 567 | my $i = 1;
|
---|
| 568 | my $doc_dir_base = $doc_dir;
|
---|
| 569 | while (-d &util::filename_cat ($working_dir, "$doc_dir.dir")) {
|
---|
| 570 | $doc_dir = "$doc_dir_base-$i";
|
---|
| 571 | $i++;
|
---|
| 572 | }
|
---|
| 573 |
|
---|
[16252] | 574 | return "$doc_dir.dir";
|
---|
[12330] | 575 | }
|
---|
| 576 |
|
---|
| 577 | sub process_assoc_files {
|
---|
| 578 | my $self = shift (@_);
|
---|
| 579 | my ($doc_obj, $doc_dir, $handle) = @_;
|
---|
| 580 |
|
---|
| 581 | my $outhandle = $self->{'output_handle'};
|
---|
| 582 |
|
---|
| 583 | my $output_dir = $self->get_output_dir();
|
---|
| 584 | return if (!defined $output_dir);
|
---|
| 585 |
|
---|
| 586 | &util::mk_all_dir ($output_dir) unless -e $output_dir;
|
---|
| 587 |
|
---|
| 588 | my $working_dir = &util::filename_cat($output_dir, $doc_dir);
|
---|
| 589 | &util::mk_all_dir ($working_dir) unless -e $working_dir;
|
---|
| 590 |
|
---|
| 591 | my @assoc_files = ();
|
---|
| 592 | my $filename;;
|
---|
| 593 |
|
---|
| 594 | my $source_filename = $doc_obj->get_source_filename();
|
---|
| 595 |
|
---|
| 596 | my $collect_dir = $ENV{'GSDLCOLLECTDIR'};
|
---|
| 597 |
|
---|
| 598 | if (defined $collect_dir) {
|
---|
| 599 | my $dirsep_regexp = &util::get_os_dirsep();
|
---|
| 600 |
|
---|
| 601 | if ($collect_dir !~ /$dirsep_regexp$/) {
|
---|
| 602 | $collect_dir .= &util::get_dirsep(); # ensure there is a slash at the end
|
---|
| 603 | }
|
---|
| 604 |
|
---|
| 605 | # This test is never going to fail on Windows -- is this a problem?
|
---|
| 606 |
|
---|
| 607 | if ($source_filename !~ /^$dirsep_regexp/) {
|
---|
| 608 | $source_filename = &util::filename_cat($collect_dir, $source_filename);
|
---|
| 609 | }
|
---|
| 610 | }
|
---|
| 611 |
|
---|
| 612 |
|
---|
| 613 | # set the assocfile path (even if we have no assoc files - need this for lucene)
|
---|
| 614 | $doc_obj->set_utf8_metadata_element ($doc_obj->get_top_section(),
|
---|
| 615 | "assocfilepath",
|
---|
| 616 | "$doc_dir");
|
---|
| 617 | foreach my $assoc_file_rec (@{$doc_obj->get_assoc_files()}) {
|
---|
| 618 | my ($dir, $afile) = $assoc_file_rec->[1] =~ /^(.*?)([^\/\\]+)$/;
|
---|
| 619 | $dir = "" unless defined $dir;
|
---|
| 620 |
|
---|
| 621 |
|
---|
| 622 | my $real_filename = $assoc_file_rec->[0];
|
---|
| 623 | # for some reasons the image associate file has / before the full path
|
---|
| 624 | $real_filename =~ s/^\\(.*)/$1/i;
|
---|
| 625 | if (-e $real_filename) {
|
---|
| 626 |
|
---|
| 627 | $filename = &util::filename_cat($working_dir, $afile);
|
---|
| 628 |
|
---|
| 629 | &util::hard_link ($real_filename, $filename);
|
---|
| 630 |
|
---|
| 631 | $doc_obj->add_utf8_metadata ($doc_obj->get_top_section(),
|
---|
| 632 | "gsdlassocfile",
|
---|
| 633 | "$afile:$assoc_file_rec->[2]:$dir");
|
---|
| 634 | } elsif ($self->{'verbosity'} > 2) {
|
---|
[17202] | 635 | print $outhandle "BasePlugout::process couldn't copy the associated file " .
|
---|
[12330] | 636 | "$real_filename to $afile\n";
|
---|
| 637 | }
|
---|
| 638 | }
|
---|
| 639 | }
|
---|
| 640 |
|
---|
[17087] | 641 |
|
---|
| 642 | sub archiveinf_gdbm
|
---|
| 643 | {
|
---|
| 644 | my $self = shift (@_);
|
---|
| 645 | my ($doc_obj) = @_;
|
---|
| 646 |
|
---|
| 647 | my $verbosity = $self->{'verbosity'};
|
---|
| 648 |
|
---|
| 649 | my $collect_dir = $ENV{'GSDLCOLLECTDIR'};
|
---|
| 650 | if (defined $collect_dir) {
|
---|
| 651 | my $dirsep_regexp = &util::get_os_dirsep();
|
---|
| 652 |
|
---|
| 653 | if ($collect_dir !~ /$dirsep_regexp$/) {
|
---|
| 654 | # ensure there is a slash at the end
|
---|
| 655 | $collect_dir .= &util::get_dirsep();
|
---|
| 656 | }
|
---|
| 657 | }
|
---|
| 658 |
|
---|
| 659 | my $oid = $doc_obj->get_OID();
|
---|
| 660 | my $source_filename = $doc_obj->get_source_filename();
|
---|
| 661 |
|
---|
| 662 | my $oid_files = { 'src-file' => $source_filename,
|
---|
| 663 | 'assoc-files' => [] };
|
---|
| 664 |
|
---|
| 665 | my @reverse_lookups = ($source_filename);
|
---|
| 666 |
|
---|
| 667 | foreach my $assoc_file_rec (@{$doc_obj->get_assoc_files()}) {
|
---|
| 668 | my $real_filename = $assoc_file_rec->[0];
|
---|
| 669 | my $full_afile = $assoc_file_rec->[1];
|
---|
| 670 |
|
---|
| 671 | # for some reasons the image associate file has / before the full path
|
---|
| 672 | $real_filename =~ s/^\\(.*)/$1/i;
|
---|
| 673 | if (-e $real_filename) {
|
---|
| 674 |
|
---|
| 675 | if (defined $collect_dir) {
|
---|
[17120] | 676 | my $collect_dir_re_safe = $collect_dir;
|
---|
| 677 | $collect_dir_re_safe =~ s/\\/\\\\/g;
|
---|
| 678 | $collect_dir_re_safe =~ s/\./\\./g;
|
---|
| 679 |
|
---|
| 680 | $real_filename =~ s/^$collect_dir_re_safe//;
|
---|
[17087] | 681 | }
|
---|
| 682 |
|
---|
| 683 | push(@reverse_lookups,$real_filename);
|
---|
| 684 |
|
---|
| 685 | push(@{$oid_files->{'assoc-files'}},$full_afile);
|
---|
| 686 |
|
---|
| 687 | }
|
---|
| 688 | else {
|
---|
| 689 | print STDERR "Warning: archiveinf_gdbm()\n $real_filename does not appear to be on the file system\n";
|
---|
| 690 | }
|
---|
| 691 | }
|
---|
| 692 |
|
---|
| 693 | # better not to commit to a particular db implementation, but
|
---|
| 694 | # for simplicity, will use GDBM for now.
|
---|
| 695 |
|
---|
| 696 | my $output_dir = $self->{'output_dir'};
|
---|
| 697 | my $db_ext = &util::is_little_endian() ? ".ldb" : ".bdb";
|
---|
| 698 |
|
---|
| 699 | my $doc_db = &util::filename_cat($output_dir,"archiveinf-doc$db_ext");
|
---|
| 700 | my $src_db = &util::filename_cat($output_dir,"archiveinf-src$db_ext");
|
---|
| 701 |
|
---|
| 702 | my $doc_db_text = "";
|
---|
| 703 | $doc_db_text .= "<src-file>$oid_files->{'src-file'}\n";
|
---|
| 704 | foreach my $af (@{$oid_files->{'assoc-files'}}) {
|
---|
| 705 | $doc_db_text .= "<assoc-file>$af\n";
|
---|
| 706 | }
|
---|
| 707 | chomp($doc_db_text); # remove trailing \n
|
---|
| 708 |
|
---|
[17880] | 709 | ## print STDERR "*** To set in db: \n\t$doc_db\n\t$oid\n\t$doc_db_text\n";
|
---|
[17087] | 710 | &GDBMUtils::gdbmDatabaseSet($doc_db,$oid,$doc_db_text);
|
---|
| 711 |
|
---|
| 712 | foreach my $rl (@reverse_lookups) {
|
---|
| 713 | &GDBMUtils::gdbmDatabaseAppend($src_db,$rl,"<oid>$oid\n");
|
---|
| 714 | }
|
---|
| 715 |
|
---|
| 716 | }
|
---|
| 717 |
|
---|
| 718 |
|
---|
[12330] | 719 | sub set_sortmeta {
|
---|
| 720 | my $self = shift (@_);
|
---|
| 721 | my ($sortmeta, $removeprefix, $removesuffix) = @_;
|
---|
| 722 |
|
---|
| 723 | $self->{'sortmeta'} = $sortmeta;
|
---|
| 724 | if (defined ($removeprefix) && $removeprefix ) {
|
---|
| 725 | $removeprefix =~ s/^\^//; # don't need a leading ^
|
---|
| 726 | $self->{'removeprefix'} = $removeprefix;
|
---|
| 727 | }
|
---|
| 728 | if (defined ($removesuffix) && $removesuffix) {
|
---|
| 729 | $removesuffix =~ s/\$$//; # don't need a trailing $
|
---|
| 730 | $self->{'removesuffix'} = $removesuffix;
|
---|
| 731 | }
|
---|
| 732 | }
|
---|
| 733 |
|
---|
| 734 | sub open_xslt_pipe
|
---|
| 735 | {
|
---|
| 736 | my $self = shift @_;
|
---|
| 737 | my ($output_file_name, $xslt_file)=@_;
|
---|
| 738 |
|
---|
| 739 | return unless defined $xslt_file and $xslt_file ne "" and -e $xslt_file;
|
---|
| 740 |
|
---|
| 741 | my $java_class_path = &util::filename_cat ($ENV{'GSDLHOME'},"bin","java");
|
---|
[13013] | 742 |
|
---|
[15140] | 743 | my $mapping_file_path = "";
|
---|
| 744 |
|
---|
[13225] | 745 | if ($ENV{'GSDLOS'} eq "windows"){
|
---|
| 746 | $java_class_path .=";".&util::filename_cat ($ENV{'GSDLHOME'},"bin","java","xalan.jar");
|
---|
[15140] | 747 | $xslt_file = "\"file:///".$xslt_file."\"";
|
---|
| 748 | $mapping_file_path = "\"file:///";
|
---|
[13225] | 749 | }
|
---|
| 750 | else{
|
---|
| 751 | $java_class_path .=":".&util::filename_cat ($ENV{'GSDLHOME'},"bin","java","xalan.jar");
|
---|
| 752 | }
|
---|
| 753 |
|
---|
| 754 |
|
---|
[13013] | 755 | $java_class_path = "\"".$java_class_path."\"";
|
---|
[13024] | 756 |
|
---|
[14969] | 757 | my $cmd = "| java -cp $java_class_path org.nzdl.gsdl.ApplyXSLT -t $xslt_file ";
|
---|
[12330] | 758 |
|
---|
[12603] | 759 | if (defined $self->{'mapping_file'} and $self->{'mapping_file'} ne ""){
|
---|
[13064] | 760 | my $mapping_file_path = "\"".$self->{'mapping_file'}."\"";
|
---|
[14969] | 761 | $cmd .= "-m $mapping_file_path";
|
---|
[12603] | 762 | }
|
---|
[14969] | 763 |
|
---|
[12330] | 764 | open(*XMLWRITER, $cmd)
|
---|
| 765 | or die "can't open pipe to xslt: $!";
|
---|
| 766 |
|
---|
| 767 |
|
---|
| 768 | $self->{'xslt_writer'} = *XMLWRITER;
|
---|
| 769 |
|
---|
| 770 | print XMLWRITER "<?DocStart?>\n";
|
---|
| 771 | print XMLWRITER "$output_file_name\n";
|
---|
[14969] | 772 |
|
---|
[12330] | 773 |
|
---|
| 774 | }
|
---|
| 775 |
|
---|
| 776 |
|
---|
| 777 | sub close_xslt_pipe
|
---|
| 778 | {
|
---|
| 779 | my $self = shift @_;
|
---|
| 780 |
|
---|
| 781 |
|
---|
| 782 | return unless defined $self->{'xslt_writer'} ;
|
---|
| 783 |
|
---|
| 784 | my $xsltwriter = $self->{'xslt_writer'};
|
---|
| 785 |
|
---|
| 786 | print $xsltwriter "<?DocEnd?>\n";
|
---|
| 787 | close($xsltwriter);
|
---|
[13024] | 788 |
|
---|
| 789 | undef $self->{'xslt_writer'};
|
---|
| 790 |
|
---|
[12330] | 791 | }
|
---|
| 792 |
|
---|
| 793 | sub close_file_output
|
---|
| 794 | {
|
---|
| 795 | my ($self) = @_;
|
---|
| 796 |
|
---|
| 797 | # make sure that the handle has been opened - it won't be if we failed
|
---|
| 798 | # to import any documents...
|
---|
| 799 | if (defined(fileno(GROUPPROCESS))) {
|
---|
| 800 | $self->output_xml_footer('GROUPPROCESS','Archive');
|
---|
| 801 | close GROUPPROCESS;
|
---|
| 802 | }
|
---|
| 803 |
|
---|
| 804 | my $OID = $self->{'gs_OID'};
|
---|
| 805 | my $short_doc_file = $self->{'short_doc_file'};
|
---|
| 806 |
|
---|
| 807 | if ($self->{'gzip'}) {
|
---|
| 808 | my $doc_file = $self->{'gs_filename'};
|
---|
| 809 | `gzip $doc_file`;
|
---|
| 810 | $doc_file .= ".gz";
|
---|
| 811 | $short_doc_file .= ".gz";
|
---|
| 812 | if (!-e $doc_file) {
|
---|
| 813 | my $outhandle = $self->{'output_handle'};
|
---|
| 814 | print $outhandle "error while gzipping: $doc_file doesn't exist\n";
|
---|
| 815 | return 0;
|
---|
| 816 | }
|
---|
| 817 | }
|
---|
| 818 |
|
---|
| 819 | # store reference in output_info
|
---|
| 820 | my $output_info = $self->{'output_info'};
|
---|
| 821 | return 0 if (!defined $output_info);
|
---|
| 822 | $output_info->add_info($OID, $short_doc_file, undef, undef);
|
---|
| 823 | return 1;
|
---|
| 824 | }
|
---|
| 825 |
|
---|
[13172] | 826 |
|
---|
[12330] | 827 | #the subclass should implement this method if is_group method could return 1.
|
---|
| 828 | sub close_group_output{
|
---|
| 829 | my $self = shift (@_);
|
---|
| 830 | }
|
---|
| 831 |
|
---|
| 832 | sub is_group {
|
---|
| 833 | my $self = shift (@_);
|
---|
| 834 | return 0;
|
---|
| 835 | }
|
---|
| 836 |
|
---|
[13172] | 837 | my $dc_set = { Title => 1,
|
---|
| 838 | Creator => 1,
|
---|
| 839 | Subject => 1,
|
---|
| 840 | Description => 1,
|
---|
| 841 | Publisher => 1,
|
---|
| 842 | Contributor => 1,
|
---|
| 843 | Date => 1,
|
---|
| 844 | Type => 1,
|
---|
| 845 | Format => 1,
|
---|
| 846 | Identifier => 1,
|
---|
| 847 | Source => 1,
|
---|
| 848 | Language => 1,
|
---|
| 849 | Relation => 1,
|
---|
| 850 | Coverage => 1,
|
---|
| 851 | Rights => 1};
|
---|
| 852 |
|
---|
| 853 |
|
---|
| 854 | # returns an XML representation of the dublin core metadata
|
---|
| 855 | # if dc meta is not found, try ex mete
|
---|
| 856 | sub get_dc_metadata {
|
---|
| 857 | my $self = shift(@_);
|
---|
| 858 | my ($doc_obj, $section, $version) = @_;
|
---|
| 859 |
|
---|
| 860 | # build up string of dublin core metadata
|
---|
| 861 | $section="" unless defined $section;
|
---|
| 862 |
|
---|
| 863 | my $section_ptr = $doc_obj->_lookup_section($section);
|
---|
| 864 | return "" unless defined $section_ptr;
|
---|
| 865 |
|
---|
| 866 |
|
---|
| 867 | my $explicit_dc = {};
|
---|
| 868 | my $explicit_ex = {};
|
---|
| 869 |
|
---|
| 870 | my $all_text="";
|
---|
| 871 | foreach my $data (@{$section_ptr->{'metadata'}}){
|
---|
| 872 | my $escaped_value = &docprint::escape_text($data->[1]);
|
---|
| 873 | if ($data->[0]=~ m/^dc\./) {
|
---|
| 874 | $data->[0] =~ tr/[A-Z]/[a-z]/;
|
---|
| 875 |
|
---|
| 876 | $data->[0] =~ m/^dc\.(.*)/;
|
---|
| 877 | my $dc_element = $1;
|
---|
| 878 |
|
---|
| 879 | if (!defined $explicit_dc->{$dc_element}) {
|
---|
| 880 | $explicit_dc->{$dc_element} = [];
|
---|
| 881 | }
|
---|
| 882 | push(@{$explicit_dc->{$dc_element}},$escaped_value);
|
---|
| 883 |
|
---|
| 884 | if (defined $version && ($version eq "oai_dc")) {
|
---|
| 885 | $all_text .= " <dc:$dc_element>$escaped_value</dc:$dc_element>\n";
|
---|
| 886 | }
|
---|
| 887 | else {
|
---|
| 888 | # qualifier???
|
---|
| 889 | $all_text .= ' <dcvalue element="'. $dc_element.'">'. $escaped_value. "</dcvalue>\n";
|
---|
| 890 | }
|
---|
| 891 |
|
---|
| 892 | }
|
---|
| 893 | elsif (($data->[0] =~ m/^ex\./) || ($data->[0] !~ m/\./)) {
|
---|
| 894 | $data->[0] =~ m/^(ex\.)?(.*)/;
|
---|
| 895 | my $ex_element = $2;
|
---|
| 896 | my $lc_ex_element = lc($ex_element);
|
---|
| 897 |
|
---|
| 898 | if (defined $dc_set->{$ex_element}) {
|
---|
| 899 | if (!defined $explicit_ex->{$lc_ex_element}) {
|
---|
| 900 | $explicit_ex->{$lc_ex_element} = [];
|
---|
| 901 | }
|
---|
| 902 | push(@{$explicit_ex->{$lc_ex_element}},$escaped_value);
|
---|
| 903 | }
|
---|
| 904 | }
|
---|
| 905 | }
|
---|
| 906 |
|
---|
| 907 | # go through dc_set and for any element *not* defined in explicit_dc
|
---|
[14932] | 908 | # that does exist in explicit_ex, add it in as metadata
|
---|
[13172] | 909 | foreach my $k ( keys %$dc_set ) {
|
---|
| 910 | my $lc_k = lc($k);
|
---|
| 911 |
|
---|
| 912 | if (!defined $explicit_dc->{$lc_k}) {
|
---|
| 913 | if (defined $explicit_ex->{$lc_k}) {
|
---|
| 914 |
|
---|
| 915 | foreach my $v (@{$explicit_ex->{$lc_k}}) {
|
---|
| 916 | my $dc_element = $lc_k;
|
---|
| 917 | my $escaped_value = $v;
|
---|
| 918 |
|
---|
| 919 | if (defined $version && ($version eq "oai_dc")) {
|
---|
| 920 | $all_text .= " <dc:$dc_element>$escaped_value</dc:$dc_element>\n";
|
---|
| 921 | }
|
---|
| 922 | else {
|
---|
| 923 | $all_text .= ' <dcvalue element="'. $dc_element.'">'. $escaped_value. "</dcvalue>\n";
|
---|
| 924 | }
|
---|
| 925 |
|
---|
| 926 | }
|
---|
| 927 | }
|
---|
| 928 | }
|
---|
| 929 | }
|
---|
| 930 |
|
---|
| 931 | if ($all_text eq "") {
|
---|
| 932 | $all_text .= " There is no Dublin Core metatdata in this document\n";
|
---|
| 933 | }
|
---|
| 934 | $all_text =~ s/[\x00-\x09\x0B\x0C\x0E-\x1F]//g;
|
---|
| 935 |
|
---|
| 936 | return $all_text;
|
---|
| 937 | }
|
---|
| 938 |
|
---|
| 939 | # Build up dublin_core metadata. Priority given to dc.* over ex.*
|
---|
| 940 | # This method was apparently added by Jeffrey and committed by Shaoqun.
|
---|
| 941 | # But we don't know why it was added, so not using it anymore.
|
---|
| 942 | sub new_get_dc_metadata {
|
---|
| 943 |
|
---|
| 944 | my $self = shift(@_);
|
---|
| 945 | my ($doc_obj, $section, $version) = @_;
|
---|
| 946 |
|
---|
| 947 | # build up string of dublin core metadata
|
---|
| 948 | $section="" unless defined $section;
|
---|
| 949 |
|
---|
| 950 | my $section_ptr=$doc_obj->_lookup_section($section);
|
---|
| 951 | return "" unless defined $section_ptr;
|
---|
| 952 |
|
---|
| 953 | my $all_text = "";
|
---|
| 954 | foreach my $data (@{$section_ptr->{'metadata'}}){
|
---|
| 955 | my $escaped_value = &docprint::escape_text($data->[1]);
|
---|
| 956 | my $dc_element = $data->[0];
|
---|
| 957 |
|
---|
| 958 | my @array = split('\.',$dc_element);
|
---|
| 959 | my ($type,$name);
|
---|
| 960 |
|
---|
| 961 | if(defined $array[1])
|
---|
| 962 | {
|
---|
| 963 | $type = $array[0];
|
---|
| 964 | $name = $array[1];
|
---|
| 965 | }
|
---|
| 966 | else
|
---|
| 967 | {
|
---|
| 968 | $type = "ex";
|
---|
| 969 | $name = $array[0];
|
---|
| 970 | }
|
---|
| 971 |
|
---|
| 972 | $all_text .= ' <Metadata Type="'. $type.'" Name="'.$name.'">'. $escaped_value. "</Metadata>\n";
|
---|
| 973 | }
|
---|
| 974 | return $all_text;
|
---|
| 975 | }
|
---|
| 976 |
|
---|
| 977 |
|
---|
[12330] | 978 | 1;
|
---|