Changeset 19984

Timestamp:

2009-07-13T10:25:21+12:00 (15 years ago)

Author:

oranfry

Message:

initial implementation of support for site-level metadata

Location:

greenstone3/trunk/src/java/org/greenstone/gsdl3

Files:

• LibraryServlet.java (modified) (1 diff)
• action/Action.java (modified) (2 diffs)
• action/BrowseAction.java (modified) (1 diff)
• action/DocumentAction.java (modified) (2 diffs)
• action/GS2BrowseAction.java (modified) (1 diff)
• action/GeneralAction.java (modified) (5 diffs)
• action/PageAction.java (modified) (9 diffs)
• action/QueryAction.java (modified) (6 diffs)
• core/MessageRouter.java (modified) (6 diffs)
• service/BerryBasket.java (modified) (2 diffs)
• util/GSXML.java (modified) (2 diffs)

greenstone3/trunk/src/java/org/greenstone/gsdl3/LibraryServlet.java

@@ -580 +580 @@
     }
 
-    // get all the <a> elements
-    NodeList hrefs = data.getElementsByTagName("a");
-    for (int i=0; i<hrefs.getLength(); i++) {
-      Element a = (Element)hrefs.item(i);
-      // ugly hack to get rid of : in the args - interferes with session handling
-      String href = a.getAttribute("href");
-      if (!href.equals("")) {
-        if (href.indexOf("?")!=-1) {
-          String[] parts = href.split("\\?", -1);
-          parts[1]=parts[1].replaceAll(":", "%3A");
-          href = parts[0]+"?"+parts[1];
-        }
-        a.setAttribute("href", response.encodeURL(href));
-      }
-    }
-    
-    // now find any submit bits - get all the <form> elements
-    NodeList forms = data.getElementsByTagName("form");
-    for (int i=0; i<forms.getLength(); i++) {
-      Element form = (Element)forms.item(i);
-      form.setAttribute("action", response.encodeURL(form.getAttribute("action")));
-    }
-    // are these the only cases where URLs occur??
-    // we should only do this for greenstone urls?
+    if ( data != null ) {
+
+        // get all the <a> elements
+        NodeList hrefs = data.getElementsByTagName("a");
+        for (int i=0; hrefs!=null && i<hrefs.getLength(); i++) {
+          Element a = (Element)hrefs.item(i);
+          // ugly hack to get rid of : in the args - interferes with session handling
+          String href = a.getAttribute("href");
+          if (!href.equals("")) {
+            if (href.indexOf("?")!=-1) {
+              String[] parts = href.split("\\?", -1);
+              parts[1]=parts[1].replaceAll(":", "%3A");
+              href = parts[0]+"?"+parts[1];
+            }
+            a.setAttribute("href", response.encodeURL(href));
+          }
+        }
+        
+        // now find any submit bits - get all the <form> elements
+        NodeList forms = data.getElementsByTagName("form");
+        for (int i=0; forms!=null && i<forms.getLength(); i++) {
+          Element form = (Element)forms.item(i);
+          form.setAttribute("action", response.encodeURL(form.getAttribute("action")));
+        }
+        // are these the only cases where URLs occur??
+        // we should only do this for greenstone urls?
+    }
     
   }

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/Action.java

@@ -37 +37 @@
     this.converter = new XMLConverter();
     this.doc = this.converter.newDOM();
+    System.err.println("action doc: " + doc );
     }
     /** the config variables must be set before configure is called */
@@ -134 +135 @@
     return true;
     }
+
+    void addSiteMetadata( Element element, String lang, String uid ) {
+        //ADD SITE METADATA
+        Element metadata_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, "", lang, uid);
+        //create a hashmap of params
+        HashMap subset_params = new HashMap(1);
+        subset_params.put(GSXML.SUBSET_PARAM, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
+        //create the element to put the params in
+        Element param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        //put them in
+        GSXML.addParametersToList( this.doc, param_list, subset_params );
+        metadata_request.appendChild(param_list);
+        //create the message
+        Element metadata_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
+        metadata_message.appendChild(metadata_request);
+
+        //get response
+        Element metadata_response_message = (Element)this.mr.process(metadata_message);
+
+        //drill down to response
+        Element metadata_response = (Element)GSXML.getChildByTagName(metadata_response_message, GSXML.RESPONSE_ELEM);
+
+        GSXML.mergeMetadataLists(element,metadata_response);
+
+    }
 }
 

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/BrowseAction.java

