pptx_edit/

save.rs

//! Baseline-diff write-back: the live CRDT state is compared against a
//! freshly seeded copy of the source package and only differences are written.

use std::collections::HashMap;

use ooxml_drawingml::{ColorValue, ShapeFill};
use pptx_parse::{
    Bullet, CommentAuthorWrite, CommentFlavor, CommentSlide, CommentWrite, CommentsWrite,
    DeckWrite, InheritedTransform, NotesWrite, ParagraphWrite, Placeholder, PptxPackage,
    RunProperties, RunWrite, ShapeAdd, ShapeNode, ShapePatch, ShapeTransform, ShapeWrite,
    SlideLayout, SlideMaster, SlideWrite, TextTarget, TextWrite,
};

use crate::comments::{derived_guid, seeded_comment_id};
use crate::deck::{seed_doc, snapshot_doc};
use crate::{
    BOOTSTRAP_CLIENT_ID, CommentSnapshot, DeckSession, DeckSnapshot, EditError, EditResult,
    ParagraphSnapshot, ShapeKind, ShapeSnapshot, SlideSnapshot, StorySnapshot, TextRunSnapshot,
    doc_with_client_id,
};

/// Source shapes and inherited geometry.
struct SlideContext<'a> {
    layout: Option<&'a SlideLayout>,
    master: Option<&'a SlideMaster>,
    source_shapes: &'a [ShapeNode],
}

impl<'a> SlideContext<'a> {
    fn new(package: &'a PptxPackage, snapshot: &SlideSnapshot) -> Self {
        let source_shapes = snapshot
            .source_part_path
            .as_deref()
            .and_then(|path| package.slides.iter().find(|slide| slide.part_path == path))
            .map(|slide| slide.shapes.as_slice())
            .unwrap_or_default();
        let layout = snapshot
            .layout_part_path
            .as_deref()
            .and_then(|path| {
                package
                    .layouts
                    .iter()
                    .find(|layout| layout.part_path == path)
            })
            .or_else(|| package.layouts.first());
        let master = layout
            .and_then(|layout| layout.master_part_path.as_deref())
            .and_then(|path| {
                package
                    .masters
                    .iter()
                    .find(|master| master.part_path == path)
            })
            .or_else(|| {
                layout.and_then(|layout| {
                    package.masters.iter().find(|master| {
                        master
                            .layout_part_paths
                            .iter()
                            .any(|path| path == &layout.part_path)
                    })
                })
            })
            .or_else(|| package.masters.first());
        Self {
            layout,
            master,
            source_shapes,
        }
    }
}

impl DeckSession {
    /// Serializes the deck with all edits applied. Untouched slides keep their
    /// exact source part bytes; edited slides are patched at the XML level.
    pub fn save(&self) -> EditResult<Vec<u8>> {
        if !self.package.has_parts() {
            return Err(EditError::Write(
                "this session carries no source file bytes; open it from the \
                 file, or from the update plus the source file, to save"
                    .to_owned(),
            ));
        }
        let current = self.snapshot()?;
        let baseline = baseline_snapshot(&self.package)?;
        if current == baseline {
            return pptx_parse::write_pptx(&self.package)
                .map_err(|error| EditError::Write(error.to_string()));
        }
        let deck = deck_write(&current, &baseline, &self.package)?;
        pptx_parse::write_pptx_with_edits(&self.package, &deck)
            .map_err(|error| EditError::Write(error.to_string()))
    }
}

fn baseline_snapshot(package: &PptxPackage) -> EditResult<DeckSnapshot> {
    let doc = doc_with_client_id(BOOTSTRAP_CLIENT_ID);
    seed_doc(&doc, package, "")?;
    snapshot_doc(&doc, package)
}

