Bug 760067 - Release all OfflineCache custom profile files ASAP after custom profile cache update has finished, r=michal

netwerk/cache/nsCacheService.cpp

@@ -1588,6 +1588,7 @@ nsCacheService::GetCustomOfflineDevice(nsIFile *aProfileDir,
         rv = CreateCustomOfflineDevice(aProfileDir, aQuota, aDevice);
         NS_ENSURE_SUCCESS(rv, rv);
 
+        (*aDevice)->SetAutoShutdown();
         mCustomOfflineDevices.Put(profilePath, *aDevice);
     }
 
@@ -1676,6 +1677,20 @@ nsCacheService::CreateMemoryDevice()
     return rv;
 }
 
+nsresult
+nsCacheService::RemoveCustomOfflineDevice(nsOfflineCacheDevice *aDevice)
+{
+    nsCOMPtr<nsIFile> profileDir = aDevice->BaseDirectory();
+    if (!profileDir)
+        return NS_ERROR_UNEXPECTED;
+
+    nsAutoString profilePath;
+    nsresult rv = profileDir->GetPath(profilePath);
+    NS_ENSURE_SUCCESS(rv, rv);
+
+    mCustomOfflineDevices.Remove(profilePath);
+    return NS_OK;
+}
 
 nsresult
 nsCacheService::CreateRequest(nsCacheSession *   session,

netwerk/cache/nsCacheService.h

@@ -199,6 +199,8 @@ private:
                                                nsOfflineCacheDevice **aDevice);
     nsresult         CreateMemoryDevice();
 
+    nsresult         RemoveCustomOfflineDevice(nsOfflineCacheDevice *aDevice);
+
     nsresult         CreateRequest(nsCacheSession *   session,
                                    const nsACString & clientKey,
                                    nsCacheAccessMode  accessRequested,

netwerk/cache/nsDiskCacheDeviceSQL.cpp

@@ -685,6 +685,10 @@ nsApplicationCache::Activate()
   NS_ENSURE_TRUE(mDevice, NS_ERROR_NOT_AVAILABLE);
 
   mDevice->ActivateCache(mGroup, mClientID);
+
+  if (mDevice->AutoShutdown(this))
+    mDevice = nsnull;
+
   return NS_OK;
 }
 
@@ -830,6 +834,7 @@ nsOfflineCacheDevice::nsOfflineCacheDevice()
   : mDB(nsnull)
   , mCacheCapacity(0)
   , mDeltaCounter(0)
+  , mAutoShutdown(false)
 {
 }
 
@@ -2418,3 +2423,23 @@ nsOfflineCacheDevice::SetCapacity(PRUint32 capacity)
 {
   mCacheCapacity = capacity * 1024;
 }
+
+bool
+nsOfflineCacheDevice::AutoShutdown(nsIApplicationCache * aAppCache)
+{
+  if (!mAutoShutdown)
+    return false;
+
+  mAutoShutdown = false;
+
+  Shutdown();
+
+  nsRefPtr<nsCacheService> cacheService = nsCacheService::GlobalInstance();
+  cacheService->RemoveCustomOfflineDevice(this);
+
+  nsCAutoString clientID;
+  aAppCache->GetClientID(clientID);
+  mCaches.Remove(clientID);
+
+  return true;
+}

netwerk/cache/nsDiskCacheDeviceSQL.h

@@ -167,6 +167,8 @@ public:
 
   void                    SetCacheParentDirectory(nsIFile * parentDir);
   void                    SetCapacity(PRUint32  capacity);
+  void                    SetAutoShutdown() { mAutoShutdown = true; }
+  bool                    AutoShutdown(nsIApplicationCache * aAppCache);
 
   nsIFile *               BaseDirectory() { return mBaseDirectory; }
   nsIFile *               CacheDirectory() { return mCacheDirectory; }
@@ -257,6 +259,7 @@ private:
   nsCOMPtr<nsIFile>               mCacheDirectory;
   PRUint32                        mCacheCapacity; // in bytes
   PRInt32                         mDeltaCounter;
+  bool                            mAutoShutdown;
 
   nsInterfaceHashtable<nsCStringHashKey, nsIWeakReference> mCaches;
   nsClassHashtable<nsCStringHashKey, nsCString> mActiveCachesByGroup;

netwerk/test/unit/test_cacheForOfflineUse_no-store.js

@@ -5,7 +5,7 @@ do_load_httpd_js();
 
 var httpServer = null;
 const testFileName = "test_nsHttpChannel_CacheForOfflineUse-no-store";
-const cacheClientID = testFileName;
+const cacheClientID = testFileName + "|fake-group-id";
 const basePath = "/" + testFileName + "/";
 const baseURI = "http://localhost:4444" + basePath;
 const normalEntry = "normal";
@@ -17,9 +17,13 @@ function make_channel_for_offline_use(url, callback, ctx) {
   var ios = Cc["@mozilla.org/network/io-service;1"].
             getService(Ci.nsIIOService);
   var chan = ios.newChannel(url, "", null);
-  var cachingChan = chan.QueryInterface(Ci.nsICachingChannel);
-  cachingChan.cacheForOfflineUse = true;
-  cachingChan.offlineCacheClientID = cacheClientID;
+  
+  var cacheService = Components.classes["@mozilla.org/network/application-cache-service;1"].
+                     getService(Components.interfaces.nsIApplicationCacheService);
+  var appCache = cacheService.getApplicationCache(cacheClientID);
+  
+  var appCacheChan = chan.QueryInterface(Ci.nsIApplicationCacheChannel);
+  appCacheChan.applicationCacheForWrite = appCache;
   return chan;
 }
 

netwerk/test/unit/test_offlinecache_custom-directory.js

@@ -64,6 +64,22 @@ function finish_test(customDir)
   file2.append("0B457F75198B29-0");
   do_check_eq(file2.exists(), true);
 
+  // This must not throw an exception.  After the update has finished
+  // the index file can be freely removed.  This way we check this process
+  // is no longer keeping the file open.  Check like this will probably
+  // work only Windows systems.
+
+  // This test could potentially randomaly fail when we start closing
+  // the offline cache database off the main thread.  Tries in a loop
+  // may be a solution then.
+  try {
+    indexSqlFile.remove(false);
+    do_check_true(true);
+  }
+  catch (ex) {
+    do_throw("Could not remove the sqlite.index file, we still keep it open \n" + ex + "\n");
+  }
+
   httpServer.stop(do_test_finished);
 }