/*
 * Copyright (C) 2012 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authors:
 * Charles Lindsay <chaz@yorba.org>
 */

#ifndef GALLERY_PHOTO_CACHES_H_
#define GALLERY_PHOTO_CACHES_H_

#include <QFile>
#include <QFileInfo>
#include <QString>

/*!
 * \brief The PhotoCaches class
 *
 * An abstraction around the various files we keep in addition to the photo
 * file itself: the original, the pristine version of the file without any
 * applied edits; and the enhanced, a version of the original with auto-enhance
 * applied to it (necessary because of how slow auto-enhance is).
 */
class PhotoCaches
{
public:
    static const QString ORIGINAL_DIR;
    static const QString ENHANCED_DIR;

    PhotoCaches(); // FIXME: remove this class and only deal with a stack of temporary rollback files
    PhotoCaches(const QFileInfo& file);

    bool hasCachedOriginal() const;
    bool hasCachedEnhanced() const;

    const QFileInfo& originalFile() const;
    const QFileInfo& enhancedFile() const;
    const QFileInfo& pristineFile() const;

    bool cacheOriginal();
    bool restoreOriginal();
    bool cacheEnhancedFromOriginal();
    bool overwriteFromCache(bool preferEnhanced);

    void discardCachedOriginal();
    void discardCachedEnhanced();
    void discardAll();

private:
    static bool remove(const QFileInfo& file) {
        return QFile::remove(file.filePath());
    }
    static bool rename(const QFileInfo& oldName, const QFileInfo& newName) {
        return QFile::rename(oldName.filePath(), newName.filePath());
    }
    static bool copy(const QFileInfo& oldName, const QFileInfo& newName) {
        return QFile::copy(oldName.filePath(), newName.filePath());
    }

    QFileInfo m_file;
    QFileInfo m_originalFile;
    QFileInfo m_enhancedFile;
};

#endif
