subversion 0.1.12

//! Conflict resolution for working copy operations.

use crate::{Error, Revnum};
use std::ffi::CStr;

/// What sort of conflict occurred.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConflictKind {
    /// Text or content conflict.
    Text,
    /// Property conflict.
    Property,
    /// Tree conflict (structural changes like add/delete/move).
    Tree,
}

impl From<subversion_sys::svn_wc_conflict_kind_t> for ConflictKind {
    fn from(kind: subversion_sys::svn_wc_conflict_kind_t) -> Self {
        match kind {
            0 => ConflictKind::Text,     // svn_wc_conflict_kind_text
            1 => ConflictKind::Property, // svn_wc_conflict_kind_property
            2 => ConflictKind::Tree,     // svn_wc_conflict_kind_tree
            _ => unreachable!("unknown svn_wc_conflict_kind_t value: {}", kind),
        }
    }
}

/// The incoming action that caused a conflict.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConflictAction {
    /// Edit.
    Edit,
    /// Add.
    Add,
    /// Delete.
    Delete,
    /// Replace.
    Replace,
}

impl From<subversion_sys::svn_wc_conflict_action_t> for ConflictAction {
    fn from(action: subversion_sys::svn_wc_conflict_action_t) -> Self {
        match action {
            0 => ConflictAction::Edit,    // svn_wc_conflict_action_edit
            1 => ConflictAction::Add,     // svn_wc_conflict_action_add
            2 => ConflictAction::Delete,  // svn_wc_conflict_action_delete
            3 => ConflictAction::Replace, // svn_wc_conflict_action_replace
            _ => unreachable!("unknown svn_wc_conflict_action_t value: {}", action),
        }
    }
}

/// The local reason for a conflict.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConflictReason {
    /// Local edit.
    Edited,
    /// Local obstruction.
    Obstructed,
    /// Locally deleted.
    Deleted,
    /// Locally missing.
    Missing,
    /// Locally unversioned.
    Unversioned,
    /// Locally added.
    Added,
    /// Locally replaced.
    Replaced,
    /// Locally moved away.
    MovedAway,
    /// Locally moved here.
    MovedHere,
}

impl From<subversion_sys::svn_wc_conflict_reason_t> for ConflictReason {
    fn from(reason: subversion_sys::svn_wc_conflict_reason_t) -> Self {
        match reason {
            0 => ConflictReason::Edited,      // svn_wc_conflict_reason_edited
            1 => ConflictReason::Obstructed,  // svn_wc_conflict_reason_obstructed
            2 => ConflictReason::Deleted,     // svn_wc_conflict_reason_deleted
            3 => ConflictReason::Missing,     // svn_wc_conflict_reason_missing
            4 => ConflictReason::Unversioned, // svn_wc_conflict_reason_unversioned
            5 => ConflictReason::Added,       // svn_wc_conflict_reason_added
            6 => ConflictReason::Replaced,    // svn_wc_conflict_reason_replaced
            7 => ConflictReason::MovedAway,   // svn_wc_conflict_reason_moved_away
            8 => ConflictReason::MovedHere,   // svn_wc_conflict_reason_moved_here
            _ => unreachable!("unknown svn_wc_conflict_reason_t value: {}", reason),
        }
    }
}

/// Information about one side of a conflict.
#[derive(Debug, Clone)]
pub struct ConflictVersion {
    /// Repository root URL.
    pub repos_url: String,
    /// Peg revision.
    pub peg_revision: Revnum,
    /// Path in repository.
    pub path_in_repos: String,
    /// Node kind.
    pub node_kind: crate::NodeKind,
}

impl ConflictVersion {
    unsafe fn from_raw(ptr: *const subversion_sys::svn_wc_conflict_version_t) -> Option<Self> {
        if ptr.is_null() {
            return None;
        }

        let version = &*ptr;
        Some(Self {
            repos_url: CStr::from_ptr(version.repos_url)
                .to_string_lossy()
                .into_owned(),
            peg_revision: Revnum(version.peg_rev),
            path_in_repos: CStr::from_ptr(version.path_in_repos)
                .to_string_lossy()
                .into_owned(),
            node_kind: version.node_kind.into(),
        })
    }
}

