From ddbb9759b8b159e3093881d9422014a4f8f3551f Mon Sep 17 00:00:00 2001 From: Patrick Fernie Date: Sun, 9 May 2021 20:26:55 -0400 Subject: [PATCH] initial commit --- .gitignore | 3 + Cargo.toml | 27 +++++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 21 +++++ README.md | 76 ++++++++++++++++++ src/lib.rs | 209 +++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 537 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bb6231f --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +Cargo.lock +.cargo-ok diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..3e2eedb --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,27 @@ +[package] +name = "reqwest_cookie_store" +version = "0.1.0" +authors = ["Patrick Fernie "] +edition = "2018" +description = "A simple crate providing an implementation of the `reqwest::cookie::CookieStore` trait for `cookie_store::CookieStore`" +readme = "README.md" +repository = "https://github.com/pfernie/reqwest_cookie_store" +documentation = "https://docs.rs/reqwest_cookie_store" +license = "MIT/Apache-2.0" # https://spdx.org/licenses/ +keywords = ["cookie", "jar", "store", "http"] # free text +categories = ["web-programming::http-client", "web-programming"] # https://crates.io/category_slugs +# https://doc.rust-lang.org/cargo/reference/manifest.html + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docsrs"] + +[dependencies] +bytes = "1.0.1" +cookie = "0.15.0" +cookie_store = "0.13.3" +reqwest = { version = "0.11.3", default-features = false, features = ["cookies"] } +url = "2.2.2" + +[dev-dependencies] +tokio-test = "^0.4.1" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/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/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..8864d4a --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 + +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/README.md b/README.md new file mode 100644 index 0000000..d0bec43 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +[![Documentation](https://docs.rs/cookie_store/badge.svg)](https://docs.rs/reqwest_cookie_store) + +`reqwest_cookie_store` provides implementations of `reqwest::cookie::CookieStore` for [https://crates.io/crates/cookie_store](cookie_store) + +# Example +The following example demonstrates loading a [`cookie_store::CookieStore`] from disk, and using it within a +[`CookieStoreMutex`]. It then makes a series of requests, examining and modifying the contents +of the underlying [`cookie_store::CookieStore`] in between. + +```no_run +# tokio_test::block_on(async { +// Load an existing set of cookies, serialized as json +let cookie_store = { + let file = std::fs::File::open("cookies.json") + .map(std::io::BufReader::new) + .unwrap(); + cookie_store::CookieStore::load_json(file).unwrap() +}; +let cookie_store = reqwest_cookie_store::CookieStoreMutex::new(cookie_store); +let cookie_store = std::sync::Arc::new(cookie_store); +{ + // Examine initial contents + println!("initial load"); + let store = cookie_store.lock().unwrap(); + for c in store.iter_any() { + println!("{:?}", c); + } +} + +// Build a `reqwest` Client, providing the deserialized store +let client = reqwest::Client::builder() + .cookie_provider(std::sync::Arc::clone(&cookie_store)) + .build() + .unwrap(); + +// Make a sample request +client.get("https://google.com").send().await.unwrap(); +{ + // Examine the contents of the store. + println!("after google.com GET"); + let store = cookie_store.lock().unwrap(); + for c in store.iter_any() { + println!("{:?}", c); + } +} + +// Make another request from another domain +println!("GET from msn"); +client.get("https://msn.com").send().await.unwrap(); +{ + // Examine the contents of the store. + println!("after msn.com GET"); + let mut store = cookie_store.lock().unwrap(); + for c in store.iter_any() { + println!("{:?}", c); + } + // Clear the store, and examine again + store.clear(); + println!("after clear"); + for c in store.iter_any() { + println!("{:?}", c); + } +} + +// Get some new cookies +client.get("https://google.com").send().await.unwrap(); +{ + // Write store back to disk + let mut writer = std::fs::File::create("cookies2.json") + .map(std::io::BufWriter::new) + .unwrap(); + let store = cookie_store.lock().unwrap(); + store.save_json(&mut writer).unwrap(); +} +# }); +``` diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..c028223 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,209 @@ +#![allow(unused_imports)] +#![deny(warnings, missing_debug_implementations, rust_2018_idioms)] +#![cfg_attr(docsrs, feature(doc_cfg))] +//! # Example +//! The following example demonstrates loading a [`cookie_store::CookieStore`] from disk, and using it within a +//! [`CookieStoreMutex`]. It then makes a series of requests, examining and modifying the contents +//! of the underlying [`cookie_store::CookieStore`] in between. +//! ```no_run +//! # tokio_test::block_on(async { +//! // Load an existing set of cookies, serialized as json +//! let cookie_store = { +//! let file = std::fs::File::open("cookies.json") +//! .map(std::io::BufReader::new) +//! .unwrap(); +//! cookie_store::CookieStore::load_json(file).unwrap() +//! }; +//! let cookie_store = reqwest_cookie_store::CookieStoreMutex::new(cookie_store); +//! let cookie_store = std::sync::Arc::new(cookie_store); +//! { +//! // Examine initial contents +//! println!("initial load"); +//! let store = cookie_store.lock().unwrap(); +//! for c in store.iter_any() { +//! println!("{:?}", c); +//! } +//! } +//! +//! // Build a `reqwest` Client, providing the deserialized store +//! let client = reqwest::Client::builder() +//! .cookie_provider(std::sync::Arc::clone(&cookie_store)) +//! .build() +//! .unwrap(); +//! +//! // Make a sample request +//! client.get("https://google.com").send().await.unwrap(); +//! { +//! // Examine the contents of the store. +//! println!("after google.com GET"); +//! let store = cookie_store.lock().unwrap(); +//! for c in store.iter_any() { +//! println!("{:?}", c); +//! } +//! } +//! +//! // Make another request from another domain +//! println!("GET from msn"); +//! client.get("https://msn.com").send().await.unwrap(); +//! { +//! // Examine the contents of the store. +//! println!("after msn.com GET"); +//! let mut store = cookie_store.lock().unwrap(); +//! for c in store.iter_any() { +//! println!("{:?}", c); +//! } +//! // Clear the store, and examine again +//! store.clear(); +//! println!("after clear"); +//! for c in store.iter_any() { +//! println!("{:?}", c); +//! } +//! } +//! +//! // Get some new cookies +//! client.get("https://google.com").send().await.unwrap(); +//! { +//! // Write store back to disk +//! let mut writer = std::fs::File::create("cookies2.json") +//! .map(std::io::BufWriter::new) +//! .unwrap(); +//! let store = cookie_store.lock().unwrap(); +//! store.save_json(&mut writer).unwrap(); +//! } +//! # }); +//!``` + +use std::{ + ops::Deref, + sync::{LockResult, Mutex, MutexGuard, PoisonError, RwLock, RwLockReadGuard, RwLockWriteGuard}, +}; + +use bytes::Bytes; +use cookie::{Cookie as RawCookie, ParseError as RawCookieParseError}; +use cookie_store::CookieStore; +use reqwest::header::HeaderValue; +use url; + +fn set_cookies( + cookie_store: &mut CookieStore, + cookie_headers: &mut dyn Iterator, + url: &url::Url, +) { + let cookies = cookie_headers.filter_map(|val| { + std::str::from_utf8(val.as_bytes()) + .map_err(RawCookieParseError::from) + .and_then(RawCookie::parse) + .map(|c| c.into_owned()) + .ok() + }); + cookie_store.store_response_cookies(cookies, url); +} + +fn cookies(cookie_store: &CookieStore, url: &url::Url) -> Option { + let s = cookie_store + .get_request_cookies(url) + .map(|c| format!("{}={}", c.name(), c.value())) + .collect::>() + .join("; "); + + if s.is_empty() { + return None; + } + + HeaderValue::from_maybe_shared(Bytes::from(s)).ok() +} + +/// A [`cookie_store::CookieStore`] wrapped internally by a [`std::sync::Mutex`], suitable for use in +/// async/concurrent contexts. +#[derive(Debug)] +pub struct CookieStoreMutex(Mutex); + +impl Default for CookieStoreMutex { + /// Create a new, empty [`CookieStoreMutex`] + fn default() -> Self { + CookieStoreMutex::new(CookieStore::default()) + } +} + +impl CookieStoreMutex { + /// Create a new [`CookieStoreMutex`] from an existing [`cookie_store::CookieStore`]. + pub fn new(cookie_store: CookieStore) -> CookieStoreMutex { + CookieStoreMutex(Mutex::new(cookie_store)) + } + + /// Lock and get a handle to the contained [`cookie_store::CookieStore`]. + pub fn lock( + &self, + ) -> Result, PoisonError>> { + self.0.lock() + } + + /// Consumes this [`CookieStoreMutex`], returning the underlying [`cookie_store::CookieStore`] + pub fn into_inner(self) -> LockResult { + self.0.into_inner() + } +} + +impl reqwest::cookie::CookieStore for CookieStoreMutex { + fn set_cookies(&self, cookie_headers: &mut dyn Iterator, url: &url::Url) { + let mut store = self.0.lock().unwrap(); + set_cookies(&mut store, cookie_headers, url); + } + + fn cookies(&self, url: &url::Url) -> Option { + let store = self.0.lock().unwrap(); + cookies(&store, url) + } +} + +/// A [`cookie_store::CookieStore`] wrapped internally by a [`std::sync::RwLock`], suitable for use in +/// async/concurrent contexts. +#[derive(Debug)] +pub struct CookieStoreRwLock(RwLock); + +impl Default for CookieStoreRwLock { + /// Create a new, empty [`CookieStoreRwLock`]. + fn default() -> Self { + CookieStoreRwLock::new(CookieStore::default()) + } +} + +impl CookieStoreRwLock { + /// Create a new [`CookieStoreRwLock`] from an existing [`cookie_store::CookieStore`]. + pub fn new(cookie_store: CookieStore) -> CookieStoreRwLock { + CookieStoreRwLock(RwLock::new(cookie_store)) + } + + /// Lock and get a read (non-exclusive) handle to the contained [`cookie_store::CookieStore`]. + pub fn read( + &self, + ) -> Result, PoisonError>> + { + self.0.read() + } + + /// Lock and get a write (exclusive) handle to the contained [`cookie_store::CookieStore`]. + pub fn write( + &self, + ) -> Result, PoisonError>> + { + self.0.write() + } + + /// Consume this [`CookieStoreRwLock`], returning the underlying [`cookie_store::CookieStore`] + pub fn into_inner(self) -> LockResult { + self.0.into_inner() + } +} + +impl reqwest::cookie::CookieStore for CookieStoreRwLock { + fn set_cookies(&self, cookie_headers: &mut dyn Iterator, url: &url::Url) { + let mut write = self.0.write().unwrap(); + set_cookies(&mut write, cookie_headers, url); + } + + fn cookies(&self, url: &url::Url) -> Option { + let read = self.0.read().unwrap(); + cookies(&read, url) + } +}