cloudreve-api 0.9.0

A Rust library for interacting with Cloudreve API
Documentation
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
//! File-related API endpoints for Cloudreve v4 API

use crate::Error;
use crate::api::v4::ApiV4Client;
use crate::api::v4::models::*;
use crate::api::v4::uri::*;

/// File management methods
impl ApiV4Client {
    pub async fn upload_file(&self, request: &UploadRequest<'_>) -> Result<File, Error> {
        let response: ApiResponse<File> = self.post("/file", request).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for upload_file request: {:?}",
                response
            ))),
        }
    }

    /// Lists files in a directory with full response including metadata
    ///
    /// Returns a complete `ListResponse` containing:
    /// - `files`: Vector of files/folders in the directory
    /// - `parent`: Information about the parent directory
    /// - `pagination`: Pagination information (page, total_items, etc.)
    /// - `storage_policy`: Preferred storage policy for uploads to this directory
    /// - `props`: Navigator capabilities and settings
    ///
    /// # Arguments
    /// * `request` - ListFilesRequest with path and optional pagination params
    pub async fn list_files(&self, request: &ListFilesRequest<'_>) -> Result<ListResponse, Error> {
        let mut url = "/file".to_string();
        // The URI has to be percent-encoded before it goes into the query. A search
        // URI carries its own `?name=...`; left raw, that inner `?` would cut the
        // outer query short and the server would answer with a plain listing.
        let uri = match request.path.strip_prefix('/') {
            Some(path) => path_to_uri(path),
            None => path_to_uri(request.path),
        };
        url.push_str(&format!("?uri={}", urlencoding::encode(&uri)));
        if let Some(page) = request.page {
            url.push_str(&format!("&page={}", page));
        }
        if let Some(page_size) = request.page_size {
            url.push_str(&format!("&page_size={}", page_size));
        }
        if let Some(order_by) = request.order_by {
            url.push_str(&format!("&order_by={}", order_by));
        }
        if let Some(order_direction) = request.order_direction {
            url.push_str(&format!("&order_direction={}", order_direction));
        }
        if let Some(next_page_token) = request.next_page_token {
            url.push_str(&format!(
                "&next_page_token={}",
                urlencoding::encode(next_page_token)
            ));
        }

        let response: ApiResponse<ListResponse> = self.get(&url).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for list_files request: {:?}",
                response
            ))),
        }
    }

    pub async fn get_file_info(&self, file_path: &str) -> Result<File, Error> {
        // URI encode the path for V4 API, use /file/info endpoint
        let uri = path_to_uri(file_path);
        let response: ApiResponse<File> = self.get(&format!("/file/info?uri={}", uri)).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_file_info request: {:?}",
                response
            ))),
        }
    }

    pub async fn get_file_stat(&self, file_path: &str) -> Result<FileStat, Error> {
        let response: ApiResponse<FileStat> =
            self.get(&format!("/file/stat/{}", file_path)).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_file_stat request: {:?}",
                response
            ))),
        }
    }

    /// Search for files by name under a folder.
    ///
    /// Returns the same shape as [`ApiV4Client::list_files`], so paging works
    /// identically — carry `pagination.next_token` into the next call.
    pub async fn search_files(
        &self,
        request: &SearchFilesRequest<'_>,
    ) -> Result<ListResponse, Error> {
        let uri = search_uri(request.path, request.keyword, request.case_folding);
        self.list_files(&ListFilesRequest {
            path: &uri,
            page: request.page,
            page_size: request.page_size,
            order_by: None,
            order_direction: None,
            next_page_token: request.next_page_token,
        })
        .await
    }

    /// Move any number of files or folders to a destination directory.
    ///
    /// Like [`ApiV4Client::delete_files`], the endpoint is inherently batched:
    /// a partial failure comes back as [`Error::Aggregate`] keyed by source
    /// URI, so callers can tell which items moved without re-probing.
    pub async fn move_file(&self, request: &MoveFileRequest<'_>) -> Result<(), Error> {
        let response: ApiResponse<serde_json::Value> = self.post("/file/move", request).await?;
        match response.code {
            0 => Ok(()),
            _ => Err(response.into_error()),
        }
    }

    /// Copy any number of files or folders to a destination directory.
    ///
    /// Reports partial failures the same way [`ApiV4Client::move_file`] does.
    pub async fn copy_file(&self, request: &CopyFileRequest<'_>) -> Result<(), Error> {
        // V4 API uses /file/move endpoint with copy=true for copy operations
        let move_request = MoveFileRequest {
            uris: request.uris.clone(),
            dst: request.dst,
            copy: Some(true),
        };
        self.move_file(&move_request).await
    }

    pub async fn rename_file(
        &self,
        request: &RenameFileRequest<'_>,
    ) -> Result<crate::api::v4::models::File, Error> {
        let response: ApiResponse<crate::api::v4::models::File> =
            self.post("/file/rename", request).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for rename_file request: {:?}",
                response
            ))),
        }
    }

    pub async fn delete_file(&self, file_path: &str) -> Result<(), Error> {
        let request = DeleteFileRequest {
            uris: vec![file_path],
            unlink: None,
            skip_soft_delete: None,
        };
        self.delete_files(&request).await
    }

    /// Delete any number of files or folders in a single request.
    ///
    /// The endpoint takes a list, so deleting N items costs one round trip
    /// rather than N. Failures keep their structure instead of collapsing into
    /// a bare code:
    ///
    /// - a partial failure returns [`Error::Aggregate`], keyed by the URI that
    ///   was sent, with each entry's own business code — every URI absent from
    ///   that map was deleted;
    /// - a lock conflict returns [`Error::ApiWithData`] holding the unlock
    ///   tokens, which [`ApiV4Client::unlock_files`] can then release.
    pub async fn delete_files(&self, request: &DeleteFileRequest<'_>) -> Result<(), Error> {
        let uris = paths_to_uris(&request.uris);
        let converted = DeleteFileRequest {
            uris: uris.iter().map(|s| s.as_str()).collect(),
            unlink: request.unlink,
            skip_soft_delete: request.skip_soft_delete,
        };
        let response: ApiResponse<serde_json::Value> =
            self.delete_with_body("/file", &converted).await?;
        match response.code {
            0 => Ok(()),
            _ => Err(response.into_error()),
        }
    }

    /// Release locks using the tokens from a 40073 conflict response.
    ///
    /// This is how a client force-unlocks files it does not itself hold locks
    /// on — the server hands out one token per conflicting file, and they are
    /// surrendered together. To unlock by path instead, use
    /// [`ApiV4Client::force_unlock`].
    pub async fn unlock_files(&self, request: &UnlockFilesRequest<'_>) -> Result<(), Error> {
        if request.tokens.is_empty() {
            return Ok(());
        }
        let response: ApiResponse<serde_json::Value> =
            self.delete_with_body("/file/lock", request).await?;
        match response.code {
            0 => Ok(()),
            _ => Err(response.into_error()),
        }
    }

    pub async fn create_directory(&self, path: &str) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let request = CreateFileRequest {
            uri: &uri,
            r#type: CreateFileType::Folder,
            metadata: None,
            err_on_conflict: None,
        };
        // Success is carried by `code` alone. Going through `create_file` would
        // additionally demand the created folder in `data`, turning a body-less
        // success into a spurious failure.
        let response: ApiResponse<serde_json::Value> = self.post("/file/create", &request).await?;
        match response.code {
            0 => Ok(()),
            _ => Err(response.into_error()),
        }
    }

    pub async fn set_file_permission(
        &self,
        request: &SetFilePermissionRequest<'_>,
    ) -> Result<(), Error> {
        let response: ApiResponse<()> = self.post("/file/permission", request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn delete_file_permission(&self, path: &str) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let response: ApiResponse<()> = self
            .delete(&format!("/file/permission?uri={}", uri))
            .await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn create_upload_session(
        &self,
        request: &CreateUploadSessionRequest<'_>,
    ) -> Result<UploadSessionResponse, Error> {
        let response: ApiResponse<UploadSessionResponse> =
            self.put("/file/upload", request).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for create_upload_session request: {:?}",
                response
            ))),
        }
    }

    pub async fn upload_file_chunk(
        &self,
        session_id: &str,
        index: u32,
        chunk_data: &[u8],
    ) -> Result<(), Error> {
        let url = format!("/file/upload/{}/{}", session_id, index);
        let full_url = self.get_url(&url);

        let mut request = self.http_client.post(&full_url).body(chunk_data.to_vec());

        if let Some(token) = &self.token {
            request = request.bearer_auth(token);
        }

        let response = request.send().await?;
        let status = response.status();

        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(Error::Api {
                code: status.as_u16() as i32,
                message: error_text,
            });
        }

        Ok(())
    }

    pub async fn delete_upload_session(&self, path: &str, session_id: &str) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let request = DeleteUploadSessionRequest {
            id: session_id,
            uri: &uri,
        };
        let url = self.get_url("/file/upload");

        let body = serde_json::to_string(&request)?;

        let mut http_req = self.http_client.delete(&url);
        if let Some(token) = &self.token {
            http_req = http_req.bearer_auth(token);
        }

        let response = http_req
            .header("Content-Type", "application/json")
            .body(body)
            .send()
            .await?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response
                .text()
                .await
                .unwrap_or_else(|_| "Unknown error".to_string());
            return Err(Error::Api {
                code: status.as_u16() as i32,
                message: error_text,
            });
        }

        Ok(())
    }

    pub async fn get_thumbnail_url(
        &self,
        path: &str,
        width: Option<u32>,
        height: Option<u32>,
    ) -> Result<String, Error> {
        let uri = path_to_uri(path);
        let mut url = format!("/file/thumb?uri={}", uri);
        if let Some(w) = width {
            url.push_str(&format!("&width={}", w));
        }
        if let Some(h) = height {
            url.push_str(&format!("&height={}", h));
        }

        let response: ApiResponse<String> = self.get(&url).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_thumbnail_url request: {:?}",
                response
            ))),
        }
    }

    pub async fn get_file_content(&self, path: &str) -> Result<String, Error> {
        let uri = path_to_uri(path);
        let response: ApiResponse<String> = self.get(&format!("/file/content?uri={}", uri)).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_file_content request: {:?}",
                response
            ))),
        }
    }

    pub async fn update_file_content(
        &self,
        request: &UpdateFileContentRequest<'_>,
    ) -> Result<(), Error> {
        let response: ApiResponse<()> = self.put("/file/content", request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn create_viewer_session(
        &self,
        request: &CreateViewerSessionRequest<'_>,
    ) -> Result<ViewerSessionResponse, Error> {
        let response: ApiResponse<ViewerSessionResponse> =
            self.put("/file/viewerSession", request).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for create_viewer_session request: {:?}",
                response
            ))),
        }
    }

    /// Create an empty file or a folder at `request.uri`.
    pub async fn create_file(&self, request: &CreateFileRequest<'_>) -> Result<File, Error> {
        let uri = path_to_uri(request.uri);
        let converted = CreateFileRequest {
            uri: &uri,
            r#type: request.r#type,
            metadata: request.metadata.clone(),
            err_on_conflict: request.err_on_conflict,
        };
        let response: ApiResponse<File> = self.post("/file/create", &converted).await?;
        if response.code != 0 {
            return Err(Error::Api {
                code: response.code,
                message: response.msg,
            });
        }
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for create_file request: {:?}",
                response
            ))),
        }
    }

    pub async fn rename_multiple(&self, request: &RenameMultipleRequest<'_>) -> Result<(), Error> {
        let response: ApiResponse<()> = self.post("/file/rename", request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    /// Move or copy files, depending on `request.copy`.
    ///
    /// The endpoint expects `uris`/`dst`, so this maps `from`/`to` onto
    /// [`MoveFileRequest`] rather than serializing them directly — sending the
    /// request's own field names would be rejected as a missing `uris`.
    pub async fn move_copy_files(&self, request: &MoveCopyFileRequest<'_>) -> Result<(), Error> {
        let move_request = MoveFileRequest {
            uris: request.from.clone(),
            dst: request.to,
            copy: request.copy,
        };
        self.move_file(&move_request).await
    }

    pub async fn create_download_url(
        &self,
        request: &CreateDownloadUrlRequest<'_>,
    ) -> Result<DownloadUrlResponse, Error> {
        let uris = paths_to_uris(&request.uris);
        let uris_refs: Vec<&str> = uris.iter().map(|s| s.as_str()).collect();

        let converted_request = CreateDownloadUrlRequest {
            uris: uris_refs,
            download: request.download,
            redirect: request.redirect,
            entity: request.entity,
            use_primary_site_url: request.use_primary_site_url,
            skip_error: request.skip_error,
            archive: request.archive,
            no_cache: request.no_cache,
        };

        let response: ApiResponse<DownloadUrlResponse> =
            self.post("/file/url", &converted_request).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for create_download_url request: {:?}",
                response
            ))),
        }
    }

    pub async fn restore_from_trash(&self, request: &RestoreFileRequest<'_>) -> Result<(), Error> {
        let uris = paths_to_uris(&request.uris);
        let uris_refs: Vec<&str> = uris.iter().map(|s| s.as_str()).collect();

        let converted_request = RestoreFileRequest { uris: uris_refs };

        let response: ApiResponse<()> = self.post("/file/restore", &converted_request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn force_unlock(&self, path: &str) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let response: ApiResponse<()> = self.delete(&format!("/file/lock?uri={}", uri)).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn patch_metadata(
        &self,
        path: &str,
        request: &UpdateMetadataRequest,
    ) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let full_url = format!("/file/metadata?uri={}", uri);
        let response: ApiResponse<()> = self.patch(&full_url, request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn mount_storage_policy(
        &self,
        path: &str,
        request: &MountStoragePolicyRequest,
    ) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let full_url = format!("/file/policy?uri={}", uri);
        let response: ApiResponse<()> = self.patch(&full_url, request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn update_view_settings(
        &self,
        path: &str,
        request: &UpdateViewRequest,
    ) -> Result<(), Error> {
        let uri = path_to_uri(path);
        let full_url = format!("/file/view?uri={}", uri);
        let response: ApiResponse<()> = self.patch(&full_url, request).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }

    pub async fn get_file_activities(
        &self,
        path: &str,
        page: Option<u32>,
        page_size: Option<u32>,
    ) -> Result<FileActivitiesResponse, Error> {
        let uri = path_to_uri(path);
        let mut url = format!("/file/activities?uri={}", uri);
        if let Some(p) = page {
            url.push_str(&format!("&page={}", p));
        }
        if let Some(ps) = page_size {
            url.push_str(&format!("&page_size={}", ps));
        }

        let response: ApiResponse<FileActivitiesResponse> = self.get(&url).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_file_activities request: {:?}",
                response
            ))),
        }
    }

    pub async fn get_file_info_extended(
        &self,
        request: &GetFileInfoRequest<'_>,
    ) -> Result<File, Error> {
        let uri = path_to_uri(request.uri);
        let mut url = format!("/file/info?uri={}", uri);
        if let Some(include_extended) = request.include_extended_info {
            url.push_str(&format!("&extended={}", include_extended));
        }

        let response: ApiResponse<File> = self.get(&url).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_file_info_extended request: {:?}",
                response
            ))),
        }
    }

    pub async fn get_archive_list(
        &self,
        request: &GetArchiveListRequest<'_>,
    ) -> Result<ArchiveListResponse, Error> {
        let uri = path_to_uri(request.uri);
        let url = format!("/file/archive?uri={}", uri);

        let response: ApiResponse<ArchiveListResponse> = self.get(&url).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for get_archive_list request: {:?}",
                response
            ))),
        }
    }

    /// Create direct links for files
    ///
    /// Creates permanent direct links that can be used to access file content directly.
    /// Only file owners or administrators can create direct links.
    ///
    /// # Arguments
    /// * `request` - CreateDirectLinkRequest with list of file URIs
    ///
    /// # Returns
    /// Vector of DirectLinkItem containing link and file_url
    pub async fn create_direct_link(
        &self,
        request: &CreateDirectLinkRequest<'_>,
    ) -> Result<Vec<DirectLinkItem>, Error> {
        let uris = paths_to_uris(&request.uris);
        let uris_refs: Vec<&str> = uris.iter().map(|s| s.as_str()).collect();

        let converted_request = CreateDirectLinkRequest { uris: uris_refs };

        let response: ApiResponse<Vec<DirectLinkItem>> =
            self.put("/file/source", &converted_request).await?;
        match response.data {
            Some(data) => Ok(data),
            None => Err(Error::InvalidResponse(format!(
                "API returned no data for create_direct_link request: {:?}",
                response
            ))),
        }
    }

    /// Delete a direct link
    ///
    /// Only file owners can delete direct links.
    ///
    /// # Arguments
    /// * `id` - ID of the direct link to delete
    pub async fn delete_direct_link(&self, id: &str) -> Result<(), Error> {
        let response: ApiResponse<()> = self.delete(&format!("/file/source{}", id)).await?;
        match response.code {
            0 => Ok(()),
            code => Err(Error::Api {
                code,
                message: response.msg,
            }),
        }
    }
}