filemanager.cpp

/*
 
Pencil2D - Traditional Animation Software
Copyright (C) 2005-2007 Patrick Corrieri & Pascal Naidon
Copyright (C) 2012-2020 Matthew Chiawen Chang
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; version 2 of the License.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
*/
 
#include "filemanager.h"
 
#include <ctime>
#include <QDir>
#include <QVersionNumber>
#include "qminiz.h"
#include "fileformat.h"
#include "object.h"
#include "layercamera.h"
#include "util.h"
 
FileManager::FileManager(QObject* parent) : QObject(parent)
{
    srand(static_cast<uint>(time(nullptr)));
}
 
Object* FileManager::load(const QString& sFileName)
{
    DebugDetails dd;
    dd << "\n[Project LOAD diagnostics]\n";
    dd << QString("File name: ").append(sFileName);
    if (!QFile::exists(sFileName))
    {
        handleOpenProjectError(Status::FILE_NOT_FOUND, dd);
        return nullptr;
    }
 
    progressForward();
 
    std::unique_ptr<Object> obj(new Object);
    obj->setFilePath(sFileName);
    obj->createWorkingDir();
 
    QString strMainXMLFile = QDir(obj->workingDir()).filePath(PFF_XML_FILE_NAME);
    QString strDataFolder = QDir(obj->workingDir()).filePath(PFF_DATA_DIR);
 
    // Test file format: new zipped .pclx or old .pcl?
    bool isArchive = isArchiveFormat(sFileName);
 
    QString fileFormat = "Project format: %1";
    if (!isArchive)
    {
        dd << fileFormat.arg(".pcl");
 
        if (!QFile::copy(sFileName, strMainXMLFile))
        {
            dd << "Failed to copy main xml file";
        }
        Status st = copyDir(sFileName + "." + PFF_OLD_DATA_DIR, strDataFolder);
        if (!st.ok())
        {
            dd.collect(st.details());
        }
    }
    else
    {
        QString workingDirPath = obj->workingDir();
 
        dd << QString("Working dir: %1").arg(workingDirPath);
        dd << fileFormat.arg(".pclx");
 
        Status sanityCheck = MiniZ::sanityCheck(sFileName);
 
        // Let's check if we can read the file before we try to unzip.
        if (!sanityCheck.ok()) {
            dd.collect(sanityCheck.details());
            dd << "\nError: Unable to extract project, miniz sanity check failed.";
            handleOpenProjectError(Status::ERROR_INVALID_XML_FILE, dd);
            return nullptr;
        } else {
            Status unzipStatus = unzip(sFileName, workingDirPath);
            dd.collect(unzipStatus.details());
 
            if(unzipStatus.ok()) {
                dd << QString("Unzipped at: %1 ").arg(workingDirPath);
            } else {
                dd << QString("Error: Unzipping failed: %1 ").arg(workingDirPath);
                handleOpenProjectError(Status::ERROR_INVALID_XML_FILE, dd);
                return nullptr;
            }
        }
    }
 
    obj->setDataDir(strDataFolder);
    obj->setMainXMLFile(strMainXMLFile);
 
    int totalFileCount = QDir(strDataFolder).entryList(QDir::Files).size();
    mMaxProgressValue = totalFileCount;
    emit progressRangeChanged(mMaxProgressValue);
 
    QFile file(strMainXMLFile);
    if (!file.exists())
    {
        dd << "Error: No main XML exists!";
        handleOpenProjectError(Status::ERROR_INVALID_XML_FILE, dd);
        return nullptr;
    }
    if (!file.open(QFile::ReadOnly))
    {
        dd << "Error: Main XML file is read only!";
        handleOpenProjectError(Status::ERROR_FILE_CANNOT_OPEN, dd);
        return nullptr;
    }
 
    dd << "Main XML exists: Yes";
 
    QDomDocument xmlDoc;
    if (!xmlDoc.setContent(&file))
    {
        FILEMANAGER_LOG("Couldn't open the main XML file");
        dd << "Error: Unable to parse or open the main XML file";
        handleOpenProjectError(Status::ERROR_INVALID_XML_FILE, dd);
        return nullptr;
    }
 
    QDomDocumentType type = xmlDoc.doctype();
    if (!(type.name() == "PencilDocument" || type.name() == "MyObject"))
    {
        FILEMANAGER_LOG("Invalid main XML doctype");
        dd << QString("Error: Invalid main XML doctype: ").append(type.name());
        handleOpenProjectError(Status::ERROR_INVALID_PENCIL_FILE, dd);
        return nullptr;
    }
 
    QDomElement root = xmlDoc.documentElement();
    if (root.isNull())
    {
        dd << "Error: Main XML root node is null";
        handleOpenProjectError(Status::ERROR_INVALID_PENCIL_FILE, dd);
        return nullptr;
    }
 
    loadPalette(obj.get());
 
    bool ok = true;
 
    if (root.tagName() == "document")
    {
        ok = loadObject(obj.get(), root);
    }
    else if (root.tagName() == "object" || root.tagName() == "MyOject") // old Pencil format (<=0.4.3)
    {
        ok = loadObjectOldWay(obj.get(), root);
    }
 
    if (!ok)
    {
        obj.reset();
        dd << "Error: Issue occurred during object loading";
        handleOpenProjectError(Status::ERROR_INVALID_PENCIL_FILE, dd);
        return nullptr;
    }
 
    verifyObject(obj.get());
 
    return obj.release();
}
 
