/* -------------------------------------------------------------------------- */
/* Copyright 2002-2018, OpenNebula Project, OpenNebula Systems                */
/*                                                                            */
/* 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.                                             */
/* -------------------------------------------------------------------------- */

#ifndef IMAGE_MANAGER_DRIVER_H_
#define IMAGE_MANAGER_DRIVER_H_

#include <map>
#include <string>
#include <sstream>

#include "Mad.h"

using namespace std;

//Forward definition of related classes
class ImagePool;
class ImageManager;

class DatastorePool;

/**
 *  ImageManagerDriver represents the basic abstraction for Image Repository
 *  drivers. It implements the protocol and recover functions from the Mad
 *  interface.
 */
class ImageManagerDriver : public Mad
{
public:

    ImageManagerDriver(int        userid,
                       const      map<string,string>& attrs,
                       bool       sudo,
                       ImagePool* _ipool,
                       DatastorePool * _dspool):
            Mad(userid,attrs,sudo),ipool(_ipool),dspool(_dspool){};

    virtual ~ImageManagerDriver(){};

    /**
     *  Implements the Image Manager driver protocol.
     *    @param message the string read from the driver
     */
    void protocol(const string& message) const;

    /**
     *  TODO: What do we need here? Check on-going xfr?
     */
    void recover();

private:
    friend class ImageManager;

    /**
     *  Reference to the ImagePool
     */
    ImagePool * ipool;

    /**
     *  Reference to the DatastorePool
     */
    DatastorePool * dspool;

    /**
     * Sends a copy request to the MAD.
     *    @param oid the image id.
     *    @param drv_msg xml data for the mad operation.
     */
    void cp(int oid, const string& drv_msg) const;

    /**
     * Sends a clone request to the MAD.
     *    @param oid the image id.
     *    @param drv_msg xml data for the mad operation.
     */
    void clone(int oid, const string& drv_msg) const;

    /**
     *  Sends a stat  request to the MAD.
     *    @param oid the id of the stat request
     *    @param drv_msg xml data for the mad operation.
     */
    void stat(int oid, const string& drv_msg) const;

    /**
     *  Sends a make filesystem request to the MAD.
     *    @param oid the image id.
     *    @param drv_msg xml data for the mad operation.
     */
    void mkfs(int oid, const string& drv_msg) const;

    /**
     *  Sends a delete request to the MAD: "DELETE IMAGE_ID PATH"
     *    @param oid the image id.
     *    @param drv_msg xml data for the mad operation.
     */
    void rm(int oid, const string& drv_msg) const;

    /**
     *  Sends a monitor request to the MAD: "MONITOR DS_ID DS_XML"
     *    @param oid the datastore id.
     *    @param drv_msg xml data for the mad operation.
     */
    void monitor(int oid, const string& drv_msg) const;

    /**
     *  Sends a delete snapshot command: "SNAP_DELETE DS_ID DS_XML"
     *    @param oid the datastore id.
     *    @param drv_msg xml data for the mad operation.
     */
    void snapshot_delete(int oid, const string& drv_msg) const;

    /**
     *  Sends a revert snapshot command: "SNAP_REVERT DS_ID DS_XML"
     *    @param oid the datastore id.
     *    @param drv_msg xml data for the mad operation.
     */
    void snapshot_revert(int oid, const string& drv_msg) const;

    /**
     *  Sends a flatten snapshot command: "SNAP_FLATTEN DS_ID DS_XML"
     *    @param oid the datastore id.
     *    @param drv_msg xml data for the mad operation.
     */
    void snapshot_flatten(int oid, const string& drv_msg) const;
};

/* -------------------------------------------------------------------------- */
/* -------------------------------------------------------------------------- */

#endif /*IMAGE_MANAGER_DRIVER_H_*/