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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
use super::{
    upload_token::OwnedUploadTokenProviderOrReferenced, DataPartitionProvider, DataSource,
    MultiPartsUploaderWithCallbacks, ObjectParams, ResumableRecorder, UploadManager,
};
use digest::Digest;
use qiniu_apis::{
    credential::AccessKey,
    http_client::{
        ApiResult, BucketRegionsProvider, Endpoints, EndpointsGetOptions, EndpointsProvider, GotRegions,
        RegionsProvider, RegionsProviderEndpoints, ServiceName,
    },
    storage,
};
use qiniu_upload_token::{BucketName, ObjectName};
use serde_json::Value;
use smart_default::SmartDefault;
use std::{fmt::Debug, num::NonZeroU64};

#[cfg(feature = "async")]
use {super::AsyncDataSource, futures::future::BoxFuture};

pub(super) struct PartsExpiredError;

/// 分片上传器接口
///
/// 将数据源通过多个分片的方式逐一上传,适合数据量较大的数据源,可以提供断点恢复的能力。
pub trait MultiPartsUploader:
    __private::Sealed + MultiPartsUploaderWithCallbacks + Clone + Send + Sync + Debug
{
    /// 数据源 KEY 的哈希算法
    type HashAlgorithm: Digest + Send + 'static;

    /// 初始化的分片信息
    type InitializedParts: InitializedParts + 'static;

    /// 已经上传的分片信息
    type UploadedPart: UploadedPart;

    /// 创建分片上传器
    fn new<R: ResumableRecorder<HashAlgorithm = Self::HashAlgorithm> + 'static>(
        upload_manager: UploadManager,
        resumable_recorder: R,
    ) -> Self;

    /// 获取初始化使用的上传管理器
    fn upload_manager(&self) -> &UploadManager;

    /// 初始化分片信息
    ///
    /// 该步骤只负责初始化分片,但不实际上传数据,如果提供了有效的断点续传记录器,则可以尝试在这一步找到记录。
    ///
    /// 该方法的异步版本为 [`Self::async_initialize_parts`]。
    fn initialize_parts<D: DataSource<Self::HashAlgorithm> + 'static>(
        &self,
        source: D,
        params: ObjectParams,
    ) -> ApiResult<Self::InitializedParts>;

    /// 上传分片
    ///
    /// 实际上传的分片大小由提供的分片大小提供者获取。
    ///
    /// 如果返回 [`Ok(None)`] 则表示已经没有更多分片可以上传。
    ///
    /// 该方法的异步版本为 [`Self::async_upload_part`]。
    fn upload_part(
        &self,
        initialized: &Self::InitializedParts,
        data_partitioner_provider: &dyn DataPartitionProvider,
    ) -> ApiResult<Option<Self::UploadedPart>>;

    /// 完成分片上传
    ///
    /// 在这步成功返回后,对象即可被读取。
    ///
    /// 该方法的异步版本为 [`Self::async_complete_parts`]。
    fn complete_parts(&self, initialized: &Self::InitializedParts, parts: &[Self::UploadedPart]) -> ApiResult<Value>;

    /// 重新初始化分片信息
    ///
    /// 该步骤负责将先前已经初始化过的分片信息全部重置,清空断点续传记录器中的记录,之后从头上传整个文件
    ///
    /// 该方法的异步版本为 [`Self::async_reinitialize_parts`]。
    fn reinitialize_parts(
        &self,
        initialized: &mut Self::InitializedParts,
        options: ReinitializeOptions,
    ) -> ApiResult<()>;

    /// 尝试恢复记录
    ///
    /// 如果提供了有效的断点续传记录器,该方法可以尝试在找到记录,如果找不到记录,或记录无法读取,则返回 `None`。
    ///
    /// 该方法的异步版本为 [`Self::try_to_async_resume_records`]。
    fn try_to_resume_parts<D: DataSource<Self::HashAlgorithm> + 'static>(
        &self,
        source: D,
        params: ObjectParams,
    ) -> Option<Self::InitializedParts>;

    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    /// 初始化的异步分片信息
    type AsyncInitializedParts: InitializedParts + 'static;

    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    /// 已经上传的异步分片信息
    type AsyncUploadedPart: UploadedPart;

    /// 异步初始化分片信息
    ///
    /// 该步骤只负责初始化分片,但不实际上传数据,如果提供了有效的断点续传记录器,则可以尝试在这一步找到记录。
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    fn async_initialize_parts<D: AsyncDataSource<Self::HashAlgorithm> + 'static>(
        &self,
        source: D,
        params: ObjectParams,
    ) -> BoxFuture<ApiResult<Self::AsyncInitializedParts>>;

    /// 异步上传分片
    ///
    /// 实际上传的分片大小由提供的分片大小提供者获取。
    ///
    /// 如果返回 [`Ok(None)`] 则表示已经没有更多分片可以上传。
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    fn async_upload_part<'r>(
        &'r self,
        initialized: &'r Self::AsyncInitializedParts,
        data_partitioner_provider: &'r dyn DataPartitionProvider,
    ) -> BoxFuture<'r, ApiResult<Option<Self::AsyncUploadedPart>>>;

    /// 异步完成分片上传
    ///
    /// 在这步成功返回后,对象即可被读取。
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    fn async_complete_parts<'r>(
        &'r self,
        initialized: &'r Self::AsyncInitializedParts,
        parts: &'r [Self::AsyncUploadedPart],
    ) -> BoxFuture<'r, ApiResult<Value>>;

    /// 异步重新初始化分片信息
    ///
    /// 该步骤负责将先前已经初始化过的分片信息全部重置,清空断点续传记录器中的记录,之后从头上传整个文件
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    fn async_reinitialize_parts<'r>(
        &'r self,
        initialized: &'r mut Self::AsyncInitializedParts,
        options: ReinitializeOptions,
    ) -> BoxFuture<'r, ApiResult<()>>;

    /// 异步尝试恢复记录
    ///
    /// 如果提供了有效的断点续传记录器,该方法可以尝试在找到记录,如果找不到记录,或记录无法读取,则返回 `None`。
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    fn try_to_async_resume_parts<D: AsyncDataSource<Self::HashAlgorithm> + 'static>(
        &self,
        source: D,
        params: ObjectParams,
    ) -> BoxFuture<Option<Self::AsyncInitializedParts>>;
}

