Changeset 27257 for main

Timestamp:

2013-04-24T21:20:27+12:00 (11 years ago)

Author:

ak19

Message:

Add User Comment form. Allows adding username, timestamp and comment to a document. Need to still display the just-added comment when the ajax reloads the page. Also should not display the form on a non-doc page, like when browsing a classifier.

Location:

main/trunk/greenstone2

Files:

• macros/document.dm (modified) (2 diffs)
• macros/english.dm (modified) (1 diff)
• web/script/gsajaxapi.js (modified) (4 diffs)

main/trunk/greenstone2/macros/document.dm

@@ -105 +105 @@
 <table width=_pagewidth_ cellpadding=0 cellspacing=0 border=0>
 <tr><td align=left valign=top>
+_usercomment_
 _prevarrow_
 </td><td align=right valign=top>
@@ -118 +119 @@
 _prevarrow_<br>
 _nextarrow_
+}
+
+#######################################################################
+# section for adding user comments: consists of form and its javascript
+#######################################################################
+
+# For 
+# http://stackoverflow.com/questions/4264091/input-type-submit-instead-of-input-type-button-with-ajax
+# http://stackoverflow.com/questions/8869341/ajax-form-submit-with-submit-button
+
+_usercomment_ {
+
+<form name="AddUserCommentForm">
+<p>_textcommentusername_ <input type="text" name="username"></p>
+<p>
+_textaddusercomment_
+<textarea name="comment" rows="10" cols="70"></textarea>
+<input type=hidden name="d" value="_cgiargd_">
+</p>
+
+<input type="submit" value="_textaddcomment_" onclick="addUserComment(document.AddUserCommentForm.username.value, document.AddUserCommentForm.comment.value, document.AddUserCommentForm.d.value); return false;">
+</form>
+
+<script type="text/javascript">  
+    function addUserComment(_username, _comment, _docid) \{
+
+        // Want to store username, timestamp and comment in import/metadata.xml, archives/doc.xml
+        // and index/col.gdb.
+
+        // For getting the current time, see
+        // http://stackoverflow.com/questions/3830244/get-current-date-time-in-seconds
+        var _timestamp = new Date().getTime(); // div by 1000 to get seconds. valueOf() may return string
+
+        //alert("username:" + _username
+        //+ "\\ncomment: " + _comment
+        //+ "\\ncollection: " + collection 
+        //+ "\\ndocid: " + _docid
+        //+ "\\ntimestamp: " + _timestamp); 
+
+
+        // To make individual api calls to set username meta, then timestamp then comment meta:
+        // GSAPI already knows the collection
+        //gsapi.setMetadata(_docid, "username", null, _username, "accumulate", "import|archives|index");
+        //gsapi.setMetadata(_docid, "usertimestamp", null, _timestamp, "accumulate", "import|archives|index");
+        //gsapi.setMetadata(_docid, "usercomment", null, _comment, "accumulate", "import|archives|index");
+
+
+        // Use the new JSON metatable format to set username, timestamp and comment meta for docid in one go
+
+        // For creating the JSON object that gets turned into a string, see
+        // http://msdn.microsoft.com/en-us/library/ie/cc836459%28v=vs.94%29.aspx
+        // http://jsfiddle.net/qmacro/W54hy/
+        
+        var username_rec = \{
+            metaname: "username",
+            metavals: [_username]
+        \};
+
+        var timestamp_rec = \{
+            metaname: "timestamp",
+            metavals: [_timestamp]
+        \};
+
+        var comment_rec = \{
+            metaname: "comment",
+            metavals: [_comment]
+        \};
+
+        var doc_rec = \{
+            docid: _docid,
+            metatable: [username_rec, timestamp_rec, comment_rec],
+            metamode: "accumulate"
+        \};
+
+        var docArray = [doc_rec];
+
+        //alert(JSON.stringify(docArray));
+
+        // GSAPI already knows the collection
+        gsapi.setMetadataArray(docArray, "accumulate","import|archives|index");
+
+    \}
+</script>
 }
 

