IDobbyUtils.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2016 Sky UK
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
 * File:   IDobbyUtils.h
 *
 */
#ifndef IDOBBYUTILS_H
#define IDOBBYUTILS_H
 
#include <ContainerId.h>
 
#include <cstdint>
#include <string>
#include <list>
#include <chrono>
#include <functional>
#include <memory>
#include <map>
#include <string.h>
 
#include <sys/types.h>
#include <sys/sysmacros.h>
 
 
// -----------------------------------------------------------------------------
class IDobbyUtils_v1
{
public:
    virtual ~IDobbyUtils_v1() = default;
 
public:
 
    // -------------------------------------------------------------------------
    virtual bool mkdirRecursive(const std::string& path, mode_t mode) const = 0;
    virtual bool mkdirRecursive(int dirFd, const std::string& path, mode_t mode) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool rmdirRecursive(const std::string& path) const = 0;
    virtual bool rmdirRecursive(int dirFd, const std::string& path) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool rmdirContents(const std::string& path) const = 0;
    virtual bool rmdirContents(int dirFd, const std::string& path) const = 0;
    virtual bool rmdirContents(int dirFd) const = 0;
 
 
    // -------------------------------------------------------------------------
    virtual int loopDeviceAssociate(int fileFd, std::string* loopDevPath = nullptr) const = 0;
 
 
    // -------------------------------------------------------------------------
    virtual bool checkExtImageFile(int dirFd, const std::string& imageFileName,
                                   bool repair = true) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool formatExtImageFile(int dirFd, const std::string& imageFileName,
                                    const std::string& fsType = "ext4") const = 0;
 
    // -------------------------------------------------------------------------
    virtual void cleanMountLostAndFound(const std::string& mountPoint,
                                        const std::string& logTag = std::string()) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool writeTextFile(const std::string& path,
                               const std::string& str,
                               int flags, mode_t mode = 0644) const = 0;
    virtual bool writeTextFileAt(int dirFd, const std::string& path,
                                 const std::string& str,
                                 int flags, mode_t mode = 0644) const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::string readTextFile(const std::string& path,
                                     size_t maxLen = 4096) const = 0;
    virtual std::string readTextFileAt(int dirFd, const std::string& path,
                                       size_t maxLen = 4096) const = 0;
 
    // -------------------------------------------------------------------------
    virtual int getNamespaceFd(pid_t pid, int nsType) const = 0;
 
    // -------------------------------------------------------------------------
    template< class Function >
    inline bool callInNamespace(pid_t pid, int nsType, Function func) const
    {
        return this->callInNamespaceImpl(pid, nsType, func);
    }
 
    // -------------------------------------------------------------------------
    template< class Function, class... Args >
    inline bool callInNamespace(pid_t pid, int nsType, Function&& f, Args&&... args) const
    {
        return this->callInNamespaceImpl(pid, nsType, std::bind(std::forward<Function>(f),
                                                                std::forward<Args>(args)...));
    }
 
 
    // -------------------------------------------------------------------------
    template< class Rep, class Period >
    inline int startTimer(const std::chrono::duration<Rep, Period>& timeout,
                          bool oneShot,
                          const std::function<bool()>& handler) const
    {
        return this->startTimerImpl(std::chrono::duration_cast<std::chrono::milliseconds>(timeout),
                                    oneShot,
                                    handler);
    }
 
    // -------------------------------------------------------------------------
    virtual bool cancelTimer(int timerId) const = 0;
 
 
    // -------------------------------------------------------------------------
    template< class Function >
    inline bool callInNamespace(int namespaceFd, Function func) const
    {
        return this->callInNamespaceImpl(namespaceFd, func);
    }
 
    template< class Function, class... Args >
    inline bool callInNamespace(int namespaceFd, Function&& f, Args&&... args) const
    {
        return this->callInNamespaceImpl(namespaceFd, std::bind(std::forward<Function>(f),
                                                                std::forward<Args>(args)...));
    }
 
 
    // -------------------------------------------------------------------------
    virtual unsigned int getDriverMajorNumber(const std::string &driverName) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool deviceAllowed(dev_t device) const = 0;
 
    inline bool deviceAllowed(unsigned int major, unsigned int minor) const
    {
        return this->deviceAllowed(makedev(major, minor));
    }
 
protected:
 