/// 初始化的分片信息
pub trait InitializedParts: __private::Sealed + Clone + Send + Sync + Debug {
    /// 获取对象上传参数
    fn params(&self) -> &ObjectParams;

    /// 上传地址列表
    fn up_endpoints(&self) -> &Endpoints;
}

/// 已经上传的分片信息
pub trait UploadedPart: __private::Sealed + Send + Sync + Debug {
    /// 分片大小
    fn size(&self) -> NonZeroU64;

    /// 分片偏移量
    fn offset(&self) -> u64;

    /// 是否来自于断点恢复
    fn resumed(&self) -> bool;
}

/// 重新初始化分片信息的选项
#[derive(Debug, Clone, Default)]
pub struct ReinitializeOptions {
    endpoints_provider: ReinitializedUpEndpointsProvider,
}

impl ReinitializeOptions {
    /// 创建重新初始化分片信息的选项构建器
    #[inline]
    pub fn builder() -> ReinitializeOptionsBuilder {
        ReinitializeOptionsBuilder(Self::default())
    }
}

#[derive(Debug, Clone, SmartDefault)]
enum ReinitializedUpEndpointsProvider {
    #[default]
    KeepOriginalUpEndpoints,
    RefreshUpEndpoints,
    SpecifiedRegionsProvider(Box<dyn RegionsProvider>),
}

impl ReinitializeOptions {
    fn get_up_endpoints<M: MultiPartsUploader>(
        &self,
        uploader: &M,
        initialized: &M::InitializedParts,
    ) -> ApiResult<Endpoints> {
        match &self.endpoints_provider {
            ReinitializedUpEndpointsProvider::KeepOriginalUpEndpoints => Ok(initialized.up_endpoints().to_owned()),
            ReinitializedUpEndpointsProvider::RefreshUpEndpoints => uploader.get_up_endpoints(initialized.params()),
            ReinitializedUpEndpointsProvider::SpecifiedRegionsProvider(regions_provider) => {
                let opts = EndpointsGetOptions::builder().service_names(&[ServiceName::Up]).build();
                Ok(RegionsProviderEndpoints::new(regions_provider)
                    .get_endpoints(opts)?
                    .into_owned())
            }
        }
    }

    #[cfg(feature = "async")]
    async fn async_get_up_endpoints<M: MultiPartsUploader>(
        &self,
        uploader: &M,
        initialized: &M::AsyncInitializedParts,
    ) -> ApiResult<Endpoints> {
        match &self.endpoints_provider {
            ReinitializedUpEndpointsProvider::KeepOriginalUpEndpoints => Ok(initialized.up_endpoints().to_owned()),
            ReinitializedUpEndpointsProvider::RefreshUpEndpoints => {
                uploader.async_get_up_endpoints(initialized.params()).await
            }
            ReinitializedUpEndpointsProvider::SpecifiedRegionsProvider(regions_provider) => {
                let opts = EndpointsGetOptions::builder().service_names(&[ServiceName::Up]).build();
                Ok(RegionsProviderEndpoints::new(regions_provider)
                    .async_get_endpoints(opts)
                    .await?
                    .into_owned())
            }
        }
    }
}

/// 重新初始化分片信息的选项构建器
#[derive(Debug, Clone)]
pub struct ReinitializeOptionsBuilder(ReinitializeOptions);

impl ReinitializeOptionsBuilder {
    /// 复用先前的区域信息
    #[inline]
    pub fn keep_original_region(&mut self) -> &mut Self {
        self.0.endpoints_provider = ReinitializedUpEndpointsProvider::KeepOriginalUpEndpoints;
        self
    }

