2010-05-20 20:58:17 +04:00
/* -------------------------------------------------------------------------- */
2012-01-12 15:29:18 +04:00
/* Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org) */
2010-05-20 20:58:17 +04:00
/* */
/* 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_POOL_H_
# define IMAGE_POOL_H_
# include "PoolSQL.h"
# include "Image.h"
2010-05-25 20:19:22 +04:00
# include "NebulaLog.h"
2010-05-20 20:58:17 +04:00
# include <time.h>
# include <sstream>
# include <iostream>
# include <vector>
2010-07-14 20:11:29 +04:00
class AuthRequest ;
2010-05-20 20:58:17 +04:00
using namespace std ;
/**
* The Image Pool class .
*/
class ImagePool : public PoolSQL
{
public :
2011-03-08 18:52:45 +03:00
ImagePool ( SqlDB * db ,
const string & _default_type ,
2012-04-25 18:47:12 +04:00
const string & _default_dev_prefix ,
2012-10-09 13:56:01 +04:00
vector < const Attribute * > & restricted_attrs ,
vector < const Attribute * > hook_mads ,
const string & remotes_location ) ;
2010-05-20 20:58:17 +04:00
~ ImagePool ( ) { } ;
/**
* Function to allocate a new Image object
* @ param uid the user id of the image ' s owner
Feature #407: Add 'GID' attribute to some pool objects; change *pool.info XML-RPC flag meaning; update onedb migrator; fix tests.
* VM, VMTEMPLATE, VNET & IMAGE objects have a GID attribute, and a table column. The group id is inherited from the user creating the object, except for VMs created from Templates, that inherit the Template's group.
* The new flag meaning has been modified in src/rm sources and CLI commands for one.(vm,template,vnet,image)pool.info . It changes from
-2 all, -1 mine & public, >=0 UID
to
-3 mine, -2 all, -1 mine & group
* USER has a group, but not secondary ones. The user_pool table doesn't have a GID column, we'll deal with it later when the group-users relations are implemented.
* onedb migrator 1.rb: deleted USERNAME, and GID added.
2011-05-16 19:00:27 +04:00
* @ param gid the id of the group this object is assigned to
2011-06-30 13:31:00 +04:00
* @ param uname name of the user
* @ param gname name of the group
2011-05-12 19:10:35 +04:00
* @ param img_template template associated with the image
2012-02-15 19:47:52 +04:00
* @ param ds_id the id of the datastore
* @ param ds_name the name of the datastore
2012-04-19 13:44:19 +04:00
* @ param ds_type disk type for the image
2012-02-15 19:47:52 +04:00
* @ param ds_data the datastore data
2012-05-25 14:56:51 +04:00
* @ param source_img_id If the new Image is a clone , this must be the
2012-10-09 13:56:01 +04:00
* source Image ID . Otherwise , it must be set to - 1
2010-05-20 20:58:17 +04:00
* @ param oid the id assigned to the Image
2011-05-12 19:10:35 +04:00
* @ param error_str Returns the error reason , if any
2010-06-24 18:47:39 +04:00
* @ return the oid assigned to the object ,
2010-05-20 20:58:17 +04:00
* - 1 in case of failure
* - 2 in case of template parse failure
*/
int allocate (
2010-07-14 21:37:43 +04:00
int uid ,
Feature #407: Add 'GID' attribute to some pool objects; change *pool.info XML-RPC flag meaning; update onedb migrator; fix tests.
* VM, VMTEMPLATE, VNET & IMAGE objects have a GID attribute, and a table column. The group id is inherited from the user creating the object, except for VMs created from Templates, that inherit the Template's group.
* The new flag meaning has been modified in src/rm sources and CLI commands for one.(vm,template,vnet,image)pool.info . It changes from
-2 all, -1 mine & public, >=0 UID
to
-3 mine, -2 all, -1 mine & group
* USER has a group, but not secondary ones. The user_pool table doesn't have a GID column, we'll deal with it later when the group-users relations are implemented.
* onedb migrator 1.rb: deleted USERNAME, and GID added.
2011-05-16 19:00:27 +04:00
int gid ,
2011-06-30 13:31:00 +04:00
const string & uname ,
const string & gname ,
2010-07-14 21:37:43 +04:00
ImageTemplate * img_template ,
2012-02-15 19:47:52 +04:00
int ds_id ,
const string & ds_name ,
2012-04-19 13:44:19 +04:00
Image : : DiskType ds_type ,
2012-02-15 19:47:52 +04:00
const string & ds_data ,
2012-10-09 13:56:01 +04:00
int source_img_id ,
2010-08-05 21:28:28 +04:00
int * oid ,
string & error_str ) ;
2010-05-20 20:58:17 +04:00
/**
2011-03-08 18:52:45 +03:00
* * Function to get a Image from the pool , if the object is not in memory
2010-05-20 20:58:17 +04:00
* it is loaded from the DB
* @ param oid Image unique id
* @ param lock locks the Image mutex
* @ return a pointer to the Image , 0 if the Image could not be loaded
*/
2011-03-05 05:24:11 +03:00
Image * get ( int oid , bool lock )
2010-05-20 20:58:17 +04:00
{
return static_cast < Image * > ( PoolSQL : : get ( oid , lock ) ) ;
} ;
2010-06-24 18:47:39 +04:00
2011-07-12 21:30:00 +04:00
/**
* Gets an object from the pool ( if needed the object is loaded from the
* database ) .
* @ param name of the object
* @ param uid id of owner
* @ param lock locks the object if true
*
* @ return a pointer to the object , 0 in case of failure
*/
Image * get ( const string & name , int uid , bool lock )
{
return static_cast < Image * > ( PoolSQL : : get ( name , uid , lock ) ) ;
} ;
2012-10-09 13:56:01 +04:00
/**
2011-03-08 18:52:45 +03:00
* Update a particular Image
2010-05-20 20:58:17 +04:00
* @ param image pointer to Image
* @ return 0 on success
*/
int update ( Image * image )
{
return image - > update ( db ) ;
} ;
2010-06-24 18:47:39 +04:00
2010-05-20 20:58:17 +04:00
/**
* Bootstraps the database table ( s ) associated to the Image pool
2011-10-10 17:14:46 +04:00
* @ return 0 on success
2010-05-20 20:58:17 +04:00
*/
2011-10-10 17:14:46 +04:00
static int bootstrap ( SqlDB * _db )
2010-05-20 20:58:17 +04:00
{
2011-10-10 17:14:46 +04:00
return Image : : bootstrap ( _db ) ;
2010-05-20 20:58:17 +04:00
} ;
2010-06-24 18:47:39 +04:00
2010-05-20 20:58:17 +04:00
/**
* Dumps the Image pool in XML format . A filter can be also added to the
* query
* @ param oss the output stream to dump the pool contents
* @ param where filter for the objects , defaults to all
* @ return 0 on success
*/
2011-03-09 15:23:01 +03:00
int dump ( ostringstream & oss , const string & where )
{
return PoolSQL : : dump ( oss , " IMAGE_POOL " , Image : : table , where ) ;
}
2010-05-20 20:58:17 +04:00
2010-06-24 20:35:18 +04:00
/**
* Generates a DISK attribute for VM templates using the Image metadata
2012-04-26 18:53:11 +04:00
*
2010-06-24 20:35:18 +04:00
* @ param disk the disk to be generated
2010-07-21 19:50:04 +04:00
* @ param disk_id the id for this disk
2012-04-25 18:47:12 +04:00
* @ param img_type will be set to the used image ' s type
2012-04-26 18:53:11 +04:00
* @ param dev_prefix will be set to the image defined dev_prefix ,
* or the default one
2011-03-08 18:52:45 +03:00
* @ param uid of VM owner ( to look for the image id within its images )
2011-09-15 21:06:16 +04:00
* @ param image_id on success returns the acquired image id
2012-02-25 00:13:56 +04:00
* @ param error_str string describing the error
2012-04-26 18:53:11 +04:00
*
* @ return 0 on success , - 1 otherwise
2010-06-24 20:35:18 +04:00
*/
2010-07-21 19:50:04 +04:00
int disk_attribute ( VectorAttribute * disk ,
int disk_id ,
2012-04-27 02:12:55 +04:00
Image : : ImageType & img_type ,
2012-04-26 18:53:11 +04:00
string & dev_prefix ,
2011-09-15 21:06:16 +04:00
int uid ,
2012-02-25 00:13:56 +04:00
int & image_id ,
string & error_str ) ;
2010-07-14 20:11:29 +04:00
/**
* Generates an Authorization token for the DISK attribute
* @ param disk the disk to be authorized
2011-03-08 18:52:45 +03:00
* @ param uid of owner ( to look for the image id within her images )
2010-07-14 20:11:29 +04:00
* @ param ar the AuthRequest
*/
2011-03-05 00:37:21 +03:00
void authorize_disk ( VectorAttribute * disk , int uid , AuthRequest * ar ) ;
2010-07-14 20:11:29 +04:00
2010-06-30 19:08:11 +04:00
static const string & default_type ( )
2010-06-30 15:10:07 +04:00
{
2010-06-30 19:08:11 +04:00
return _default_type ;
2010-06-30 15:10:07 +04:00
} ;
2012-04-25 18:47:12 +04:00
static const string & default_dev_prefix ( )
{
return _default_dev_prefix ;
} ;
2010-05-20 20:58:17 +04:00
private :
2010-06-30 19:08:11 +04:00
//--------------------------------------------------------------------------
// Configuration Attributes for Images
// -------------------------------------------------------------------------
2010-06-24 18:47:39 +04:00
2010-05-25 20:19:22 +04:00
/**
* Default image type
* */
2011-03-08 18:52:45 +03:00
static string _default_type ;
2010-06-07 18:21:58 +04:00
2012-04-25 18:47:12 +04:00
/**
* Default device prefix
* */
static string _default_dev_prefix ;
2010-06-30 19:08:11 +04:00
//--------------------------------------------------------------------------
// Pool Attributes
// -------------------------------------------------------------------------
2010-05-20 20:58:17 +04:00
/**
* Factory method to produce Image objects
* @ return a pointer to the new Image
*/
PoolObjectSQL * create ( )
{
2011-06-30 13:31:00 +04:00
return new Image ( - 1 , - 1 , " " , " " , 0 ) ;
2010-05-20 20:58:17 +04:00
} ;
} ;
2010-05-21 14:36:24 +04:00
# endif /*IMAGE_POOL_H_*/