1 // Copyright 2016 The rust-url developers.
2 //
3 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
4 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
5 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
6 // option. This file may not be copied, modified, or distributed
7 // except according to those terms.
8 
9 //! Getters and setters for URL components implemented per https://url.spec.whatwg.org/#api
10 //!
11 //! Unless you need to be interoperable with web browsers,
12 //! you probably want to use `Url` method instead.
13 
14 use {Url, Position, Host, ParseError, idna};
15 use parser::{Parser, SchemeType, default_port, Context, Input};
16 
17 /// https://url.spec.whatwg.org/#dom-url-domaintoascii
domain_to_ascii(domain: &str) -> String18 pub fn domain_to_ascii(domain: &str) -> String {
19     match Host::parse(domain) {
20         Ok(Host::Domain(domain)) => domain,
21         _ => String::new(),
22     }
23 }
24 
25 /// https://url.spec.whatwg.org/#dom-url-domaintounicode
domain_to_unicode(domain: &str) -> String26 pub fn domain_to_unicode(domain: &str) -> String {
27     match Host::parse(domain) {
28         Ok(Host::Domain(ref domain)) => {
29             let (unicode, _errors) = idna::domain_to_unicode(domain);
30             unicode
31         }
32         _ => String::new(),
33     }
34 }
35 
36 /// Getter for https://url.spec.whatwg.org/#dom-url-href
href(url: &Url) -> &str37 pub fn href(url: &Url) -> &str {
38     url.as_str()
39 }
40 
41 /// Setter for https://url.spec.whatwg.org/#dom-url-href
set_href(url: &mut Url, value: &str) -> Result<(), ParseError>42 pub fn set_href(url: &mut Url, value: &str) -> Result<(), ParseError> {
43     *url = Url::parse(value)?;
44     Ok(())
45 }
46 
47 /// Getter for https://url.spec.whatwg.org/#dom-url-origin
origin(url: &Url) -> String48 pub fn origin(url: &Url) -> String {
49     url.origin().ascii_serialization()
50 }
51 
52 /// Getter for https://url.spec.whatwg.org/#dom-url-protocol
53 #[inline]
protocol(url: &Url) -> &str54 pub fn protocol(url: &Url) -> &str {
55     &url.as_str()[..url.scheme().len() + ":".len()]
56 }
57 
58 /// Setter for https://url.spec.whatwg.org/#dom-url-protocol
set_protocol(url: &mut Url, mut new_protocol: &str) -> Result<(), ()>59 pub fn set_protocol(url: &mut Url, mut new_protocol: &str) -> Result<(), ()> {
60     // The scheme state in the spec ignores everything after the first `:`,
61     // but `set_scheme` errors if there is more.
62     if let Some(position) = new_protocol.find(':') {
63         new_protocol = &new_protocol[..position];
64     }
65     url.set_scheme(new_protocol)
66 }
67 
68 /// Getter for https://url.spec.whatwg.org/#dom-url-username
69 #[inline]
username(url: &Url) -> &str70 pub fn username(url: &Url) -> &str {
71     url.username()
72 }
73 
74 /// Setter for https://url.spec.whatwg.org/#dom-url-username
set_username(url: &mut Url, new_username: &str) -> Result<(), ()>75 pub fn set_username(url: &mut Url, new_username: &str) -> Result<(), ()> {
76     url.set_username(new_username)
77 }
78 
79 /// Getter for https://url.spec.whatwg.org/#dom-url-password
80 #[inline]
password(url: &Url) -> &str81 pub fn password(url: &Url) -> &str {
82     url.password().unwrap_or("")
83 }
84 
85 /// Setter for https://url.spec.whatwg.org/#dom-url-password
set_password(url: &mut Url, new_password: &str) -> Result<(), ()>86 pub fn set_password(url: &mut Url, new_password: &str) -> Result<(), ()> {
87     url.set_password(if new_password.is_empty() { None } else { Some(new_password) })
88 }
89 
90 /// Getter for https://url.spec.whatwg.org/#dom-url-host
91 #[inline]
host(url: &Url) -> &str92 pub fn host(url: &Url) -> &str {
93     &url[Position::BeforeHost..Position::AfterPort]
94 }
95 
96 /// Setter for https://url.spec.whatwg.org/#dom-url-host
set_host(url: &mut Url, new_host: &str) -> Result<(), ()>97 pub fn set_host(url: &mut Url, new_host: &str) -> Result<(), ()> {
98     if url.cannot_be_a_base() {
99         return Err(())
100     }
101     let host;
102     let opt_port;
103     {
104         let scheme = url.scheme();
105         let result = Parser::parse_host(Input::new(new_host), SchemeType::from(scheme));
106         match result {
107             Ok((h, remaining)) => {
108                 host = h;
109                 opt_port = if let Some(remaining) = remaining.split_prefix(':') {
110                     Parser::parse_port(remaining, || default_port(scheme), Context::Setter)
111                     .ok().map(|(port, _remaining)| port)
112                 } else {
113                     None
114                 };
115             }
116             Err(_) => return Err(())
117         }
118     }
119     url.set_host_internal(host, opt_port);
120     Ok(())
121 }
122 
123 /// Getter for https://url.spec.whatwg.org/#dom-url-hostname
124 #[inline]
hostname(url: &Url) -> &str125 pub fn hostname(url: &Url) -> &str {
126     url.host_str().unwrap_or("")
127 }
128 
129 /// Setter for https://url.spec.whatwg.org/#dom-url-hostname
set_hostname(url: &mut Url, new_hostname: &str) -> Result<(), ()>130 pub fn set_hostname(url: &mut Url, new_hostname: &str) -> Result<(), ()> {
131     if url.cannot_be_a_base() {
132         return Err(())
133     }
134     let result = Parser::parse_host(Input::new(new_hostname), SchemeType::from(url.scheme()));
135     if let Ok((host, _remaining)) = result {
136         url.set_host_internal(host, None);
137         Ok(())
138     } else {
139         Err(())
140     }
141 }
142 
143 /// Getter for https://url.spec.whatwg.org/#dom-url-port
144 #[inline]
port(url: &Url) -> &str145 pub fn port(url: &Url) -> &str {
146     &url[Position::BeforePort..Position::AfterPort]
147 }
148 
149 /// Setter for https://url.spec.whatwg.org/#dom-url-port
set_port(url: &mut Url, new_port: &str) -> Result<(), ()>150 pub fn set_port(url: &mut Url, new_port: &str) -> Result<(), ()> {
151     let result;
152     {
153         // has_host implies !cannot_be_a_base
154         let scheme = url.scheme();
155         if !url.has_host() || url.host() == Some(Host::Domain("")) || scheme == "file" {
156             return Err(())
157         }
158         result = Parser::parse_port(Input::new(new_port), || default_port(scheme), Context::Setter)
159     }
160     if let Ok((new_port, _remaining)) = result {
161         url.set_port_internal(new_port);
162         Ok(())
163     } else {
164         Err(())
165     }
166 }
167 
168 /// Getter for https://url.spec.whatwg.org/#dom-url-pathname
169 #[inline]
pathname(url: &Url) -> &str170 pub fn pathname(url: &Url) -> &str {
171      url.path()
172 }
173 
174 /// Setter for https://url.spec.whatwg.org/#dom-url-pathname
set_pathname(url: &mut Url, new_pathname: &str)175 pub fn set_pathname(url: &mut Url, new_pathname: &str) {
176     if !url.cannot_be_a_base() {
177         url.set_path(new_pathname)
178     }
179 }
180 
181 /// Getter for https://url.spec.whatwg.org/#dom-url-search
search(url: &Url) -> &str182 pub fn search(url: &Url) -> &str {
183     trim(&url[Position::AfterPath..Position::AfterQuery])
184 }
185 
186 /// Setter for https://url.spec.whatwg.org/#dom-url-search
set_search(url: &mut Url, new_search: &str)187 pub fn set_search(url: &mut Url, new_search: &str) {
188     url.set_query(match new_search {
189         "" => None,
190         _ if new_search.starts_with('?') => Some(&new_search[1..]),
191         _ => Some(new_search),
192     })
193 }
194 
195 /// Getter for https://url.spec.whatwg.org/#dom-url-hash
hash(url: &Url) -> &str196 pub fn hash(url: &Url) -> &str {
197     trim(&url[Position::AfterQuery..])
198 }
199 
200 /// Setter for https://url.spec.whatwg.org/#dom-url-hash
set_hash(url: &mut Url, new_hash: &str)201 pub fn set_hash(url: &mut Url, new_hash: &str) {
202     if url.scheme() != "javascript" {
203         url.set_fragment(match new_hash {
204             "" => None,
205             _ if new_hash.starts_with('#') => Some(&new_hash[1..]),
206             _ => Some(new_hash),
207         })
208     }
209 }
210 
trim(s: &str) -> &str211 fn trim(s: &str) -> &str {
212     if s.len() == 1 {
213         ""
214     } else {
215         s
216     }
217 }
218