Abstract

This specification defines an API to manage usage and availability of local storage resources, and defines a means by which a user agent (UA) may grant Web applications permission to use more local space, temporarily or persistently, via various different storage APIs.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

This document is a proposal that is being made available for public review in order to solicit feedback, particularly from implementors, with a goal of potential cross-browser implementation and standardization.

This document was published by the Web Applications (WebApps) Working Group as a Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to public-webapps@w3.org (subscribe, archive) with a Subject prefix of [quota-api]. All comments are welcome.

Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

Table of Contents

1. Introduction

This section is non-normative.

Today we have a variety of storage APIs that can store inherently complex or large data in order to satisfy offline data requirements of Web applications. Examples of these APIs include: Application Cache [OFFLINE-WEBAPPS], FileSystem API [FILE-SYSTEM][NEW-FILE-SYSTEM], Indexed Database [INDEXEDDB] and Web SQL Database [WEB-SQL].

These APIs may require larger local space than the conventional cookie storage or Web Storage [WEBSTORAGE], but they do not provide a means by which a Web application can query and manage how much data is currently stored and how much more can be stored.

This specification defines an API to query and manage usage and availability of a user's local storage. The storage space granted by the API is intended to be shared by different storage APIs, therefore a user and UA only need to manage single upper limit for all storage per logical application unit, e.g. per origin or per browser (which is implementation specific).

2. Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this specification are to be interpreted as described in [RFC2119].

User agents that use ECMAScript to implement the APIs defined in this specification MUST implement them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification [WEBIDL] as this specification uses that specification and terminology.

3. Terminology

The concept fires a simple event is defined in [HTML5].

The Event, EventTarget, EventListener interfaces are defined in [DOM4].

The DOMError and DOMException interfaces are defined in [DOM4].

The Promise interface is currently defined and discussed in the WHATWG DOM specification.

4. Storage Types

4.1 Temporary vs Persistent

This section is non-normative.

A Web application can request temporary or persistent local storage space depending on its purpose.

Temporary type of storage is especially useful if an application wants to cache data locally to improve its performance, but can fall back to fetching or recreating the same data at a data loss.

Conversely, persistent type of storage is useful if an application wants to store critical offline data that is necessary to be functional, or wants to manage local data amount and lifetime on its own policy rather than relying on the UA's default eviction policy for temporary storage.

4.2 Examples

Suppose there is a photo editing application. This application manages user photo data using Indexed Database [INDEXEDDB], stores photo images using Filesystem API [FILE-SYSTEM] [NEW-FILE-SYSTEM] and optinally utilizes Application Cache [OFFLINE-WEBAPPS] to make it work offline.

The application needs to query how much data it can store in the temporary storage to determine its initial cache size.

Example 1
// Query current usage and availability in Temporary storage:
navigator.storageQuota.queryInfo("temporary").then(
  function(storageInfo) {
    // Continue to initialize local cache using the obtained
    // usage and remaining space (quota - usage) information.
    initializeCache(storageInfo.usage,
                    storageInfo.quota - storageInfo.usage);
  });

Similarly, the application needs to request additional persistent storage to support offline mode when it is enabled by the user.

Example 2
// A function which is to be called when 'offline-mode' is enabled
// by the user.
function onOfflineModeEnabled(amountOfSpaceNeeded) {
  // First check how much we can use in the Persistent storage.
  navigator.storageQuota.queryInfo("persistent").then(
    function (storageInfo) {
      var availableSpace = storageInfo.quota - storageInfo.usage;
      if (availableSpace >= amountOfSpaceNeeded) {
        // We're fine; just continue with the returned storage info.
        return storageInfo;
      }
      return navigator.storageQuota.requestPersistentQuota(
          amountOfSpaceNeeded + storageInfo.usage);
    }
  ).then(
    function (storageInfo) {
      // Prepare for offline mode using the current available
      // storage space.
      prepareForOfflineMode(storageInfo.quota - storageInfo.usage);
    }, function (error) {
      // Handle error.
    }
  );
}

5. Quota Management API

5.1 StorageType enum

enum StorageType {
    "temporary",
    "persistent"
};
Enumeration description
temporaryIndicates temporary storage type.
persistentIndicates persistent storage type.

5.2 StorageInfo interface

[NoInterfaceObject]
interface StorageInfo {
    readonly    attribute unsigned long long usage;
    readonly    attribute unsigned long long quota;
};

5.2.1 Attributes