bool FileManager::loadObject(Object* object, const QDomElement& root)
{
    QDomElement e = root.firstChildElement("object");
    if (e.isNull())
        return false;
 
    bool ok = true;
    for (QDomNode node = root.firstChild(); !node.isNull(); node = node.nextSibling())
    {
        QDomElement element = node.toElement(); // try to convert the node to an element.
        if (element.isNull())
        {
            continue;
        }
 
        if (element.tagName() == "object")
        {
            ok = object->loadXML(element, [this]{ progressForward(); });
            if (!ok) FILEMANAGER_LOG("Failed to Load object");
 
        }
        else if (element.tagName() == "editor" || element.tagName() == "projectdata")
        {
            object->setData(loadProjectData(element));
        }
        else if (element.tagName() == "version")
        {
            QVersionNumber fileVersion = QVersionNumber::fromString(element.text());
            QVersionNumber appVersion = QVersionNumber::fromString(APP_VERSION);
 
            if (!fileVersion.isNull())
            {
                if (appVersion < fileVersion)
                {
                    qWarning() << "You are opening a newer project file in an older version of Pencil2D!";
                }
            }
        }
        else
        {
            Q_ASSERT(false);
        }
    }
    return ok;
}
 
bool FileManager::loadObjectOldWay(Object* object, const QDomElement& root)
{
    return object->loadXML(root, [this] { progressForward(); });
}
 
bool FileManager::isArchiveFormat(const QString& fileName) const
{
    if (QFileInfo(fileName).suffix().compare(PFF_BIG_LETTER_EXTENSION, Qt::CaseInsensitive) != 0) {
        return false;
    }
    return true;
}
 
