/*
 * WorkflowPackage.h
 *
 *  Created on: 2013-11-27
 *      Author: dev
 */

#ifndef PAI_FRAME_WORKFLOWVIEW_WORKFLOWPACKAGE_H
#define PAI_FRAME_WORKFLOWVIEW_WORKFLOWPACKAGE_H

#include <QString>
#include <QStringList>

namespace pai
{

/**
 * @class WorkflowPackage
 * @brief Workflow import/export helper class
 */
class WorkflowPackage
{
public:
    WorkflowPackage();
    virtual ~WorkflowPackage();

    /**
     * @brief 判断文件是否可读
     * @return 文件可读返回true，文件不可读返回false
     */
    bool CanRead(const QString &path);

    /**
     * @brief 判断文件是否可写
     * @return 文件可写返回true，文件不可写返回false
     */
    bool CanWrite(const QString &path);

    /**
     * @brief 判断文件是否存在
     * @return 文件存在返回true，文件不存在返回false
     */
    bool Exists(const QString &path);

    /**
     * @brief 判断是否是一个目录
     * @return 是目录返回true，不是目录返回false
     */
    bool IsDirectory(const QString &path);

    /**
     * @brief 判断是否是一个文件
     * @return 是文件返回true，不是文件返回false
     */
    bool IsFile(const QString &path);

    /**
     * @brief 创建文件指定目录
     * @return 创建成功返回 true
     */
    bool Mkdir(const QString &path, QString &msg);

    /**
     * @brief 创建文件目录包括创建必需但不存在的父目录
     * @return 创建成功返回 true
     */
    bool Mkdirs(const QString &path, QString &msg);

    /**
     * @brief 删除指定文件
     * @return 删除成功返回true，删除失败返回false
     */
    bool Delete(const QString &path, QString &msg);

    /**
     * @brief 文件更名
     * @param[in] oldPath旧文件名
     * @param[in] newPath新文件名
     * @return
     */
    bool Rename(const QString& oldPath, const QString& newPath);

    /**
     * @brief 获取符合过滤器的文件和目录列表
     * @param[in] filter 条件过滤器
     * @param[out] files 文件名列表
     */
    int ListFiles(const QString &path, const QString& filter, QList<QString>& files);

    /**
     * @brief 删除文件目录
     * @return 删除成功返回 true
     */
    bool Rmdir(const QString &dirName);

    /**
     * @brief 压缩文件到制定目录
     */
    bool ZipPackage(const QString &targetDir, const QString &targetName, const QStringList &srcFiles, QString &msg);

    /**
     * @brief 解压缩文件到制定目录
     */
    bool UnZipPackage(const QString &pkgPath, const QString &unzipPath, QString &msg);
};

}
#endif