fn deck_write(
    current: &DeckSnapshot,
    baseline: &DeckSnapshot,
    package: &PptxPackage,
) -> EditResult<DeckWrite> {
    let baseline_slides: HashMap<&str, &SlideSnapshot> = baseline
        .slides
        .iter()
        .map(|slide| (slide.id.as_str(), slide))
        .collect();
    let mut slides = Vec::with_capacity(current.slides.len());
    for slide in &current.slides {
        let write = match baseline_slides.get(slide.id.as_str()) {
            Some(base) if *base == slide => SlideWrite::Keep {
                part_path: source_part_path(slide)?,
            },
            Some(base) => SlideWrite::Patch {
                part_path: source_part_path(slide)?,
                shapes: {
                    let context = SlideContext::new(package, slide);
                    shape_writes(&slide.shapes, &base.shapes, &context, context.source_shapes)?
                },
            },
            None => SlideWrite::Add {
                name: slide.name.clone(),
                layout_part_path: slide.layout_part_path.clone(),
                shapes: slide
                    .shapes
                    .iter()
                    .map(shape_add)
                    .collect::<EditResult<Vec<_>>>()?,
            },
        };
        slides.push(write);
    }
    Ok(DeckWrite {
        slides,
        comments: comments_write(current, baseline, package),
        notes: notes_write(current, baseline),
    })
}

fn notes_write(current: &DeckSnapshot, baseline: &DeckSnapshot) -> Option<NotesWrite> {
    let baseline_notes: HashMap<&str, &str> = baseline
        .slides
        .iter()
        .map(|slide| (slide.id.as_str(), slide.notes.as_str()))
        .collect();
    let mut per_slide = Vec::new();
    for (index, slide) in current.slides.iter().enumerate() {
        let changed = baseline_notes
            .get(slide.id.as_str())
            .is_none_or(|base| *base != slide.notes.as_str());
        if !changed {
            continue;
        }
        let target = match slide.source_part_path.clone() {
            Some(part_path) => CommentSlide::Existing(part_path),
            None => CommentSlide::Added(index),
        };
        per_slide.push((target, slide.notes.clone()));
    }
    (!per_slide.is_empty()).then_some(NotesWrite { per_slide })
}

fn comments_write(
    current: &DeckSnapshot,
    baseline: &DeckSnapshot,
    package: &PptxPackage,
) -> Option<CommentsWrite> {
    if current.comments == baseline.comments && current.comment_flavor == baseline.comment_flavor {
        return None;
    }
    let baseline_live: Vec<&CommentSnapshot> = baseline
        .comments
        .iter()
        .filter(|comment| {
            current
                .slides
                .iter()
                .any(|slide| slide.id == comment.slide_id)
        })
        .collect();
    if !current.comments.is_empty()
        && current.comments.len() < baseline.comments.len()
        && current.comment_flavor == baseline.comment_flavor
        && current.comments.iter().eq(baseline_live)
    {
        return None;
    }
    let flavor = current.comment_flavor;
    let live: Vec<&CommentSnapshot> = current
        .comments
        .iter()
        .filter(|comment| {
            current
                .slides
                .iter()
                .any(|slide| slide.id == comment.slide_id)
        })
        .collect();

    let source: HashMap<_, _> = package
        .comments
        .iter()
        .enumerate()
        .filter(|(_, comment)| comment.flavor == flavor)
        .map(|(index, comment)| (seeded_comment_id(index, &comment.id), comment))
        .collect();
    let mut authors: Vec<CommentAuthorWrite> = if live.is_empty() || source.is_empty() {
        Vec::new()
    } else {
        package
            .comment_authors
            .iter()
            .map(|author| CommentAuthorWrite {
                id: author.id.clone(),
                name: author.name.clone(),
                initials: author.initials.clone(),
                last_index: author.last_index.unwrap_or_default(),
                color_index: author.color_index.unwrap_or_default(),
                user_id: author.user_id.clone(),
                provider_id: author.provider_id.clone(),
            })
            .collect()
    };
    let mut per_slide: Vec<(CommentSlide, Vec<CommentWrite>)> = current
        .slides
        .iter()
        .enumerate()
        .map(|(index, slide)| {
            let target = match slide.source_part_path.clone() {
                Some(part_path) => CommentSlide::Existing(part_path),
                None => CommentSlide::Added(index),
            };
            (target, Vec::new())
        })
        .collect();

    for comment in live.iter().filter(|comment| comment.parent_id.is_none()) {
        let Some(index) = current
            .slides
            .iter()
            .position(|slide| slide.id == comment.slide_id)
        else {
            continue;
        };
        let mut write = preserved_comment(&mut authors, flavor, comment, &source);
        if flavor == CommentFlavor::Modern {
            for reply in live
                .iter()
                .filter(|reply| reply.parent_id.as_deref() == Some(comment.id.as_str()))
            {
                write
                    .replies
                    .push(preserved_comment(&mut authors, flavor, reply, &source));
            }
        }
        if let Some((_, slide_comments)) = per_slide.get_mut(index) {
            slide_comments.push(write);
        }
    }

    Some(CommentsWrite {
        flavor,
        authors,
        per_slide: per_slide
            .into_iter()
            .enumerate()
            .filter_map(|(index, entry)| {
                let slide_id = &current.slides[index].id;
                let unchanged = flavor == baseline.comment_flavor
                    && current
                        .comments
                        .iter()
                        .filter(|comment| &comment.slide_id == slide_id)
                        .eq(baseline
                            .comments
                            .iter()
                            .filter(|comment| &comment.slide_id == slide_id));
                (!unchanged).then_some(entry)
            })
            .collect(),
    })
}