Status FileManager::save(const Object* object, const QString& sFileName)
{
    DebugDetails dd;
    dd << "\n[Project SAVE diagnostics]\n";
    dd << ("file name:" + sFileName);
 
    if (object == nullptr)
    {
        dd << "Error: Object parameter is null";
        return Status(Status::INVALID_ARGUMENT, dd);
    }
    if (sFileName.isEmpty()) {
        dd << "Error: File name is empty, unable to save.";
        return Status(Status::INVALID_ARGUMENT, dd,
                      tr("Invalid Save Path"),
                      tr("The path is empty."));
    }
 
    const int totalCount = object->totalKeyFrameCount();
    mMaxProgressValue = totalCount + 5;
    emit progressRangeChanged(mMaxProgressValue);
 
    progressForward();
 
    QFileInfo fileInfo(sFileName);
    if (fileInfo.isDir())
    {
        dd << "Error: File name must point to a file, not a directory.";
        return Status(Status::INVALID_ARGUMENT, dd,
                      tr("Invalid Save Path"),
                      tr("The path (\"%1\") points to a directory.").arg(fileInfo.absoluteFilePath()));
    }
    QFileInfo parentDirInfo(fileInfo.dir().absolutePath());
    if (!parentDirInfo.exists())
    {
        dd << QString("Error: The parent directory of %1 does not exist").arg(sFileName);
        return Status(Status::INVALID_ARGUMENT, dd,
                      tr("Invalid Save Path"),
                      tr("The directory (\"%1\") does not exist.").arg(parentDirInfo.absoluteFilePath()));
    }
    if ((fileInfo.exists() && !fileInfo.isWritable()) || !parentDirInfo.isWritable())
    {
        dd << "Error: File name points to a location that is not writable";
        return Status(Status::INVALID_ARGUMENT, dd,
                      tr("Invalid Save Path"),
                      tr("The path (\"%1\") is not writable.").arg(fileInfo.absoluteFilePath()));
    }
 
    QString sTempWorkingFolder;
    QString sMainXMLFile;
    QString sDataFolder;
 
    QString fileFormat = QString("Project format: %1");
    bool isArchive = isArchiveFormat(sFileName);
    if (!isArchive)
    {
        dd << fileFormat.arg(".pcl");
 
        sMainXMLFile = sFileName;
        sDataFolder = sMainXMLFile + "." + PFF_OLD_DATA_DIR;
    }
    else
    {
        sTempWorkingFolder = object->workingDir();
 
        dd << QString("Working dir: %1").arg(sTempWorkingFolder);
        dd << fileFormat.arg(".pclx");
 
        Q_ASSERT(QDir(sTempWorkingFolder).exists());
 
        sMainXMLFile = QDir(sTempWorkingFolder).filePath(PFF_XML_FILE_NAME);
        sDataFolder = QDir(sTempWorkingFolder).filePath(PFF_OLD_DATA_DIR);
    }
 
    QFileInfo dataInfo(sDataFolder);
    if (!dataInfo.exists())
    {
        QDir dir(sDataFolder); // the directory where all key frames will be saved
 
        if (!dir.mkpath(sDataFolder))
        {
            dd << QString("Error: Unable to create data directory, tried to save to: %1").arg(dir.absolutePath());
            return Status(Status::FAIL, dd,
                          tr("Cannot Create Data Directory"),
                          tr("Failed to create directory \"%1\". Please make sure you have sufficient permissions.").arg(sDataFolder));
        }
    }
    if (!dataInfo.isDir())
    {
        dd << QString("Error: Expected data to be a directory but found %1 instead").arg(dataInfo.absoluteFilePath());
        return Status(Status::FAIL,
                      dd,
                      tr("Cannot Create Data Directory"),
                      tr("\"%1\" is a file. Please delete the file and try again.").arg(dataInfo.absoluteFilePath()));
    }
 
    QStringList filesToZip; // A files list in the working folder needs to be zipped
    Status stKeyFrames = writeKeyFrameFiles(object, sDataFolder, filesToZip);
    dd.collect(stKeyFrames.details());
 
    Status stMainXml = writeMainXml(object, sMainXMLFile, filesToZip);
    dd.collect(stMainXml.details());
 
    Status stPalette = writePalette(object, sDataFolder, filesToZip);
    dd.collect(stPalette.details());
 
    const bool saveOk = stKeyFrames.ok() && stMainXml.ok() && stPalette.ok();
 
    progressForward();
 
    if (isArchive)
    {
        dd << "\n[Archiving diagnostics]\n";
        QString sBackupFile = backupPreviousFile(sFileName);
 
        if (!sBackupFile.isEmpty()) {
            dd << QString("\nNote: A backup has been made here: %1").arg(sBackupFile);
        }
 
        if (!saveOk) {
            return Status(Status::FAIL, dd,
                          tr("Internal Error"),
                          tr("An internal error occurred. The project could not be saved."));
        }
 
        dd << "Miniz: Zipping...";
        Status stMiniz = MiniZ::compressFolder(sFileName, sTempWorkingFolder, filesToZip, "application/x-pencil2d-pclx");
        if (!stMiniz.ok())
        {
            dd.collect(stMiniz.details());
            dd << "\nError: Miniz failed to zip project";
            return Status(Status::ERROR_MINIZ_FAIL, dd,
                          tr("Miniz Error"),
                          tr("An internal error occurred. The project may not have been saved successfully."));
        }
        dd << "Miniz: Zip file saved successfully";
        Q_ASSERT(stMiniz.ok());
 
        if (saveOk) {
            dd << "Project saved successfully, deleting backup";
            deleteBackupFile(sBackupFile);
        }
    }
 
    progressForward();
 
    if (!saveOk)
    {
        return Status(Status::FAIL, dd,
                      tr("Internal Error"),
                      tr("An internal error occurred. The project may not have been saved successfully."));
    }
 
    return Status::OK;
}
 
Status FileManager::writeToWorkingFolder(const Object* object)
{
    DebugDetails dd;
 
    QStringList filesWritten;
 
    const QString dataFolder = object->dataDir();
    const QString mainXml = object->mainXMLFile();
 
    Status stKeyFrames = writeKeyFrameFiles(object, dataFolder, filesWritten);
    dd.collect(stKeyFrames.details());
 
    Status stMainXml = writeMainXml(object, mainXml, filesWritten);
    dd.collect(stMainXml.details());
 
    Status stPalette = writePalette(object, dataFolder, filesWritten);
    dd.collect(stPalette.details());
 
    const bool saveOk = stKeyFrames.ok() && stMainXml.ok() && stPalette.ok();
    const auto errorCode = (saveOk) ? Status::OK : Status::FAIL;
    return Status(errorCode, dd);
}
 
