/usr/lib/python2.7/dist-packages/Bcfg2/Reporting/Storage/DjangoORM.py is in bcfg2-server 1.4.0~pre2+git141-g6d40dace6358-1.
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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 | """
The base for the original DjangoORM (DBStats)
"""
import difflib
import traceback
from datetime import datetime
from time import strptime
from lxml import etree
import django
from django.core.exceptions import ObjectDoesNotExist, MultipleObjectsReturned
from django.db.models import FieldDoesNotExist
from django.core.cache import cache
import Bcfg2.Options
import Bcfg2.DBSettings
from Bcfg2.Compat import b64decode, md5
from Bcfg2.Reporting.Compat import transaction
from Bcfg2.Reporting.Storage.base import StorageBase, StorageError
from Bcfg2.Server.Plugin.exceptions import PluginExecutionError
def load_django_models():
""" Load models for Django after option parsing has completed """
# pylint: disable=W0602
global Interaction, PackageEntry, FilePerms, PathEntry, LinkEntry, \
Group, Client, Bundle, TYPE_EXTRA, TYPE_BAD, TYPE_MODIFIED, \
FailureEntry, Performance, BaseEntry
# pylint: enable=W0602
from Bcfg2.Reporting.models import \
Interaction, PackageEntry, FilePerms, PathEntry, LinkEntry, \
Group, Client, Bundle, TYPE_EXTRA, TYPE_BAD, TYPE_MODIFIED, \
FailureEntry, Performance, BaseEntry
def get_all_field_names(model):
if django.VERSION[0] == 1 and django.VERSION[1] >= 8:
return [field.name
for field in model._meta.get_fields()
if field.auto_created == False and
not (field.is_relation and field.related_model is None)]
else:
return model._meta.get_all_field_names()
class DjangoORM(StorageBase):
options = StorageBase.options + [
Bcfg2.Options.Common.repository,
Bcfg2.Options.Option(
cf=('reporting', 'file_limit'),
type=Bcfg2.Options.Types.size,
help='Reporting file size limit',
default=1024 * 1024)]
options_parsed_hook = staticmethod(load_django_models)
def _import_default(self, entry, state, entrytype=None, defaults=None,
mapping=None, boolean=None, xforms=None):
""" Default entry importer. Maps the entry (in state
``state``) to an appropriate *Entry object; by default, this
is determined by the entry tag, e.g., from an Action entry an
ActionEntry object is created. This can be overridden with
``entrytype``, which should be the class to instantiate for
this entry.
``defaults`` is an optional mapping of <attribute
name>:<value> that will be used to set the default values for
various attributes.
``mapping`` is a mapping of <field name>:<attribute name> that
can be used to map fields that are named differently on the
XML entry and in the database model.
``boolean`` is a list of attribute names that should be
treated as booleans.
``xforms`` is a dict of <attribute name>:<function>, where the
given function will be applied to the value of the named
attribute before trying to store it in the database.
"""
if entrytype is None:
entrytype = globals()["%sEntry" % entry.tag]
if defaults is None:
defaults = dict()
if mapping is None:
mapping = dict()
if boolean is None:
boolean = []
if xforms is None:
xforms = dict()
mapping['exists'] = 'current_exists'
defaults['current_exists'] = 'true'
boolean.append("current_exists")
def boolean_xform(val):
try:
return val.lower() == "true"
except AttributeError:
return False
for attr in boolean + ["current_exists"]:
xforms[attr] = boolean_xform
act_dict = dict(state=state)
for fieldname in get_all_field_names(entrytype):
if fieldname in ['id', 'hash_key', 'state']:
continue
try:
field = entrytype._meta.get_field(fieldname)
except FieldDoesNotExist:
continue
attrname = mapping.get(fieldname, fieldname)
val = entry.get(fieldname, defaults.get(attrname))
act_dict[fieldname] = xforms.get(attrname, lambda v: v)(val)
self.logger.debug("Adding %s:%s" % (entry.tag, entry.get("name")))
return entrytype.entry_get_or_create(act_dict)
def _import_Action(self, entry, state):
return self._import_default(entry, state,
defaults=dict(status='check', rc=-1),
mapping=dict(output="rc"))
def _import_Package(self, entry, state):
name = entry.get('name')
exists = entry.get('current_exists', default="true").lower() == "true"
act_dict = dict(name=name, state=state, exists=exists,
target_version=entry.get('version', default=''),
current_version=entry.get('current_version',
default=''))
# extra entries are a bit different. They can have Instance
# objects
if not act_dict['target_version']:
instance = entry.find("Instance")
if instance:
release = instance.get('release', '')
arch = instance.get('arch', '')
act_dict['current_version'] = instance.get('version')
if release:
act_dict['current_version'] += "-" + release
if arch:
act_dict['current_version'] += "." + arch
self.logger.debug("Adding extra package %s %s" %
(name, act_dict['current_version']))
else:
self.logger.debug("Adding package %s %s" %
(name, act_dict['target_version']))
# not implemented yet
act_dict['verification_details'] = \
entry.get('verification_details', '')
return PackageEntry.entry_get_or_create(act_dict)
def _import_Path(self, entry, state):
name = entry.get('name')
exists = entry.get('current_exists', default="true").lower() == "true"
path_type = entry.get("type").lower()
act_dict = dict(name=name, state=state, exists=exists,
path_type=path_type)
target_dict = dict(
owner=entry.get('owner', default="root"),
group=entry.get('group', default="root"),
mode=entry.get('mode', default=entry.get('perms',
default=""))
)
fperm, created = FilePerms.objects.get_or_create(**target_dict)
act_dict['target_perms'] = fperm
current_dict = dict(
owner=entry.get('current_owner', default=""),
group=entry.get('current_group', default=""),
mode=entry.get('current_mode',
default=entry.get('current_perms', default=""))
)
fperm, created = FilePerms.objects.get_or_create(**current_dict)
act_dict['current_perms'] = fperm
if path_type in ('symlink', 'hardlink'):
act_dict['target_path'] = entry.get('to', default="")
act_dict['current_path'] = entry.get('current_to', default="")
self.logger.debug("Adding link %s" % name)
return LinkEntry.entry_get_or_create(act_dict)
elif path_type == 'device':
# TODO devices
self.logger.warn("device path types are not supported yet")
return
# TODO - vcs output
act_dict['detail_type'] = PathEntry.DETAIL_UNUSED
if path_type == 'directory' and entry.get('prune', 'false') == 'true':
unpruned_elist = [e.get('name') for e in entry.findall('Prune')]
if unpruned_elist:
act_dict['detail_type'] = PathEntry.DETAIL_PRUNED
act_dict['details'] = "\n".join(unpruned_elist)
elif entry.get('sensitive', 'false').lower() == 'true':
act_dict['detail_type'] = PathEntry.DETAIL_SENSITIVE
else:
cdata = None
if entry.get('current_bfile', None):
act_dict['detail_type'] = PathEntry.DETAIL_BINARY
cdata = entry.get('current_bfile')
elif entry.get('current_bdiff', None):
act_dict['detail_type'] = PathEntry.DETAIL_DIFF
cdata = b64decode(entry.get('current_bdiff'))
elif entry.get('current_diff', None):
act_dict['detail_type'] = PathEntry.DETAIL_DIFF
cdata = entry.get('current_bdiff')
if cdata:
if len(cdata) > Bcfg2.Options.setup.file_limit:
act_dict['detail_type'] = PathEntry.DETAIL_SIZE_LIMIT
act_dict['details'] = md5(cdata).hexdigest()
else:
act_dict['details'] = cdata
self.logger.debug("Adding path %s" % name)
return PathEntry.entry_get_or_create(act_dict)
# TODO - secontext
# TODO - acls
def _import_Service(self, entry, state):
return self._import_default(entry, state,
defaults=dict(status='',
current_status='',
target_status=''),
mapping=dict(status='target_status'))
def _import_SEBoolean(self, entry, state):
return self._import_default(
entry, state,
xforms=dict(value=lambda v: v.lower() == "on"))
def _import_SEFcontext(self, entry, state):
return self._import_default(entry, state,
defaults=dict(filetype='all'))
def _import_SEInterface(self, entry, state):
return self._import_default(entry, state)
def _import_SEPort(self, entry, state):
return self._import_default(entry, state)
def _import_SENode(self, entry, state):
return self._import_default(entry, state)
def _import_SELogin(self, entry, state):
return self._import_default(entry, state)
def _import_SEUser(self, entry, state):
return self._import_default(entry, state)
def _import_SEPermissive(self, entry, state):
return self._import_default(entry, state)
def _import_SEModule(self, entry, state):
return self._import_default(entry, state,
defaults=dict(disabled='false'),
boolean=['disabled', 'current_disabled'])
def _import_POSIXUser(self, entry, state):
defaults = dict(group=entry.get("name"),
gecos=entry.get("name"),
shell='/bin/bash',
uid=entry.get("current_uid"))
if entry.get('name') == 'root':
defaults['home'] = '/root'
else:
defaults['home'] = '/home/%s' % entry.get('name')
# TODO: supplementary group membership
return self._import_default(entry, state, defaults=defaults)
def _import_POSIXGroup(self, entry, state):
return self._import_default(
entry, state,
defaults=dict(gid=entry.get("current_gid")))
def _import_unknown(self, entry, _):
self.logger.error("Unknown type %s not handled by reporting yet" %
entry.tag)
return None
@transaction.atomic
def _import_interaction(self, interaction):
"""Real import function"""
hostname = interaction['hostname']
stats = etree.fromstring(interaction['stats'])
metadata = interaction['metadata']
server = metadata['server']
client = cache.get(hostname)
if not client:
client, created = Client.objects.get_or_create(name=hostname)
if created:
self.logger.debug("Client %s added to the db" % hostname)
cache.set(hostname, client)
timestamp = datetime(*strptime(stats.get('time'))[0:6])
if len(Interaction.objects.filter(client=client,
timestamp=timestamp)) > 0:
self.logger.warn("Interaction for %s at %s already exists" %
(hostname, timestamp))
return
if 'profile' in metadata:
profile, created = \
Group.objects.get_or_create(name=metadata['profile'])
else:
profile = None
flags = {'dry_run': False, 'only_important': False}
for flag in stats.findall('./Flags/Flag'):
value = flag.get('value', default='false').lower() == 'true'
name = flag.get('name')
if name in flags:
flags[name] = value
inter = Interaction(client=client,
timestamp=timestamp,
state=stats.get('state', default="unknown"),
repo_rev_code=stats.get('revision',
default="unknown"),
good_count=stats.get('good', default="0"),
total_count=stats.get('total', default="0"),
server=server,
profile=profile,
**flags)
inter.save()
self.logger.debug("Interaction for %s at %s with INSERTED in to db" %
(client.id, timestamp))
# FIXME - this should be more efficient
for group_name in metadata['groups']:
group = cache.get("GROUP_" + group_name)
if not group:
group, created = Group.objects.get_or_create(name=group_name)
if created:
self.logger.debug("Added group %s" % group)
cache.set("GROUP_" + group_name, group)
inter.groups.add(group)
for bundle_name in metadata.get('bundles', []):
bundle = cache.get("BUNDLE_" + bundle_name)
if not bundle:
bundle, created = \
Bundle.objects.get_or_create(name=bundle_name)
if created:
self.logger.debug("Added bundle %s" % bundle)
cache.set("BUNDLE_" + bundle_name, bundle)
inter.bundles.add(bundle)
inter.save()
counter_fields = {TYPE_BAD: 0,
TYPE_MODIFIED: 0,
TYPE_EXTRA: 0}
pattern = [('Bad/*', TYPE_BAD),
('Extra/*', TYPE_EXTRA),
('Modified/*', TYPE_MODIFIED)]
updates = dict([(etype, []) for etype in Interaction.entry_types])
for (xpath, state) in pattern:
for entry in stats.findall(xpath):
counter_fields[state] = counter_fields[state] + 1
# handle server failures differently
failure = entry.get('failure', '')
if failure:
act_dict = dict(name=entry.get("name"),
entry_type=entry.tag,
message=failure)
newact = FailureEntry.entry_get_or_create(act_dict)
updates['failures'].append(newact)
continue
updatetype = entry.tag.lower() + "s"
update = getattr(self, "_import_%s" % entry.tag,
self._import_unknown)(entry, state)
if update is not None:
updates[updatetype].append(update)
inter.bad_count = counter_fields[TYPE_BAD]
inter.modified_count = counter_fields[TYPE_MODIFIED]
inter.extra_count = counter_fields[TYPE_EXTRA]
inter.save()
for entry_type in updates.keys():
# batch this for sqlite
i = 0
while(i < len(updates[entry_type])):
getattr(inter, entry_type).add(*updates[entry_type][i:i + 100])
i += 100
# performance metrics
for times in stats.findall('OpStamps'):
for metric, value in list(times.items()):
Performance(interaction=inter,
metric=metric,
value=value).save()
def import_interaction(self, interaction):
"""Import the data into the backend"""
try:
try:
self._import_interaction(interaction)
except:
self.logger.error("Failed to import interaction: %s" %
traceback.format_exc().splitlines()[-1])
finally:
self.logger.debug("%s: Closing database connection" %
self.__class__.__name__)
if django.VERSION[0] == 1 and django.VERSION[1] >= 7:
for connection in django.db.connections.all():
connection.close()
else:
django.db.close_connection()
def validate(self):
"""Validate backend storage. Should be called once when loaded"""
# verify our database schema
try:
if Bcfg2.Options.setup.debug:
vrb = 2
elif Bcfg2.Options.setup.verbose:
vrb = 1
else:
vrb = 0
Bcfg2.DBSettings.sync_databases(verbosity=vrb, interactive=False)
Bcfg2.DBSettings.migrate_databases(verbosity=vrb,
interactive=False)
except:
msg = "Failed to update database schema: %s" % sys.exc_info()[1]
self.logger.error(msg)
raise StorageError(msg)
def GetExtra(self, client):
"""Fetch extra entries for a client"""
try:
c_inst = Client.objects.get(name=client)
if not c_inst.current_interaction:
# the rare case where a client has no interations
return None
return [(ent.entry_type, ent.name) for ent in
c_inst.current_interaction.extra()]
except ObjectDoesNotExist:
return []
except MultipleObjectsReturned:
self.logger.error("%s Inconsistency: Multiple entries for %s." %
(self.__class__.__name__, client))
return []
def GetCurrentEntry(self, client, e_type, e_name):
""""GetCurrentEntry: Used by PullSource"""
try:
c_inst = Client.objects.get(name=client)
except ObjectDoesNotExist:
self.logger.error("Unknown client: %s" % client)
raise PluginExecutionError
except MultipleObjectsReturned:
self.logger.error("%s Inconsistency: Multiple entries for %s." %
(self.__class__.__name__, client))
raise PluginExecutionError
try:
cls = BaseEntry.entry_from_name(e_type + "Entry")
result = cls.objects.filter(name=e_name, state=TYPE_BAD,
interaction=c_inst.current_interaction)
except ValueError:
self.logger.error("Unhandled type %s" % e_type)
raise PluginExecutionError
if not result:
raise PluginExecutionError
entry = result[0]
ret = []
for p_entry in ('owner', 'group', 'mode'):
this_entry = getattr(entry.current_perms, p_entry)
if this_entry == '':
ret.append(getattr(entry.target_perms, p_entry))
else:
ret.append(this_entry)
if entry.entry_type == 'Path':
if entry.is_sensitive():
raise PluginExecutionError
elif entry.detail_type == PathEntry.DETAIL_PRUNED:
ret.append('\n'.join(entry.details))
elif entry.is_binary():
ret.append(b64decode(entry.details))
elif entry.is_diff():
ret.append('\n'.join(difflib.restore(\
entry.details.split('\n'), 1)))
elif entry.is_too_large():
# If len is zero the object was too large to store
raise PluginExecutionError
else:
ret.append(None)
return ret
|