    // -------------------------------------------------------------------------
    virtual bool callInNamespaceImpl(pid_t pid, int nsType, const std::function<bool()>& func) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool callInNamespaceImpl(int namespaceFd, const std::function<bool()>& func) const = 0;
 
    // -------------------------------------------------------------------------
    virtual int startTimerImpl(const std::chrono::milliseconds& timeout,
                               bool oneShot,
                               const std::function<bool()>& handler) const = 0;
 
    // -------------------------------------------------------------------------
    virtual gid_t getGID(pid_t pid) const = 0;
 
    // -------------------------------------------------------------------------
    virtual uid_t getUID(pid_t pid) const = 0;
 
};
 
 
// -----------------------------------------------------------------------------
class IDobbyUtils_v2 : public virtual IDobbyUtils_v1
{
public:
    using IDobbyUtils_v1::mkdirRecursive;
    using IDobbyUtils_v1::rmdirRecursive;
    using IDobbyUtils_v1::rmdirContents;
    using IDobbyUtils_v1::loopDeviceAssociate;
    using IDobbyUtils_v1::checkExtImageFile;
    using IDobbyUtils_v1::formatExtImageFile;
    using IDobbyUtils_v1::cleanMountLostAndFound;
    using IDobbyUtils_v1::writeTextFile;
    using IDobbyUtils_v1::writeTextFileAt;
    using IDobbyUtils_v1::readTextFile;
    using IDobbyUtils_v1::readTextFileAt;
    using IDobbyUtils_v1::getNamespaceFd;
    using IDobbyUtils_v1::cancelTimer;
    using IDobbyUtils_v1::getDriverMajorNumber;
    using IDobbyUtils_v1::deviceAllowed;
    using IDobbyUtils_v1::getGID;
    using IDobbyUtils_v1::getUID;
 
public:
 
    // -------------------------------------------------------------------------
    virtual void setIntegerMetaData(const ContainerId &id, const std::string &key, int value) = 0;
    virtual int getIntegerMetaData(const ContainerId &id, const std::string &key, int defaultValue) const = 0;
    inline int getIntegerMetaData(const ContainerId &id, const std::string &key)
    {
        return getIntegerMetaData(id, key, -1);
    }
 
    // -------------------------------------------------------------------------
    virtual void setStringMetaData(const ContainerId &id, const std::string &key, const std::string &value) = 0;
    virtual std::string getStringMetaData(const ContainerId &id, const std::string &key, const std::string &defaultValue) const = 0;
    inline std::string getStringMetaData(const ContainerId &id, const std::string &key)
    {
        return getStringMetaData(id, key, std::string());
    }
    virtual void clearContainerMetaData(const ContainerId &id) = 0;
 
};
 
// -----------------------------------------------------------------------------
class IDobbyUtils_v3 : public virtual IDobbyUtils_v2
{
public:
    using IDobbyUtils_v1::mkdirRecursive;
    using IDobbyUtils_v1::rmdirRecursive;
    using IDobbyUtils_v1::rmdirContents;
    using IDobbyUtils_v1::loopDeviceAssociate;
    using IDobbyUtils_v1::checkExtImageFile;
    using IDobbyUtils_v1::formatExtImageFile;
    using IDobbyUtils_v1::cleanMountLostAndFound;
    using IDobbyUtils_v1::writeTextFile;
    using IDobbyUtils_v1::writeTextFileAt;
    using IDobbyUtils_v1::readTextFile;
    using IDobbyUtils_v1::readTextFileAt;
    using IDobbyUtils_v1::getNamespaceFd;
    using IDobbyUtils_v1::cancelTimer;
    using IDobbyUtils_v1::getDriverMajorNumber;
    using IDobbyUtils_v1::deviceAllowed;
    using IDobbyUtils_v1::getGID;
    using IDobbyUtils_v1::getUID;
 
    using IDobbyUtils_v2::setIntegerMetaData;
    using IDobbyUtils_v2::getIntegerMetaData;
    using IDobbyUtils_v2::setStringMetaData;
    using IDobbyUtils_v2::getStringMetaData;
    using IDobbyUtils_v2::clearContainerMetaData;
 
public:
 
    // -------------------------------------------------------------------------
    virtual bool insertEbtablesRule(const std::string &args) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool deleteEbtablesRule(const std::string &args) const = 0;
 
};
 
 
using IDobbyUtils = IDobbyUtils_v3;
 
 
 
#endif // !defined(IDOBBYUTILS_H)