ObjectData FileManager::loadProjectData(const QDomElement& docElem)
{
    ObjectData data;
    if (docElem.isNull())
    {
        return data;
    }
 
    QDomNode tag = docElem.firstChild();
 
    while (!tag.isNull())
    {
        QDomElement element = tag.toElement(); // try to convert the node to an element.
        if (element.isNull())
        {
            continue;
        }
 
        extractProjectData(element, data);
 
        tag = tag.nextSibling();
    }
    return data;
}
 
QDomElement FileManager::saveProjectData(const ObjectData* data, QDomDocument& xmlDoc)
{
    QDomElement rootTag = xmlDoc.createElement("projectdata");
 
    // Current Frame
    QDomElement currentFrameTag = xmlDoc.createElement("currentFrame");
    currentFrameTag.setAttribute("value", data->getCurrentFrame());
    rootTag.appendChild(currentFrameTag);
 
    // Current Color
    QDomElement currentColorTag = xmlDoc.createElement("currentColor");
    QColor color = data->getCurrentColor();
    currentColorTag.setAttribute("r", color.red());
    currentColorTag.setAttribute("g", color.green());
    currentColorTag.setAttribute("b", color.blue());
    currentColorTag.setAttribute("a", color.alpha());
    rootTag.appendChild(currentColorTag);
 
    // Current Layer
    QDomElement currentLayerTag = xmlDoc.createElement("currentLayer");
    currentLayerTag.setAttribute("value", data->getCurrentLayer());
    rootTag.appendChild(currentLayerTag);
 
    // Current View
    QDomElement currentViewTag = xmlDoc.createElement("currentView");
    QTransform view = data->getCurrentView();
    currentViewTag.setAttribute("m11", view.m11());
    currentViewTag.setAttribute("m12", view.m12());
    currentViewTag.setAttribute("m21", view.m21());
    currentViewTag.setAttribute("m22", view.m22());
    currentViewTag.setAttribute("dx", view.dx());
    currentViewTag.setAttribute("dy", view.dy());
    rootTag.appendChild(currentViewTag);
 
    // Fps
    QDomElement fpsTag = xmlDoc.createElement("fps");
    fpsTag.setAttribute("value", data->getFrameRate());
    rootTag.appendChild(fpsTag);
 
    // Current Layer
    QDomElement tagIsLoop = xmlDoc.createElement("isLoop");
    tagIsLoop.setAttribute("value", data->isLooping() ? "true" : "false");
    rootTag.appendChild(tagIsLoop);
 
    QDomElement tagRangedPlayback = xmlDoc.createElement("isRangedPlayback");
    tagRangedPlayback.setAttribute("value", data->isRangedPlayback() ? "true" : "false");
    rootTag.appendChild(tagRangedPlayback);
 
    QDomElement tagMarkInFrame = xmlDoc.createElement("markInFrame");
    tagMarkInFrame.setAttribute("value", data->getMarkInFrameNumber());
    rootTag.appendChild(tagMarkInFrame);
 
    QDomElement tagMarkOutFrame = xmlDoc.createElement("markOutFrame");
    tagMarkOutFrame.setAttribute("value", data->getMarkOutFrameNumber());
    rootTag.appendChild(tagMarkOutFrame);
 
    return rootTag;
}
 
void FileManager::extractProjectData(const QDomElement& element, ObjectData& data)
{
    QString strName = element.tagName();
    if (strName == "currentFrame")
    {
        data.setCurrentFrame(element.attribute("value").toInt());
    }
    else  if (strName == "currentColor")
    {
        int r = element.attribute("r", "255").toInt();
        int g = element.attribute("g", "255").toInt();
        int b = element.attribute("b", "255").toInt();
        int a = element.attribute("a", "255").toInt();
 
        data.setCurrentColor(QColor(r, g, b, a));
    }
    else if (strName == "currentLayer")
    {
        data.setCurrentLayer(element.attribute("value", "0").toInt());
    }
    else if (strName == "currentView")
    {
        double m11 = element.attribute("m11", "1").toDouble();
        double m12 = element.attribute("m12", "0").toDouble();
        double m21 = element.attribute("m21", "0").toDouble();
        double m22 = element.attribute("m22", "1").toDouble();
        double dx = element.attribute("dx", "0").toDouble();
        double dy = element.attribute("dy", "0").toDouble();
 
        data.setCurrentView(QTransform(m11, m12, m21, m22, dx, dy));
    }
    else if (strName == "fps" || strName == "currentFps")
    {
        data.setFrameRate(element.attribute("value", "12").toInt());
    }
    else if (strName == "isLoop")
    {
        data.setLooping(element.attribute("value", "false") == "true");
    }
    else if (strName == "isRangedPlayback")
    {
        data.setRangedPlayback((element.attribute("value", "false") == "true"));
    }
    else if (strName == "markInFrame")
    {
        data.setMarkInFrameNumber(element.attribute("value", "0").toInt());
    }
    else if (strName == "markOutFrame")
    {
        data.setMarkOutFrameNumber(element.attribute("value", "15").toInt());
    }
}
 
