Skip to main content

rustango_cms/api/
documents.rs

1//! `GET /api/v2/documents/` + `GET /api/v2/documents/{id}/`.
2//!
3//! Mirrors [`crate::api::images`] for non-image media. Hosts are
4//! responsible for wiring an actual byte-serving route for documents
5//! — the API surfaces the metadata + storage_key so the host can
6//! generate signed download URLs at the application layer.
7
8// Our extractors, not axum's: they refuse a malformed value in the same
9// JSON envelope as everything else. See `query::Query`.
10use crate::api::query::{Path, Query};
11use axum::response::{IntoResponse, Response};
12use axum::Json;
13use rustango::core::Column as _;
14use rustango::extractors::{SessionUser, Tenant};
15use rustango::sql::FetcherPool as _;
16use serde::Deserialize;
17
18use super::images::{list_media, MediaFilter, MEDIA_ORDER_FIELDS};
19use super::query as q;
20use crate::media::Media;
21
22#[derive(Debug, Default, Deserialize)]
23pub struct DocumentListQuery {
24    #[serde(flatten)]
25    pub list: q::ListQuery,
26    #[serde(default, deserialize_with = "crate::api::query::empty_as_none")]
27    pub collection: Option<i64>,
28}
29
30/// `GET /api/v2/documents/`
31pub async fn list(
32    tenant: Tenant,
33    SessionUser(session_user): SessionUser,
34    rustango::tenancy::member_auth::CurrentMember(member): rustango::tenancy::member_auth::CurrentMember,
35    crate::api::auth::BearerMember(bearer): crate::api::auth::BearerMember,
36    Query(qs): Query<DocumentListQuery>,
37) -> Response {
38    let viewer = member.as_ref().or(bearer.as_ref()).or(session_user.as_ref());
39    match list_inner(&tenant, viewer, &qs).await {
40        Ok(resp) => resp,
41        Err(e) => {
42            tracing::error!(target: "rustango_cms::api", error = %e, "documents list failed");
43            crate::api::error::ApiError::internal().into_response()
44        }
45    }
46}
47
48async fn list_inner(
49    tenant: &Tenant,
50    viewer: Option<&rustango::tenancy::auth::User>,
51    qs: &DocumentListQuery,
52) -> Result<Response, rustango::sql::ExecError> {
53    let pool = tenant.pool();
54    let (limit, offset) = q::paginate(&qs.list);
55    let fields = q::field_set(&qs.list);
56    let orderings = match q::parse_order_in(&qs.list, &MEDIA_ORDER_FIELDS) {
57        Ok(v) => v,
58        Err(msg) => return Ok(crate::api::error::ApiError::bad_request(msg).into_response()),
59    };
60
61    let updated_since = match crate::api::query::parse_updated_since(&qs.list) {
62        Ok(v) => v,
63        Err(msg) => return Ok(crate::api::error::ApiError::bad_request(msg).into_response()),
64    };
65    let (window, total_count) = list_media(
66        pool,
67        viewer,
68        MediaFilter {
69            images: false,
70            collection: qs.collection,
71            search: qs.list.search.as_deref(),
72            search_alt_text: false,
73            updated_since,
74        },
75        &orderings,
76        limit,
77        offset,
78    )
79    .await?;
80
81    let mut items = Vec::with_capacity(window.len());
82    for m in &window {
83        let mut obj = serialize_document(m);
84        // Validated against the first serialized row rather than a
85        // hand-written list, so it cannot drift from what we return.
86        if let Err(msg) = q::validate_fields(fields.as_ref(), &obj) {
87            return Ok(crate::api::error::ApiError::bad_request(msg).into_response());
88        }
89        q::apply_fields(&mut obj, fields.as_ref());
90        items.push(serde_json::Value::Object(obj));
91    }
92
93    Ok(Json(q::ListEnvelope {
94        meta: q::ListMeta::paged(total_count, limit, offset),
95        items,
96    })
97    .into_response())
98}
99
100/// `GET /api/v2/documents/{id}/`
101pub async fn detail(
102    tenant: Tenant,
103    SessionUser(session_user): SessionUser,
104    rustango::tenancy::member_auth::CurrentMember(member): rustango::tenancy::member_auth::CurrentMember,
105    crate::api::auth::BearerMember(bearer): crate::api::auth::BearerMember,
106    Path(id): Path<i64>,
107    Query(q): Query<crate::api::query::DetailFields>,
108) -> Response {
109    let viewer = member.as_ref().or(bearer.as_ref()).or(session_user.as_ref());
110    match detail_inner(&tenant, viewer, id, &q).await {
111        Ok(resp) => resp,
112        Err(e) => {
113            tracing::error!(target: "rustango_cms::api", error = %e, "document detail failed");
114            crate::api::error::ApiError::internal().into_response()
115        }
116    }
117}
118
119async fn detail_inner(
120    tenant: &Tenant,
121    viewer: Option<&rustango::tenancy::auth::User>,
122    id: i64,
123    q: &crate::api::query::DetailFields,
124) -> Result<Response, rustango::sql::ExecError> {
125    let row: Option<Media> = Media::objects()
126        .where_(Media::id.eq(id))
127        .fetch(tenant.pool())
128        .await?
129        .into_iter()
130        .find(|m| m.kind != "image");
131    match row {
132        // A gated collection answers exactly as a missing asset does —
133        // otherwise this endpoint tells an anonymous caller which ids
134        // exist behind the gate.
135        Some(m) if !gated_for(tenant, viewer, &m).await => {
136            let mut obj = serialize_document(&m);
137            crate::api::query::apply_fields(&mut obj, q.keep().as_ref());
138            Ok(Json(serde_json::Value::Object(obj)).into_response())
139        }
140        _ => Ok(crate::api::error::ApiError::not_found("document").into_response()),
141    }
142}
143
144/// Is this asset's collection closed to `viewer`?
145async fn gated_for(
146    tenant: &Tenant,
147    viewer: Option<&rustango::tenancy::auth::User>,
148    media: &Media,
149) -> bool {
150    let Some(cid) = media.collection_id else {
151        return false;
152    };
153    !crate::collection_view_restriction::denied_collection_ids(tenant.pool(), viewer, &[cid])
154        .await
155        .is_empty()
156}
157
158fn serialize_document(m: &Media) -> serde_json::Map<String, serde_json::Value> {
159    let id = m.id.get().copied().unwrap_or_default();
160    let mut obj = serde_json::Map::new();
161    obj.insert("id".to_owned(), serde_json::json!(id));
162    obj.insert(
163        "meta".to_owned(),
164        serde_json::json!({
165            "type": "cms.Document",
166            "detail_url": format!("/api/v2/documents/{id}/"),
167            "storage_key": m.storage_key,
168            "content_hash": m.content_hash,
169        }),
170    );
171    obj.insert("title".to_owned(), serde_json::json!(m.title));
172    obj.insert("filename".to_owned(), serde_json::json!(m.filename));
173    obj.insert("mime".to_owned(), serde_json::json!(m.mime));
174    obj.insert("size".to_owned(), serde_json::json!(m.size));
175    obj.insert("kind".to_owned(), serde_json::json!(m.kind));
176    obj.insert(
177        "collection_id".to_owned(),
178        serde_json::json!(m.collection_id),
179    );
180    obj.insert(
181        "uploaded_at".to_owned(),
182        serde_json::json!(m.uploaded_at.get().copied()),
183    );
184    obj
185}