Changeset 24071 for main/trunk/greenstone2/perllib/cgiactions/explodeaction.pm

Timestamp:

2011-05-20T16:34:22+12:00 (13 years ago)

Author:

davidb

Message:

Introduction of actions that take an array of items (e.g. an array of OIDs or filenames). In adding in this ability, we have started to make use of JSON.

Another action added in is the ability to control building using a manifest file (its fields passed in using JSON). Also the ability to delete files in the archives directory (i.e. when a collection is beeing used in an 'onlyadd' way). Still needs to the more general case to be implemented.

/DB/

File:

• main/trunk/greenstone2/perllib/cgiactions/explodeaction.pm (modified) (4 diffs)

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

@@ -34 +34 @@
 use util;
 
+use JSON;
+
 use File::Basename;
 
@@ -50 +52 @@
 my $action_table =
 { 
-    "explode"          => { 'compulsory-args' => ["d"],
-                'optional-args'   => [] }
+    "explode-document"          => { 'compulsory-args' => ["d"],
+                'optional-args'   => [] },
+    "delete-document"           => { 'compulsory-args' => ["d"],
+                'optional-args'   => [ "onlyadd" ] },
+    "delete-document-array"     => { 'compulsory-args' => ["json"],
+                'optional-args'   => [ "onlyadd" ] }
+                
+                
 };
 