void FileManager::handleOpenProjectError(Status::ErrorCode error, const DebugDetails& dd)
{
    QString title = tr("Could not open file");
    QString errorDesc;
    QString contactLinks = "<ul>"
        "<li><a href=\"https://discuss.pencil2d.org/c/bugs\">Pencil2D Forum</a></li>"
        "<li><a href=\"https://github.com/pencil2d/pencil/issues/new\">Github</a></li>"
        "<li><a href=\"https://discord.gg/8FxdV2g\">Discord<\a></li>"
        "</ul>";
 
    if (error == Status::FILE_NOT_FOUND)
    {
        errorDesc = tr("The file does not exist, so we are unable to open it."
                       "Please check to make sure the path is correct and try again.");
    }
    else if (error == Status::ERROR_FILE_CANNOT_OPEN)
    {
        errorDesc = tr("No permission to read the file. "
                       "Please check you have read permissions for this file and try again.");
    }
    else
    {
        // other cases
        errorDesc = tr("There was an error processing your file. "
            "This usually means that your project has been at least partially corrupted. "
            "Try again with a newer version of Pencil2D, "
            "or try to use a backup file if you have one. "
            "If you contact us through one of our official channels we may be able to help you."
            "For reporting issues, the best places to reach us are:");
    }
 
    mError = Status(error, dd, title, errorDesc + contactLinks);
    removePFFTmpDirectory(mstrLastTempFolder);
}
 
int FileManager::countExistingBackups(const QString& fileName) const
{
    QFileInfo fileInfo(fileName);
    QDir directory(fileInfo.absoluteDir());
    const QString& baseFileName = fileInfo.completeBaseName();
 
    int backupCount = 0;
    for (const QFileInfo &dirFileInfo : directory.entryInfoList(QDir::Filter::Files)) {
        QString searchFileAbsPath = dirFileInfo.absoluteFilePath();
        QString searchFileName = dirFileInfo.baseName();
 
        bool sameBaseName = baseFileName.compare(searchFileName) == 0;
        if (sameBaseName && searchFileAbsPath.contains(PFF_BACKUP_IDENTIFIER)) {
            backupCount++;
        }
    }
 
    return backupCount;
}
 
QString FileManager::backupPreviousFile(const QString& fileName)
{
    if (!QFile::exists(fileName))
        return "";
 
    QFileInfo fileInfo(fileName);
    QString baseName = fileInfo.completeBaseName();
 
    int backupCount = countExistingBackups(fileName) + 1; // start index 1
    QString countStr = QString::number(backupCount);
 
    QString sBackupFile = baseName + "." + PFF_BACKUP_IDENTIFIER + countStr + "." + fileInfo.suffix();
    QString sBackupFileFullPath = QDir(fileInfo.absolutePath()).filePath(sBackupFile);
 
    bool ok = QFile::copy(fileInfo.absoluteFilePath(), sBackupFileFullPath);
    if (!ok)
    {
        FILEMANAGER_LOG("Cannot backup the previous file");
        return "";
    }
    return sBackupFileFullPath;
}
 
void FileManager::deleteBackupFile(const QString& fileName)
{
    if (QFile::exists(fileName))
    {
        QFile::remove(fileName);
    }
}
 
void FileManager::progressForward()
{
    mCurrentProgress++;
    emit progressChanged(mCurrentProgress);
}
 
bool FileManager::loadPalette(Object* obj)
{
    FILEMANAGER_LOG("Load Palette..");
 
    QString paletteFilePath = validateDataPath(PFF_PALETTE_FILE, obj->dataDir());
    if (paletteFilePath.isEmpty() || !obj->importPalette(paletteFilePath))
    {
        obj->loadDefaultPalette();
    }
    return true;
}
 
