opendal/services/http/
backend.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20use std::sync::Arc;
21
22use http::Response;
23use http::StatusCode;
24use log::debug;
25
26use super::core::HttpCore;
27use super::error::parse_error;
28use crate::raw::*;
29use crate::services::HttpConfig;
30use crate::*;
31
32impl Configurator for HttpConfig {
33    type Builder = HttpBuilder;
34
35    #[allow(deprecated)]
36    fn into_builder(self) -> Self::Builder {
37        HttpBuilder {
38            config: self,
39            http_client: None,
40        }
41    }
42}
43
44/// HTTP Read-only service support like [Nginx](https://www.nginx.com/) and [Caddy](https://caddyserver.com/).
45#[doc = include_str!("docs.md")]
46#[derive(Default)]
47pub struct HttpBuilder {
48    config: HttpConfig,
49
50    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
51    http_client: Option<HttpClient>,
52}
53
54impl Debug for HttpBuilder {
55    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
56        let mut de = f.debug_struct("HttpBuilder");
57
58        de.field("config", &self.config).finish()
59    }
60}
61
62impl HttpBuilder {
63    /// Set endpoint for http backend.
64    ///
65    /// For example: `https://example.com`
66    pub fn endpoint(mut self, endpoint: &str) -> Self {
67        self.config.endpoint = if endpoint.is_empty() {
68            None
69        } else {
70            Some(endpoint.to_string())
71        };
72
73        self
74    }
75
76    /// set username for http backend
77    ///
78    /// default: no username
79    pub fn username(mut self, username: &str) -> Self {
80        if !username.is_empty() {
81            self.config.username = Some(username.to_owned());
82        }
83        self
84    }
85
86    /// set password for http backend
87    ///
88    /// default: no password
89    pub fn password(mut self, password: &str) -> Self {
90        if !password.is_empty() {
91            self.config.password = Some(password.to_owned());
92        }
93        self
94    }
95
96    /// set bearer token for http backend
97    ///
98    /// default: no access token
99    pub fn token(mut self, token: &str) -> Self {
100        if !token.is_empty() {
101            self.config.token = Some(token.to_string());
102        }
103        self
104    }
105
106    /// Set root path of http backend.
107    pub fn root(mut self, root: &str) -> Self {
108        self.config.root = if root.is_empty() {
109            None
110        } else {
111            Some(root.to_string())
112        };
113
114        self
115    }
116
117    /// Specify the http client that used by this service.
118    ///
119    /// # Notes
120    ///
121    /// This API is part of OpenDAL's Raw API. `HttpClient` could be changed
122    /// during minor updates.
123    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
124    #[allow(deprecated)]
125    pub fn http_client(mut self, client: HttpClient) -> Self {
126        self.http_client = Some(client);
127        self
128    }
129}
130
131impl Builder for HttpBuilder {
132    const SCHEME: Scheme = Scheme::Http;
133    type Config = HttpConfig;
134
135    fn build(self) -> Result<impl Access> {
136        debug!("backend build started: {:?}", &self);
137
138        let endpoint = match &self.config.endpoint {
139            Some(v) => v,
140            None => {
141                return Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
142                    .with_context("service", Scheme::Http))
143            }
144        };
145
146        let root = normalize_root(&self.config.root.unwrap_or_default());
147        debug!("backend use root {root}");
148
149        let mut auth = None;
150        if let Some(username) = &self.config.username {
151            auth = Some(format_authorization_by_basic(
152                username,
153                self.config.password.as_deref().unwrap_or_default(),
154            )?);
155        }
156        if let Some(token) = &self.config.token {
157            auth = Some(format_authorization_by_bearer(token)?)
158        }
159
160        let info = AccessorInfo::default();
161        info.set_scheme(Scheme::Http)
162            .set_root(&root)
163            .set_native_capability(Capability {
164                stat: true,
165                stat_with_if_match: true,
166                stat_with_if_none_match: true,
167
168                read: true,
169
170                read_with_if_match: true,
171                read_with_if_none_match: true,
172
173                presign: auth.is_none(),
174                presign_read: auth.is_none(),
175                presign_stat: auth.is_none(),
176
177                shared: true,
178
179                ..Default::default()
180            });
181
182        // allow deprecated api here for compatibility
183        #[allow(deprecated)]
184        if let Some(client) = self.http_client {
185            info.update_http_client(|_| client);
186        }
187
188        let accessor_info = Arc::new(info);
189
190        let core = Arc::new(HttpCore {
191            info: accessor_info,
192            endpoint: endpoint.to_string(),
193            root,
194            authorization: auth,
195        });
196
197        Ok(HttpBackend { core })
198    }
199}
200
201/// Backend is used to serve `Accessor` support for http.
202#[derive(Clone)]
203pub struct HttpBackend {
204    core: Arc<HttpCore>,
205}
206
207impl Debug for HttpBackend {
208    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
209        f.debug_struct("HttpBackend")
210            .field("core", &self.core)
211            .finish()
212    }
213}
214
215impl Access for HttpBackend {
216    type Reader = HttpBody;
217    type Writer = ();
218    type Lister = ();
219    type Deleter = ();
220
221    fn info(&self) -> Arc<AccessorInfo> {
222        self.core.info.clone()
223    }
224
225    async fn stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
226        // Stat root always returns a DIR.
227        if path == "/" {
228            return Ok(RpStat::new(Metadata::new(EntryMode::DIR)));
229        }
230
231        let resp = self.core.http_head(path, &args).await?;
232
233        let status = resp.status();
234
235        match status {
236            StatusCode::OK => parse_into_metadata(path, resp.headers()).map(RpStat::new),
237            // HTTP Server like nginx could return FORBIDDEN if auto-index
238            // is not enabled, we should ignore them.
239            StatusCode::NOT_FOUND | StatusCode::FORBIDDEN if path.ends_with('/') => {
240                Ok(RpStat::new(Metadata::new(EntryMode::DIR)))
241            }
242            _ => Err(parse_error(resp)),
243        }
244    }
245
246    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
247        let resp = self.core.http_get(path, args.range(), &args).await?;
248
249        let status = resp.status();
250
251        match status {
252            StatusCode::OK | StatusCode::PARTIAL_CONTENT => {
253                Ok((RpRead::default(), resp.into_body()))
254            }
255            _ => {
256                let (part, mut body) = resp.into_parts();
257                let buf = body.to_buffer().await?;
258                Err(parse_error(Response::from_parts(part, buf)))
259            }
260        }
261    }
262
263    async fn presign(&self, path: &str, args: OpPresign) -> Result<RpPresign> {
264        if self.core.has_authorization() {
265            return Err(Error::new(
266                ErrorKind::Unsupported,
267                "Http doesn't support presigned request on backend with authorization",
268            ));
269        }
270
271        let req = match args.operation() {
272            PresignOperation::Stat(v) => self.core.http_head_request(path, v)?,
273            PresignOperation::Read(v) => {
274                self.core.http_get_request(path, BytesRange::default(), v)?
275            }
276            _ => {
277                return Err(Error::new(
278                    ErrorKind::Unsupported,
279                    "Http doesn't support presigned write",
280                ))
281            }
282        };
283
284        let (parts, _) = req.into_parts();
285
286        Ok(RpPresign::new(PresignedRequest::new(
287            parts.method,
288            parts.uri,
289            parts.headers,
290        )))
291    }
292}
opendal/services/http/backend.rs

opendal/services/http/
backend.rs
