hippox-drivers 0.3.5

//! File list skill
//!
//! This driver provides functionality to list the contents of a directory
//! with options for showing hidden files, recursive listing, and detailed output.
use crate::DriverCallback;
use crate::DriverContext;
use crate::DriverResult;
use crate::{
    DriverCategory,
    types::{Driver, DriverParameter},
};
use crate::{list_directory, validate_path};
use serde_json::{Value, json};
use std::collections::HashMap;
use std::fs;
use tracing::{debug, info, warn};
/// Driver for listing directory contents
#[derive(Debug)]
pub struct ListDirectoryDriver;
#[async_trait::async_trait]
impl Driver for ListDirectoryDriver {
    /// Returns the unique name of this driver
    fn name(&self) -> &str {
        "file_list"
    }
    /// Returns a brief description of the driver's functionality
    fn description(&self) -> &str {
        "List contents of a directory"
    }
    /// Returns detailed usage guidance for LLMs
    fn usage_hint(&self) -> &str {
        "Use this skill when the user wants to list, show, or see what's inside a directory"
    }
    /// Returns the parameter definitions for this driver
    fn parameters(&self) -> Vec<DriverParameter> {
        return vec![
            DriverParameter {
                name: "path".to_string(),
                param_type: "string".to_string(),
                description: "Directory path to list".to_string(),
                required: true,
                default: None,
                example: Some(Value::String("/home/user".to_string())),
                enum_values: None,
            },
            DriverParameter {
                name: "show_hidden".to_string(),
                param_type: "boolean".to_string(),
                description: "Show hidden files (starting with dot)".to_string(),
                required: false,
                default: Some(Value::Bool(false)),
                example: Some(Value::Bool(true)),
                enum_values: None,
            },
            DriverParameter {
                name: "recursive".to_string(),
                param_type: "boolean".to_string(),
                description: "List directory contents recursively".to_string(),
                required: false,
                default: Some(Value::Bool(false)),
                example: Some(Value::Bool(true)),
                enum_values: None,
            },
            DriverParameter {
                name: "detail".to_string(),
                param_type: "boolean".to_string(),
                description: "Show detailed information (type, size)".to_string(),
                required: false,
                default: Some(Value::Bool(false)),
                example: Some(Value::Bool(true)),
                enum_values: None,
            },
        ];
    }
    /// Returns an example call for this driver
    fn example_call(&self) -> DriverResult<Value> {
        return Ok(json!({
            "action": "file_list",
            "parameters": {
                "path": "/home/user"
            }
        }));
    }
    /// Returns an example output from this driver
    fn example_output(&self) -> String {
        return "Contents of /home/user:\ndocuments\nDownloads\nPictures".to_string();
    }
    /// Returns the category of this driver
    fn category(&self) -> DriverCategory {
        return DriverCategory::File;
    }
    /// Executes the driver with the given parameters
    async fn execute(
        &self,
        parameters: &HashMap<String, Value>,
        callback: Option<&dyn DriverCallback>,
        context: Option<&DriverContext>,
    ) -> DriverResult<String> {
        debug!("Executing file_list driver");
        let task_id = context.as_ref().and_then(|c| c.task_id()).map(String::from);
        let driver_index = context.as_ref().and_then(|c| c.driver_index());
        let step_name = context.as_ref().and_then(|c| c.driver_name()).map(String::from);
        let cb = callback;
        if let Some(cb) = cb {
            cb.on_start(task_id.clone(), driver_index, step_name.clone());
            cb.on_log(task_id.clone(), driver_index, Some("Starting directory listing".to_string()));
            cb.on_progress(task_id.clone(), driver_index, Some(10), None);
        }
        let path = parameters.get("path").and_then(|v| v.as_str()).ok_or_else(|| {
            debug!("Missing 'path' parameter");
            return crate::DriverError::missing_parameter("path");
        })?;
        if let Some(cb) = cb {
            cb.on_log(task_id.clone(), driver_index, Some(format!("Path: {}", path)));
            cb.on_progress(task_id.clone(), driver_index, Some(20), None);
        }
        let show_hidden = parameters.get("show_hidden").and_then(|v| v.as_bool()).unwrap_or(false);
        let recursive = parameters.get("recursive").and_then(|v| v.as_bool()).unwrap_or(false);
        let detail = parameters.get("detail").and_then(|v| v.as_bool()).unwrap_or(false);
        if let Some(cb) = cb {
            cb.on_log(task_id.clone(), driver_index, Some(format!("Show hidden: {}", show_hidden)));
            cb.on_log(task_id.clone(), driver_index, Some(format!("Recursive: {}", recursive)));
            cb.on_log(task_id.clone(), driver_index, Some(format!("Detail: {}", detail)));
            cb.on_progress(task_id.clone(), driver_index, Some(30), None);
        }
        let validated_path = validate_path(path, None).map_err(|e| {
            debug!("Failed to validate path: {}", e);
            return crate::DriverError::execution(format!("Failed to validate path: {}", e));
        })?;
        if let Some(cb) = cb {
            cb.on_log(task_id.clone(), driver_index, Some("Path validated".to_string()));
            cb.on_progress(task_id.clone(), driver_index, Some(40), None);
        }
        if !validated_path.is_dir() {
            warn!("Not a directory: {}", path);
            if let Some(cb) = cb {
                cb.on_log(task_id.clone(), driver_index, Some(format!("Not a directory: {}", path)));
                cb.on_error(task_id.clone(), driver_index, step_name.clone(), Some("Not a directory".to_string()));
            }
            return Err(crate::DriverError::validation("path", "Not a directory"));
        }
        if let Some(cb) = cb {
            cb.on_log(task_id.clone(), driver_index, Some("Reading directory contents".to_string()));
            cb.on_progress(task_id.clone(), driver_index, Some(50), None);
        }
        let entries = list_directory(&validated_path.to_string_lossy(), recursive, show_hidden).map_err(|e| {
            debug!("Failed to list directory: {}", e);
            return crate::DriverError::execution(format!("Failed to list directory: {}", e));
        })?;
        if let Some(cb) = cb {
            cb.on_log(task_id.clone(), driver_index, Some(format!("Found {} entries", entries.len())));
            cb.on_progress(task_id.clone(), driver_index, Some(60), None);
        }
        if entries.is_empty() {
            let result = format!("Directory is empty: {}", path);
            info!("Directory is empty: {}", path);
            if let Some(cb) = cb {
                cb.on_log(task_id.clone(), driver_index, Some(result.clone()));
                cb.on_progress(task_id.clone(), driver_index, Some(100), None);
                cb.on_complete(task_id.clone(), driver_index, Some("file_list".to_string()), Some(result.clone()));
            }
            return Ok(result);
        }
        let mut result_vec = Vec::new();
        if detail {
            debug!("Gathering detailed file information");
            if let Some(cb) = cb {
                cb.on_log(task_id.clone(), driver_index, Some("Gathering detailed file information".to_string()));
                cb.on_progress(task_id.clone(), driver_index, Some(70), None);
            }
            for (idx, entry_path) in entries.iter().enumerate() {
                let name = entry_path.file_name().unwrap_or_default().to_string_lossy().to_string();
                if let Ok(metadata) = fs::metadata(entry_path) {
                    let file_type = if metadata.is_dir() { "DIR" } else { "FILE" };
                    let size = metadata.len();
                    result_vec.push(format!("{}  {}  {} bytes", file_type, name, size));
                } else {
                    result_vec.push(name);
                }
                if let Some(cb) = cb {
                    let progress = 70 + ((idx + 1) * 20 / entries.len()) as u32;
                    cb.on_progress(task_id.clone(), driver_index, Some(progress), None);
                }
            }
        } else {
            debug!("Processing file names");
            if let Some(cb) = cb {
                cb.on_log(task_id.clone(), driver_index, Some("Processing file names".to_string()));
                cb.on_progress(task_id.clone(), driver_index, Some(70), None);
            }
            for (idx, entry_path) in entries.iter().enumerate() {
                let name = entry_path.file_name().unwrap_or_default().to_string_lossy().to_string();
                result_vec.push(name);
                if let Some(cb) = cb {
                    let progress = 70 + ((idx + 1) * 20 / entries.len()) as u32;
                    cb.on_progress(task_id.clone(), driver_index, Some(progress), None);
                }
            }
        }
        let header = if recursive { format!("Contents of {} (recursive):", path) } else { format!("Contents of {}:", path) };
        let result = format!("{}\n{}", header, result_vec.join("\n"));
        info!("Directory listing complete: {} entries found", result_vec.len());
        if let Some(cb) = cb {
            cb.on_log(task_id.clone(), driver_index, Some(format!("Formatted output with {} entries", result_vec.len())));
            cb.on_progress(task_id.clone(), driver_index, Some(90), None);
            cb.on_log(task_id.clone(), driver_index, Some(format!("Result length: {} characters", result.len())));
            cb.on_progress(task_id.clone(), driver_index, Some(100), None);
            cb.on_complete(task_id.clone(), driver_index, Some("file_list".to_string()), Some(result.clone()));
        }
        return Ok(result);
    }
    /// Validates parameters before execution
    fn validate(&self, parameters: &HashMap<String, Value>) -> DriverResult<()> {
        if parameters.get("path").and_then(|v| v.as_str()).is_none() {
            return Err(crate::DriverError::missing_parameter("path"));
        }
        return Ok(());
    }
}