tablo-core 0.9.0

//! Renders each [`Relation`](crate::resource::Relation) of a resource on its records' detail and
//! edit pages, as the related resource's table narrowed to the record. A many-to-many relation's
//! attach and detach post to the owner's routes, which `actions::link` serves.

use std::sync::Arc;

use toasty::stmt::Expr;
use topcoat::{
    context::Cx,
    icon::icon,
    router::path_param_segment,
    view::{BoxView, ViewExt, view},
};

use super::{
    bar::ActionBar,
    gate::enforce_tenant,
    list::{choose_columns, declared_chrome, load_scoped_page, table_error_view, wire_table},
    state::current,
};
use crate::{
    Color,
    navigation::runtime_link,
    panel::{
        list::TableAction,
        url::{
            RETURN_PARAM, action_options_url, bulk_action_url, create_page_url, relation_url,
            with_return,
        },
    },
    policy::Ability,
    resource::{InputSpec, Links, Mounted, Relation, RelationKind, Resource, Trashed, mounted},
    topcoat_compat::async_page,
};

/// The action a many-to-many relation's table links a record with, from its header.
pub(crate) const ATTACH: &str = "attach";

/// The action a many-to-many relation's table unlinks records with, from a row or the bulk bar.
pub(crate) const DETACH: &str = "detach";

/// A registered resource as the child of other resources' relations.
pub(crate) struct Child {
    pub(crate) slug: String,
    pub(crate) label: crate::Text,
    pub(crate) plural_label: crate::Text,
    /// Renders the child's table narrowed to one owner.
    pub(crate) render: for<'a> fn(&'a Cx, BoundRelation) -> BoxView<'a>,
    /// Whether the request may list the child: [`can_list`](crate::can_list).
    pub(crate) listable: fn(&Cx) -> bool,
    /// The fields of the child [`field_access`](crate::ResourceDef::field_access) hides from the
    /// request; `None` when the panel does not mount it.
    pub(crate) hidden: fn(&Cx) -> Option<Vec<String>>,
    /// The child's form as a `has_one` relation's.
    pub(crate) form: super::forms::ChildForm,
}

/// A relation resolved against one owner record.
pub(crate) struct BoundRelation {
    /// The child's slug: the prefix of the table's URL parameters.
    pub(crate) key: String,
    /// The section title.
    pub(crate) label: crate::Text,
    /// The child's rows that belong to the owner.
    pub(crate) scope: Expr<bool>,
    /// The child's form key for the owner, and the owner's value for it, which a create from the
    /// table seeds; `None` for a many-to-many relation, whose new child would link nothing.
    pub(crate) seed: Option<(String, String)>,
    /// Whether the owner takes new children: not while it is trashed.
    pub(crate) creates: bool,
    /// Where a many-to-many relation's table attaches and detaches, when the user may.
    pub(crate) linking: Option<Linking>,
    /// The path of the record's page that renders the table: its detail or its edit page.
    pub(crate) page: String,
}

/// A many-to-many relation's writes, as its table posts them.
pub(crate) struct Linking {
    /// The relation's routes: `{list}/{key}/-/relations/{slug}`.
    pub(crate) url: String,
    /// The attach dialog's input.
    pub(crate) input: InputSpec,
}

/// Renders the relation tables of `resource`'s record `owner`, but its tabs.
pub(crate) fn render_relations<'a, R: Resource>(
    cx: &'a Cx,
    resource: &Mounted<R>,
    owner: &R::Model,
) -> Vec<BoxView<'a>> {
    resource
        .relations
        .iter()
        .filter(|relation| !relation.tab)
        .filter_map(|relation| render_relation(cx, resource, owner, relation))
        .collect()
}

/// The [`tab`](crate::Relation::tab) of `resource` whose related slug is `slug`, and its related
/// resource as the panel registered it.
pub(crate) fn relation_tab<'r, R: Resource>(
    cx: &'r Cx,
    resource: &'r Mounted<R>,
    slug: &str,
) -> Option<(&'r Relation<R::Model>, &'r Child)> {
    let panel = current(cx)?;
    resource.relations.iter().find_map(|relation| {
        let child = panel.children.get(&relation.child)?;
        (relation.tab && child.slug == slug).then_some((relation, child))
    })
}

/// Renders `relation`'s table of `resource`'s record `owner`, or nothing for a `has_one` relation,
/// whose form edits on the edit page.
pub(crate) fn render_relation<'a, R: Resource>(
    cx: &'a Cx,
    resource: &Mounted<R>,
    owner: &R::Model,
    relation: &Relation<R::Model>,
) -> Option<BoxView<'a>> {
    let panel = current(cx)?;
    let child = panel.children.get(&relation.child)?;
    let page = topcoat::router::request::uri(cx).path().to_string();
    // A trashed owner takes no writes: every write loads it among the live records.
    let live = !resource.is_trashed(owner);
    let (scope, value) = relation.bind(owner);
    let (seed, linking) = match &relation.kind {
        RelationKind::HasMany { foreign_key } => (Some((foreign_key.clone(), value)), None),
        // Its form edits the record's one child on the edit page.
        RelationKind::HasOne { .. } => return None,
        // Linking writes the owner's relations, which its edit asks `Update` for; a composite key
        // has no URL to post under.
        RelationKind::ManyToMany(Links { input, .. }) => (
            None,
            (live
                && resource.table.is_addressable()
                && resource.can(cx, Ability::View(owner))
                && resource.can(cx, Ability::Update(owner)))
            .then(|| Linking {
                url: relation_url(&resource.url, &resource.table.key_of(owner), &child.slug),
                input: *input,
            }),
        ),
    };
    Some((child.render)(
        cx,
        BoundRelation {
            key: child.slug.clone(),
            label: relation
                .label
                .clone()
                .unwrap_or_else(|| child.plural_label.clone()),
            scope,
            seed,
            creates: live,
            linking,
            page,
        },
    ))
}