@@ -91 +91 @@
     page_response.appendChild(this.doc.importNode(service_description, true));
     
+    //append site metadata
+    addSiteMetadata(page_response, lang, uid);
+
     // if rt=d, then we are just displaying the service
     String request_type = (String)params.get(GSParams.REQUEST_TYPE);

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/DocumentAction.java

@@ -85 +85 @@
     // just in case there are some that need to get passed to the services
     HashMap service_params = (HashMap)params.get("s0"); 
+
     
     String has_rl = null;
@@ -131 +132 @@
         }
     }
+
+    //append site metadata
+    addSiteMetadata( page_response, lang, uid);
+
     // get the additional data needed for the page
     getBackgroundData(page_response, collection, lang, uid);

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/GS2BrowseAction.java

@@ -82 +82 @@
     page_response.appendChild(this.doc.importNode(service_description, true));
     
+    //append site metadata
+    addSiteMetadata( page_response, lang, uid);
+
     // if rt=d, then we are just displaying the service
     String request_type = (String)params.get(GSParams.REQUEST_TYPE);

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/GeneralAction.java

@@ -23 +23 @@
     Element request = (Element)GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
     logger.debug(" request="+this.converter.getString(request));
+
+    String lang = request.getAttribute(GSXML.LANG_ATT);
+    String uid = request.getAttribute(GSXML.USER_ID_ATT);
+
     //A shortcut action serving the flax web page requests
     if(request.getAttribute(GSXML.SUBACTION_ATT).equals(GSXML.FLAX_PAGE_GENERATION)
@@ -33 +37 @@
             page_response.appendChild((Element)this.doc.importNode(flaxPageNode, true));
         }
-        return result;      
+        addSiteMetadata(result, lang, uid);
+        System.err.println("a");
+        return result;
     }
     
@@ -47 +53 @@
     }
     String request_type = (String) params.get(GSParams.REQUEST_TYPE);
-    String lang = request.getAttribute(GSXML.LANG_ATT);
-    String uid = request.getAttribute(GSXML.USER_ID_ATT);
     // what is carried out depends on the request_type
     // if rt=d, then a describe request is done,
@@ -89 +93 @@
         if (response_only) {
         // just send the reponse as is
+        addSiteMetadata(result_response, lang, uid);
+        System.err.println("b");
         return result_response;
         }
@@ -116 +122 @@
     }
 
+    addSiteMetadata(page_response, lang, uid);
+    System.err.println("c");
     return result;
     }

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/PageAction.java

@@ -5 +5 @@
 //XML classes
 import org.w3c.dom.Node; 
-import org.w3c.dom.NodeList; 
-import org.w3c.dom.Document; 
+import org.w3c.dom.NodeList;
+import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
@@ -115 +115 @@
         String uid = request.getAttribute(GSXML.USER_ID_ATT);
         // extract the params from the cgi-request, 
-        Element cgi_paramList = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);        
+        Element cgi_paramList = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
         HashMap params = GSXML.extractParams(cgi_paramList, false);
         
@@ -122 +122 @@
             logger.error("about page requested with no collection or cluster specified!");
             // return an empty response
-            return this.doc.createElement(GSXML.RESPONSE_ELEM);
+            Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
+            addSiteMetadata(response, lang, uid);
+            return response;
         }
 
@@ -128 +130 @@
         Element coll_about_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
 
-        Element coll_about_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE,  coll_name, lang, uid);
+        Element coll_about_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, lang, uid);
         coll_about_message.appendChild(coll_about_request);
-
         Element coll_about_response = (Element)this.mr.process(coll_about_message);
-        
+
         // add collection type attribute to paramList
         String col_type = "";
@@ -159 +160 @@
             return null;
         }
-        
+
+
         // second, get the info for each service - we only want display items 
         // but for now, we'll just get it all
@@ -168 +170 @@
 
         Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
