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