Changeset 5762

Timestamp:

Nov 28, 2019, 1:52:09 PM (3 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1207: Replace the "Nothing yet" in the activity log with a quote-of-the-day

Quotes can now be downloaded from ​https://quotes.rest/qod.json

Location:

extensions/net.sf.basedb.reggie/trunk

Files:

• config/reggie-config.xml (modified) (1 diff)
• src/net/sf/basedb/reggie/activity/ActivityLog.java (modified) (5 diffs)
• src/net/sf/basedb/reggie/activity/QuoteOfTheDay.java (modified) (2 diffs)

extensions/net.sf.basedb.reggie/trunk/config/reggie-config.xml

@@ -23 +23 @@
     <!-- Max age (in days) of entries to display (even if the max number hasn't been reached) -->
     <max-age-in-days>14</max-age-in-days>
+    <quote-of-the-day>
+      <!-- URL to quote-of-the-day endpoint (optional, set an empty URL to disable this feature) -->
+      <url>https://quotes.rest/qod.json</url>
+      <!-- Default is 12 hours; do not set to less than 3600 since the external API has a limit -->
+      <max-age-in-seconds>43200</max-age-in-seconds>
+    </quote-of-the-day>
   </activity-log>
 

extensions/net.sf.basedb.reggie/trunk/src/net/sf/basedb/reggie/activity/ActivityLog.java

@@ -1 +1 @@
 package net.sf.basedb.reggie.activity;
 
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.StringWriter;
+import java.net.URL;
+import java.net.URLConnection;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.text.SimpleDateFormat;
 import java.time.LocalDateTime;
@@ -21 +27 @@
 import org.jdom2.output.Format;
 import org.jdom2.output.XMLOutputter;
+import org.json.simple.JSONArray;
+import org.json.simple.JSONObject;
+import org.json.simple.parser.JSONParser;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import net.sf.basedb.clients.web.extensions.ExtensionsControl;
+import net.sf.basedb.core.AbsoluteProgressReporter;
 import net.sf.basedb.core.Application;
 import net.sf.basedb.reggie.Reggie;
 import net.sf.basedb.reggie.XmlConfig;
+import net.sf.basedb.util.FileUtil;
 import net.sf.basedb.util.Values;
 
@@ -106 +117 @@
   private int maxAgeInDays = 14;
   private int maxEntries = 35;
+  private int maxQuoteAgeInSeconds = 3600 * 12; //  12 hours is the default
+  private URL quoteUrl;
   
   private volatile byte[] rssFeed;
@@ -187 +200 @@
     maxAgeInDays = Values.getInt(cfg.getConfig("activity-log/max-age-in-days"), 14);
     maxEntries = Values.getInt(cfg.getConfig("activity-log/max-entries"), 35);
+    maxQuoteAgeInSeconds = Values.getInt(cfg.getConfig("activity-log/quote-of-the-day/max-age-in-seconds"), 12*3600);
+    try
+    {
+      quoteUrl = new URL(cfg.getConfig("activity-log/quote-of-the-day/url"));
+    }
+    catch (Exception ex)
+    {
+      quoteUrl = null;
+    }
   }
 
   public QuoteOfTheDay getQuoteOfTheDay()
   {
-    if (quoteOfTheDay == null)
-    {
-      QuoteOfTheDay tmp = new QuoteOfTheDay();
-      tmp.setAuthor("Indiana Jones - Raiders of the Lost Ark");
-      tmp.setQuote("There's a big snake in the plane, Jock!");
-      quoteOfTheDay = tmp;
-    }
-    return quoteOfTheDay;
+    if (quoteUrl == null) return null; // Disabled
+    
+    if (quoteOfTheDay == null || quoteOfTheDay.getAgeInSeconds() > maxQuoteAgeInSeconds)
+    {
+      synchronized (quoteUrl)
+      {
+        if (quoteOfTheDay == null || quoteOfTheDay.getAgeInSeconds() > maxQuoteAgeInSeconds)
+        {
+          InputStream in = null;
+          QuoteOfTheDay tmp = new QuoteOfTheDay();
+          try
+          {
+            // Read data from the URL, if external we have a fixed limit
+            AbsoluteProgressReporter maxDataFilter = quoteUrl.getProtocol().startsWith("http") ? new MaxDownloadFilter(5000) : null;
+            logger.debug("Loading quote from " + quoteUrl);
+            URLConnection conn = quoteUrl.openConnection();
+            conn.setConnectTimeout(3000);
+            conn.setReadTimeout(3000);
+            in = conn.getInputStream();
+            StringWriter sout = new StringWriter();
+            FileUtil.copy(new InputStreamReader(in, StandardCharsets.UTF_8), sout, maxDataFilter);
+            logger.debug("A quote was loaded from " + quoteUrl + "; bytes="+sout.getBuffer().length());
+            
+            // Parse as JSON { "contents": { "quotes": [ {"quote": "...", "author": "..." }, {...} ] }}
+            JSONObject json = (JSONObject)new JSONParser().parse(sout.toString());
+            json = (JSONObject)json.get("contents");
+            JSONArray jsonQuotes = (JSONArray)json.get("quotes");
+            
+            int index = (int)Math.floor(Math.random()*jsonQuotes.size());
+            JSONObject jsonQuote = (JSONObject)jsonQuotes.get(index);       
+            String quote = (String)jsonQuote.get("quote");
+            String author = (String)jsonQuote.get("author");
+            
+            // Check that we have values of acceptable lengths            
+            if (quote != null && author != null && quote.length() < 160 && author.length() < 40)
+            {
+              tmp.setAuthor(author);
+              tmp.setQuote(quote);
+              logger.debug("A quote was successfully loaded from "+ quoteUrl);
+            }
+          }
+          catch (Exception ex)
+          {
+            logger.warn("Could not load quote-of-the-day", ex);
+          }
+          finally
+          {
+            FileUtil.close(in);
+            quoteOfTheDay = tmp;
+          }
+        }
+      }
+    }
+    else if (logger.isDebugEnabled() || true)
+    {
+      logger.debug("Using existing quote; age="+quoteOfTheDay.getAgeInSeconds());
+    }
+    return quoteOfTheDay == null || quoteOfTheDay.getQuote() == null ? null : quoteOfTheDay;
   }
   
@@ -441 +513 @@
   }
 
+  /**
+    To prevent external data overflow.
+  */
+  static class MaxDownloadFilter
+    implements AbsoluteProgressReporter
+  {
+  
+    private final long maxBytes;
+    
+    public MaxDownloadFilter(long maxBytes) 
+    {
+      this.maxBytes = maxBytes;
+    }
+    
+    @Override
+    public void display(int percent, String message) 
+    {}
+  
+    @Override
+    public void append(String message) 
+    {}
+  
+    @Override
+    public void displayAbsolute(long completed, String message) 
+    {
+      if (completed > maxBytes)
+      {
+        throw new RuntimeException("Too much data: " + completed + "; max allowed: " + maxBytes);
+      }
+    }
+  
+  }
 }

extensions/net.sf.basedb.reggie/trunk/src/net/sf/basedb/reggie/activity/QuoteOfTheDay.java

@@ -7 +7 @@
 public class QuoteOfTheDay 
 {
+  private final long created;
   private String quote;
   private String author;
   
   public QuoteOfTheDay()
-  {}
+  {
+    this.created = System.currentTimeMillis();
+  }
   
   /**
@@ -39 +42 @@
   }
   
+  /**
+    Get the age of the quote in seconds.
+  */
+  public int getAgeInSeconds()
+  {
+    return (int)((System.currentTimeMillis() - created) / 1000);
+  }
+  
 }