main/trunk/greenstone2/macros/english.dm

@@ -336 +336 @@
 }
 
+_textcommentusername_ {User name:}
+_textaddusercomment_ {Add user comment:}
+_textaddcomment_ {add comment}
+
 _textgoto_ {go to page}
 _textintro_ { <i>(introductory text)</i>}

main/trunk/greenstone2/web/script/gsajaxapi.js

@@ -139 +139 @@
     }
     
-
-    
-    
-    
     this.setLiveMetadata = function(id,metaname,metavalue)
     {
@@ -155 +151 @@
         this.urlGetSync(url);
     }
-    
+
+    // New
+    // The where parameter can be specified as one or more of: import, archives, index, live 
+    // separated by |. If null, it is assumed to be index which is the original default 
+    // behaviour of calling set-metadata). E.g. where=import|archives|index
+    this.setMetadata = function(docid,metaname,metapos,metavalue,metamode,where)
+    {
+        var mdserver = this.metadataserverURL();
+    
+        var params = "a=set-metadata";
+    if(where != null) {
+        params += "&where=" + where; // if where not specified, meta-server will default to setting index meta
+        //} else {
+        //    params += "&where=import|archives|index";
+    }
+        params += "&c="+collect_;
+        params += "&d="+docid;
+        params += "&metaname=" + metaname;
+        if (metapos!=null) {
+            params += "&metapos=" + metapos;
+        }
+        params += "&metavalue=" + metavalue;
+    if (metamode!=null) {
+            params += "&metamode=" + metamode;
+    }
+    
+        this.urlGetSync(mdserver + "?" + params);
+        //this.urlPostSync(mdserver,params);
+    }
+
+    // New
+    // The where parameter can be specified as one or more of: import, archives, index, live 
+    // separated by |. If null, it is assumed to be index which is the original default 
+    // behaviour of calling set-metadata-array). E.g. where=import|archives|index
+    this.setMetadataArray = function(docArray,metamode,where) 
+    {
+    docArrayJSON = JSON.stringify(docArray);
+    
+    var mdserver = this.metadataserverURL();
+    
+    var params = "a=set-metadata-array";
+    if(where != null) {
+        params += "&where=" + where; // if where not specified, meta-server will default to setting index meta
+        //} else {
+        //    params += "&where=import|archives|index";
+    }
+    params += "&c="+collect_;
+    params += "&json="+docArrayJSON;
+    
+    if (metamode!=null) {
+        params += "&metamode=" + metamode;
+    }
+    
+    this.urlGetSync(mdserver + "?" + params);
+    
+    }
+
     this._setMetadata = function(mode,docid,metaname,metapos,metavalue,metamode)
     {
@@ -168 +220 @@
         }
         params += "&metavalue=" + metavalue;
-        if (metamode!=null) {
+    if (metamode!=null) {
             params += "&metamode=" + metamode;
-        }
+    }
     
         this.urlGetSync(mdserver + "?" + params);
@@ -177 +229 @@
     
     
-    this._setDocumentArrayMetadata = function(mode,docArray,metamode) 
-    {
-        docArrayJSON = JSON.stringify(docArray);
-  
-        var mdserver = this.metadataserverURL();
-    
-        var params = "a=set" + mode + "-metadata-array";
-        params += "&c="+collect_;
-        params += "&json="+docArrayJSON;
-    
-        if (metamode!=null) {
-            params += "&metamode=" + metamode;
-        }
-        
-        this.urlGetSync(mdserver + "?" + params);
-   
-    }
+    this._setDocumentArrayMetadata = function(mode,docArray,metamode) 
+    {
+    docArrayJSON = JSON.stringify(docArray);
+    
+    var mdserver = this.metadataserverURL();
+    
+    var params = "a=set" + mode + "-metadata-array";
+    params += "&c="+collect_;
+    params += "&json="+docArrayJSON;
+    
+    if (metamode!=null) {
+        params += "&metamode=" + metamode;
+    }
+    
+    this.urlGetSync(mdserver + "?" + params);
+    
+    }