/// Description of a conflict, wrapping `svn_wc_conflict_description2_t`.
#[derive(Debug, Clone)]
pub struct ConflictDescription {
    /// Absolute path of the conflicted node.
    pub local_abspath: String,
    /// Node kind.
    pub node_kind: crate::NodeKind,
    /// What sort of conflict this is.
    pub kind: ConflictKind,
    /// Property name, for property conflicts.
    pub property_name: Option<String>,
    /// Whether the file is binary.
    pub is_binary: bool,
    /// MIME type of the file.
    pub mime_type: Option<String>,
    /// The incoming action.
    pub action: ConflictAction,
    /// The local reason.
    pub reason: ConflictReason,
    /// Base file (common ancestor).
    pub base_file: Option<String>,
    /// Their file (incoming version).
    pub their_file: Option<String>,
    /// My file (local version).
    pub my_file: Option<String>,
    /// Merged file, if already merged.
    pub merged_file: Option<String>,
    /// Left source version.
    pub src_left_version: Option<ConflictVersion>,
    /// Right source version.
    pub src_right_version: Option<ConflictVersion>,
}

impl ConflictDescription {
    pub(crate) unsafe fn from_raw(
        desc: *const subversion_sys::svn_wc_conflict_description2_t,
    ) -> Result<Self, Error<'static>> {
        if desc.is_null() {
            return Err(Error::from_message("Null conflict description"));
        }

        let d = &*desc;

        Ok(Self {
            local_abspath: CStr::from_ptr(d.local_abspath)
                .to_string_lossy()
                .into_owned(),
            node_kind: d.node_kind.into(),
            kind: d.kind.into(),
            property_name: if d.property_name.is_null() {
                None
            } else {
                Some(
                    CStr::from_ptr(d.property_name)
                        .to_string_lossy()
                        .into_owned(),
                )
            },
            is_binary: d.is_binary != 0,
            mime_type: if d.mime_type.is_null() {
                None
            } else {
                Some(CStr::from_ptr(d.mime_type).to_string_lossy().into_owned())
            },
            action: d.action.into(),
            reason: d.reason.into(),
            base_file: if d.base_abspath.is_null() {
                None
            } else {
                Some(
                    CStr::from_ptr(d.base_abspath)
                        .to_string_lossy()
                        .into_owned(),
                )
            },
            their_file: if d.their_abspath.is_null() {
                None
            } else {
                Some(
                    CStr::from_ptr(d.their_abspath)
                        .to_string_lossy()
                        .into_owned(),
                )
            },
            my_file: if d.my_abspath.is_null() {
                None
            } else {
                Some(CStr::from_ptr(d.my_abspath).to_string_lossy().into_owned())
            },
            merged_file: if d.merged_file.is_null() {
                None
            } else {
                Some(CStr::from_ptr(d.merged_file).to_string_lossy().into_owned())
            },
            src_left_version: ConflictVersion::from_raw(d.src_left_version),
            src_right_version: ConflictVersion::from_raw(d.src_right_version),
        })
    }
}

/// Resolution choice for a conflict.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConflictChoice {
    /// Postpone resolution.
    Postpone,
    /// Use base version.
    Base,
    /// Accept theirs completely.
    TheirsFull,
    /// Accept mine completely.
    MineFull,
    /// Use their version for conflict regions only.
    TheirsConflict,
    /// Use my version for conflict regions only.
    MineConflict,
    /// Use a merged version.
    Merged,
    /// Undefined / not yet decided.
    Undefined,
}

impl ConflictChoice {
    /// Converts the conflict choice to its raw SVN representation.
    pub fn to_raw(&self) -> subversion_sys::svn_wc_conflict_choice_t {
        match self {
            ConflictChoice::Undefined => -1, // svn_wc_conflict_choose_undefined
            ConflictChoice::Postpone => 0,   // svn_wc_conflict_choose_postpone
            ConflictChoice::Base => 1,       // svn_wc_conflict_choose_base
            ConflictChoice::TheirsFull => 2, // svn_wc_conflict_choose_theirs_full
            ConflictChoice::MineFull => 3,   // svn_wc_conflict_choose_mine_full
            ConflictChoice::TheirsConflict => 4, // svn_wc_conflict_choose_theirs_conflict
            ConflictChoice::MineConflict => 5, // svn_wc_conflict_choose_mine_conflict
            ConflictChoice::Merged => 6,     // svn_wc_conflict_choose_merged
        }
    }

    /// Convert to client conflict option ID for text conflicts.
    #[cfg(feature = "client")]
    pub fn to_text_option_id(&self) -> subversion_sys::svn_client_conflict_option_id_t {
        match self {
            ConflictChoice::Undefined => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_undefined,
            ConflictChoice::Postpone => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_postpone,
            ConflictChoice::Base => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_base_text,
            ConflictChoice::TheirsFull => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_text,
            ConflictChoice::MineFull => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_working_text,
            ConflictChoice::TheirsConflict => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_text_where_conflicted,
            ConflictChoice::MineConflict => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_working_text_where_conflicted,
            ConflictChoice::Merged => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_merged_text,
        }
    }

