opendal/services/dropbox/
lister.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::sync::Arc;
19
20use bytes::Buf;
21
22use super::core::*;
23use super::error::parse_error;
24use crate::raw::*;
25use crate::*;
26
27pub struct DropboxLister {
28    core: Arc<DropboxCore>,
29    path: String,
30    recursive: bool,
31    limit: Option<usize>,
32}
33
34impl DropboxLister {
35    pub fn new(
36        core: Arc<DropboxCore>,
37        path: String,
38        recursive: bool,
39        limit: Option<usize>,
40    ) -> Self {
41        Self {
42            core,
43            path,
44            recursive,
45            limit,
46        }
47    }
48}
49
50impl oio::PageList for DropboxLister {
51    async fn next_page(&self, ctx: &mut oio::PageContext) -> Result<()> {
52        // The token is set when obtaining entries and returning `has_more` flag.
53        // When the token exists, we should retrieve more entries using the Dropbox continue API.
54        // Refer: https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue
55        let response = if !ctx.token.is_empty() {
56            self.core.dropbox_list_continue(&ctx.token).await?
57        } else {
58            self.core
59                .dropbox_list(&self.path, self.recursive, self.limit)
60                .await?
61        };
62
63        let status_code = response.status();
64
65        if !status_code.is_success() {
66            let error = parse_error(response);
67
68            let result = match error.kind() {
69                ErrorKind::NotFound => Ok(()),
70                _ => Err(error),
71            };
72
73            ctx.done = true;
74            return result;
75        }
76
77        let bytes = response.into_body();
78        let decoded_response: DropboxListResponse =
79            serde_json::from_reader(bytes.reader()).map_err(new_json_deserialize_error)?;
80
81        for entry in decoded_response.entries {
82            let entry_mode = match entry.tag.as_str() {
83                "file" => EntryMode::FILE,
84                "folder" => EntryMode::DIR,
85                _ => EntryMode::Unknown,
86            };
87
88            let mut name = entry.name;
89            let mut meta = Metadata::new(entry_mode);
90
91            // Dropbox will return folder names that do not end with '/'.
92            if entry_mode == EntryMode::DIR && !name.ends_with('/') {
93                name.push('/');
94            }
95
96            // The behavior here aligns with Dropbox's stat function.
97            if entry_mode == EntryMode::FILE {
98                let date_utc_last_modified = parse_datetime_from_rfc3339(&entry.client_modified)?;
99                meta.set_last_modified(date_utc_last_modified);
100
101                if let Some(size) = entry.size {
102                    meta.set_content_length(size);
103                }
104            }
105
106            ctx.entries.push_back(oio::Entry::with(name, meta));
107        }
108
109        if decoded_response.has_more {
110            ctx.token = decoded_response.cursor;
111            ctx.done = false;
112        } else {
113            ctx.done = true;
114        }
115        Ok(())
116    }
117}
opendal/services/dropbox/lister.rs

opendal/services/dropbox/
lister.rs
