Auto merge of #5824 - KiChjang:http-fetch-spec, r=jdm

This is a work-in-progress for the implementation of HTTP fetch. Currently, it does not compile, as I haven't figured out how to solve the issues regarding borrows and lifetimes.

<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.png" height=40 alt="Review on Reviewable"/>](https://reviewable.io/reviews/servo/servo/5824)
<!-- Reviewable:end -->

components/net/fetch/request.rs

@@ -5,13 +5,16 @@
 use url::Url;
 use hyper::method::Method;
 use hyper::mime::{Mime, TopLevel, SubLevel, Attr, Value};
-use hyper::header::Headers;
+use hyper::header::{Headers, ContentType, IfModifiedSince, IfNoneMatch, Accept};
-use hyper::header::ContentType;
+use hyper::header::{IfUnmodifiedSince, IfMatch, IfRange, Location, HeaderView};
-use fetch::cors_cache::CORSCache;
+use hyper::header::{AcceptLanguage, ContentLanguage};
-use fetch::response::Response;
+use hyper::status::StatusCode;
+use fetch::cors_cache::{CORSCache, CacheRequestDetails};
+use fetch::response::{Response, ResponseType};
+use std::ascii::AsciiExt;
 
 /// A [request context](https://fetch.spec.whatwg.org/#concept-request-context)
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, PartialEq)]
 pub enum Context {
     Audio, Beacon, CSPreport, Download, Embed, Eventsource,
     Favicon, Fetch, Font, Form, Frame, Hyperlink, IFrame, Image,
@@ -21,7 +24,7 @@ pub enum Context {
 }
 
 /// A [request context frame type](https://fetch.spec.whatwg.org/#concept-request-context-frame-type)
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, PartialEq)]
 pub enum ContextFrameType {
     Auxiliary,
     TopLevel,
@@ -37,7 +40,7 @@ pub enum Referer {
 }
 
 /// A [request mode](https://fetch.spec.whatwg.org/#concept-request-mode)
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, PartialEq)]
 pub enum RequestMode {
     SameOrigin,
     NoCORS,
@@ -46,15 +49,34 @@ pub enum RequestMode {
 }
 
 /// Request [credentials mode](https://fetch.spec.whatwg.org/#concept-request-credentials-mode)
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, PartialEq)]
 pub enum CredentialsMode {
     Omit,
     CredentialsSameOrigin,
     Include
 }
 
