<!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.Packages.Apt — 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.Packages" href="../Packages.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" >Bcfg2.Server.Plugins</a> »</li> <li><a href="../Packages.html" accesskey="U">Bcfg2.Server.Plugins.Packages</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <h1>Source code for Bcfg2.Server.Plugins.Packages.Apt</h1><div class="highlight"><pre> <span class="sd">""" APT backend for :mod:`Bcfg2.Server.Plugins.Packages` """</span> <span class="kn">import</span> <span class="nn">re</span> <span class="kn">import</span> <span class="nn">gzip</span> <span class="kn">from</span> <span class="nn">Bcfg2.Server.Plugins.Packages.Collection</span> <span class="kn">import</span> <span class="n">Collection</span> <span class="kn">from</span> <span class="nn">Bcfg2.Server.Plugins.Packages.Source</span> <span class="kn">import</span> <span class="n">Source</span> <div class="viewcode-block" id="AptCollection"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Apt.AptCollection">[docs]</a><span class="k">class</span> <span class="nc">AptCollection</span><span class="p">(</span><span class="n">Collection</span><span class="p">):</span> <span class="sd">""" Handle collections of APT sources. This is a no-op object</span> <span class="sd"> that simply inherits from</span> <span class="sd"> :class:`Bcfg2.Server.Plugins.Packages.Collection.Collection`,</span> <span class="sd"> overrides nothing, and defers all operations to :class:`PacSource`</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">metadata</span><span class="p">,</span> <span class="n">sources</span><span class="p">,</span> <span class="n">cachepath</span><span class="p">,</span> <span class="n">basepath</span><span class="p">,</span> <span class="n">fam</span><span class="p">,</span> <span class="n">debug</span><span class="o">=</span><span class="bp">False</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">Collection</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">metadata</span><span class="p">,</span> <span class="n">sources</span><span class="p">,</span> <span class="n">cachepath</span><span class="p">,</span> <span class="n">basepath</span><span class="p">,</span> <span class="n">fam</span><span class="p">,</span> <span class="n">debug</span><span class="o">=</span><span class="n">debug</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">Collection</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="AptCollection.get_config"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Apt.AptCollection.get_config">[docs]</a> <span class="k">def</span> <span class="nf">get_config</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="sd">""" Get an APT configuration file (i.e., ``sources.list``).</span> <span class="sd"> :returns: string """</span> <span class="n">lines</span> <span class="o">=</span> <span class="p">[</span><span class="s">"# This config was generated automatically by the Bcfg2 "</span> \ <span class="s">"Packages plugin"</span><span class="p">,</span> <span class="s">''</span><span class="p">]</span> <span class="k">for</span> <span class="n">source</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span> <span class="k">if</span> <span class="n">source</span><span class="o">.</span><span class="n">rawurl</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">"Packages: Skipping rawurl </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">source</span><span class="o">.</span><span class="n">rawurl</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"deb </span><span class="si">%s</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="n">source</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">source</span><span class="o">.</span><span class="n">version</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">source</span><span class="o">.</span><span class="n">components</span><span class="p">)))</span> <span class="n">lines</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="s">"</span><span class="se">\n</span><span class="s">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lines</span><span class="p">)</span> </div></div> <div class="viewcode-block" id="AptSource"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Apt.AptSource">[docs]</a><span class="k">class</span> <span class="nc">AptSource</span><span class="p">(</span><span class="n">Source</span><span class="p">):</span> <span class="sd">""" Handle APT sources """</span> <span class="c">#: :ref:`server-plugins-generators-packages-magic-groups` for</span> <span class="c">#: ``AptSource`` are "apt", "debian", "ubuntu", and "nexenta"</span> <span class="n">basegroups</span> <span class="o">=</span> <span class="p">[</span><span class="s">'apt'</span><span class="p">,</span> <span class="s">'debian'</span><span class="p">,</span> <span class="s">'ubuntu'</span><span class="p">,</span> <span class="s">'nexenta'</span><span class="p">]</span> <span class="c">#: AptSource sets the ``type`` on Package entries to "deb"</span> <span class="n">ptype</span> <span class="o">=</span> <span class="s">'deb'</span> <span class="nd">@property</span> <div class="viewcode-block" id="AptSource.urls"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Apt.AptSource.urls">[docs]</a> <span class="k">def</span> <span class="nf">urls</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="sd">""" A list of URLs to the base metadata file for each</span> <span class="sd"> repository described by this source. """</span> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">rawurl</span><span class="p">:</span> <span class="n">rv</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="p">:</span> <span class="k">for</span> <span class="n">arch</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">arches</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="s">"</span><span class="si">%s</span><span class="s">dists/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/binary-</span><span class="si">%s</span><span class="s">/Packages.gz"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">part</span><span class="p">,</span> <span class="n">arch</span><span class="p">))</span> <span class="k">return</span> <span class="n">rv</span> <span class="k">else</span><span class="p">:</span> <span class="k">return</span> <span class="p">[</span><span class="s">"</span><span class="si">%s</span><span class="s">Packages.gz"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">rawurl</span><span class="p">]</span> </div> <div class="viewcode-block" id="AptSource.read_files"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Apt.AptSource.read_files">[docs]</a> <span class="k">def</span> <span class="nf">read_files</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="n">bdeps</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> <span class="n">bprov</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> <span class="n">depfnames</span> <span class="o">=</span> <span class="p">[</span><span class="s">'Depends'</span><span class="p">,</span> <span class="s">'Pre-Depends'</span><span class="p">]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">recommended</span><span class="p">:</span> <span class="n">depfnames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'Recommends'</span><span class="p">)</span> <span class="k">for</span> <span class="n">fname</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</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">rawurl</span><span class="p">:</span> <span class="n">barch</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</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="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'binary-'</span><span class="p">)][</span><span class="mi">0</span><span class="p">][</span><span class="mi">7</span><span class="p">:]</span> <span class="k">else</span><span class="p">:</span> <span class="c"># RawURL entries assume that they only have one <Arch></Arch></span> <span class="c"># element and that it is the architecture of the source.</span> <span class="n">barch</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">arches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">barch</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">bdeps</span><span class="p">:</span> <span class="n">bdeps</span><span class="p">[</span><span class="n">barch</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> <span class="n">bprov</span><span class="p">[</span><span class="n">barch</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> <span class="k">try</span><span class="p">:</span> <span class="n">reader</span> <span class="o">=</span> <span class="n">gzip</span><span class="o">.</span><span class="n">GzipFile</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span> <span class="k">except</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">"Packages: Failed to read file </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">fname</span><span class="p">)</span> <span class="k">raise</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">reader</span><span class="o">.</span><span class="n">readlines</span><span class="p">():</span> <span class="n">words</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">())</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">1</span><span class="p">)</span> <span class="k">if</span> <span class="n">words</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'Package'</span><span class="p">:</span> <span class="n">pkgname</span> <span class="o">=</span> <span class="n">words</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">pkgnames</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">pkgname</span><span class="p">)</span> <span class="n">bdeps</span><span class="p">[</span><span class="n">barch</span><span class="p">][</span><span class="n">pkgname</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">elif</span> <span class="n">words</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'Essential'</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">essential</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">essentialpkgs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">pkgname</span><span class="p">)</span> <span class="k">elif</span> <span class="n">words</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="n">depfnames</span><span class="p">:</span> <span class="n">vindex</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">for</span> <span class="n">dep</span> <span class="ow">in</span> <span class="n">words</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">):</span> <span class="k">if</span> <span class="s">'|'</span> <span class="ow">in</span> <span class="n">dep</span><span class="p">:</span> <span class="n">cdeps</span> <span class="o">=</span> <span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">'\s+'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">'\(.*\)'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="n">cdep</span><span class="p">))</span> <span class="k">for</span> <span class="n">cdep</span> <span class="ow">in</span> <span class="n">dep</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'|'</span><span class="p">)]</span> <span class="n">dyn_dname</span> <span class="o">=</span> <span class="s">"choice-</span><span class="si">%s</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="n">pkgname</span><span class="p">,</span> <span class="n">barch</span><span class="p">,</span> <span class="n">vindex</span><span class="p">)</span> <span class="n">vindex</span> <span class="o">+=</span> <span class="mi">1</span> <span class="n">bdeps</span><span class="p">[</span><span class="n">barch</span><span class="p">][</span><span class="n">pkgname</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dyn_dname</span><span class="p">)</span> <span class="n">bprov</span><span class="p">[</span><span class="n">barch</span><span class="p">][</span><span class="n">dyn_dname</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">cdeps</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="n">raw_dep</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">'\(.*\)'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="n">dep</span><span class="p">)</span> <span class="n">raw_dep</span> <span class="o">=</span> <span class="n">raw_dep</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="n">bdeps</span><span class="p">[</span><span class="n">barch</span><span class="p">][</span><span class="n">pkgname</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">raw_dep</span><span class="p">)</span> <span class="k">elif</span> <span class="n">words</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'Provides'</span><span class="p">:</span> <span class="k">for</span> <span class="n">pkg</span> <span class="ow">in</span> <span class="n">words</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">):</span> <span class="n">dname</span> <span class="o">=</span> <span class="n">pkg</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">if</span> <span class="n">dname</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">bprov</span><span class="p">[</span><span class="n">barch</span><span class="p">]:</span> <span class="n">bprov</span><span class="p">[</span><span class="n">barch</span><span class="p">][</span><span class="n">dname</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> <span class="n">bprov</span><span class="p">[</span><span class="n">barch</span><span class="p">][</span><span class="n">dname</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">pkgname</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">process_files</span><span class="p">(</span><span class="n">bdeps</span><span class="p">,</span> <span class="n">bprov</span><span class="p">)</span></div> <span class="n">read_files</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">Source</span><span class="o">.</span><span class="n">read_files</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> <li><a href="../Packages.html" >Bcfg2.Server.Plugins.Packages</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>