quota of type unsigned long long, readonly

The current upper limit of the storage space that can be used by the application for a given storage type. This includes the storage area that is already used by the application, so storageInfo.usage needs to be subtracted from storageInfo.quota to get the remaining available storage space.

For temporary storage this value may reflect the actual storage space available on the user's local device and may change from time to time. For persistent storage this value must return the consistent quota size that is granted to the application by requestPersistentQuota. If the application does not have the associated persistent quota yet the UA may return a UA-specific default quota value (which could be 0).

usage of type unsigned long long, readonly

The total amount of data (in bytes) stored by the application for a given storage type. Depending on how the UA calculates data usage the returned value may differ from the exact real-time usage of the user's physical local storage.

5.3 StorageQuota interface

The StorageQuota interface provides means to query and request storage usage and quota information. The API provided by the interface is asynchronous since querying or allocating space in a user's local storage may require blocking I/O operations, e.g. examining the local disk status or making changes in a local database. 

[NoInterfaceObject]
interface StorageQuota {
    readonly    attribute StorageType[] supportedTypes;
    Promise queryInfo (StorageType type);
    Promise requestPersistentQuota (unsigned long long newQuota);
};

5.3.1 Attributes

supportedTypes of type array of StorageType, readonly
List of all storage types supported by the UA.

5.3.2 Methods

queryInfo

This method queries the storage info of the given storage type. This returns StorageInfo that has the current data usage and available quota information for the application. When queryInfo method is called, the UA must run the following steps:

  1. Let storageType be the first argument.
  2. Let promise be a new Promise object.
  3. Return the promise and run the following steps asynchronously.
    1. If the storageType is not supported by the user agent (i.e. not in the supportedTypes array), let error be a new DOMError created with the name "NotSupportedError" and jump to the step labeled failure below.
    2. Let usage be the total amount of data stored by the application in the storage of storageType.
    3. Let quota be the upper limit of the usage that can be stored by the application for storageType.
    4. If any error has occured during querying the storage status, let error be a new DOMError and jump to the step labeled failure below.
  4. success: Let storageInfo be a new StorageInfo object, created with usage and quota, and resolve promise with storageInfo as its resulting value.
  5. failure: Reject promise with error as the reason.

ParameterTypeNullableOptionalDescription
type✘✘
Return type:
requestPersistentQuota

Requests a new quota in persistent storage for the requesting application. It is not guaranteed that the requested amount of space is granted just by calling this API, and the UA may return a new StorageInfo object (without rejecting the request) with a smaller quota value than requested. Calling this API may trigger user prompting to request explicit user permission to proceed.

When requestPersistentQuota method is called, the UA must run the following steps:
  1. Let newQuota be the first argument.
  2. Let promise be a new Promise object.
  3. Return the promise and run the following steps asynchronously.
    1. Let usage be the total amount of data stored by the application in persistent storage.
    2. Let quota be the quota size that is granted to the application for persistent storage. If this application does not have associated persistent quota yet, initialize quota with a UA-specific default quota value (which could be 0).
    3. If quota is equal to or greater than newQuota, let grantedQuota be the same value as quota and jump to the step labeled success below.
    4. Optionally, if newQuota is greater than the current quota, prompt the user in a UA-specific manner for permission to allow the application to store more data.
    5. If the user rejects to grant the permission, let grantedQuota be the same value as quota and jump to the step labeled success below.
    6. Let grantedQuota be the new quota size associated to the application which may satisfy newQuota if possible, and record the value in a persistent way so that the UA can return the consistent quota value for the application for later queryInfo requests. grantedQuota may be smaller than newQuota, but must be equal to or greater than the old quota.
    7. If any error has occured during updating the quota, let error be a new DOMError and jump to the step labeled failure below.
  4. success: Let storageInfo be a new StorageInfo object, created with usage and grantedQuota, and resolve promise with storageInfo as its resulting value.
  5. failure: Reject promise with error as the reason.
ParameterTypeNullableOptionalDescription
newQuota✘✘
Return type:

5.3.3 Accessing StorageQuota interface

partial interface Navigator {
    readonly    attribute StorageQuota storageQuota;
};
5.3.3.1 Attributes
storageQuota of type StorageQuota, readonly
Returns the StorageQuota interface.

5.4 StorageEvent interface

An event object implementing this interface is passed to onstoragechange event handler when storage information is updated. 

