// Copyright: Ankitects Pty Ltd and contributors // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html use crate::collection::Collection; use crate::config::SchedulerVersion; use crate::error::Result; use crate::prelude::*; pub mod answering; pub mod bury_and_suspend; pub(crate) mod congrats; pub(crate) mod filtered; pub mod fsrs; pub mod new; pub(crate) mod queue; mod reviews; mod service; pub mod states; pub mod timespan; pub mod timing; mod upgrade; use chrono::FixedOffset; pub use reviews::parse_due_date_str; use timing::sched_timing_today; use timing::SchedTimingToday; #[derive(Debug, Clone, Copy)] pub struct SchedulerInfo { pub version: SchedulerVersion, pub timing: SchedTimingToday, } #[derive(Debug, Clone)] pub struct ReviewForecastDay { pub day_offset: u32, pub total: u32, pub review: u32, pub learn: u32, pub new: u32, } impl Collection { pub fn scheduler_info(&mut self) -> Result { let now = TimestampSecs::now(); if let Some(mut info) = self.state.scheduler_info { if now < info.timing.next_day_at { info.timing.now = now; return Ok(info); } } let version = self.scheduler_version(); let timing = self.timing_for_timestamp(now)?; let info = SchedulerInfo { version, timing }; self.state.scheduler_info = Some(info); Ok(info) } pub fn timing_today(&mut self) -> Result { self.scheduler_info().map(|info| info.timing) } pub fn current_due_day(&mut self, delta: i32) -> Result { Ok(((self.timing_today()?.days_elapsed as i32) + delta).max(0) as u32) } pub(crate) fn timing_for_timestamp(&mut self, now: TimestampSecs) -> Result { let current_utc_offset = self.local_utc_offset_for_user()?; let rollover_hour = match self.scheduler_version() { SchedulerVersion::V1 => None, SchedulerVersion::V2 => { let configured_rollover = self.get_v2_rollover(); match configured_rollover { None => { // an older Anki version failed to set this; correct // the issue self.set_v2_rollover(4)?; Some(4) } val => val, } } }; sched_timing_today( self.storage.creation_stamp()?, now, self.creation_utc_offset(), current_utc_offset, rollover_hour, ) } /// In the client case, return the current local timezone offset, /// ensuring the config reflects the current value. /// In the server case, return the value set in the config, and /// fall back on UTC if it's missing/invalid. pub(crate) fn local_utc_offset_for_user(&mut self) -> Result { let config_tz = self .get_configured_utc_offset() .and_then(|v| FixedOffset::west_opt(v * 60)) .unwrap_or_else(|| FixedOffset::west_opt(0).unwrap()); let local_tz = TimestampSecs::now().local_utc_offset()?; Ok(if self.server { config_tz } else { // if the timezone has changed, update the config if config_tz != local_tz { self.set_configured_utc_offset(local_tz.utc_minus_local() / 60)?; } local_tz }) } /// Return the timezone offset at collection creation time. This should /// only be set when the V2 scheduler is active and the new timezone /// code is enabled. fn creation_utc_offset(&self) -> Option { self.get_creation_utc_offset() .and_then(|v| FixedOffset::west_opt(v * 60)) } pub fn rollover_for_current_scheduler(&self) -> Result { match self.scheduler_version() { SchedulerVersion::V1 => Err(AnkiError::SchedulerUpgradeRequired), SchedulerVersion::V2 => Ok(self.get_v2_rollover().unwrap_or(4)), } } pub(crate) fn set_rollover_for_current_scheduler(&mut self, hour: u8) -> Result<()> { match self.scheduler_version() { SchedulerVersion::V1 => Err(AnkiError::SchedulerUpgradeRequired), SchedulerVersion::V2 => self.set_v2_rollover(hour as u32), } } pub(crate) fn set_creation_stamp(&mut self, stamp: TimestampSecs) -> Result<()> { self.state.scheduler_info = None; self.storage.set_creation_stamp(stamp) } /// Return forecast data for the next `days` days (capped at 7). pub(crate) fn sched_forecast( &mut self, days: u32, ) -> Result> { use anki_proto::scheduler::ReviewForecastDay as PbDay; let timing = self.timing_for_timestamp(TimestampSecs::now())?; let today = timing.days_elapsed; let mut out = Vec::new(); let want = days.min(7); for offset in 0..want { let target_day = today + offset; let rev_cnt = self .storage .db .prepare_cached("SELECT COUNT(*) FROM cards WHERE queue = 2 AND due = ?") .and_then(|mut stmt| { stmt.query_row([(target_day as i64)], |row| row.get::<_, u32>(0)) }) .unwrap_or(0); out.push(PbDay { day_offset: offset, total: rev_cnt, review: rev_cnt, learn: 0, new: 0, }); } Ok(out) } }