Status FileManager::writeKeyFrameFiles(const Object* object, const QString& dataFolder, QStringList& filesFlushed)
{
    DebugDetails dd;
    dd << "\n[Keyframes WRITE diagnostics]\n";
 
    const int numLayers = object->getLayerCount();
    dd << QString("Total layer count: %1").arg(numLayers);
 
    for (int i = 0; i < numLayers; ++i)
    {
        Layer* layer = object->getLayer(i);
        layer->presave(dataFolder);
    }
 
    bool saveLayersOK = true;
    for (int i = 0; i < numLayers; ++i)
    {
        Layer* layer = object->getLayer(i);
 
        dd << QString("Layer[%1] = [id=%2, type=%3, name=%4]").arg(i).arg(layer->id()).arg(layer->type()).arg(layer->name());
 
        Status st = layer->save(dataFolder, filesFlushed, [this] { progressForward(); });
        if (!st.ok())
        {
            saveLayersOK = false;
            dd.collect(st.details());
            dd << QString("\nError: Failed to save Layer[%1] %2").arg(i).arg(layer->name());
        }
    }
 
    progressForward();
 
    auto errorCode = (saveLayersOK) ? Status::OK : Status::FAIL;
 
    if (saveLayersOK) {
        dd << "\nAll Layers saved";
    } else {
        dd << "\nError: Unable to save all layers";
    }
 
    return Status(errorCode, dd);
}
 
Status FileManager::writeMainXml(const Object* object, const QString& mainXmlPath, QStringList& filesWritten)
{
    DebugDetails dd;
    dd << "\n[XML WRITE diagnostics]\n";
 
    QFile file(mainXmlPath);
    if (!file.open(QFile::WriteOnly | QFile::Text))
    {
        dd << QString("Error: Failed to open Main XML at: %1, \nReason: %2").arg(mainXmlPath).arg(file.errorString());
        return Status(Status::ERROR_FILE_CANNOT_OPEN, dd);
    }
    ScopeGuard fileScopeGuard([&] {
        file.close();
    });
 
    QDomDocument xmlDoc("PencilDocument");
    QDomElement root = xmlDoc.createElement("document");
    QDomProcessingInstruction encoding = xmlDoc.createProcessingInstruction("xml", "version=\"1.0\" encoding=\"UTF-8\"");
    xmlDoc.appendChild(encoding);
    xmlDoc.appendChild(root);
 
    progressForward();
 
    // save editor information
    QDomElement projDataXml = saveProjectData(object->data(), xmlDoc);
    root.appendChild(projDataXml);
 
    // save object
    QDomElement objectElement = object->saveXML(xmlDoc);
    root.appendChild(objectElement);
 
    // save Pencil2D version
    QDomElement versionElem = xmlDoc.createElement("version");
    versionElem.appendChild(xmlDoc.createTextNode(QString(APP_VERSION)));
    root.appendChild(versionElem);
 
    dd << "Writing main xml file...";
 
    const int indentSize = 2;
 
    QTextStream out(&file);
    xmlDoc.save(out, indentSize);
    out.flush();
 
    dd << "Done writing main xml file: " << mainXmlPath;
 
    filesWritten.append(mainXmlPath);
    return Status(Status::OK, dd);
}
 
Status FileManager::writePalette(const Object* object, const QString& dataFolder, QStringList& filesWritten)
{
    const QString paletteFile = object->savePalette(dataFolder);
    if (paletteFile.isEmpty())
    {
        DebugDetails dd;
        dd << "\nError: Failed to save palette";
        return Status(Status::FAIL, dd);
    }
    filesWritten.append(paletteFile);
    return Status::OK;
}
 
Status FileManager::copyDir(const QDir src, const QDir dst)
{
    if (!src.exists()) return Status::FILE_NOT_FOUND;
 
    DebugDetails dd;
    bool isOkay = true;
 
    if (!dst.mkpath(dst.absolutePath()))
    {
        dd << ("Failed to create target directory: " + dst.absolutePath());
        return Status(Status::FAIL, dd);
    }
 
    foreach (QString dirName, src.entryList(QDir::Dirs | QDir::NoDotAndDotDot))
    {
        Status st = copyDir(src.filePath(dirName), dst.filePath(dirName));
        if (!st.ok())
        {
            isOkay = false;
            dd.collect(st.details());
        }
    }
 
    foreach (QString fileName, src.entryList(QDir::Files))
    {
        if (!QFile::copy(src.filePath(fileName), dst.filePath(fileName)))
        {
            isOkay = false;
            dd << "Failed to copy file"
               << ("Source path: " + src.filePath(fileName))
               << ("Destination path: " + dst.filePath(fileName));
        }
    }
 
    if (isOkay)
    {
        return Status::OK;
    }
    else
    {
        return Status(Status::FAIL, dd);
    }
}
 
