provenant/parsers/

chef.rs

// SPDX-FileCopyrightText: nexB Inc. and others
// ScanCode is a trademark of nexB Inc.
// SPDX-FileCopyrightText: Provenant contributors
// SPDX-License-Identifier: Apache-2.0
// Derived from ScanCode Toolkit (Apache-2.0); modified. See NOTICE.

//! Parser for Chef cookbook metadata files (JSON and Ruby).
//!
//! Extracts package metadata, dependencies, and maintainer information from
//! Chef cookbook metadata files used by the Chef configuration management tool.
//!
//! # Supported Formats
//! - metadata.json (Chef cookbook metadata in JSON format)
//! - metadata.rb (Chef cookbook metadata in Ruby DSL format)
//!
//! # Key Features
//! - Maintainer party extraction from maintainer/maintainer_email fields
//! - Dependency extraction from both `dependencies` and `depends` fields (merged)
//! - URL construction for Chef Supermarket (download, homepage, API)
//! - dist-info guard to prevent false positives with Python wheel metadata.json
//!
//! # Implementation Notes
//! - JSON parser uses serde_json for JSON parsing
//! - Ruby parser uses line-based token extraction (not a full Ruby parser)
//! - Description from `description` or fallback to `long_description`
//! - Graceful error handling: logs warnings and returns default on parse failure
//! - IO.read(...) expressions in Ruby files are skipped (cannot evaluate Ruby code)

use std::collections::HashMap;
use std::fs::{self, File};
use std::io::{BufRead, BufReader};
use std::path::Path;
use std::sync::LazyLock;

use crate::parser_warn as warn;
use packageurl::PackageUrl;
use regex::Regex;
use serde_json::Value;

use crate::models::{DatasourceId, Dependency, PackageData, PackageType, Party};

use super::PackageParser;
use super::metadata::ParserMetadata;
use super::utils::{
    CappedIterExt, MAX_MANIFEST_SIZE, capped_iteration_limit, read_file_to_string, truncate_field,
};

const FIELD_NAME: &str = "name";
const FIELD_VERSION: &str = "version";
const FIELD_DESCRIPTION: &str = "description";
const FIELD_LONG_DESCRIPTION: &str = "long_description";
const FIELD_LICENSE: &str = "license";
const FIELD_MAINTAINER: &str = "maintainer";
const FIELD_MAINTAINER_EMAIL: &str = "maintainer_email";
const FIELD_SOURCE_URL: &str = "source_url";
const FIELD_ISSUES_URL: &str = "issues_url";
const FIELD_DEPENDENCIES: &str = "dependencies";
const FIELD_DEPENDS: &str = "depends";

static RE_FIELD: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r#"^\s*(\w+)\s+['"](.+?)['"]"#).expect("valid regex"));
static RE_DEPENDS: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r#"^\s*depends\s+['"](.+?)['"](?:\s*,\s*['"](.+?)['"])?"#).expect("valid regex")
});
static RE_IO_READ: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"IO\.read\(").expect("valid regex"));

struct ChefPackageFields {
    datasource_id: DatasourceId,
    name: Option<String>,
    version: Option<String>,
    description: Option<String>,
    extracted_license_statement: Option<String>,
    maintainer_name: Option<String>,
    maintainer_email: Option<String>,
    code_view_url: Option<String>,
    bug_tracking_url: Option<String>,
    deps: HashMap<String, Option<String>>,
}

/// Chef metadata.json parser for Chef cookbook manifests.
///
/// Extracts metadata from Chef cookbook metadata.json files, including
/// dependencies from both `dependencies` and `depends` fields.
pub struct ChefMetadataJsonParser;

impl PackageParser for ChefMetadataJsonParser {
    const PACKAGE_TYPE: PackageType = PackageType::Chef;

    fn metadata() -> Vec<ParserMetadata> {
        vec![ParserMetadata {
            description: "Chef cookbook metadata",
            file_patterns: &["**/metadata.json", "**/metadata.rb"],
            package_type: "chef",
            primary_language: "Ruby",
            documentation_url: Some("https://docs.chef.io/config_rb_metadata/"),
        }]
    }

    fn is_match(path: &Path) -> bool {
        if path.file_name().is_some_and(|name| name == "metadata.json") {
            // Check parent directory doesn't end with "dist-info"
            // to prevent false positives with Python wheel metadata.json files
            if let Some(parent) = path.parent()
                && let Some(parent_name) = parent.file_name().and_then(|n| n.to_str())
            {
                return !parent_name.ends_with("dist-info");
            }
            return true;
        }
        false
    }

