Blame servo/components/url/origin.rs

Packit f0b94e
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit f0b94e
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit f0b94e
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit f0b94e
Packit f0b94e
use servo_rand;
Packit f0b94e
use servo_rand::Rng;
Packit f0b94e
use std::cell::RefCell;
Packit f0b94e
use std::rc::Rc;
Packit f0b94e
use url::{Host, Origin};
Packit f0b94e
use url_serde;
Packit f0b94e
use uuid::Uuid;
Packit f0b94e
Packit f0b94e
/// The origin of an URL
Packit f0b94e
#[derive(Clone, Debug, Deserialize, Eq, MallocSizeOf, PartialEq, Serialize)]
Packit f0b94e
pub enum ImmutableOrigin {
Packit f0b94e
    /// A globally unique identifier
Packit f0b94e
    Opaque(OpaqueOrigin),
Packit f0b94e
Packit f0b94e
    /// Consists of the URL's scheme, host and port
Packit f0b94e
    Tuple(
Packit f0b94e
        String,
Packit f0b94e
        #[serde(deserialize_with = "url_serde::deserialize", serialize_with = "url_serde::serialize")]
Packit f0b94e
        Host,
Packit f0b94e
        u16,
Packit f0b94e
    )
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
impl ImmutableOrigin {
Packit f0b94e
    pub fn new(origin: Origin) -> ImmutableOrigin {
Packit f0b94e
        match origin {
Packit f0b94e
            Origin::Opaque(_) => ImmutableOrigin::new_opaque(),
Packit f0b94e
            Origin::Tuple(scheme, host, port) => ImmutableOrigin::Tuple(scheme, host, port),
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn same_origin(&self, other: &MutableOrigin) -> bool {
Packit f0b94e
        self == other.immutable()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn same_origin_domain(&self, other: &MutableOrigin) -> bool {
Packit f0b94e
        !other.has_domain() && self == other.immutable()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    /// Creates a new opaque origin that is only equal to itself.
Packit f0b94e
    pub fn new_opaque() -> ImmutableOrigin {
Packit f0b94e
        ImmutableOrigin::Opaque(OpaqueOrigin(servo_rand::thread_rng().gen()))
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn scheme(&self) -> Option<&str> {
Packit f0b94e
        match *self {
Packit f0b94e
            ImmutableOrigin::Opaque(_) => None,
Packit f0b94e
            ImmutableOrigin::Tuple(ref scheme, _, _) => Some(&**scheme),
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn host(&self) -> Option<&Host> {
Packit f0b94e
        match *self {
Packit f0b94e
            ImmutableOrigin::Opaque(_) => None,
Packit f0b94e
            ImmutableOrigin::Tuple(_, ref host, _) => Some(host),
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn port(&self) -> Option<u16> {
Packit f0b94e
        match *self {
Packit f0b94e
            ImmutableOrigin::Opaque(_) => None,
Packit f0b94e
            ImmutableOrigin::Tuple(_, _, port) => Some(port),
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn into_url_origin(self) -> Origin {
Packit f0b94e
        match self {
Packit f0b94e
            ImmutableOrigin::Opaque(_) => Origin::new_opaque(),
Packit f0b94e
            ImmutableOrigin::Tuple(scheme, host, port) => Origin::Tuple(scheme, host, port),
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    /// Return whether this origin is a (scheme, host, port) tuple
Packit f0b94e
    /// (as opposed to an opaque origin).
Packit f0b94e
    pub fn is_tuple(&self) -> bool {
Packit f0b94e
        match *self {
Packit f0b94e
            ImmutableOrigin::Opaque(..) => false,
Packit f0b94e
            ImmutableOrigin::Tuple(..) => true,
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    /// <https://html.spec.whatwg.org/multipage/#ascii-serialisation-of-an-origin>
Packit f0b94e
    pub fn ascii_serialization(&self) -> String {
Packit f0b94e
        self.clone().into_url_origin().ascii_serialization()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    /// <https://html.spec.whatwg.org/multipage/#unicode-serialisation-of-an-origin>
Packit f0b94e
    pub fn unicode_serialization(&self) -> String {
Packit f0b94e
        self.clone().into_url_origin().unicode_serialization()
Packit f0b94e
    }
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
/// Opaque identifier for URLs that have file or other schemes
Packit f0b94e
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
Packit f0b94e
pub struct OpaqueOrigin(Uuid);
Packit f0b94e
Packit f0b94e
malloc_size_of_is_0!(OpaqueOrigin);
Packit f0b94e
Packit f0b94e
/// A representation of an [origin](https://html.spec.whatwg.org/multipage/#origin-2).
Packit f0b94e
#[derive(Clone, Debug)]
Packit f0b94e
pub struct MutableOrigin(Rc<(ImmutableOrigin, RefCell<Option<Host>>)>);
Packit f0b94e
Packit f0b94e
malloc_size_of_is_0!(MutableOrigin);
Packit f0b94e
Packit f0b94e
impl MutableOrigin {
Packit f0b94e
    pub fn new(origin: ImmutableOrigin) -> MutableOrigin {
Packit f0b94e
        MutableOrigin(Rc::new((origin, RefCell::new(None))))
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn immutable(&self) -> &ImmutableOrigin {
Packit f0b94e
        &(self.0).0
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn is_tuple(&self) -> bool {
Packit f0b94e
        self.immutable().is_tuple()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn scheme(&self) -> Option<&str> {
Packit f0b94e
        self.immutable().scheme()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn host(&self) -> Option<&Host> {
Packit f0b94e
        self.immutable().host()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn port(&self) -> Option<u16> {
Packit f0b94e
        self.immutable().port()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn same_origin(&self, other: &MutableOrigin) -> bool {
Packit f0b94e
        self.immutable() == other.immutable()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn same_origin_domain(&self, other: &MutableOrigin) -> bool {
Packit f0b94e
        if let Some(ref self_domain) = *(self.0).1.borrow() {
Packit f0b94e
            if let Some(ref other_domain) = *(other.0).1.borrow() {
Packit f0b94e
                self_domain == other_domain &&
Packit f0b94e
                    self.immutable().scheme() == other.immutable().scheme()
Packit f0b94e
            } else {
Packit f0b94e
                false
Packit f0b94e
            }
Packit f0b94e
        } else {
Packit f0b94e
            self.immutable().same_origin_domain(other)
Packit f0b94e
        }
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn domain(&self) -> Option<Host> {
Packit f0b94e
        (self.0).1.borrow().clone()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn set_domain(&self, domain: Host) {
Packit f0b94e
        *(self.0).1.borrow_mut() = Some(domain);
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn has_domain(&self) -> bool {
Packit f0b94e
        (self.0).1.borrow().is_some()
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    pub fn effective_domain(&self) -> Option<Host> {
Packit f0b94e
        self.immutable().host()
Packit f0b94e
            .map(|host| self.domain().unwrap_or_else(|| host.clone()))
Packit f0b94e
    }
Packit f0b94e
}