path: root/cobbler/item_profile.py

"""
A Cobbler Profile.  A profile is a reference to a distribution, possibly some kernel options, possibly some Virt options, and some kickstart data.

Copyright 2006-2008, Red Hat, Inc
Michael DeHaan <mdehaan@redhat.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301  USA
"""

import utils
import item
import time
from cexceptions import *

from utils import _

class Profile(item.Item):

    TYPE_NAME = _("profile")
    COLLECTION_TYPE = "profile"
 
    def make_clone(self):
        ds = self.to_datastruct()
        cloned = Profile(self.config)
        cloned.from_datastruct(ds)
        return cloned

    def clear(self,is_subobject=False):
        """
        Reset this object.
        """
        self.name                   = None
        self.uid                    = ""
        self.random_id              = ""
        self.owners                 = self.settings.default_ownership
        self.distro                 = (None,                                    '<<inherit>>')[is_subobject]
        self.enable_menu            = (self.settings.enable_menu,               '<<inherit>>')[is_subobject]
        self.kickstart              = (self.settings.default_kickstart ,        '<<inherit>>')[is_subobject]    
        self.kernel_options         = ({},                                      '<<inherit>>')[is_subobject]
        self.kernel_options_post    = ({},                                      '<<inherit>>')[is_subobject]
        self.ks_meta                = ({},                                      '<<inherit>>')[is_subobject]
        self.template_files         = ({},                                      '<<inherit>>')[is_subobject]
        self.virt_cpus              = (1,                                       '<<inherit>>')[is_subobject]
        self.virt_file_size         = (self.settings.default_virt_file_size,    '<<inherit>>')[is_subobject]
        self.virt_ram               = (self.settings.default_virt_ram,          '<<inherit>>')[is_subobject]
        self.repos                  = ([],                                      '<<inherit>>')[is_subobject]
        self.depth                  = 1
        self.virt_type              = (self.settings.default_virt_type,         '<<inherit>>')[is_subobject]
        self.virt_path              = ("",                                      '<<inherit>>')[is_subobject]
        self.virt_bridge            = (self.settings.default_virt_bridge,       '<<inherit>>')[is_subobject]
        self.dhcp_tag               = ("default",                               '<<inherit>>')[is_subobject]
        self.mgmt_classes           = ([],                                      '<<inherit>>')[is_subobject]
        self.parent                 = ''
        self.server                 = "<<inherit>>"
        self.comment                = ""
        self.ctime                  = 0
        self.mtime                  = 0
        self.name_servers           = (self.settings.default_name_servers,      '<<inherit>>')[is_subobject]
        self.redhat_management_key  = "<<inherit>>"

    def from_datastruct(self,seed_data):
        """
        Load this object's properties based on seed_data
        """

        self.parent                 = self.load_item(seed_data,'parent','')
        self.name                   = self.load_item(seed_data,'name')
        self.owners                 = self.load_item(seed_data,'owners',self.settings.default_ownership)
        self.distro                 = self.load_item(seed_data,'distro')
        self.enable_menu            = self.load_item(seed_data,'enable_menu', self.settings.enable_menu)
        self.kickstart              = self.load_item(seed_data,'kickstart')
        self.kernel_options         = self.load_item(seed_data,'kernel_options')
        self.kernel_options_post    = self.load_item(seed_data,'kernel_options_post')
        self.ks_meta                = self.load_item(seed_data,'ks_meta')
        self.template_files         = self.load_item(seed_data,'template_files', {})
        self.repos                  = self.load_item(seed_data,'repos', [])
        self.depth                  = self.load_item(seed_data,'depth', 1)     
        self.dhcp_tag               = self.load_item(seed_data,'dhcp_tag', 'default')
        self.server                 = self.load_item(seed_data,'server', '<<inherit>>')
        self.mgmt_classes           = self.load_item(seed_data,'mgmt_classes', [])
        self.comment                = self.load_item(seed_data,'comment','')
        self.ctime                  = self.load_item(seed_data,'ctime',0)
        self.mtime                  = self.load_item(seed_data,'mtime',0)
        self.name_servers           = self.load_item(seed_data,'name_servers',[])
        self.redhat_management_key  = self.load_item(seed_data,'redhat_management_key', '<<inherit>>')

        # backwards compatibility
        if type(self.repos) != list:
            # ensure we are formatted correctly though if some repo
            # defs don't exist on this side, don't fail as we need
            # to convert everything -- cobbler check can report it
            self.set_repos(self.repos,bypass_check=True)
        
        self.set_parent(self.parent)

        # virt specific 
        self.virt_ram    = self.load_item(seed_data,'virt_ram',self.settings.default_virt_ram)
        self.virt_file_size  = self.load_item(seed_data,'virt_file_size',self.settings.default_virt_file_size)
        self.virt_path   = self.load_item(seed_data,'virt_path')
        self.virt_type   = self.load_item(seed_data,'virt_type', self.settings.default_virt_type)
        self.virt_bridge = self.load_item(seed_data,'virt_bridge', self.settings.default_virt_bridge)        
        self.virt_cpus   = self.load_item(seed_data,'virt_cpus',1)

        # backwards compatibility -- convert string entries to dicts for storage
        if self.kernel_options != "<<inherit>>" and type(self.kernel_options) != dict:
            self.set_kernel_options(self.kernel_options)
        if self.kernel_options_post != "<<inherit>>" and type(self.kernel_options_post) != dict:
            self.set_kernel_options_post(self.kernel_options_post)
        if self.ks_meta != "<<inherit>>" and type(self.ks_meta) != dict:
            self.set_ksmeta(self.ks_meta)
        if self.repos != "<<inherit>>" and type(self.ks_meta) != list:
            self.set_repos(self.repos,bypass_check=True)

        self.set_enable_menu(self.enable_menu)
        self.set_owners(self.owners)
        self.set_mgmt_classes(self.mgmt_classes)
        self.set_template_files(self.template_files)

        self.uid         = self.load_item(seed_data,'uid','')
        if self.uid == '':
           self.uid = self.config.generate_uid()

        self.random_id   = self.load_item(seed_data,'random_id','')
        if self.random_id == '' or len(self.random_id) != 4:
           self.random_id = self.config.generate_random_id(4)

        return self

    def set_parent(self,parent_name):
        """
        Instead of a --distro, set the parent of this object to another profile
        and use the values from the parent instead of this one where the values
        for this profile aren't filled in, and blend them together where they
        are hashes.  Basically this enables profile inheritance.  To use this,
        the object MUST have been constructed with is_subobject=True or the
        default values for everything will be screwed up and this will likely NOT
        work.  So, API users -- make sure you pass is_subobject=True into the
        constructor when using this.
        """
        if parent_name is None or parent_name == '':
           self.parent = ''
           return True
        if parent_name == self.name:
           # check must be done in two places as set_parent could be called before/after
           # set_name...
           raise CX(_("self parentage is weird"))
        found = self.config.profiles().find(name=parent_name)
        if found is None:
           raise CX(_("profile %s not found, inheritance not possible") % parent_name)
        self.parent = parent_name       
        self.depth = found.depth + 1
        return True

    def set_distro(self,distro_name):
        """
	Sets the distro.  This must be the name of an existing
	Distro object in the Distros collection.
	"""
        d = self.config.distros().find(name=distro_name)
        if d is not None:
            self.distro = distro_name
            self.depth  = d.depth +1 # reset depth if previously a subprofile and now top-level
            return True
        raise CX(_("distribution not found"))

    def set_redhat_management_key(self,key):
        return utils.set_redhat_management_key(self,key)

    def set_name_servers(self,data):
        data = utils.input_string_or_list(data)
        self.name_servers = data
        return True

    def set_enable_menu(self,enable_menu):
        """
        Sets whether or not the profile will be listed in the default
        PXE boot menu.  This is pretty forgiving for YAML's sake.
        """
        self.enable_menu = utils.input_boolean(enable_menu)
        return True

    def set_dhcp_tag(self,dhcp_tag):
        if dhcp_tag is None:
           dhcp_tag = ""
        self.dhcp_tag = dhcp_tag
        return True

    def set_server(self,server):
        if server is None or server == "":
           server = "<inherit>"
        self.server = server
        return True

  
    def set_kickstart(self,kickstart):
        """
	Sets the kickstart.  This must be a NFS, HTTP, or FTP URL.
	Or filesystem path.  Minor checking of the URL is performed here.
	"""
        if kickstart == "" or kickstart is None:
            self.kickstart = ""
            return True
        if kickstart == "<<inherit>>":
            self.kickstart = kickstart
            return True
        if utils.find_kickstart(kickstart):
            self.kickstart = kickstart
            return True
        raise CX(_("kickstart not found: %s") % kickstart)

    def set_virt_cpus(self,num):
        return utils.set_virt_cpus(self,num)

    def set_virt_file_size(self,num):
        return utils.set_virt_file_size(self,num)
 
    def set_virt_ram(self,num):
        return utils.set_virt_ram(self,num)

    def set_virt_type(self,vtype):
        return utils.set_virt_type(self,vtype)

    def set_virt_bridge(self,vbridge):
        return utils.set_virt_bridge(self,vbridge)

    def set_virt_path(self,path):
        return utils.set_virt_path(self,path)

    def set_repos(self,repos,bypass_check=False):
        return utils.set_repos(self,repos,bypass_check)


    def get_parent(self):
        """
        Return object next highest up the tree.
        """
        if self.parent is None or self.parent == '':
            result = self.config.distros().find(name=self.distro)
        else:
            result = self.config.profiles().find(name=self.parent)
        return result

    def is_valid(self):
        """
	A profile only needs a name and a distro.  Kickstart info,
	as well as Virt info, are optional.  (Though I would say provisioning
	without a kickstart is *usually* not a good idea).
	"""
        if self.parent is None or self.parent == '':
            # all values must be filled in if not inheriting from another profile
            if self.name is None:
                raise CX(_("no name specified"))
            if self.distro is None:
                raise CX(_("no distro specified"))
        else:
            # if inheriting, specifying distro is not allowed, and
            # name is required, but there are no other rules.
            if self.name is None:
                raise CX(_("no name specified"))
            if self.distro != "<<inherit>>":
                raise CX(_("cannot override distro when inheriting a profile"))
        return True

    def to_datastruct(self):
        """
        Return hash representation for the serializer
        """
        return {
            'name'                  : self.name,
            'owners'                : self.owners,
            'distro'                : self.distro,
            'enable_menu'           : self.enable_menu,
            'kickstart'             : self.kickstart,
            'kernel_options'        : self.kernel_options,
            'kernel_options_post'   : self.kernel_options_post,
            'virt_file_size'        : self.virt_file_size,
            'virt_ram'              : self.virt_ram,
            'virt_bridge'           : self.virt_bridge,
            'virt_cpus'             : self.virt_cpus,
            'ks_meta'               : self.ks_meta,
            'template_files'        : self.template_files,
            'repos'                 : self.repos,
            'parent'                : self.parent,
            'depth'                 : self.depth,
            'virt_type'             : self.virt_type,
            'virt_path'             : self.virt_path,
            'dhcp_tag'              : self.dhcp_tag,
            'server'                : self.server,
            'mgmt_classes'          : self.mgmt_classes,
            'comment'               : self.comment,
            'ctime'                 : self.ctime,
            'mtime'                 : self.mtime,
            'name_servers'          : self.name_servers,
            'uid'                   : self.uid,
            'random_id'             : self.random_id,
            'redhat_management_key' : self.redhat_management_key
         }

    def printable(self):
        """
        A human readable representaton
        """
        buf =       _("profile              : %s\n") % self.name
        if self.distro == "<<inherit>>":
            buf = buf + _("parent               : %s\n") % self.parent
        else:
            buf = buf + _("distro               : %s\n") % self.distro
        buf = buf + _("comment              : %s\n") % self.comment
        buf = buf + _("created              : %s\n") % time.ctime(self.ctime)
        buf = buf + _("dhcp tag             : %s\n") % self.dhcp_tag
        buf = buf + _("enable menu          : %s\n") % self.enable_menu
        buf = buf + _("kernel options       : %s\n") % self.kernel_options
        buf = buf + _("kickstart            : %s\n") % self.kickstart
        buf = buf + _("ks metadata          : %s\n") % self.ks_meta
        buf = buf + _("mgmt classes         : %s\n") % self.mgmt_classes
        buf = buf + _("modified             : %s\n") % time.ctime(self.mtime)
        buf = buf + _("name servers         : %s\n") % self.name_servers
        buf = buf + _("owners               : %s\n") % self.owners
        buf = buf + _("post kernel options  : %s\n") % self.kernel_options_post
        buf = buf + _("redhat mgmt key      : %s\n") % self.redhat_management_key
        buf = buf + _("repos                : %s\n") % self.repos
        buf = buf + _("server               : %s\n") % self.server
        buf = buf + _("template_files       : %s\n") % self.template_files
        buf = buf + _("virt bridge          : %s\n") % self.virt_bridge
        buf = buf + _("virt cpus            : %s\n") % self.virt_cpus
        buf = buf + _("virt file size       : %s\n") % self.virt_file_size
        buf = buf + _("virt path            : %s\n") % self.virt_path
        buf = buf + _("virt ram             : %s\n") % self.virt_ram
        buf = buf + _("virt type            : %s\n") % self.virt_type
        return buf

  
    def remote_methods(self):
        return {           
            'name'            :  self.set_name,
            'parent'          :  self.set_parent,
            'profile'         :  self.set_name,
            'distro'          :  self.set_distro,
            'enable-menu'     :  self.set_enable_menu,
            'enable_menu'     :  self.set_enable_menu,            
            'kickstart'       :  self.set_kickstart,
            'kopts'           :  self.set_kernel_options,
            'kopts-post'      :  self.set_kernel_options_post,
            'kopts_post'      :  self.set_kernel_options_post,            
            'virt-file-size'  :  self.set_virt_file_size,
            'virt_file_size'  :  self.set_virt_file_size,            
            'virt-ram'        :  self.set_virt_ram,
            'virt_ram'        :  self.set_virt_ram,            
            'ksmeta'          :  self.set_ksmeta,
            'template-files'  :  self.set_template_files,
            'template_files'  :  self.set_template_files,            
            'repos'           :  self.set_repos,
            'virt-path'       :  self.set_virt_path,
            'virt_path'       :  self.set_virt_path,            
            'virt-type'       :  self.set_virt_type,
            'virt_type'       :  self.set_virt_type,            
            'virt-bridge'     :  self.set_virt_bridge,
            'virt_bridge'     :  self.set_virt_bridge,            
            'virt-cpus'       :  self.set_virt_cpus,
            'virt_cpus'       :  self.set_virt_cpus,            
            'dhcp-tag'        :  self.set_dhcp_tag,
            'dhcp_tag'        :  self.set_dhcp_tag,            
            'server'          :  self.set_server,
            'owners'          :  self.set_owners,
            'mgmt-classes'    :  self.set_mgmt_classes,
            'mgmt_classes'    :  self.set_mgmt_classes,            
            'comment'         :  self.set_comment,
            'name_servers'    :  self.set_name_servers,
            'redhat_management_key' : self.set_redhat_management_key
        }