The Tor Browser: mobile/android/base/background/healthreport/prune/PrunePolicyDatabaseStorage.java@6474c204b198 (annotated)

mobile/android/base/background/healthreport/prune/PrunePolicyDatabaseStorage.java@6474c204b198 (annotated)

mobile/android/base/background/healthreport/prune/PrunePolicyDatabaseStorage.java

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 package org.mozilla.gecko.background.healthreport.prune;
 import org.mozilla.gecko.background.common.log.Logger;
 import org.mozilla.gecko.background.healthreport.Environment;
 import org.mozilla.gecko.background.healthreport.EnvironmentBuilder;
 import org.mozilla.gecko.background.healthreport.HealthReportDatabaseStorage;
 import org.mozilla.gecko.background.healthreport.ProfileInformationCache;
 import android.content.ContentProviderClient;
 import android.content.Context;
 /**
  * Abstracts over the Storage instance behind the PrunePolicy. The underlying storage instance is
  * a {@link HealthReportDatabaseStorage} instance. Since our cleanup routine vacuums, auto_vacuum
  * can be disabled. It is enabled by default, however, turning it off requires an expensive vacuum
  * so we wait until our first {@link cleanup} call since we are vacuuming anyway.
  */
 public class PrunePolicyDatabaseStorage implements PrunePolicyStorage {
   public static final String LOG_TAG = PrunePolicyDatabaseStorage.class.getSimpleName();
   private final Context context;
   private final String profilePath;
   private ContentProviderClient client;
   private HealthReportDatabaseStorage storage;
   private int currentEnvironmentID; // So we don't prune the current environment.
   public PrunePolicyDatabaseStorage(final Context context, final String profilePath) {
     this.context = context;
     this.profilePath = profilePath;
     this.currentEnvironmentID = -1;
   }
   public void pruneEvents(final int count) {
     getStorage().pruneEvents(count);
   }
   public void pruneEnvironments(final int count) {
     getStorage().pruneEnvironments(count);
     // Re-populate the DB and environment cache with the current environment in the unlikely event
     // that it was deleted.
     this.currentEnvironmentID = -1;
     getCurrentEnvironmentID();
   }
   /**
    * Deletes data recorded before the given time. Note that if this method fails to retrieve the
    * current environment from the profile cache, it will not delete data so be sure to prune by
    * other methods (e.g. {@link pruneEvents}) as well.
    */
   public int deleteDataBefore(final long time) {
     return getStorage().deleteDataBefore(time, getCurrentEnvironmentID());
   }
   public void cleanup() {
     final HealthReportDatabaseStorage storage = getStorage();
     // The change to auto_vacuum will only take affect after a vacuum.
     storage.disableAutoVacuuming();
     storage.vacuum();
   }
   public int getEventCount() {
     return getStorage().getEventCount();
   }
   public int getEnvironmentCount() {
     return getStorage().getEnvironmentCount();
   }
   public void close() {
     if (client != null) {
       client.release();
       client = null;
     }
   }
   /**
    * Retrieves the {@link HealthReportDatabaseStorage} associated with the profile of the policy.
    * For efficiency, the underlying {@link ContentProviderClient} and
    * {@link HealthReportDatabaseStorage} are cached for later invocations. However, this means a
    * call to this method MUST be accompanied by a call to {@link close}. Throws
    * {@link IllegalStateException} if the storage instance could not be retrieved - note that the
    * {@link ContentProviderClient} instance will not be closed in this case and
    * {@link releaseClient} should still be called.
    */
   protected HealthReportDatabaseStorage getStorage() {
     if (storage != null) {
       return storage;
     }
     client = EnvironmentBuilder.getContentProviderClient(context);
     if (client == null) {
       // TODO: Record prune failures and submit as part of FHR upload.
       Logger.warn(LOG_TAG, "Unable to get ContentProviderClient - throwing.");
       throw new IllegalStateException("Unable to get ContentProviderClient.");
     }
     try {
       storage = EnvironmentBuilder.getStorage(client, profilePath);
       if (storage == null) {
         // TODO: Record prune failures and submit as part of FHR upload.
         Logger.warn(LOG_TAG,"Unable to get HealthReportDatabaseStorage for " + profilePath +
             " - throwing.");
         throw new IllegalStateException("Unable to get HealthReportDatabaseStorage for " +
             profilePath + " (== null).");
       }
     } catch (ClassCastException ex) {
       // TODO: Record prune failures and submit as part of FHR upload.
       Logger.warn(LOG_TAG,"Unable to get HealthReportDatabaseStorage for " + profilePath +
           profilePath + " (ClassCastException).");
       throw new IllegalStateException("Unable to get HealthReportDatabaseStorage for " +
           profilePath + ".", ex);
     }
     return storage;
   }
   protected int getCurrentEnvironmentID() {
     if (currentEnvironmentID < 0) {
       final ProfileInformationCache cache = new ProfileInformationCache(profilePath);
       if (!cache.restoreUnlessInitialized()) {
         throw new IllegalStateException("Current environment unknown.");
       }
       final Environment env = EnvironmentBuilder.getCurrentEnvironment(cache);
       currentEnvironmentID = env.register();
     }
     return currentEnvironmentID;
   }
 }

The Tor Browser / annotate

mobile/android/base/background/healthreport/prune/PrunePolicyDatabaseStorage.java@6474c204b198 (annotated)

mobile/android/base/background/healthreport/prune/PrunePolicyDatabaseStorage.java