/usr/share/pyshared/cobbler/modules/serializer_catalog.py is in python-cobbler 2.2.2-0ubuntu33.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | """
Serializer code for cobbler.
As of 8/2009, this is the "best" serializer option.
It uses multiple files in /var/lib/cobbler/config/distros.d, profiles.d, etc
And JSON, when possible, and YAML, when not.
It is particularly fast, especially when using JSON. YAML, not so much.
It also knows how to upgrade the old "single file" configs to .d versions.
Copyright 2006-2009, 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 distutils.sysconfig
import os
import sys
import glob
import traceback
import yaml # PyYAML
import simplejson
import exceptions
plib = distutils.sysconfig.get_python_lib()
mod_path="%s/cobbler" % plib
sys.path.insert(0, mod_path)
from utils import _
import utils
from cexceptions import *
import os
def can_use_json():
version = sys.version[:3]
version = float(version)
return (version > 2.3)
def register():
"""
The mandatory cobbler module registration hook.
"""
return "serializer"
def what():
"""
Module identification function
"""
return "serializer/catalog"
def serialize_item(obj, item):
if item.name is None or item.name == "":
raise exceptions.RuntimeError("name unset for object!")
# FIXME: Need a better way to support collections/items
# appending an 's' does not work in all cases
if obj.collection_type() in [ 'mgmtclass' ]:
filename = "/var/lib/cobbler/config/%ses.d/%s" % (obj.collection_type(),item.name)
else:
filename = "/var/lib/cobbler/config/%ss.d/%s" % (obj.collection_type(),item.name)
datastruct = item.to_datastruct()
jsonable = can_use_json()
if jsonable:
# avoid using JSON on python 2.3 where we can encounter
# unicode problems with simplejson pre 2.0
if os.path.exists(filename):
print "upgrading yaml file to json: %s" % filename
os.remove(filename)
filename = filename + ".json"
datastruct = item.to_datastruct()
fd = open(filename,"w+")
data = simplejson.dumps(datastruct, encoding="utf-8")
#data = data.encode('utf-8')
fd.write(data)
else:
if os.path.exists(filename + ".json"):
print "downgrading json file back to yaml: %s" % filename
os.remove(filename + ".json")
datastruct = item.to_datastruct()
fd = open(filename,"w+")
data = yaml.dump(datastruct)
fd.write(data)
fd.close()
return True
def serialize_delete(obj, item):
# FIXME: Need a better way to support collections/items
# appending an 's' does not work in all cases
if obj.collection_type() in [ 'mgmtclass', ]:
filename = "/var/lib/cobbler/config/%ses.d/%s" % (obj.collection_type(),item.name)
else:
filename = "/var/lib/cobbler/config/%ss.d/%s" % (obj.collection_type(),item.name)
filename2 = filename + ".json"
if os.path.exists(filename):
os.remove(filename)
if os.path.exists(filename2):
os.remove(filename2)
return True
def deserialize_item_raw(collection_type, item_name):
# this new fn is not really implemented performantly in this module.
# yet.
# FIXME: Need a better way to support collections/items
# appending an 's' does not work in all cases
if item_name in [ 'mgmtclass' ]:
filename = "/var/lib/cobbler/config/%ses.d/%s" % (collection_type(),item_name)
else:
filename = "/var/lib/cobbler/config/%ss.d/%s" % (collection_type,item_name)
filename2 = filename + ".json"
if os.path.exists(filename):
fd = open(filename)
data = fd.read()
return yaml.safe_load(data)
elif os.path.exists(filename2):
fd = open(filename2)
data = fd.read()
return simplejson.loads(data, encoding="utf-8")
else:
return None
def serialize(obj):
"""
Save an object to disk. Object must "implement" Serializable.
FIXME: Return False on access/permission errors.
This should NOT be used by API if serialize_item is available.
"""
ctype = obj.collection_type()
if ctype == "settings":
return True
for x in obj:
serialize_item(obj,x)
return True
def deserialize_raw(collection_type):
# FIXME: Need a better way to support collections/items
# appending an 's' does not work in all cases
if collection_type in [ 'mgmtclass' ]:
old_filename = "/var/lib/cobbler/%ses" % collection_type
else:
old_filename = "/var/lib/cobbler/%ss" % collection_type
if collection_type == "settings":
fd = open("/etc/cobbler/settings")
datastruct = yaml.safe_load(fd.read())
fd.close()
return datastruct
elif os.path.exists(old_filename):
# for use in migration from serializer_yaml to serializer_catalog (yaml/json)
fd = open(old_filename)
datastruct = yaml.safe_load(fd.read())
fd.close()
return datastruct
else:
results = []
# FIXME: Need a better way to support collections/items
# appending an 's' does not work in all cases
if collection_type in [ 'mgmtclass' ]:
all_files = glob.glob("/var/lib/cobbler/config/%ses.d/*" % collection_type)
else:
all_files = glob.glob("/var/lib/cobbler/config/%ss.d/*" % collection_type)
all_files = filter_upgrade_duplicates(all_files)
for f in all_files:
fd = open(f)
ydata = fd.read()
# ydata = ydata.decode()
if f.endswith(".json"):
datastruct = simplejson.loads(ydata, encoding='utf-8')
else:
datastruct = yaml.safe_load(ydata)
results.append(datastruct)
fd.close()
return results
def filter_upgrade_duplicates(file_list):
"""
In a set of files, some ending with .json, some not, return
the list of files with the .json ones taking priority over
the ones that are not.
"""
bases = {}
for f in file_list:
basekey = f.replace(".json","")
if f.endswith(".json"):
bases[basekey] = f
else:
lookup = bases.get(basekey,"")
if not lookup.endswith(".json"):
bases[basekey] = f
return bases.values()
def deserialize(obj,topological=True):
"""
Populate an existing object with the contents of datastruct.
Object must "implement" Serializable.
"""
# FIXME: Need a better way to support collections/items
# appending an 's' does not work in all cases
if obj.collection_type() in [ 'mgmtclass' ]:
old_filename = "/var/lib/cobbler/%ses" % obj.collection_type()
else:
old_filename = "/var/lib/cobbler/%ss" % obj.collection_type()
datastruct = deserialize_raw(obj.collection_type())
if topological and type(datastruct) == list:
datastruct.sort(__depth_cmp)
obj.from_datastruct(datastruct)
if os.path.exists(old_filename):
# we loaded it in from the old filename, so now migrate to new fmt
sys.stderr.write("auto-removing old config format: %s\n" % old_filename)
serialize(obj)
os.remove(old_filename)
return True
def __depth_cmp(item1, item2):
d1 = item1.get("depth",1)
d2 = item2.get("depth",1)
return cmp(d1,d2)
if __name__ == "__main__":
print deserialize_item_raw("distro","D1")
|