Changeset 28872 for main

Timestamp:

2014-03-05T13:46:28+13:00 (10 years ago)

Author:

kjdon

Message:

deleted old unused code. added code to save current tokens to a file when server shuts down, and read them back in when server starts up. note if server crashes then tokens won't be saved. expired tokens are deleted.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/OAIResumptionToken.java (modified) (8 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/OAIResumptionToken.java

@@ -25 +25 @@
 
 import java.io.File;
+import java.net.URL;
 import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
+
 
 // import file Logger.java
@@ -39 +44 @@
   public static final String CURRENT_CURSOR = "current_cursor";
 
+  // for token XML
+  public static final String TOKEN = "token";
+  public static final String TOKEN_LIST = "tokenList";
+  public static final String NAME = "name";
+  public static final String EXPIRATION = "expiration";
+  //public static final String FROM
   public static final String FILE_SEPARATOR = File.separator;
   static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSXML.class.getName());
@@ -51 +62 @@
   private static HashMap<String, Long> expiration_data = new HashMap<String, Long>();
 
-  /** initialize stored resumption tokens */
+  /** initialize stored resumption tokens and clear any expired ones*/
   public static void init() {
-
-  }
+    if (!findOrCreateTokenFile()) {
+      // can't read in old tokens
+      logger.error("Can't find token file, so we can't initialise tokens");
+      return;
+    }
+
+    Document token_doc = converter.getDOM(resumption_token_file, "utf-8");
+    Element token_elem = null;
+    if (token_doc != null) {
+      token_elem = token_doc.getDocumentElement();
+    } else {
+      logger.error("Failed to parse oai resumption token file OAIResumptionToken.xml.");
+      resetTokenFile();
+      return;
+    }
+      
+    // read in stored tokens
+    NodeList tokens = token_elem.getElementsByTagName(TOKEN);
+    for(int i=0; i<tokens.getLength(); i++) {
+      Element token = (Element)tokens.item(i);
+      String set = token.getAttribute(OAIXML.SET);
+      if (set.isEmpty()) {
+    set = null;
+      }
+      String meta_prefix = token.getAttribute(OAIXML.METADATA_PREFIX);
+      if (meta_prefix.isEmpty()) {
+    meta_prefix = null;
+      }
+      String from = token.getAttribute(OAIXML.FROM);
+      if (from.isEmpty()) {
+    from = null;
+      }
+      String until = token.getAttribute(OAIXML.UNTIL);
+      if (until.isEmpty()) {
+    until = null;
+      }
+      storeToken(token.getAttribute(NAME), set, meta_prefix, from, until, token.getAttribute(EXPIRATION));
+
+    }
+  }
+  // store the token read in from saved tokens file
+  protected static void storeToken(String name, String set, String metadata_prefix, String from, String until, String expiration) {
+    HashMap<String, String> data = new HashMap<String, String>();
+    data.put(OAIXML.FROM, from);
+    data.put(OAIXML.UNTIL, until);
+    data.put(OAIXML.SET, set);
+    data.put(OAIXML.METADATA_PREFIX, metadata_prefix);
+    stored_tokens.put(name, data);
+    expiration_data.put(name, new Long(expiration));
+  }
+
   /** generate the token, and store all the data for it */
   public static String createAndStoreResumptionToken(String set, String metadata_prefix, String from, String until, String cursor, String current_set, String current_cursor) {
@@ -61 +121 @@
     String base_token_name = ""+expiration_date;
     stored_tokens.put(base_token_name, data);   
-    expiration_date += (OAIXML.token_expiration*1000);
+    expiration_date += (OAIXML.getTokenExpiration());
     expiration_data.put(base_token_name, new Long(expiration_date));
     String token_name = base_token_name+":" + cursor + ":" + current_set +":"+ current_cursor;
@@ -86 +146 @@
     // when we are generating a new token, we update the expiration date to allow the new token to have the full length of time
     long exp_date = System.currentTimeMillis();
-    exp_date += (OAIXML.token_expiration*1000);
+    exp_date += (OAIXML.getTokenExpiration());
     expiration_data.put(token, exp_date);
     
@@ -95 +155 @@
   /** check that this token is currently valid */
   public static boolean isValidToken(String token) {
+    // we clear expired tokens each time we check one.
+    clearExpiredTokens();
     // take off the set/cursor parts to check for the main key
     if (token.indexOf(":") != -1) {
@@ -118 +180 @@
       return null;
     }
+    // add in cursor, etc from the token name    
     if (base_name != token) {
       String[] parts = token.split(":");
@@ -127 +190 @@
       data.put(CURRENT_CURSOR, parts[3]);
     }
-    // add in cursor, etc form the token name
-    //return stored_tokens.get(token);
     return data;
 
   }
 
+  // read through all stored expiry dates, and delete any tokens that are too
+  // old
   public static void clearExpiredTokens() {
 
+    Set<Map.Entry<String,Long>> token_set = expiration_data.entrySet();
+    Iterator<Map.Entry<String,Long>> i = token_set.iterator();
+    int size = expiration_data.size();
+    logger.error("start tokens "+size);
+    Long time_now = System.currentTimeMillis();
+    while (i.hasNext()==true) {
+      Map.Entry<String,Long> entry = i.next();
+      String key = entry.getKey();
+      Long exp = entry.getValue();
+      if (exp < time_now) {
+    logger.error("token "+key+" is expired, "+ OAIXML.getTime(exp));
+    i.remove();
+    // also remove the token from the stored tokens
+    stored_tokens.remove(key);
+      }
+    }
+    size = expiration_data.size();
+    logger.error("end tokens "+size);
+  }
+
+  protected static boolean findOrCreateTokenFile() {
     
-  }
-  // ********************************************************************
-  // *********************************************************************
-  // following is old code
-  /** Read in OAIResumptionToken.xml (residing web/WEB-INF/classes/) */ 
-  public static Element getOAIResumptionTokenXML() {     
-      
-    // The system environment variable $GSDL3HOME(ends ../web) does not contain the file separator 
-    resumption_token_file = new File(GlobalProperties.getGSDL3Home() + FILE_SEPARATOR +
-                     "WEB-INF" + FILE_SEPARATOR + "classes" +FILE_SEPARATOR + "OAIResumptionToken.xml");
-    if (resumption_token_file.exists()) {
-      Document token_doc = converter.getDOM(resumption_token_file, "utf-8");
-      if (token_doc != null) {
-    resumption_token_elem = token_doc.getDocumentElement();
-      } else {
-    logger.error("Fail to parse resumption token file OAIReceptionToken.xml.");
-    return null;
-      }
-      //remove all expired tokens
-      clearExpiredTokens();
-      return resumption_token_elem;  
-    }
-    //if resumption_token_file does not exist        
-    logger.info("resumption token file: "+ resumption_token_file.getPath()+" not found! create an empty one.");
+    try {
+      URL token_file_url = Class.forName("org.greenstone.gsdl3.OAIServer").getClassLoader().getResource("OAIResumptionToken.xml");
+      if (token_file_url != null) {
+    resumption_token_file = new File(token_file_url.toURI());
+    if (resumption_token_file != null && resumption_token_file.exists()) {
+      return true;
+    }
+    else {
+      logger.error("Resumption token file found, "+ token_file_url.toURI()+" but couldn't create a file from it.");
+    }
+      }
+    } catch (Exception e) {
+      logger.error("couldn't find or ResumptionToken.xml "+e.getMessage());
+    }
+    // if we have got here, have't managed to load file via class loader -
+    // it may not exist yet.
+    // try and create a new empty one
+    if (resetTokenFile()) {
+      return true;
+    }
+    return false;
+  }
+
+  // If there was no file, or something went wrong with the file, use this to
+  // create a new one.
+  public static boolean resetTokenFile() {
+    resumption_token_file = new File(GlobalProperties.getGSDL3Home() + 
+                     FILE_SEPARATOR + "WEB-INF" + 
+                     FILE_SEPARATOR + "classes" +
+                     FILE_SEPARATOR + "OAIResumptionToken.xml");
+    try {
+      if (!resumption_token_file.createNewFile()) {
+    logger.error("Couldn't create a new resumption token file "+ resumption_token_file.getPath());
+    resumption_token_file = null;
+    return false;
+      }
+    } catch (Exception e) {
+      logger.error("Couldn't create a new resumption token file "+ resumption_token_file.getPath()+", "+e.getMessage());
+      resumption_token_file = null;
+      return false;
+    }
     Document doc = converter.newDOM();
-    resumption_token_elem = doc.createElement(/*OAI_RESUMPTION_TOKENS*/"resumptionTokens");
-    saveOAIResumptionTokenXML(resumption_token_elem);
-    return resumption_token_elem;
-  }
-  public static void saveOAIResumptionTokenXML(Element token_elem) {     
-    if(converter.writeDOM(token_elem, resumption_token_file) == false) {
-      logger.error("Fail to save the resumption token file");
-    }
-  }
-  public static void clearExpiredTokensOld() {
-    boolean token_deleted = false;
-    NodeList tokens = GSXML.getChildrenByTagName(resumption_token_elem, OAIXML.RESUMPTION_TOKEN);
-    for (int i=0; i<tokens.getLength(); i++) {
-      Element token_elem = (Element)tokens.item(i);
-      String expire_str = token_elem.getAttribute(OAIXML.EXPIRATION_DATE);
-      long datestamp = OAIXML.getTime(expire_str); // expire_str is in milliseconds
-      if(datestamp < System.currentTimeMillis()) {
-    resumption_token_elem.removeChild(token_elem);
-    token_elem = null;
-    token_deleted = true;
-      }
-    } 
-      
-    if(token_deleted) {
-      saveOAIResumptionTokenXML(resumption_token_elem);
-    }
-  }
-  public static boolean containsToken(String token) {
-    NodeList tokens = GSXML.getChildrenByTagName(resumption_token_elem, OAIXML.RESUMPTION_TOKEN);
-    for (int i=0; i<tokens.getLength(); i++) {
-      if(token.equals(GSXML.getNodeText((Element)tokens.item(i)).trim() ))
-    return true;
-    }
+    Element elem = doc.createElement(TOKEN_LIST);
+    if (converter.writeDOM(elem, resumption_token_file)) {
+      return true;
+    }
+    resumption_token_file = null;
     return false;
   }
-  public static void addToken(Element token) {
-    Document doc = resumption_token_elem.getOwnerDocument();
-    resumption_token_elem.appendChild(doc.importNode(token, true));
-    saveOAIResumptionTokenXML(resumption_token_elem);
-  }
-  public static void addToken(String token) {
-    Element te = resumption_token_elem.getOwnerDocument().createElement(OAIXML.RESUMPTION_TOKEN);
-    //add expiration att
-    resumption_token_elem.appendChild(te);
-    saveOAIResumptionTokenXML(resumption_token_elem);
-  }
-  public static boolean removeToken(String token) {
-    NodeList tokens = GSXML.getChildrenByTagName(resumption_token_elem, OAIXML.RESUMPTION_TOKEN);
-    int num_tokens = tokens.getLength();
-    for (int i=0; i<num_tokens; i++) {
-      Element e = (Element)(tokens.item(i));
-      if(token.equals(GSXML.getNodeText(e))) {
-    resumption_token_elem.removeChild(e);
-    saveOAIResumptionTokenXML(resumption_token_elem);
-    return true;
-      }
-    }
-    return false;      
-  }
-
+  
+
+  public static boolean saveTokensToFile() {
+    clearExpiredTokens();
+    if (resumption_token_file == null) {
+      logger.error("no available resumption token file, not storing tokens");
+      return false;
+    }
+    
+    // Create an XML representation of the stored tokens
+    Document doc = converter.newDOM();
+    Element token_list = doc.createElement(TOKEN_LIST);
+
+    if (stored_tokens.size() == 0) {
+      // nothing to store, store an empty file
+      converter.writeDOM(token_list, resumption_token_file);
+      return true;
+    }
+    Set<String> keys = stored_tokens.keySet();
+    Iterator<String> i = keys.iterator();
+    while(i.hasNext()) {
+      String token = i.next();
+      HashMap<String, String> data = stored_tokens.get(token);
+      Element token_elem = doc.createElement(TOKEN);
+      token_elem.setAttribute(NAME, token);
+      token_elem.setAttribute(OAIXML.FROM, data.get(OAIXML.FROM));
+      token_elem.setAttribute(OAIXML.UNTIL, data.get(OAIXML.UNTIL));
+      token_elem.setAttribute(OAIXML.SET, data.get(OAIXML.SET));
+      token_elem.setAttribute(OAIXML.METADATA_PREFIX, data.get(OAIXML.METADATA_PREFIX));
+      token_elem.setAttribute(EXPIRATION, ""+expiration_data.get(token));
+      token_list.appendChild(token_elem);
+    }
+    converter.writeDOM(token_list, resumption_token_file);
+    return true;
+  }
 
 }