Anki/rslib/src/browser_rows.rs

// Copyright: Ankitects Pty Ltd and contributors
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html

use std::sync::Arc;

use itertools::Itertools;

use crate::err::{AnkiError, Result};
use crate::i18n::I18n;
use crate::{
    card::{Card, CardID, CardQueue, CardType},
    collection::Collection,
    decks::{Deck, DeckID},
    notes::Note,
    notetype::{CardTemplate, NoteType, NoteTypeKind},
    scheduler::{timespan::time_span, timing::SchedTimingToday},
    template::RenderedNode,
    text::{extract_av_tags, html_to_text_line},
    timestamp::{TimestampMillis, TimestampSecs},
};

const CARD_RENDER_COLUMNS: [&str; 2] = ["question", "answer"];

#[derive(Debug, PartialEq)]
pub struct Row {
    pub cells: Vec<Cell>,
    pub color: Color,
    pub font: Font,
}

#[derive(Debug, PartialEq)]
pub struct Cell {
    pub text: String,
    pub is_rtl: bool,
}

#[derive(Debug, PartialEq)]
pub enum Color {
    Default,
    Marked,
    Suspended,
    FlagRed,
    FlagOrange,
    FlagGreen,
    FlagBlue,
}

#[derive(Debug, PartialEq)]
pub struct Font {
    pub name: String,
    pub size: u32,
}

struct RowContext<'a> {
    col: &'a Collection,
    card: Card,
    note: Note,
    notetype: Arc<NoteType>,
    deck: Option<Deck>,
    original_deck: Option<Option<Deck>>,
    i18n: &'a I18n,
    timing: SchedTimingToday,
    render_context: Option<RenderContext>,
}

/// The answer string needs the question string but not the other way around, so only build the
/// answer string when needed.
struct RenderContext {
    question: String,
    answer_nodes: Vec<RenderedNode>,
}

fn card_render_required(columns: &[String]) -> bool {
    columns
        .iter()
        .any(|c| CARD_RENDER_COLUMNS.contains(&c.as_str()))
}

impl Collection {
    pub fn browser_row_for_card(&mut self, id: CardID) -> Result<Row> {
        // this is inefficient; we may want to use an enum in the future
        let columns = self.get_desktop_browser_card_columns();
        let mut context = RowContext::new(self, id, card_render_required(&columns))?;

        Ok(Row {
            cells: columns
                .iter()
                .map(|column| context.get_cell(column))
                .collect::<Result<_>>()?,
            color: context.get_row_color(),
            font: context.get_row_font()?,
        })
    }
}

impl RenderContext {
    fn new(col: &mut Collection, card: &Card, note: &Note, notetype: &NoteType) -> Result<Self> {
        let render = col.render_card(
            note,
            card,
            notetype,
            notetype.get_template(card.template_idx)?,
            true,
        )?;
        let qnodes_text = render
            .qnodes
            .iter()
            .map(|node| match node {
                RenderedNode::Text { text } => text,
                RenderedNode::Replacement {
                    field_name: _,
                    current_text,
                    filters: _,
                } => current_text,
            })
            .join("");
        let question = extract_av_tags(&qnodes_text, true).0.to_string();

        Ok(RenderContext {
            question,
            answer_nodes: render.anodes,
        })
    }
}

impl<'a> RowContext<'a> {
    fn new(col: &'a mut Collection, id: CardID, with_card_render: bool) -> Result<Self> {
        let card = col.storage.get_card(id)?.ok_or(AnkiError::NotFound)?;
        // todo: After note.sort_field has been modified so it can be displayed in the browser,
        // we can update note_field_str() and only load the note with fields if a card render is
        // necessary (see #1082).
        let note = if true {
            col.storage.get_note(card.note_id)?
        } else {
            col.storage.get_note_without_fields(card.note_id)?
        }
        .ok_or(AnkiError::NotFound)?;
        let notetype = col
            .get_notetype(note.notetype_id)?
            .ok_or(AnkiError::NotFound)?;
        let timing = col.timing_today()?;
        let render_context = if with_card_render {
            Some(RenderContext::new(col, &card, &note, &notetype)?)
        } else {
            None
        };

        Ok(RowContext {
            col,
            card,
            note,
            notetype,
            deck: None,
            original_deck: None,
            i18n: &col.i18n,
            timing,
            render_context,
        })
    }

    fn template(&self) -> Result<&CardTemplate> {
        self.notetype.get_template(self.card.template_idx)
    }

    fn deck(&mut self) -> Result<&Deck> {
        if self.deck.is_none() {
            self.deck = Some(
                self.col
                    .storage
                    .get_deck(self.card.deck_id)?
                    .ok_or(AnkiError::NotFound)?,
            );
        }
        Ok(self.deck.as_ref().unwrap())
    }

    fn original_deck(&mut self) -> Result<&Option<Deck>> {
        if self.original_deck.is_none() {
            self.original_deck = Some(self.col.storage.get_deck(self.card.original_deck_id)?);
        }
        Ok(self.original_deck.as_ref().unwrap())
    }

