/* -------------------------------------------------------------------------
 *  This file is part of the MindStudio project.
 * Copyright (c) 2025 Huawei Technologies Co.,Ltd.
 *
 * MindStudio is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *          http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 * ------------------------------------------------------------------------- */

#ifndef FILE_H
#define FILE_H

#include <fcntl.h>
#include <unistd.h>

#include <fstream>
#include <string>
#include <vector>

#include "ait_logger.h"
#include "const.h"

// File 类主要处理文件相关操作
namespace File
{
// 安全的创建目录
bool CreateDir(const std::string& path, bool recursion = false, mode_t mode = MsConst::NORMAL_DIR_MODE_DEFAULT);
// 文件夹校验：包括路径长度，文件存在性，属组，权限
bool CheckDir(const std::string& path);
// 文件权限校验
bool IsFileReadable(const std::string& path);
bool IsFileWritable(const std::string& path);
bool IsOtherWritable(const std::string& path);
// 文件存在性校验
bool IsPathExist(const std::string& path);
// 校验是否是文件夹
bool IsDir(const std::string& path);
// 校验文件属组
bool CheckOwner(const std::string& path);
// 获取文件父目录
std::string GetParentDir(const std::string& path);
// 获取绝对路径
std::string GetFullPath(const std::string& originPath);
std::string GetAbsPath(const std::string& originPath);
// 获取文件大小
size_t GetFileSize(const std::string& path);
// 路径长度校验
bool IsPathLengthLegal(const std::string& path);
// 路径字符校验
bool IsPathCharactersValid(const std::string& path);
// 路径深度校验
bool IsPathDepthValid(const std::string& path);
// 常规文件校验
bool IsRegularFile(const std::string& path);
// 获取文件名
std::string GetFileName(const std::string& path);
// 获取文件权限
mode_t GetPathPermissions(const std::string& path);
// 获取文件后缀
std::string GetFileSuffix(const std::string& path);
// 校验文件后缀和内容长度
bool CheckFileSuffixAndSize(const std::string& path, MsConst::SUFFIX type, const size_t maxSize);
// 读文件前的校验
bool CheckFileBeforeRead(const std::string& path, MsConst::SUFFIX type, const size_t maxSize);
bool CheckFileBeforeCreateOrWrite(const std::string& path, bool overwrite = false);
bool CheckConfigFile(const std::string& absPath, const size_t maxSize = MsConst::MAX_JSON_SIZE);
bool WriteTextToFile(const std::string& filePath, const std::string& textContent);
};  // namespace File
#endif  // FILE_H