    /// 刷新区域信息
    #[inline]
    pub fn refresh_regions(&mut self) -> &mut Self {
        self.0.endpoints_provider = ReinitializedUpEndpointsProvider::RefreshUpEndpoints;
        self
    }

    /// 指定区域信息
    #[inline]
    pub fn regions_provider(&mut self, regions: impl RegionsProvider + 'static) -> &mut Self {
        self.0.endpoints_provider = ReinitializedUpEndpointsProvider::SpecifiedRegionsProvider(Box::new(regions));
        self
    }

    /// 构建重新初始化分片信息的选项
    #[inline]
    pub fn build(&self) -> ReinitializeOptions {
        self.0.to_owned()
    }
}

mod v1;
pub use v1::{MultiPartsV1Uploader, MultiPartsV1UploaderInitializedObject, MultiPartsV1UploaderUploadedPart};

mod v2;
pub use v2::{MultiPartsV2Uploader, MultiPartsV2UploaderInitializedObject, MultiPartsV2UploaderUploadedPart};

mod progress;

mod __private {
    pub trait Sealed {}
}

pub(super) trait MultiPartsUploaderExt: MultiPartsUploader {
    fn storage(&self) -> storage::Client {
        self.upload_manager().client().storage()
    }

    fn access_key(&self) -> ApiResult<AccessKey> {
        self.upload_manager().upload_token().access_key()
    }

    fn bucket_name(&self) -> ApiResult<BucketName> {
        self.upload_manager().upload_token().bucket_name()
    }

    #[cfg(feature = "async")]
    fn async_access_key(&self) -> BoxFuture<ApiResult<AccessKey>> {
        Box::pin(async move { self.upload_manager().upload_token().async_access_key().await })
    }

    #[cfg(feature = "async")]
    fn async_bucket_name(&self) -> BoxFuture<ApiResult<BucketName>> {
        Box::pin(async move { self.upload_manager().upload_token().async_bucket_name().await })
    }

    fn get_bucket_regions(&self, params: &ObjectParams) -> ApiResult<GotRegions> {
        if let Some(region_provider) = params.region_provider() {
            region_provider.get_all(Default::default())
        } else {
            self.get_bucket_region()?.get_all(Default::default())
        }
    }

    #[cfg(feature = "async")]
    fn async_get_bucket_regions<'a>(&'a self, params: &'a ObjectParams) -> BoxFuture<'a, ApiResult<GotRegions>> {
        Box::pin(async move {
            if let Some(region_provider) = params.region_provider() {
                region_provider.async_get_all(Default::default()).await
            } else {
                self.async_get_bucket_region()
                    .await?
                    .async_get_all(Default::default())
                    .await
            }
        })
    }

    fn get_up_endpoints(&self, params: &ObjectParams) -> ApiResult<Endpoints> {
        let options = EndpointsGetOptions::builder().service_names(&[ServiceName::Up]).build();
        let up_endpoints = if let Some(region_provider) = params.region_provider() {
            RegionsProviderEndpoints::new(region_provider)
                .get_endpoints(options)?
                .into_owned()
        } else {
            RegionsProviderEndpoints::new(self.get_bucket_region()?)
                .get_endpoints(options)?
                .into_owned()
        };
        Ok(up_endpoints)
    }

    #[cfg(feature = "async")]
    fn async_get_up_endpoints<'a>(&'a self, params: &'a ObjectParams) -> BoxFuture<'a, ApiResult<Endpoints>> {
        Box::pin(async move {
            let options = EndpointsGetOptions::builder().service_names(&[ServiceName::Up]).build();
            let up_endpoints = if let Some(region_provider) = params.region_provider() {
                RegionsProviderEndpoints::new(region_provider)
                    .async_get_endpoints(options)
                    .await?
                    .into_owned()
            } else {
                RegionsProviderEndpoints::new(self.async_get_bucket_region().await?)
                    .async_get_endpoints(options)
                    .await?
                    .into_owned()
            };
            Ok(up_endpoints)
        })
    }

    fn get_bucket_region(&self) -> ApiResult<BucketRegionsProvider> {
        Ok(self
            .upload_manager()
            .queryer()
            .query(self.access_key()?, self.bucket_name()?))
    }

    #[cfg(feature = "async")]
    fn async_get_bucket_region(&self) -> BoxFuture<ApiResult<BucketRegionsProvider>> {
        Box::pin(async move {
            Ok(self
                .upload_manager()
                .queryer()
                .query(self.async_access_key().await?, self.async_bucket_name().await?))
        })
    }

    fn make_upload_token_signer(&self, object_name: Option<ObjectName>) -> OwnedUploadTokenProviderOrReferenced<'_> {
        self.upload_manager()
            .upload_token()
            .make_upload_token_provider(object_name)
    }
}

impl<M: MultiPartsUploader> MultiPartsUploaderExt for M {}