fn preserved_comment(
    authors: &mut Vec<CommentAuthorWrite>,
    flavor: CommentFlavor,
    comment: &CommentSnapshot,
    source: &HashMap<String, &pptx_parse::Comment>,
) -> CommentWrite {
    let Some(original) = source.get(&comment.id) else {
        for author in authors.iter_mut() {
            author.last_index = source
                .values()
                .filter(|item| item.author_id == author.id)
                .filter_map(|item| item.id.rsplit_once(':')?.1.parse::<u32>().ok())
                .fold(author.last_index, u32::max);
        }
        return charge_author(authors, flavor, comment);
    };
    let index = original
        .id
        .rsplit_once(':')
        .and_then(|(_, index)| index.parse().ok())
        .unwrap_or(0);
    let mut write = comment_write(comment, original.author_id.clone(), index);
    write.id = original.id.clone();
    if comment.resolved == (original.status.as_deref() == Some("resolved")) {
        write.status = original.status.clone();
    } else if !comment.resolved {
        write.status = Some("active".to_owned());
    }
    write
}

fn charge_author(
    authors: &mut Vec<CommentAuthorWrite>,
    flavor: CommentFlavor,
    comment: &CommentSnapshot,
) -> CommentWrite {
    let slot = match authors
        .iter()
        .position(|known| known.name == comment.author && known.initials == comment.initials)
    {
        Some(slot) => slot,
        None => {
            let slot = authors.len();
            let id = match flavor {
                CommentFlavor::Legacy => authors
                    .iter()
                    .filter_map(|author| author.id.parse::<u32>().ok())
                    .max()
                    .map_or(0, |id| id + 1)
                    .to_string(),
                CommentFlavor::Modern => {
                    derived_guid(&format!("author:{}:{}", comment.author, comment.initials))
                }
            };
            authors.push(CommentAuthorWrite {
                id,
                name: comment.author.clone(),
                initials: comment.initials.clone(),
                last_index: 0,
                color_index: slot as u32,
                user_id: None,
                provider_id: None,
            });
            slot
        }
    };
    authors[slot].last_index += 1;
    comment_write(comment, authors[slot].id.clone(), authors[slot].last_index)
}