    fn get_cell(&mut self, column: &str) -> Result<Cell> {
        Ok(Cell {
            text: self.get_cell_text(column)?,
            is_rtl: self.get_is_rtl(column),
        })
    }

    fn get_cell_text(&mut self, column: &str) -> Result<String> {
        Ok(match column {
            "answer" => self.answer_str(),
            "cardDue" => self.card_due_str(),
            "cardEase" => self.card_ease_str(),
            "cardIvl" => self.card_interval_str(),
            "cardLapses" => self.card.lapses.to_string(),
            "cardMod" => self.card.mtime.date_string(),
            "cardReps" => self.card.reps.to_string(),
            "deck" => self.deck_str()?,
            "note" => self.notetype.name.to_owned(),
            "noteCrt" => self.note_creation_str(),
            "noteFld" => self.note_field_str(),
            "noteMod" => self.note.mtime.date_string(),
            "noteTags" => self.note.tags.join(" "),
            "question" => self.question_str(),
            "template" => self.template_str()?,
            _ => "".to_string(),
        })
    }

    fn answer_str(&self) -> String {
        let render_context = self.render_context.as_ref().unwrap();
        let answer = render_context
            .answer_nodes
            .iter()
            .map(|node| match node {
                RenderedNode::Text { text } => text,
                RenderedNode::Replacement {
                    field_name: _,
                    current_text,
                    filters: _,
                } => current_text,
            })
            .join("");
        let answer = extract_av_tags(&answer, false).0;
        html_to_text_line(
            if let Some(stripped) = answer.strip_prefix(&render_context.question) {
                stripped
            } else {
                &answer
            },
        )
        .to_string()
    }

    fn card_due_str(&mut self) -> String {
        let due = if self.card.original_deck_id != DeckID(0) {
            self.i18n.browsing_filtered()
        } else if self.card.queue == CardQueue::New || self.card.ctype == CardType::New {
            self.i18n.statistics_due_for_new_card(self.card.due)
        } else {
            let date = if self.card.queue == CardQueue::Learn {
                TimestampSecs(self.card.due as i64)
            } else if self.card.queue == CardQueue::DayLearn
                || self.card.queue == CardQueue::Review
                || (self.card.ctype == CardType::Review && (self.card.queue as i8) < 0)
            {
                TimestampSecs::now()
                    .adding_secs(((self.card.due - self.timing.days_elapsed as i32) * 86400) as i64)
            } else {
                return "".into();
            };
            date.date_string().into()
        };
        if (self.card.queue as i8) < 0 {
            format!("({})", due)
        } else {
            due.into()
        }
    }

    fn card_ease_str(&self) -> String {
        match self.card.ctype {
            CardType::New => self.i18n.browsing_new().into(),
            _ => format!("{}%", self.card.ease_factor / 10),
        }
    }

    fn card_interval_str(&self) -> String {
        match self.card.ctype {
            CardType::New => self.i18n.browsing_new().into(),
            CardType::Learn => self.i18n.browsing_learning().into(),
            _ => time_span((self.card.interval * 86400) as f32, self.i18n, false),
        }
    }

    fn deck_str(&mut self) -> Result<String> {
        let deck_name = self.deck()?.human_name();
        Ok(if let Some(original_deck) = self.original_deck()? {
            format!("{} ({})", &deck_name, &original_deck.human_name())
        } else {
            deck_name
        })
    }

    fn note_creation_str(&self) -> String {
        TimestampMillis(self.note.id.into()).as_secs().date_string()
    }

    fn note_field_str(&self) -> String {
        let index = self.notetype.config.sort_field_idx as usize;
        html_to_text_line(&self.note.fields()[index]).into()
    }

    fn template_str(&self) -> Result<String> {
        let name = &self.template()?.name;
        Ok(match self.notetype.config.kind() {
            NoteTypeKind::Normal => name.to_owned(),
            NoteTypeKind::Cloze => format!("{} {}", name, self.card.template_idx + 1),
        })
    }

    fn question_str(&self) -> String {
        html_to_text_line(&self.render_context.as_ref().unwrap().question).to_string()
    }

    fn get_is_rtl(&self, column: &str) -> bool {
        match column {
            "noteFld" => {
                let index = self.notetype.config.sort_field_idx as usize;
                self.notetype.fields[index].config.rtl
            }
            _ => false,
        }
    }

    fn get_row_color(&self) -> Color {
        match self.card.flags {
            1 => Color::FlagRed,
            2 => Color::FlagOrange,
            3 => Color::FlagGreen,
            4 => Color::FlagBlue,
            _ => {
                if self
                    .note
                    .tags
                    .iter()
                    .any(|tag| tag.eq_ignore_ascii_case("marked"))
                {
                    Color::Marked
                } else if self.card.queue == CardQueue::Suspended {
                    Color::Suspended
                } else {
                    Color::Default
                }
            }
        }
    }

    fn get_row_font(&self) -> Result<Font> {
        Ok(Font {
            name: self.template()?.config.browser_font_name.to_owned(),
            size: self.template()?.config.browser_font_size,
        })
    }
}