Status FileManager::unzip(const QString& strZipFile, const QString& strUnzipTarget)
{
    // removes the previous directory first  - better approach
    removePFFTmpDirectory(strUnzipTarget);
 
    Status s = MiniZ::uncompressFolder(strZipFile, strUnzipTarget);
    Q_ASSERT(s.ok());
 
    mstrLastTempFolder = strUnzipTarget;
    return s;
}
 
QList<ColorRef> FileManager::loadPaletteFile(QString strFilename)
{
    QFileInfo fileInfo(strFilename);
    if (!fileInfo.exists())
    {
        return QList<ColorRef>();
    }
 
    // TODO: Load Palette.
    return QList<ColorRef>();
}
 
Status FileManager::verifyObject(Object* obj)
{
    // check current layer.
    int curLayer = obj->data()->getCurrentLayer();
    int maxLayer = obj->getLayerCount();
    if (curLayer >= maxLayer)
    {
        obj->data()->setCurrentLayer(maxLayer - 1);
    }
 
    // Must have at least 1 camera layer
    std::vector<LayerCamera*> camLayers = obj->getLayersByType<LayerCamera>();
    if (camLayers.empty())
    {
        obj->addNewCameraLayer();
    }
    return Status::OK;
}
 
QStringList FileManager::searchForUnsavedProjects()
{
    QDir pencil2DTempDir = QDir::temp();
    bool folderExists = pencil2DTempDir.cd("Pencil2D");
    if (!folderExists)
    {
        return QStringList();
    }
 
    const QStringList nameFilter("*_" PFF_TMP_DECOMPRESS_EXT "_*"); // match name pattern like "Default_Y2xD_0a4e44e9"
    QStringList entries = pencil2DTempDir.entryList(nameFilter, QDir::Dirs | QDir::Readable);
 
    QStringList recoverables;
    for (const QString& path : entries)
    {
        QString fullPath = pencil2DTempDir.filePath(path);
        if (isProjectRecoverable(fullPath))
        {
            qDebug() << "Found debris at" << fullPath;
            recoverables.append(fullPath);
        }
    }
    return recoverables;
}
 
bool FileManager::isProjectRecoverable(const QString& projectFolder)
{
    QDir dir(projectFolder);
    if (!dir.exists()) { return false; }
 
    // There must be a subfolder called "data"
    if (!dir.exists("data")) { return false; }
 
    bool ok = dir.cd("data");
    Q_ASSERT(ok);
 
    QStringList nameFiler;
    nameFiler << "*.png" << "*.vec" << "*.xml";
    QStringList entries = dir.entryList(nameFiler, QDir::Files);
 
    return (entries.size() > 0);
}
 
Object* FileManager::recoverUnsavedProject(QString intermeidatePath)
{
    qDebug() << "TODO: recover project" << intermeidatePath;
 
    QDir projectDir(intermeidatePath);
    const QString mainXMLPath = projectDir.filePath(PFF_XML_FILE_NAME);
    const QString dataFolder = projectDir.filePath(PFF_DATA_DIR);
 
    std::unique_ptr<Object> object(new Object);
    object->setWorkingDir(intermeidatePath);
    object->setMainXMLFile(mainXMLPath);
    object->setDataDir(dataFolder);
 
    Status st = recoverObject(object.get());
    if (!st.ok())
    {
        mError = st;
        return nullptr;
    }
    // Transfer ownership to the caller
    return object.release();
}
 
Status FileManager::recoverObject(Object* object)
{
    // Check whether the main.xml is fine, if not we should make a valid one.
    bool mainXmlOK = true;
 
    QFile file(object->mainXMLFile());
    mainXmlOK &= file.exists();
    mainXmlOK &= file.open(QFile::ReadOnly);
    file.close();
 
    QDomDocument xmlDoc;
    mainXmlOK &= !!xmlDoc.setContent(&file);
 
    QDomDocumentType type = xmlDoc.doctype();
    mainXmlOK &= (type.name() == "PencilDocument" || type.name() == "MyObject");
 
    QDomElement root = xmlDoc.documentElement();
    mainXmlOK &= (!root.isNull());
 
    QDomElement objectTag = root.firstChildElement("object");
    mainXmlOK &= (!objectTag.isNull());
 
    if (mainXmlOK == false)
    {
        // the main.xml is broken, try to rebuild one
        rebuildMainXML(object);
 
        // Load the newly built main.xml
        QFile file(object->mainXMLFile());
        file.open(QFile::ReadOnly);
        xmlDoc.setContent(&file);
        root = xmlDoc.documentElement();
        objectTag = root.firstChildElement("object");
    }
    loadPalette(object);
 
    bool ok = loadObject(object, root);
    verifyObject(object);
 
    return ok ? Status::OK : Status::FAIL;
}
 