    fn extract_packages(path: &Path) -> Vec<PackageData> {
        let json_content = match read_json_file(path) {
            Ok(content) => content,
            Err(e) => {
                warn!("Failed to read metadata.json at {:?}: {}", path, e);
                return vec![default_package_data(DatasourceId::ChefCookbookMetadataJson)];
            }
        };

        let name = json_content
            .get(FIELD_NAME)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let version = json_content
            .get(FIELD_VERSION)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let description = extract_description(&json_content).map(truncate_field);

        let extracted_license_statement = json_content
            .get(FIELD_LICENSE)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let maintainer_name = json_content
            .get(FIELD_MAINTAINER)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let maintainer_email = json_content
            .get(FIELD_MAINTAINER_EMAIL)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let code_view_url = json_content
            .get(FIELD_SOURCE_URL)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let bug_tracking_url = json_content
            .get(FIELD_ISSUES_URL)
            .and_then(|v| v.as_str())
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let mut deps: HashMap<String, Option<String>> = HashMap::new();

        if let Some(deps_obj) = json_content
            .get(FIELD_DEPENDENCIES)
            .and_then(|v| v.as_object())
        {
            let limit = capped_iteration_limit(deps_obj.len(), "metadata.json dependencies");
            for (dep_name, dep_version) in deps_obj.iter().take(limit) {
                let version_constraint = dep_version
                    .as_str()
                    .map(|s| s.trim().to_string())
                    .filter(|s| !s.is_empty())
                    .map(truncate_field);
                deps.insert(
                    truncate_field(dep_name.trim().to_string()),
                    version_constraint,
                );
            }
        }

        if let Some(depends_obj) = json_content.get(FIELD_DEPENDS).and_then(|v| v.as_object()) {
            let limit = capped_iteration_limit(depends_obj.len(), "metadata.json depends");
            for (dep_name, dep_version) in depends_obj.iter().take(limit) {
                let version_constraint = dep_version
                    .as_str()
                    .map(|s| s.trim().to_string())
                    .filter(|s| !s.is_empty())
                    .map(truncate_field);
                deps.insert(
                    truncate_field(dep_name.trim().to_string()),
                    version_constraint,
                );
            }
        }

        vec![build_package(ChefPackageFields {
            datasource_id: DatasourceId::ChefCookbookMetadataJson,
            name,
            version,
            description,
            extracted_license_statement,
            maintainer_name,
            maintainer_email,
            code_view_url,
            bug_tracking_url,
            deps,
        })]
    }
}

fn read_json_file(path: &Path) -> Result<Value, String> {
    let contents = read_file_to_string(path, None).map_err(|e| e.to_string())?;
    serde_json::from_str(&contents).map_err(|e| format!("Failed to parse JSON: {}", e))
}

fn default_package_data(datasource_id: DatasourceId) -> PackageData {
    PackageData {
        package_type: Some(ChefMetadataJsonParser::PACKAGE_TYPE),
        datasource_id: Some(datasource_id),
        ..Default::default()
    }
}

fn extract_description(json: &Value) -> Option<String> {
    // Try description first, then long_description
    json.get(FIELD_DESCRIPTION)
        .and_then(|v| v.as_str())
        .map(|s| s.trim().to_string())
        .filter(|s| !s.is_empty())
        .or_else(|| {
            json.get(FIELD_LONG_DESCRIPTION)
                .and_then(|v| v.as_str())
                .map(|s| s.trim().to_string())
                .filter(|s| !s.is_empty())
        })
}

/// Chef metadata.rb parser for Chef cookbook manifests in Ruby DSL format.
///
/// Uses line-based token extraction to parse Ruby DSL without executing Ruby code.
pub struct ChefMetadataRbParser;

impl PackageParser for ChefMetadataRbParser {
    const PACKAGE_TYPE: PackageType = PackageType::Chef;

    fn is_match(path: &Path) -> bool {
        path.file_name().is_some_and(|name| name == "metadata.rb")
    }

    fn extract_packages(path: &Path) -> Vec<PackageData> {
        if let Ok(metadata) = fs::metadata(path)
            && metadata.len() > MAX_MANIFEST_SIZE
        {
            warn!(
                "File {:?} is {} bytes, exceeding the {} byte limit",
                path,
                metadata.len(),
                MAX_MANIFEST_SIZE
            );
            return vec![default_package_data(DatasourceId::ChefCookbookMetadataRb)];
        }

        let file = match File::open(path) {
            Ok(f) => f,
            Err(e) => {
                warn!("Failed to open metadata.rb at {:?}: {}", path, e);
                return vec![default_package_data(DatasourceId::ChefCookbookMetadataRb)];
            }
        };

        let reader = BufReader::new(file);
        let mut fields: HashMap<String, String> = HashMap::new();
        let mut deps: HashMap<String, Option<String>> = HashMap::new();

        for line in reader.lines().capped("metadata.rb lines") {
            let line = match line {
                Ok(l) => l,
                Err(e) => {
                    warn!("Skipping non-UTF-8 line in {:?}: {}", path, e);
                    continue;
                }
            };

            let trimmed = line.trim();

            if trimmed.is_empty() || trimmed.starts_with('#') {
                continue;
            }

            if RE_IO_READ.is_match(&line) {
                continue;
            }

            if let Some(caps) = RE_DEPENDS.captures(&line) {
                let dep_name = caps
                    .get(1)
                    .map(|m| m.as_str().to_string())
                    .unwrap_or_default();
                let dep_version = caps.get(2).map(|m| m.as_str().to_string());
                if !dep_name.is_empty() {
                    deps.insert(dep_name, dep_version);
                }
                continue;
            }

            if let Some(caps) = RE_FIELD.captures(&line) {
                let key = caps
                    .get(1)
                    .map(|m| m.as_str().to_string())
                    .unwrap_or_default();
                let value = caps
                    .get(2)
                    .map(|m| m.as_str().to_string())
                    .unwrap_or_default();

                if !key.is_empty() && !value.is_empty() {
                    match key.as_str() {
                        "name" | "version" | "description" | "long_description" | "license"
                        | "maintainer" | "maintainer_email" | "source_url" | "issues_url" => {
                            fields.insert(key, value);
                        }
                        _ => {}
                    }
                }
            }
        }

        let name = fields
            .get("name")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let version = fields
            .get("version")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let description = fields
            .get("description")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field)
            .or_else(|| {
                fields
                    .get("long_description")
                    .map(|s| s.trim().to_string())
                    .filter(|s| !s.is_empty())
                    .map(truncate_field)
            });