/// The many-to-many relation of `resource` the `{relation}` path segment names, by its related
/// resource's slug.
pub(crate) fn linked_relation<'r, R: Resource>(
    cx: &Cx,
    resource: &'r Mounted<R>,
) -> Option<&'r Links<R::Model>> {
    let panel = current(cx)?;
    let slug = path_param_segment(cx, "relation");
    resource.relations.iter().find_map(|relation| {
        let child = panel.children.get(&relation.child)?;
        (child.slug == slug).then_some(())?;
        relation.links()
    })
}

/// Renders one relation's section as `C`'s list table over the rows the owner holds.
///
/// The table's parameters carry the child's slug, so each relation on the page keeps its own
/// state, and a change reruns the page in place.
pub(crate) fn relation_table<C: Resource>(cx: &Cx, relation: BoundRelation) -> BoxView<'_> {
    async_page(async move {
        let Some(resource) = mounted::<C>(cx) else {
            return Ok(().boxed());
        };
        if enforce_tenant(cx, &resource).is_err() || !resource.can(cx, Ability::ViewAny) {
            return Ok(().boxed());
        }
        let BoundRelation {
            key,
            label,
            scope,
            seed,
            creates,
            linking,
            page,
        } = relation;
        let mut chrome = declared_chrome(cx, &resource);
        // A table wires its custom actions under one route; a many-to-many relation's posts
        // Detach to the owner's, so it wires none of the related resource's own.
        chrome.actions = seed.is_some();
        let mut table = choose_columns(
            cx,
            &resource,
            wire_table(cx, &resource, chrome).prefixed(&key),
        )
        .await;
        if let Some(linking) = &linking {
            table =
                table.with_custom_actions(linking.url.clone(), vec![detach_action(cx, &resource)]);
        }
        let (signals, state) = table.browser_state(cx);
        let back = state.list_url(&page);
        let table = table
            .taking(resource.list_trashed(&state))
            .returning_to(back.clone());
        let create_url = seed
            .filter(|_| creates && resource.pages.create && resource.can_create(cx))
            .map(|(column, value)| {
                let query = form_urlencoded::Serializer::new(String::new())
                    .append_pair(&column, &value)
                    .append_pair(RETURN_PARAM, &back)
                    .finish();
                format!("{}?{query}", create_page_url(&resource.url))
            });
        let attach = linking.map(|linking| {
            ActionBar::input(
                crate::t!(
                    cx,
                    "tablo-relation-attach-title",
                    label = resource.label.clone()
                ),
                with_return(&bulk_action_url(&linking.url, ATTACH), &back),
                linking.input,
                action_options_url(&linking.url, ATTACH),
            )
        });
        let body = match load_scoped_page(cx, &resource, &table, &state, scope).await {
            Ok(rows) => table.render_page(cx, rows, &state, &page, &signals).await?,
            Err(error) => table_error_view(
                cx,
                &resource.slug,
                &resource.plural_label,
                &state,
                &error,
                &page,
            ),
        };
        Ok(relation_section(
            cx,
            key,
            label,
            &resource.label,
            create_url,
            attach.map(|bar| bar.render(cx)),
            body,
        ))
    })
}

/// The row and bulk Detach of a many-to-many relation's table over `C`, on every row the user may
/// view.
fn detach_action<C: Resource>(cx: &Cx, resource: &Arc<Mounted<C>>) -> TableAction<C::Model> {
    let (policy_cx, policy) = (cx.clone(), Arc::clone(resource));
    let label = crate::t!(cx, "tablo-relation-detach");
    TableAction {
        name: DETACH,
        label: label.clone(),
        row: true,
        bulk: true,
        confirm: false,
        prompt: String::new(),
        bulk_prompt: String::new(),
        icon: None,
        record_face: Arc::new(move |_| (label.clone(), None)),
        tooltip: None,
        color: Color::Gray,
        input: None,
        trashed: Trashed::With,
        allowed: Arc::new(move |record: &C::Model| policy.can(&policy_cx, Ability::View(record))),
        disabled: Arc::new(|_| None),
    }
}

/// Renders a relation section titled `label` around its table `body`, with a link to create a
/// child, labeled after `child_label`, at `create_url`, and the `attach` button.
fn relation_section<'a>(
    cx: &'a Cx,
    key: String,
    label: crate::Text,
    child_label: &crate::Text,
    create_url: Option<String>,
    attach: Option<BoxView<'a>>,
    body: BoxView<'a>,
) -> BoxView<'a> {
    let create_label = crate::t!(cx, "tablo-relation-new", label = child_label);
    view! {
        <section class="flex flex-col gap-3" data-relation=(key)>
            <div class="flex items-center justify-between gap-4">
                <h2 class="text-lg font-semibold tracking-tight text-foreground">
                    (label)
                </h2>
                <div class="flex items-center gap-2">
                    if let Some(attach) = attach {
                        (attach)
                    }
                    if let Some(url) = create_url {
                        <a
                            (runtime_link(cx, &url))
                            class=(tablo_ui::button_variants(
                                tablo_ui::ButtonVariant::Outline,
                                tablo_ui::ButtonSize::Sm,
                            ))
                        >
                            icon(data: tablo_ui::icons::PLUS)
                            (create_label)
                        </a>
                    }
                </div>
            </div>
            (body)
        </section>
    }
    .boxed()
}