<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Bcfg2.Server.Plugins.Cfg — Bcfg2 1.3.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '1.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
<link rel="top" title="Bcfg2 1.3.0 documentation" href="../../../../index.html" />
<link rel="up" title="Bcfg2.Server.Plugins" href="../Plugins.html" />
<link rel="stylesheet" href="../../../../_static/bcfg2.css" type=""/>
</head>
<body>
<div style="text-align: left; padding: 10px 10px 15px 15px">
<a href="../../../../index.html"><img src="../../../../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../../index.html">home</a> | </li>
<!--<li><a href="../../../../search.html">search</a> | </li>-->
<li><a href="../../../../help/index.html">help</a> | </li>
<li><a href="../../../../contents.html">documentation </a> »</li>
<li><a href="../../../index.html" >Module code</a> »</li>
<li><a href="../Plugins.html" accesskey="U">Bcfg2.Server.Plugins</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for Bcfg2.Server.Plugins.Cfg</h1><div class="highlight"><pre>
<span class="sd">"""This module implements a config file repository."""</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">stat</span>
<span class="kn">import</span> <span class="nn">errno</span>
<span class="kn">import</span> <span class="nn">operator</span>
<span class="kn">import</span> <span class="nn">lxml.etree</span>
<span class="kn">import</span> <span class="nn">Bcfg2.Options</span>
<span class="kn">import</span> <span class="nn">Bcfg2.Server.Plugin</span>
<span class="kn">import</span> <span class="nn">Bcfg2.Server.Lint</span>
<span class="kn">from</span> <span class="nn">Bcfg2.Server.Plugin</span> <span class="kn">import</span> <span class="n">PluginExecutionError</span>
<span class="c"># pylint: disable=W0622</span>
<span class="kn">from</span> <span class="nn">Bcfg2.Compat</span> <span class="kn">import</span> <span class="n">u_str</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">,</span> <span class="n">b64encode</span><span class="p">,</span> <span class="n">walk_packages</span><span class="p">,</span> \
<span class="nb">any</span><span class="p">,</span> <span class="n">oct_mode</span>
<span class="c"># pylint: enable=W0622</span>
<span class="c">#: SETUP contains a reference to the</span>
<span class="c">#: :class:`Bcfg2.Options.OptionParser` created by the Bcfg2 core for</span>
<span class="c">#: parsing command-line and config file options.</span>
<span class="c">#: :class:`Bcfg2.Server.Plugins.Cfg.Cfg` stores it in a module global</span>
<span class="c">#: so that the handler objects can access it, because there is no other</span>
<span class="c">#: facility for passing a setup object from a</span>
<span class="c">#: :class:`Bcfg2.Server.Plugin.helpers.GroupSpool` to its</span>
<span class="c">#: :class:`Bcfg2.Server.Plugin.helpers.EntrySet` objects and thence to</span>
<span class="c">#: the EntrySet children.</span>
<span class="n">SETUP</span> <span class="o">=</span> <span class="bp">None</span>
<span class="c">#: CFG is a reference to the :class:`Bcfg2.Server.Plugins.Cfg.Cfg`</span>
<span class="c">#: plugin object created by the Bcfg2 core. This is provided so that</span>
<span class="c">#: the handler objects can access it as necessary, since the existing</span>
<span class="c">#: :class:`Bcfg2.Server.Plugin.helpers.GroupSpool` and</span>
<span class="c">#: :class:`Bcfg2.Server.Plugin.helpers.EntrySet` classes have no</span>
<span class="c">#: facility for passing it otherwise.</span>
<span class="n">CFG</span> <span class="o">=</span> <span class="bp">None</span>
<div class="viewcode-block" id="CfgBaseFileMatcher"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgBaseFileMatcher">[docs]</a><span class="k">class</span> <span class="nc">CfgBaseFileMatcher</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">SpecificData</span><span class="p">,</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">Debuggable</span><span class="p">):</span>
<span class="sd">""" .. currentmodule:: Bcfg2.Server.Plugins.Cfg</span>
<span class="sd"> CfgBaseFileMatcher is the parent class for all Cfg handler</span>
<span class="sd"> objects. """</span>
<span class="c">#: The set of filenames handled by this handler. If</span>
<span class="c">#: ``__basenames__`` is the empty list, then the basename of each</span>
<span class="c">#: :class:`CfgEntrySet` is used -- i.e., the name of the directory</span>
<span class="c">#: that contains the file is used for the basename.</span>
<span class="n">__basenames__</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c">#: This handler only handles files with the listed extensions</span>
<span class="c">#: (which come *after* :attr:`CfgBaseFileMatcher.__specific__`</span>
<span class="c">#: indicators).</span>
<span class="n">__extensions__</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c">#: This handler ignores all files with the listed extensions. A</span>
<span class="c">#: file that is ignored by a handler will not be handled by any</span>
<span class="c">#: other handlers; that is, a file is ignored if any handler</span>
<span class="c">#: ignores it. Ignoring a file is not simply a means to defer</span>
<span class="c">#: handling of that file to another handler.</span>
<span class="n">__ignore__</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c">#: Whether or not the files handled by this handler are permitted</span>
<span class="c">#: to have specificity indicators in their filenames -- e.g.,</span>
<span class="c">#: ``.H_client.example.com`` or ``.G10_foogroup``.</span>
<span class="n">__specific__</span> <span class="o">=</span> <span class="bp">True</span>
<span class="c">#: Cfg handlers are checked in ascending order of priority to see</span>
<span class="c">#: if they handle a given event. If this explicit priority is not</span>
<span class="c">#: set, then :class:`CfgPlaintextGenerator.CfgPlaintextGenerator`</span>
<span class="c">#: would match against nearly every other sort of generator file</span>
<span class="c">#: if it comes first. It's not necessary to set ``__priority__``</span>
<span class="c">#: on handlers where :attr:`CfgBaseFileMatcher.__specific__` is</span>
<span class="c">#: False, since they don't have a potentially open-ended regex</span>
<span class="n">__priority__</span> <span class="o">=</span> <span class="mi">0</span>
<span class="c">#: Flag to indicate a deprecated handler.</span>
<span class="n">deprecated</span> <span class="o">=</span> <span class="bp">False</span>
<span class="c">#: Flag to indicate an experimental handler.</span>
<span class="n">experimental</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">SpecificData</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span>
<span class="n">encoding</span><span class="p">)</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">Debuggable</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="n">encoding</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">SpecificData</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">+</span> \
<span class="sd">"""</span>
<span class="sd">.. -----</span>
<span class="sd">.. autoattribute:: CfgBaseFileMatcher.__basenames__</span>
<span class="sd">.. autoattribute:: CfgBaseFileMatcher.__extensions__</span>
<span class="sd">.. autoattribute:: CfgBaseFileMatcher.__ignore__</span>
<span class="sd">.. autoattribute:: CfgBaseFileMatcher.__specific__</span>
<span class="sd">.. autoattribute:: CfgBaseFileMatcher.__priority__ """</span>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="CfgBaseFileMatcher.get_regex"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgBaseFileMatcher.get_regex">[docs]</a> <span class="k">def</span> <span class="nf">get_regex</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">basenames</span><span class="p">):</span>
<span class="sd">""" Get a compiled regular expression to match filenames (not</span>
<span class="sd"> full paths) that this handler handles.</span>
<span class="sd"> :param basename: The base filename to use if</span>
<span class="sd"> :attr:`CfgBaseFileMatcher.__basenames__`</span>
<span class="sd"> is not defined (i.e., the name of the</span>
<span class="sd"> directory that contains the files the regex</span>
<span class="sd"> will be applied to)</span>
<span class="sd"> :type basename: string</span>
<span class="sd"> :returns: compiled regex</span>
<span class="sd"> """</span>
<span class="n">components</span> <span class="o">=</span> <span class="p">[</span><span class="s">'^(?P<basename></span><span class="si">%s</span><span class="s">)'</span> <span class="o">%</span> <span class="s">'|'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">b</span><span class="p">)</span>
<span class="k">for</span> <span class="n">b</span> <span class="ow">in</span> <span class="n">basenames</span><span class="p">)]</span>
<span class="k">if</span> <span class="n">cls</span><span class="o">.</span><span class="n">__specific__</span><span class="p">:</span>
<span class="n">components</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'(|</span><span class="se">\\</span><span class="s">.H_(?P<hostname>\S+?)|'</span> <span class="o">+</span>
<span class="s">'\.G(?P<prio>\d+)_(?P<group>\S+?))'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">cls</span><span class="o">.</span><span class="n">__extensions__</span><span class="p">:</span>
<span class="n">components</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'</span><span class="se">\\</span><span class="s">.(?P<extension></span><span class="si">%s</span><span class="s">)'</span> <span class="o">%</span>
<span class="s">'|'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cls</span><span class="o">.</span><span class="n">__extensions__</span><span class="p">))</span>
<span class="n">components</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'$'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">components</span><span class="p">))</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="CfgBaseFileMatcher.handles"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgBaseFileMatcher.handles">[docs]</a> <span class="k">def</span> <span class="nf">handles</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">basename</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">""" Return True if this handler handles the file described by</span>
<span class="sd"> ``event``. This is faster than just applying</span>
<span class="sd"> :func:`CfgBaseFileMatcher.get_regex`</span>
<span class="sd"> because it tries to do non-regex matching first.</span>
<span class="sd"> :param event: The FAM event to check</span>
<span class="sd"> :type event: Bcfg2.Server.FileMonitor.Event</span>
<span class="sd"> :param basename: The base filename to use if</span>
<span class="sd"> :attr:`CfgBaseFileMatcher.__basenames__`</span>
<span class="sd"> is not defined (i.e., the name of the</span>
<span class="sd"> directory that contains the files the regex</span>
<span class="sd"> will be applied to)</span>
<span class="sd"> :type basename: string</span>
<span class="sd"> :returns: bool - True if this handler handles the file listed</span>
<span class="sd"> in the event, False otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">cls</span><span class="o">.</span><span class="n">__basenames__</span><span class="p">:</span>
<span class="n">basenames</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">__basenames__</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">basenames</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">basename</span><span class="p">)]</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">cls</span><span class="o">.</span><span class="n">get_regex</span><span class="p">(</span><span class="n">basenames</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">))</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="CfgBaseFileMatcher.ignore"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgBaseFileMatcher.ignore">[docs]</a> <span class="k">def</span> <span class="nf">ignore</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">basename</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> <span class="c"># pylint: disable=W0613</span>
<span class="sd">""" Return True if this handler ignores the file described by</span>
<span class="sd"> ``event``. See</span>
<span class="sd"> :attr:`CfgBaseFileMatcher.__ignore__`</span>
<span class="sd"> for more information on how ignoring files works.</span>
<span class="sd"> :param event: The FAM event to check</span>
<span class="sd"> :type event: Bcfg2.Server.FileMonitor.Event</span>
<span class="sd"> :param basename: The base filename to use if</span>
<span class="sd"> :attr:`CfgBaseFileMatcher.__basenames__`</span>
<span class="sd"> is not defined (i.e., the name of the</span>
<span class="sd"> directory that contains the files the regex</span>
<span class="sd"> will be applied to)</span>
<span class="sd"> :type basename: string</span>
<span class="sd"> :returns: bool - True if this handler handles the file listed</span>
<span class="sd"> in the event, False otherwise.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">any</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"."</span> <span class="o">+</span> <span class="n">e</span><span class="p">)</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">cls</span><span class="o">.</span><span class="n">__ignore__</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="CfgGenerator"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgGenerator">[docs]</a><span class="k">class</span> <span class="nc">CfgGenerator</span><span class="p">(</span><span class="n">CfgBaseFileMatcher</span><span class="p">):</span>
<span class="sd">""" CfgGenerators generate the initial content of a file. Every</span>
<span class="sd"> valid :class:`Bcfg2.Server.Plugins.Cfg.CfgEntrySet` must have at</span>
<span class="sd"> least one file handled by a CfgGenerator. Moreover, each</span>
<span class="sd"> CfgEntrySet must have one unambiguously best handler for each</span>
<span class="sd"> client. See :class:`Bcfg2.Server.Plugin.helpers.EntrySet` for more</span>
<span class="sd"> details on how the best handler is chosen."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
<span class="c"># we define an __init__ that just calls the parent __init__,</span>
<span class="c"># so that we can set the docstring on __init__ to something</span>
<span class="c"># different from the parent __init__ -- namely, the parent</span>
<span class="c"># __init__ docstring, minus everything after ``.. -----``,</span>
<span class="c"># which we use to delineate the actual docs from the</span>
<span class="c"># .. autoattribute hacks we have to do to get private</span>
<span class="c"># attributes included in sphinx 1.0 """</span>
<span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">".. -----"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<div class="viewcode-block" id="CfgGenerator.get_data"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgGenerator.get_data">[docs]</a> <span class="k">def</span> <span class="nf">get_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span> <span class="c"># pylint: disable=W0613</span>
<span class="sd">""" get_data() returns the initial data of a file.</span>
<span class="sd"> :param entry: The entry to generate data for. ``entry`` should</span>
<span class="sd"> not be modified in-place.</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to generate data for.</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: string - the contents of the entry</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
</div></div>
<div class="viewcode-block" id="CfgFilter"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgFilter">[docs]</a><span class="k">class</span> <span class="nc">CfgFilter</span><span class="p">(</span><span class="n">CfgBaseFileMatcher</span><span class="p">):</span>
<span class="sd">""" CfgFilters modify the initial content of a file after it has</span>
<span class="sd"> been generated by a :class:`Bcfg2.Server.Plugins.Cfg.CfgGenerator`. """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
<span class="c"># see comment on CfgGenerator.__init__ above</span>
<span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">".. -----"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<div class="viewcode-block" id="CfgFilter.modify_data"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgFilter.modify_data">[docs]</a> <span class="k">def</span> <span class="nf">modify_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">""" Return new data for the entry, based on the initial data</span>
<span class="sd"> produced by the :class:`Bcfg2.Server.Plugins.Cfg.CfgGenerator`.</span>
<span class="sd"> :param entry: The entry to filter data for. ``entry`` should</span>
<span class="sd"> not be modified in-place.</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to filter data for.</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :param data: The initial contents of the entry produced by the</span>
<span class="sd"> CfgGenerator</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :returns: string - the new contents of the entry</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</div></div>
<div class="viewcode-block" id="CfgInfo"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgInfo">[docs]</a><span class="k">class</span> <span class="nc">CfgInfo</span><span class="p">(</span><span class="n">CfgBaseFileMatcher</span><span class="p">):</span>
<span class="sd">""" CfgInfo handlers provide metadata (owner, group, paranoid,</span>
<span class="sd"> etc.) for a file entry.</span>
<span class="sd"> .. private-include: _set_info</span>
<span class="sd"> """</span>
<span class="c">#: Whether or not the files handled by this handler are permitted</span>
<span class="c">#: to have specificity indicators in their filenames -- e.g.,</span>
<span class="c">#: ``.H_client.example.com`` or ``.G10_foogroup``. By default</span>
<span class="c">#: CfgInfo handlers do not allow specificities</span>
<span class="n">__specific__</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fname</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param name: The full path to the file</span>
<span class="sd"> :type name: string</span>
<span class="sd"> .. -----</span>
<span class="sd"> .. autoattribute:: Bcfg2.Server.Plugins.Cfg.CfgInfo.__specific__</span>
<span class="sd"> """</span>
<span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fname</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<div class="viewcode-block" id="CfgInfo.bind_info_to_entry"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgInfo.bind_info_to_entry">[docs]</a> <span class="k">def</span> <span class="nf">bind_info_to_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">""" Assign the appropriate attributes to the entry, modifying</span>
<span class="sd"> it in place.</span>
<span class="sd"> :param entry: The abstract entry to bind the info to</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to get info for</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</div>
<div class="viewcode-block" id="CfgInfo._set_info"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgInfo._set_info">[docs]</a> <span class="k">def</span> <span class="nf">_set_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
<span class="sd">""" Helper function to assign a dict of info attributes to an</span>
<span class="sd"> entry object. ``entry`` is modified in-place.</span>
<span class="sd"> :param entry: The abstract entry to bind the info to</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param info: A dict of attribute: value pairs</span>
<span class="sd"> :type info: dict</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">info</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"__"</span><span class="p">):</span>
<span class="n">entry</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
</div></div>
<div class="viewcode-block" id="CfgVerifier"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgVerifier">[docs]</a><span class="k">class</span> <span class="nc">CfgVerifier</span><span class="p">(</span><span class="n">CfgBaseFileMatcher</span><span class="p">):</span>
<span class="sd">""" CfgVerifier handlers validate entry data once it has been</span>
<span class="sd"> generated, filtered, and info applied. Validation can be enabled</span>
<span class="sd"> or disabled in the configuration. Validation can apply to the</span>
<span class="sd"> contents of an entry, the attributes on it (e.g., owner, group,</span>
<span class="sd"> etc.), or both.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
<span class="c"># see comment on CfgGenerator.__init__ above</span>
<span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">".. -----"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<div class="viewcode-block" id="CfgVerifier.verify_entry"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgVerifier.verify_entry">[docs]</a> <span class="k">def</span> <span class="nf">verify_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">""" Perform entry contents. validation.</span>
<span class="sd"> :param entry: The entry to validate data for. ``entry`` should</span>
<span class="sd"> not be modified in-place. Info attributes have</span>
<span class="sd"> been bound to the entry, but the text data has</span>
<span class="sd"> not been set.</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to validate data for.</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :param data: The contents of the entry</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :returns: None</span>
<span class="sd"> :raises: :exc:`Bcfg2.Server.Plugins.Cfg.CfgVerificationError`</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</div></div>
<div class="viewcode-block" id="CfgCreator"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgCreator">[docs]</a><span class="k">class</span> <span class="nc">CfgCreator</span><span class="p">(</span><span class="n">CfgBaseFileMatcher</span><span class="p">):</span>
<span class="sd">""" CfgCreator handlers create static entry data if no generator</span>
<span class="sd"> was found to generate any. A CfgCreator runs at most once per</span>
<span class="sd"> client, writes its data to disk as a static file, and is not</span>
<span class="sd"> called on subsequent runs by the same client. """</span>
<span class="c">#: CfgCreators generally store their configuration in a single XML</span>
<span class="c">#: file, and are thus not specific</span>
<span class="n">__specific__</span> <span class="o">=</span> <span class="bp">False</span>
<span class="c">#: The CfgCreator interface is experimental at this time</span>
<span class="n">experimental</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fname</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param name: The full path to the file</span>
<span class="sd"> :type name: string</span>
<span class="sd"> .. -----</span>
<span class="sd"> .. autoattribute:: Bcfg2.Server.Plugins.Cfg.CfgCreator.__specific__</span>
<span class="sd"> """</span>
<span class="n">CfgBaseFileMatcher</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fname</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<div class="viewcode-block" id="CfgCreator.create_data"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgCreator.create_data">[docs]</a> <span class="k">def</span> <span class="nf">create_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">""" Create new data for the given entry and write it to disk</span>
<span class="sd"> using :func:`Bcfg2.Server.Plugins.Cfg.CfgCreator.write_data`.</span>
<span class="sd"> :param entry: The entry to create data for.</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to create data for.</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: string - The contents of the entry</span>
<span class="sd"> :raises: :exc:`Bcfg2.Server.Plugins.Cfg.CfgCreationError`</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</div>
<div class="viewcode-block" id="CfgCreator.get_filename"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgCreator.get_filename">[docs]</a> <span class="k">def</span> <span class="nf">get_filename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">prio</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">ext</span><span class="o">=</span><span class="s">''</span><span class="p">):</span>
<span class="sd">""" Get the filename where the new data will be written. If</span>
<span class="sd"> ``host`` is given, it will be host-specific. It will be</span>
<span class="sd"> group-specific if ``group`` and ``prio`` are given. If</span>
<span class="sd"> neither ``host`` nor ``group`` is given, the filename will be</span>
<span class="sd"> non-specific.</span>
<span class="sd"> :param host: The file applies to the given host</span>
<span class="sd"> :type host: bool</span>
<span class="sd"> :param group: The file applies to the given group</span>
<span class="sd"> :type group: string</span>
<span class="sd"> :param prio: The file has the given priority relative to other</span>
<span class="sd"> objects that also apply to the same group.</span>
<span class="sd"> ``group`` must also be specified.</span>
<span class="sd"> :type prio: int</span>
<span class="sd"> :param ext: An extension to add after the specificity (e.g.,</span>
<span class="sd"> '.crypt', to signal that an encrypted file has</span>
<span class="sd"> been created)</span>
<span class="sd"> :type prio: string</span>
<span class="sd"> :returns: string - the filename</span>
<span class="sd"> """</span>
<span class="n">basefilename</span> <span class="o">=</span> \
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">),</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)))</span>
<span class="k">if</span> <span class="n">group</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">.G</span><span class="si">%02d</span><span class="s">_</span><span class="si">%s%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">basefilename</span><span class="p">,</span> <span class="n">prio</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">ext</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">host</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">.H_</span><span class="si">%s%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">basefilename</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">ext</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">basefilename</span><span class="p">,</span> <span class="n">ext</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="CfgCreator.write_data"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgCreator.write_data">[docs]</a> <span class="k">def</span> <span class="nf">write_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">prio</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">ext</span><span class="o">=</span><span class="s">''</span><span class="p">):</span>
<span class="sd">""" Write the new data to disk. If ``host`` is given, it is</span>
<span class="sd"> written as a host-specific file, or as a group-specific file</span>
<span class="sd"> if ``group`` and ``prio`` are given. If neither ``host`` nor</span>
<span class="sd"> ``group`` is given, it will be written as a non-specific file.</span>
<span class="sd"> :param data: The data to write</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :param host: The data applies to the given host</span>
<span class="sd"> :type host: bool</span>
<span class="sd"> :param group: The data applies to the given group</span>
<span class="sd"> :type group: string</span>
<span class="sd"> :param prio: The data has the given priority relative to other</span>
<span class="sd"> objects that also apply to the same group.</span>
<span class="sd"> ``group`` must also be specified.</span>
<span class="sd"> :type prio: int</span>
<span class="sd"> :param ext: An extension to add after the specificity (e.g.,</span>
<span class="sd"> '.crypt', to signal that an encrypted file has</span>
<span class="sd"> been created)</span>
<span class="sd"> :type prio: string</span>
<span class="sd"> :returns: None</span>
<span class="sd"> :raises: :exc:`Bcfg2.Server.Plugins.Cfg.CfgCreationError`</span>
<span class="sd"> """</span>
<span class="n">fileloc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_filename</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="n">host</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span> <span class="n">prio</span><span class="o">=</span><span class="n">prio</span><span class="p">,</span> <span class="n">ext</span><span class="o">=</span><span class="n">ext</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">: Writing new file </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">fileloc</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">fileloc</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="n">err</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EEXIST</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">CfgCreationError</span><span class="p">(</span><span class="s">"Could not create parent directories "</span>
<span class="s">"for </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">fileloc</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">open</span><span class="p">(</span><span class="n">fileloc</span><span class="p">,</span> <span class="s">'wb'</span><span class="p">)</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
<span class="n">err</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">raise</span> <span class="n">CfgCreationError</span><span class="p">(</span><span class="s">"Could not write </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">fileloc</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
</div></div>
<div class="viewcode-block" id="CfgVerificationError"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgVerificationError">[docs]</a><span class="k">class</span> <span class="nc">CfgVerificationError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">""" Raised by</span>
<span class="sd"> :func:`Bcfg2.Server.Plugins.Cfg.CfgVerifier.verify_entry` when an</span>
<span class="sd"> entry fails verification """</span>
<span class="k">pass</span>
</div>
<div class="viewcode-block" id="CfgCreationError"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgCreationError">[docs]</a><span class="k">class</span> <span class="nc">CfgCreationError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">""" Raised by</span>
<span class="sd"> :func:`Bcfg2.Server.Plugins.Cfg.CfgCreator.create_data` when data</span>
<span class="sd"> creation fails """</span>
<span class="k">pass</span>
</div>
<div class="viewcode-block" id="CfgDefaultInfo"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgDefaultInfo">[docs]</a><span class="k">class</span> <span class="nc">CfgDefaultInfo</span><span class="p">(</span><span class="n">CfgInfo</span><span class="p">):</span>
<span class="sd">""" :class:`Bcfg2.Server.Plugins.Cfg.Cfg` handler that supplies a</span>
<span class="sd"> default set of file metadata """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">defaults</span><span class="p">):</span>
<span class="n">CfgInfo</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaults</span> <span class="o">=</span> <span class="n">defaults</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgInfo</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">".. -----"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<div class="viewcode-block" id="CfgDefaultInfo.bind_info_to_entry"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgDefaultInfo.bind_info_to_entry">[docs]</a> <span class="k">def</span> <span class="nf">bind_info_to_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_info</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span><span class="p">)</span></div>
<span class="n">bind_info_to_entry</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgInfo</span><span class="o">.</span><span class="n">bind_info_to_entry</span><span class="o">.</span><span class="n">__doc__</span>
<span class="c">#: A :class:`CfgDefaultInfo` object instantiated with</span>
<span class="c">#: :attr:`Bcfg2.Server.Plugin.helper.DEFAULT_FILE_METADATA` as its</span>
<span class="c">#: default metadata. This is used to set a default file metadata set</span>
<span class="c">#: on an entry before a "real" :class:`CfgInfo` handler applies its</span>
<span class="c">#: metadata to the entry.</span></div>
<span class="n">DEFAULT_INFO</span> <span class="o">=</span> <span class="n">CfgDefaultInfo</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">DEFAULT_FILE_METADATA</span><span class="p">)</span>
<div class="viewcode-block" id="CfgEntrySet"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet">[docs]</a><span class="k">class</span> <span class="nc">CfgEntrySet</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="p">,</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">Debuggable</span><span class="p">):</span>
<span class="sd">""" Handle a collection of host- and group-specific Cfg files with</span>
<span class="sd"> multiple different Cfg handlers in a single directory. """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">basename</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">entry_type</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">basename</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span>
<span class="n">entry_type</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">Debuggable</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">specific</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">def</span> <span class="nf">set_debug</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">debug</span><span class="p">):</span>
<span class="n">rv</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">Debuggable</span><span class="o">.</span><span class="n">set_debug</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">debug</span><span class="p">)</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">entry</span><span class="o">.</span><span class="n">set_debug</span><span class="p">(</span><span class="n">debug</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rv</span>
<span class="nd">@property</span>
<div class="viewcode-block" id="CfgEntrySet.handlers"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.handlers">[docs]</a> <span class="k">def</span> <span class="nf">handlers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" A list of Cfg handler classes. Loading the handlers must</span>
<span class="sd"> be done at run-time, not at compile-time, or it causes a</span>
<span class="sd"> circular import and Bad Things Happen."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">submodule</span> <span class="ow">in</span> <span class="n">walk_packages</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="n">__path__</span><span class="p">,</span>
<span class="n">prefix</span><span class="o">=</span><span class="n">__name__</span> <span class="o">+</span> <span class="s">"."</span><span class="p">):</span>
<span class="n">mname</span> <span class="o">=</span> <span class="n">submodule</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s">'.'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">module</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="nb">__import__</span><span class="p">(</span><span class="n">submodule</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugins</span><span class="o">.</span><span class="n">Cfg</span><span class="p">,</span>
<span class="n">mname</span><span class="p">)</span>
<span class="n">hdlr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">mname</span><span class="p">)</span>
<span class="k">if</span> <span class="n">CfgBaseFileMatcher</span> <span class="ow">in</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">__mro__</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hdlr</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">operator</span><span class="o">.</span><span class="n">attrgetter</span><span class="p">(</span><span class="s">"__priority__"</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span>
</div>
<div class="viewcode-block" id="CfgEntrySet.handle_event"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.handle_event">[docs]</a> <span class="k">def</span> <span class="nf">handle_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="sd">""" Dispatch a FAM event to :func:`entry_init` or the</span>
<span class="sd"> appropriate child handler object.</span>
<span class="sd"> :param event: An event that applies to a file handled by this</span>
<span class="sd"> CfgEntrySet</span>
<span class="sd"> :type event: Bcfg2.Server.FileMonitor.Event</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</span>
<span class="n">action</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">code2str</span><span class="p">()</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
<span class="k">if</span> <span class="n">action</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'exists'</span><span class="p">,</span> <span class="s">'created'</span><span class="p">,</span> <span class="s">'changed'</span><span class="p">]:</span>
<span class="c"># process a bogus changed event like a created</span>
<span class="k">return</span>
<span class="k">for</span> <span class="n">hdlr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">handlers</span><span class="p">:</span>
<span class="k">if</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">handles</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">basename</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">):</span>
<span class="k">if</span> <span class="n">action</span> <span class="o">==</span> <span class="s">'changed'</span><span class="p">:</span>
<span class="c"># warn about a bogus 'changed' event, but</span>
<span class="c"># handle it like a 'created'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">"Got </span><span class="si">%s</span><span class="s"> event for unknown file </span><span class="si">%s</span><span class="s">"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> handling </span><span class="si">%s</span><span class="s"> event on </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">hdlr</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">action</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_init</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">hdlr</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="c"># pylint: disable=W0702</span>
<span class="n">err</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">"Cfg: Failed to parse </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">ignore</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">basename</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">):</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">action</span> <span class="o">==</span> <span class="s">'changed'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">]</span><span class="o">.</span><span class="n">handle_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">action</span> <span class="o">==</span> <span class="s">'deleted'</span><span class="p">:</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">]</span>
<span class="k">return</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">"Could not process event </span><span class="si">%s</span><span class="s"> for </span><span class="si">%s</span><span class="s">; ignoring"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">action</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="CfgEntrySet.get_matching"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.get_matching">[docs]</a> <span class="k">def</span> <span class="nf">get_matching</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">CfgGenerator</span><span class="p">)</span></div>
<span class="n">get_matching</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="o">.</span><span class="n">get_matching</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="CfgEntrySet.entry_init"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.entry_init">[docs]</a> <span class="k">def</span> <span class="nf">entry_init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">hdlr</span><span class="p">):</span> <span class="c"># pylint: disable=W0221</span>
<span class="sd">""" Handle the creation of a file on the filesystem and the</span>
<span class="sd"> creation of a Cfg handler object in this CfgEntrySet to track</span>
<span class="sd"> it.</span>
<span class="sd"> :param event: An event that applies to a file handled by this</span>
<span class="sd"> CfgEntrySet</span>
<span class="sd"> :type event: Bcfg2.Server.FileMonitor.Event</span>
<span class="sd"> :param hdlr: The Cfg handler class to be used to create an</span>
<span class="sd"> object for the file described by ``event``</span>
<span class="sd"> :type hdlr: class</span>
<span class="sd"> :returns: None</span>
<span class="sd"> :raises: :class:`Bcfg2.Server.Plugin.exceptions.SpecificityError`</span>
<span class="sd"> """</span>
<span class="n">fpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">)</span>
<span class="k">if</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">__basenames__</span><span class="p">:</span>
<span class="n">fdesc</span> <span class="o">=</span> <span class="s">"/"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">hdlr</span><span class="o">.</span><span class="n">__basenames__</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">__extensions__</span><span class="p">:</span>
<span class="n">fdesc</span> <span class="o">=</span> <span class="s">"."</span> <span class="o">+</span> <span class="s">"/."</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">hdlr</span><span class="o">.</span><span class="n">__extensions__</span><span class="p">)</span>
<span class="k">if</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">deprecated</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">"Cfg: </span><span class="si">%s</span><span class="s">: Use of </span><span class="si">%s</span><span class="s"> files is deprecated"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">fpath</span><span class="p">,</span> <span class="n">fdesc</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">experimental</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">"Cfg: </span><span class="si">%s</span><span class="s">: Use of </span><span class="si">%s</span><span class="s"> files is experimental"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">fpath</span><span class="p">,</span> <span class="n">fdesc</span><span class="p">))</span>
<span class="k">if</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">__specific__</span><span class="p">:</span>
<span class="k">if</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">__basenames__</span><span class="p">:</span>
<span class="c"># specific entry with explicit basenames</span>
<span class="n">basenames</span> <span class="o">=</span> <span class="n">hdlr</span><span class="o">.</span><span class="n">__basenames__</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># specific entry with no explicit basename; use the</span>
<span class="c"># directory name as the basename</span>
<span class="n">basenames</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)]</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="o">.</span><span class="n">entry_init</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="n">entry_type</span><span class="o">=</span><span class="n">hdlr</span><span class="p">,</span>
<span class="n">specific</span><span class="o">=</span><span class="n">hdlr</span><span class="o">.</span><span class="n">get_regex</span><span class="p">(</span><span class="n">basenames</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s">"Got duplicate add for </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">]</span> <span class="o">=</span> <span class="n">hdlr</span><span class="p">(</span><span class="n">fpath</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">event</span><span class="o">.</span><span class="n">filename</span><span class="p">]</span><span class="o">.</span><span class="n">handle_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="CfgEntrySet.bind_entry"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.bind_entry">[docs]</a> <span class="k">def</span> <span class="nf">bind_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bind_info_to_entry</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_generate_data</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">for</span> <span class="n">fltr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">CfgFilter</span><span class="p">):</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">fltr</span><span class="o">.</span><span class="n">modify_data</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="k">if</span> <span class="n">SETUP</span><span class="p">[</span><span class="s">'validate'</span><span class="p">]:</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_data</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="k">except</span> <span class="n">CfgVerificationError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="s">"Failed to verify </span><span class="si">%s</span><span class="s"> for </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">),</span>
<span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]))</span>
<span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'encoding'</span><span class="p">)</span> <span class="o">==</span> <span class="s">'base64'</span><span class="p">:</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">b64encode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">u_str</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeDecodeError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Failed to decode </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">),</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">"Please verify you are using the proper "</span>
<span class="s">"encoding"</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Error in specification for </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">),</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">"You need to specify base64 encoding for </span><span class="si">%s</span><span class="s">"</span>
<span class="o">%</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">))</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
<span class="c"># data is already unicode; newer versions of Cheetah</span>
<span class="c"># seem to return unicode</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="n">data</span><span class="p">:</span>
<span class="n">entry</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">data</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">entry</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'empty'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">entry</span></div>
<span class="n">bind_entry</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="o">.</span><span class="n">bind_entry</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="CfgEntrySet.get_handlers"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.get_handlers">[docs]</a> <span class="k">def</span> <span class="nf">get_handlers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">handler_type</span><span class="p">):</span>
<span class="sd">""" Get all handlers of the given type for the given metadata.</span>
<span class="sd"> :param metadata: The metadata to get all handlers for.</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :param handler_type: The type of Cfg handler to get</span>
<span class="sd"> :type handler_type: type</span>
<span class="sd"> :returns: list of Cfg handler classes</span>
<span class="sd"> """</span>
<span class="n">rv</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">ent</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="k">if</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">ent</span><span class="p">,</span> <span class="n">handler_type</span><span class="p">)</span> <span class="ow">and</span>
<span class="p">(</span><span class="ow">not</span> <span class="n">ent</span><span class="o">.</span><span class="n">__specific__</span> <span class="ow">or</span> <span class="n">ent</span><span class="o">.</span><span class="n">specific</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">metadata</span><span class="p">))):</span>
<span class="n">rv</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ent</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rv</span>
</div>
<div class="viewcode-block" id="CfgEntrySet.bind_info_to_entry"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.bind_info_to_entry">[docs]</a> <span class="k">def</span> <span class="nf">bind_info_to_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">""" Bind entry metadata to the entry with the best CfgInfo</span>
<span class="sd"> handler</span>
<span class="sd"> :param entry: The abstract entry to bind the info to. This</span>
<span class="sd"> will be modified in place</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to get info for</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</span>
<span class="n">info_handlers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">CfgInfo</span><span class="p">)</span>
<span class="n">DEFAULT_INFO</span><span class="o">.</span><span class="n">bind_info_to_entry</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">info_handlers</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">"More than one info supplier found for </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"name"</span><span class="p">),</span> <span class="n">info_handlers</span><span class="p">))</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">info_handlers</span><span class="p">):</span>
<span class="n">info_handlers</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">bind_info_to_entry</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="s">'Path'</span><span class="p">:</span>
<span class="n">entry</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'type'</span><span class="p">,</span> <span class="s">'file'</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_create_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">""" Create data for the given entry on the given client</span>
<span class="sd"> :param entry: The abstract entry to create data for. This</span>
<span class="sd"> will not be modified</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to create data for</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: string - the data for the entry</span>
<span class="sd"> """</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">best_matching</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">CfgCreator</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">creator</span><span class="o">.</span><span class="n">create_data</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="s">"Cfg: Error creating data for </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"name"</span><span class="p">),</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]))</span>
<span class="k">def</span> <span class="nf">_generate_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">""" Generate data for the given entry on the given client</span>
<span class="sd"> :param entry: The abstract entry to generate data for. This</span>
<span class="sd"> will not be modified</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata to generate data for</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: string - the data for the entry</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">generator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">best_matching</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">CfgGenerator</span><span class="p">))</span>
<span class="k">except</span> <span class="n">PluginExecutionError</span><span class="p">:</span>
<span class="c"># if no creators or generators exist, _create_data()</span>
<span class="c"># raises an appropriate exception</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_data</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'mode'</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'inherit'</span><span class="p">:</span>
<span class="c"># use on-disk permissions</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">"Cfg: </span><span class="si">%s</span><span class="s">: Use of mode='inherit' is deprecated"</span>
<span class="o">%</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"name"</span><span class="p">))</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">generator</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">entry</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'mode'</span><span class="p">,</span>
<span class="n">oct_mode</span><span class="p">(</span><span class="n">stat</span><span class="o">.</span><span class="n">S_IMODE</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span><span class="o">.</span><span class="n">st_mode</span><span class="p">)))</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">generator</span><span class="o">.</span><span class="n">get_data</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Cfg: Error rendering </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"name"</span><span class="p">),</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_validate_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">""" Validate data for the given entry on the given client</span>
<span class="sd"> :param entry: The abstract entry to validate data for</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: The client metadata validate data for</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: None</span>
<span class="sd"> :raises: :exc:`Bcfg2.Server.Plugins.Cfg.CfgVerificationError`</span>
<span class="sd"> """</span>
<span class="n">verifiers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">CfgVerifier</span><span class="p">)</span>
<span class="c"># we can have multiple verifiers, but we only want to use the</span>
<span class="c"># best matching verifier of each class</span>
<span class="n">verifiers_by_class</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">for</span> <span class="n">verifier</span> <span class="ow">in</span> <span class="n">verifiers</span><span class="p">:</span>
<span class="n">cls</span> <span class="o">=</span> <span class="n">verifier</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>
<span class="k">if</span> <span class="n">cls</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">verifiers_by_class</span><span class="p">:</span>
<span class="n">verifiers_by_class</span><span class="p">[</span><span class="n">cls</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">verifier</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">verifiers_by_class</span><span class="p">[</span><span class="n">cls</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">verifier</span><span class="p">)</span>
<span class="k">for</span> <span class="n">verifiers</span> <span class="ow">in</span> <span class="n">verifiers_by_class</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">verifier</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">best_matching</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">verifiers</span><span class="p">)</span>
<span class="n">verifier</span><span class="o">.</span><span class="n">verify_entry</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<div class="viewcode-block" id="CfgEntrySet.list_accept_choices"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.list_accept_choices">[docs]</a> <span class="k">def</span> <span class="nf">list_accept_choices</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">'''return a list of candidate pull locations'''</span>
<span class="n">generators</span> <span class="o">=</span> <span class="p">[</span><span class="n">ent</span> <span class="k">for</span> <span class="n">ent</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
<span class="k">if</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">ent</span><span class="p">,</span> <span class="n">CfgGenerator</span><span class="p">)</span> <span class="ow">and</span>
<span class="n">ent</span><span class="o">.</span><span class="n">specific</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">metadata</span><span class="p">))]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">generators</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"No base file found for </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">rv</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">best</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">best_matching</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">generators</span><span class="p">)</span>
<span class="n">rv</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">best</span><span class="o">.</span><span class="n">specific</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="c"># pylint: disable=W0702</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">rv</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">rv</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">hostname</span><span class="p">:</span>
<span class="n">rv</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">Specificity</span><span class="p">(</span>
<span class="n">hostname</span><span class="o">=</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">))</span>
<span class="k">return</span> <span class="n">rv</span>
</div>
<div class="viewcode-block" id="CfgEntrySet.build_filename"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.build_filename">[docs]</a> <span class="k">def</span> <span class="nf">build_filename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">specific</span><span class="p">):</span>
<span class="sd">""" Create a filename for pulled file data """</span>
<span class="n">bfname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">+</span> <span class="s">'/'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'/'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">specific</span><span class="o">.</span><span class="n">all</span><span class="p">:</span>
<span class="k">return</span> <span class="n">bfname</span>
<span class="k">elif</span> <span class="n">specific</span><span class="o">.</span><span class="n">group</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">.G</span><span class="si">%02d</span><span class="s">_</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">bfname</span><span class="p">,</span> <span class="n">specific</span><span class="o">.</span><span class="n">prio</span><span class="p">,</span> <span class="n">specific</span><span class="o">.</span><span class="n">group</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">specific</span><span class="o">.</span><span class="n">hostname</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s</span><span class="s">.H_</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">bfname</span><span class="p">,</span> <span class="n">specific</span><span class="o">.</span><span class="n">hostname</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="CfgEntrySet.write_update"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgEntrySet.write_update">[docs]</a> <span class="k">def</span> <span class="nf">write_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">new_entry</span><span class="p">,</span> <span class="n">log</span><span class="p">):</span>
<span class="sd">""" Write pulled data to the filesystem """</span>
<span class="k">if</span> <span class="s">'text'</span> <span class="ow">in</span> <span class="n">new_entry</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_filename</span><span class="p">(</span><span class="n">specific</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">.genshi"</span> <span class="o">%</span> <span class="n">name</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Cfg: Unable to pull data for genshi types"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">.cheetah"</span> <span class="o">%</span> <span class="n">name</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Cfg: Unable to pull data for cheetah types"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">etext</span> <span class="o">=</span> <span class="n">new_entry</span><span class="p">[</span><span class="s">'text'</span><span class="p">]</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Cfg: Cannot encode content of </span><span class="si">%s</span><span class="s"> as </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> \
<span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="nb">open</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">etext</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">"Wrote file </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">,</span> <span class="n">flag</span><span class="o">=</span><span class="n">log</span><span class="p">)</span>
<span class="n">badattr</span> <span class="o">=</span> <span class="p">[</span><span class="n">attr</span> <span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'owner'</span><span class="p">,</span> <span class="s">'group'</span><span class="p">,</span> <span class="s">'mode'</span><span class="p">]</span>
<span class="k">if</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">new_entry</span><span class="p">]</span>
<span class="k">if</span> <span class="n">badattr</span><span class="p">:</span>
<span class="c"># check for info files and inform user of their removal</span>
<span class="k">for</span> <span class="n">ifile</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'info'</span><span class="p">,</span> <span class="s">':info'</span><span class="p">]:</span>
<span class="n">info</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">ifile</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">info</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Removing </span><span class="si">%s</span><span class="s"> and replacing with info.xml"</span>
<span class="o">%</span> <span class="n">info</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="n">metadata_updates</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">metadata_updates</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">badattr</span><span class="p">:</span>
<span class="n">metadata_updates</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
<span class="n">infoxml</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">'FileInfo'</span><span class="p">)</span>
<span class="n">infotag</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">infoxml</span><span class="p">,</span> <span class="s">'Info'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">metadata_updates</span><span class="p">:</span>
<span class="n">infotag</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">__setitem__</span><span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="n">metadata_updates</span><span class="p">[</span><span class="n">attr</span><span class="p">])</span>
<span class="n">ofile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">+</span> <span class="s">"/info.xml"</span><span class="p">,</span> <span class="s">"w"</span><span class="p">)</span>
<span class="n">ofile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="n">infoxml</span><span class="p">,</span> <span class="n">xml_declaration</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="n">pretty_print</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'UTF-8'</span><span class="p">))</span>
<span class="n">ofile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">"Wrote file </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="s">"info.xml"</span><span class="p">),</span>
<span class="n">flag</span><span class="o">=</span><span class="n">log</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="Cfg"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.Cfg">[docs]</a><span class="k">class</span> <span class="nc">Cfg</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">GroupSpool</span><span class="p">,</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">PullTarget</span><span class="p">):</span>
<span class="sd">""" The Cfg plugin provides a repository to describe configuration</span>
<span class="sd"> file contents for clients. In its simplest form, the Cfg repository is</span>
<span class="sd"> just a directory tree modeled off of the directory tree on your client</span>
<span class="sd"> machines.</span>
<span class="sd"> """</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s">'bcfg-dev@mcs.anl.gov'</span>
<span class="n">es_cls</span> <span class="o">=</span> <span class="n">CfgEntrySet</span>
<span class="n">es_child_cls</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">SpecificData</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">core</span><span class="p">,</span> <span class="n">datastore</span><span class="p">):</span>
<span class="k">global</span> <span class="n">SETUP</span><span class="p">,</span> <span class="n">CFG</span> <span class="c"># pylint: disable=W0603</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">GroupSpool</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">core</span><span class="p">,</span> <span class="n">datastore</span><span class="p">)</span>
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">PullTarget</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">CFG</span> <span class="o">=</span> <span class="bp">self</span>
<span class="n">SETUP</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">setup</span>
<span class="k">if</span> <span class="s">'validate'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">SETUP</span><span class="p">:</span>
<span class="n">SETUP</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">'validate'</span><span class="p">,</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Options</span><span class="o">.</span><span class="n">CFG_VALIDATION</span><span class="p">)</span>
<span class="n">SETUP</span><span class="o">.</span><span class="n">reparse</span><span class="p">()</span>
<span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">GroupSpool</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="Cfg.has_generator"><a class="viewcode-back" href="../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.Cfg.has_generator">[docs]</a> <span class="k">def</span> <span class="nf">has_generator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">""" Return True if the given entry can be generated for the</span>
<span class="sd"> given metadata; False otherwise</span>
<span class="sd"> :param entry: Determine if a</span>
<span class="sd"> :class:`Bcfg2.Server.Plugins.Cfg.CfgGenerator`</span>
<span class="sd"> object exists that handles this (abstract) entry</span>
<span class="sd"> :type entry: lxml.etree._Element</span>
<span class="sd"> :param metadata: Determine if a CfgGenerator has data that</span>
<span class="sd"> applies to this client metadata</span>
<span class="sd"> :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd"> :returns: bool</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">)]</span><span class="o">.</span><span class="n">get_handlers</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">CfgGenerator</span><span class="p">))</span>
</div>
<span class="k">def</span> <span class="nf">AcceptChoices</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">)]</span><span class="o">.</span><span class="n">list_accept_choices</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">)</span>
<span class="n">AcceptChoices</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> \
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">PullTarget</span><span class="o">.</span><span class="n">AcceptChoices</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">def</span> <span class="nf">AcceptPullData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">specific</span><span class="p">,</span> <span class="n">new_entry</span><span class="p">,</span> <span class="n">log</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">new_entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">)]</span><span class="o">.</span><span class="n">write_update</span><span class="p">(</span><span class="n">specific</span><span class="p">,</span>
<span class="n">new_entry</span><span class="p">,</span>
<span class="n">log</span><span class="p">)</span>
<span class="n">AcceptPullData</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> \
<span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">PullTarget</span><span class="o">.</span><span class="n">AcceptPullData</span><span class="o">.</span><span class="n">__doc__</span>
</div>
<span class="k">class</span> <span class="nc">CfgLint</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Lint</span><span class="o">.</span><span class="n">ServerPlugin</span><span class="p">):</span>
<span class="sd">""" warn about usage of .cat and .diff files """</span>
<span class="k">def</span> <span class="nf">Run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">for</span> <span class="n">basename</span><span class="p">,</span> <span class="n">entry</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">plugins</span><span class="p">[</span><span class="s">'Cfg'</span><span class="p">]</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_delta</span><span class="p">(</span><span class="n">basename</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_pubkey</span><span class="p">(</span><span class="n">basename</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">Errors</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="p">{</span><span class="s">"cat-file-used"</span><span class="p">:</span> <span class="s">"warning"</span><span class="p">,</span>
<span class="s">"diff-file-used"</span><span class="p">:</span> <span class="s">"warning"</span><span class="p">,</span>
<span class="s">"no-pubkey-xml"</span><span class="p">:</span> <span class="s">"warning"</span><span class="p">}</span>
<span class="k">def</span> <span class="nf">check_delta</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">basename</span><span class="p">,</span> <span class="n">entry</span><span class="p">):</span>
<span class="sd">""" check that no .cat or .diff files are in use """</span>
<span class="k">for</span> <span class="n">fname</span><span class="p">,</span> <span class="n">handler</span> <span class="ow">in</span> <span class="n">entry</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">handler</span><span class="o">.</span><span class="n">name</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">HandlesFile</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">handler</span><span class="p">,</span> <span class="n">CfgFilter</span><span class="p">):</span>
<span class="n">extension</span> <span class="o">=</span> <span class="n">fname</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"."</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">extension</span> <span class="ow">in</span> <span class="p">[</span><span class="s">"cat"</span><span class="p">,</span> <span class="s">"diff"</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">LintError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">-file-used"</span> <span class="o">%</span> <span class="n">extension</span><span class="p">,</span>
<span class="s">"</span><span class="si">%s</span><span class="s"> file used on </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">extension</span><span class="p">,</span>
<span class="n">basename</span><span class="p">,</span>
<span class="n">fname</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">check_pubkey</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">basename</span><span class="p">,</span> <span class="n">entry</span><span class="p">):</span>
<span class="sd">""" check that privkey.xml files have corresponding pubkey.xml</span>
<span class="sd"> files """</span>
<span class="k">if</span> <span class="s">"privkey.xml"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">entry</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">privkey</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="s">"privkey.xml"</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">HandlesFile</span><span class="p">(</span><span class="n">privkey</span><span class="o">.</span><span class="n">name</span><span class="p">):</span>
<span class="k">return</span>
<span class="n">pubkey</span> <span class="o">=</span> <span class="n">basename</span> <span class="o">+</span> <span class="s">".pub"</span>
<span class="k">if</span> <span class="n">pubkey</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">plugins</span><span class="p">[</span><span class="s">'Cfg'</span><span class="p">]</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">LintError</span><span class="p">(</span><span class="s">"no-pubkey-xml"</span><span class="p">,</span>
<span class="s">"</span><span class="si">%s</span><span class="s"> has no corresponding pubkey.xml at </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">basename</span><span class="p">,</span> <span class="n">pubkey</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pubset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">plugins</span><span class="p">[</span><span class="s">'Cfg'</span><span class="p">]</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="n">pubkey</span><span class="p">]</span>
<span class="k">if</span> <span class="s">"pubkey.xml"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">pubset</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">LintError</span><span class="p">(</span><span class="s">"no-pubkey-xml"</span><span class="p">,</span>
<span class="s">"</span><span class="si">%s</span><span class="s"> has no corresponding pubkey.xml at </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">basename</span><span class="p">,</span> <span class="n">pubkey</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../../index.html">home</a> | </li>
<!--<li><a href="../../../../search.html">search</a> | </li>-->
<li><a href="../../../../help/index.html">help</a> | </li>
<li><a href="../../../../contents.html">documentation </a> »</li>
<li><a href="../../../index.html" >Module code</a> »</li>
<li><a href="../Plugins.html" >Bcfg2.Server.Plugins</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2013, Narayan Desai.
Last updated on Mar 20, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
b50d8ee6d7871fcc13c0677a9364ed59
>
files
>
34
