stof 0.9.19

Data that carries its own logic.
Documentation
//
// Copyright 2025 Formata, Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

use std::{fs, path::PathBuf};
use bytes::Bytes;
use crate::{model::{FS_LIB, Graph, NodeRef, Profile}, parser::context::ParseContext, runtime::Error};


/// Format.
pub trait Format: std::fmt::Debug + Send + Sync {
    /// Identifiers for this format.
    /// These will be the ways this format is referenced on the graph.
    fn identifiers(&self) -> Vec<String>;

    /// Content type for this format.
    fn content_type(&self) -> String;

    /// String import.
    #[allow(unused)]
    fn string_import(&self, graph: &mut Graph, format: &str, src: &str, node: Option<NodeRef>, profile: &Profile) -> Result<(), Error> {
        Err(Error::FormatStringImportNotImplemented(format.into()))
    }

    /// File import.
    #[allow(unused)]
    fn file_import(&self, graph: &mut Graph, format: &str, path: &str, node: Option<NodeRef>, profile: &Profile) -> Result<(), Error> {
        if let Some(_lib) = graph.libfunc(&FS_LIB, "read_string") {
            #[cfg(not(feature = "system"))]
            {
                use imbl::vector;
                use std::sync::Arc;
                use crate::{runtime::{Val, instruction::Instruction, instructions::{Base, call::FuncCall}}};

                let mut context = ParseContext::new(graph, profile.clone());
                let ins: Arc<dyn Instruction> = Arc::new(FuncCall {
                    func: None,
                    search: Some("fs.read_string".into()),
                    stack: false,
                    as_ref: false,
                    cnull: false,
                    args: vector![Arc::new(Base::Literal(Val::Str(path.into()))) as Arc<dyn Instruction>],
                    oself: None,
                });
                match context.eval(ins) {
                    Ok(res) => {
                        match res {
                            Val::Str(src) => {
                                if !src.is_empty() {
                                    return self.string_import(&mut context.graph, format, &src, node, profile);
                                }
                                return Ok(());
                            },
                            _ => {
                                // Try FS
                            }
                        }
                    },
                    Err(_error) => {
                        // Try FS
                    }
                }
            }

            // Only allow reads if the FS library function is available
            match fs::read(path) {
                Ok(content) => {
                    return self.binary_import(graph, format, Bytes::from(content), node, profile);
                },
                Err(error) => {
                    return Err(Error::FormatFileImportFsError(format!("{}: {}", error.to_string(), path)));
                }
            }
        } else if let Some(_lib) = graph.libfunc(&FS_LIB, "read") {
            // Only allow reads if the FS library function is available
            match fs::read(path) {
                Ok(content) => {
                    return self.binary_import(graph, format, Bytes::from(content), node, profile);
                },
                Err(error) => {
                    return Err(Error::FormatFileImportFsError(format!("{}: {}", error.to_string(), path)));
                }
            }
        }
        Err(Error::FormatFileImportNotAllowed)
    }

    #[allow(unused)]
    /// File export.
    /// Try exporting a string (binary if failed) and write the output to a file located at 'path'.
    fn file_export(&self, graph: &Graph, format: &str, path: &str, node: Option<NodeRef>) -> Result<(), Error> {
        if let Some(_lib) = graph.libfunc(&FS_LIB, "write") {
            // make sure a directory exists at the requested path before writing to it
            let buf = PathBuf::from(path);
            if let Some(path) = buf.parent() {
                let _ = fs::create_dir_all(path);
            }

            match self.string_export(graph, format, node.clone()) {
                Ok(exp_str) => {
                    match fs::write(path, exp_str) {
                        Ok(_) => {
                            return Ok(());
                        },
                        Err(err) => {
                            return Err(Error::FormatFileExportFsError(err.to_string()));
                        }
                    }
                },
                Err(_) => {
                    match self.binary_export(graph, format, node) {
                        Ok(exp_bytes) => {
                            match fs::write(path, exp_bytes) {
                                Ok(_) => {
                                    return Ok(());
                                },
                                Err(err) => {
                                    return Err(Error::FormatFileExportFsError(err.to_string()));        
                                }
                            }
                        },
                        Err(_) => {}
                    }
                }
            }
        }
        Err(Error::FormatFileExportNotAllowed)
    }

    /// Binary import.
    /// By default attempts to get bytes as UTF-8 string and uses string import.
    #[allow(unused)]
    fn binary_import(&self, graph: &mut Graph, format: &str, bytes: Bytes, node: Option<NodeRef>, profile: &Profile) -> Result<(), Error> {
        match std::str::from_utf8(bytes.as_ref()) {
            Ok(src) => {
                self.string_import(graph, format, src, node, profile)
            },
            Err(_error) => {
                Err(Error::FormatBinaryImportUtf8Error)
            }
        }
    }

    /// String export.
    #[allow(unused)]
    fn string_export(&self, graph: &Graph, format: &str, node: Option<NodeRef>) -> Result<String, Error> {
        Err(Error::FormatStringExportNotImplemented(format.into()))
    }

    /// Binary export.
    #[allow(unused)]
    fn binary_export(&self, graph: &Graph, format: &str, node: Option<NodeRef>) -> Result<Bytes, Error> {
        match self.string_export(graph, format, node) {
            Ok(src) => {
                Ok(Bytes::from(src))
            },
            Err(error) => {
                Err(error)
            }
        }
    }

    #[allow(unused)]
    /// Parser import.
    fn parser_import(&self, format: &str, path: &str, context: &mut ParseContext) -> Result<(), Error> {
        let node = context.self_ptr();
        self.file_import(&mut context.graph, format, path, Some(node), &context.profile)
    }
}