one/include/VMTemplate.h

/* -------------------------------------------------------------------------- */
/* Copyright 2002-2024, 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 VMTEMPLATE_H_
#define VMTEMPLATE_H_

#include "PoolObjectSQL.h"
#include "VirtualMachineTemplate.h"

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

/**
 *  The VMTemplate class.
 */
class VMTemplate : public PoolObjectSQL
{
public:

    virtual ~VMTemplate() = default;

    /**
     * Function to print the VMTemplate object into a string in XML format
     *  @param xml the resulting XML string
     *  @return a reference to the generated string
     */
    std::string& to_xml(std::string& xml) const override;


    /**
     * Function to print the VMTemplate object into a string in XML format
     *  @param xml the resulting XML string
     *  @param tmpl a template to replace the internal obj_template. It is only
     *  used to create the resulting xml string, the internal obj_template is
     *  not altered
     *  @return a reference to the generated string
     */
    std::string& to_xml(std::string& xml, const Template* tmpl) const;

    // ------------------------------------------------------------------------
    // Template Contents
    // ------------------------------------------------------------------------

    /**
     *  Factory method for virtual machine templates
     */
    std::unique_ptr<Template> get_new_template() const override
    {
        return std::make_unique<VirtualMachineTemplate>();
    }

    /**
     *  Returns a copy of the VirtualMachineTemplate
     *    @return A copy of the VirtualMachineTemplate
     */
    std::unique_ptr<VirtualMachineTemplate> clone_template() const
    {
        return std::make_unique<VirtualMachineTemplate>(*obj_template);
    }

    /**
     * Returns a copy of the DISK attributes of this template, the attributes
     * are copied and must be freed by the calling function.
     *   @param a vector to store the disks.
     */
    void clone_disks(std::vector<VectorAttribute *>& disks)
    {
        std::vector<const VectorAttribute *> _disks;

        obj_template->get("DISK", _disks);

        for (auto disk : _disks)
        {
            disks.push_back(new VectorAttribute(disk));
        }
    }

    /**
     * Replaces the current DISK attributes with the given ones. The objects
     * must NOT be deleted by the calling function, and should be obtained
     * through a clone_disks() call.
     *   @param disks a vector with the new disks
     *
     */
    void replace_disks(std::vector<VectorAttribute *>& disks)
    {
        obj_template->erase("DISK");

        obj_template->set(disks);
    }

    // ------------------------------------------------------------------------
    // Virtual Router
    // ------------------------------------------------------------------------

    /**
     * Returns true if this Template is a Virtual Router Template
     * @return true if this Template is a Virtual Router Template
     */
    bool is_vrouter();

private:
    // -------------------------------------------------------------------------
    // Friends
    // -------------------------------------------------------------------------

    friend class VMTemplatePool;

    // -------------------------------------------------------------------------
    // VMTemplate Attributes
    // -------------------------------------------------------------------------

    /**
     *  Registration time
     */
    time_t      regtime;

    // *************************************************************************
    // DataBase implementation (Private)
    // *************************************************************************

    /**
     *  Execute an INSERT or REPLACE Sql query.
     *    @param db The SQL DB
     *    @param replace Execute an INSERT or a REPLACE
     *    @param error_str Returns the error reason, if any
     *    @return 0 one success
     */
    int insert_replace(SqlDB *db, bool replace, std::string& error_str);

    /**
     *  Execute this method after update the template.
     *    @param error Returns the error reason, if any
     *    @return 0 one success
     */
    int post_update_template(std::string& error, Template *_old_tmpl) override;

    /**
     *  Bootstraps the database table(s) associated to the VMTemplate
     *    @return 0 on success
     */
    static int bootstrap(SqlDB * db);

    /**
     *  Rebuilds the object from an xml formatted string
     *    @param xml_str The xml-formatted string
     *
     *    @return 0 on success, -1 otherwise
     */
    int from_xml(const std::string &xml_str) override;

    /**
     *  This method removes sched_action DONE/MESSAGE attributes
     */
    int parse_sched_action(std::string& error_str);

protected:

    // *************************************************************************
    // Constructor
    // *************************************************************************
    VMTemplate(int id,
               int uid,
               int gid,
               const std::string& uname,
               const std::string& gname,
               int umask,
               std::unique_ptr<Template> _template_contents);

    // *************************************************************************
    // DataBase implementation
    // *************************************************************************

    /**
     *  Writes the VMTemplate in the database.
     *    @param db pointer to the db
     *    @param error_str Returns the error reason, if any
     *    @return 0 on success
     */
    int insert(SqlDB *db, std::string& error_str) override;

    /**
     *  Writes/updates the VMTemplate data fields in the database.
     *    @param db pointer to the db
     *    @return 0 on success
     */
    int update(SqlDB *db) override
    {
        std::string err;
        return insert_replace(db, true, err);
    };
};

#endif /*VMTEMPLATE_H_*/