def remove(self,
name,
with_delete=True,
with_sync=True,
with_triggers=True,
recursive=True,
logger=None):
"""
Remove element named 'name' from the collection
"""
# NOTE: with_delete isn't currently meaningful for repos
# but is left in for consistancy in the API. Unused.
name = name.lower()
# first see if any Groups use this distro
if not recursive:
for v in self.config.systems():
if v.image is not None and v.image.lower() == name:
raise CX(_("removal would orphan system: %s") % v.name)
obj = self.find(name=name)
if obj is not None:
if recursive:
kids = obj.get_children()
for k in kids:
self.config.api.remove_system(k,
recursive=True,
logger=logger)
if with_delete:
if with_triggers:
utils.run_triggers(
self.config.api, obj,
"/var/lib/cobbler/triggers/delete/image/pre/*", [],
logger)
if with_sync:
lite_sync = action_litesync.BootLiteSync(self.config,
logger=logger)
lite_sync.remove_single_image(name)
del self.listing[name]
self.config.serialize_delete(self, obj)
if with_delete:
if with_triggers:
utils.run_triggers(
self.config.api, obj,
"/var/lib/cobbler/triggers/delete/image/post/*", [],
logger)
utils.run_triggers(self.config.api, obj,
"/var/lib/cobbler/triggers/change/*",
[], logger)
return True
raise CX(_("cannot delete an object that does not exist: %s") % name)
def remove(self, name, with_delete=True, with_sync=True, with_triggers=True, recursive=False, logger=None):
"""
Remove element named 'name' from the collection
"""
name = name.lower()
obj = self.find(name=name)
if obj is not None:
if with_delete:
if with_triggers:
utils.run_triggers(self.config.api, obj, "/var/lib/cobbler/triggers/delete/system/pre/*", [], logger)
if with_sync:
lite_sync = action_litesync.BootLiteSync(self.config, logger=logger)
lite_sync.remove_single_system(name)
self.lock.acquire()
try:
del self.listing[name]
finally:
self.lock.release()
self.config.serialize_delete(self, obj)
if with_delete:
if with_triggers:
utils.run_triggers(self.config.api, obj, "/var/lib/cobbler/triggers/delete/system/post/*", [], logger)
utils.run_triggers(self.config.api, obj, "/var/lib/cobbler/triggers/change/*", [], logger)
return True
raise CX(_("cannot delete an object that does not exist: %s") % name)
def remove(self, name, with_delete=True, with_sync=True, with_triggers=True, recursive=False, logger=None):
"""
Remove element named 'name' from the collection
"""
name = name.lower()
if not recursive:
for v in self.config.systems():
if v.profile is not None and v.profile.lower() == name:
raise CX(_("removal would orphan system: %s") % v.name)
obj = self.find(name=name)
if obj is not None:
if recursive:
kids = obj.get_children()
for k in kids:
if k.COLLECTION_TYPE == "profile":
self.config.api.remove_profile(k.name, recursive=recursive, delete=with_delete, with_triggers=with_triggers, logger=logger)
else:
self.config.api.remove_system(k.name, recursive=recursive, delete=with_delete, with_triggers=with_triggers, logger=logger)
if with_delete:
if with_triggers:
utils.run_triggers(self.config.api, obj, "/var/lib/cobbler/triggers/delete/profile/pre/*", [], logger)
self.lock.acquire()
try:
del self.listing[name]
finally:
self.lock.release()
self.config.serialize_delete(self, obj)
if with_delete:
if with_triggers:
utils.run_triggers(self.config.api, obj, "/var/lib/cobbler/triggers/delete/profile/post/*", [], logger)
utils.run_triggers(self.config.api, obj, "/var/lib/cobbler/triggers/change/*", [], logger)
if with_sync:
lite_sync = action_litesync.BootLiteSync(self.config, logger=logger)
lite_sync.remove_single_profile(name)
return True
raise CX(_("cannot delete an object that does not exist: %s") % name)
def remove(self,
name,
with_delete=True,
with_sync=True,
with_triggers=True,
recursive=False,
logger=None):
"""
Remove element named 'name' from the collection
"""
name = name.lower()
# first see if any Groups use this distro
if not recursive:
for v in self.config.profiles():
if v.distro and v.distro.lower() == name:
raise CX(_("removal would orphan profile: %s") % v.name)
obj = self.find(name=name)
if obj is not None:
kernel = obj.kernel
if recursive:
kids = obj.get_children()
for k in kids:
self.config.api.remove_profile(k.name,
recursive=recursive,
delete=with_delete,
with_triggers=with_triggers,
logger=logger)
if with_delete:
if with_triggers:
utils.run_triggers(
self.config.api, obj,
"/var/lib/cobbler/triggers/delete/distro/pre/*", [],
logger)
if with_sync:
lite_sync = action_litesync.BootLiteSync(self.config,
logger=logger)
lite_sync.remove_single_distro(name)
del self.listing[name]
self.config.serialize_delete(self, obj)
if with_delete:
if with_triggers:
utils.run_triggers(
self.config.api, obj,
"/var/lib/cobbler/triggers/delete/distro/post/*", [],
logger)
utils.run_triggers(self.config.api, obj,
"/var/lib/cobbler/triggers/change/*",
[], logger)
# look through all mirrored directories and find if any directory is holding
# this particular distribution's kernel and initrd
settings = self.config.settings()
possible_storage = glob.glob(settings.webdir + "/ks_mirror/*")
path = None
for storage in possible_storage:
if os.path.dirname(obj.kernel).find(storage) != -1:
path = storage
continue
# if we found a mirrored path above, we can delete the mirrored storage /if/
# no other object is using the same mirrored storage.
if with_delete and path is not None and os.path.exists(
path) and kernel.find(settings.webdir) != -1:
# this distro was originally imported so we know we can clean up the associated
# storage as long as nothing else is also using this storage.
found = False
distros = self.api.distros()
for d in distros:
if d.kernel.find(path) != -1:
found = True
if not found:
utils.rmtree(path)
return True
class Collection:
def __init__(self, config):
"""
Constructor.
"""
self.config = config
self.clear()
self.api = self.config.api
self.lite_sync = None
def factory_produce(self, config, seed_data):
"""
Must override in subclass. Factory_produce returns an Item object
from datastructure seed_data
"""
raise exceptions.NotImplementedError
def clear(self):
"""
Forget about objects in the collection.
"""
self.listing = {}
def get(self, name):
"""
Return object with name in the collection
"""
return self.listing.get(name.lower(), None)
def find(self, name=None, return_list=False, no_errors=False, **kargs):
"""
Return first object in the collection that maches all item='value'
pairs passed, else return None if no objects can be found.
When return_list is set, can also return a list. Empty list
would be returned instead of None in that case.
"""
matches = []
# support the old style innovation without kwargs
if name is not None:
kargs["name"] = name
kargs = self.__rekey(kargs)
# no arguments is an error, so we don't return a false match
if len(kargs) == 0:
raise CX(_("calling find with no arguments"))
# performance: if the only key is name we can skip the whole loop
if len(kargs) == 1 and kargs.has_key("name") and not return_list:
return self.listing.get(kargs["name"].lower(), None)
for (name, obj) in self.listing.iteritems():
if obj.find_match(kargs, no_errors=no_errors):
matches.append(obj)
if not return_list:
if len(matches) == 0:
return None
return matches[0]
else:
return matches
SEARCH_REKEY = {
'kopts': 'kernel_options',
'kopts_post': 'kernel_options_post',
'ksmeta': 'ks_meta',
'inherit': 'parent',
'ip': 'ip_address',
'mac': 'mac_address',
'virt-auto-boot': 'virt_auto_boot',
'virt-file-size': 'virt_file_size',
'virt-disk-driver': 'virt_disk_driver',
'virt-ram': 'virt_ram',
'virt-path': 'virt_path',
'virt-type': 'virt_type',
'virt-bridge': 'virt_bridge',
'virt-cpus': 'virt_cpus',
'virt-host': 'virt_host',
'virt-group': 'virt_group',
'dhcp-tag': 'dhcp_tag',
'netboot-enabled': 'netboot_enabled',
'ldap-enabled': 'ldap_enabled',
'monit-enabled': 'monit_enabled'
}
def __rekey(self, hash):
"""
Find calls from the command line ("cobbler system find")
don't always match with the keys from the datastructs and this
makes them both line up without breaking compatibility with either.
Thankfully we don't have a LOT to remap.
"""
newhash = {}
for x in hash.keys():
if self.SEARCH_REKEY.has_key(x):
newkey = self.SEARCH_REKEY[x]
newhash[newkey] = hash[x]
else:
newhash[x] = hash[x]
return newhash
def to_datastruct(self):
"""
Serialize the collection
"""
datastruct = [x.to_datastruct() for x in self.listing.values()]
return datastruct
def from_datastruct(self, datastruct):
if datastruct is None:
return
for seed_data in datastruct:
item = self.factory_produce(self.config, seed_data)
self.add(item)
def copy(self, ref, newname, logger=None):
ref = ref.make_clone()
ref.uid = self.config.generate_uid()
ref.ctime = 0
ref.set_name(newname)
if ref.COLLECTION_TYPE == "system":
# this should only happen for systems
for iname in ref.interfaces.keys():
# clear all these out to avoid DHCP/DNS conflicts
ref.set_dns_name("", iname)
ref.set_mac_address("", iname)
ref.set_ip_address("", iname)
return self.add(ref,
save=True,
with_copy=True,
with_triggers=True,
with_sync=True,
check_for_duplicate_names=True,
check_for_duplicate_netinfo=False)
def rename(self,
ref,
newname,
with_sync=True,
with_triggers=True,
logger=None):
"""
Allows an object "ref" to be given a newname without affecting the rest
of the object tree.
"""
# Nothing to do when it is the same name
if newname == ref.name:
return True
# make a copy of the object, but give it a new name.
oldname = ref.name
newref = ref.make_clone()
newref.set_name(newname)
self.add(newref, with_triggers=with_triggers, save=True)
# for mgmt classes, update all objects that use it
if ref.COLLECTION_TYPE == "mgmtclass":
for what in ["distro", "profile", "system"]:
items = self.api.find_items(what, {"mgmt_classes": oldname})
for item in items:
for i in range(0, len(item.mgmt_classes)):
if item.mgmt_classes[i] == oldname:
item.mgmt_classes[i] = newname
self.api.add_item(what, item, save=True)
# for a repo, rename the mirror directory
if ref.COLLECTION_TYPE == "repo":
path = "/var/www/cobbler/repo_mirror/%s" % ref.name
if os.path.exists(path):
newpath = "/var/www/cobbler/repo_mirror/%s" % newref.name
os.renames(path, newpath)
# for a distro, rename the mirror and references to it
if ref.COLLECTION_TYPE == 'distro':
path = utils.find_distro_path(self.api.settings(), ref)
# create a symlink for the new distro name
utils.link_distro(self.api.settings(), newref)
# test to see if the distro path is based directly
# on the name of the distro. If it is, things need
# to updated accordingly
if os.path.exists(
path
) and path == "/var/www/cobbler/ks_mirror/%s" % ref.name:
newpath = "/var/www/cobbler/ks_mirror/%s" % newref.name
os.renames(path, newpath)
# update any reference to this path ...
distros = self.api.distros()
for d in distros:
if d.kernel.find(path) == 0:
d.set_kernel(d.kernel.replace(path, newpath))
d.set_initrd(d.initrd.replace(path, newpath))
self.config.serialize_item(self, d)
# now descend to any direct ancestors and point them at the new object allowing
# the original object to be removed without orphanage. Direct ancestors
# will either be profiles or systems. Note that we do have to care as
# set_parent is only really meaningful for subprofiles. We ideally want a more
# generic set_parent.
kids = ref.get_children()
for k in kids:
if k.COLLECTION_TYPE == "distro":
raise CX(
_("internal error, not expected to have distro child objects"
))
elif k.COLLECTION_TYPE == "profile":
if k.parent != "":
k.set_parent(newname)
else:
k.set_distro(newname)
self.api.profiles().add(k,
save=True,
with_sync=with_sync,
with_triggers=with_triggers)
elif k.COLLECTION_TYPE == "system":
k.set_profile(newname)
self.api.systems().add(k,
save=True,
with_sync=with_sync,
with_triggers=with_triggers)
elif k.COLLECTION_TYPE == "repo":
raise CX(
_("internal error, not expected to have repo child objects"
))
else:
raise CX(
_("internal error, unknown child type (%s), cannot finish rename"
% k.COLLECTION_TYPE))
# now delete the old version
self.remove(oldname, with_delete=True, with_triggers=with_triggers)
return True
def add(self,
ref,
save=False,
with_copy=False,
with_triggers=True,
with_sync=True,
quick_pxe_update=False,
check_for_duplicate_names=False,
check_for_duplicate_netinfo=False,
logger=None):
"""
Add an object to the collection, if it's valid. Returns True
if the object was added to the collection. Returns False if the
object specified by ref deems itself invalid (and therefore
won't be added to the collection).
with_copy is a bit of a misnomer, but lots of internal add operations
can run with "with_copy" as False. True means a real final commit, as if
entered from the command line (or basically, by a user).
With with_copy as False, the particular add call might just be being run
during deserialization, in which case extra semantics around the add don't really apply.
So, in that case, don't run any triggers and don't deal with any actual files.
"""
if ref is None or ref.name is None:
return False
try:
ref.check_if_valid()
except CX, error:
return False
if ref.uid == '':
ref.uid = self.config.generate_uid()
if save is True:
now = time.time()
if ref.ctime == 0:
ref.ctime = now
ref.mtime = now
if self.lite_sync is None:
self.lite_sync = action_litesync.BootLiteSync(self.config,
logger=logger)
# migration path for old API parameter that I've renamed.
if with_copy and not save:
save = with_copy
if not save:
# for people that aren't quite aware of the API
# if not saving the object, you can't run these features
with_triggers = False
with_sync = False
# Avoid adding objects to the collection
# if an object of the same/ip/mac already exists.
self.__duplication_checks(ref, check_for_duplicate_names,
check_for_duplicate_netinfo)
if ref.COLLECTION_TYPE != self.collection_type():
raise CX(_("API error: storing wrong data type in collection"))
if not save:
# don't need to run triggers, so add it already ...
self.listing[ref.name.lower()] = ref
# perform filesystem operations
if save:
# failure of a pre trigger will prevent the object from being added
if with_triggers:
utils.run_triggers(
self.api, ref, "/var/lib/cobbler/triggers/add/%s/pre/*" %
self.collection_type(), [], logger)
self.listing[ref.name.lower()] = ref
# save just this item if possible, if not, save
# the whole collection
self.config.serialize_item(self, ref)
if with_sync:
if isinstance(ref, item_system.System):
self.lite_sync.add_single_system(ref.name)
elif isinstance(ref, item_profile.Profile):
self.lite_sync.add_single_profile(ref.name)
elif isinstance(ref, item_distro.Distro):
self.lite_sync.add_single_distro(ref.name)
elif isinstance(ref, item_image.Image):
self.lite_sync.add_single_image(ref.name)
elif isinstance(ref, item_repo.Repo):
pass
elif isinstance(ref, item_mgmtclass.Mgmtclass):
pass
elif isinstance(ref, item_package.Package):
pass
elif isinstance(ref, item_file.File):
pass
else:
print _("Internal error. Object type not recognized: %s"
) % type(ref)
if not with_sync and quick_pxe_update:
if isinstance(ref, item_system.System):
self.lite_sync.update_system_netboot_status(ref.name)
# save the tree, so if neccessary, scripts can examine it.
if with_triggers:
utils.run_triggers(self.api, ref,
"/var/lib/cobbler/triggers/change/*", [],
logger)
utils.run_triggers(
self.api, ref, "/var/lib/cobbler/triggers/add/%s/post/*" %
self.collection_type(), [], logger)
# update children cache in parent object
parent = ref.get_parent()
if parent != None:
parent.children[ref.name] = ref
return True
def add(self,
ref,
save=False,
with_copy=False,
with_triggers=True,
with_sync=True,
quick_pxe_update=False,
check_for_duplicate_names=False,
check_for_duplicate_netinfo=False,
logger=None):
"""
Add an object to the collection, if it's valid. Returns True
if the object was added to the collection. Returns False if the
object specified by ref deems itself invalid (and therefore
won't be added to the collection).
with_copy is a bit of a misnomer, but lots of internal add operations
can run with "with_copy" as False. True means a real final commit, as if
entered from the command line (or basically, by a user).
With with_copy as False, the particular add call might just be being run
during deserialization, in which case extra semantics around the add don't really apply.
So, in that case, don't run any triggers and don't deal with any actual files.
"""
if ref is None or ref.name is None:
return False
try:
ref.check_if_valid()
except CX:
return False
if ref.uid == '':
ref.uid = self.config.generate_uid()
if save is True:
now = time.time()
if ref.ctime == 0:
ref.ctime = now
ref.mtime = now
if self.lite_sync is None:
self.lite_sync = action_litesync.BootLiteSync(self.config,
logger=logger)
# migration path for old API parameter that I've renamed.
if with_copy and not save:
save = with_copy
if not save:
# for people that aren't quite aware of the API
# if not saving the object, you can't run these features
with_triggers = False
with_sync = False
# Avoid adding objects to the collection
# if an object of the same/ip/mac already exists.
self.__duplication_checks(ref, check_for_duplicate_names,
check_for_duplicate_netinfo)
if ref.COLLECTION_TYPE != self.collection_type():
raise CX(_("API error: storing wrong data type in collection"))
if not save:
# don't need to run triggers, so add it already ...
self.lock.acquire()
try:
self.listing[ref.name.lower()] = ref
finally:
self.lock.release()
# perform filesystem operations
if save:
# failure of a pre trigger will prevent the object from being added
if with_triggers:
utils.run_triggers(
self.api, ref, "/var/lib/cobbler/triggers/add/%s/pre/*" %
self.collection_type(), [], logger)
self.lock.acquire()
try:
self.listing[ref.name.lower()] = ref
finally:
self.lock.release()
# save just this item if possible, if not, save
# the whole collection
self.config.serialize_item(self, ref)
if with_sync:
if isinstance(ref, item_system.System):
# we don't need openvz containers to be network bootable
if ref.virt_type == "openvz":
ref.netboot_enabled = False
self.lite_sync.add_single_system(ref.name)
elif isinstance(ref, item_profile.Profile):
# we don't need openvz containers to be network bootable
if ref.virt_type == "openvz":
ref.enable_menu = 0
self.lite_sync.add_single_profile(ref.name)
elif isinstance(ref, item_distro.Distro):
self.lite_sync.add_single_distro(ref.name)
elif isinstance(ref, item_image.Image):
self.lite_sync.add_single_image(ref.name)
elif isinstance(ref, item_repo.Repo):
pass
elif isinstance(ref, item_mgmtclass.Mgmtclass):
pass
elif isinstance(ref, item_package.Package):
pass
elif isinstance(ref, item_file.File):
pass
else:
print _("Internal error. Object type not recognized: %s"
) % type(ref)
if not with_sync and quick_pxe_update:
if isinstance(ref, item_system.System):
self.lite_sync.update_system_netboot_status(ref.name)
# save the tree, so if neccessary, scripts can examine it.
if with_triggers:
utils.run_triggers(self.api, ref,
"/var/lib/cobbler/triggers/change/*", [],
logger)
utils.run_triggers(
self.api, ref, "/var/lib/cobbler/triggers/add/%s/post/*" %
self.collection_type(), [], logger)
# update children cache in parent object
parent = ref.get_parent()
if parent != None:
parent.children[ref.name] = ref
return True