+        //add the site metadata
+        addSiteMetadata(response, lang, uid);
         return response;
     }
@@ -190 +194 @@
         if (coll_name == null || coll_name.equals("")) {
             // just return an empty response
-            return this.doc.createElement(GSXML.RESPONSE_ELEM);
+            Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
+            addSiteMetadata(response, lang, uid);
+            return response;
         }
 
@@ -205 +211 @@
 
         Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
+
+        //add the site metadata
+        addSiteMetadata(response, lang, uid);
+
         return response;
 
@@ -275 +285 @@
         return page_response;
     }
+
+
 }

greenstone3/trunk/src/java/org/greenstone/gsdl3/action/QueryAction.java

@@ -46 +46 @@
      */
     protected Element basicQuery(Element request) {
-    
+
     // the result
     Element page_response = this.doc.createElement(GSXML.RESPONSE_ELEM);
-    
+
     // extract the params from the cgi-request, and check that we have a coll specified
     Element cgi_param_list = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
@@ -84 +84 @@
         page_response.appendChild(service_description);
     }
-    
+
     if (request_type.indexOf("r") == -1) {
         // just a display request, no actual processing to do
-        return page_response;
-    }
-    
+        System.err.println("just a display request, no actual processing to do");
+        //append site metadata
+        addSiteMetadata( page_response, lang, uid);
+        return page_response;
+    }
+
     // check that we have some service params
     HashMap service_params = (HashMap)params.get("s1");
     if (service_params == null) { // no query
+        //append site metadata
+        addSiteMetadata( page_response, lang, uid);
         return page_response;
     }
@@ -116 +121 @@
     // check for errors
     if (processErrorElements(mr_query_response, page_response)) {
+        //append site metadata
+        addSiteMetadata( page_response, lang, uid);
         return page_response;
     }
@@ -143 +150 @@
         // add in a dummy doc node list - used by the display. need to think about this
         page_response.appendChild(this.doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER));
+        //append site metadata
+        addSiteMetadata( page_response, lang, uid);
         return page_response;
     }
@@ -152 +161 @@
         // append the doc list to the result
         page_response.appendChild(this.doc.importNode(document_list, true));
+        //append site metadata
+        addSiteMetadata( page_response, lang, uid);
         return page_response;
     }
@@ -203 +214 @@
     
     logger.debug("Query page:\n" + this.converter.getPrettyString(page_response));
+    //append site metadata
+    addSiteMetadata( page_response, lang, uid);
     return page_response;
     }

greenstone3/trunk/src/java/org/greenstone/gsdl3/core/MessageRouter.java

@@ -107 +107 @@
   /** list of sites that can be reached */
   protected Element site_list = null;
+  /** list of metadata for the site */
+  protected Element metadata_list = null;
   
   
@@ -120 +122 @@
     this.converter = new XMLConverter();
     this.doc = this.converter.newDOM();
+    System.err.println("mr doc: " + doc );
   }
   
@@ -420 +423 @@
     Element site_list_elem = (Element)GSXML.getChildByTagName(config_info, GSXML.SITE_ELEM+GSXML.LIST_MODIFIER);
     configureExternalSites(site_list_elem);
