Support full log viewing.

Author: yasushi-saito

AndroidManifest.xml

@@ -36,6 +36,9 @@
         <activity android:name=".OptusPlayerListActivity"
                   android:label="@string/app_name">
         </activity>
+        <activity android:name=".OptusGameLogListActivity"
+                  android:label="@string/app_name">
+        </activity>
         <activity android:name=".ShogiPreferenceActivity"
                   android:label="@string/app_name">
         </activity>

src/com/ysaito/shogi/ExternalCacheManager.java

@@ -15,29 +15,46 @@
 
 /**
  * Class for managing a file system directory (Context.getCacheDir) as an LRU cache.
- * This class is generally MT safe, except that the constructor must be called by the application's main 
- * event loop thread, since it calls Context.getCacheDir, which doesn't look MT safe.
+ * This class is generally MT safe, except for getInstance(), which must be called by the application's main 
+ * event loop thread; it calls Context.getCacheDir, which doesn't look MT safe.
  */
 public class ExternalCacheManager {
   private static final String TAG = "ExtenalCacheManager"; 
   private final File mDir;
   private final Context mContext;
+  private static final int MAX_CACHE_STALENESS_MS = 7200 * 1000; // 2h
 
   // Cache key -> last access time
   private HashMap<String, Long> mLastAccessTimes;
 
   // The path where a serialized mLastAccessTimes is saved serialized.
   private static final String SUMMARY_PATH = "external_cache_summary";
-  
-  // TODO: add background purging
-  
+
+  private static final HashMap<String, ExternalCacheManager> mInstances =
+      new HashMap<String, ExternalCacheManager>();
+
   /**
+   * Create and return a process-wide cache instance. This method must be called by the
+   * main application event loop thread.
+   * 
+   * @param context It should be the value of getApplicationContext().
    * 
    * @param id The ID for this cache. It can be any string (it should be usable as a filename). 
    * It should be unique within the application, so that
    * multiple instances of this class can partition the per-application cache space.
    */
-  public ExternalCacheManager(Context context, String id) {
+  public static ExternalCacheManager getInstance(Context context, String id) {
+    ExternalCacheManager c = mInstances.get(id);
+    if (c == null) {
+      c = new ExternalCacheManager(context, id);
+      mInstances.put(id, c);
+    }
+    return c;
+  }
+  
+  // TODO: add background purging
+  
+  private ExternalCacheManager(Context context, String id) {
     mContext = context;
     mDir = new File(context.getCacheDir(), id);
     mDir.mkdirs();
@@ -75,6 +92,11 @@ public synchronized void clearAll() {
       Log.d(TAG, SUMMARY_PATH + ": Failed to clear cache: " + e.toString());
     }
   }
+
+  private static class CacheEntry implements Serializable {
+    long createMs;  // The time the entry was created. Millisec since the epoch
+    Serializable obj;
+  }
 
   /**
    * Write the mapping key -> obj to the cache. Errors (e.g., IOError) are simply ignored.
@@ -83,12 +105,16 @@ public synchronized void clearAll() {
    * chars such as '/'.
    */
   public synchronized void write(String key, Serializable obj) {
+    CacheEntry ent = new CacheEntry();
+    ent.createMs = System.currentTimeMillis();
+    ent.obj = obj;
+    
     FileOutputStream data_out = null;
     try {
       try {
         File path = new File(mDir, key);
         data_out = new FileOutputStream(path);
-        new ObjectOutputStream(data_out).writeObject(obj);
+        new ObjectOutputStream(data_out).writeObject(ent);
         mLastAccessTimes.put(key, System.currentTimeMillis());
         saveSummary();
       } finally {
@@ -103,25 +129,36 @@ public synchronized void write(String key, Serializable obj) {
    * If object for "key" is in the cache, return it. Else, or in case of an error (e.g., IOError)
    * return null.
    */
-  public synchronized Object read(String key) {
+  public static class ReadResult {
+    public Object obj;
+    public boolean needRefresh;
+  }
+  
+  public synchronized ReadResult read(String key) {
+    final long now = System.currentTimeMillis(); 
+    ReadResult r = new ReadResult();
+    r.obj = null;
+    r.needRefresh = true;
     FileInputStream data_in = null;
-    Object obj = null;
     try {
       try {
         File path = new File(mDir, key);
         data_in = new FileInputStream(path);
-        obj = new ObjectInputStream(data_in).readObject();
-        mLastAccessTimes.put(key, System.currentTimeMillis());
+        CacheEntry ent = (CacheEntry)(new ObjectInputStream(data_in).readObject());
+        if (ent != null) {
+          r.obj = ent.obj;
+          r.needRefresh = (now - ent.createMs >= MAX_CACHE_STALENESS_MS);
+        }
+        mLastAccessTimes.put(key, now);
         saveSummary();
       } finally {
         if (data_in != null) data_in.close();
       }
     } catch (FileNotFoundException e) {
-      return null;
     } catch (Throwable e) {
       Log.d(TAG, SUMMARY_PATH + ": failed to write: " + e.toString());
     }
-    return obj;
+    return r;
   }
 
   private void saveSummary() throws IOException {

src/com/ysaito/shogi/GameLog.java

@@ -82,6 +82,10 @@ public final String attr(String key) {
     return mAttrs.get(key);
   }
 
+  /** 
+   * Return the local sdcard path in which the log is saved. Returns null if
+   * the log is not in sdcard. 
+   */
   public final File path() { return mPath; }
 
   /**
@@ -105,12 +109,7 @@ public String digest() {
         for (int i = 0; i < mPlays.size(); ++i) {
           digest.update(mPlays.get(i).toString().getBytes());
         }
-        byte b[] = digest.digest();
-        StringBuffer hex = new StringBuffer();
-	for (int i = 0;i < b.length; i++) {
-	  hex.append(Integer.toHexString(b[i] & 0xff));
-	}        
-        mDigest = hex.toString();
+        mDigest = Util.bytesToHexText(digest.digest());
       } catch (NoSuchAlgorithmException e) {
         throw new AssertionError("MessageDigest.NoSuchAlgorithmException: " + e.getMessage());
       }
@@ -232,6 +231,8 @@ public static GameLog newLog(
   /** 
    * Parse an embedded KIF file downloaded from http://wiki.optus.nu/.
    * Such a file can be created by saving a "テキスト表示" link directly to a file.
+   *
+   * @param path The path in which the file is stored. Can be null.
    */
   public static GameLog parseHtml(File path, InputStream stream) throws ParseException, IOException {
     BufferedReader reader = new BufferedReader(Util.inputStreamToReader(stream, "EUC-JP"));
@@ -321,7 +322,7 @@ public void toKif(OutputStream out, String format) throws IOException {
     stream.close();
   }
 
-    /** 
+  /** 
    * Given a KIF file encoded in UTF-8, parse it. If this method doesn't throw 
    * an exception, it always return a non-null GameLog object.
    */
@@ -330,6 +331,10 @@ public static GameLog parseKif(File path, InputStream in) throws ParseException,
     return doParseKif(path, stream);
   }
 
+  /**
+   * @param path The local sdcard path in which the kif data is stored. Should
+   * be null if the data is not on sdcard.
+   */
   private static GameLog doParseKif(File path, Reader stream) throws ParseException, IOException {
     GameLog l = new GameLog();
     l.mPath = path;

src/com/ysaito/shogi/GameLogListActivity.java

@@ -45,19 +45,19 @@ public MyAdapter(Context context) {
       mInflater = (LayoutInflater)context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
     }
 
-    public int getCount() {
+    @Override public int getCount() {
       return mLogs.size();
     }
 
-    public Object getItem(int position) {
+    @Override public Object getItem(int position) {
       return null;
     }
 
-    public long getItemId(int position) {
+    @Override public long getItemId(int position) {
       return position;
     }
 
-    public View getView(int position, View convertView, ViewGroup parent) {
+    @Override public View getView(int position, View convertView, ViewGroup parent) {
       TextView text;
 
       if (convertView == null) {
@@ -146,13 +146,13 @@ private void startListLogs(LogListManager.Mode mode) {
 
     LogListManager.getSingletonInstance().listLogs(
         new LogListManager.ListLogsListener() {
-          public void onNewGameLogs(Collection<GameLog> logs) {
+          @Override public void onNewGameLogs(Collection<GameLog> logs) {
             if (mLogs.addAll(logs)) {
               mLogsSorted = false;
               mAdapter.notifyDataSetChanged();
             }
           }
-          public void onFinish() { mAdapter.notifyDataSetChanged(); }
+          @Override public void onFinish() { mAdapter.notifyDataSetChanged(); }
         },
         this,
         mode);
@@ -237,7 +237,7 @@ public boolean onContextItemSelected(MenuItem item) {
       if (log != null) { 
         LogListManager.getSingletonInstance().deleteLog(
             new LogListManager.DeleteLogListener() {
-              public void onFinish(LogListManager.UndoToken undoToken) {
+              @Override public void onFinish(LogListManager.UndoToken undoToken) {
                 if (undoToken != null) { // no error happened
                   addUndoToken(undoToken);
                   startListLogs(LogListManager.Mode.READ_SDCARD_SUMMARY);
@@ -254,7 +254,7 @@ public void onFinish(LogListManager.UndoToken undoToken) {
       if (log != null) {
         LogListManager.getSingletonInstance().saveLogInSdcard(
             new LogListManager.TrivialListener() {
-              public void onFinish() { 
+              @Override public void onFinish() { 
                 startListLogs(LogListManager.Mode.READ_SDCARD_SUMMARY); 
               }
             },
@@ -272,7 +272,7 @@ public void onFinish() {
         .setTitle(R.string.game_log_properties)
         .setView(view)
         .setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() {
-          public void onClick(DialogInterface dialog, int whichButton) { }
+          @Override public void onClick(DialogInterface dialog, int whichButton) { }
         }).create().show();
       }
       return true;
@@ -300,7 +300,7 @@ private void updateUndoMenu() {
         final LogListManager.UndoToken undo = mUndoTokens.remove(lastIndex);
         LogListManager.getSingletonInstance().undo(
             new LogListManager.TrivialListener() {
-              public void onFinish() { 
+              @Override public void onFinish() { 
                 startListLogs(LogListManager.Mode.READ_SDCARD_SUMMARY); 
               }
             },