bsky-sdk 0.1.24

//! Moderation behavior decision making.
use super::types::*;
use super::{Moderator, labels::KnownLabelValue, ui::ModerationUi};
use atrium_api::app::bsky::graph::defs::ListViewBasic;
use atrium_api::com::atproto::label::defs::Label;
use atrium_api::types::string::Did;

/// A moderation decision context.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DecisionContext {
    /// A profile being listed, e.g. in search or a follower list
    ProfileList,
    /// A profile being viewed directly
    ProfileView,
    /// The user's avatar in any context
    Avatar,
    /// The user's banner in any context
    Banner,
    /// The user's display name in any context
    DisplayName,
    /// Content being listed, e.g. posts in a feed, posts as replies, a user list list, a feed generator list, etc
    ContentList,
    /// Content being viewed direct, e.g. an opened post, the user list page, the feedgen page, etc
    ContentView,
    /// Media inside the content, e.g. a picture embedded in a post
    ContentMedia,
}

impl DecisionContext {
    pub const ALL: [DecisionContext; 8] = [
        DecisionContext::ProfileList,
        DecisionContext::ProfileView,
        DecisionContext::Avatar,
        DecisionContext::Banner,
        DecisionContext::DisplayName,
        DecisionContext::ContentList,
        DecisionContext::ContentView,
        DecisionContext::ContentMedia,
    ];
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum ModerationBehaviorSeverity {
    High,
    Medium,
    Low,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) enum Priority {
    Priority1,
    Priority2,
    Priority3,
    Priority4,
    Priority5,
    Priority6,
    Priority7,
    Priority8,
}

impl AsRef<u8> for Priority {
    fn as_ref(&self) -> &u8 {
        match self {
            Priority::Priority1 => &1,
            Priority::Priority2 => &2,
            Priority::Priority3 => &3,
            Priority::Priority4 => &4,
            Priority::Priority5 => &5,
            Priority::Priority6 => &6,
            Priority::Priority7 => &7,
            Priority::Priority8 => &8,
        }
    }
}

/// A moderation decision.
#[derive(Debug)]
pub struct ModerationDecision {
    did: Option<Did>,
    is_me: bool,
    causes: Vec<ModerationCause>,
}

impl ModerationDecision {
    /// Calculate the [`ModerationUi`] for a given context.
    pub fn ui(&self, context: DecisionContext) -> ModerationUi {
        let mut ui = ModerationUi {
            no_override: false,
            filters: Vec::new(),
            blurs: Vec::new(),
            alerts: Vec::new(),
            informs: Vec::new(),
        };
        for cause in &self.causes {
            match cause {
                ModerationCause::Blocking(b)
                | ModerationCause::BlockedBy(b)
                /* | ModerationCause::BlockOther(b) */ => {
                    if self.is_me {
                        continue;
                    }
                    if matches!(
                        context,
                        DecisionContext::ProfileList | DecisionContext::ContentList
                    ) {
                        ui.filters.push(cause.clone())
                    }
                    if !b.downgraded {
                        match ModerationBehavior::BLOCK_BEHAVIOR.behavior_for(context) {
                            Some(BehaviorValue::Blur) => {
                                ui.no_override = true;
                                ui.blurs.push(cause.clone());
                            }
                            Some(BehaviorValue::Alert) => {
                                ui.alerts.push(cause.clone());
                            }
                            Some(BehaviorValue::Inform) => {
                                ui.informs.push(cause.clone());
                            }
                            _ => {}
                        }
                    }
                }
                ModerationCause::Label(label) => {
                    if matches!(
                        (context, label.target),
                        (DecisionContext::ProfileList, LabelTarget::Account)
                            | (
                                DecisionContext::ContentList,
                                LabelTarget::Account | LabelTarget::Content,
                            ),
                    ) && (label.setting == LabelPreference::Hide && !self.is_me)
                    {
                        ui.filters.push(cause.clone())
                    }
                    if !label.downgraded {
                        match label.behavior.behavior_for(context) {
                            Some(BehaviorValue::Blur) => {
                                ui.blurs.push(cause.clone());
                                if label.no_override && !self.is_me {
                                    ui.no_override = true;
                                }
                            }
                            Some(BehaviorValue::Alert) => {
                                ui.alerts.push(cause.clone());
                            }
                            Some(BehaviorValue::Inform) => {
                                ui.informs.push(cause.clone());
                            }
                            _ => {}
                        }
                    }
                }
                ModerationCause::Muted(muted) => {
                    if self.is_me {
                        continue;
                    }
                    if matches!(
                        context,
                        DecisionContext::ProfileList | DecisionContext::ContentList
                    ) {
                        ui.filters.push(cause.clone())
                    }
                    if !muted.downgraded {
                        match ModerationBehavior::MUTE_BEHAVIOR.behavior_for(context) {
                            Some(BehaviorValue::Blur) => {
                                ui.blurs.push(cause.clone());
                            }
                            Some(BehaviorValue::Alert) => {
                                ui.alerts.push(cause.clone());
                            }
                            Some(BehaviorValue::Inform) => {
                                ui.informs.push(cause.clone());
                            }
                            _ => {}
                        }
                    }
                }
                ModerationCause::MuteWord(mute_word) => {
                    if self.is_me {
                        continue;
                    }
                    if matches!(context, DecisionContext::ContentList) {
                        ui.filters.push(cause.clone())
                    }
                    if !mute_word.downgraded {
                        match ModerationBehavior::MUTEWORD_BEHAVIOR.behavior_for(context) {
                            Some(BehaviorValue::Blur) => {
                                ui.blurs.push(cause.clone());
                            }
                            Some(BehaviorValue::Alert) => {
                                ui.alerts.push(cause.clone());
                            }
                            Some(BehaviorValue::Inform) => {
                                ui.informs.push(cause.clone());
                            }
                            _ => {}
                        }
                    }
                }
                ModerationCause::Hidden(hidden) => {
                    if matches!(context, DecisionContext::ProfileList | DecisionContext::ContentList) {
                        ui.filters.push(cause.clone())
                    }
                    if !hidden.downgraded {
                        match ModerationBehavior::HIDE_BEHAVIOR.behavior_for(context) {
                            Some(BehaviorValue::Blur) => {
                                ui.blurs.push(cause.clone());
                            }
                            Some(BehaviorValue::Alert) => {
                                ui.alerts.push(cause.clone());
                            }
                            Some(BehaviorValue::Inform) => {
                                ui.informs.push(cause.clone());
                            }
                            _ => {}
                        }
                    }
                }
            }
        }
        ui.filters.sort_by_cached_key(|c| c.priority());
        ui.blurs.sort_by_cached_key(|c| c.priority());
        ui
    }
    /// Check if the decision is blocking or blocked by other user.
    pub fn is_blocked(&self) -> bool {
        self.causes.iter().any(|c| {
            matches!(
                c,
                ModerationCause::Blocking(_)
                    | ModerationCause::BlockedBy(_)
                    /* | ModerationCause::BlockOther(_) */
            )
        })
    }
    /// Check if the decision is by muted.
    pub fn is_muted(&self) -> bool {
        self.causes.iter().any(|c| matches!(c, ModerationCause::Muted(_)))
    }
    pub(crate) fn new() -> Self {
        Self { did: None, is_me: false, causes: Vec::new() }
    }
    pub(crate) fn merge(decisions: &[Self]) -> Self {
        assert!(!decisions.is_empty());
        // assert!(decisions
        //     .windows(2)
        //     .all(|w| w[0].did == w[1].did && w[0].is_me == w[1].is_me));
        Self {
            did: decisions[0].did.clone(),
            is_me: decisions[0].is_me,
            causes: decisions.iter().flat_map(|d| d.causes.iter().cloned()).collect(),
        }
    }
    pub(crate) fn set_did(&mut self, did: Did) {
        self.did = Some(did);
    }
    pub(crate) fn set_is_me(&mut self, is_me: bool) {
        self.is_me = is_me;
    }
    pub(crate) fn add_blocking(&mut self) {
        self.causes.push(ModerationCause::Blocking(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::User,
            downgraded: false,
        })));
    }
    pub(crate) fn add_blocking_by_list(&mut self, list_view: &ListViewBasic) {
        self.causes.push(ModerationCause::Blocking(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::List(Box::new(list_view.clone())),
            downgraded: false,
        })));
    }
    pub(crate) fn add_blocked_by(&mut self) {
        self.causes.push(ModerationCause::BlockedBy(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::User,
            downgraded: false,
        })));
    }
    pub(crate) fn add_label(&mut self, target: LabelTarget, label: &Label, moderator: &Moderator) {
        let Some(label_def) = Self::lookup_label_def(label, moderator) else {
            return;
        };
        let is_self = Some(&label.src) == self.did.as_ref();
        let labeler = if is_self {
            None
        } else {
            moderator.prefs.labelers.iter().find(|l| l.did == label.src)
        };
        if !is_self && labeler.is_none() {
            return; // skip labelers not configured by the user
        }
        if is_self && label_def.flags.contains(&LabelValueDefinitionFlag::NoSelf) {
            return; // skip self-labels that arent supported
        }

        // establish the label preference for interpretation
        let mut label_pref = label_def.default_setting;
        if label_def.flags.contains(&LabelValueDefinitionFlag::Adult)
            && !moderator.prefs.adult_content_enabled
        {
            label_pref = LabelPreference::Hide;
        } else if let Some(pref) = labeler.and_then(|l| l.labels.get(&label_def.identifier)) {
            label_pref = *pref;
        } else if let Some(pref) = moderator.prefs.labels.get(&label_def.identifier) {
            label_pref = *pref;
        }

        // ignore labels the user has asked to ignore
        if label_pref == LabelPreference::Ignore {
            return;
        }

        // ignore 'unauthed' labels when the user is authed
        if label_def.flags.contains(&LabelValueDefinitionFlag::Unauthed)
            && moderator.user_did.is_some()
        {
            return;
        }

        let behavior = label_def.behaviors.behavior_for(target);
        // establish the priority of the label
        let severity = Self::measure_moderation_behavior_severity(&behavior);
        let priority = if label_def.flags.contains(&LabelValueDefinitionFlag::NoOverride)
            || (label_def.flags.contains(&LabelValueDefinitionFlag::Adult)
                && !moderator.prefs.adult_content_enabled)
        {
            Priority::Priority1
        } else if label_pref == LabelPreference::Hide {
            Priority::Priority2
        } else if severity == ModerationBehaviorSeverity::High {
            // blurring profile view or content view
            Priority::Priority5
        } else if severity == ModerationBehaviorSeverity::Medium {
            // blurring content list or content media
            Priority::Priority7
        } else {
            // blurring avatar, adding alerts
            Priority::Priority8
        };

        let no_override = label_def.flags.contains(&LabelValueDefinitionFlag::NoOverride)
            || (label_def.flags.contains(&LabelValueDefinitionFlag::Adult)
                && !moderator.prefs.adult_content_enabled);

        self.causes.push(ModerationCause::Label(Box::new(ModerationCauseLabel {
            source: if is_self || labeler.is_none() {
                ModerationCauseSource::User
            } else {
                ModerationCauseSource::Labeler(label.src.clone())
            },
            label: label.clone(),
            label_def,
            target,
            setting: label_pref,
            behavior,
            no_override,
            priority,
            downgraded: false,
        })));
    }
    pub(crate) fn add_muted(&mut self) {
        self.causes.push(ModerationCause::Muted(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::User,
            downgraded: false,
        })));
    }
    pub(crate) fn add_muted_by_list(&mut self, list_view: &ListViewBasic) {
        self.causes.push(ModerationCause::Muted(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::List(Box::new(list_view.clone())),
            downgraded: false,
        })));
    }
    pub(crate) fn add_muted_word(&mut self) {
        self.causes.push(ModerationCause::MuteWord(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::User,
            downgraded: false,
        })));
    }
    pub(crate) fn add_hidden(&mut self) {
        self.causes.push(ModerationCause::Hidden(Box::new(ModerationCauseOther {
            source: ModerationCauseSource::User,
            downgraded: false,
        })));
    }
    pub(crate) fn downgrade(&mut self) {
        for cause in self.causes.iter_mut() {
            cause.downgrade()
        }
    }
    fn lookup_label_def(
        label: &Label,
        moderator: &Moderator,
    ) -> Option<InterpretedLabelValueDefinition> {
        if label.val.chars().all(|c| c.is_ascii_lowercase() || c == '-') {
            if let Some(def) = moderator
                .label_defs
                .get(&label.src)
                .and_then(|defs| defs.iter().find(|def| def.identifier == label.val))
            {
                return Some(def.clone());
            }
        }
        label.val.parse::<KnownLabelValue>().ok().map(|known_value| known_value.definition())
    }
    fn measure_moderation_behavior_severity(
        behavior: &ModerationBehavior,
    ) -> ModerationBehaviorSeverity {
        if behavior.profile_view == Some(ProfileViewBehavior::Blur)
            || behavior.content_view == Some(ContentViewBehavior::Blur)
        {
            return ModerationBehaviorSeverity::High;
        }
        if behavior.content_list == Some(ContentListBehavior::Blur)
            || behavior.content_media == Some(ContentMediaBehavior::Blur)
        {
            return ModerationBehaviorSeverity::Medium;
        }
        ModerationBehaviorSeverity::Low
    }
}