@@ -257 +265 @@
 
 
-sub explode 
+sub remove_docoids
+{
+    my $self = shift @_;
+    my ($docids) = @_;
+
+    my $collect   = $self->{'collect'};
+    my $gsdl_cgi  = $self->{'gsdl_cgi'};
+    my $infodb_type = $self->{'infodbtype'};
+
+    # Derive the archives and import directories
+    my $site = $self->{'site'};
+    my $collect_dir = $gsdl_cgi->get_collection_dir($site);
+    
+    my $archive_dir = &util::filename_cat($collect_dir,$collect,"archives");
+
+    # Obtain the doc.xml path for the specified docID
+    my $arcinfo_doc_filename 
+    = &dbutil::get_infodb_file_path($infodb_type, "archiveinf-doc", 
+                    $archive_dir);
+
+    foreach my $docid (@$docids) {
+
+        my $doc_rec
+            = &dbutil::read_infodb_entry($infodb_type, $arcinfo_doc_filename, 
+                     $docid);
+
+        my $doc_xml_file = $doc_rec->{'doc-file'}->[0];
+
+        # The $doc_xml_file is relative to the archives, so need to do
+        # a bit more work to make sure the right folder containing this
+        # is moved to the right place in the import folder
+
+        my $assoc_path = dirname($doc_xml_file);
+        my $archive_assoc_dir = &util::filename_cat($archive_dir,$assoc_path);
+
+        &util::rm_r($archive_assoc_dir)
+    }
+}
+
+
+sub explode_document 
 {
     my $self = shift @_;
@@ -309 +357 @@
 
 
+sub delete_document_entry
+{
+    my $self = shift @_;
+    my ($docid_root,$opt_onlyadd) = @_;
+    
+    my $docid_keys = [];
+    if ((defined $opt_onlyadd) && ($opt_onlyadd==1)) {
+        # delete docoid archive folder
+        push(@$docid_keys,$docid_root);
+    }
+    else {
+        print STDERR "**** Not currently implemented for the general case!!\nDeleting 'archive' version only.";
+        
+        push(@$docid_keys,$docid_root);
+        
+        #my $orig_import_filenames = $self->docid_to_import_filenames($docid_root);
+        #$docid_keys = $self->import_filenames_to_docids($orig_import_filenames);
+        #my $expanded_import_filenames = $self->docid_to_import_filenames(@$docid_keys);
+        
+        # need to remove only the files that are not 
+        
+        #$self->remove_import_filenames($expanded_import_filenames);
+    }
+   
+    $self->remove_docoids($docid_keys);
+}
+    
+
+sub delete_document
+{
+    my $self = shift @_;
+
+    my $username  = $self->{'username'};
+    my $collect   = $self->{'collect'};
+    my $gsdl_cgi  = $self->{'gsdl_cgi'};
+    my $gsdl_home  = $self->{'gsdlhome'};
+
+    # Authenticate user if it is enabled
+    if ($baseaction::authentication_enabled) {
+    # Ensure the user is allowed to edit this collection
+    &authenticate_user($gsdl_cgi, $username, $collect);
+    }
+    
+    # Derive the archives dir    
+    my $site = $self->{'site'};
+    my $collect_dir = $gsdl_cgi->get_collection_dir($site);
+    
+    my $archive_dir = &util::filename_cat($collect_dir,$collect,"archives");
+    ##my $archive_dir = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"archives");
+
+    # Make sure the collection isn't locked by someone else
+    $self->lock_collection($username, $collect);
+
+    # look up additional args
+    my $docid  = $self->{'d'};
+    if ((!defined $docid) || ($docid =~ m/^\s*$/)) {
+    $self->unlock_collection($username, $collect);
+    $gsdl_cgi->generate_error("No docid (d=...) specified.");
+    }
+
+    my ($docid_root,$docid_secnum) = ($docid =~ m/^(.*?)(\..*)?$/);
+
+    my $onlyadd = $self->{'onlyadd'};
+
+    my $status = $self->delete_document_entry($docid_root,$onlyadd);    
+
+    # Release the lock once it is done
+    $self->unlock_collection($username, $collect);
+
+    my $mess = "delete-document successful: Key[$docid_root]\n";
+    $gsdl_cgi->generate_ok_message($mess);
+
+}
+
+
+sub delete_document_array
+{
+    my $self = shift @_;
+
+    my $username  = $self->{'username'};
+    my $collect   = $self->{'collect'};
+    my $gsdl_cgi  = $self->{'gsdl_cgi'};
+    my $gsdlhome  = $self->{'gsdlhome'};
+
+    if ($baseaction::authentication_enabled) {
+    # Ensure the user is allowed to edit this collection
+    &authenticate_user($gsdl_cgi, $username, $collect);
+    }
+
+    my $site = $self->{'site'};
+    my $collect_dir = $gsdl_cgi->get_collection_dir($site);
+    
+    $gsdl_cgi->checked_chdir($collect_dir);
+
+    # Obtain the collect dir
+    ## my $collect_dir = &util::filename_cat($gsdlhome, "collect");
+
+    # Make sure the collection isn't locked by someone else
+    $self->lock_collection($username, $collect);
+
+    # look up additional args
+    
+    my $json_str      = $self->{'json'};
+    my $doc_array = decode_json $json_str;
+
+    my $onlyadd = $self->{'onlyadd'};
+    
+    
+    my $global_status = 0;
+    my $global_mess = "";
+    
+    my @all_docids = ();
+    
+    foreach my $doc_array_rec ( @$doc_array ) {
+        
+        my $docid     = $doc_array_rec->{'docid'};
+        
+        push(@all_docids,$docid);
+        
+        my ($docid_root,$docid_secnum) = ($docid =~ m/^(.*?)(\..*)?$/);
+          
+        my $status = $self->delete_document_entry($docid_root,$onlyadd);    
+        
+        if ($status != 0) {
+            # Catch error if set infodb entry failed
+            $global_status = $status;
+            $global_mess .= "Failed to delete document key: $docid\n";
+            $global_mess .= "Exit status: $status\n";
+            $global_mess .= "System Error Message: $!\n";
+            $global_mess .= "-" x 20;
+        }
+    }
+
+    if ($global_status != 0) {
+        $global_mess .= "PATH: $ENV{'PATH'}\n";
+        $gsdl_cgi->generate_error($global_mess);
+    }
+    else {
+        my $mess = "delete-document-array successful: Keys[ ".join(", ",@all_docids)."]\n";
+        $gsdl_cgi->generate_ok_message($mess);
+    }
+    
+    # Release the lock once it is done
+    $self->unlock_collection($username, $collect);
+}
+
+
 
 1;