+
+    // load up the site metadata
+    this.metadata_list = this.doc.createElement(GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
+    Element metadata_list_elem = (Element)GSXML.getChildByTagName(config_info, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
+    loadMetadata(metadata_list_elem);
+
         
     return true;
@@ -724 +733 @@
     return true;
   }
+
+  /** Goes through the metadataList and loads each metadatum found */
+  protected boolean loadMetadata(Element config_metadata_list) {
+    
+    // load up the sites
+    logger.info("loading site metadata...");
+    if (config_metadata_list ==null ) {
+      logger.info("...none found");
+      return true;
+    }
+    
+    NodeList metadata = config_metadata_list.getElementsByTagName(GSXML.METADATA_ELEM);
+    if (metadata.getLength()==0) {
+      logger.info("...none found");
+      return true;
+    }
+    
+
+    for (int i=0; i<metadata.getLength(); i++) {
+      Element s = (Element)metadata.item(i);
+      this.metadata_list.appendChild(this.doc.importNode(s, true));
+    }
+    return true;
+  }
+
   
   /** get site info from external site
@@ -882 +916 @@
         response.appendChild(this.site_list);
         response.appendChild(this.service_list);
+        response.appendChild(this.metadata_list);
         return response;
       }
+
       NodeList params = param_list.getElementsByTagName(GSXML.PARAM_ELEM);
       
@@ -895 +931 @@
           if (info.equals(GSXML.COLLECTION_ELEM+GSXML.LIST_MODIFIER)) {
             response.appendChild(this.collection_list);
-            
           } else if (info.equals(GSXML.CLUSTER_ELEM+GSXML.LIST_MODIFIER)) {
             response.appendChild(this.cluster_list);
-            
           } else if (info.equals(GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER)) {
             response.appendChild(this.service_list);
           } else if (info.equals(GSXML.SITE_ELEM+GSXML.LIST_MODIFIER)) {
             response.appendChild(this.site_list);
+          } else if (info.equals(GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER)) {
+            response.appendChild(this.metadata_list);
           }
         }

greenstone3/trunk/src/java/org/greenstone/gsdl3/service/BerryBasket.java

@@ -32 +32 @@
 import org.greenstone.gsdl3.util.GSXML;
 import org.greenstone.gsdl3.util.GSPath;
+import org.greenstone.gsdl3.util.GlobalProperties;
 
 import java.net.InetAddress;
@@ -483 +484 @@
 
 
-    public Element processSendMail(Element request){
-    // Create a new (empty) result message
-    Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
-    
-    // Get the parameters of the request
-    Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-        
-        GSXML.printXMLNode(param_list);
-     
-    if (param_list == null) {
-        logger.error("BerryBasket Error: SendMail request had no paramList.");
-        return result;  // Return the empty result
-    }
-
-    HashMap params = GSXML.extractParams(param_list, false);
-      
-    String to = (String)params.get("address");
-        String subject = (String)params.get("subject");
-    String mailhost = (String)params.get("host");
-        String content =  (String)params.get("content");
-        String cc = (String)params.get("cc");
-        String bcc = (String)params.get("bcc");
-        username = (String)params.get("user");
-        password = (String)params.get("password");
-    String mailer = "msgsend";        
-       
-    try {
-       
-        Properties props = System.getProperties();
-        // XXX - could use Session.getTransport() and Transport.connect()
-        // XXX - assume we're using SMTP
-        // TODO: need to get Mail server info from the configuration file
-        if (mailhost != null && mailhost.trim().equals(""))
-        props.put("mail.smtp.host", mailhost);
-        else{
-        props.put("mail.smtp.host", "webmail.cs.waikato.ac.nz"); 
-        }
-
-        // TODO: need to get account info from the configuration file
-            Authenticator auth = new Authenticator(){
-         protected  PasswordAuthentication  getPasswordAuthentication(){
-             if (username == null || username.equals("")){
-             username = "xxxxx";
-                         password = "xxxxx";
-             }
-              return new PasswordAuthentication(username,password);
-          }
-            };
-    
-           Session session = Session.getInstance(props, auth);
-
-       Message msg = new MimeMessage(session);
-       msg.setFrom();
-
-       msg.setRecipients(Message.RecipientType.TO,
-                 InternetAddress.parse(to, false));
-       if (cc != null)
-           msg.setRecipients(Message.RecipientType.CC,
-                 InternetAddress.parse(cc, false));
-        if (bcc != null)
-        msg.setRecipients(Message.RecipientType.BCC,
-                  InternetAddress.parse(bcc, false));
-
-        msg.setSubject(subject);
-        
-            msg.setText(content.replaceAll("-------","&"));
-        msg.setHeader("X-Mailer", mailer);
-        msg.setSentDate(new Date());
-
-        // send the thing off
-        Transport.send(msg);
-        
-        logger.info("\nMail was sent successfully.");
-            result.appendChild(this.doc.createTextNode("Mail was sent successfully."));
-    } catch (Exception e) {
-        e.printStackTrace();
-            result.appendChild(this.doc.createTextNode(e.getMessage()));
-    }
-    
-    return result;
-    }
-
-    protected class Item {
-
-    public String collection;
-    public String docid;
-        public String title="";
-        public String query="";
-        public String date="";
-        public String rootTitle="";
-
-    public Item(String coll, String id) {
-        this.collection = coll;
-        this.docid = id;
-        }
+    public Element processSendMail(Element request){
+        // Create a new (empty) result message
+        Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
+        
+        // Get the parameters of the request
+        Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        
+        GSXML.printXMLNode(param_list);
+        
+        if (param_list == null) {
+            logger.error("BerryBasket Error: SendMail request had no paramList.");
+            return result;  // Return the empty result
+        }
+        
+        HashMap params = GSXML.extractParams(param_list, false);
+        
+        String to = (String)params.get("address");
+        String subject = (String)params.get("subject");
+        String content = (String)params.get("content");
+        String cc = (String)params.get("cc");
+        String bcc = (String)params.get("bcc");
+        
+        String mailhost = GlobalProperties.getProperty("mail.smtp.host");
+        username = GlobalProperties.getProperty("mail.smtp.username");
+        password = GlobalProperties.getProperty("mail.smtp.password");
+        String from = GlobalProperties.getProperty("mail.from");
+        
+        String mailer = "msgsend";
+        
+        try {
+            
+            Properties props = System.getProperties();
+            
+            //Setup smtp host and from address
+            // XXX - could use Session.getTransport() and Transport.connect()
+            // XXX - assume we're using SMTP
+            if ( mailhost != null && !mailhost.trim().equals("") ) {
+                props.put("mail.smtp.host", mailhost);
+            } else {
+                props.put("mail.smtp.host", "localhost");
+            }
+            if ( from != null && !from.trim().equals("") ) {
+                props.put("mail.from", from);
+            }
+            
+            //setup username and password to the smtp server
+            if ( username == null || username.trim().equals("") ) username = "";
+            if ( password == null || password.trim().equals("") ) password = "";
+            Authenticator auth = new Authenticator() {
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication( username, password );
+                }
+            };
+            
+            Session session = Session.getInstance(props, auth);
+            
+            Message msg = new MimeMessage(session);
+            msg.setFrom();
+            msg.setRecipients( Message.RecipientType.TO, InternetAddress.parse(to, false) );
+            if ( cc != null ) {
+                msg.setRecipients(Message.RecipientType.CC, InternetAddress.parse(cc, false) );
+            }
+            if ( bcc != null ) {
+                msg.setRecipients(Message.RecipientType.BCC, InternetAddress.parse(bcc, false) );
+            }
+            msg.setSubject(subject);
+            msg.setText(content.replaceAll("-------","&"));
+            msg.setHeader("X-Mailer", mailer);
+            msg.setSentDate(new Date());
+            
+            // send the thing off
+            Transport.send(msg);
+            
+            logger.info("\nMail was sent successfully.");
+            result.appendChild(this.doc.createTextNode("Mail was sent successfully."));
+        } catch (Exception e) {
+            e.printStackTrace();
+            result.appendChild(this.doc.createTextNode(e.getMessage()));
+        }
+        
+        return result;
+    }
+
+
+    protected class Item {
+        public String collection;
+        public String docid;
+        public String title="";
+        public String query="";
+        public String date="";
+        public String rootTitle="";
+        
+        public Item(String coll, String id) {
+            this.collection = coll;
+            this.docid = id;
+        }
 
         public boolean equals(Object o){

greenstone3/trunk/src/java/org/greenstone/gsdl3/util/GSXML.java

@@ -25 +25 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Text;
+
+
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.Transformer;
+import java.io.StringWriter;
+import javax.xml.transform.stream.StreamResult;
+import javax.xml.transform.dom.DOMSource;
 
 import java.util.Map;
@@ -970 +977 @@
     
   }
+
+  public static void elementToLogAsString(Element e) {
+    try {
+      TransformerFactory tf = TransformerFactory.newInstance();
+      Transformer trans = tf.newTransformer();
+      StringWriter sw = new StringWriter();
+      trans.transform(new DOMSource(e), new StreamResult(sw));
+      System.err.println( sw.toString() );
+    } catch( Exception ex ) {
+      System.err.println( "couldn't write " + e + " to log" );
+    }
+
+  }
 }