Expose the POST redirection setting (#286)

Change-Id: Ib094f5480f7571255c50f9a7d05fa3102df74e27

Author: larper2axis

src/easy/handle.rs

@@ -10,7 +10,7 @@ use curl_sys;
 use libc::c_void;
 
 use crate::easy::handler::{self, InfoType, ReadError, SeekResult, WriteError};
-use crate::easy::handler::{Auth, NetRc, ProxyType, SslOpt};
+use crate::easy::handler::{Auth, NetRc, PostRedirections, ProxyType, SslOpt};
 use crate::easy::handler::{HttpVersion, IpResolve, SslVersion, TimeCondition};
 use crate::easy::{Easy2, Handler};
 use crate::easy::{Form, List};
@@ -802,6 +802,11 @@ impl Easy {
         self.inner.max_redirections(max)
     }
 
+    /// Same as [`Easy2::post_redirections`](struct.Easy2.html#method.post_redirections)
+    pub fn post_redirections(&mut self, redirects: &PostRedirections) -> Result<(), Error> {
+        self.inner.post_redirections(redirects)
+    }
+
     /// Same as [`Easy2::put`](struct.Easy2.html#method.put)
     pub fn put(&mut self, enable: bool) -> Result<(), Error> {
         self.inner.put(enable)

src/easy/handler.rs

@@ -571,6 +571,10 @@ pub struct Auth {
 pub struct SslOpt {
     bits: c_long,
 }
+/// Structure which stores possible post redirection options to pass to `post_redirections`.
+pub struct PostRedirections {
+    bits: c_ulong,
+}
 
 impl<H: Handler> Easy2<H> {
     /// Creates a new "easy" handle which is the core of almost all operations
@@ -1474,7 +1478,14 @@ impl<H> Easy2<H> {
         self.setopt_long(curl_sys::CURLOPT_MAXREDIRS, max as c_long)
     }
 
-    // TODO: post_redirections
+    /// Set the policy for handling redirects to POST requests.
+    ///
+    /// By default a POST is changed to a GET when following a redirect. Setting any
+    /// of the `PostRedirections` flags will preserve the POST method for the
+    /// selected response codes.
+    pub fn post_redirections(&mut self, redirects: &PostRedirections) -> Result<(), Error> {
+        self.setopt_long(curl_sys::CURLOPT_POSTREDIR, redirects.bits as c_long)
+    }
 
     /// Make an HTTP PUT request.
     ///
@@ -3911,3 +3922,66 @@ impl fmt::Debug for SslOpt {
             .finish()
     }
 }
+
+impl PostRedirections {
+    /// Create an empty PostRedirection setting with no flags set.
+    pub fn new() -> PostRedirections {
+        PostRedirections { bits: 0 }
+    }
+
+    /// Configure POST method behaviour on a 301 redirect. Setting the value
+    /// to true will preserve the method when following the redirect, else
+    /// the method is changed to GET.
+    pub fn redirect_301(&mut self, on: bool) -> &mut PostRedirections {
+        self.flag(curl_sys::CURL_REDIR_POST_301, on)
+    }
+
+    /// Configure POST method behaviour on a 302 redirect. Setting the value
+    /// to true will preserve the method when following the redirect, else
+    /// the method is changed to GET.
+    pub fn redirect_302(&mut self, on: bool) -> &mut PostRedirections {
+        self.flag(curl_sys::CURL_REDIR_POST_302, on)
+    }
+
+    /// Configure POST method behaviour on a 303 redirect. Setting the value
+    /// to true will preserve the method when following the redirect, else
+    /// the method is changed to GET.
+    pub fn redirect_303(&mut self, on: bool) -> &mut PostRedirections {
+        self.flag(curl_sys::CURL_REDIR_POST_303, on)
+    }
+
+    /// Configure POST method behaviour for all redirects. Setting the value
+    /// to true will preserve the method when following the redirect, else
+    /// the method is changed to GET.
+    pub fn redirect_all(&mut self, on: bool) -> &mut PostRedirections {
+        self.flag(curl_sys::CURL_REDIR_POST_ALL, on)
+    }
+
+    fn flag(&mut self, bit: c_ulong, on: bool) -> &mut PostRedirections {
+        if on {
+            self.bits |= bit;
+        } else {
+            self.bits &= !bit;
+        }
+        self
+    }
+}
+
+impl fmt::Debug for PostRedirections {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        f.debug_struct("PostRedirections")
+            .field(
+                "redirect_301",
+                &(self.bits & curl_sys::CURL_REDIR_POST_301 != 0),
+            )
+            .field(
+                "redirect_302",
+                &(self.bits & curl_sys::CURL_REDIR_POST_302 != 0),
+            )
+            .field(
+                "redirect_303",
+                &(self.bits & curl_sys::CURL_REDIR_POST_303 != 0),
+            )
+            .finish()
+    }
+}

src/easy/mod.rs

@@ -15,7 +15,7 @@ mod windows;
 
 pub use self::form::{Form, Part};
 pub use self::handle::{Easy, Transfer};
-pub use self::handler::{Auth, NetRc, ProxyType, SslOpt};
+pub use self::handler::{Auth, NetRc, PostRedirections, ProxyType, SslOpt};
 pub use self::handler::{Easy2, Handler};
 pub use self::handler::{HttpVersion, IpResolve, SslVersion, TimeCondition};
 pub use self::handler::{InfoType, ReadError, SeekResult, WriteError};