Status FileManager::rebuildMainXML(Object* object)
{
    QDir dataDir(object->dataDir());
 
    QStringList nameFiler;
    nameFiler << "*.png" << "*.vec";
    const QStringList entries = dataDir.entryList(nameFiler, QDir::Files | QDir::Readable, QDir::Name);
 
    QMap<int, QStringList> keyFrameGroups;
 
    // grouping keyframe files by layers
    for (const QString& s : entries)
    {
        int layerIndex = layerIndexFromFilename(s);
        if (layerIndex > 0)
        {
            keyFrameGroups[layerIndex].append(s);
        }
    }
 
    // build the new main XML file
    const QString mainXMLPath = object->mainXMLFile();
    QFile file(mainXMLPath);
    if (!file.open(QFile::WriteOnly | QFile::Text))
    {
        return Status::ERROR_FILE_CANNOT_OPEN;
    }
 
    QDomDocument xmlDoc("PencilDocument");
    QDomElement root = xmlDoc.createElement("document");
    QDomProcessingInstruction encoding = xmlDoc.createProcessingInstruction("xml", "version=\"1.0\" encoding=\"UTF-8\"");
    xmlDoc.appendChild(encoding);
    xmlDoc.appendChild(root);
 
    // save editor information
    QDomElement projDataXml = saveProjectData(object->data(), xmlDoc);
    root.appendChild(projDataXml);
 
    // save object
    QDomElement elemObject = xmlDoc.createElement("object");
    root.appendChild(elemObject);
 
    for (const int layerIndex : keyFrameGroups.keys())
    {
        const QStringList& frames = keyFrameGroups.value(layerIndex);
        Status st = rebuildLayerXmlTag(xmlDoc, elemObject, layerIndex, frames);
    }
 
    QTextStream fout(&file);
    xmlDoc.save(fout, 2);
    fout.flush();
 
    return Status::OK;
}
Status FileManager::rebuildLayerXmlTag(QDomDocument& doc,
                                       QDomElement& elemObject,
                                       const int layerIndex,
                                       const QStringList& frames)
{
    Q_ASSERT(frames.length() > 0);
 
    Layer::LAYER_TYPE type = frames[0].endsWith(".png") ? Layer::BITMAP : Layer::VECTOR;
 
    QDomElement elemLayer = doc.createElement("layer");
    elemLayer.setAttribute("id", layerIndex + 1); // starts from 1, not 0.
    elemLayer.setAttribute("name", recoverLayerName(type, layerIndex));
    elemLayer.setAttribute("visibility", true);
    elemLayer.setAttribute("type", type);
    elemObject.appendChild(elemLayer);
 
    for (const QString& s : frames)
    {
        const int framePos = framePosFromFilename(s);
        if (framePos < 0) { continue; }
 
        QDomElement elemFrame = doc.createElement("image");
        elemFrame.setAttribute("frame", framePos);
        elemFrame.setAttribute("src", s);
 
        if (type == Layer::BITMAP)
        {
            // Since we have no way to know the original img position
            // Put it at the top left corner of the default camera
            elemFrame.setAttribute("topLeftX", -800);
            elemFrame.setAttribute("topLeftY", -600);
        }
        elemLayer.appendChild(elemFrame);
    }
    return Status::OK;
}
 
QString FileManager::recoverLayerName(Layer::LAYER_TYPE type, int index)
{
    switch (type)
    {
    case Layer::BITMAP:
        return tr("Bitmap Layer %1").arg(index);
    case Layer::VECTOR:
        return tr("Vector Layer %1").arg(index);
    case Layer::SOUND:
        return tr("Sound Layer %1").arg(index);
    default:
        Q_ASSERT(false);
    }
    return "";
}
 
int FileManager::layerIndexFromFilename(const QString& filename)
{
    const QStringList tokens = filename.split("."); // e.g., 001.019.png or 012.132.vec
    if (tokens.length() >= 3) // a correct file name must have 3 tokens
    {
        return tokens[0].toInt();
    }
    return -1;
}
 
int FileManager::framePosFromFilename(const QString& filename)
{
    const QStringList tokens = filename.split("."); // e.g., 001.019.png or 012.132.vec
    if (tokens.length() >= 3) // a correct file name must have 3 tokens
    {
        return tokens[1].toInt();
    }
    return -1;
}