netwerk/cache/src/nsCacheSession.cpp

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is nsCacheSession.h, released
  17  * February 23, 2001.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 2001
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Gordon Sheridan <gordon@netscape.com>
  26  *   Patrick Beard   <beard@netscape.com>
  27  *   Darin Fisher    <darin@netscape.com>
  28  *
  29  * Alternatively, the contents of this file may be used under the terms of
  30  * either the GNU General Public License Version 2 or later (the "GPL"), or
  31  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  32  * in which case the provisions of the GPL or the LGPL are applicable instead
  33  * of those above. If you wish to allow use of your version of this file only
  34  * under the terms of either the GPL or the LGPL, and not to allow others to
  35  * use your version of this file under the terms of the MPL, indicate your
  36  * decision by deleting the provisions above and replace them with the notice
  37  * and other provisions required by the GPL or the LGPL. If you do not delete
  38  * the provisions above, a recipient may use your version of this file under
  39  * the terms of any one of the MPL, the GPL or the LGPL.
  40  *
  41  * ***** END LICENSE BLOCK ***** */
  42
  43 #include "nsCacheSession.h"
  44 #include "nsCacheService.h"
  45 #include "nsCRT.h"
  46
  47 NS_IMPL_ISUPPORTS1(nsCacheSession, nsICacheSession)
  48
  49 nsCacheSession::nsCacheSession(const char *         clientID,
  50                                nsCacheStoragePolicy storagePolicy,
  51                                PRBool               streamBased)
  52     : mClientID(clientID),
  53       mInfo(0)
  54 {
  55   SetStoragePolicy(storagePolicy);
  56
  57   if (streamBased) MarkStreamBased();
  58   else SetStoragePolicy(nsICache::STORE_IN_MEMORY);
  59
  60   MarkDoomEntriesIfExpired();
  61 }
  62
  63 nsCacheSession::~nsCacheSession()
  64 {
  65   /* destructor code */
  66     // notify service we are going away?
  67 }
  68
  69
  70 NS_IMETHODIMP nsCacheSession::GetDoomEntriesIfExpired(PRBool *result)
  71 {
  72     NS_ENSURE_ARG_POINTER(result);
  73     *result = WillDoomEntriesIfExpired();
  74     return NS_OK;
  75 }
  76
  77
  78 NS_IMETHODIMP nsCacheSession::SetDoomEntriesIfExpired(PRBool doomEntriesIfExpired)
  79 {
  80     if (doomEntriesIfExpired)  MarkDoomEntriesIfExpired();
  81     else                       ClearDoomEntriesIfExpired();
  82     return NS_OK;
  83 }
  84
  85
  86 NS_IMETHODIMP
  87 nsCacheSession::OpenCacheEntry(const nsACString &         key,
  88                                nsCacheAccessMode          accessRequested,
  89                                PRBool                     blockingMode,
  90                                nsICacheEntryDescriptor ** result)
  91 {
  92     nsresult rv;
  93     rv =  nsCacheService::OpenCacheEntry(this,
  94                                          key,
  95                                          accessRequested,
  96                                          blockingMode,
  97                                          nsnull, // no listener
  98                                          result);
  99     return rv;
 100 }
 101
 102
 103 NS_IMETHODIMP nsCacheSession::AsyncOpenCacheEntry(const nsACString & key,
 104                                                   nsCacheAccessMode accessRequested,
 105                                                   nsICacheListener *listener)
 106 {
 107     nsresult rv;
 108     rv = nsCacheService::OpenCacheEntry(this,
 109                                         key,
 110                                         accessRequested,
 111                                         nsICache::BLOCKING,
 112                                         listener,
 113                                         nsnull); // no result
 114
 115     if (rv == NS_ERROR_CACHE_WAIT_FOR_VALIDATION) rv = NS_OK;
 116     return rv;
 117 }
 118
 119 NS_IMETHODIMP nsCacheSession::EvictEntries()
 120 {
 121     return nsCacheService::EvictEntriesForSession(this);
 122 }
 123
 124
 125 NS_IMETHODIMP nsCacheSession::IsStorageEnabled(PRBool *result)
 126 {
 127
 128     return nsCacheService::IsStorageEnabledForPolicy(StoragePolicy(), result);
 129 }