+/// [Cache mode](https://fetch.spec.whatwg.org/#concept-request-cache-mode)
+#[derive(Copy, Clone, PartialEq)]
+pub enum CacheMode {
+    Default,
+    NoStore,
+    Reload,
+    NoCache,
+    ForceCache,
+    OnlyIfCached
+}
+
+/// [Redirect mode](https://fetch.spec.whatwg.org/#concept-request-redirect-mode)
+#[derive(Copy, Clone, PartialEq)]
+pub enum RedirectMode {
+    Follow,
+    Error,
+    Manual
+}
+
 /// [Response tainting](https://fetch.spec.whatwg.org/#concept-request-response-tainting)
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, PartialEq)]
 pub enum ResponseTainting {
     Basic,
     CORSTainting,
@@ -71,6 +93,7 @@ pub struct Request {
     pub preserve_content_codings: bool,
     // pub client: GlobalRef, // XXXManishearth copy over only the relevant fields of the global scope,
                               // not the entire scope to avoid the libscript dependency
+    pub is_service_worker_global_scope: bool,
     pub skip_service_worker: bool,
     pub context: Context,
     pub context_frame_type: ContextFrameType,
@@ -83,14 +106,15 @@ pub struct Request {
     pub mode: RequestMode,
     pub credentials_mode: CredentialsMode,
     pub use_url_credentials: bool,
-    pub manual_redirect: bool,
+    pub cache_mode: CacheMode,
-    pub redirect_count: u32,
+    pub redirect_mode: RedirectMode,
+    pub redirect_count: usize,
     pub response_tainting: ResponseTainting,
     pub cache: Option<Box<CORSCache+'static>>
 }
 
 impl Request {
-    pub fn new(url: Url, context: Context) -> Request {
+    pub fn new(url: Url, context: Context, isServiceWorkerGlobalScope: bool) -> Request {
          Request {
             method: Method::Get,
             url: url,
@@ -98,6 +122,7 @@ impl Request {
             unsafe_request: false,
             body: None,
             preserve_content_codings: false,
+            is_service_worker_global_scope: isServiceWorkerGlobalScope,
             skip_service_worker: false,
             context: context,
             context_frame_type: ContextFrameType::ContextNone,
@@ -110,13 +135,20 @@ impl Request {
             mode: RequestMode::NoCORS,
             credentials_mode: CredentialsMode::Omit,
             use_url_credentials: false,
-            manual_redirect: false,
+            cache_mode: CacheMode::Default,
+            redirect_mode: RedirectMode::Follow,
             redirect_count: 0,
             response_tainting: ResponseTainting::Basic,
             cache: None
         }
     }
 
+    // [Fetch](https://fetch.spec.whatwg.org#concept-fetch)
+    pub fn fetch(&mut self, _cors_flag: bool) -> Response {
+        // TODO: Implement fetch spec
+        Response::network_error()
+    }
+
     /// [Basic fetch](https://fetch.spec.whatwg.org#basic-fetch)
     pub fn basic_fetch(&mut self) -> Response {
         match &*self.url.scheme {
@@ -143,16 +175,210 @@ impl Request {
     }
 
     // [HTTP fetch](https://fetch.spec.whatwg.org#http-fetch)
-    pub fn http_fetch(&mut self, _cors_flag: bool, cors_preflight_flag: bool, _authentication_fetch_flag: bool) -> Response {
+    pub fn http_fetch(&mut self, cors_flag: bool, cors_preflight_flag: bool, authentication_fetch_flag: bool) -> Response {
-        let response = Response::new();
+        // Step 1
-        // TODO: Service worker fetch
+        let mut response: Option<Response> = None;
-        // Step 3
+        // Step 2
-        // Substep 1
+        if !self.skip_service_worker && !self.is_service_worker_global_scope {
-        self.skip_service_worker = true;
+            // TODO: Substep 1 (handle fetch unimplemented)
-        // Substep 2
+            // Substep 2
-        if cors_preflight_flag {
+            if let Some(ref res) = response {
-            // XXXManishearth stuff goes here
+                if (res.response_type == ResponseType::Opaque && self.mode != RequestMode::NoCORS) ||
+                   res.response_type == ResponseType::Error {
+                    return Response::network_error();
+                }
+            }
         }
+        // Step 3
+        if response.is_none() {
+            // Substep 1
+            if cors_preflight_flag {
+                let mut method_mismatch = false;
+                let mut header_mismatch = false;
+                if let Some(ref mut cache) = self.cache {
+                    let origin = self.origin.clone().unwrap_or(Url::parse("").unwrap());
+                    let url = self.url.clone();
+                    let credentials = self.credentials_mode == CredentialsMode::Include;
+                    let method_cache_match = cache.match_method(CacheRequestDetails {
+                        origin: origin.clone(),
+                        destination: url.clone(),
+                        credentials: credentials
+                    }, self.method.clone());
+                    method_mismatch = !method_cache_match && (!is_simple_method(&self.method) ||
+                        self.mode == RequestMode::ForcedPreflightMode);
+                    header_mismatch = self.headers.iter().any(|view|
+                        !cache.match_header(CacheRequestDetails {
+                            origin: origin.clone(),
+                            destination: url.clone(),
+                            credentials: credentials
+                        }, view.name()) && !is_simple_header(&view)
+                        );
+                }
+                if method_mismatch || header_mismatch {
+                    let preflight_result = self.preflight_fetch();
+                    if preflight_result.response_type == ResponseType::Error {
+                        return Response::network_error();
+                    }
+                    response = Some(preflight_result);
+                }
+            }
+            // Substep 2
+            self.skip_service_worker = true;
+            // Substep 3
+            let credentials = match self.credentials_mode {
+                CredentialsMode::Include => true,
+                CredentialsMode::CredentialsSameOrigin if !cors_flag => true,
+                _ => false
+            };
+            // Substep 4
+            if self.cache_mode == CacheMode::Default && is_no_store_cache(&self.headers) {
+                self.cache_mode = CacheMode::NoStore;
+            }
+            // Substep 5
+            let fetch_result = self.http_network_or_cache_fetch(credentials, authentication_fetch_flag);
+            // Substep 6
+            if cors_flag && self.cors_check(&fetch_result).is_err() {
+                return Response::network_error();
+            }
+            response = Some(fetch_result);
+        }
+        // Step 4
+        let mut response = response.unwrap();
+        match response.status.unwrap() {
+            // Code 304
+            StatusCode::NotModified => match self.cache_mode {
+                CacheMode::Default | CacheMode::NoCache => {
+                    // TODO: Check HTTP cache for request and response entry
+                }
+                _ => { }
+            },
+            // Code 301, 302, 303, 307, 308
+            StatusCode::MovedPermanently | StatusCode::Found | StatusCode::SeeOther |
+            StatusCode::TemporaryRedirect | StatusCode::PermanentRedirect => {
+                // Step 1
+                if self.redirect_mode == RedirectMode::Error {
+                    return Response::network_error();
+                }
+                // Step 2-4
+                if !response.headers.has::<Location>() {
+                    return response;
+                }
+                let location = response.headers.get::<Location>();
+                if location.is_none() {
+                    return Response::network_error();
+                }
+                // Step 5
+                let locationUrl = Url::parse(location.unwrap());
+                // Step 6
+                let locationUrl = match locationUrl {
+                    Ok(url) => url,
+                    Err(_) => return Response::network_error()
+                };
+                // Step 7
+                if self.redirect_count == 20 {
+                    return Response::network_error();
+                }
+                // Step 8
+                self.redirect_count += 1;
+                // Step 9
+                self.same_origin_data = false;
+                // Step 10
+                if self.redirect_mode == RedirectMode::Follow {
+                    // FIXME: Origin method of the Url crate hasn't been implemented (https://github.com/servo/rust-url/issues/54)
+                    // Substep 1
+                    // if cors_flag && locationUrl.origin() != self.url.origin() { self.origin = None; }
+                    // Substep 2
+                    if cors_flag && (!locationUrl.username().unwrap_or("").is_empty() ||
+                                      locationUrl.password().is_some()) {
+                        return Response::network_error();
+                    }
+                    // Substep 3
+                    if response.status.unwrap() == StatusCode::MovedPermanently ||
+                       response.status.unwrap() == StatusCode::SeeOther ||
+                       (response.status.unwrap() == StatusCode::Found && self.method == Method::Post) {
+                        self.method = Method::Get;
+                    }
+                    // Substep 4
+                    self.url = locationUrl;
+                    // Substep 5
+                    return self.fetch(cors_flag);
+                }
+            }
+            // Code 401
+            StatusCode::Unauthorized => {
+                // Step 1
+                if !self.authentication || cors_flag {
+                    return response;
+                }
+                // Step 2
+                // TODO: Spec says requires testing
+                // Step 3
+                if !self.use_url_credentials || authentication_fetch_flag {
+                    // TODO: Prompt the user for username and password
+                }
+                return self.http_fetch(cors_flag, cors_preflight_flag, true);
+            }
+            // Code 407
+            StatusCode::ProxyAuthenticationRequired => {
+                // Step 1
+                // TODO: Spec says requires testing
+                // Step 2
+                // TODO: Prompt the user for proxy authentication credentials
+                // Step 3
+                return self.http_fetch(cors_flag, cors_preflight_flag, authentication_fetch_flag);
+            }
+            _ => { }
+        }
+        // Step 5
+        if authentication_fetch_flag {
+            // TODO: Create authentication entry for this request
+        }
+        // Step 6
         response
     }
+
+    // [HTTP network or cache fetch](https://fetch.spec.whatwg.org#http-network-or-cache-fetch)
+    pub fn http_network_or_cache_fetch(&mut self, _credentials_flag: bool, _authentication_fetch_flag: bool) -> Response {
+        // TODO: Implement HTTP network or cache fetch spec
+        Response::network_error()
+    }
+
+    // [CORS preflight fetch](https://fetch.spec.whatwg.org#cors-preflight-fetch)
+    pub fn preflight_fetch(&mut self) -> Response {
+        // TODO: Implement preflight fetch spec
+        Response::network_error()
+    }
+
+    // [CORS check](https://fetch.spec.whatwg.org#concept-cors-check)
+    pub fn cors_check(&mut self, response: &Response) -> Result<(), ()> {
+        // TODO: Implement CORS check spec
+        Err(())
+    }
+}
+
+fn is_no_store_cache(headers: &Headers) -> bool {
+    headers.has::<IfModifiedSince>() | headers.has::<IfNoneMatch>() |
+    headers.has::<IfUnmodifiedSince>() | headers.has::<IfMatch>() |
+    headers.has::<IfRange>()
+}
+
+fn is_simple_header(h: &HeaderView) -> bool {
+    if h.is::<ContentType>() {
+        match h.value() {
+            Some(&ContentType(Mime(TopLevel::Text, SubLevel::Plain, _))) |
+            Some(&ContentType(Mime(TopLevel::Application, SubLevel::WwwFormUrlEncoded, _))) |
+            Some(&ContentType(Mime(TopLevel::Multipart, SubLevel::FormData, _))) => true,
+            _ => false
+
+        }
+    } else {
+        h.is::<Accept>() || h.is::<AcceptLanguage>() || h.is::<ContentLanguage>()
+    }
+}
+
+fn is_simple_method(m: &Method) -> bool {
+    match *m {
+        Method::Get | Method::Head | Method::Post => true,
+        _ => false
+    }
 }