filetoolkitwithundo.h

/*
 * Copyright (C) 2016-2017 Pelagicore AB
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
 * BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
 * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 *
 * For further information see LICENSE
 */

#pragma once

#include "mountcleanuphandler.h"
#include "createdir.h"
#include "softwarecontainer-common.h"

namespace softwarecontainer {

class FileToolkitWithUndo
{
    LOG_DECLARE_CLASS_CONTEXT("CLEA", "File toolkit");

public:
    ~FileToolkitWithUndo();

    bool bindMount(const std::string &src,
                   const std::string &dst,
                   const std::string &tmpContainerRoot,
                   bool readOnly,
                   bool writeBufferEnabled=false);

    bool tmpfsMount(const std::string dst, const int maxSize);

protected:
    /*
     * @brief Writes to a file (and optionally create it)
     */
    bool writeToFile(const std::string &path, const std::string &content);

    /*
     * @brief Creates a file cleanup handler for a specific file.
     *
     * This is useful if one creates a file in some other way and want it deleted later.
     */
    void markFileForDeletion(const std::string &path);

    bool overlayMount(const std::string &lower,
                      const std::string &upper,
                      const std::string &work,
                      const std::string &dst);

    bool syncOverlayMount(const std::string &lower,
                          const std::string &upper);

    bool createSharedMountPoint(const std::string &path);

    bool pathInList(const std::string path);

    std::vector<std::unique_ptr<CleanUpHandler>> m_cleanupHandlers;

    std::vector<std::unique_ptr<CreateDir>> m_createDirList;
};

} // namespace softwarecontainer