<!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.Properties — 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.Properties</h1><div class="highlight"><pre>
<span class="sd">""" The properties plugin maps property files into client metadata</span>
<span class="sd">instances. """</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">copy</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">lxml.etree</span>
<span class="kn">import</span> <span class="nn">Bcfg2.Server.Plugin</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="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">Bcfg2.Encryption</span>
<span class="n">HAS_CRYPTO</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">HAS_CRYPTO</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="n">HAS_JSON</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">simplejson</span> <span class="kn">as</span> <span class="nn">json</span>
<span class="n">HAS_JSON</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">HAS_JSON</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">yaml</span>
<span class="n">HAS_YAML</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">HAS_YAML</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
<span class="n">SETUP</span> <span class="o">=</span> <span class="bp">None</span>
<div class="viewcode-block" id="PropertyFile"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropertyFile">[docs]</a><span class="k">class</span> <span class="nc">PropertyFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">""" Base Properties file handler """</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="sd">"""</span>
<span class="sd"> :param name: The filename of this properties file.</span>
<span class="sd"> .. automethod:: _write</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<div class="viewcode-block" id="PropertyFile.write"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropertyFile.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Write the data in this data structure back to the property</span>
<span class="sd"> file. This public method performs checking to ensure that</span>
<span class="sd"> writing is possible and then calls :func:`_write`. """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">SETUP</span><span class="o">.</span><span class="n">cfp</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s">"properties"</span><span class="p">,</span> <span class="s">"writes_enabled"</span><span class="p">,</span>
<span class="n">default</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Properties files write-back is disabled in the "</span> <span class="o">+</span> \
<span class="s">"configuration"</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="bp">self</span><span class="o">.</span><span class="n">validate_data</span><span class="p">()</span>
<span class="k">except</span> <span class="n">PluginExecutionError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Cannot 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="bp">self</span><span class="o">.</span><span class="n">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="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="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_write</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="n">msg</span> <span class="o">=</span> <span class="s">"Failed to 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="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">err</span><span class="p">)</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>
</div>
<div class="viewcode-block" id="PropertyFile._write"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropertyFile._write">[docs]</a> <span class="k">def</span> <span class="nf">_write</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Write the data in this data structure back to the property</span>
<span class="sd"> file. """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</div>
<div class="viewcode-block" id="PropertyFile.validate_data"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropertyFile.validate_data">[docs]</a> <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="sd">""" Verify that the data in this file is valid. """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</div>
<div class="viewcode-block" id="PropertyFile.get_additional_data"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropertyFile.get_additional_data">[docs]</a> <span class="k">def</span> <span class="nf">get_additional_data</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="c"># pylint: disable=W0613</span>
<span class="sd">""" Get file data for inclusion in client metadata. """</span>
<span class="k">return</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="JSONPropertyFile"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.JSONPropertyFile">[docs]</a><span class="k">class</span> <span class="nc">JSONPropertyFile</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">FileBacked</span><span class="p">,</span> <span class="n">PropertyFile</span><span class="p">):</span>
<span class="sd">""" Handle JSON Properties files. """</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">fam</span><span class="o">=</span><span class="bp">None</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">FileBacked</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">fam</span><span class="o">=</span><span class="n">fam</span><span class="p">)</span>
<span class="n">PropertyFile</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="bp">self</span><span class="o">.</span><span class="n">json</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">FileBacked</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="JSONPropertyFile.Index"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.JSONPropertyFile.Index">[docs]</a> <span class="k">def</span> <span class="nf">Index</span><span class="p">(</span><span class="bp">self</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">json</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</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">PluginExecutionError</span><span class="p">(</span><span class="s">"Could not load JSON data from </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">name</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span></div>
<span class="n">Index</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">FileBacked</span><span class="o">.</span><span class="n">Index</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">def</span> <span class="nf">_write</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="p">,</span> <span class="nb">open</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="s">'wb'</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="n">_write</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">PropertyFile</span><span class="o">.</span><span class="n">_write</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="JSONPropertyFile.validate_data"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.JSONPropertyFile.validate_data">[docs]</a> <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="k">try</span><span class="p">:</span>
<span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
<span class="k">except</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">PluginExecutionError</span><span class="p">(</span><span class="s">"Data for </span><span class="si">%s</span><span class="s"> cannot be dumped to JSON: "</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">name</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span></div>
<span class="n">validate_data</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">PropertyFile</span><span class="o">.</span><span class="n">validate_data</span><span class="o">.</span><span class="n">__doc__</span>
<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="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="YAMLPropertyFile"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.YAMLPropertyFile">[docs]</a><span class="k">class</span> <span class="nc">YAMLPropertyFile</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">FileBacked</span><span class="p">,</span> <span class="n">PropertyFile</span><span class="p">):</span>
<span class="sd">""" Handle YAML Properties files. """</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">fam</span><span class="o">=</span><span class="bp">None</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">FileBacked</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">fam</span><span class="o">=</span><span class="n">fam</span><span class="p">)</span>
<span class="n">PropertyFile</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="bp">self</span><span class="o">.</span><span class="n">yaml</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">FileBacked</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="YAMLPropertyFile.Index"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.YAMLPropertyFile.Index">[docs]</a> <span class="k">def</span> <span class="nf">Index</span><span class="p">(</span><span class="bp">self</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">yaml</span> <span class="o">=</span> <span class="n">yaml</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
<span class="k">except</span> <span class="n">yaml</span><span class="o">.</span><span class="n">YAMLError</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">PluginExecutionError</span><span class="p">(</span><span class="s">"Could not load YAML data from </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">name</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span></div>
<span class="n">Index</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">FileBacked</span><span class="o">.</span><span class="n">Index</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">def</span> <span class="nf">_write</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">yaml</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">yaml</span><span class="p">,</span> <span class="nb">open</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="s">'wb'</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="n">_write</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">PropertyFile</span><span class="o">.</span><span class="n">_write</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="YAMLPropertyFile.validate_data"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.YAMLPropertyFile.validate_data">[docs]</a> <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="k">try</span><span class="p">:</span>
<span class="n">yaml</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">yaml</span><span class="p">)</span>
<span class="k">except</span> <span class="n">yaml</span><span class="o">.</span><span class="n">YAMLError</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">PluginExecutionError</span><span class="p">(</span><span class="s">"Data for </span><span class="si">%s</span><span class="s"> cannot be dumped to YAML: "</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">name</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span></div>
<span class="n">validate_data</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">PropertyFile</span><span class="o">.</span><span class="n">validate_data</span><span class="o">.</span><span class="n">__doc__</span>
<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="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">yaml</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">yaml</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="XMLPropertyFile"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.XMLPropertyFile">[docs]</a><span class="k">class</span> <span class="nc">XMLPropertyFile</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">StructFile</span><span class="p">,</span> <span class="n">PropertyFile</span><span class="p">):</span>
<span class="sd">""" Handle XML Properties files. """</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">fam</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">should_monitor</span><span class="o">=</span><span class="bp">False</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">StructFile</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">fam</span><span class="o">=</span><span class="n">fam</span><span class="p">,</span>
<span class="n">should_monitor</span><span class="o">=</span><span class="n">should_monitor</span><span class="p">)</span>
<span class="n">PropertyFile</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">__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">StructFile</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">def</span> <span class="nf">_write</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">open</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="s">"wb"</span><span class="p">)</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="bp">self</span><span class="o">.</span><span class="n">xdata</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="k">return</span> <span class="bp">True</span>
<span class="n">_write</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">PropertyFile</span><span class="o">.</span><span class="n">_write</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="XMLPropertyFile.validate_data"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.XMLPropertyFile.validate_data">[docs]</a> <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="sd">""" ensure that the data in this object validates against the</span>
<span class="sd"> XML schema for this property file (if a schema exists) """</span>
<span class="n">schemafile</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">".xml"</span><span class="p">,</span> <span class="s">".xsd"</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">schemafile</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">schema</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">XMLSchema</span><span class="p">(</span><span class="nb">file</span><span class="o">=</span><span class="n">schemafile</span><span class="p">)</span>
<span class="k">except</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">XMLSchemaParseError</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">PluginExecutionError</span><span class="p">(</span><span class="s">"Failed to process schema for </span><span class="si">%s</span><span class="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">name</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># no schema exists</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">schema</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">xdata</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="s">"Data for </span><span class="si">%s</span><span class="s"> fails to validate; run "</span>
<span class="s">"bcfg2-lint for more details"</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span></div>
<span class="n">validate_data</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">PropertyFile</span><span class="o">.</span><span class="n">validate_data</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="XMLPropertyFile.Index"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.XMLPropertyFile.Index">[docs]</a> <span class="k">def</span> <span class="nf">Index</span><span class="p">(</span><span class="bp">self</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">StructFile</span><span class="o">.</span><span class="n">Index</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="n">HAS_CRYPTO</span><span class="p">:</span>
<span class="n">strict</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">xdata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s">"decrypt"</span><span class="p">,</span>
<span class="n">SETUP</span><span class="o">.</span><span class="n">cfp</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">CFG_SECTION</span><span class="p">,</span> <span class="s">"decrypt"</span><span class="p">,</span>
<span class="n">default</span><span class="o">=</span><span class="s">"strict"</span><span class="p">))</span> <span class="o">==</span> <span class="s">"strict"</span>
<span class="k">for</span> <span class="n">el</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">xdata</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s">"//*[@encrypted]"</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">el</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_decrypt</span><span class="p">(</span><span class="n">el</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'ascii'</span><span class="p">,</span>
<span class="s">'xmlcharrefreplace'</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeDecodeError</span><span class="p">:</span>
<span class="n">LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Properties: Decrypted </span><span class="si">%s</span><span class="s"> to gibberish, "</span>
<span class="s">"skipping"</span> <span class="o">%</span> <span class="n">el</span><span class="o">.</span><span class="n">tag</span><span class="p">)</span>
<span class="k">except</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">EVPError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"Properties: Failed to decrypt </span><span class="si">%s</span><span class="s"> element in </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> \
<span class="p">(</span><span class="n">el</span><span class="o">.</span><span class="n">tag</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">strict</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">else</span><span class="p">:</span>
<span class="n">LOGGER</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
<span class="n">Index</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">StructFile</span><span class="o">.</span><span class="n">Index</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">def</span> <span class="nf">_decrypt</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
<span class="sd">""" Decrypt a single encrypted properties file element """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">element</span><span class="o">.</span><span class="n">text</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">element</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
<span class="k">return</span>
<span class="n">passes</span> <span class="o">=</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">get_passphrases</span><span class="p">(</span><span class="n">SETUP</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">passphrase</span> <span class="o">=</span> <span class="n">passes</span><span class="p">[</span><span class="n">element</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"encrypted"</span><span class="p">)]</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">ssl_decrypt</span><span class="p">(</span>
<span class="n">element</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">passphrase</span><span class="p">,</span>
<span class="n">algorithm</span><span class="o">=</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">get_algorithm</span><span class="p">(</span><span class="n">SETUP</span><span class="p">))</span>
<span class="k">except</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">EVPError</span><span class="p">:</span>
<span class="c"># error is raised below</span>
<span class="k">pass</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="c"># bruteforce_decrypt raises an EVPError with a sensible</span>
<span class="c"># error message, so we just let it propagate up the stack</span>
<span class="k">return</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">bruteforce_decrypt</span><span class="p">(</span>
<span class="n">element</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">passphrases</span><span class="o">=</span><span class="n">passes</span><span class="o">.</span><span class="n">values</span><span class="p">(),</span>
<span class="n">algorithm</span><span class="o">=</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">get_algorithm</span><span class="p">(</span><span class="n">SETUP</span><span class="p">))</span>
<span class="k">raise</span> <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Encryption</span><span class="o">.</span><span class="n">EVPError</span><span class="p">(</span><span class="s">"Failed to decrypt"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_additional_data</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">if</span> <span class="n">SETUP</span><span class="o">.</span><span class="n">cfp</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s">"properties"</span><span class="p">,</span> <span class="s">"automatch"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="n">default_automatch</span> <span class="o">=</span> <span class="s">"true"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">default_automatch</span> <span class="o">=</span> <span class="s">"false"</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">xdata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"automatch"</span><span class="p">,</span> <span class="n">default_automatch</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">"true"</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">XMLMatch</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<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="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">xdata</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">xdata</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="PropDirectoryBacked"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropDirectoryBacked">[docs]</a><span class="k">class</span> <span class="nc">PropDirectoryBacked</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">DirectoryBacked</span><span class="p">):</span>
<span class="sd">""" A collection of properties files. """</span>
<span class="n">extensions</span> <span class="o">=</span> <span class="p">[</span><span class="s">"xml"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">HAS_JSON</span><span class="p">:</span>
<span class="n">extensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"json"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">HAS_YAML</span><span class="p">:</span>
<span class="n">extensions</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">"yaml"</span><span class="p">,</span> <span class="s">"yml"</span><span class="p">])</span>
<span class="c">#: Only track and include files whose names and paths match this</span>
<span class="c">#: regex. Created on-the-fly based on which libraries are</span>
<span class="c">#: installed (and thus which data formats are supported).</span>
<span class="c">#: Candidates are ``.xml`` (always supported), ``.json``,</span>
<span class="c">#: ``.yaml``, and ``.yml``.</span>
<span class="n">patterns</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r'.*\.</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">extensions</span><span class="p">))</span>
<span class="c">#: Ignore XML schema (``.xsd``) files</span>
<span class="n">ignore</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r'.*\.xsd$'</span><span class="p">)</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">data</span><span class="p">,</span> <span class="n">fam</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">DirectoryBacked</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">data</span><span class="p">,</span> <span class="n">fam</span><span class="p">)</span>
<span class="c">#: Instead of creating children of this object with a static</span>
<span class="c">#: object, we use :func:`property_dispatcher` to create a</span>
<span class="c">#: child of the appropriate subclass of :class:`PropertyFile`</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__child__</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">property_dispatcher</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">DirectoryBacked</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="PropDirectoryBacked.property_dispatcher"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.PropDirectoryBacked.property_dispatcher">[docs]</a> <span class="k">def</span> <span class="nf">property_dispatcher</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="n">fam</span><span class="p">):</span>
<span class="sd">""" Dispatch an event on a Properties file to the</span>
<span class="sd"> appropriate object.</span>
<span class="sd"> :param fname: The name of the file that received the event</span>
<span class="sd"> :type fname: string</span>
<span class="sd"> :param fam: The file monitor the event was received by</span>
<span class="sd"> :type fam: Bcfg2.Server.FileMonitor.FileMonitor</span>
<span class="sd"> :returns: An object of the appropriate subclass of</span>
<span class="sd"> :class:`PropertyFile`</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">fname</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">".xml"</span><span class="p">):</span>
<span class="k">return</span> <span class="n">XMLPropertyFile</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="n">fam</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">HAS_JSON</span> <span class="ow">and</span> <span class="n">fname</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">".json"</span><span class="p">):</span>
<span class="k">return</span> <span class="n">JSONPropertyFile</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="n">fam</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">HAS_YAML</span> <span class="ow">and</span> <span class="p">(</span><span class="n">fname</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">".yaml"</span><span class="p">)</span> <span class="ow">or</span> <span class="n">fname</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">".yml"</span><span class="p">)):</span>
<span class="k">return</span> <span class="n">YAMLPropertyFile</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="n">fam</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</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">PluginExecutionError</span><span class="p">(</span>
<span class="s">"Properties: Unknown extension </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">fname</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="Properties"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.Properties">[docs]</a><span class="k">class</span> <span class="nc">Properties</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">Plugin</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">Connector</span><span class="p">):</span>
<span class="sd">""" The properties plugin maps property files into client metadata</span>
<span class="sd"> instances. """</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="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">Plugin</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">Connector</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">SETUP</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">setup</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">store</span> <span class="o">=</span> <span class="n">PropDirectoryBacked</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="n">core</span><span class="o">.</span><span class="n">fam</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="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">"Error while creating Properties store: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
<span class="n">err</span><span class="p">)</span>
<span class="k">raise</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">PluginInitError</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">Plugin</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>
<div class="viewcode-block" id="Properties.get_additional_data"><a class="viewcode-back" href="../../../../server/plugins/connectors/properties.html#Bcfg2.Server.Plugins.Properties.Properties.get_additional_data">[docs]</a> <span class="k">def</span> <span class="nf">get_additional_data</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">rv</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">for</span> <span class="n">fname</span><span class="p">,</span> <span class="n">pfile</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">store</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">rv</span><span class="p">[</span><span class="n">fname</span><span class="p">]</span> <span class="o">=</span> <span class="n">pfile</span><span class="o">.</span><span class="n">get_additional_data</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rv</span></div>
<span class="n">get_additional_data</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">Connector</span><span class="o">.</span><span class="n">get_additional_data</span><span class="o">.</span><span class="n">__doc__</span></div>
</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
>
57