fn comment_write(comment: &CommentSnapshot, author_id: String, index: u32) -> CommentWrite {
    CommentWrite {
        id: derived_guid(&comment.id),
        author_id,
        index,
        text: comment.text.clone(),
        created: comment.created.clone(),
        x_emu: comment.x_emu,
        y_emu: comment.y_emu,
        status: comment.resolved.then(|| "resolved".to_owned()),
        replies: Vec::new(),
    }
}

fn source_part_path(slide: &SlideSnapshot) -> EditResult<String> {
    slide
        .source_part_path
        .clone()
        .ok_or_else(|| EditError::Write(format!("slide {} has no source part", slide.id)))
}

fn shape_writes(
    current: &[ShapeSnapshot],
    baseline: &[ShapeSnapshot],
    context: &SlideContext<'_>,
    source: &[ShapeNode],
) -> EditResult<Vec<ShapeWrite>> {
    let baseline_shapes: HashMap<&str, &ShapeSnapshot> = baseline
        .iter()
        .map(|shape| (shape.id.as_str(), shape))
        .collect();
    let mut writes = Vec::with_capacity(current.len());
    for shape in current {
        let write = match baseline_shapes.get(shape.id.as_str()) {
            Some(base) if *base == shape => ShapeWrite::Keep {
                source_index: addressed_source_index(shape, source)?,
            },
            Some(base) => {
                let index = addressed_source_index(shape, source)?;
                ShapeWrite::Patch {
                    source_index: index,
                    patch: Box::new(shape_patch(
                        shape,
                        base,
                        context,
                        group_children(source, index),
                    )?),
                }
            }
            None => ShapeWrite::Add(Box::new(shape_add(shape)?)),
        };
        writes.push(write);
    }
    Ok(writes)
}

/// Checks the source identity before resolving an ordinal.
fn addressed_source_index(shape: &ShapeSnapshot, source: &[ShapeNode]) -> EditResult<usize> {
    let index = source_index(&shape.id)?;
    match source.get(index) {
        Some(node) if node.id() == shape.source_id => Ok(index),
        _ => Err(EditError::Write(format!(
            "shape {} no longer addresses source shape {}: this update was seeded by a \
             different parse of the file and has to be re-seeded from it",
            shape.id, shape.source_id
        ))),
    }
}

fn group_children(source: &[ShapeNode], index: usize) -> &[ShapeNode] {
    match source.get(index) {
        Some(ShapeNode::Group(group)) => &group.children,
        _ => &[],
    }
}

fn source_index(shape_id: &str) -> EditResult<usize> {
    shape_id
        .rfind(":shape:")
        .map(|position| &shape_id[position + ":shape:".len()..])
        .and_then(|path| path.rsplit('.').next())
        .and_then(|segment| segment.parse().ok())
        .ok_or_else(|| EditError::Write(format!("shape {shape_id} has no source index")))
}

