Changeset 37214 for main

Timestamp:

2023-01-29T23:42:13+13:00 (15 months ago)

Author:

davidb

Message:

Addition of new action (in the same style of get-archives-metadata) but for getting an associated file. While this particular operation can be achieved by simply building the URL directly, it has been introduced as part of the 'get-metadata' API for reasons on consistent treatment. The next feature to be added with be set-archives-assocfile, which is something that can't be done by forming a direct URL to the resource

File:

• main/trunk/greenstone2/perllib/cgiactions/metadataaction.pm (modified) (3 diffs)

main/trunk/greenstone2/perllib/cgiactions/metadataaction.pm

@@ -87 +87 @@
         'compulsory-args' => [ "d", "metaname" ],
         'optional-args'   => [ "dv", "metapos" ] },
+
+    "get-archives-assocfiles" => { 
+        'compulsory-args' => [ "d", "assocname" ],
+        'optional-args'   => [ "dv" ] },
     
     "get-index-metadata" => { 
@@ -920 +924 @@
 
     my $doc_filename = &util::filename_cat($archive_dir, $doc_file);
-        
+
+
     $gsdl_cgi->generate_ok_message($self->get_metadata_from_archive_xml($gsdl_cgi, $doc_filename, $metaname, $metapos, $docid_secnum));
-
 }
 
@@ -967 +971 @@
     $gsdl_cgi->generate_ok_message($self->get_metadata_from_archive_xml($gsdl_cgi, $doc_filename, $metaname, $metapos, $docid_secnum));
 
+}
+
+sub get_archives_assocfiles
+{
+    my $self = shift @_;
+
+    my $username  = $self->{'username'};
+    my $collect   = $self->{'collect'};
+    my $gsdl_cgi  = $self->{'gsdl_cgi'};
+    my $infodbtype = $self->{'infodbtype'};
+
+    # Obtain the collect and archive dir
+    my $site = $self->{'site'};
+    my $collect_dir = $gsdl_cgi->get_collection_dir($site);
+    
+    my $archive_dir = &util::filename_cat($collect_dir, $collect, "archives");
+
+    # look up additional args
+    my $docid = $self->{'d'};
+
+    my $assocname = $self->{'assocname'};
+    
+    my $arcinfo_doc_filename = &dbutil::get_infodb_file_path($infodbtype, "archiveinf-doc", $archive_dir);
+    my $doc_rec = &dbutil::read_infodb_entry($infodbtype, $arcinfo_doc_filename, $docid);
+
+    my $doc_file = $doc_rec->{'doc-file'}->[0];
+
+    # check if request if for file-level doc-version history 'nminus-<n>' version
+    my $dv = $self->{'dv'}; 
+    if (defined $dv && ($dv ne "")) {
+        # Need to insert '_fldv_history/nminus-<n>' into doc_filename
+        
+        my ($doc_tailname, $doc_dirname) = File::Basename::fileparse($doc_file);
+        $doc_file = &util::filename_cat($doc_dirname,$FLDV_HISTORY_DIR,$dv,$doc_tailname);
+    }
+    
+    my $doc_filename = &util::filename_cat($archive_dir, $doc_file);
+        
+
+    # In the following the repeated calls to $self->get_metadata_from_archive_xml() with increasing $metapos
+    # get the job done, but is not very efficient
+    # => candidate for refactoring
+    
+    my $json_result_str .= "[";
+    
+
+    my $metapos = 0;
+    my $metavalue = $self->get_metadata_from_archive_xml($gsdl_cgi, $doc_filename, "gsdlassocfile", $metapos, "");
+
+    my $found_file     = undef;
+    my $found_mimetype = undef;
+    
+    while (defined $metavalue && $metavalue ne "") {
+
+        my ($assoc_file,$assoc_mimetype) = ($metavalue =~ m/^(.+?):(.+?):(?:.*)$/); # only need first two fields, third one might be section???
+
+        if ($assoc_file eq $assocname) {
+        $found_file     = $assoc_file;
+        $found_mimetype = $assoc_mimetype;
+        last;
+        }
+                
+        $metapos++;
+        $metavalue = $self->get_metadata_from_archive_xml($gsdl_cgi, $doc_filename, "gsdlassocfile", $metapos, ""); 
+    }
+
+    if (defined $found_file) {
+
+        my ($unused_tailname, $doc_dirname) = File::Basename::fileparse($doc_file);
+
+        if (defined $dv && ($dv ne "")) {
+        # Need to insert '_fldv_history/nminus-<n>' into doc_filename
+
+        $found_file = &util::filename_cat($doc_dirname,$FLDV_HISTORY_DIR,$dv,$found_file);
+        }
+        else {
+        $found_file = &util::filename_cat($doc_dirname,$found_file);
+        }
+        
+        my $found_filename = &util::filename_cat($archive_dir, $found_file);
+
+        $gsdl_cgi->generate_file($found_mimetype,$found_filename);
+    }
+    else {
+        
+        $gsdl_cgi->generate_error("Failed to find associated file $assocname in 'archives' for $docid");
+    }   
 }