<!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.Plugin.base — 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.Plugin" href="../Plugin.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="../Plugin.html" accesskey="U">Bcfg2.Server.Plugin</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for Bcfg2.Server.Plugin.base</h1><div class="highlight"><pre>
<span class="sd">"""This module provides the base class for Bcfg2 server plugins."""</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">logging</span>
<div class="viewcode-block" id="Debuggable"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Debuggable">[docs]</a><span class="k">class</span> <span class="nc">Debuggable</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">""" Mixin to add a debugging interface to an object and expose it</span>
<span class="sd"> via XML-RPC on :class:`Bcfg2.Server.Plugin.base.Plugin` objects """</span>
<span class="c">#: List of names of methods to be exposed as XML-RPC functions</span>
<span class="n">__rmi__</span> <span class="o">=</span> <span class="p">[</span><span class="s">'toggle_debug'</span><span class="p">,</span> <span class="s">'set_debug'</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">name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param name: The name of the logger object to get. If none is</span>
<span class="sd"> supplied, the full name of the class (including</span>
<span class="sd"> module) will be used.</span>
<span class="sd"> :type name: string</span>
<span class="sd"> .. autoattribute:: __rmi__</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</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">__module__</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">debug_flag</span> <span class="o">=</span> <span class="bp">False</span>
<span class="bp">self</span><span class="o">.</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>
<div class="viewcode-block" id="Debuggable.set_debug"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Debuggable.set_debug">[docs]</a> <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="sd">""" Explicitly enable or disable debugging. This method is exposed</span>
<span class="sd"> via XML-RPC.</span>
<span class="sd"> :returns: bool - The new value of the debug flag</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">debug_flag</span> <span class="o">=</span> <span class="n">debug</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">: debug_flag = </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">debug_flag</span><span class="p">),</span>
<span class="n">flag</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">debug</span>
</div>
<div class="viewcode-block" id="Debuggable.toggle_debug"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Debuggable.toggle_debug">[docs]</a> <span class="k">def</span> <span class="nf">toggle_debug</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Turn debugging output on or off. This method is exposed</span>
<span class="sd"> via XML-RPC.</span>
<span class="sd"> :returns: bool - The new value of the debug flag</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">set_debug</span><span class="p">(</span><span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_flag</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Debuggable.debug_log"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Debuggable.debug_log">[docs]</a> <span class="k">def</span> <span class="nf">debug_log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">flag</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">""" Log a message at the debug level.</span>
<span class="sd"> :param message: The message to log</span>
<span class="sd"> :type message: string</span>
<span class="sd"> :param flag: Override the current debug flag with this value</span>
<span class="sd"> :type flag: bool</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">flag</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_flag</span><span class="p">)</span> <span class="ow">or</span> <span class="n">flag</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">message</span><span class="p">)</span>
</div></div>
<span class="k">class</span> <span class="nc">ClassName</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">""" This very simple descriptor class exists only to get the name</span>
<span class="sd"> of the owner class. This is used because, for historical reasons,</span>
<span class="sd"> we expect every plugin to have a ``name`` attribute that is in</span>
<span class="sd"> almost all cases the same as the ``__class__.__name__`` attribute</span>
<span class="sd"> of the plugin object. This makes that more dynamic so that each</span>
<span class="sd"> plugin isn't repeating its own name. """</span>
<span class="k">def</span> <span class="nf">__get__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inst</span><span class="p">,</span> <span class="n">owner</span><span class="p">):</span>
<span class="k">return</span> <span class="n">owner</span><span class="o">.</span><span class="n">__name__</span>
<div class="viewcode-block" id="Plugin"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Plugin">[docs]</a><span class="k">class</span> <span class="nc">Plugin</span><span class="p">(</span><span class="n">Debuggable</span><span class="p">):</span>
<span class="sd">""" The base class for all Bcfg2 Server plugins. """</span>
<span class="c">#: The name of the plugin.</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">ClassName</span><span class="p">()</span>
<span class="c">#: The email address of the plugin author.</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s">'bcfg-dev@mcs.anl.gov'</span>
<span class="c">#: Plugin is experimental. Use of this plugin will produce a log</span>
<span class="c">#: message alerting the administrator that an experimental plugin</span>
<span class="c">#: is in use.</span>
<span class="n">experimental</span> <span class="o">=</span> <span class="bp">False</span>
<span class="c">#: Plugin is deprecated and will be removed in a future release.</span>
<span class="c">#: Use of this plugin will produce a log message alerting the</span>
<span class="c">#: administrator that an experimental plugin is in use.</span>
<span class="n">deprecated</span> <span class="o">=</span> <span class="bp">False</span>
<span class="c">#: Plugin conflicts with the list of other plugin names</span>
<span class="n">conflicts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c">#: Plugins of the same type are processed in order of ascending</span>
<span class="c">#: sort_order value. Plugins with the same sort_order are sorted</span>
<span class="c">#: alphabetically by their name.</span>
<span class="n">sort_order</span> <span class="o">=</span> <span class="mi">500</span>
<span class="c">#: List of names of methods to be exposed as XML-RPC functions</span>
<span class="n">__rmi__</span> <span class="o">=</span> <span class="n">Debuggable</span><span class="o">.</span><span class="n">__rmi__</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="sd">"""</span>
<span class="sd"> :param core: The Bcfg2.Server.Core initializing the plugin</span>
<span class="sd"> :type core: Bcfg2.Server.Core</span>
<span class="sd"> :param datastore: The path to the Bcfg2 repository on the</span>
<span class="sd"> filesystem</span>
<span class="sd"> :type datastore: string</span>
<span class="sd"> :raises: :class:`Bcfg2.Server.Plugin.exceptions.PluginInitError`</span>
<span class="sd"> .. autoattribute:: Bcfg2.Server.Plugin.base.Debuggable.__rmi__</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">Entries</span> <span class="o">=</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">core</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</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">datastore</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="bp">self</span><span class="o">.</span><span class="n">running</span> <span class="o">=</span> <span class="bp">True</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="n">name</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="nd">@classmethod</span>
<div class="viewcode-block" id="Plugin.init_repo"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Plugin.init_repo">[docs]</a> <span class="k">def</span> <span class="nf">init_repo</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">repo</span><span class="p">):</span>
<span class="sd">""" Perform any tasks necessary to create an initial Bcfg2</span>
<span class="sd"> repository.</span>
<span class="sd"> :param repo: The path to the Bcfg2 repository on the filesystem</span>
<span class="sd"> :type repo: string</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</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">join</span><span class="p">(</span><span class="n">repo</span><span class="p">,</span> <span class="n">cls</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="Plugin.shutdown"><a class="viewcode-back" href="../../../../development/plugins.html#Bcfg2.Server.Plugin.base.Plugin.shutdown">[docs]</a> <span class="k">def</span> <span class="nf">shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Perform shutdown tasks for the plugin</span>
<span class="sd"> :returns: None """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">running</span> <span class="o">=</span> <span class="bp">False</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"> Plugin"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</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="../Plugin.html" >Bcfg2.Server.Plugin</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
>
27