fn shape_patch(
    shape: &ShapeSnapshot,
    base: &ShapeSnapshot,
    context: &SlideContext<'_>,
    source_children: &[ShapeNode],
) -> EditResult<ShapePatch> {
    let mut patch = ShapePatch::default();
    let moved = (shape.x, shape.y) != (base.x, base.y);
    let resized = (shape.width, shape.height) != (base.width, base.height);
    if moved || resized {
        patch.offset = moved.then_some((shape.x, shape.y));
        patch.extent = resized.then_some((shape.width, shape.height));
        let source_inherited = base.width <= 0 || base.height <= 0;
        patch.inherited = source_inherited.then(|| {
            inherited_transform(shape, context)
                .map(|transform| InheritedTransform {
                    x: transform.x,
                    y: transform.y,
                    width: transform.width,
                    height: transform.height,
                    rotation_deg: transform.rotation_deg,
                    flip_horizontal: transform.flip_h,
                    flip_vertical: transform.flip_v,
                })
                .unwrap_or(InheritedTransform {
                    x: shape.x,
                    y: shape.y,
                    width: shape.width,
                    height: shape.height,
                    rotation_deg: shape.rotation_deg,
                    flip_horizontal: shape.flip_h,
                    flip_vertical: shape.flip_v,
                })
        });
    }
    if shape.fill != base.fill {
        patch.fill = Some(
            shape
                .fill
                .clone()
                .unwrap_or_else(|| ShapeFill::named("none")),
        );
    }
    if shape.outline != base.outline {
        patch.outline = Some(shape.outline.clone().unwrap_or_default());
    }
    if shape.adjust_values != base.adjust_values {
        patch.adjust_values = Some(shape.adjust_values.clone());
    }
    let baseline_stories: HashMap<&str, &StorySnapshot> = base
        .text_stories
        .iter()
        .map(|story| (story.id.as_str(), story))
        .collect();
    for story in &shape.text_stories {
        let base_story = baseline_stories.get(story.id.as_str()).copied();
        if base_story == Some(story) {
            continue;
        }
        patch.texts.push(TextWrite {
            target: text_target(&story.id, &shape.id)?,
            paragraphs: paragraph_writes(story, base_story)?,
        });
    }
    if shape.children != base.children {
        patch.children = shape_writes(&shape.children, &base.children, context, source_children)?;
    }
    Ok(patch)
}

/// The transform a placeholder inherits: the layout's matching placeholder,
/// then the master's. The shape's own parsed node cannot contribute — a
/// positive extent there would already be in the snapshot.
fn inherited_transform<'a>(
    shape: &ShapeSnapshot,
    context: &SlideContext<'a>,
) -> Option<&'a ShapeTransform> {
    let layout = shape.placeholder.as_ref().and_then(|placeholder| {
        context
            .layout
            .and_then(|layout| find_placeholder(&layout.shapes, placeholder))
    });
    let master = shape.placeholder.as_ref().and_then(|placeholder| {
        context
            .master
            .and_then(|master| find_placeholder(&master.shapes, placeholder))
    });
    [layout, master]
        .into_iter()
        .flatten()
        .map(node_transform)
        .find(|transform| transform.width > 0 && transform.height > 0)
}

fn find_placeholder<'a>(nodes: &'a [ShapeNode], target: &Placeholder) -> Option<&'a ShapeNode> {
    for node in nodes {
        if node_placeholder(node).is_some_and(|value| placeholders_match(value, target)) {
            return Some(node);
        }
        if let ShapeNode::Group(group) = node
            && let Some(found) = find_placeholder(&group.children, target)
        {
            return Some(found);
        }
    }
    None
}

fn placeholders_match(left: &Placeholder, right: &Placeholder) -> bool {
    match (left.index, right.index) {
        (Some(left), Some(right)) => left == right,
        _ => {
            normalize_placeholder_type(left.placeholder_type.as_deref())
                == normalize_placeholder_type(right.placeholder_type.as_deref())
        }
    }
}

fn normalize_placeholder_type(value: Option<&str>) -> &str {
    match value.unwrap_or("body") {
        "ctrTitle" => "title",
        "obj" => "body",
        value => value,
    }
}

fn node_placeholder(node: &ShapeNode) -> Option<&Placeholder> {
    node_base(node).placeholder.as_ref()
}

fn node_transform(node: &ShapeNode) -> &ShapeTransform {
    &node_base(node).transform
}

fn node_base(node: &ShapeNode) -> &pptx_parse::ShapeBase {
    match node {
        ShapeNode::Shape(shape) => &shape.base,
        ShapeNode::Picture(shape) => &shape.base,
        ShapeNode::GraphicFrame(shape) => &shape.base,
        ShapeNode::Group(shape) => &shape.base,
    }
}