    /// Convert to client conflict option ID for tree conflicts.
    #[cfg(feature = "client")]
    pub fn to_tree_option_id(&self) -> subversion_sys::svn_client_conflict_option_id_t {
        match self {
            ConflictChoice::Postpone => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_postpone,
            ConflictChoice::Base => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_accept_current_wc_state,
            ConflictChoice::TheirsFull => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_delete_accept,
            ConflictChoice::MineFull => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_delete_ignore,
            ConflictChoice::Undefined
            | ConflictChoice::TheirsConflict
            | ConflictChoice::MineConflict
            | ConflictChoice::Merged => subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_postpone,
        }
    }
}

/// Result of conflict resolution.
#[derive(Debug, Clone)]
pub struct ConflictResult {
    /// The choice made to resolve the conflict.
    pub choice: ConflictChoice,
    /// Path to merged file (if choice is Merged).
    pub merged_file: Option<String>,
    /// Whether to save the resolution to the working copy.
    pub save_merged: bool,
}

impl Default for ConflictResult {
    fn default() -> Self {
        Self {
            choice: ConflictChoice::Postpone,
            merged_file: None,
            save_merged: false,
        }
    }
}

impl ConflictResult {
    pub(crate) unsafe fn to_raw(
        &self,
        pool: *mut apr_sys::apr_pool_t,
    ) -> *mut subversion_sys::svn_wc_conflict_result_t {
        let merged_file_cstr;
        let merged_file_ptr = if let Some(ref merged_file) = self.merged_file {
            merged_file_cstr = std::ffi::CString::new(merged_file.as_str()).unwrap();
            merged_file_cstr.as_ptr()
        } else {
            std::ptr::null()
        };

        let result = subversion_sys::svn_wc_create_conflict_result(
            self.choice.to_raw(),
            merged_file_ptr,
            pool,
        );

        (*result).save_merged = if self.save_merged { 1 } else { 0 };

        result
    }
}

/// Trait for implementing conflict resolution.
///
/// Called when a conflict is encountered during a merge or update operation.
/// The implementation should examine the conflict description and return a
/// resolution choice.
pub trait ConflictResolver: Send + Sync {
    /// Resolve a conflict, returning the chosen resolution.
    fn resolve(&mut self, conflict: &ConflictDescription)
        -> Result<ConflictResult, Error<'static>>;
}

/// Storage for conflict resolver in client context
#[cfg(feature = "client")]
pub(crate) struct ConflictResolverBaton {
    pub resolver: Box<dyn ConflictResolver>,
}

