localStorage shim, fixes #5195

This commit is contained in:
Zack Slayton 2015-03-14 12:33:48 -04:00
parent 1a9679857a
commit 323baf92db
27 changed files with 112 additions and 172 deletions

View file

@ -11,26 +11,32 @@ use url::Url;
use util::str::DOMString; use util::str::DOMString;
use util::task::spawn_named; use util::task::spawn_named;
#[derive(Copy)]
pub enum StorageType {
Session,
Local
}
/// Request operations on the storage data associated with a particular url /// Request operations on the storage data associated with a particular url
pub enum StorageTaskMsg { pub enum StorageTaskMsg {
/// gets the number of key/value pairs present in the associated storage data /// gets the number of key/value pairs present in the associated storage data
Length(Sender<u32>, Url), Length(Sender<u32>, Url, StorageType),
/// gets the name of the key at the specified index in the associated storage data /// gets the name of the key at the specified index in the associated storage data
Key(Sender<Option<DOMString>>, Url, u32), Key(Sender<Option<DOMString>>, Url, StorageType, u32),
/// gets the value associated with the given key in the associated storage data /// gets the value associated with the given key in the associated storage data
GetItem(Sender<Option<DOMString>>, Url, DOMString), GetItem(Sender<Option<DOMString>>, Url, StorageType, DOMString),
/// sets the value of the given key in the associated storage data /// sets the value of the given key in the associated storage data
/// TODO throw QuotaExceededError in case of error /// TODO throw QuotaExceededError in case of error
SetItem(Sender<bool>, Url, DOMString, DOMString), SetItem(Sender<bool>, Url, StorageType, DOMString, DOMString),
/// removes the key/value pair for the given key in the associated storage data /// removes the key/value pair for the given key in the associated storage data
RemoveItem(Sender<bool>, Url, DOMString), RemoveItem(Sender<bool>, Url, StorageType, DOMString),
/// clears the associated storage data by removing all the key/value pairs /// clears the associated storage data by removing all the key/value pairs
Clear(Sender<bool>, Url), Clear(Sender<bool>, Url, StorageType),
/// shut down this task /// shut down this task
Exit Exit
@ -56,14 +62,16 @@ impl StorageTaskFactory for StorageTask {
struct StorageManager { struct StorageManager {
port: Receiver<StorageTaskMsg>, port: Receiver<StorageTaskMsg>,
data: HashMap<String, BTreeMap<DOMString, DOMString>>, session_data: HashMap<String, BTreeMap<DOMString, DOMString>>,
local_data: HashMap<String, BTreeMap<DOMString, DOMString>>,
} }
impl StorageManager { impl StorageManager {
fn new(port: Receiver<StorageTaskMsg>) -> StorageManager { fn new(port: Receiver<StorageTaskMsg>) -> StorageManager {
StorageManager { StorageManager {
port: port, port: port,
data: HashMap::new(), session_data: HashMap::new(),
local_data: HashMap::new(),
} }
} }
} }
@ -72,23 +80,23 @@ impl StorageManager {
fn start(&mut self) { fn start(&mut self) {
loop { loop {
match self.port.recv().unwrap() { match self.port.recv().unwrap() {
StorageTaskMsg::Length(sender, url) => { StorageTaskMsg::Length(sender, url, storage_type) => {
self.length(sender, url) self.length(sender, url, storage_type)
} }
StorageTaskMsg::Key(sender, url, index) => { StorageTaskMsg::Key(sender, url, storage_type, index) => {
self.key(sender, url, index) self.key(sender, url, storage_type, index)
} }
StorageTaskMsg::SetItem(sender, url, name, value) => { StorageTaskMsg::SetItem(sender, url, storage_type, name, value) => {
self.set_item(sender, url, name, value) self.set_item(sender, url, storage_type, name, value)
} }
StorageTaskMsg::GetItem(sender, url, name) => { StorageTaskMsg::GetItem(sender, url, storage_type, name) => {
self.get_item(sender, url, name) self.get_item(sender, url, storage_type, name)
} }
StorageTaskMsg::RemoveItem(sender, url, name) => { StorageTaskMsg::RemoveItem(sender, url, storage_type, name) => {
self.remove_item(sender, url, name) self.remove_item(sender, url, storage_type, name)
} }
StorageTaskMsg::Clear(sender, url) => { StorageTaskMsg::Clear(sender, url, storage_type) => {
self.clear(sender, url) self.clear(sender, url, storage_type)
} }
StorageTaskMsg::Exit => { StorageTaskMsg::Exit => {
break break
@ -97,25 +105,42 @@ impl StorageManager {
} }
} }
fn length(&self, sender: Sender<u32>, url: Url) { fn select_data(& self, storage_type: StorageType) -> &HashMap<String, BTreeMap<DOMString, DOMString>> {
let origin = self.get_origin_as_string(url); match storage_type {
sender.send(self.data.get(&origin).map_or(0u, |entry| entry.len()) as u32).unwrap(); StorageType::Session => &self.session_data,
StorageType::Local => &self.local_data
}
} }
fn key(&self, sender: Sender<Option<DOMString>>, url: Url, index: u32) { fn select_data_mut(&mut self, storage_type: StorageType) -> &mut HashMap<String, BTreeMap<DOMString, DOMString>> {
match storage_type {
StorageType::Session => &mut self.session_data,
StorageType::Local => &mut self.local_data
}
}
fn length(&self, sender: Sender<u32>, url: Url, storage_type: StorageType) {
let origin = self.get_origin_as_string(url); let origin = self.get_origin_as_string(url);
sender.send(self.data.get(&origin) let data = self.select_data(storage_type);
sender.send(data.get(&origin).map_or(0u, |entry| entry.len()) as u32).unwrap();
}
fn key(&self, sender: Sender<Option<DOMString>>, url: Url, storage_type: StorageType, index: u32) {
let origin = self.get_origin_as_string(url);
let data = self.select_data(storage_type);
sender.send(data.get(&origin)
.and_then(|entry| entry.keys().nth(index as uint)) .and_then(|entry| entry.keys().nth(index as uint))
.map(|key| key.clone())).unwrap(); .map(|key| key.clone())).unwrap();
} }
fn set_item(&mut self, sender: Sender<bool>, url: Url, name: DOMString, value: DOMString) { fn set_item(&mut self, sender: Sender<bool>, url: Url, storage_type: StorageType, name: DOMString, value: DOMString) {
let origin = self.get_origin_as_string(url); let origin = self.get_origin_as_string(url);
if !self.data.contains_key(&origin) { let data = self.select_data_mut(storage_type);
self.data.insert(origin.clone(), BTreeMap::new()); if !data.contains_key(&origin) {
data.insert(origin.clone(), BTreeMap::new());
} }
let updated = self.data.get_mut(&origin).map(|entry| { let updated = data.get_mut(&origin).map(|entry| {
if entry.get(&origin).map_or(true, |item| item.as_slice() != value.as_slice()) { if entry.get(&origin).map_or(true, |item| item.as_slice() != value.as_slice()) {
entry.insert(name.clone(), value.clone()); entry.insert(name.clone(), value.clone());
true true
@ -127,22 +152,25 @@ impl StorageManager {
sender.send(updated).unwrap(); sender.send(updated).unwrap();
} }
fn get_item(&self, sender: Sender<Option<DOMString>>, url: Url, name: DOMString) { fn get_item(&self, sender: Sender<Option<DOMString>>, url: Url, storage_type: StorageType, name: DOMString) {
let origin = self.get_origin_as_string(url); let origin = self.get_origin_as_string(url);
sender.send(self.data.get(&origin) let data = self.select_data(storage_type);
sender.send(data.get(&origin)
.and_then(|entry| entry.get(&name)) .and_then(|entry| entry.get(&name))
.map(|value| value.to_string())).unwrap(); .map(|value| value.to_string())).unwrap();
} }
fn remove_item(&mut self, sender: Sender<bool>, url: Url, name: DOMString) { fn remove_item(&mut self, sender: Sender<bool>, url: Url, storage_type: StorageType, name: DOMString) {
let origin = self.get_origin_as_string(url); let origin = self.get_origin_as_string(url);
sender.send(self.data.get_mut(&origin) let data = self.select_data_mut(storage_type);
sender.send(data.get_mut(&origin)
.map_or(false, |entry| entry.remove(&name).is_some())).unwrap(); .map_or(false, |entry| entry.remove(&name).is_some())).unwrap();
} }
fn clear(&mut self, sender: Sender<bool>, url: Url) { fn clear(&mut self, sender: Sender<bool>, url: Url, storage_type: StorageType) {
let origin = self.get_origin_as_string(url); let origin = self.get_origin_as_string(url);
sender.send(self.data.get_mut(&origin) let data = self.select_data_mut(storage_type);
sender.send(data.get_mut(&origin)
.map_or(false, |entry| { .map_or(false, |entry| {
if !entry.is_empty() { if !entry.is_empty() {
entry.clear(); entry.clear();

View file

@ -48,6 +48,7 @@ use layout_interface::{LayoutRPC, LayoutChan};
use libc; use libc;
use msg::constellation_msg::{PipelineId, SubpageId, WindowSizeData}; use msg::constellation_msg::{PipelineId, SubpageId, WindowSizeData};
use net::image_cache_task::ImageCacheTask; use net::image_cache_task::ImageCacheTask;
use net::storage_task::StorageType;
use script_traits::ScriptControlChan; use script_traits::ScriptControlChan;
use script_traits::UntrustedNodeAddress; use script_traits::UntrustedNodeAddress;
use msg::compositor_msg::ScriptListener; use msg::compositor_msg::ScriptListener;
@ -231,6 +232,7 @@ no_jsmanaged_fields!(UntrustedNodeAddress);
no_jsmanaged_fields!(LengthOrPercentageOrAuto); no_jsmanaged_fields!(LengthOrPercentageOrAuto);
no_jsmanaged_fields!(RGBA); no_jsmanaged_fields!(RGBA);
no_jsmanaged_fields!(Matrix2D<T>); no_jsmanaged_fields!(Matrix2D<T>);
no_jsmanaged_fields!(StorageType);
impl JSTraceable for Box<ScriptChan+Send> { impl JSTraceable for Box<ScriptChan+Send> {
#[inline] #[inline]

View file

@ -7,9 +7,9 @@ use dom::bindings::codegen::Bindings::StorageBinding::StorageMethods;
use dom::bindings::global::{GlobalRef, GlobalField}; use dom::bindings::global::{GlobalRef, GlobalField};
use dom::bindings::js::{JSRef, Temporary}; use dom::bindings::js::{JSRef, Temporary};
use dom::bindings::utils::{Reflector, reflect_dom_object}; use dom::bindings::utils::{Reflector, reflect_dom_object};
use dom::bindings::error::Fallible;
use util::str::DOMString; use util::str::DOMString;
use net::storage_task::StorageTask; use net::storage_task::StorageTask;
use net::storage_task::StorageType;
use net::storage_task::StorageTaskMsg; use net::storage_task::StorageTaskMsg;
use std::sync::mpsc::channel; use std::sync::mpsc::channel;
use url::Url; use url::Url;
@ -18,22 +18,20 @@ use url::Url;
pub struct Storage { pub struct Storage {
reflector_: Reflector, reflector_: Reflector,
global: GlobalField, global: GlobalField,
storage_type: StorageType
} }
impl Storage { impl Storage {
fn new_inherited(global: &GlobalRef) -> Storage { fn new_inherited(global: &GlobalRef, storage_type: StorageType) -> Storage {
Storage { Storage {
reflector_: Reflector::new(), reflector_: Reflector::new(),
global: GlobalField::from_rooted(global), global: GlobalField::from_rooted(global),
storage_type: storage_type
} }
} }
pub fn new(global: &GlobalRef) -> Temporary<Storage> { pub fn new(global: &GlobalRef, storage_type: StorageType) -> Temporary<Storage> {
reflect_dom_object(box Storage::new_inherited(global), *global, StorageBinding::Wrap) reflect_dom_object(box Storage::new_inherited(global, storage_type), *global, StorageBinding::Wrap)
}
pub fn Constructor(global: &GlobalRef) -> Fallible<Temporary<Storage>> {
Ok(Storage::new(global))
} }
fn get_url(&self) -> Url { fn get_url(&self) -> Url {
@ -54,21 +52,21 @@ impl<'a> StorageMethods for JSRef<'a, Storage> {
fn Length(self) -> u32 { fn Length(self) -> u32 {
let (sender, receiver) = channel(); let (sender, receiver) = channel();
self.get_storage_task().send(StorageTaskMsg::Length(sender, self.get_url())).unwrap(); self.get_storage_task().send(StorageTaskMsg::Length(sender, self.get_url(), self.storage_type)).unwrap();
receiver.recv().unwrap() receiver.recv().unwrap()
} }
fn Key(self, index: u32) -> Option<DOMString> { fn Key(self, index: u32) -> Option<DOMString> {
let (sender, receiver) = channel(); let (sender, receiver) = channel();
self.get_storage_task().send(StorageTaskMsg::Key(sender, self.get_url(), index)).unwrap(); self.get_storage_task().send(StorageTaskMsg::Key(sender, self.get_url(), self.storage_type, index)).unwrap();
receiver.recv().unwrap() receiver.recv().unwrap()
} }
fn GetItem(self, name: DOMString) -> Option<DOMString> { fn GetItem(self, name: DOMString) -> Option<DOMString> {
let (sender, receiver) = channel(); let (sender, receiver) = channel();
self.get_storage_task().send(StorageTaskMsg::GetItem(sender, self.get_url(), name)).unwrap(); self.get_storage_task().send(StorageTaskMsg::GetItem(sender, self.get_url(), self.storage_type, name)).unwrap();
receiver.recv().unwrap() receiver.recv().unwrap()
} }
@ -81,7 +79,7 @@ impl<'a> StorageMethods for JSRef<'a, Storage> {
fn SetItem(self, name: DOMString, value: DOMString) { fn SetItem(self, name: DOMString, value: DOMString) {
let (sender, receiver) = channel(); let (sender, receiver) = channel();
self.get_storage_task().send(StorageTaskMsg::SetItem(sender, self.get_url(), name, value)).unwrap(); self.get_storage_task().send(StorageTaskMsg::SetItem(sender, self.get_url(), self.storage_type, name, value)).unwrap();
if receiver.recv().unwrap() { if receiver.recv().unwrap() {
//TODO send notification //TODO send notification
} }
@ -98,7 +96,7 @@ impl<'a> StorageMethods for JSRef<'a, Storage> {
fn RemoveItem(self, name: DOMString) { fn RemoveItem(self, name: DOMString) {
let (sender, receiver) = channel(); let (sender, receiver) = channel();
self.get_storage_task().send(StorageTaskMsg::RemoveItem(sender, self.get_url(), name)).unwrap(); self.get_storage_task().send(StorageTaskMsg::RemoveItem(sender, self.get_url(), self.storage_type, name)).unwrap();
if receiver.recv().unwrap() { if receiver.recv().unwrap() {
//TODO send notification //TODO send notification
} }
@ -111,10 +109,9 @@ impl<'a> StorageMethods for JSRef<'a, Storage> {
fn Clear(self) { fn Clear(self) {
let (sender, receiver) = channel(); let (sender, receiver) = channel();
self.get_storage_task().send(StorageTaskMsg::Clear(sender, self.get_url())).unwrap(); self.get_storage_task().send(StorageTaskMsg::Clear(sender, self.get_url(), self.storage_type)).unwrap();
if receiver.recv().unwrap() { if receiver.recv().unwrap() {
//TODO send notification //TODO send notification
} }
} }
} }

View file

@ -134,3 +134,10 @@ interface WindowSessionStorage {
readonly attribute Storage sessionStorage; readonly attribute Storage sessionStorage;
}; };
Window implements WindowSessionStorage; Window implements WindowSessionStorage;
// https://html.spec.whatwg.org/multipage/webstorage.html#dom-localstorage
[NoInterfaceObject]
interface WindowLocalStorage {
readonly attribute Storage localStorage;
};
Window implements WindowLocalStorage;

View file

@ -39,7 +39,7 @@ use msg::compositor_msg::ScriptListener;
use msg::constellation_msg::{LoadData, PipelineId, SubpageId, ConstellationChan, WindowSizeData}; use msg::constellation_msg::{LoadData, PipelineId, SubpageId, ConstellationChan, WindowSizeData};
use net::image_cache_task::ImageCacheTask; use net::image_cache_task::ImageCacheTask;
use net::resource_task::ResourceTask; use net::resource_task::ResourceTask;
use net::storage_task::StorageTask; use net::storage_task::{StorageTask, StorageType};
use util::geometry::{self, Au, MAX_RECT}; use util::geometry::{self, Au, MAX_RECT};
use util::opts; use util::opts;
use util::str::{DOMString,HTML_SPACE_CHARACTERS}; use util::str::{DOMString,HTML_SPACE_CHARACTERS};
@ -95,6 +95,7 @@ pub struct Window {
navigation_start_precise: f64, navigation_start_precise: f64,
screen: MutNullableJS<Screen>, screen: MutNullableJS<Screen>,
session_storage: MutNullableJS<Storage>, session_storage: MutNullableJS<Storage>,
local_storage: MutNullableJS<Storage>,
timers: TimerManager, timers: TimerManager,
/// For providing instructions to an optional devtools server. /// For providing instructions to an optional devtools server.
@ -288,7 +289,11 @@ impl<'a> WindowMethods for JSRef<'a, Window> {
} }
fn SessionStorage(self) -> Temporary<Storage> { fn SessionStorage(self) -> Temporary<Storage> {
self.session_storage.or_init(|| Storage::new(&GlobalRef::Window(self))) self.session_storage.or_init(|| Storage::new(&GlobalRef::Window(self), StorageType::Session))
}
fn LocalStorage(self) -> Temporary<Storage> {
self.local_storage.or_init(|| Storage::new(&GlobalRef::Window(self), StorageType::Local))
} }
fn Console(self) -> Temporary<Console> { fn Console(self) -> Temporary<Console> {
@ -775,6 +780,7 @@ impl Window {
navigation_start_precise: time::precise_time_ns() as f64, navigation_start_precise: time::precise_time_ns() as f64,
screen: Default::default(), screen: Default::default(),
session_storage: Default::default(), session_storage: Default::default(),
local_storage: Default::default(),
timers: TimerManager::new(), timers: TimerManager::new(),
id: id, id: id,
subpage_id: subpage_id, subpage_id: subpage_id,

View file

@ -8367,9 +8367,6 @@
[Window interface: calling createImageBitmap(ImageBitmapSource,long,long,long,long) on window with too few arguments must throw TypeError] [Window interface: calling createImageBitmap(ImageBitmapSource,long,long,long,long) on window with too few arguments must throw TypeError]
expected: FAIL expected: FAIL
[Window interface: window must inherit property "localStorage" with the proper type (124)]
expected: FAIL
[BarProp interface: existence and properties of interface object] [BarProp interface: existence and properties of interface object]
expected: FAIL expected: FAIL

View file

@ -1,5 +1,4 @@
[event_local_key.html] [event_local_key.html]
type: testharness type: testharness
[Web Storage] expected: TIMEOUT
expected: FAIL

View file

@ -1,5 +1,4 @@
[event_local_newvalue.html] [event_local_newvalue.html]
type: testharness type: testharness
[Web Storage] expected: TIMEOUT
expected: FAIL

View file

@ -1,5 +1,3 @@
[event_local_oldvalue.html] [event_local_oldvalue.html]
type: testharness type: testharness
[Web Storage] expected: TIMEOUT
expected: FAIL

View file

@ -1,5 +1,3 @@
[event_local_storagearea.html] [event_local_storagearea.html]
type: testharness type: testharness
[Web Storage] expected: TIMEOUT
expected: FAIL

View file

@ -1,5 +1,3 @@
[event_local_url.html] [event_local_url.html]
type: testharness type: testharness
[Web Storage] expected: TIMEOUT
expected: FAIL

View file

@ -6,42 +6,6 @@
[Storage interface object length] [Storage interface object length]
expected: FAIL expected: FAIL
[Storage must be primary interface of window.localStorage]
expected: FAIL
[Stringification of window.localStorage]
expected: FAIL
[Storage interface: window.localStorage must inherit property "length" with the proper type (0)]
expected: FAIL
[Storage interface: window.localStorage must inherit property "key" with the proper type (1)]
expected: FAIL
[Storage interface: calling key(unsigned long) on window.localStorage with too few arguments must throw TypeError]
expected: FAIL
[Storage interface: window.localStorage must inherit property "getItem" with the proper type (2)]
expected: FAIL
[Storage interface: calling getItem(DOMString) on window.localStorage with too few arguments must throw TypeError]
expected: FAIL
[Storage interface: window.localStorage must inherit property "setItem" with the proper type (3)]
expected: FAIL
[Storage interface: calling setItem(DOMString,DOMString) on window.localStorage with too few arguments must throw TypeError]
expected: FAIL
[Storage interface: window.localStorage must inherit property "removeItem" with the proper type (4)]
expected: FAIL
[Storage interface: calling removeItem(DOMString) on window.localStorage with too few arguments must throw TypeError]
expected: FAIL
[Storage interface: window.localStorage must inherit property "clear" with the proper type (5)]
expected: FAIL
[StorageEvent interface: existence and properties of interface object] [StorageEvent interface: existence and properties of interface object]
expected: FAIL expected: FAIL

View file

@ -1,19 +1,5 @@
[missing_arguments.html] [missing_arguments.html]
type: testharness type: testharness
[Should throw TypeError for function "function () { localStorage.key(); }".]
expected: FAIL
[Should throw TypeError for function "function () { localStorage.getItem(); }".]
expected: FAIL
[Should throw TypeError for function "function () { localStorage.setItem(); }".]
expected: FAIL
[Should throw TypeError for function "function () { localStorage.setItem("a"); }".]
expected: FAIL
[Should throw TypeError for function "function () { localStorage.removeItem(); }".]
expected: FAIL
[Should throw TypeError for function "function () { new StorageEvent(); }".] [Should throw TypeError for function "function () { new StorageEvent(); }".]
expected: FAIL expected: FAIL

View file

@ -1,3 +1,4 @@
[storage_local_builtins.html] [storage_local_builtins.html]
type: testharness type: testharness
expected: TIMEOUT [Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_clear.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_clear_js.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_getitem.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_getitem_js.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,8 +1,5 @@
[storage_local_in_js.html] [storage_local_in_js.html]
type: testharness type: testharness
[Web Storage]
expected: FAIL
[Web Storage 1] [Web Storage 1]
expected: FAIL expected: FAIL

View file

@ -1,5 +1,4 @@
[storage_local_index_js.html] [storage_local_index_js.html]
type: testharness type: testharness
[Web Storage] [Web Storage 3]
expected: FAIL expected: FAIL

View file

@ -1,5 +1,5 @@
[storage_local_key.html] [storage_local_key.html]
type: testharness type: testharness
[Web Storage] [Web Storage 3]
expected: FAIL expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_length.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_length_js.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_removeitem.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_removeitem_js.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +0,0 @@
[storage_local_setitem.html]
type: testharness
[Web Storage]
expected: FAIL

View file

@ -1,5 +1,14 @@
[storage_local_setitem_js.html] [storage_local_setitem_js.html]
type: testharness type: testharness
[Web Storage] [Web Storage 4]
expected: FAIL
[Web Storage 6]
expected: FAIL
[Web Storage 7]
expected: FAIL
[Web Storage 8]
expected: FAIL
[Web Storage 9]
expected: FAIL
[Web Storage 10]
expected: FAIL expected: FAIL