        let extracted_license_statement = fields
            .get("license")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let maintainer_name = fields
            .get("maintainer")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let maintainer_email = fields
            .get("maintainer_email")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let code_view_url = fields
            .get("source_url")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        let bug_tracking_url = fields
            .get("issues_url")
            .map(|s| s.trim().to_string())
            .filter(|s| !s.is_empty())
            .map(truncate_field);

        vec![build_package(ChefPackageFields {
            datasource_id: DatasourceId::ChefCookbookMetadataRb,
            name,
            version,
            description,
            extracted_license_statement,
            maintainer_name,
            maintainer_email,
            code_view_url,
            bug_tracking_url,
            deps,
        })]
    }
}

fn build_package(fields: ChefPackageFields) -> PackageData {
    let ChefPackageFields {
        datasource_id,
        name,
        version,
        description,
        extracted_license_statement,
        maintainer_name,
        maintainer_email,
        code_view_url,
        bug_tracking_url,
        deps,
    } = fields;
    let parties = if maintainer_name.is_some() || maintainer_email.is_some() {
        vec![Party {
            r#type: None,
            role: Some(truncate_field("maintainer".to_string())),
            name: maintainer_name.map(truncate_field),
            email: maintainer_email.map(truncate_field),
            url: None,
            organization: None,
            organization_url: None,
            timezone: None,
        }]
    } else {
        Vec::new()
    };

    let mut dependencies: Vec<Dependency> = deps
        .into_iter()
        .map(|(dep_name, version_constraint)| {
            let purl = PackageUrl::new("chef", &dep_name)
                .map(|p| truncate_field(p.to_string()))
                .ok();
            Dependency {
                purl,
                extracted_requirement: version_constraint.map(truncate_field),
                scope: Some(truncate_field("dependencies".to_string())),
                is_runtime: Some(true),
                is_optional: Some(false),
                is_pinned: None,
                is_direct: None,
                resolved_package: None,
                extra_data: None,
            }
        })
        .collect();

    dependencies.sort_by(|a, b| {
        let name_a = a.purl.as_deref().unwrap_or("");
        let name_b = b.purl.as_deref().unwrap_or("");
        name_a.cmp(name_b)
    });

    let (download_url, repository_download_url, repository_homepage_url, api_data_url) =
        if let (Some(n), Some(v)) = (&name, &version) {
            let download = truncate_field(format!(
                "https://supermarket.chef.io/cookbooks/{}/versions/{}/download",
                n, v
            ));
            let homepage = truncate_field(format!(
                "https://supermarket.chef.io/cookbooks/{}/versions/{}/",
                n, v
            ));
            let api = truncate_field(format!(
                "https://supermarket.chef.io/api/v1/cookbooks/{}/versions/{}",
                n, v
            ));
            (
                Some(download.clone()),
                Some(download),
                Some(homepage),
                Some(api),
            )
        } else {
            (None, None, None, None)
        };

    let purl = match (name.as_deref(), version.as_deref()) {
        (Some(name), Some(version)) => PackageUrl::new("chef", name)
            .map(|mut p| {
                let _ = p.with_version(version);
                truncate_field(p.to_string())
            })
            .ok(),
        _ => None,
    };

    PackageData {
        package_type: Some(ChefMetadataJsonParser::PACKAGE_TYPE),
        datasource_id: Some(datasource_id),
        name,
        version,
        description,
        extracted_license_statement,
        parties,
        code_view_url,
        bug_tracking_url,
        dependencies,
        download_url,
        repository_download_url,
        repository_homepage_url,
        api_data_url,
        purl,
        primary_language: Some(truncate_field("Ruby".to_string())),
        ..Default::default()
    }
}