fn text_target(story_id: &str, shape_id: &str) -> EditResult<TextTarget> {
    let suffix = story_id
        .strip_prefix("story:")
        .and_then(|rest| rest.strip_prefix(shape_id))
        .and_then(|rest| rest.strip_prefix(':'))
        .ok_or_else(|| EditError::Write(format!("story {story_id} does not match its shape")))?;
    if let Some(cell) = suffix.strip_prefix("table:") {
        let (row, cell) = cell
            .split_once(':')
            .and_then(|(row, cell)| Some((row.parse().ok()?, cell.parse().ok()?)))
            .ok_or_else(|| EditError::Write(format!("story {story_id} has no table address")))?;
        return Ok(TextTarget::TableCell { row, cell });
    }
    Ok(TextTarget::Body)
}

fn paragraph_writes(
    story: &StorySnapshot,
    baseline: Option<&StorySnapshot>,
) -> EditResult<Vec<ParagraphWrite>> {
    let baseline_paragraphs: HashMap<&str, &ParagraphSnapshot> = baseline
        .into_iter()
        .flat_map(|story| &story.paragraphs)
        .map(|paragraph| (paragraph.id.as_str(), paragraph))
        .collect();
    let prefix = format!("para:{}:", story.id);
    let mut writes = Vec::with_capacity(story.paragraphs.len());
    for paragraph in &story.paragraphs {
        let source_index = paragraph
            .id
            .strip_prefix(&prefix)
            .and_then(|index| index.parse::<usize>().ok());
        let base = baseline_paragraphs.get(paragraph.id.as_str()).copied();
        if base == Some(paragraph) && source_index.is_some() {
            writes.push(ParagraphWrite {
                source_index,
                rebuild: false,
                properties_changed: false,
                alignment: None,
                level: 0,
                bullet: None,
                runs: Vec::new(),
            });
            continue;
        }
        let properties_changed = match base {
            Some(base) => {
                base.alignment != paragraph.alignment
                    || base.level != paragraph.level
                    || base.bullet_json != paragraph.bullet_json
            }
            None => true,
        };
        let bullet = paragraph
            .bullet_json
            .as_deref()
            .map(serde_json::from_str::<Bullet>)
            .transpose()
            .map_err(|error| EditError::Json(error.to_string()))?;
        writes.push(ParagraphWrite {
            source_index,
            rebuild: true,
            properties_changed,
            alignment: paragraph.alignment.clone(),
            level: paragraph.level,
            bullet,
            runs: paragraph.runs.iter().map(run_write).collect(),
        });
    }
    Ok(writes)
}

fn run_write(run: &TextRunSnapshot) -> RunWrite {
    RunWrite {
        text: run.text.clone(),
        properties: RunProperties {
            font_size_pt: run.style.font_size_pt,
            spacing_pt: run.style.spacing_pt,
            baseline_pct: run.style.baseline_pct,
            bold: run.style.bold,
            italic: run.style.italic,
            underline: run.style.underline.clone(),
            font_family: run.style.font_family.clone(),
            color: run.style.color.as_deref().map(color_from_hex),
            language: None,
            hyperlink_relationship_id: None,
        },
    }
}

fn color_from_hex(color: &str) -> ColorValue {
    ColorValue {
        rgb: Some(
            color
                .strip_prefix('#')
                .unwrap_or(color)
                .to_ascii_uppercase(),
        ),
        ..ColorValue::default()
    }
}

fn shape_add(shape: &ShapeSnapshot) -> EditResult<ShapeAdd> {
    if shape.kind != ShapeKind::Shape {
        return Err(EditError::Write(format!(
            "shape {} cannot be written as a new shape",
            shape.id
        )));
    }
    let paragraphs = shape
        .text_stories
        .first()
        .map(|story| paragraph_writes(story, None))
        .transpose()?;
    Ok(ShapeAdd {
        name: shape.name.clone(),
        geometry: shape.geometry.clone(),
        x: shape.x,
        y: shape.y,
        width: shape.width,
        height: shape.height,
        adjust_values: shape.adjust_values.clone(),
        fill: shape.fill.clone(),
        outline: shape.outline.clone(),
        paragraphs,
    })
}