/// C callback function for conflict resolution
#[cfg(feature = "client")]
pub(crate) unsafe extern "C" fn conflict_resolver_callback(
    result: *mut *mut subversion_sys::svn_wc_conflict_result_t,
    description: *const subversion_sys::svn_wc_conflict_description2_t,
    baton: *mut std::ffi::c_void,
    result_pool: *mut apr_sys::apr_pool_t,
    _scratch_pool: *mut apr_sys::apr_pool_t,
) -> *mut subversion_sys::svn_error_t {
    if baton.is_null() {
        return std::ptr::null_mut();
    }

    let resolver_baton = &mut *(baton as *mut ConflictResolverBaton);
    let conflict_desc = match ConflictDescription::from_raw(description) {
        Ok(desc) => desc,
        Err(mut e) => {
            *result = std::ptr::null_mut();
            return e.detach();
        }
    };

    match resolver_baton.resolver.resolve(&conflict_desc) {
        Ok(resolution) => {
            let pool = unsafe { apr::PoolHandle::from_borrowed_raw(result_pool) };
            let conflict_result: *mut subversion_sys::svn_wc_conflict_result_t = pool.calloc();

            (*conflict_result).choice = resolution.choice.to_raw();

            if let Some(ref merged_path) = resolution.merged_file {
                let merged_cstr = std::ffi::CString::new(merged_path.as_str()).unwrap();
                (*conflict_result).merged_file =
                    apr::strings::pstrdup_raw(merged_cstr.to_str().unwrap(), &pool).unwrap()
                        as *const _;
            } else {
                (*conflict_result).merged_file = std::ptr::null();
            }

            (*conflict_result).save_merged = if resolution.save_merged { 1 } else { 0 };

            *result = conflict_result;
            std::ptr::null_mut()
        }
        Err(e) => e.into_raw(),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_conflict_choice_conversion() {
        assert_eq!(
            ConflictChoice::Postpone.to_raw(),
            0 // svn_wc_conflict_choose_postpone
        );
        assert_eq!(
            ConflictChoice::TheirsFull.to_raw(),
            2 // svn_wc_conflict_choose_theirs_full
        );
    }

    #[test]
    fn test_conflict_choice_to_raw_all() {
        assert_eq!(ConflictChoice::Undefined.to_raw(), -1);
        assert_eq!(ConflictChoice::Postpone.to_raw(), 0);
        assert_eq!(ConflictChoice::Base.to_raw(), 1);
        assert_eq!(ConflictChoice::TheirsFull.to_raw(), 2);
        assert_eq!(ConflictChoice::MineFull.to_raw(), 3);
        assert_eq!(ConflictChoice::TheirsConflict.to_raw(), 4);
        assert_eq!(ConflictChoice::MineConflict.to_raw(), 5);
        assert_eq!(ConflictChoice::Merged.to_raw(), 6);
    }

    #[test]
    fn test_conflict_kind_from_all() {
        assert_eq!(
            ConflictKind::from(subversion_sys::svn_wc_conflict_kind_t_svn_wc_conflict_kind_text),
            ConflictKind::Text
        );
        assert_eq!(
            ConflictKind::from(
                subversion_sys::svn_wc_conflict_kind_t_svn_wc_conflict_kind_property
            ),
            ConflictKind::Property
        );
        assert_eq!(
            ConflictKind::from(subversion_sys::svn_wc_conflict_kind_t_svn_wc_conflict_kind_tree),
            ConflictKind::Tree
        );
    }

    #[test]
    fn test_conflict_action_from_all() {
        assert_eq!(
            ConflictAction::from(
                subversion_sys::svn_wc_conflict_action_t_svn_wc_conflict_action_edit
            ),
            ConflictAction::Edit
        );
        assert_eq!(
            ConflictAction::from(
                subversion_sys::svn_wc_conflict_action_t_svn_wc_conflict_action_add
            ),
            ConflictAction::Add
        );
        assert_eq!(
            ConflictAction::from(
                subversion_sys::svn_wc_conflict_action_t_svn_wc_conflict_action_delete
            ),
            ConflictAction::Delete
        );
        assert_eq!(
            ConflictAction::from(
                subversion_sys::svn_wc_conflict_action_t_svn_wc_conflict_action_replace
            ),
            ConflictAction::Replace
        );
    }

    #[test]
    fn test_conflict_reason_from_all() {
        let cases = [
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_edited,
                ConflictReason::Edited,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_obstructed,
                ConflictReason::Obstructed,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_deleted,
                ConflictReason::Deleted,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_missing,
                ConflictReason::Missing,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_unversioned,
                ConflictReason::Unversioned,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_added,
                ConflictReason::Added,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_replaced,
                ConflictReason::Replaced,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_moved_away,
                ConflictReason::MovedAway,
            ),
            (
                subversion_sys::svn_wc_conflict_reason_t_svn_wc_conflict_reason_moved_here,
                ConflictReason::MovedHere,
            ),
        ];
        for (raw, expected) in cases {
            assert_eq!(ConflictReason::from(raw), expected);
        }
    }

    #[cfg(feature = "client")]
    #[test]
    fn test_to_text_option_id() {
        // Distinct choices map to distinct, non-default option IDs.
        assert_eq!(
            ConflictChoice::Postpone.to_text_option_id(),
            subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_postpone
        );
        assert_eq!(
            ConflictChoice::TheirsFull.to_text_option_id(),
            subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_text
        );
        assert_eq!(
            ConflictChoice::Merged.to_text_option_id(),
            subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_merged_text
        );
    }

    #[cfg(feature = "client")]
    #[test]
    fn test_to_tree_option_id() {
        assert_eq!(
            ConflictChoice::Base.to_tree_option_id(),
            subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_accept_current_wc_state
        );
        assert_eq!(
            ConflictChoice::TheirsFull.to_tree_option_id(),
            subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_delete_accept
        );
        assert_eq!(
            ConflictChoice::MineFull.to_tree_option_id(),
            subversion_sys::svn_client_conflict_option_id_t_svn_client_conflict_option_incoming_delete_ignore
        );
    }
}