Changeset 37233

Timestamp:

2023-01-31T23:41:56+13:00 (8 months ago)

Author:

davidb

Message:

Adding in action for get-fldv-info

File:

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

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

@@ -75 +75 @@
         "get-archives-text" => {
             'compulsory-args' => [ "d" ],
-            'optional-args'   => [ "dv" ] },
+            'optional-args'   => [ "dv" ] 
             #'compulsory-args' => [ "d" ],
-            #'optional-args' => [ "section" ] },
+        #'optional-args' => [ "section" ] },
+    },
     
     #GET METHODS
     "get-import-metadata" => { 
         'compulsory-args' => [ "d", "metaname" ],
-        'optional-args'   => [ "metapos" ] },
+            'optional-args'   => [ "metapos" ]
+    },
 
     "get-archives-metadata" => { 
         'compulsory-args' => [ "d", "metaname" ],
-        'optional-args'   => [ "dv", "metapos" ] },
+            'optional-args'   => [ "dv", "metapos" ]
+    },
 
     "get-archives-assocfile" => { 
         'compulsory-args' => [ "d", "assocname" ],
-        'optional-args'   => [ "dv" ] },
+            'optional-args'   => [ "dv" ]
+    },
     
     "get-index-metadata" => { 
         'compulsory-args' => [ "d", "metaname" ],
-        'optional-args'   => [ "metapos" ] }, 
+            'optional-args'   => [ "metapos" ]
+    }, 
 
     "get-metadata" => { # alias for get-index-metadata
         'compulsory-args' => [ "d", "metaname" ],
-        'optional-args'   => [ "metapos" ] },
+        'optional-args'   => [ "metapos" ]
+    },
 
     "get-live-metadata" => { 
         'compulsory-args' => [ "d", "metaname" ],
-        'optional-args'   => [ ] }, 
+            'optional-args'   => [ ]
+    }, 
 
     "get-metadata-array" => { # where param can be ONE of: index (default), import, archives, live
@@ -108 +115 @@
         'optional-args'   => [ "where" ],
         'help-string' => [
-        'metadata-server.pl?a=get-metadata-array&c=demo&where=index&json=[{"docid":"HASHc5bce2d6d3e5b04e470ec9","metatable":[{"metaname":"username","metapos":"all"},{"metaname":"usertimestamp","metapos":"all"}, {"metaname":"usercomment","metapos":"all"}]}]'
-        ]}
+        'metadata-server.pl?a=get-metadata-array&c=demo&where=index&json=[{"docid":"HASHc5bce2d6d3e5b04e470ec9","metatable":[{"metaname":"username","metapos":"all"},{"metaname":"usertimestamp","metapos":"all"}, {"metaname":"usercomment","metapos":"all"}]}]' ]
+    },
+
+    "get-fldv-info" => { 
+        'compulsory-args' => [ "d", ],
+        'optional-args'   => [ ],
+        'help-string' => [
+            "fldv is short for file-level document-version history.  It refers to the filesystem level approach Greenstone takes to keeping a document version history of the documents formed in the 'archives' directory.  When collection is imported with -keepold, for example, any existing documents in the archives area get 'bundled up' as a subfolder called 'nminus-1' within the newly formed document.  If there is an existing 'nminus-1' subdirectory then this is moved to nminus-2 prior to forming a new 'nminus-1'.  And so on.",
+        "Calling this action returns in JSON formated the array of 'nminus-<n>' subdirectories that a particular document has." ]
+    }
 };
+
 
 # To get the final action_table of all available subroutines in this class,
@@ -1058 +1074 @@
 }
 
+
+
+sub get_fldv_info
+{
+    my $self = shift @_;
+
+    my $username  = $self->{'username'};
+    my $collect   = $self->{'collect'};
+    my $gsdl_cgi  = $self->{'gsdl_cgi'};
+    my $infodbtype = $self->{'infodbtype'};
+
+    # Obtain the collect 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 $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);
+
+    # This now stores the full pathname [is this still true??]
+    my $doc_file = $doc_rec->{'doc-file'}->[0]; 
+
+    my ($unused_doc_tailname, $doc_dirname) = File::Basename::fileparse($doc_file);
+    my $doc_full_dirname = &util::filename_cat($archive_dir,$doc_dirname);
+    
+    my $fldv_full_dirname = &util::filename_cat($doc_full_dirname,$FLDV_HISTORY_DIR);
+
+    my $sorted_fldv_filtered_dirs_json = "[]";
+    if (-d $fldv_full_dirname) {
+        my $fldv_filtered_dirs = &FileUtils::readDirectoryFiltered($fldv_full_dirname,undef,"^nminus-\\d+\$");
+
+        my @sorted_fldv_filtered_dirs = sort {
+        my ($a_num) = ($a =~ m/(\d+)$/);
+        my ($b_num) = ($b =~ m/(\d+)$/);
+        
+        # sort into ascending order
+        return $a_num <=> $b_num;
+        } @$fldv_filtered_dirs;
+        
+        $sorted_fldv_filtered_dirs_json = encode_json \@sorted_fldv_filtered_dirs;
+    }
+    
+    $gsdl_cgi->generate_ok_message($sorted_fldv_filtered_dirs_json);
+}
+
+
 sub get_metadata_from_archive_xml
 {