Home | History | Annotate | Download | only in public
      1 /*
      2  * Copyright (C) 2009 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WebStorageNamespace_h
     32 #define WebStorageNamespace_h
     33 
     34 #include "WebCommon.h"
     35 
     36 namespace WebKit {
     37 
     38 class WebStorageArea;
     39 class WebString;
     40 
     41 // WebStorageNamespace represents a collection of StorageAreas. Typically, you'll have
     42 // multiple StorageNamespaces to represent the SessionStorage for each tab and a single
     43 // StorageNamespace to represent LocalStorage for the entire browser.
     44 class WebStorageNamespace {
     45 public:
     46     // Create a new WebStorageNamespace. LocalStorageNamespaces require a path to specify
     47     // where the SQLite databases that make LocalStorage data persistent are located.
     48     // If path is empty, data will not persist. You should call delete on the returned
     49     // object when you're finished.
     50     WEBKIT_API static WebStorageNamespace* createLocalStorageNamespace(const WebString& backingDirectoryPath, unsigned quota);
     51     WEBKIT_API static WebStorageNamespace* createSessionStorageNamespace(unsigned quota);
     52 
     53     // The quota for each storage area.  Suggested by the spec.
     54     static const unsigned m_localStorageQuota = 5 * 1024 * 1024;
     55 
     56     // Since SessionStorage memory is allocated in the browser process, we place a
     57     // per-origin quota on it.  Like LocalStorage there are known attacks against
     58     // this, so it's more of a sanity check than a real security measure.
     59     static const unsigned m_sessionStorageQuota = 5 * 1024 * 1024;
     60 
     61     static const unsigned noQuota = UINT_MAX;
     62 
     63     virtual ~WebStorageNamespace() { }
     64 
     65     // Create a new WebStorageArea object. Two subsequent calls with the same origin
     66     // will return two different WebStorageArea objects that share the same backing store.
     67     // You should call delete on the returned object when you're finished.
     68     virtual WebStorageArea* createStorageArea(const WebString& origin) = 0;
     69 
     70     // Copy a StorageNamespace. This only makes sense in the case of SessionStorage.
     71     virtual WebStorageNamespace* copy() = 0;
     72 
     73     // Shutdown the StorageNamespace. Write all StorageArea's to disk and disallow new
     74     // write activity.
     75     virtual void close() = 0;
     76 };
     77 
     78 } // namespace WebKit
     79 
     80 #endif // WebStorageNamespace_h
     81