diff --git a/Cargo.toml b/Cargo.toml index 0894782f2..207d2badb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -18,7 +18,7 @@ travis-ci = { repository = "servo/rust-url" } appveyor = { repository = "Manishearth/rust-url" } [workspace] -members = [".", "idna", "percent_encoding", "data-url"] +members = [".", "form_urlencoded", "idna", "percent_encoding", "data-url"] [[test]] name = "unit" @@ -37,6 +37,7 @@ serde_json = "1.0" bencher = "0.1" [dependencies] +form_urlencoded = { version = "1.0.0", path = "./form_urlencoded" } idna = { version = "0.2.0", path = "./idna" } matches = "0.1" percent-encoding = { version = "2.1.0", path = "./percent_encoding" } diff --git a/form_urlencoded/Cargo.toml b/form_urlencoded/Cargo.toml new file mode 100644 index 000000000..6b0a635ce --- /dev/null +++ b/form_urlencoded/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "form_urlencoded" +version = "1.0.0" +authors = ["The rust-url developers"] +description = "Parser and serializer for the application/x-www-form-urlencoded syntax, as used by HTML forms." +repository = "https://github.com/servo/rust-url" +license = "MIT/Apache-2.0" + +[lib] +test = false + +[dependencies] +matches = "0.1" +percent-encoding = { version = "2.1.0", path = "../percent_encoding" } diff --git a/form_urlencoded/LICENSE-APACHE b/form_urlencoded/LICENSE-APACHE new file mode 100644 index 000000000..16fe87b06 --- /dev/null +++ b/form_urlencoded/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/form_urlencoded/LICENSE-MIT b/form_urlencoded/LICENSE-MIT new file mode 100644 index 000000000..24de6b418 --- /dev/null +++ b/form_urlencoded/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2013-2016 The rust-url developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/src/form_urlencoded.rs b/form_urlencoded/src/lib.rs similarity index 90% rename from src/form_urlencoded.rs rename to form_urlencoded/src/lib.rs index b97f35d25..e1cf571a6 100644 --- a/src/form_urlencoded.rs +++ b/form_urlencoded/src/lib.rs @@ -13,11 +13,19 @@ //! Converts between a string (such as an URL’s query string) //! and a sequence of (name, value) pairs. +extern crate percent_encoding; +#[macro_use] +extern crate matches; + use percent_encoding::{percent_decode, percent_encode_byte}; -use query_encoding::{self, decode_utf8_lossy, EncodingOverride}; +use query_encoding::decode_utf8_lossy; use std::borrow::{Borrow, Cow}; use std::str; +mod query_encoding; + +pub use query_encoding::EncodingOverride; + /// Convert a byte string in the `application/x-www-form-urlencoded` syntax /// into a iterator of (name, value) pairs. /// @@ -191,30 +199,6 @@ impl<'a> Target for &'a mut String { type Finished = Self; } -// `as_mut_string` string here exposes the internal serialization of an `Url`, -// which should not be exposed to users. -// We achieve that by not giving users direct access to `UrlQuery`: -// * Its fields are private -// (and so can not be constructed with struct literal syntax outside of this crate), -// * It has no constructor -// * It is only visible (on the type level) to users in the return type of -// `Url::query_pairs_mut` which is `Serializer` -// * `Serializer` keeps its target in a private field -// * Unlike in other `Target` impls, `UrlQuery::finished` does not return `Self`. -impl<'a> Target for ::UrlQuery<'a> { - fn as_mut_string(&mut self) -> &mut String { - &mut self.url.as_mut().unwrap().serialization - } - - fn finish(mut self) -> &'a mut ::Url { - let url = self.url.take().unwrap(); - url.restore_already_parsed_fragment(self.fragment.take()); - url - } - - type Finished = &'a mut ::Url; -} - impl<'a, T: Target> Serializer<'a, T> { /// Create a new `application/x-www-form-urlencoded` serializer for the given target. /// @@ -299,7 +283,7 @@ impl<'a, T: Target> Serializer<'a, T> { /// If this serializer was constructed with a string, take and return that string. /// /// ```rust - /// use url::form_urlencoded; + /// use form_urlencoded; /// let encoded: String = form_urlencoded::Serializer::new(String::new()) /// .append_pair("foo", "bar & baz") /// .append_pair("saison", "Été+hiver") diff --git a/src/query_encoding.rs b/form_urlencoded/src/query_encoding.rs similarity index 100% rename from src/query_encoding.rs rename to form_urlencoded/src/query_encoding.rs diff --git a/src/lib.rs b/src/lib.rs index 8aff08af4..a159f284a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -109,6 +109,7 @@ assert_eq!(css_url.as_str(), "http://servo.github.io/rust-url/main.css"); #[macro_use] extern crate matches; +pub extern crate form_urlencoded; extern crate idna; extern crate percent_encoding; #[cfg(feature = "serde")] @@ -132,21 +133,19 @@ use std::str; use std::convert::TryFrom; +pub use form_urlencoded::EncodingOverride; pub use host::Host; pub use origin::{OpaqueOrigin, Origin}; pub use parser::{ParseError, SyntaxViolation}; pub use path_segments::PathSegmentsMut; -pub use query_encoding::EncodingOverride; pub use slicing::Position; mod host; mod origin; mod parser; mod path_segments; -mod query_encoding; mod slicing; -pub mod form_urlencoded; #[doc(hidden)] pub mod quirks; @@ -2668,6 +2667,30 @@ pub struct UrlQuery<'a> { fragment: Option, } +// `as_mut_string` string here exposes the internal serialization of an `Url`, +// which should not be exposed to users. +// We achieve that by not giving users direct access to `UrlQuery`: +// * Its fields are private +// (and so can not be constructed with struct literal syntax outside of this crate), +// * It has no constructor +// * It is only visible (on the type level) to users in the return type of +// `Url::query_pairs_mut` which is `Serializer` +// * `Serializer` keeps its target in a private field +// * Unlike in other `Target` impls, `UrlQuery::finished` does not return `Self`. +impl<'a> form_urlencoded::Target for UrlQuery<'a> { + fn as_mut_string(&mut self) -> &mut String { + &mut self.url.as_mut().unwrap().serialization + } + + fn finish(mut self) -> &'a mut Url { + let url = self.url.take().unwrap(); + url.restore_already_parsed_fragment(self.fragment.take()); + url + } + + type Finished = &'a mut Url; +} + impl<'a> Drop for UrlQuery<'a> { fn drop(&mut self) { if let Some(url) = self.url.take() { diff --git a/src/parser.rs b/src/parser.rs index dc771d11e..317d276b3 100644 --- a/src/parser.rs +++ b/src/parser.rs @@ -10,9 +10,9 @@ use std::error::Error; use std::fmt::{self, Formatter, Write}; use std::str; +use form_urlencoded::EncodingOverride; use host::{Host, HostInternal}; use percent_encoding::{percent_encode, utf8_percent_encode, AsciiSet, CONTROLS}; -use query_encoding::EncodingOverride; use Url; /// https://url.spec.whatwg.org/#fragment-percent-encode-set @@ -1441,7 +1441,11 @@ impl<'a> Parser<'a> { "http" | "https" | "file" | "ftp" | "gopher" => self.query_encoding_override, _ => None, }; - let query_bytes = ::query_encoding::encode(encoding, &query); + let query_bytes = if let Some(o) = encoding { + o(&query) + } else { + query.as_bytes().into() + }; let set = if scheme_type.is_special() { SPECIAL_QUERY } else {