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 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
//! This module defines various methods and structs for interacting with uplaods on backblaze. //! //! The primary struct in this module is [UploadAuthorization][1], which has various methods for //! uploading files to backblaze b2. This struct is usually obtained from a [B2Authorization][2] //! using the method [get_upload_url][3]. //! //! [1]: struct.UploadAuthorization.html //! [2]: ../authorize/struct.B2Authorization.html //! [3]: ../authorize/struct.B2Authorization.html#method.get_upload_url use std::io::{Write, Read, copy}; use hyper::{self, Client, Url}; use hyper::client::Body; use hyper::client::request::Request; use hyper::header::{Headers,ContentLength,ContentType}; use hyper::mime::Mime; use hyper::method::Method; use hyper::net::{Streaming, NetworkConnector, NetworkStream}; use serde::Deserialize; use serde_json; use B2Error; use B2AuthHeader; use raw::authorize::B2Authorization; use raw::files::MoreFileInfo; /// Contains the information needed to authorize an upload to b2. This struct is usually obtained /// from a [B2Authorization][1] using the method [get_upload_url][2]. /// /// The b2 website specifies that you may not upload to the same url in parallel. /// /// [1]: ../authorize/struct.B2Authorization.html /// [2]: ../authorize/struct.B2Authorization.html#method.get_upload_url #[derive(Deserialize,Serialize,Clone,Debug)] #[serde(rename_all = "camelCase")] pub struct UploadAuthorization { pub bucket_id: String, pub upload_url: String, pub authorization_token: String } impl UploadAuthorization { /// Returns a hyper header that authorizes an upload request. pub fn auth_header(&self) -> B2AuthHeader { B2AuthHeader(self.authorization_token.clone()) } } /// Methods related to the [upload module][1]. /// /// [1]: ../upload/index.html impl B2Authorization { /// Performs a [b2_get_upload_url][1] api call and returns the upload url wrapped in an /// [`UploadAuthorization`]. /// /// # Errors /// This function returns a [`B2Error`] in case something goes wrong. Besides the standard /// errors, this function can fail with [`is_bucket_not_found`]. /// /// [1]: https://www.backblaze.com/b2/docs/b2_get_upload_url.html /// [`B2Error`]: ../authorize/enum.B2Error.html /// [`is_bucket_not_found`]: ../../enum.B2Error.html#method.is_bucket_not_found /// [`UploadAuthorization`]: struct.UploadAuthorization.html pub fn get_upload_url(&self, bucket_id: &str, client: &Client) -> Result<UploadAuthorization,B2Error> { let url_string: String = format!("{}/b2api/v1/b2_get_upload_url", self.api_url); let url: &str = &url_string; #[derive(Serialize)] #[serde(rename_all = "camelCase")] struct Request<'a> { bucket_id: &'a str } let request = Request { bucket_id: bucket_id }; let body: String = serde_json::to_string(&request)?; let resp = client.post(url) .body(Body::BufBody(body.as_bytes(), body.len())) .header(self.auth_header()) .send()?; if resp.status != hyper::status::StatusCode::Ok { Err(B2Error::from_response(resp)) } else { Ok(serde_json::from_reader(resp)?) } } } impl UploadAuthorization { /// Equivalent to calling [create_upload_file_request][1], writing everything in the Read to /// the Writer and calling finish. /// /// [1]: struct.UploadAuthorization.html#method.create_upload_file_request pub fn upload_file<InfoType, R: Read, C, S>(&self, file: &mut R, file_name: String, content_type: Option<Mime>, content_length: u64, content_sha1: String, connector: &C) -> Result<MoreFileInfo<InfoType>, B2Error> where for<'de> InfoType: Deserialize<'de>, R: Sized, C: NetworkConnector<Stream=S>, S: Into<Box<NetworkStream + Send>> { let mut ufr = self.create_upload_file_request( file_name, content_type, content_length, content_sha1, connector)?; copy(file, &mut ufr)?; ufr.finish() } /// Starts a request to upload a file to backblaze b2. This function returns an /// [UploadFileRequest][1], which implements [Write][2]. When writing to this object, the /// data is sent to backblaze b2. This method of uploading can be used to /// implement things such as rate limiting of the request. /// /// After the file has been sent, you need to call the [finish method][3] on the /// [UploadFileRequest][1], in order to close the connection. /// /// The [upload_file method][4] can be used to upload any Reader easily. The backblaze api /// supports not specifying the sha1 checksum. This is not recommended, but if you wish to do /// this, simply pass the string `do_not_verify` as the sha1 checksum. /// /// The function [create_upload_file_request_sha1_at_end][5] might be of interest. This /// function behaves identically to this function, except the sha1 is passed when calling /// finish instead of before initiating the request. /// /// Read the [backblaze api documentation][6] for more information. /// /// # Errors /// This function returns a [`B2Error`] in case something goes wrong. Besides the standard /// errors, this function can fail with [`is_invalid_file_name`] and [`is_cap_exceeded`]. /// /// [1]: struct.UploadFileRequest.html /// [2]: https://doc.rust-lang.org/stable/std/io/trait.Write.html /// [3]: struct.UploadFileRequest.html#method.finish /// [4]: struct.UploadAuthorization.html#method.upload_file /// [5]: struct.UploadFileRequest.html#method.create_upload_file_request_sha1_at_end /// [6]: https://www.backblaze.com/b2/docs/uploading.html /// [`B2Error`]: ../authorize/enum.B2Error.html /// [`is_invalid_file_name`]: ../../enum.B2Error.html#method.is_invalid_file_name /// [`is_cap_exceeded`]: ../../enum.B2Error.html#method.is_cap_exceeded pub fn create_upload_file_request<C,S>(&self, file_name: String, content_type: Option<Mime>, content_length: u64, content_sha1: String, connector: &C) -> Result<UploadFileRequest, B2Error> where C: NetworkConnector<Stream=S>, S: Into<Box<NetworkStream + Send>> { let url: Url = Url::parse(&self.upload_url)?; let mut request = Request::with_connector(Method::Post, url, connector)?; { let headers: &mut Headers = request.headers_mut(); headers.set(self.auth_header()); headers.set(XBzFileName(file_name)); headers.set(XBzContentSha1(content_sha1)); headers.set(ContentLength(content_length)); headers.set(ContentType(match content_type { Some(v) => v, None => "b2/x-auto".parse().unwrap() })); } Ok(UploadFileRequest { request: request.start()? }) } /// Starts a request to upload a file to backblaze b2. This function returns an /// [UploadFileRequestSha1End][1], which implements [Write][2]. When writing to this object, /// the data is sent to backblaze b2. This method of uploading can be used to implement things /// such as rate limiting of the request. /// /// The value of the `content_length` parameter must be exactly the amount of bytes you are /// going to write, not including the 40 byte sha1 appended by the [finish method][3]. /// /// After the file has been sent, you need to call the [finish method][3] on the /// [UploadFileRequestSha1End][1], in order to close the connection. /// /// Read the [backblaze api documentation][4] for more information. /// /// # Errors /// This function returns a [`B2Error`] in case something goes wrong. Besides the standard /// errors, this function can fail with [`is_invalid_file_name`] and [`is_cap_exceeded`]. /// /// [1]: struct.UploadFileRequestSha1End.html /// [2]: https://doc.rust-lang.org/stable/std/io/trait.Write.html /// [3]: struct.UploadFileRequestSha1End.html#method.finish /// [4]: https://www.backblaze.com/b2/docs/uploading.html /// [`B2Error`]: ../authorize/enum.B2Error.html /// [`is_invalid_file_name`]: ../../enum.B2Error.html#method.is_invalid_file_name /// [`is_cap_exceeded`]: ../../enum.B2Error.html#method.is_cap_exceeded pub fn create_upload_file_request_sha1_at_end<C,S>(&self, file_name: String, content_type: Option<Mime>, content_length: u64, connector: &C) -> Result<UploadFileRequestSha1End, B2Error> where C: NetworkConnector<Stream=S>, S: Into<Box<NetworkStream + Send>> { let url: Url = Url::parse(&self.upload_url)?; let mut request = Request::with_connector(Method::Post, url, connector)?; { let headers: &mut Headers = request.headers_mut(); headers.set(self.auth_header()); headers.set(XBzFileName(file_name)); headers.set(XBzContentSha1("hex_digits_at_end".to_owned())); headers.set(ContentLength(content_length + 40)); headers.set(ContentType(match content_type { Some(v) => v, None => "b2/x-auto".parse().unwrap() })); } Ok(UploadFileRequestSha1End { request: request.start()? }) } } header! { (XBzFileName, "X-Bz-File-Name") => [String] } header! { (XBzContentSha1, "X-Bz-Content-Sha1") => [String] } /// Contains an ongoing upload to the backblaze b2 api. This struct is created by the /// [`create_upload_file_request`] method. /// /// [`create_upload_file_request`]: struct.UploadAuthorization.html#method.create_upload_file_request pub struct UploadFileRequest { request: Request<Streaming> } impl Write for UploadFileRequest { fn write(&mut self, msg: &[u8]) -> ::std::io::Result<usize> { self.request.write(msg) } fn flush(&mut self) -> ::std::io::Result<()> { self.request.flush() } fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> { self.request.write_all(buf) } fn write_fmt(&mut self, fmt: ::core::fmt::Arguments) -> Result<(), ::std::io::Error> { self.request.write_fmt(fmt) } } impl UploadFileRequest { /// Finishes the upload of the file and returns information about the uploaded file. /// /// # Errors /// This function returns a [`B2Error`] in case something goes wrong. Besides the standard /// errors, this function can fail with [`is_cap_exceeded`], [`is_invalid_sha1`]. /// /// [`B2Error`]: ../authorize/enum.B2Error.html /// [`is_cap_exceeded`]: ../../enum.B2Error.html#method.is_cap_exceeded /// [`is_invalid_sha1`]: ../../enum.B2Error.html#method.is_invalid_sha1 pub fn finish<InfoType>(self) -> Result<MoreFileInfo<InfoType>, B2Error> where for<'de> InfoType: Deserialize<'de> { let resp = self.request.send()?; if resp.status != hyper::status::StatusCode::Ok { Err(B2Error::from_response(resp)) } else { Ok(serde_json::from_reader(resp)?) } } } /// Contains an ongoing upload to the backblaze b2 api. This struct is created by the /// [create_upload_file_request_sha1_at_end][1] method. /// /// [1]: struct.UploadAuthorization.html#method.create_upload_file_request_sha1_at_end pub struct UploadFileRequestSha1End { request: Request<Streaming> } impl Write for UploadFileRequestSha1End { fn write(&mut self, msg: &[u8]) -> ::std::io::Result<usize> { self.request.write(msg) } fn flush(&mut self) -> ::std::io::Result<()> { self.request.flush() } fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> { self.request.write_all(buf) } fn write_fmt(&mut self, fmt: ::core::fmt::Arguments) -> Result<(), ::std::io::Error> { self.request.write_fmt(fmt) } } impl UploadFileRequestSha1End { /// Finishes the upload of the file and returns information about the uploaded file. The `sha1` /// argument must be the ascii encoding of the sha1 of the file. /// /// The sha1 should be 40 bytes long, but this is not checked at runtime. If it is not 40 bytes /// the b2 server will complain with some kind of bad request error. /// /// # Errors /// This function returns a [`B2Error`] in case something goes wrong. Besides the standard /// errors, this function can fail with [`is_cap_exceeded`], [`is_invalid_sha1`]. /// /// [`B2Error`]: ../authorize/enum.B2Error.html /// [`is_cap_exceeded`]: ../../enum.B2Error.html#method.is_cap_exceeded /// [`is_invalid_sha1`]: ../../enum.B2Error.html#method.is_invalid_sha1 pub fn finish<InfoType>(mut self, sha1: &str) -> Result<MoreFileInfo<InfoType>, B2Error> where for<'de> InfoType: Deserialize<'de> { self.request.write_all(sha1.as_bytes())?; let resp = self.request.send()?; if resp.status != hyper::status::StatusCode::Ok { Err(B2Error::from_response(resp)) } else { Ok(serde_json::from_reader(resp)?) } } }