Changeset 27312 for main

Timestamp:

2013-05-07T17:07:03+12:00 (11 years ago)

Author:

ak19

Message:

get_metadata_array which takes a JSON string and returns one, implemented for getting index metadata. archives, import and live will be implemented later after testing the current implementation against the javascript for retrieving user added comments.

File:

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

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

@@ -66 +66 @@
         'optional-args'   => [ ] }, 
 
+    "get-metadata-array" => { # where param can be ONE of: index (default), import, archives, live
+        'compulsory-args' => [ "json" ],
+        '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"}]}]'
+        ]},
+
     #SET METHODS
     "set-live-metadata" => { 
@@ -238 +245 @@
     $self->get_index_metadata(@_);
 }
+
+# JSON version that will get the requested metadata values 
+# from the requested source (index, import, archives or live)
+# One of the params is a JSON string and the return value is JSON too
+# http://forums.asp.net/t/1844684.aspx/1 - Web api method return json in string
+sub get_metadata_array
+{
+    my $self = shift @_;
+
+    my $where = $self->{'where'};
+    if (!$where) {  
+    $where = "index"; # default behaviour is to get the values from index
+    }
+
+    # Only when setting metadata do we perform authentication and do we lock the collection
+    # not when getting metadata
+
+    # for get_meta_array, the where param can only be ONE of import, archives, index, live
+    if($where =~ m/index/) {
+    $self->_get_index_metadata_array(@_);
+    }
+    # still to be implemented for archives, import and live
+}
+
+# takes a JSON string and returns a JSON string
+sub _get_index_metadata_array
+{
+    my $self = shift @_;
+
+    my $collect   = $self->{'collect'};
+    my $gsdl_cgi  = $self->{'gsdl_cgi'};
+    my $site = $self->{'site'};
+    my $collect_dir = $gsdl_cgi->get_collection_dir($site);
+
+    # look up additional args    
+    my $infodbtype = $self->{'infodbtype'};
+    
+    # To people who know $collect_tail please add some comments
+    # Obtain the path to the database
+    my $collect_tail = $collect;
+    $collect_tail =~ s/^.*[\/\\]//;
+    my $index_text_directory = &util::filename_cat($collect_dir,$collect,"index","text");
+    my $infodb_file_path = &dbutil::get_infodb_file_path($infodbtype, $collect_tail, $index_text_directory);
+
+    my $json_str      = $self->{'json'};
+    my $doc_array = decode_json $json_str;
+
+    my $json_result_str = "[";
+    my $first_doc_rec = 1;
+
+    foreach my $doc_array_rec ( @$doc_array ) {
+    
+    my $docid     = $doc_array_rec->{'docid'};
+    
+    if($first_doc_rec) {
+        $first_doc_rec = 0;
+    } else {
+        $json_result_str .= ",";
+    }
+    $json_result_str = $json_result_str . "{docid:\"" . $docid . "\"";  
+
+    my $metatable = $doc_array_rec->{'metatable'}; # a subarray, or need to generate an error saying JSON structure is wrong
+    $json_result_str = $json_result_str . ",metatable:[";
+
+    my $first_rec = 1;
+    foreach my $metatable_rec ( @$metatable ) { # the subarray metatable is an array of hashmaps        
+        if($first_rec) {
+        $first_rec = 0;
+        } else {
+        $json_result_str .= ",";        
+        }
+        
+        my $metaname  = $metatable_rec->{'metaname'};
+        $json_result_str .= "{metaname:\"$metaname\",metavals:[";
+
+        my $metapos   = $metatable_rec->{'metapos'}; # 0... 1|all|undefined
+        if(!defined $metapos) {
+        $metapos = "all";
+        }
+
+         # Read the docid entry
+        my $doc_rec = &dbutil::read_infodb_entry($infodbtype, $infodb_file_path, $docid);
+  
+        # Basically loop through and unescape_html the values
+        foreach my $k (keys %$doc_rec) {
+        my @escaped_v = ();
+        foreach my $v (@{$doc_rec->{$k}}) {
+            my $ev = &ghtml::unescape_html($v);
+            push(@escaped_v, $ev);
+        }
+        $doc_rec->{$k} = \@escaped_v;
+        }
+
+        # Obtain the specified metadata value(s)
+        my $metavalue;
+
+        if($metapos ne "all") { # get the value at a single metapos
+
+        $metavalue = $doc_rec->{$metaname}->[$metapos];     
+        $json_result_str .= "{metapos:\"$metapos\",metavalue:\"$metavalue\"}";
+
+        } else {
+        my $first_metaval = 1;
+        $metapos = 0;
+        $metavalue = $doc_rec->{$metaname}->[$metapos];
+
+        while (defined $metavalue) {
+            if($first_metaval) {        
+            $first_metaval = 0;
+            } else {
+            $json_result_str .= ",";
+            }
+        
+            $json_result_str .= "{metapos:\"$metapos\",metavalue:\"$metavalue\"}";
+
+            $metapos++;
+            $metavalue = $doc_rec->{$metaname}->[$metapos];         
+        }
+        }
+
+        $json_result_str .= "]}"; # close metavals array and metatable record
+    }
+    
+    $json_result_str .= "]}"; # close metatable array and docid record
+    }
+
+    $json_result_str .= "]"; # close array of docids
+
+    $gsdl_cgi->generate_ok_message($json_result_str);    
+}
+
 
 sub get_index_metadata