servo/components/shared/storage/lib.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use malloc_size_of::malloc_size_of_is_0;
use serde::{Deserialize, Serialize};
use servo_base::generic_channel::{self, GenericCallback, GenericSend, GenericSender, SendResult};
use servo_url::ImmutableOrigin;

use crate::client_storage::ClientStorageThreadMessage;
use crate::indexeddb::IndexedDBThreadMsg;
use crate::webstorage_thread::{OriginDescriptor, WebStorageThreadMsg, WebStorageType};

pub mod client_storage;
pub mod indexeddb;
pub mod webstorage_thread;

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct StorageThreads {
    client_storage_thread: GenericSender<ClientStorageThreadMessage>,
    idb_thread: GenericSender<IndexedDBThreadMsg>,
    web_storage_thread: GenericSender<WebStorageThreadMsg>,
}

impl StorageThreads {
    pub fn new(
        client_storage_thread: GenericSender<ClientStorageThreadMessage>,
        idb_thread: GenericSender<IndexedDBThreadMsg>,
        web_storage_thread: GenericSender<WebStorageThreadMsg>,
    ) -> StorageThreads {
        StorageThreads {
            client_storage_thread,
            idb_thread,
            web_storage_thread,
        }
    }

    pub fn persisted(
        &self,
        origin: ImmutableOrigin,
        sender: GenericCallback<Result<bool, String>>,
    ) -> SendResult {
        self.client_storage_thread
            .send(ClientStorageThreadMessage::Persisted { origin, sender })
    }

    pub fn persist(
        &self,
        origin: ImmutableOrigin,
        permission_granted: bool,
        sender: GenericCallback<Result<bool, String>>,
    ) -> SendResult {
        self.client_storage_thread
            .send(ClientStorageThreadMessage::Persist {
                origin,
                permission_granted,
                sender,
            })
    }

    pub fn estimate(
        &self,
        origin: ImmutableOrigin,
        sender: GenericCallback<Result<(u64, u64), String>>,
    ) -> SendResult {
        self.client_storage_thread
            .send(ClientStorageThreadMessage::Estimate { origin, sender })
    }

    // TODO: Consider changing to `webstorage_sites`
    pub fn webstorage_origins(&self, storage_type: WebStorageType) -> Vec<OriginDescriptor> {
        let (sender, receiver) = generic_channel::channel().unwrap();
        let _ = self
            .web_storage_thread
            .send(WebStorageThreadMsg::ListOrigins(sender, storage_type));
        receiver.recv().unwrap()
    }

    pub fn clear_webstorage_for_sites(&self, storage_type: WebStorageType, sites: &[&str]) {
        let sites = sites.iter().map(|site| site.to_string()).collect();
        let (sender, receiver) = generic_channel::channel().unwrap();
        let _ = self
            .web_storage_thread
            .send(WebStorageThreadMsg::ClearDataForSites(
                sender,
                storage_type,
                sites,
            ));
        let _ = receiver.recv();
    }
}

impl GenericSend<ClientStorageThreadMessage> for StorageThreads {
    fn send(&self, msg: ClientStorageThreadMessage) -> SendResult {
        self.client_storage_thread.send(msg)
    }

    fn sender(&self) -> GenericSender<ClientStorageThreadMessage> {
        self.client_storage_thread.clone()
    }
}

impl GenericSend<IndexedDBThreadMsg> for StorageThreads {
    fn send(&self, msg: IndexedDBThreadMsg) -> SendResult {
        self.idb_thread.send(msg)
    }

    fn sender(&self) -> GenericSender<IndexedDBThreadMsg> {
        self.idb_thread.clone()
    }
}

impl GenericSend<WebStorageThreadMsg> for StorageThreads {
    fn send(&self, msg: WebStorageThreadMsg) -> SendResult {
        self.web_storage_thread.send(msg)
    }

    fn sender(&self) -> GenericSender<WebStorageThreadMsg> {
        self.web_storage_thread.clone()
    }
}

// Ignore the sub-fields
malloc_size_of_is_0!(StorageThreads);