package com.bonus.file.service;

import com.bonus.file.entity.FileDetails;
import com.bonus.system.api.domain.SysFile;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.util.List;
import java.util.Set;

/**
 * 文件上传接口
 * 
 * @author bonus
 */
public interface ISysFileService
{
    /**
     * 文件上传接口
     * 
     * @param file 上传的文件
     * @return 访问地址
     * @throws Exception
     */
    public SysFile uploadFile(MultipartFile file) throws Exception;

    /**
     * 文件上传接口
     *
     * @param files 上传的文件
     * @return 访问地址
     * @throws Exception
     */
    public List<SysFile> uploadFiles(MultipartFile[] files) throws Exception;

    /**
     * 从给定的URL下载文件并将其保存到指定的目标位置。
     *
     * @param urlStr 要下载文件的URL地址。
     * @param response 请求响应。
     * @throws Exception 如果在下载过程中遇到任何异常，例如网络问题、文件写入问题等。
     */
    public void downloadFile(HttpServletResponse response, String urlStr) throws Exception;

    public String getFullFileUrl(String urlStr) throws Exception;


    /**
     * 从给定的URL下载文件并将其保存到指定的目标位置。
     *
     * @param urlStr 要下载文件的URL地址。
     * @param response 请求响应。
     * @throws Exception 如果在下载过程中遇到任何异常，例如网络问题、文件写入问题等。
     */
    public void downloadFilesAsZip(HttpServletResponse response, List<String> urlStr) throws Exception;

    /**
     * 删除指定URL所指向的文件。
     *
     * @param urlStr 要删除文件的URL地址。
     * @return 布尔值，指示文件删除是否成功。如果文件被成功删除，则返回true；否则返回false。
     * @throws Exception 如果在删除文件的过程中遇到错误，例如网络问题、文件不存在或没有删除权限等。
     */
    public void deleteFile(String urlStr) throws Exception;


    /**
     * 删除指定URL所指向的文件。
     *
     * @param urlStr 要删除文件的URL地址。
     * @return 布尔值，指示文件删除是否成功。如果文件被成功删除，则返回true；否则返回false。
     * @throws Exception 如果在删除文件的过程中遇到错误，例如网络问题、文件不存在或没有删除权限等。
     */
    public void deleteFiles(List<String> urlStr) throws Exception;


    /**
     * 获取指定文件夹下的所有文件夹和文件。
     *
     * @param folderPath 要获取文件夹和文件的父文件夹路径（例如 "folder1/"）
     * @return 返回一个包含所有文件夹和文件路径的集合
     */
    public Set<FileDetails> getFilesAndSubfolders(String folderPath);

    /**
     * 创建文件夹（通过上传带有路径的文件）
     *
     * @param folderPath 文件夹路径（例如 "folder1/subfolder/"）
     */
    public void createFolder(String folderPath);


    /**
     * 删除指定路径的所有对象，从而删除“文件夹”。
     *
     * @param folderPath 文件夹路径（例如 "folder1/subfolder/"）
     */
    public void deleteFolder(String folderPath);
}
