source: main/trunk/greenstone2/perllib/inexport.pm@ 28211

Last change on this file since 28211 was 28211, checked in by ak19, 11 years ago

No more absolute paths in archiveinf-doc.gdb and archiveinf-src.gdb

  • Property svn:executable set to *
File size: 45.2 KB
RevLine 
[18457]1###########################################################################
2#
[22413]3# inexport.pm -- useful class to support import.pl and export.pl
[18457]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) 1999 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
26package inexport;
27
28use strict;
29
[22413]30no strict 'refs'; # allow filehandles to be variables and vice versa
31no strict 'subs'; # allow barewords (eg STDERR) as function arguments
[19789]32
[22413]33use arcinfo;
34use colcfg;
[21553]35use dbutil;
[22464]36use doc;
[22413]37use plugin;
38use plugout;
39use manifest;
40use inexport;
[18457]41use util;
[22413]42use scriptutil;
43use FileHandle;
44use gsprintf 'gsprintf';
45use printusage;
46use parse2;
[18457]47
[22413]48use File::Basename;
[21563]49
[22413]50sub new
51{
52 my $class = shift (@_);
[22421]53 my ($mode,$argv,$options,$opt_listall_options) = @_;
[22413]54
[22421]55 my $self = { 'xml' => 0, 'mode' => $mode };
[22413]56
57 # general options available to all plugins
58 my $arguments = $options->{'args'};
59 my $intArgLeftinAfterParsing = parse2::parse($argv,$arguments,$self,"allow_extra_options");
60 # Parse returns -1 if something has gone wrong
61 if ($intArgLeftinAfterParsing == -1)
62 {
63 &PrintUsage::print_txt_usage($options, "{import.params}");
64 die "\n";
65 }
66
67 my $language = $self->{'language'};
68 # If $language has been specified, load the appropriate resource bundle
69 # (Otherwise, the default resource bundle will be loaded automatically)
70 if ($language && $language =~ /\S/) {
71 &gsprintf::load_language_specific_resource_bundle($language);
72 }
73
[22421]74 if ($self->{'listall'}) {
75 if ($self->{'xml'}) {
76 &PrintUsage::print_xml_usage($opt_listall_options);
77 }
78 else
79 {
80 &PrintUsage::print_txt_usage($opt_listall_options,"{export.params}");
81 }
82 die "\n";
83 }
84
85
[22413]86 if ($self->{'xml'}) {
87 &PrintUsage::print_xml_usage($options);
88 print "\n";
[22460]89 return bless $self, $class;
[22413]90 }
91
92 if ($self->{'gli'}) { # the gli wants strings to be in UTF-8
93 &gsprintf::output_strings_in_UTF8;
94 }
95
96 # now check that we had exactly one leftover arg, which should be
97 # the collection name. We don't want to do this earlier, cos
98 # -xml arg doesn't need a collection name
99 # Or if the user specified -h, then we output the usage also
[22460]100
[22413]101 if ($intArgLeftinAfterParsing != 1 || (@$argv && $argv->[0] =~ /^\-+h/))
102 {
103 &PrintUsage::print_txt_usage($options, "{import.params}");
104 die "\n";
105 }
106
107 $self->{'close_out'} = 0;
108 my $out = $self->{'out'};
109 if ($out !~ /^(STDERR|STDOUT)$/i) {
110 open (OUT, ">$out") ||
111 (&gsprintf(STDERR, "{common.cannot_open_output_file}: $!\n", $out) && die);
[23042]112 $out = 'inexport::OUT';
[22413]113 $self->{'close_out'} = 1;
114 }
115 $out->autoflush(1);
116 $self->{'out'} = $out;
117
118 # @ARGV should be only one item, the name of the collection
119 $self->{'collection'} = shift @$argv;
120
[27302]121 # Unless otherwise stated all manifests are considered version 1---where
122 # they act more like an advanced process expression---as compared to newer
123 # manifest files that act as an explicit (and exhaustive) list of files to
124 # process [jmt12]
125 $self->{'manifest_version'} = 1;
[22445]126
[22413]127 return bless $self, $class;
128}
129
[23402]130# Simplified version of the contstructor for use with CGI scripts
131sub newCGI
132{
133 my $class = shift (@_);
[23767]134 my ($mode,$collect,$gsdl_cgi,$opt_site) = @_;
[23402]135
136 my $self = { 'xml' => 0, 'mode' => $mode };
137
138 $self->{'out'} = STDERR;
[23767]139
140 if (defined $gsdl_cgi) {
141 $self->{'site'} = $opt_site;
142 my $collect_dir = $gsdl_cgi->get_collection_dir($opt_site);
143 $self->{'collectdir'} = $collect_dir;
144 }
145 else {
146 $self->{'site'} = "";
[27302]147 $self->{'collectdir'} = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'},"collect");
[23767]148 }
[23402]149 $self->{'faillog'} = "";
150
151 $self->{'collection'} = $collect;
152
153 return bless $self, $class;
154}
[22413]155sub get_collection
156{
157 my $self = shift @_;
158
159 return $self->{'collection'};
160}
161
162
163sub read_collection_cfg
164{
165 my $self = shift @_;
166 my ($collection,$options) = @_;
167
168 my $collectdir = $self->{'collectdir'};
169 my $site = $self->{'site'};
170 my $out = $self->{'out'};
[23767]171
[22413]172 if (($collection = &colcfg::use_collection($site, $collection, $collectdir)) eq "") {
173 &PrintUsage::print_txt_usage($options, "{import.params}");
174 die "\n";
175 }
176
[26567]177 # set gs_version 2/3
[25957]178 $self->{'gs_version'} = "2";
179 if ((defined $site) && ($site ne "")) {
180 # gs3
181 $self->{'gs_version'} = "3";
182 }
[27302]183
184 # add collection's perllib dir into include path in
[22413]185 # case we have collection specific modules
[27302]186 &util::augmentINC(&FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, 'perllib'));
[22413]187
188 # check that we can open the faillog
189 my $faillog = $self->{'faillog'};
190 if ($faillog eq "") {
[27302]191 $faillog = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "etc", "fail.log");
[22413]192 }
193 open (FAILLOG, ">$faillog") ||
194 (&gsprintf(STDERR, "{import.cannot_open_fail_log}\n", $faillog) && die);
195
196
197 my $faillogname = $faillog;
198 $faillog = 'inexport::FAILLOG';
199 $faillog->autoflush(1);
200 $self->{'faillog'} = $faillog;
201 $self->{'faillogname'} = $faillogname;
[27302]202 $self->{'close_faillog'} = 1;
[22413]203
204 # Read in the collection configuration file.
[26567]205 my $gs_mode = "gs".$self->{'gs_version'}; #gs2 or gs3
206 my $config_filename = &colcfg::get_collect_cfg_name($out, $gs_mode);
[22421]207 my $collectcfg = &colcfg::read_collection_cfg ($config_filename, $gs_mode);
[22413]208
[22421]209 return ($config_filename,$collectcfg);
[22413]210}
211
212sub set_collection_options
213{
214 my $self = shift @_;
[22421]215 my ($collectcfg) = @_;
[22413]216
[22421]217 my $inexport_mode = $self->{'mode'};
218
[22413]219 my $verbosity = $self->{'verbosity'};
220 my $debug = $self->{'debug'};
221 my $importdir = $self->{'importdir'};
[22466]222 my $archivedir = $self->{'archivedir'} || $self->{'exportdir'} || "";
[22413]223 my $out = $self->{'out'};
224
225 # If the infodbtype value wasn't defined in the collect.cfg file, use the default
226 if (!defined($collectcfg->{'infodbtype'}))
227 {
228 $collectcfg->{'infodbtype'} = &dbutil::get_default_infodb_type();
229 }
[23170]230 if ($collectcfg->{'infodbtype'} eq "gdbm-txtgz") {
231 # we can't use the text version for archives dbs.
232 $collectcfg->{'infodbtype'} = "gdbm";
233 }
[26450]234
[22413]235 if (defined $collectcfg->{'importdir'} && $importdir eq "") {
236 $importdir = $collectcfg->{'importdir'};
237 }
238 if (defined $collectcfg->{'archivedir'} && $archivedir eq "") {
239 $archivedir = $collectcfg->{'archivedir'};
240 }
241 # fill in the default import and archives directories if none
242 # were supplied, turn all \ into / and remove trailing /
[27394]243 if ($importdir eq "")
244 {
245 $importdir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "import");
[22413]246 }
[27394]247 else
248 {
249 # Don't do this - it kills protocol prefixes
250 #$importdir =~ s/[\\\/]+/\//g;
251 #$importdir =~ s/\/$//;
252 # Do this instead
253 &FileUtils::sanitizePath($importdir);
254 }
255 if (!&FileUtils::directoryExists($importdir))
256 {
257 &gsprintf($out, "{import.no_import_dir}\n\n", $importdir);
258 die "\n";
259 }
[22413]260 $self->{'importdir'} = $importdir;
261
262 if ($archivedir eq "") {
263 if ($inexport_mode eq "import") {
[27302]264 $archivedir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "archives");
[22413]265 }
266 elsif ($inexport_mode eq "export") {
[27302]267 $archivedir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "export");
[22413]268 }
269 else {
270 print STDERR "Warning: Unrecognized import/export mode '$inexport_mode'\n";
271 print STDERR " Defaulting to 'archives' for file output\n";
[27302]272 $archivedir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "archives");
[22413]273 }
274 }
275
[27483]276 $archivedir = &FileUtils::sanitizePath($archivedir);
[27482]277 #$archivedir =~ s/[\\\/]+/\//g;
278 #$archivedir =~ s/\/$//;
[22413]279 $self->{'archivedir'} = $archivedir;
280
281 if ($verbosity !~ /\d+/) {
282 if (defined $collectcfg->{'verbosity'} && $collectcfg->{'verbosity'} =~ /\d+/) {
283 $verbosity = $collectcfg->{'verbosity'};
284 } else {
285 $verbosity = 2; # the default
286 }
287 }
[22421]288 $self->{'verbosity'} = $verbosity;
289
[22413]290 if (defined $collectcfg->{'manifest'} && $self->{'manifest'} eq "") {
291 $self->{'manifest'} = $collectcfg->{'manifest'};
292 }
293
294 if (defined $collectcfg->{'gzip'} && !$self->{'gzip'}) {
295 if ($collectcfg->{'gzip'} =~ /^true$/i) {
296 $self->{'gzip'} = 1;
297 }
298 }
299
300 if ($self->{'maxdocs'} !~ /\-?\d+/) {
301 if (defined $collectcfg->{'maxdocs'} && $collectcfg->{'maxdocs'} =~ /\-?\d+/) {
302 $self->{'maxdocs'} = $collectcfg->{'maxdocs'};
303 } else {
304 $self->{'maxdocs'} = -1; # the default
305 }
306 }
[22421]307
308 if ((defined $self->{'groupsize'}) && ($self->{'groupsize'} == 1)) {
[22413]309 if (defined $collectcfg->{'groupsize'} && $collectcfg->{'groupsize'} =~ /\d+/) {
310 $self->{'groupsize'} = $collectcfg->{'groupsize'};
311 }
312 }
[28077]313
314 if (!defined $self->{'saveas'}
315 || ($self->{'saveas'} !~ /^(GreenstoneXML|GreenstoneMETS)$/ )) {
316 # saveas was either not defined on the command-line, or it was not one of the recognized values
317 if (defined $collectcfg->{'saveas'}
318 && $collectcfg->{'saveas'} =~ /^(GreenstoneXML|GreenstoneMETS)$/) {
319 $self->{'saveas'} = $collectcfg->{'saveas'};
320 } else {
321 $self->{'saveas'} = "GreenstoneXML"; # the default
322 }
323 }
[22413]324
325 if (!defined $self->{'OIDtype'}
[27352]326 || ($self->{'OIDtype'} !~ /^(hash|hash_on_full_filename|incremental|assigned|filename|dirname|full_filename)$/ )) {
[26536]327 # OIDtype was either not defined on the command-line, or if it was not one of the recognized values
[22413]328 if (defined $collectcfg->{'OIDtype'}
[27352]329 && $collectcfg->{'OIDtype'} =~ /^(hash|hash_on_full_filename|incremental|assigned|filename|dirname|full_filename)$/) {
[22413]330 $self->{'OIDtype'} = $collectcfg->{'OIDtype'};
331 } else {
332 $self->{'OIDtype'} = "hash"; # the default
333 }
334 }
335
336 if ((!defined $self->{'OIDmetadata'}) || ($self->{'OIDmetadata'} eq "")) {
337 if (defined $collectcfg->{'OIDmetadata'}) {
338 $self->{'OIDmetadata'} = $collectcfg->{'OIDmetadata'};
339 } else {
340 $self->{'OIDmetadata'} = "dc.Identifier"; # the default
341 }
342 }
343
344 my $sortmeta = $self->{'sortmeta'};
345 if (defined $collectcfg->{'sortmeta'} && (!defined $sortmeta || $sortmeta eq "")) {
346 $sortmeta = $collectcfg->{'sortmeta'};
347 }
348 # sortmeta cannot be used with group size
349 $sortmeta = undef unless defined $sortmeta && $sortmeta =~ /\S/;
350 if (defined $sortmeta && $self->{'groupsize'} > 1) {
351 &gsprintf($out, "{import.cannot_sort}\n\n");
352 $sortmeta = undef;
353 }
[27698]354 if (defined $sortmeta) {
355 &gsprintf($out, "{import.sortmeta_paired_with_ArchivesInfPlugin}\n\n");
356 }
[22413]357 $self->{'sortmeta'} = $sortmeta;
358
359 if (defined $collectcfg->{'removeprefix'} && $self->{'removeprefix'} eq "") {
360 $self->{'removeprefix'} = $collectcfg->{'removeprefix'};
361 }
362
363 if (defined $collectcfg->{'removesuffix'} && $self->{'removesuffix'} eq "") {
364 $self->{'removesuffix'} = $collectcfg->{'removesuffix'};
365 }
366 if (defined $collectcfg->{'debug'} && $collectcfg->{'debug'} =~ /^true$/i) {
367 $self->{'debug'} = 1;
368 }
369 if (defined $collectcfg->{'gli'} && $collectcfg->{'gli'} =~ /^true$/i) {
370 $self->{'gli'} = 1;
371 }
372 $self->{'gli'} = 0 unless defined $self->{'gli'};
373
374 # check keepold and removeold
[22421]375 my $checkdir = ($inexport_mode eq "import") ? "archives" : "export";
376
[22413]377 my ($removeold, $keepold, $incremental, $incremental_mode)
378 = &scriptutil::check_removeold_and_keepold($self->{'removeold'}, $self->{'keepold'},
[22421]379 $self->{'incremental'}, $checkdir,
[22413]380 $collectcfg);
381
382 $self->{'removeold'} = $removeold;
383 $self->{'keepold'} = $keepold;
384 $self->{'incremental'} = $incremental;
385 $self->{'incremental_mode'} = $incremental_mode;
[27302]386
387 # Since this wasted my morning, let's at least warn a user that manifest
388 # files now *only* work if keepold is set [jmt12]
389 if ($self->{'manifest'} && !$self->{'keepold'})
390 {
391 print STDERR "Warning: -manifest flag should not be specified without also setting -keepold or -incremental\n";
392 }
[22413]393}
394
395sub process_files
396{
397 my $self = shift @_;
[22421]398 my ($config_filename,$collectcfg) = @_;
[22413]399
[22421]400 my $inexport_mode = $self->{'mode'};
401
[22413]402 my $verbosity = $self->{'verbosity'};
403 my $debug = $self->{'debug'};
404
405 my $importdir = $self->{'importdir'};
[22460]406 my $archivedir = $self->{'archivedir'} || $self->{'exportdir'};
[22413]407
408 my $incremental = $self->{'incremental'};
409 my $incremental_mode = $self->{'incremental_mode'};
410
[25957]411 my $gs_version = $self->{'gs_version'};
412
[22413]413 my $removeold = $self->{'removeold'};
414 my $keepold = $self->{'keepold'};
415
416 my $saveas = $self->{'saveas'};
417 my $OIDtype = $self->{'OIDtype'};
418 my $OIDmetadata = $self->{'OIDmetadata'};
419
420 my $out = $self->{'out'};
421 my $faillog = $self->{'faillog'};
422
423 my $maxdocs = $self->{'maxdocs'};
424 my $gzip = $self->{'gzip'};
425 my $groupsize = $self->{'groupsize'};
426 my $sortmeta = $self->{'sortmeta'};
427
428 my $removeprefix = $self->{'removeprefix'};
429 my $removesuffix = $self->{'removesuffix'};
430
[22421]431 my $gli = $self->{'gli'};
[22413]432
[22421]433 # related to export
434 my $xsltfile = $self->{'xsltfile'};
435 my $group_marc = $self->{'group_marc'};
436 my $mapping_file = $self->{'mapping_file'};
437 my $xslt_mets = $self->{'xslt_mets'};
438 my $xslt_txt = $self->{'xslt_txt'};
439 my $fedora_namespace = $self->{'fedora_namespace'};
[23825]440 my $metadata_prefix = $self->{'metadata_prefix'};
[22421]441
442 if ($inexport_mode eq "import") {
443 print STDERR "<Import>\n" if $gli;
444 }
445 else {
446 print STDERR "<export>\n" if $gli;
447 }
[24344]448
[22413]449 my $manifest_lookup = new manifest($collectcfg->{'infodbtype'},$archivedir);
[23053]450 if ($self->{'manifest'} ne "") {
[22413]451 my $manifest_filename = $self->{'manifest'};
452
[27302]453 if (!&FileUtils::isFilenameAbsolute($manifest_filename)) {
454 $manifest_filename = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, $manifest_filename);
[22413]455 }
456
[27482]457 $self->{'manifest'} = &FileUtils::sanitizePath($self->{'manifest'});
458 #$self->{'manifest'} =~ s/[\\\/]+/\//g;
459 #$self->{'manifest'} =~ s/\/$//;
[22413]460
461 $manifest_lookup->parse($manifest_filename);
[27302]462
463 # manifests may now include a version number [jmt12]
464 $self->{'manifest_version'} = $manifest_lookup->get_version();
[22413]465 }
466
467 my $manifest = $self->{'manifest'};
468
469 # load all the plugins
470 my $plugins = [];
471 if (defined $collectcfg->{'plugin'}) {
472 $plugins = $collectcfg->{'plugin'};
473 }
474
[23053]475 my $plugin_incr_mode = $incremental_mode;
476 if ($manifest ne "") {
477 # if we have a manifest file, then we pretend we are fully incremental for plugins
478 $plugin_incr_mode = "all";
479 }
[22413]480 #some global options for the plugins
481 my @global_opts = ();
482
[25957]483 my $pluginfo = &plugin::load_plugins ($plugins, $verbosity, $out, $faillog, \@global_opts, $plugin_incr_mode, $gs_version);
[22413]484 if (scalar(@$pluginfo) == 0) {
485 &gsprintf($out, "{import.no_plugins_loaded}\n");
486 die "\n";
487 }
488
[24344]489 # remove the old contents of the archives directory (and tmp
490 # directory) if needed
491
[22413]492 if ($removeold) {
[27302]493 if (&FileUtils::directoryExists($archivedir)) {
[22413]494 &gsprintf($out, "{import.removing_archives}\n");
[27302]495 &FileUtils::removeFilesRecursive($archivedir);
[22413]496 }
[27302]497 my $tmpdir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "tmp");
[22413]498 $tmpdir =~ s/[\\\/]+/\//g;
499 $tmpdir =~ s/\/$//;
[27302]500 if (&FileUtils::directoryExists($tmpdir)) {
[22413]501 &gsprintf($out, "{import.removing_tmpdir}\n");
[27334]502 &FileUtils::removeFilesRecursive($tmpdir);
[22413]503 }
504 }
505
506 # create the archives dir if needed
[27302]507 &FileUtils::makeAllDirectories($archivedir);
[22413]508
509 # read the archive information file
510
511 # BACKWARDS COMPATIBILITY: Just in case there are old .ldb/.bdb files (won't do anything for other infodbtypes)
[27302]512 &util::rename_ldb_or_bdb_file(&FileUtils::filenameConcatenate($archivedir, "archiveinf-doc"));
513 &util::rename_ldb_or_bdb_file(&FileUtils::filenameConcatenate($archivedir, "archiveinf-src"));
[22413]514
[27302]515 # When we make these initial calls to determine the archive information doc
516 # and src databases we pass through a '1' to indicate this is the first
517 # time we are referring to these databases. When using dynamic dbutils
518 # (available in extensions) this indicates to some database types (for
519 # example, persistent servers) that this is a good time to perform any
520 # one time initialization. The argument has no effect on vanilla dbutils
521 # [jmt12]
522 my $perform_firsttime_init = 1;
523 my $arcinfo_doc_filename = &dbutil::get_infodb_file_path($collectcfg->{'infodbtype'}, "archiveinf-doc", $archivedir, $perform_firsttime_init);
524 my $arcinfo_src_filename = &dbutil::get_infodb_file_path($collectcfg->{'infodbtype'}, "archiveinf-src", $archivedir, $perform_firsttime_init);
525
[22413]526 my $archive_info = new arcinfo ($collectcfg->{'infodbtype'});
527 $archive_info->load_info ($arcinfo_doc_filename);
528
529 if ($manifest eq "") {
530 # Load in list of files in import folder from last import (if present)
531 $archive_info->load_prev_import_filelist ($arcinfo_src_filename);
532 }
533
534 ####Use Plugout####
[22421]535 my $plugout;
536
537 if ($inexport_mode eq "import") {
538 if (defined $collectcfg->{'plugout'}) {
539 # If a plugout was specified in the collect.cfg file, assume it is sensible
540 # We can't check the name because it could be anything, if it is a custom plugout
541 $plugout = $collectcfg->{'plugout'};
542 }
543 else{
544 if ($saveas !~ /^(GreenstoneXML|GreenstoneMETS)$/) {
545 push @$plugout,"GreenstoneXMLPlugout";
546 }
547 else{
548 push @$plugout,$saveas."Plugout";
549 }
550 }
[22413]551 }
[22421]552 else {
553 if (defined $collectcfg->{'plugout'} && $collectcfg->{'plugout'} =~ /^(.*METS|DSpace|MARCXML)Plugout/) {
554 $plugout = $collectcfg->{'plugout'};
[22413]555 }
556 else{
[22421]557 if ($saveas !~ /^(GreenstoneMETS|FedoraMETS|DSpace|MARCXML)$/) {
558 push @$plugout,"GreenstoneMETSPlugout";
559 }
560 else{
561 push @$plugout,$saveas."Plugout";
562 }
[22413]563 }
564 }
[22421]565
566 my $plugout_name = $plugout->[0];
[22413]567
[22421]568 push @$plugout,("-output_info",$archive_info) if (defined $archive_info);
569 push @$plugout,("-verbosity",$verbosity) if (defined $verbosity);
570 push @$plugout,("-debug") if ($debug);
571 push @$plugout,("-group_size",$groupsize) if (defined $groupsize);
572 push @$plugout,("-gzip_output") if ($gzip);
573 push @$plugout,("-output_handle",$out) if (defined $out);
574
575 push @$plugout,("-xslt_file",$xsltfile) if (defined $xsltfile && $xsltfile ne "");
576
577 if ($plugout_name =~ m/^MARCXMLPlugout$/) {
578 push @$plugout,("-group") if ($group_marc);
579 push @$plugout,("-mapping_file",$mapping_file) if (defined $mapping_file && $mapping_file ne "");
580 }
581 if ($plugout_name =~ m/^.*METSPlugout$/) {
582 push @$plugout,("-xslt_mets",$xslt_mets) if (defined $xslt_mets && $xslt_mets ne "");
583 push @$plugout,("-xslt_txt",$xslt_txt) if (defined $xslt_txt && $xslt_txt ne "");
584 }
585
586 if ($plugout_name eq "FedoraMETSPlugout") {
587 push @$plugout,("-fedora_namespace",$fedora_namespace) if (defined $fedora_namespace && $fedora_namespace ne "");
588 }
[23825]589
590 if ($plugout_name eq "DSpacePlugout") {
591 push @$plugout,("-metadata_prefix",$metadata_prefix) if (defined $metadata_prefix && $metadata_prefix ne "");
592 }
[22421]593
[27302]594 my $processor = &plugout::load_plugout($plugout);
[22413]595 $processor->setoutputdir ($archivedir);
596 $processor->set_sortmeta ($sortmeta, $removeprefix, $removesuffix) if defined $sortmeta;
[26536]597
[22413]598 $processor->set_OIDtype ($OIDtype, $OIDmetadata);
599
600 &plugin::begin($pluginfo, $importdir, $processor, $maxdocs, $gli);
601
602 if ($removeold) {
[24344]603 # occasionally, plugins may want to do something on remove
604 # old, eg pharos image indexing
[22413]605 &plugin::remove_all($pluginfo, $importdir, $processor, $maxdocs, $gli);
606 }
607
[23053]608 # process the import directory
609 my $block_hash = {};
610 $block_hash->{'new_files'} = {};
611 $block_hash->{'reindex_files'} = {};
[27302]612 # all of these are set somewhere else, so it's more readable to define them
613 # here [jmt12]
614 $block_hash->{'all_files'} = {};
615 $block_hash->{'deleted_files'} = {};
616 $block_hash->{'file_blocks'} = {};
617 $block_hash->{'metadata_files'} = {};
618 $block_hash->{'shared_fileroot'} = '';
619 # a new flag so we can tell we had a manifest way down in the plugins
620 # [jmt12]
621 $block_hash->{'manifest'} = 'false';
[23053]622 my $metadata = {};
623
[23943]624 # global blocking pass may set up some metadata
[27302]625 # - when we have a newer manifest file we don't do this -unless- the
626 # collection configuration indicates this collection contains complex
627 # (inherited) metadata [jmt12]
628 if ($manifest eq '' || (defined $collectcfg->{'complexmeta'} && $collectcfg->{'complexmeta'} eq 'true'))
629 {
630 &plugin::file_block_read($pluginfo, $importdir, "", $block_hash, $metadata, $gli);
631 }
632 else
633 {
634 print STDERR "Skipping global file scan due to manifest and complexmeta configuration\n";
635 }
636
[23053]637 if ($manifest ne "") {
[27302]638
639 # mark that we are using a manifest - information that might be needed
640 # down in plugins (for instance DirectoryPlugin)
641 $block_hash->{'manifest'} = $self->{'manifest_version'};
642
[23053]643 #
644 # 1. Process delete files first
645 #
646 my @deleted_files = keys %{$manifest_lookup->{'delete'}};
647 my @full_deleted_files = ();
648
649 # ensure all filenames are absolute
650 foreach my $df (@deleted_files) {
651 my $full_df =
[27302]652 (&FileUtils::isFilenameAbsolute($df))
[23053]653 ? $df
[27302]654 : &FileUtils::filenameConcatenate($importdir,$df);
[23053]655
656 if (-d $full_df) {
657 &add_dir_contents_to_list($full_df, \@full_deleted_files);
658 } else {
659 push(@full_deleted_files,$full_df);
660 }
661 }
662
663 &plugin::remove_some($pluginfo, $collectcfg->{'infodbtype'}, $archivedir, \@full_deleted_files);
664 mark_docs_for_deletion($archive_info,{},
665 \@full_deleted_files,
666 $archivedir, $verbosity, "delete");
667
668
669 #
670 # 2. Now files for reindexing
671 #
672
673 my @reindex_files = keys %{$manifest_lookup->{'reindex'}};
674 my @full_reindex_files = ();
675 # ensure all filenames are absolute
676 foreach my $rf (@reindex_files) {
677 my $full_rf =
[27302]678 (&FileUtils::isFilenameAbsolute($rf))
[23053]679 ? $rf
[27302]680 : &FileUtils::filenameConcatenate($importdir,$rf);
[23053]681
682 if (-d $full_rf) {
683 &add_dir_contents_to_list($full_rf, \@full_reindex_files);
684 } else {
685 push(@full_reindex_files,$full_rf);
686 }
687 }
688
689 &plugin::remove_some($pluginfo, $collectcfg->{'infodbtype'}, $archivedir, \@full_reindex_files);
690 mark_docs_for_deletion($archive_info,{},\@full_reindex_files, $archivedir,$verbosity, "reindex");
691
692 # And now to ensure the new version of the file processed by
693 # appropriate plugin, we need to add it to block_hash reindex list
694 foreach my $full_rf (@full_reindex_files) {
695 $block_hash->{'reindex_files'}->{$full_rf} = 1;
696 }
697
698
699 #
700 # 3. Now finally any new files - add to block_hash new_files list
701 #
702
703 my @new_files = keys %{$manifest_lookup->{'index'}};
704 my @full_new_files = ();
705
706 foreach my $nf (@new_files) {
707 # ensure filename is absolute
708 my $full_nf =
[27302]709 (&FileUtils::isFilenameAbsolute($nf))
[23053]710 ? $nf
[27302]711 : &FileUtils::filenameConcatenate($importdir,$nf);
[23053]712
713 if (-d $full_nf) {
714 &add_dir_contents_to_list($full_nf, \@full_new_files);
715 } else {
716 push(@full_new_files,$full_nf);
717 }
718 }
719
[23132]720 my $arcinfo_src_filename = &dbutil::get_infodb_file_path($collectcfg->{'infodbtype'}, "archiveinf-src", $archivedir);
[27302]721 # need to check this file exists before trying to read it - in the past
722 # it wasn't possible to have a manifest unless keepold was also set so
723 # you were pretty much guarenteed arcinfo existed
724 # [jmt12]
725 # @todo &FileUtils::fileExists($arcinfo_src_filename) [jmt12]
726 if (-e $arcinfo_src_filename)
727 {
[23132]728 my $arcinfodb_map = {};
729 &dbutil::read_infodb_file($collectcfg->{'infodbtype'}, $arcinfo_src_filename, $arcinfodb_map);
[23053]730 foreach my $f (@full_new_files) {
[28211]731 my $rel_f = &util::abspath_to_placeholders($f);
732
[23132]733 # check that we haven't seen it already
[28211]734 if (defined $arcinfodb_map->{$rel_f}) {
[23132]735 # TODO make better warning
[28211]736 print STDERR "Warning: $f ($rel_f) already in src archive, \n";
[23132]737 } else {
738 $block_hash->{'new_files'}->{$f} = 1;
739 }
[23053]740 }
[23132]741
742 undef $arcinfodb_map;
[27302]743 }
744 # no existing files - so we can just add all the files [jmt12]
745 else
746 {
747 foreach my $f (@full_new_files)
748 {
749 $block_hash->{'new_files'}->{$f} = 1;
750 }
751 }
752
753 # If we are not using complex inherited metadata (and thus have skipped
754 # the global file scan) we need to at least check for a matching
755 # metadata.xml for the files being indexed/reindexed
756 # - unless we are using the newer version of Manifests, which are treated
757 # verbatim, and should have a metadata element for metadata files (so
758 # we can explicitly process metadata files other than metadata.xml)
759 # [jmt12]
760 if ($self->{'manifest_version'} < 1 && (!defined $collectcfg->{'complexmeta'} || $collectcfg->{'complexmeta'} ne 'true'))
761 {
762 my @all_files_to_import = (keys %{$block_hash->{'reindex_files'}}, keys %{$block_hash->{'new_files'}});
763 foreach my $file_to_import (@all_files_to_import)
764 {
765 my $metadata_xml_path = $file_to_import;
766 $metadata_xml_path =~ s/[^\\\/]*$/metadata.xml/;
767 if (&FileUtils::fileExists($metadata_xml_path))
768 {
769 &plugin::file_block_read($pluginfo, '', $metadata_xml_path, $block_hash, $metadata, $gli);
770 }
771 }
772 }
773
774 # new version manifest files explicitly list metadata files to be
775 # processed (ignoring complexmeta if set)
776 # [jmt12]
777 if ($self->{'manifest_version'} > 1)
778 {
779 # Process metadata files
780 foreach my $file_to_import (keys %{$block_hash->{'reindex_files'}}, keys %{$block_hash->{'new_files'}})
781 {
782 $self->perform_process_files($manifest, $pluginfo, '', $file_to_import, $block_hash, $metadata, $processor, $maxdocs);
783 }
784 }
[23053]785 }
786 else {
787 # if incremental, we read through the import folder to see whats changed.
788
[22413]789 if ($incremental || $incremental_mode eq "onlyadd") {
790 prime_doc_oid_count($archivedir);
791
792 # Can now work out which files were new, already existed, and have
793 # been deleted
794
795 new_vs_old_import_diff($archive_info,$block_hash,$importdir,
796 $archivedir,$verbosity,$incremental_mode);
797
798 my @new_files = sort keys %{$block_hash->{'new_files'}};
799 if (scalar(@new_files>0)) {
800 print STDERR "New files and modified metadata files since last import:\n ";
801 print STDERR join("\n ",@new_files), "\n";
802 }
803
804 if ($incremental) {
805 # only look for deletions if we are truely incremental
806 my @deleted_files = sort keys %{$block_hash->{'deleted_files'}};
807 # Filter out any in gsdl/tmp area
808 my @filtered_deleted_files = ();
[27302]809 my $gsdl_tmp_area = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "tmp");
810 my $collect_tmp_area = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "tmp");
[22413]811 $gsdl_tmp_area = &util::filename_to_regex($gsdl_tmp_area);
812 $collect_tmp_area = &util::filename_to_regex($collect_tmp_area);
813
814 foreach my $df (@deleted_files) {
815 next if ($df =~ m/^$gsdl_tmp_area/);
816 next if ($df =~ m/^$collect_tmp_area/);
817
818 push(@filtered_deleted_files,$df);
819 }
820
821
822 @deleted_files = @filtered_deleted_files;
823
824 if (scalar(@deleted_files)>0) {
825 print STDERR "Files deleted since last import:\n ";
826 print STDERR join("\n ",@deleted_files), "\n";
827
828
829 &plugin::remove_some($pluginfo, $collectcfg->{'infodbtype'}, $archivedir, \@deleted_files);
830
831 mark_docs_for_deletion($archive_info,$block_hash,\@deleted_files, $archivedir,$verbosity, "delete");
832 }
833
834 my @reindex_files = sort keys %{$block_hash->{'reindex_files'}};
835
836 if (scalar(@reindex_files)>0) {
837 print STDERR "Files to reindex since last import:\n ";
838 print STDERR join("\n ",@reindex_files), "\n";
839 &plugin::remove_some($pluginfo, $collectcfg->{'infodbtype'}, $archivedir, \@reindex_files);
840 mark_docs_for_deletion($archive_info,$block_hash,\@reindex_files, $archivedir,$verbosity, "reindex");
841 }
842
[23053]843 }
[22413]844 }
845 }
[23939]846
847 # Check for existence of the file that's to contain earliestDateStamp in archivesdir
848 # Do nothing if the file already exists (file exists on incremental build).
849 # If the file doesn't exist, as happens on full build, create it and write out the current datestamp into it
850 # In buildcol, read the file's contents and set the earliestdateStamp in GS2's build.cfg / GS3's buildconfig.xml
851 # In doc.pm have set_oaiLastModified similar to set_lastmodified, and create the doc fields
852 # oailastmodified and oailastmodifieddate
[27302]853 my $earliestDatestampFile = &FileUtils::filenameConcatenate($archivedir, "earliestDatestamp");
[23943]854 if (!-f $earliestDatestampFile && -d $archivedir) {
[23939]855 my $current_time_in_seconds = time; # in seconds
[23946]856
857 if(open(FOUT, ">$earliestDatestampFile")) {
858 # || (&gsprintf(STDERR, "{common.cannot_open}: $!\n", $earliestDatestampFile) && die);
859 print FOUT $current_time_in_seconds;
860 close(FOUT);
861 }
862 else {
863 &gsprintf(STDERR, "{import.cannot_write_earliestdatestamp}\n", $earliestDatestampFile);
864 }
865
[23939]866 }
867
[23053]868
[27302]869 $self->perform_process_files($manifest, $pluginfo, $importdir, '', $block_hash, $metadata, $processor, $maxdocs);
870
[22421]871 if ($saveas eq "FedoraMETS") {
872 # create collection "doc obj" for Fedora that contains
873 # collection-level metadata
874
875 my $doc_obj = new doc($config_filename,"nonindexed_doc","none");
876 $doc_obj->set_OID("collection");
877
878 my $col_name = undef;
879 my $col_meta = $collectcfg->{'collectionmeta'};
880
881 if (defined $col_meta) {
882 store_collectionmeta($col_meta,"collectionname",$doc_obj); # in GS3 this is a collection's name
883 store_collectionmeta($col_meta,"collectionextra",$doc_obj); # in GS3 this is a collection's description
884 }
885 $processor->process($doc_obj);
886 }
887
[22413]888 &plugin::end($pluginfo, $processor);
889
890 &plugin::deinit($pluginfo, $processor);
891
892 # Store the value of OIDCount (used in doc.pm) so it can be
893 # restored correctly to this value on an incremental build
[27302]894 # - this OIDcount file should only be generated for numerical oids [jmt12]
895 if ($self->{'OIDtype'} eq 'incremental')
896 {
897 store_doc_oid_count($archivedir);
898 }
[22413]899
900 # write out the archive information file
[22464]901 $processor->close_file_output() if (defined $groupsize) && ($groupsize > 1);
[22413]902 $processor->close_group_output() if $processor->is_group();
903
904 # for backwards compatability with archvies.inf file
905 if ($arcinfo_doc_filename =~ m/(contents)|(\.inf)$/) {
906 $archive_info->save_info($arcinfo_doc_filename);
907 }
908 else {
909 $archive_info->save_revinfo_db($arcinfo_src_filename);
910 }
911
912 return $pluginfo;
913}
914
[27302]915# @function perform_process_files()
916# while process_files() above prepares the system to import files this is the
917# function that actually initiates the plugin pipeline to process the files.
918# This function the therefore be overridden in subclasses of inexport.pm should
919# they wish to do different or further processing
920# @author jmt12
921sub perform_process_files
922{
923 my $self = shift(@_);
924 my ($manifest, $pluginfo, $importdir, $file_to_import, $block_hash, $metadata, $processor, $maxdocs) = @_;
925 my $gli = $self->{'gli'};
926 # specific file to process - via manifest version 2+
927 if ($file_to_import ne '')
928 {
929 &plugin::read ($pluginfo, '', $file_to_import, $block_hash, $metadata, $processor, $maxdocs, 0, $gli);
930 }
931 # global file scan - if we are using a new version manifest, files would have
932 # been read above. Older manifests use extra settings in the $block_hash to
933 # control what is imported, while non-manifest imports use a regular
934 # $block_hash (so obeying process_exp and block_exp) [jmt12]
935 elsif ($manifest eq '' || $self->{'manifest_version'} < 1)
936 {
937 &plugin::read ($pluginfo, $importdir, '', $block_hash, $metadata, $processor, $maxdocs, 0, $gli);
938 }
939 else
940 {
941 print STDERR "Skipping perform_process_files() due to manifest presence and version\n";
942 }
943}
944# perform_process_files()
[22413]945
[27302]946# @function generate_statistics()
[22413]947sub generate_statistics
948{
[27302]949 my $self = shift @_;
950 my ($pluginfo) = @_;
[22413]951
[27302]952 my $inexport_mode = $self->{'mode'};
953 my $out = $self->{'out'};
954 my $faillogname = $self->{'faillogname'};
955 my $gli = $self->{'gli'};
[22421]956
[27302]957 &gsprintf($out, "\n");
958 &gsprintf($out, "*********************************************\n");
959 &gsprintf($out, "{$inexport_mode.complete}\n");
960 &gsprintf($out, "*********************************************\n");
[22413]961
[27302]962 &plugin::write_stats($pluginfo, 'STDERR', $faillogname, $gli);
963}
964# generate_statistics()
[22413]965
966
[27302]967# @function deinit()
968# Close down any file handles that we opened (and hence are responsible for
969# closing
970sub deinit
971{
972 my $self = shift(@_);
973 close OUT if $self->{'close_out'};
974 close FAILLOG if $self->{'close_faillog'};
[22413]975}
[27302]976# deinit()
[22413]977
978
[22464]979sub store_collectionmeta
980{
981 my ($collectionmeta,$field,$doc_obj) = @_;
982
983 my $section = $doc_obj->get_top_section();
984
985 my $field_hash = $collectionmeta->{$field};
986
987 foreach my $k (keys %$field_hash)
988 {
989 my $val = $field_hash->{$k};
990
991 ### print STDERR "*** $k = $field_hash->{$k}\n";
992
993 my $md_label = "ex.$field";
994
995
996 if ($k =~ m/^\[l=(.*?)\]$/)
997 {
998
999 my $md_suffix = $1;
1000 $md_label .= "^$md_suffix";
1001 }
1002
1003
1004 $doc_obj->add_utf8_metadata($section,$md_label, $val);
1005
1006 # see collConfigxml.pm: GS2's "collectionextra" is called "description" in GS3,
1007 # while "collectionname" in GS2 is called "name" in GS3.
1008 # Variable $nameMap variable in collConfigxml.pm maps between GS2 and GS3
1009 if (($md_label eq "ex.collectionname^en") || ($md_label eq "ex.collectionname"))
1010 {
1011 $doc_obj->add_utf8_metadata($section,"dc.Title", $val);
1012 }
1013
1014 }
1015}
[22413]1016
1017
[21306]1018sub oid_count_file {
1019 my ($archivedir) = @_;
[27302]1020 return &FileUtils::filenameConcatenate($archivedir, "OIDcount");
[21306]1021}
1022
1023
[18528]1024sub prime_doc_oid_count
1025{
1026 my ($archivedir) = @_;
[21306]1027 my $oid_count_filename = &oid_count_file($archivedir);
[18528]1028
1029 if (-e $oid_count_filename) {
1030 if (open(OIDIN,"<$oid_count_filename")) {
1031 my $OIDcount = <OIDIN>;
1032 chomp $OIDcount;
1033 close(OIDIN);
1034
1035 $doc::OIDcount = $OIDcount;
1036 }
[23946]1037 else {
1038 &gsprintf(STDERR, "{import.cannot_read_OIDcount}\n", $oid_count_filename);
[18528]1039 }
1040 }
1041
1042}
1043
1044sub store_doc_oid_count
1045{
1046 # Use the file "OIDcount" in the archives directory to record
1047 # what value doc.pm got up to
1048
1049 my ($archivedir) = @_;
[21306]1050 my $oid_count_filename = &oid_count_file($archivedir);
[18528]1051
[27302]1052 # @todo $oidout = &FileUtils::openFileDescriptor($oid_count_filename, 'w') [jmt12]
[18528]1053 if (open(OIDOUT,">$oid_count_filename")) {
1054 print OIDOUT $doc::OIDcount, "\n";
1055
1056 close(OIDOUT);
1057 }
1058 else {
[23946]1059 &gsprintf(STDERR, "{import.cannot_write_OIDcount}\n", $oid_count_filename);
[18528]1060 }
1061}
1062
1063
1064
[18457]1065sub new_vs_old_import_diff
1066{
[20578]1067 my ($archive_info,$block_hash,$importdir,$archivedir,$verbosity,$incremental_mode) = @_;
[18457]1068
[21620]1069 # Get the infodbtype value for this collection from the arcinfo object
1070 my $infodbtype = $archive_info->{'infodbtype'};
1071
[20776]1072 # in this method, we want to know if metadata files are modified or not.
[21620]1073 my $arcinfo_doc_filename = &dbutil::get_infodb_file_path($infodbtype, "archiveinf-doc", $archivedir);
[20776]1074
1075 my $archiveinf_timestamp = -M $arcinfo_doc_filename;
1076
[18457]1077 # First convert all files to absolute form
1078 # This is to support the situation where the import folder is not
1079 # the default
1080
1081 my $prev_all_files = $archive_info->{'prev_import_filelist'};
1082 my $full_prev_all_files = {};
1083
1084 foreach my $prev_file (keys %$prev_all_files) {
1085
[27302]1086 if (!&FileUtils::isFilenameAbsolute($prev_file)) {
1087 my $full_prev_file = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'},$prev_file);
[18457]1088 $full_prev_all_files->{$full_prev_file} = $prev_file;
1089 }
1090 else {
1091 $full_prev_all_files->{$prev_file} = $prev_file;
1092 }
1093 }
1094
[18469]1095
[18457]1096 # Figure out which are the new files, existing files and so
1097 # by implication the files from the previous import that are not
1098 # there any more => mark them for deletion
1099 foreach my $curr_file (keys %{$block_hash->{'all_files'}}) {
1100
1101 my $full_curr_file = $curr_file;
1102
1103 # entry in 'all_files' is moved to either 'existing_files',
[20776]1104 # 'deleted_files', 'new_files', or 'new_or_modified_metadata_files'
[18457]1105
[27302]1106 if (!&FileUtils::isFilenameAbsolute($curr_file)) {
[18457]1107 # add in import dir to make absolute
[27302]1108 $full_curr_file = &FileUtils::filenameConcatenate($importdir,$curr_file);
[18457]1109 }
1110
[19498]1111 # figure out if new file or not
[18457]1112 if (defined $full_prev_all_files->{$full_curr_file}) {
[20776]1113 # delete it so that only files that need deleting are left
1114 delete $full_prev_all_files->{$full_curr_file};
1115
1116 # had it before. is it a metadata file?
1117 if ($block_hash->{'metadata_files'}->{$full_curr_file}) {
[20578]1118
[20776]1119 # is it modified??
1120 if (-M $full_curr_file < $archiveinf_timestamp) {
[23485]1121 print STDERR "*** Detected a *modified metadata* file: $full_curr_file\n" if $verbosity >= 2;
[20776]1122 # its newer than last build
1123 $block_hash->{'new_or_modified_metadata_files'}->{$full_curr_file} = 1;
1124 }
[20578]1125 }
1126 else {
[20776]1127 if ($incremental_mode eq "all") {
1128
1129 # had it before
1130 $block_hash->{'existing_files'}->{$full_curr_file} = 1;
1131
1132 }
1133 else {
1134 # Warning in "onlyadd" mode, but had it before!
1135 print STDERR "Warning: File $full_curr_file previously imported.\n";
1136 print STDERR " Treating as new file\n";
1137
1138 $block_hash->{'new_files'}->{$full_curr_file} = 1;
1139
1140 }
[20578]1141 }
1142 }
1143 else {
1144 if ($block_hash->{'metadata_files'}->{$full_curr_file}) {
1145 # the new file is the special sort of file greenstone uses
1146 # to attach metadata to src documents
1147 # i.e metadata.xml
1148 # (but note, the filename used is not constrained in
1149 # Greenstone to always be this)
[18457]1150
[23485]1151 print STDERR "*** Detected *new* metadata file: $full_curr_file\n" if $verbosity >= 2;
[20776]1152 $block_hash->{'new_or_modified_metadata_files'}->{$full_curr_file} = 1;
[20578]1153 }
1154 else {
1155 $block_hash->{'new_files'}->{$full_curr_file} = 1;
1156 }
[18457]1157 }
[20578]1158
[18457]1159
1160 delete $block_hash->{'all_files'}->{$curr_file};
1161 }
1162
[20578]1163
[21306]1164
1165
[20776]1166 # Deal with complication of new or modified metadata files by forcing
[20578]1167 # everything from this point down in the file hierarchy to
1168 # be freshly imported.
1169 #
1170 # This may mean files that have not changed are reindexed, but does
1171 # guarantee by the end of processing all new metadata is correctly
1172 # associated with the relevant document(s).
1173
[20776]1174 foreach my $new_mdf (keys %{$block_hash->{'new_or_modified_metadata_files'}}) {
[20578]1175 my ($fileroot,$situated_dir,$ext) = fileparse($new_mdf, "\\.[^\\.]+\$");
1176
1177 $situated_dir =~ s/[\\\/]+$//; # remove tailing slashes
[24829]1178 $situated_dir = &util::filename_to_regex($situated_dir); # need to escape windows slash \ and brackets in regular expression
[20769]1179
[20578]1180 # Go through existing_files, and mark anything that is contained
1181 # within 'situated_dir' to be reindexed (in case some of the metadata
1182 # attaches to one of these files)
1183
1184 my $reindex_files = [];
1185
1186 foreach my $existing_f (keys %{$block_hash->{'existing_files'}}) {
[20769]1187
[20578]1188 if ($existing_f =~ m/^$situated_dir/) {
[23485]1189
1190 print STDERR "**** Existing file $existing_f\nis located within\n$situated_dir\n";
1191
[20578]1192 push(@$reindex_files,$existing_f);
1193 $block_hash->{'reindex_files'}->{$existing_f} = 1;
[21306]1194 delete $block_hash->{'existing_files'}->{$existing_f};
[20578]1195
1196 }
1197 }
1198
1199 # metadata file needs to be in new_files list so parsed by MetadataXMLPlug
1200 # (or equivalent)
1201 $block_hash->{'new_files'}->{$new_mdf} = 1;
1202
1203 }
1204
[21306]1205 # go through remaining existing files and work out what has changed and needs to be reindexed.
1206 my @existing_files = sort keys %{$block_hash->{'existing_files'}};
1207
1208 my $reindex_files = [];
1209
1210 foreach my $existing_filename (@existing_files) {
1211 if (-M $existing_filename < $archiveinf_timestamp) {
1212 # file is newer than last build
1213
1214 my $existing_file = $existing_filename;
[27302]1215 #my $collectdir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'});
[21306]1216
1217 #my $collectdir_resafe = &util::filename_to_regex($collectdir);
1218 #$existing_file =~ s/^$collectdir_resafe(\\|\/)?//;
1219
1220 print STDERR "**** Reindexing existing file: $existing_file\n";
1221
1222 push(@$reindex_files,$existing_file);
1223 $block_hash->{'reindex_files'}->{$existing_filename} = 1;
1224 }
1225
1226 }
1227
[20578]1228
[18469]1229 # By this point full_prev_all_files contains the files
1230 # mentioned in archiveinf-src.db but are not in the 'import'
1231 # folder (or whatever was specified through -importdir ...)
1232
1233 # This list can contain files that were created in the 'tmp' or
1234 # 'cache' areas (such as screen-size and thumbnail images).
[18457]1235 #
[18469]1236 # In building the final list of files to delete, we test to see if
[20578]1237 # it exists on the filesystem and if it does (unusual for a "normal"
1238 # file in import, but possible in the case of 'tmp' files),
1239 # supress it from going into the final list
[18469]1240
1241 my $collectdir = $ENV{'GSDLCOLLECTDIR'};
1242
[18457]1243 my @deleted_files = values %$full_prev_all_files;
[18469]1244 map { my $curr_file = $_;
1245 my $full_curr_file = $curr_file;
1246
[27302]1247 if (!&FileUtils::isFilenameAbsolute($curr_file)) {
[18469]1248 # add in import dir to make absolute
1249
[27302]1250 $full_curr_file = &FileUtils::filenameConcatenate($collectdir,$curr_file);
[18469]1251 }
1252
1253
1254 if (!-e $full_curr_file) {
1255 $block_hash->{'deleted_files'}->{$curr_file} = 1;
1256 }
1257 } @deleted_files;
[20578]1258
1259
1260
[18457]1261}
1262
[19498]1263
[20788]1264# this is used to delete "deleted" docs, and to remove old versions of "changed" docs
[21306]1265# $mode is 'delete' or 'reindex'
1266sub mark_docs_for_deletion
[18457]1267{
[21306]1268 my ($archive_info,$block_hash,$deleted_files,$archivedir,$verbosity,$mode) = @_;
[18457]1269
[21306]1270 my $mode_text = "deleted from index";
1271 if ($mode eq "reindex") {
1272 $mode_text = "reindexed";
1273 }
[18457]1274
[21620]1275 # Get the infodbtype value for this collection from the arcinfo object
1276 my $infodbtype = $archive_info->{'infodbtype'};
[18457]1277
[21620]1278 my $arcinfo_doc_filename = &dbutil::get_infodb_file_path($infodbtype, "archiveinf-doc", $archivedir);
1279 my $arcinfo_src_filename = &dbutil::get_infodb_file_path($infodbtype, "archiveinf-src", $archivedir);
1280
[22010]1281
[18457]1282 # record files marked for deletion in arcinfo
[19498]1283 foreach my $file (@$deleted_files) {
[21564]1284 # use 'archiveinf-src' info database file to look up all the OIDs
[19789]1285 # that this file is used in (note in most cases, it's just one OID)
[18457]1286
[28211]1287 my $relfile = &util::abspath_to_placeholders($file);
1288
1289 my $src_rec = &dbutil::read_infodb_entry($infodbtype, $arcinfo_src_filename, $relfile);
[18457]1290 my $oids = $src_rec->{'oid'};
[20776]1291 my $file_record_deleted = 0;
[20788]1292
1293 # delete the src record
[22010]1294 my $src_infodb_file_handle = &dbutil::open_infodb_write_handle($infodbtype, $arcinfo_src_filename, "append");
[28211]1295 &dbutil::delete_infodb_entry($infodbtype, $src_infodb_file_handle, $relfile);
[22010]1296 &dbutil::close_infodb_write_handle($infodbtype, $src_infodb_file_handle);
1297
1298
[18457]1299 foreach my $oid (@$oids) {
1300
[20788]1301 # find the source doc (the primary file that becomes this oid)
[23485]1302 my $doc_rec = &dbutil::read_infodb_entry($infodbtype, $arcinfo_doc_filename, $oid);
[20776]1303 my $doc_source_file = $doc_rec->{'src-file'}->[0];
[28211]1304 $doc_source_file = &util::placeholders_to_abspath($doc_source_file);
1305
[20776]1306 if (!&util::filename_is_absolute($doc_source_file)) {
[27302]1307 $doc_source_file = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'},$doc_source_file);
[20776]1308 }
[18457]1309
[20788]1310 if ($doc_source_file ne $file) {
1311 # its an associated or metadata file
1312
[20776]1313 # mark source doc for reimport as one of its assoc files has changed or deleted
1314 $block_hash->{'reindex_files'}->{$doc_source_file} = 1;
[20788]1315
[18457]1316 }
[20788]1317 my $curr_status = $archive_info->get_status_info($oid);
1318 if (defined($curr_status) && (($curr_status ne "D"))) {
1319 if ($verbosity>1) {
1320 print STDERR "$oid ($doc_source_file) marked to be $mode_text on next buildcol.pl\n";
[19498]1321 }
[20788]1322 # mark oid for deletion (it will be deleted or reimported)
1323 $archive_info->set_status_info($oid,"D");
[23485]1324 my $val = &dbutil::read_infodb_rawentry($infodbtype, $arcinfo_doc_filename, $oid);
[20788]1325 $val =~ s/^<index-status>(.*)$/<index-status>D/m;
[21557]1326
1327 my $val_rec = &dbutil::convert_infodb_string_to_hash($val);
[22010]1328 my $doc_infodb_file_handle = &dbutil::open_infodb_write_handle($infodbtype, $arcinfo_doc_filename, "append");
1329
[21620]1330 &dbutil::write_infodb_entry($infodbtype, $doc_infodb_file_handle, $oid, $val_rec);
[22010]1331 &dbutil::close_infodb_write_handle($infodbtype, $doc_infodb_file_handle);
[19498]1332 }
[18457]1333 }
[22327]1334
[18457]1335 }
[24344]1336
1337 # now go through and check that we haven't marked any primary
1338 # files for reindex (because their associated files have
1339 # changed/deleted) when they have been deleted themselves. only in
1340 # delete mode.
1341
[22567]1342 if ($mode eq "delete") {
1343 foreach my $file (@$deleted_files) {
1344 if (defined $block_hash->{'reindex_files'}->{$file}) {
1345 delete $block_hash->{'reindex_files'}->{$file};
1346 }
[22327]1347 }
1348 }
[21560]1349
[22010]1350
[18457]1351}
1352
[23053]1353sub add_dir_contents_to_list {
[18457]1354
[23053]1355 my ($dirname, $list) = @_;
1356
1357 # Recur over directory contents.
1358 my (@dir, $subfile);
1359
1360 # find all the files in the directory
1361 if (!opendir (DIR, $dirname)) {
1362 print STDERR "inexport: WARNING - couldn't read directory $dirname\n";
1363 return -1; # error in processing
1364 }
1365 @dir = readdir (DIR);
1366 closedir (DIR);
1367
1368 for (my $i = 0; $i < scalar(@dir); $i++) {
1369 my $subfile = $dir[$i];
1370 next if ($subfile =~ m/^\.\.?$/);
[23119]1371 next if ($subfile =~ /^\.svn$/);
[27302]1372 my $full_file = &FileUtils::filenameConcatenate($dirname, $subfile);
[23053]1373 if (-d $full_file) {
1374 &add_dir_contents_to_list($full_file, $list);
1375 } else {
1376 push (@$list, $full_file);
1377 }
1378 }
1379
1380}
[18554]1381
[23053]1382
[18457]13831;
Note: See TracBrowser for help on using the repository browser.