[Constructor(DOMString type, optional StorageEventInit eventInitDict)]
interface StorageEvent : Event {
    readonly    attribute unsigned long long usage;
    readonly    attribute unsigned long long quota;
};

5.4.1 Attributes

quota of type unsigned long long, readonly
The current upper limit of the storage space that can be used by the application for a given storage type.
usage of type unsigned long long, readonly
The total amount of data (in bytes) stored by the application for a given storage type.

Events are constructed as defined in constructing events in [DOM4]. 

dictionary StorageEventInit : EventInit {
    unsigned long long usage = 0;
    unsigned long long quota = 0;
};

Dictionary StorageEventInit Members

quota of type unsigned long long, defaulting to 0
usage of type unsigned long long, defaulting to 0

5.5 StorageWatcher interface

StorageWatcher interface is to watch real time storage changes. This fires storagechange event every time a storage status change is detected by the UA, or about every rate second(s), whichever is least frequent.

If rate is not given in the constructor, the UA fires storagechange event whenever it detects the usage or quota changes in the backend, but no more frequent than 50ms.

Regardless of the rate value, the UA must fire one storagechange event with the current storage status immediately (but asynchronously) after a watcher is constructed, unless close() is called before the first storagechange event is dispatched. 

[Constructor(StorageType type, optional unsigned long rate)]
interface StorageWatcher : EventTarget {
    void close ();
    readonly    attribute StorageType   type;
    readonly    attribute unsigned long rate;
                attribute EventListener onstoragechange;
};

5.5.1 Attributes

onstoragechange of type EventListener,
The event handler for the storagechange event.
rate of type unsigned long, readonly
Returns the rate value which this watcher is constructed with.
type of type StorageType, readonly
Returns the storage type type which this watcher is constructed with and is monitoring changes on.

5.5.2 Methods

close
Explicitly closes the watcher. Once close() is called the UA never fires events on this instance.
No parameters.
Return type:

5.6 Restrictions

The space queried and granted by StorageQuota have the following properties:

6. Quota handling in storage APIs

This section is non-normative.

Storage APIs except for Web Storage, i.e. Application Cache, File System API, Indexed Database and Web SQL Database, should respect the quota management API and must have following properties:
Note

Indexed Database [INDEXEDDB] is expected to have temporary and persistent storage types in its next version, and when that happens the UA should store data for temporary database in temporary storage and for persistent database in persistent storage, respectively.

A. Acknowledgements

Many thanks to Robin Berjon for making our lives so much easier with his cool tool.

B. References

B.1 Normative references

[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Internet RFC 2119. URL: http://www.ietf.org/rfc/rfc2119.txt

B.2 Informative references

[DOM4]
Anne van Kesteren; Aryeh Gregor; Lachlan Hunt; Ms2ger. DOM4. 6 December 2012. W3C Working Draft. URL: http://www.w3.org/TR/dom/
[FILE-SYSTEM]
Eric Uhrhane. File API: Directories and System. 17 April 2012. W3C Working Draft. URL: http://www.w3.org/TR/file-system-api/
[HTML5]
Robin Berjon; Steve Faulkner; Travis Leithead; Erika Doyle Navara; Edward O'Connor; Silvia Pfeiffer. HTML5. 6 August 2013. W3C Candidate Recommendation. URL: http://www.w3.org/TR/html5/
[INDEXEDDB]
Nikunj Mehta; Jonas Sicking; Eliot Graff; Andrei Popescu; Jeremy Orlow; Joshua Bell. Indexed Database API. 4 July 2013. W3C Candidate Recommendation. URL: http://www.w3.org/TR/IndexedDB/
[NEW-FILE-SYSTEM]
Arun Ranganathan. FileSystem API. W3C Editor's Draft. URL: http://w3c.github.io/filesystem-api/Overview.html
[OFFLINE-WEBAPPS]
Anne van Kesteren; Ian Hickson. Offline Web Applications. 30 May 2008. W3C Note. URL: http://www.w3.org/TR/offline-webapps/
[WEB-SQL]
Ian Hickson. Web SQL Database. 18 November 2010. W3C Note. URL: http://www.w3.org/TR/webdatabase/
[WEBIDL]
Cameron McCormack. Web IDL. 19 April 2012. W3C Candidate Recommendation. URL: http://www.w3.org/TR/WebIDL/
[WEBSTORAGE]
Ian Hickson. Web Storage. 30 July 2013. W3C Recommendation. URL: http://www.w3.org/TR/webstorage/