1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
use crate::service::RedirectSchemeService;
use actix_service::{Service, Transform};
use actix_web::dev::{ServiceRequest, ServiceResponse};
use actix_web::Error;
use futures::future::{ok, Ready};

/// Middleware for `actix-web` which redirects between `http` and `https` requests with optional url
/// string replacements.
///
/// ## Usage
/// ```
/// extern crate actix_web_middleware_redirect_scheme;
///
/// use actix_web::{App, web, HttpResponse};
/// use actix_web_middleware_redirect_scheme::RedirectSchemeBuilder;
///
/// App::new()
///     .wrap(RedirectSchemeBuilder::new().temporary().build())
///     .route("/", web::get().to(|| HttpResponse::Ok()
///                                     .content_type("text/plain")
///                                     .body("Always HTTPS!")));
/// ```
#[derive(Default, Clone)]
pub struct RedirectScheme {
    // Redirect to HTTP (true: HTTP -> HTTPS, false: HTTPS -> HTTP)
    pub https_to_http: bool,
    // Temporary redirect (true: 307 Temporary Redirect, false: 301 Moved Permanently)
    pub temporary: bool,
    // List of string replacements
    pub replacements: Vec<(String, String)>,
}

impl RedirectScheme {
    /// Creates a RedirectScheme middleware.
    ///
    /// ## Usage
    /// ```
    /// extern crate actix_web_middleware_redirect_scheme;
    ///
    /// use actix_web::{App, web, HttpResponse};
    /// use actix_web_middleware_redirect_scheme::RedirectScheme;
    ///
    /// App::new()
    ///     .wrap(RedirectScheme::simple(false))
    ///     .route("/", web::get().to(|| HttpResponse::Ok()
    ///                                     .content_type("text/plain")
    ///                                     .body("Always HTTPS on non-default ports!")));
    /// ```
    pub fn simple(https_to_http: bool) -> Self {
        RedirectScheme {
            https_to_http,
            ..Self::default()
        }
    }

    /// Creates a RedirectScheme middleware which also performs string replacement on the final url.
    /// This is useful when not running on the default web and ssl ports (80 and 443) since we will
    /// need to change the development web port in the hostname to the development ssl port.
    ///
    /// ## Usage
    /// ```
    /// extern crate actix_web_middleware_redirect_scheme;
    ///
    /// use actix_web::{App, web, HttpResponse};
    /// use actix_web_middleware_redirect_scheme::RedirectScheme;
    ///
    /// App::new()
    ///     .wrap(RedirectScheme::with_replacements(false, &[(":8080".to_owned(), ":8443".to_owned())]))
    ///     .route("/", web::get().to(|| HttpResponse::Ok()
    ///                                     .content_type("text/plain")
    ///                                     .body("Always HTTPS on non-default ports!")));
    /// ```
    pub fn with_replacements(https_to_http: bool, replacements: &[(String, String)]) -> Self {
        RedirectScheme {
            https_to_http,
            temporary: false,
            replacements: replacements.to_vec(),
        }
    }
}

impl<S, B> Transform<S> for RedirectScheme
where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static,
{
    type Request = ServiceRequest;
    type Response = ServiceResponse<B>;
    type Error = Error;
    type InitError = ();
    type Transform = RedirectSchemeService<S>;
    type Future = Ready<Result<Self::Transform, Self::InitError>>;

    fn new_transform(&self, service: S) -> Self::Future {
        ok(RedirectSchemeService {
            service,
            https_to_http: self.https_to_http,
            temporary: self.temporary,
            replacements: self.replacements.clone(),
        })
    }
}