commit fab3c35ba9aeb1d87f5e0faa12d4768095cc96db Author: Nikolay Kim Date: Thu Dec 28 21:14:04 2017 -0800 initial import diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..42d0755dd --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +Cargo.lock +target/ +guide/build/ +/gh-pages + +*.so +*.out +*.pyc +*.pid +*.sock +*~ + +# These are backup files generated by rustfmt +**/*.rs.bk diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 000000000..e88f30859 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "actix-redis" +version = "0.1.0" +authors = ["Nikolay Kim "] + +[lib] +name = "actix_redis" +path = "src/lib.rs" + +[dependencies] +bytes = "0.4" +failure = "^0.1.1" +futures = "0.1" +serde = "1.0" +serde_json = "1.0" +tokio-io = "0.1" +tokio-core = "0.1" +actix = "^0.3.5" +actix-web = { path = "../actix-web/" } +redis-async = { git = "https://github.com/benashford/redis-async-rs.git" } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 000000000..6cdf2d16c --- /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 2017-NOW Nikolay Kim + + 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 000000000..410ce45a4 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2017 Nikilay Kim + +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/example/basic.rs b/example/basic.rs new file mode 100644 index 000000000..c6dbd93e4 --- /dev/null +++ b/example/basic.rs @@ -0,0 +1,56 @@ +#![allow(unused_variables)] +#![cfg_attr(feature="cargo-clippy", allow(needless_pass_by_value))] + +extern crate actix; +extern crate actix_web; +extern crate actix_redis; +extern crate env_logger; +extern crate futures; + +use actix_web::*; +use actix_web::middleware::RequestSession; +use actix_redis::RedisSessionBackend; + + +/// simple handler +fn index(mut req: HttpRequest) -> Result { + println!("{:?}", req); + if let Ok(ch) = req.payload_mut().readany().poll() { + if let futures::Async::Ready(Some(d)) = ch { + println!("{}", String::from_utf8_lossy(d.as_ref())); + } + } + + // session + if let Some(count) = req.session().get::("counter")? { + println!("SESSION value: {}", count); + req.session().set("counter", count+1)?; + } else { + req.session().set("counter", 1)?; + } + + Ok("Welcome!".into()) +} + +fn main() { + ::std::env::set_var("RUST_LOG", "actix_web=info"); + let _ = env_logger::init(); + let sys = actix::System::new("basic-example"); + + HttpServer::new( + || Application::new() + // enable logger + .middleware(middleware::Logger::default()) + // cookie session middleware + .middleware(middleware::SessionStorage::new( + RedisSessionBackend::new("127.0.0.1:6379", Duration::from_secs(7200)) + .expect("Can not connect to redis server") + )) + // register simple route, handle all methods + .resource("/", |r| r.f(index))) + .bind("0.0.0.0:8080").unwrap() + .start(); + + println!("Starting http server: 127.0.0.1:8080"); + let _ = sys.run(); +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 000000000..3cf9edbb8 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,17 @@ +extern crate actix; +extern crate actix_web; +extern crate bytes; +extern crate futures; +extern crate serde; +extern crate serde_json; +extern crate tokio_io; +extern crate tokio_core; +#[macro_use] +extern crate redis_async; +#[macro_use] +extern crate failure; + +mod redis; +mod session; + +pub use session::RedisSessionBackend; diff --git a/src/redis.rs b/src/redis.rs new file mode 100644 index 000000000..ba7420e92 --- /dev/null +++ b/src/redis.rs @@ -0,0 +1,118 @@ +use std::io; +use std::collections::VecDeque; + +use bytes::BytesMut; +use futures::Future; +use futures::future::Either; +use futures::unsync::oneshot; +use tokio_core::net::TcpStream; +use tokio_io::codec::{Decoder, Encoder}; +use redis_async::{resp, error}; + +use actix::prelude::*; + +#[derive(Fail, Debug)] +pub enum Error { + #[fail(display="Io error: {}", _0)] + Io(io::Error), + #[fail(display="Redis error")] + Redis(error::Error), +} + +unsafe impl Send for Error {} +unsafe impl Sync for Error {} + +impl From for Error { + fn from(err: io::Error) -> Error { + Error::Io(err) + } +} + +#[derive(Message)] +pub struct Value(resp::RespValue); + +/// Redis codec wrapper +pub struct RedisCodec; + +impl Encoder for RedisCodec { + type Item = Value; + type Error = Error; + + fn encode(&mut self, msg: Value, buf: &mut BytesMut) -> Result<(), Self::Error> { + match resp::RespCodec.encode(msg.0, buf) { + Ok(()) => Ok(()), + Err(err) => Err(Error::Io(err)) + } + } +} + +impl Decoder for RedisCodec { + type Item = Value; + type Error = Error; + + fn decode(&mut self, buf: &mut BytesMut) -> Result, Self::Error> { + match resp::RespCodec.decode(buf) { + Ok(Some(item)) => Ok(Some(Value(item))), + Ok(None) => Ok(None), + Err(err) => Err(Error::Redis(err)), + } + } +} + +pub struct Command(pub resp::RespValue); + +impl ResponseType for Command { + type Item = resp::RespValue; + type Error = Error; +} + +/// Redis comminucation actor +pub struct RedisActor { + queue: VecDeque>>, +} + +impl RedisActor { + pub fn start(io: TcpStream) -> Address { + RedisActor{queue: VecDeque::new()}.framed(io, RedisCodec) + } +} + +impl Actor for RedisActor { + type Context = FramedContext; +} + +impl FramedActor for RedisActor { + type Io = TcpStream; + type Codec = RedisCodec; +} + +impl StreamHandler for RedisActor {} + +impl Handler for RedisActor { + + fn error(&mut self, err: Error, _: &mut Self::Context) { + if let Some(tx) = self.queue.pop_front() { + let _ = tx.send(Err(err)); + } + } + + fn handle(&mut self, msg: Value, _ctx: &mut Self::Context) -> Response { + if let Some(tx) = self.queue.pop_front() { + let _ = tx.send(Ok(msg.0)); + } + Self::empty() + } +} + +impl Handler for RedisActor { + fn handle(&mut self, msg: Command, ctx: &mut Self::Context) -> Response { + let (tx, rx) = oneshot::channel(); + self.queue.push_back(tx); + ctx.send(Value(msg.0)); + + Self::async_reply( + rx.map_err(|_| io::Error::new(io::ErrorKind::Other, "").into()) + .and_then(|res| res) + .actfuture()) + } +} diff --git a/src/session.rs b/src/session.rs new file mode 100644 index 000000000..49a4b0c48 --- /dev/null +++ b/src/session.rs @@ -0,0 +1,156 @@ +use std::{io, net}; +use std::rc::Rc; +use std::time::Duration; +use std::collections::HashMap; + +use serde_json; +use futures::Future; +use futures::future::{Either, ok as FutOk, err as FutErr}; +use tokio_core::net::TcpStream; +use actix::prelude::*; +use actix_web::{error, Error, HttpRequest, HttpResponse}; +use actix_web::middleware::{SessionImpl, SessionBackend, Response as MiddlewareResponse}; + +use redis::{Command, RedisActor}; + + +/// Session that stores data in redis +pub struct RedisSession { + changed: bool, + inner: Rc, + state: HashMap, +} + +impl SessionImpl for RedisSession { + + fn get(&self, key: &str) -> Option<&str> { + if let Some(s) = self.state.get(key) { + Some(s) + } else { + None + } + } + + fn set(&mut self, key: &str, value: String) { + self.changed = true; + self.state.insert(key.to_owned(), value); + } + + fn remove(&mut self, key: &str) { + self.changed = true; + self.state.remove(key); + } + + fn clear(&mut self) { + self.changed = true; + self.state.clear() + } + + fn write(&self, mut resp: HttpResponse) -> MiddlewareResponse { + if self.changed { + let _ = self.inner.update(&self.state); + } + MiddlewareResponse::Done(resp) + } +} + +pub struct RedisSessionBackend(Rc); + +impl RedisSessionBackend { + /// Create new redis session backend + pub fn new(addr: S, ttl: Duration) -> io::Result { + let h = Arbiter::handle(); + let mut err = None; + for addr in addr.to_socket_addrs()? { + match TcpStream::connect(&addr, &h).wait() { + Err(e) => err = Some(e), + Ok(conn) => { + let addr = RedisActor::start(conn); + return Ok(RedisSessionBackend(Rc::new(Inner{ttl: ttl, addr: addr}))); + }, + } + } + if let Some(e) = err.take() { + Err(e) + } else { + Err(io::Error::new(io::ErrorKind::Other, "Can not connect to redis server.")) + } + } +} + +impl SessionBackend for RedisSessionBackend { + + type Session = RedisSession; + type ReadFuture = Box>; + + fn from_request(&self, req: &mut HttpRequest) -> Self::ReadFuture { + let inner = Rc::clone(&self.0); + + Box::new(self.0.load(req).map(move |state| { + if let Some(state) = state { + RedisSession { + changed: false, + inner: inner, + state: state, + } + } else { + RedisSession { + changed: false, + inner: inner, + state: HashMap::new(), + } + } + })) + } +} + +struct Inner { + ttl: Duration, + addr: Address, +} + +impl Inner { + fn load(&self, req: &mut HttpRequest) + -> Box>, Error=Error>> + { + if let Ok(cookies) = req.cookies() { + for cookie in cookies { + if cookie.name() == "actix-session" { + return Box::new( + self.addr.call_fut(Command(resp_array!["GET", cookie.value()])) + .map_err(Error::from) + .and_then(|res| { + match res { + Ok(val) => { + println!("VAL {:?}", val); + Ok(Some(HashMap::new())) + }, + Err(err) => Err( + io::Error::new(io::ErrorKind::Other, "Error").into()) + } + })) + } + } + } + Box::new(FutOk(None)) + } + + fn update(&self, state: &HashMap) -> Box> { + Box::new( + match serde_json::to_string(state) { + Err(e) => Either::A(FutErr(e.into())), + Ok(body) => { + Either::B( + self.addr.call_fut(Command(resp_array!["GET", "test"])) + .map_err(Error::from) + .and_then(|res| { + match res { + Ok(val) => Ok(()), + Err(err) => Err( + error::ErrorInternalServerError(err).into()) + } + })) + } + }) + } +}