Sophie

Sophie

distrib > Fedora > 17 > x86_64 > by-pkgid > b50d8ee6d7871fcc13c0677a9364ed59 > files > 56

bcfg2-doc-1.3.0-1.fc17.noarch.rpm



<!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.Yum &mdash; 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> |&nbsp;</li>
	<!--<li><a href="../../../../../search.html">search</a> |&nbsp;</li>-->
	<li><a href="../../../../../help/index.html">help</a> |&nbsp;</li>
	<li><a href="../../../../../contents.html">documentation </a> &raquo;</li>

          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../../Plugins.html" >Bcfg2.Server.Plugins</a> &raquo;</li>
          <li><a href="../Packages.html" accesskey="U">Bcfg2.Server.Plugins.Packages</a> &raquo;</li> 
      </ul>
    </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for Bcfg2.Server.Plugins.Packages.Yum</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot; Yum backend for :mod:`Bcfg2.Server.Plugins.Packages`.  This module</span>
<span class="sd">is the most complex backend because it has to handle Yum sources</span>
<span class="sd">without yum Python libraries, with yum Python libraries, and Pulp</span>
<span class="sd">sources.  (See :ref:`native-yum-libraries` for details on using the</span>
<span class="sd">yum Python libraries and :ref:`pulp-source-support` for details on</span>
<span class="sd">Pulp sources.)</span>

<span class="sd">.. _bcfg2-yum-helper:</span>

<span class="sd">bcfg2-yum-helper</span>
<span class="sd">~~~~~~~~~~~~~~~~</span>

<span class="sd">If using the yum Python libraries, :class:`YumCollection` makes shell</span>
<span class="sd">calls to an external command, ``bcfg2-yum-helper``, which performs the</span>
<span class="sd">actual yum API calls.  This is done because the yum libs have horrific</span>
<span class="sd">memory leaks, and apparently the right way to get around that in</span>
<span class="sd">long-running processes it to have a short-lived helper.  This is how</span>
<span class="sd">it&#39;s done by yum itself in ``yum-updatesd``, which is a long-running</span>
<span class="sd">daemon that checks for and applies updates.</span>

<span class="sd">.. _yum-pkg-objects:</span>

<span class="sd">Package Objects</span>
<span class="sd">~~~~~~~~~~~~~~~</span>

<span class="sd">:class:`Bcfg2.Server.Plugins.Packages.Collection.Collection` objects</span>
<span class="sd">have the option to translate from some backend-specific representation</span>
<span class="sd">of packages to XML entries; see :ref:`pkg-objects` for more</span>
<span class="sd">information on this.  If you are using the Python yum libraries,</span>
<span class="sd">:class:`Bcfg2.Server.Plugins.Packages.Yum.YumCollection` opts to do</span>
<span class="sd">this, using the yum tuple representation of packages, which is::</span>

<span class="sd">    (&lt;name&gt;, &lt;arch&gt;, &lt;epoch&gt;, &lt;version&gt;, &lt;release&gt;)</span>

<span class="sd">For shorthand this is occasionally abbrevated &quot;naevr&quot;.  Any datum that</span>
<span class="sd">is not defined is ``None``.  So a normal package entry that can be any</span>
<span class="sd">version would be passed to :ref:`bcfg2-yum-helper` as::</span>

<span class="sd">    (&quot;somepackage&quot;, None, None, None, None)</span>

<span class="sd">A package returned from the helper might look more like this::</span>

<span class="sd">    (&quot;somepackage&quot;, &quot;x86_64&quot;, None, &quot;1.2.3&quot;, &quot;1.el6&quot;)</span>

<span class="sd">We translate between this representation and the XML representation of</span>
<span class="sd">packages with :func:`YumCollection.packages_from_entry` and</span>
<span class="sd">:func:`YumCollection.packages_to_entry`.</span>

<span class="sd">The Yum Backend</span>
<span class="sd">~~~~~~~~~~~~~~~</span>
<span class="sd">&quot;&quot;&quot;</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">errno</span>
<span class="kn">import</span> <span class="nn">socket</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">from</span> <span class="nn">subprocess</span> <span class="kn">import</span> <span class="n">Popen</span><span class="p">,</span> <span class="n">PIPE</span>
<span class="kn">import</span> <span class="nn">Bcfg2.Server.Plugin</span>
<span class="c"># pylint: disable=W0622</span>
<span class="kn">from</span> <span class="nn">Bcfg2.Compat</span> <span class="kn">import</span> <span class="n">StringIO</span><span class="p">,</span> <span class="n">cPickle</span><span class="p">,</span> <span class="n">HTTPError</span><span class="p">,</span> <span class="n">URLError</span><span class="p">,</span> \
    <span class="n">ConfigParser</span><span class="p">,</span> <span class="nb">any</span>
<span class="c"># pylint: enable=W0622</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">SourceInitError</span><span class="p">,</span> <span class="n">Source</span><span class="p">,</span> \
     <span class="n">fetch_url</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="c"># pylint: disable=E0611</span>
<span class="k">try</span><span class="p">:</span>
    <span class="kn">from</span> <span class="nn">pulp.client.consumer.config</span> <span class="kn">import</span> <span class="n">ConsumerConfig</span>
    <span class="kn">from</span> <span class="nn">pulp.client.api.repository</span> <span class="kn">import</span> <span class="n">RepositoryAPI</span>
    <span class="kn">from</span> <span class="nn">pulp.client.api.consumer</span> <span class="kn">import</span> <span class="n">ConsumerAPI</span>
    <span class="kn">from</span> <span class="nn">pulp.client.api</span> <span class="kn">import</span> <span class="n">server</span>
    <span class="n">HAS_PULP</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_PULP</span> <span class="o">=</span> <span class="bp">False</span>
<span class="c"># pylint: enable=E0611</span>

<span class="k">try</span><span class="p">:</span>
    <span class="kn">import</span> <span class="nn">yum</span>
    <span class="k">try</span><span class="p">:</span>
        <span class="kn">import</span> <span class="nn">json</span>
    <span class="k">except</span> <span class="ne">ImportError</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_YUM</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_YUM</span> <span class="o">=</span> <span class="bp">False</span>
    <span class="n">LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Packages: No yum libraries found; forcing use of internal &quot;</span>
                <span class="s">&quot;dependency resolver&quot;</span><span class="p">)</span>


<span class="n">XP</span> <span class="o">=</span> <span class="s">&#39;{http://linux.duke.edu/metadata/common}&#39;</span>
<span class="n">RP</span> <span class="o">=</span> <span class="s">&#39;{http://linux.duke.edu/metadata/rpm}&#39;</span>
<span class="n">RPO</span> <span class="o">=</span> <span class="s">&#39;{http://linux.duke.edu/metadata/repo}&#39;</span>
<span class="n">FL</span> <span class="o">=</span> <span class="s">&#39;{http://linux.duke.edu/metadata/filelists}&#39;</span>

<span class="n">PULPSERVER</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">PULPCONFIG</span> <span class="o">=</span> <span class="bp">None</span>

<span class="c">#: The path to bcfg2-yum-helper</span>
<span class="n">HELPER</span> <span class="o">=</span> <span class="bp">None</span>


<span class="k">def</span> <span class="nf">_setup_pulp</span><span class="p">(</span><span class="n">setup</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Connect to a Pulp server and pass authentication credentials.</span>
<span class="sd">    This only needs to be called once, but multiple calls won&#39;t hurt</span>
<span class="sd">    anything.</span>

<span class="sd">    :param setup: A Bcfg2 options dict</span>
<span class="sd">    :type setup: dict</span>
<span class="sd">    :returns: :class:`pulp.client.api.server.PulpServer`</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">global</span> <span class="n">PULPSERVER</span><span class="p">,</span> <span class="n">PULPCONFIG</span>
    <span class="k">if</span> <span class="ow">not</span> <span class="n">HAS_PULP</span><span class="p">:</span>
        <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Packages: Cannot create Pulp collection: Pulp libraries &quot;</span> <span class="o">+</span> \
            <span class="s">&quot;not found&quot;</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">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="p">(</span><span class="n">msg</span><span class="p">)</span>

    <span class="k">if</span> <span class="n">PULPSERVER</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">username</span> <span class="o">=</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="s">&quot;packages:pulp&quot;</span><span class="p">,</span> <span class="s">&quot;username&quot;</span><span class="p">)</span>
            <span class="n">password</span> <span class="o">=</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="s">&quot;packages:pulp&quot;</span><span class="p">,</span> <span class="s">&quot;password&quot;</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">NoSectionError</span><span class="p">:</span>
            <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Packages: No [pulp] section found in bcfg2.conf&quot;</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">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="p">(</span><span class="n">msg</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">NoOptionError</span><span class="p">:</span>
            <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Packages: Required option not found in bcfg2.conf: </span><span class="si">%s</span><span class="s">&quot;</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">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">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="p">(</span><span class="n">msg</span><span class="p">)</span>

        <span class="n">PULPCONFIG</span> <span class="o">=</span> <span class="n">ConsumerConfig</span><span class="p">()</span>
        <span class="n">serveropts</span> <span class="o">=</span> <span class="n">PULPCONFIG</span><span class="o">.</span><span class="n">server</span>

        <span class="n">PULPSERVER</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">PulpServer</span><span class="p">(</span><span class="n">serveropts</span><span class="p">[</span><span class="s">&#39;host&#39;</span><span class="p">],</span>
                                       <span class="nb">int</span><span class="p">(</span><span class="n">serveropts</span><span class="p">[</span><span class="s">&#39;port&#39;</span><span class="p">]),</span>
                                       <span class="n">serveropts</span><span class="p">[</span><span class="s">&#39;scheme&#39;</span><span class="p">],</span>
                                       <span class="n">serveropts</span><span class="p">[</span><span class="s">&#39;path&#39;</span><span class="p">])</span>
        <span class="n">PULPSERVER</span><span class="o">.</span><span class="n">set_basic_auth_credentials</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">)</span>
        <span class="n">server</span><span class="o">.</span><span class="n">set_active_server</span><span class="p">(</span><span class="n">PULPSERVER</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">PULPSERVER</span>


<div class="viewcode-block" id="PulpCertificateData"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.PulpCertificateData">[docs]</a><span class="k">class</span> <span class="nc">PulpCertificateData</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">SpecificData</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Handle pulp consumer certificate data for</span>
<span class="sd">    :class:`PulpCertificateSet` &quot;&quot;&quot;</span>

<div class="viewcode-block" id="PulpCertificateData.bind_entry"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.PulpCertificateData.bind_entry">[docs]</a>    <span class="k">def</span> <span class="nf">bind_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">_</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Given an abstract entry, add data to it and return it.</span>
<span class="sd">        :class:`PulpCertificateSet` handles binding entry metadata.</span>

<span class="sd">        :param entry: The abstract entry to bind data to</span>
<span class="sd">        :type entry: lxml.etree._Element</span>
<span class="sd">        :returns: lxml.etree._Element - the bound entry</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">entry</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;type&quot;</span><span class="p">,</span> <span class="s">&quot;file&quot;</span><span class="p">)</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">:</span>
            <span class="n">entry</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">entry</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;empty&quot;</span><span class="p">,</span> <span class="s">&quot;true&quot;</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">entry</span>

</div></div>
<div class="viewcode-block" id="PulpCertificateSet"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.PulpCertificateSet">[docs]</a><span class="k">class</span> <span class="nc">PulpCertificateSet</span><span class="p">(</span><span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Handle Pulp consumer certificates. &quot;&quot;&quot;</span>

    <span class="c">#: The path to certificates on consumer machines</span>
    <span class="n">certpath</span> <span class="o">=</span> <span class="s">&quot;/etc/pki/consumer/cert.pem&quot;</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">path</span><span class="p">,</span> <span class="n">fam</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        :param path: The path to the directory where Pulp consumer</span>
<span class="sd">                     certificates will be stored</span>
<span class="sd">        :type path: string</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">Bcfg2</span><span class="o">.</span><span class="n">Server</span><span class="o">.</span><span class="n">Plugin</span><span class="o">.</span><span class="n">EntrySet</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                                              <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">certpath</span><span class="p">),</span>
                                              <span class="n">path</span><span class="p">,</span>
                                              <span class="n">PulpCertificateData</span><span class="p">,</span>
                                              <span class="s">&quot;UTF-8&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">owner</span><span class="o">=</span><span class="s">&#39;root&#39;</span><span class="p">,</span>
                             <span class="n">group</span><span class="o">=</span><span class="s">&#39;root&#39;</span><span class="p">,</span>
                             <span class="n">mode</span><span class="o">=</span><span class="s">&#39;0644&#39;</span><span class="p">,</span>
                             <span class="n">secontext</span><span class="o">=</span><span class="s">&#39;__default__&#39;</span><span class="p">,</span>
                             <span class="n">important</span><span class="o">=</span><span class="s">&#39;true&#39;</span><span class="p">,</span>
                             <span class="n">sensitive</span><span class="o">=</span><span class="s">&#39;true&#39;</span><span class="p">,</span>
                             <span class="n">paranoid</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s">&#39;paranoid&#39;</span><span class="p">])</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">fam</span> <span class="o">=</span> <span class="n">fam</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">fam</span><span class="o">.</span><span class="n">AddMonitor</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>

<div class="viewcode-block" id="PulpCertificateSet.HandleEvent"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.PulpCertificateSet.HandleEvent">[docs]</a>    <span class="k">def</span> <span class="nf">HandleEvent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Handle FAM events on certificate files.</span>

<span class="sd">        :param event: The event to handle</span>
<span class="sd">        :type event: Bcfg2.Server.FileMonitor.Event &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">filename</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="PulpCertificateSet.write_data"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.PulpCertificateSet.write_data">[docs]</a>    <span class="k">def</span> <span class="nf">write_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Write a new certificate to the filesystem.</span>

<span class="sd">        :param data: The new certificate data</span>
<span class="sd">        :type data: string</span>
<span class="sd">        :param metadata: Metadata for the client to write the</span>
<span class="sd">                         certificate for</span>
<span class="sd">        :type metadata: Bcfg2.Server.Plugins.Metadata.ClientMetadata</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">specific</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">.H_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">certpath</span><span class="p">),</span>
                                <span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">)</span>
        <span class="n">fileloc</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">specific</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">&quot;Packages: Writing certificate data for </span><span class="si">%s</span><span class="s"> to </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                         <span class="p">(</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span> <span class="n">fileloc</span><span class="p">))</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="nb">open</span><span class="p">(</span><span class="n">fileloc</span><span class="p">,</span> <span class="s">&#39;wb&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
        <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
            <span class="n">err</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
            <span class="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">&quot;Could not write </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">fileloc</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
            <span class="k">return</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verify_file</span><span class="p">(</span><span class="n">specific</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="PulpCertificateSet.verify_file"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.PulpCertificateSet.verify_file">[docs]</a>    <span class="k">def</span> <span class="nf">verify_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Service the FAM events queued up by the key generation so</span>
<span class="sd">        the data structure entries will be available for binding.</span>

<span class="sd">        NOTE: We wait for up to ten seconds. There is some potential</span>
<span class="sd">        for race condition, because if the file monitor doesn&#39;t get</span>
<span class="sd">        notified about the new key files in time, those entries won&#39;t</span>
<span class="sd">        be available for binding. In practice, this seems &quot;good</span>
<span class="sd">        enough.&quot;</span>

<span class="sd">        :param filename: The filename to check for events on</span>
<span class="sd">        :type filename: string</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">tries</span> <span class="o">=</span> <span class="mi">0</span>
        <span class="n">updated</span> <span class="o">=</span> <span class="bp">False</span>
        <span class="k">while</span> <span class="ow">not</span> <span class="n">updated</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">tries</span> <span class="o">&gt;=</span> <span class="mi">10</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">&quot;</span><span class="si">%s</span><span class="s"> still not registered&quot;</span> <span class="o">%</span> <span class="n">filename</span><span class="p">)</span>
                <span class="k">return</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">fam</span><span class="o">.</span><span class="n">handle_events_in_interval</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">filename</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">:</span>
                <span class="k">break</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">tries</span> <span class="o">+=</span> <span class="mi">1</span>
                <span class="k">continue</span>

</div></div>
<div class="viewcode-block" id="YumCollection"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection">[docs]</a><span class="k">class</span> <span class="nc">YumCollection</span><span class="p">(</span><span class="n">Collection</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Handle collections of Yum sources.  If we&#39;re using the yum</span>
<span class="sd">    Python libraries, then this becomes a very full-featured</span>
<span class="sd">    :class:`Bcfg2.Server.Plugins.Packages.Collection.Collection`</span>
<span class="sd">    object; if not, then it defers to the :class:`YumSource`</span>
<span class="sd">    object.</span>

<span class="sd">    .. private-include: _add_gpg_instances, _get_pulp_consumer</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="c">#: Options that are included in the [packages:yum] section of the</span>
    <span class="c">#: config but that should not be included in the temporary</span>
    <span class="c">#: yum.conf we write out</span>
    <span class="n">option_blacklist</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;use_yum_libraries&quot;</span><span class="p">,</span> <span class="s">&quot;helper&quot;</span><span class="p">]</span>

    <span class="c">#: :class:`PulpCertificateSet` object used to handle Pulp certs</span>
    <span class="n">pulp_cert_set</span> <span class="o">=</span> <span class="bp">None</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="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="bp">self</span><span class="o">.</span><span class="n">keypath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachepath</span><span class="p">,</span> <span class="s">&quot;keys&quot;</span><span class="p">)</span>

        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="c">#: Define a unique cache file for this collection to use</span>
            <span class="c">#: for cached yum metadata</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachepath</span><span class="p">,</span>
                                         <span class="s">&quot;cache-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">cachekey</span><span class="p">)</span>
            <span class="k">if</span> <span class="ow">not</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="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">):</span>
                <span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">)</span>

            <span class="c">#: The path to the server-side config file used when</span>
            <span class="c">#: resolving packages with the Python yum libraries</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">cfgfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">,</span> <span class="s">&quot;yum.conf&quot;</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">write_config</span><span class="p">()</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span> <span class="o">=</span> <span class="bp">None</span>

        <span class="k">if</span> <span class="n">HAS_PULP</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_pulp_sources</span><span class="p">:</span>
            <span class="n">_setup_pulp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="p">)</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pulp_cert_set</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
                <span class="n">certdir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">basepath</span><span class="p">,</span>
                    <span class="s">&quot;pulp&quot;</span><span class="p">,</span>
                    <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">PulpCertificateSet</span><span class="o">.</span><span class="n">certpath</span><span class="p">))</span>
                <span class="k">try</span><span class="p">:</span>
                    <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">certdir</span><span class="p">)</span>
                <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
                    <span class="n">err</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
                    <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">EEXIST</span><span class="p">:</span>
                        <span class="k">pass</span>
                    <span class="k">else</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">&quot;Could not create Pulp consumer &quot;</span>
                                          <span class="s">&quot;cert directory at </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                                          <span class="p">(</span><span class="n">certdir</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">pulp_cert_set</span> <span class="o">=</span> <span class="n">PulpCertificateSet</span><span class="p">(</span><span class="n">certdir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fam</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">__package_groups__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; YumCollections support package groups only if</span>
<span class="sd">        :attr:`use_yum` is True &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span>

    <span class="nd">@property</span>
<div class="viewcode-block" id="YumCollection.helper"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.helper">[docs]</a>    <span class="k">def</span> <span class="nf">helper</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; The full path to :file:`bcfg2-yum-helper`.  First, we</span>
<span class="sd">        check in the config file to see if it has been explicitly</span>
<span class="sd">        specified; next we see if it&#39;s in $PATH (which we do by making</span>
<span class="sd">        a call to it; I wish there was a way to do this without</span>
<span class="sd">        forking, but apparently not); finally we check in /usr/sbin,</span>
<span class="sd">        the default location. &quot;&quot;&quot;</span>
        <span class="k">global</span> <span class="n">HELPER</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">HELPER</span><span class="p">:</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="n">HELPER</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</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="s">&quot;packages:yum&quot;</span><span class="p">,</span> <span class="s">&quot;helper&quot;</span><span class="p">)</span>
            <span class="k">except</span> <span class="p">(</span><span class="n">ConfigParser</span><span class="o">.</span><span class="n">NoOptionError</span><span class="p">,</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">NoSectionError</span><span class="p">):</span>
                <span class="c"># first see if bcfg2-yum-helper is in PATH</span>
                <span class="k">try</span><span class="p">:</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">&quot;Checking for bcfg2-yum-helper in $PATH&quot;</span><span class="p">)</span>
                    <span class="n">Popen</span><span class="p">([</span><span class="s">&#39;bcfg2-yum-helper&#39;</span><span class="p">],</span>
                          <span class="n">stdin</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">)</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
                    <span class="n">HELPER</span> <span class="o">=</span> <span class="s">&#39;bcfg2-yum-helper&#39;</span>
                <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
                    <span class="n">HELPER</span> <span class="o">=</span> <span class="s">&quot;/usr/sbin/bcfg2-yum-helper&quot;</span>
        <span class="k">return</span> <span class="n">HELPER</span>
</div>
    <span class="nd">@property</span>
<div class="viewcode-block" id="YumCollection.use_yum"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.use_yum">[docs]</a>    <span class="k">def</span> <span class="nf">use_yum</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; True if we should use the yum Python libraries, False</span>
<span class="sd">        otherwise &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="n">HAS_YUM</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</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">&quot;packages:yum&quot;</span><span class="p">,</span>
                                                     <span class="s">&quot;use_yum_libraries&quot;</span><span class="p">,</span>
                                                     <span class="n">default</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
</div>
    <span class="nd">@property</span>
<div class="viewcode-block" id="YumCollection.has_pulp_sources"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.has_pulp_sources">[docs]</a>    <span class="k">def</span> <span class="nf">has_pulp_sources</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; True if there are any Pulp sources to handle, False</span>
<span class="sd">        otherwise &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="nb">any</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">pulp_id</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">)</span>
</div>
    <span class="nd">@property</span>
<div class="viewcode-block" id="YumCollection.cachefiles"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.cachefiles">[docs]</a>    <span class="k">def</span> <span class="nf">cachefiles</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; A list of the full path to all cachefiles used by this</span>
<span class="sd">        collection.&quot;&quot;&quot;</span>
        <span class="n">cachefiles</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">Collection</span><span class="o">.</span><span class="n">cachefiles</span><span class="o">.</span><span class="n">fget</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">:</span>
            <span class="n">cachefiles</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">)</span>
        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">cachefiles</span><span class="p">)</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection.write_config"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.write_config">[docs]</a>    <span class="k">def</span> <span class="nf">write_config</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Write the server-side config file to :attr:`cfgfile` based</span>
<span class="sd">        on the data from :func:`get_config`&quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</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="bp">self</span><span class="o">.</span><span class="n">cfgfile</span><span class="p">):</span>
            <span class="n">yumconf</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_config</span><span class="p">(</span><span class="n">raw</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
            <span class="n">yumconf</span><span class="o">.</span><span class="n">add_section</span><span class="p">(</span><span class="s">&quot;main&quot;</span><span class="p">)</span>

            <span class="c"># we set installroot to the cache directory so</span>
            <span class="c"># bcfg2-yum-helper works with an empty rpmdb.  otherwise</span>
            <span class="c"># the rpmdb is so hopelessly intertwined with yum that we</span>
            <span class="c"># have to totally reinvent the dependency resolver.</span>
            <span class="n">mainopts</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">cachedir</span><span class="o">=</span><span class="s">&#39;/&#39;</span><span class="p">,</span>
                            <span class="n">installroot</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">,</span>
                            <span class="n">keepcache</span><span class="o">=</span><span class="s">&quot;0&quot;</span><span class="p">,</span>
                            <span class="n">debuglevel</span><span class="o">=</span><span class="s">&quot;0&quot;</span><span class="p">,</span>
                            <span class="n">sslverify</span><span class="o">=</span><span class="s">&quot;0&quot;</span><span class="p">,</span>
                            <span class="n">reposdir</span><span class="o">=</span><span class="s">&quot;/dev/null&quot;</span><span class="p">)</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="p">[</span><span class="s">&#39;debug&#39;</span><span class="p">]:</span>
                <span class="n">mainopts</span><span class="p">[</span><span class="s">&#39;debuglevel&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&quot;5&quot;</span>
            <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="p">[</span><span class="s">&#39;verbose&#39;</span><span class="p">]:</span>
                <span class="n">mainopts</span><span class="p">[</span><span class="s">&#39;debuglevel&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&quot;2&quot;</span>

            <span class="k">try</span><span class="p">:</span>
                <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="o">.</span><span class="n">cfp</span><span class="o">.</span><span class="n">options</span><span class="p">(</span><span class="s">&quot;packages:yum&quot;</span><span class="p">):</span>
                    <span class="k">if</span> <span class="n">opt</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">option_blacklist</span><span class="p">:</span>
                        <span class="n">mainopts</span><span class="p">[</span><span class="n">opt</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</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="s">&quot;packages:yum&quot;</span><span class="p">,</span> <span class="n">opt</span><span class="p">)</span>
            <span class="k">except</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">NoSectionError</span><span class="p">:</span>
                <span class="k">pass</span>

            <span class="k">for</span> <span class="n">opt</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">mainopts</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
                <span class="n">yumconf</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;main&quot;</span><span class="p">,</span> <span class="n">opt</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>

            <span class="n">yumconf</span><span class="o">.</span><span class="n">write</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">cfgfile</span><span class="p">,</span> <span class="s">&#39;w&#39;</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="YumCollection.get_config"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.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="n">raw</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>  <span class="c"># pylint: disable=W0221</span>
        <span class="sd">&quot;&quot;&quot; Get the yum configuration for this collection.</span>

<span class="sd">        :param raw: Return a :class:`ConfigParser.SafeConfigParser`</span>
<span class="sd">                    object representing the configuration instead of a</span>
<span class="sd">                    string.  This is useful if you need to modify the</span>
<span class="sd">                    config before writing it (as :func:`write_config`</span>
<span class="sd">                    does in order to produce a server-specific</span>
<span class="sd">                    configuration).</span>
<span class="sd">        :type raw: bool</span>
<span class="sd">        :returns: string or ConfigParser.SafeConfigParser &quot;&quot;&quot;</span>

        <span class="n">config</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">SafeConfigParser</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">for</span> <span class="n">url_map</span> <span class="ow">in</span> <span class="n">source</span><span class="o">.</span><span class="n">url_map</span><span class="p">:</span>
                <span class="k">if</span> <span class="n">url_map</span><span class="p">[</span><span class="s">&#39;arch&#39;</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">groups</span><span class="p">:</span>
                    <span class="k">continue</span>
                <span class="n">basereponame</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">get_repo_name</span><span class="p">(</span><span class="n">url_map</span><span class="p">)</span>
                <span class="n">reponame</span> <span class="o">=</span> <span class="n">basereponame</span>

                <span class="n">added</span> <span class="o">=</span> <span class="bp">False</span>
                <span class="k">while</span> <span class="ow">not</span> <span class="n">added</span><span class="p">:</span>
                    <span class="k">try</span><span class="p">:</span>
                        <span class="n">config</span><span class="o">.</span><span class="n">add_section</span><span class="p">(</span><span class="n">reponame</span><span class="p">)</span>
                        <span class="n">added</span> <span class="o">=</span> <span class="bp">True</span>
                    <span class="k">except</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">DuplicateSectionError</span><span class="p">:</span>
                        <span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">&quot;-(\d+)&quot;</span><span class="p">,</span> <span class="n">reponame</span><span class="p">)</span>
                        <span class="k">if</span> <span class="n">match</span><span class="p">:</span>
                            <span class="n">rid</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span> <span class="o">+</span> <span class="mi">1</span>
                        <span class="k">else</span><span class="p">:</span>
                            <span class="n">rid</span> <span class="o">=</span> <span class="mi">1</span>
                        <span class="n">reponame</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">-</span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">basereponame</span><span class="p">,</span> <span class="n">rid</span><span class="p">)</span>

                <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;name&quot;</span><span class="p">,</span> <span class="n">reponame</span><span class="p">)</span>
                <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;baseurl&quot;</span><span class="p">,</span> <span class="n">url_map</span><span class="p">[</span><span class="s">&#39;url&#39;</span><span class="p">])</span>
                <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;enabled&quot;</span><span class="p">,</span> <span class="s">&quot;1&quot;</span><span class="p">)</span>
                <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">source</span><span class="o">.</span><span class="n">gpgkeys</span><span class="p">):</span>
                    <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;gpgcheck&quot;</span><span class="p">,</span> <span class="s">&quot;1&quot;</span><span class="p">)</span>
                    <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;gpgkey&quot;</span><span class="p">,</span>
                               <span class="s">&quot; &quot;</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">gpgkeys</span><span class="p">))</span>
                <span class="k">else</span><span class="p">:</span>
                    <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;gpgcheck&quot;</span><span class="p">,</span> <span class="s">&quot;0&quot;</span><span class="p">)</span>

                <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">source</span><span class="o">.</span><span class="n">blacklist</span><span class="p">):</span>
                    <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;exclude&quot;</span><span class="p">,</span>
                               <span class="s">&quot; &quot;</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">blacklist</span><span class="p">))</span>
                <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">source</span><span class="o">.</span><span class="n">whitelist</span><span class="p">):</span>
                    <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="s">&quot;includepkgs&quot;</span><span class="p">,</span>
                               <span class="s">&quot; &quot;</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">whitelist</span><span class="p">))</span>

                <span class="k">if</span> <span class="n">raw</span><span class="p">:</span>
                    <span class="n">opts</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">server_options</span>
                <span class="k">else</span><span class="p">:</span>
                    <span class="n">opts</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">client_options</span>
                <span class="k">for</span> <span class="n">opt</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">opts</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
                    <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">reponame</span><span class="p">,</span> <span class="n">opt</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">raw</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">config</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="c"># configparser only writes to file, so we have to use a</span>
            <span class="c"># StringIO object to get the data out as a string</span>
            <span class="n">buf</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span>
            <span class="n">config</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">buf</span><span class="p">)</span>
            <span class="k">return</span> <span class="s">&quot;# This config was generated automatically by the Bcfg2 &quot;</span> \
                   <span class="s">&quot;Packages plugin</span><span class="se">\n\n</span><span class="s">&quot;</span> <span class="o">+</span> <span class="n">buf</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection.build_extra_structures"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.build_extra_structures">[docs]</a>    <span class="k">def</span> <span class="nf">build_extra_structures</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">independent</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Add additional entries to the ``&lt;Independent/&gt;`` section</span>
<span class="sd">        of the final configuration.  This adds several kinds of</span>
<span class="sd">        entries:</span>

<span class="sd">        * For GPG keys, adds a ``Package`` entry that describes the</span>
<span class="sd">          version and release of all expected ``gpg-pubkey`` packages;</span>
<span class="sd">          and ``Path`` entries to copy all of the GPG keys to the</span>
<span class="sd">          appropriate place on the client filesystem.  Calls</span>
<span class="sd">          :func:`_add_gpg_instances`.</span>

<span class="sd">        * For Pulp Sources, adds a ``Path`` entry for the consumer</span>
<span class="sd">          certificate; and ``Action`` entries to update the</span>
<span class="sd">          consumer-side Pulp config if the consumer is newly</span>
<span class="sd">          registered.  Creates a new Pulp consumer from the Bcfg2</span>
<span class="sd">          server as necessary.</span>

<span class="sd">        :param independent: The XML tag to add extra entries to.  This</span>
<span class="sd">                            is modified in place.</span>
<span class="sd">        :type independent: lxml.etree._Element</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">needkeys</span> <span class="o">=</span> <span class="nb">set</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">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">source</span><span class="o">.</span><span class="n">gpgkeys</span><span class="p">:</span>
                <span class="n">needkeys</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>

        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">needkeys</span><span class="p">):</span>
            <span class="k">if</span> <span class="n">HAS_YUM</span><span class="p">:</span>
                <span class="c"># this must be be HAS_YUM, not use_yum, because</span>
                <span class="c"># regardless of whether the user wants to use the yum</span>
                <span class="c"># resolver we want to include gpg key data</span>
                <span class="n">keypkg</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&#39;BoundPackage&#39;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&quot;gpg-pubkey&quot;</span><span class="p">,</span>
                                            <span class="nb">type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ptype</span><span class="p">,</span> <span class="n">origin</span><span class="o">=</span><span class="s">&#39;Packages&#39;</span><span class="p">)</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">&quot;GPGKeys were specified for yum sources &quot;</span>
                                    <span class="s">&quot;in sources.xml, but no yum libraries &quot;</span>
                                    <span class="s">&quot;were found&quot;</span><span class="p">)</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">&quot;GPG key version/release data cannot be &quot;</span>
                                    <span class="s">&quot;determined automatically&quot;</span><span class="p">)</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">&quot;Install yum libraries, or manage GPG &quot;</span>
                                    <span class="s">&quot;keys manually&quot;</span><span class="p">)</span>
                <span class="n">keypkg</span> <span class="o">=</span> <span class="bp">None</span>

            <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">needkeys</span><span class="p">:</span>
                <span class="c"># figure out the path of the key on the client</span>
                <span class="n">keydir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</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="s">&quot;global&quot;</span><span class="p">,</span> <span class="s">&quot;gpg_keypath&quot;</span><span class="p">,</span>
                                            <span class="n">default</span><span class="o">=</span><span class="s">&quot;/etc/pki/rpm-gpg&quot;</span><span class="p">)</span>
                <span class="n">remotekey</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">keydir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
                <span class="n">localkey</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keypath</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
                <span class="n">kdata</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">localkey</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

                <span class="c"># copy the key to the client</span>
                <span class="n">keypath</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;BoundPath&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">remotekey</span><span class="p">,</span>
                                             <span class="n">encoding</span><span class="o">=</span><span class="s">&#39;ascii&#39;</span><span class="p">,</span>
                                             <span class="n">owner</span><span class="o">=</span><span class="s">&#39;root&#39;</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="s">&#39;root&#39;</span><span class="p">,</span>
                                             <span class="nb">type</span><span class="o">=</span><span class="s">&#39;file&#39;</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s">&#39;0644&#39;</span><span class="p">,</span>
                                             <span class="n">important</span><span class="o">=</span><span class="s">&#39;true&#39;</span><span class="p">)</span>
                <span class="n">keypath</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">kdata</span>

                <span class="c"># hook to add version/release info if possible</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">_add_gpg_instances</span><span class="p">(</span><span class="n">keypkg</span><span class="p">,</span> <span class="n">localkey</span><span class="p">,</span> <span class="n">remotekey</span><span class="p">,</span>
                                        <span class="n">keydata</span><span class="o">=</span><span class="n">kdata</span><span class="p">)</span>
                <span class="n">independent</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">keypath</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">keypkg</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
                <span class="n">independent</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">keypkg</span><span class="p">)</span>

        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_pulp_sources</span><span class="p">:</span>
            <span class="n">consumerapi</span> <span class="o">=</span> <span class="n">ConsumerAPI</span><span class="p">()</span>
            <span class="n">consumer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_pulp_consumer</span><span class="p">(</span><span class="n">consumerapi</span><span class="o">=</span><span class="n">consumerapi</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">consumer</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
                <span class="k">try</span><span class="p">:</span>
                    <span class="n">consumer</span> <span class="o">=</span> \
                        <span class="n">consumerapi</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span>
                                           <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span>
                                           <span class="n">capabilities</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">bind</span><span class="o">=</span><span class="bp">False</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">SubElement</span><span class="p">(</span>
                        <span class="n">independent</span><span class="p">,</span> <span class="s">&quot;BoundAction&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&quot;pulp-update&quot;</span><span class="p">,</span>
                        <span class="n">timing</span><span class="o">=</span><span class="s">&quot;pre&quot;</span><span class="p">,</span> <span class="n">when</span><span class="o">=</span><span class="s">&quot;always&quot;</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="s">&quot;check&quot;</span><span class="p">,</span>
                        <span class="n">command</span><span class="o">=</span><span class="s">&quot;pulp-consumer consumer update&quot;</span><span class="p">)</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">pulp_cert_set</span><span class="o">.</span><span class="n">write_data</span><span class="p">(</span><span class="n">consumer</span><span class="p">[</span><span class="s">&#39;certificate&#39;</span><span class="p">],</span>
                                                  <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
                <span class="k">except</span> <span class="n">server</span><span class="o">.</span><span class="n">ServerRequestError</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">&quot;Packages: Could not create Pulp &quot;</span>
                                      <span class="s">&quot;consumer </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                                      <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span> <span class="n">err</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="c"># each pulp source can only have one arch, so we don&#39;t</span>
                <span class="c"># have to check the arch in url_map</span>
                <span class="k">if</span> <span class="p">(</span><span class="n">source</span><span class="o">.</span><span class="n">pulp_id</span> <span class="ow">and</span>
                    <span class="n">source</span><span class="o">.</span><span class="n">pulp_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">consumer</span><span class="p">[</span><span class="s">&#39;repoids&#39;</span><span class="p">]):</span>
                    <span class="k">try</span><span class="p">:</span>
                        <span class="n">consumerapi</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span>
                                         <span class="n">source</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">)</span>
                    <span class="k">except</span> <span class="n">server</span><span class="o">.</span><span class="n">ServerRequestError</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">&quot;Packages: Could not bind </span><span class="si">%s</span><span class="s"> to &quot;</span>
                                          <span class="s">&quot;Pulp repo </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                                          <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span>
                                           <span class="n">source</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>

            <span class="n">crt</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">independent</span><span class="p">,</span> <span class="s">&quot;BoundPath&quot;</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">pulp_cert_set</span><span class="o">.</span><span class="n">certpath</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">pulp_cert_set</span><span class="o">.</span><span class="n">bind_entry</span><span class="p">(</span><span class="n">crt</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">)</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection._get_pulp_consumer"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection._get_pulp_consumer">[docs]</a>    <span class="k">def</span> <span class="nf">_get_pulp_consumer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">consumerapi</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Get a Pulp consumer object for the client.</span>

<span class="sd">        :param consumerapi: A Pulp ConsumerAPI object.  If none is</span>
<span class="sd">                            passed, one will be instantiated.</span>
<span class="sd">        :type consumerapi: pulp.client.api.consumer.ConsumerAPI</span>
<span class="sd">        :returns: dict - the consumer.  Returns None on failure</span>
<span class="sd">                  (including if there is no existing Pulp consumer for</span>
<span class="sd">                  this client.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="n">consumerapi</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
            <span class="n">consumerapi</span> <span class="o">=</span> <span class="n">ConsumerAPI</span><span class="p">()</span>
        <span class="n">consumer</span> <span class="o">=</span> <span class="bp">None</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">consumer</span> <span class="o">=</span> <span class="n">consumerapi</span><span class="o">.</span><span class="n">consumer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">hostname</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">server</span><span class="o">.</span><span class="n">ServerRequestError</span><span class="p">:</span>
            <span class="c"># consumer does not exist</span>
            <span class="k">pass</span>
        <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</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">&quot;Packages: Could not contact Pulp server: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                              <span class="n">err</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="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">&quot;Packages: Unknown error querying Pulp server: &quot;</span>
                              <span class="s">&quot;</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">err</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">consumer</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection._add_gpg_instances"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection._add_gpg_instances">[docs]</a>    <span class="k">def</span> <span class="nf">_add_gpg_instances</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keyentry</span><span class="p">,</span> <span class="n">localkey</span><span class="p">,</span> <span class="n">remotekey</span><span class="p">,</span> <span class="n">keydata</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Add GPG keys instances to a ``Package`` entry.  This is</span>
<span class="sd">        called from :func:`build_extra_structures` to add GPG keys to</span>
<span class="sd">        the specification.</span>

<span class="sd">        :param keyentry: The ``Package`` entry to add key instances</span>
<span class="sd">                         to.  This will be modified in place.</span>
<span class="sd">        :type keyentry: lxml.etree._Element</span>
<span class="sd">        :param localkey: The full path to the key file on the Bcfg2 server</span>
<span class="sd">        :type localkey: string</span>
<span class="sd">        :param remotekey: The full path to the key file on the client.</span>
<span class="sd">                          (If they key is not yet on the client, this</span>
<span class="sd">                          will be the full path to where the key file</span>
<span class="sd">                          will go eventually.)</span>
<span class="sd">        :type remotekey: string</span>
<span class="sd">        :param keydata: The contents of the key file.  If this is not</span>
<span class="sd">                        provided, read the data from ``localkey``.</span>
<span class="sd">        :type keydata: string</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="c"># this must be be HAS_YUM, not use_yum, because regardless of</span>
        <span class="c"># whether the user wants to use the yum resolver we want to</span>
        <span class="c"># include gpg key data</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">HAS_YUM</span><span class="p">:</span>
            <span class="k">return</span>

        <span class="k">if</span> <span class="n">keydata</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
            <span class="n">keydata</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">localkey</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

        <span class="k">try</span><span class="p">:</span>
            <span class="n">kinfo</span> <span class="o">=</span> <span class="n">yum</span><span class="o">.</span><span class="n">misc</span><span class="o">.</span><span class="n">getgpgkeyinfo</span><span class="p">(</span><span class="n">keydata</span><span class="p">)</span>
            <span class="n">version</span> <span class="o">=</span> <span class="n">yum</span><span class="o">.</span><span class="n">misc</span><span class="o">.</span><span class="n">keyIdToRPMVer</span><span class="p">(</span><span class="n">kinfo</span><span class="p">[</span><span class="s">&#39;keyid&#39;</span><span class="p">])</span>
            <span class="n">release</span> <span class="o">=</span> <span class="n">yum</span><span class="o">.</span><span class="n">misc</span><span class="o">.</span><span class="n">keyIdToRPMVer</span><span class="p">(</span><span class="n">kinfo</span><span class="p">[</span><span class="s">&#39;timestamp&#39;</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">SubElement</span><span class="p">(</span><span class="n">keyentry</span><span class="p">,</span> <span class="s">&#39;Instance&#39;</span><span class="p">,</span>
                                  <span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">,</span>
                                  <span class="n">release</span><span class="o">=</span><span class="n">release</span><span class="p">,</span>
                                  <span class="n">simplefile</span><span class="o">=</span><span class="n">remotekey</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="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">&quot;Packages: Could not read GPG key </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                              <span class="p">(</span><span class="n">localkey</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection.get_groups"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.get_groups">[docs]</a>    <span class="k">def</span> <span class="nf">get_groups</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">grouplist</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; If using the yum libraries, given a list of package group</span>
<span class="sd">        names, return a dict of ``&lt;group name&gt;: &lt;list of packages&gt;``.</span>
<span class="sd">        This is much faster than implementing</span>
<span class="sd">        :func:`Bcfg2.Server.Plugins.Packages.Collection.Collection.get_group`,</span>
<span class="sd">        since we have to make a call to the bcfg2 Yum helper, and each</span>
<span class="sd">        time we do that we make another call to yum, which means we</span>
<span class="sd">        set up yum metadata from the cache (hopefully) each time.  So</span>
<span class="sd">        resolving ten groups once is much faster than resolving one</span>
<span class="sd">        group ten times.</span>

<span class="sd">        If you are using the builtin yum parser, this raises a warning</span>
<span class="sd">        and returns an empty dict.</span>

<span class="sd">        :param grouplist: The list of groups to query</span>
<span class="sd">        :type grouplist: list of strings - group names</span>
<span class="sd">        :returns: dict of ``&lt;group name&gt;: &lt;list of packages&gt;``</span>

<span class="sd">        In this implementation the packages may be strings or tuples.</span>
<span class="sd">        See :ref:`yum-pkg-objects` for more information. &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">&quot;Packages: Package groups are not supported &quot;</span>
                                <span class="s">&quot;by Bcfg2&#39;s internal Yum dependency generator&quot;</span><span class="p">)</span>
            <span class="k">return</span> <span class="nb">dict</span><span class="p">()</span>

        <span class="k">if</span> <span class="ow">not</span> <span class="n">grouplist</span><span class="p">:</span>
            <span class="k">return</span> <span class="nb">dict</span><span class="p">()</span>

        <span class="n">gdicts</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">group</span><span class="p">,</span> <span class="n">ptype</span> <span class="ow">in</span> <span class="n">grouplist</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">group</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&quot;@&quot;</span><span class="p">):</span>
                <span class="n">group</span> <span class="o">=</span> <span class="n">group</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
            <span class="k">if</span> <span class="ow">not</span> <span class="n">ptype</span><span class="p">:</span>
                <span class="n">ptype</span> <span class="o">=</span> <span class="s">&quot;default&quot;</span>
            <span class="n">gdicts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="n">ptype</span><span class="p">))</span>

        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">call_helper</span><span class="p">(</span><span class="s">&quot;get_groups&quot;</span><span class="p">,</span> <span class="n">inputdata</span><span class="o">=</span><span class="n">gdicts</span><span class="p">)</span>
</div>
    <span class="k">def</span> <span class="nf">_element_to_pkg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">el</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Convert a Package or Instance element to a package tuple &quot;&quot;&quot;</span>
        <span class="n">rv</span> <span class="o">=</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">el</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;arch&quot;</span><span class="p">),</span> <span class="n">el</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;epoch&quot;</span><span class="p">),</span>
              <span class="n">el</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">),</span> <span class="n">el</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;release&quot;</span><span class="p">))</span>
        <span class="k">if</span> <span class="n">rv</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;any&#39;</span><span class="p">,</span> <span class="s">&#39;auto&#39;</span><span class="p">]:</span>
            <span class="n">rv</span> <span class="o">=</span> <span class="p">(</span><span class="n">rv</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">rv</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">rv</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
        <span class="c"># if a package requires no specific version, we just use</span>
        <span class="c"># the name, not the tuple.  this limits the amount of JSON</span>
        <span class="c"># encoding/decoding that has to be done to pass the</span>
        <span class="c"># package list to bcfg2-yum-helper.</span>
        <span class="k">if</span> <span class="n">rv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="o">==</span> <span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">):</span>
            <span class="k">return</span> <span class="n">name</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">rv</span>

<div class="viewcode-block" id="YumCollection.packages_from_entry"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.packages_from_entry">[docs]</a>    <span class="k">def</span> <span class="nf">packages_from_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; When using the Python yum libraries, convert a Package</span>
<span class="sd">        entry to a list of package tuples.  See :ref:`yum-pkg-objects`</span>
<span class="sd">        and :ref:`pkg-objects` for more information on this process.</span>

<span class="sd">        :param entry: The Package entry to convert</span>
<span class="sd">        :type entry: lxml.etree._Element</span>
<span class="sd">        :returns: list of tuples</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">Collection</span><span class="o">.</span><span class="n">packages_from_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span>

        <span class="n">rv</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
        <span class="n">name</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;name&quot;</span><span class="p">)</span>

        <span class="k">for</span> <span class="n">inst</span> <span class="ow">in</span> <span class="n">entry</span><span class="o">.</span><span class="n">getchildren</span><span class="p">():</span>
            <span class="k">if</span> <span class="n">inst</span><span class="o">.</span><span class="n">tag</span> <span class="o">!=</span> <span class="s">&quot;Instance&quot;</span><span class="p">:</span>
                <span class="k">continue</span>
            <span class="n">rv</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_element_to_pkg</span><span class="p">(</span><span class="n">inst</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">rv</span><span class="p">:</span>
            <span class="n">rv</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_element_to_pkg</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
</div>
    <span class="k">def</span> <span class="nf">_get_entry_attrs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pkgtup</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Given a package tuple, return a dict of attributes</span>
<span class="sd">        suitable for applying to either a Package or an Instance</span>
<span class="sd">        tag &quot;&quot;&quot;</span>
        <span class="n">attrs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</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="s">&quot;packages&quot;</span><span class="p">,</span> <span class="s">&quot;version&quot;</span><span class="p">,</span>
                                                <span class="n">default</span><span class="o">=</span><span class="s">&quot;auto&quot;</span><span class="p">))</span>
        <span class="k">if</span> <span class="n">attrs</span><span class="p">[</span><span class="s">&#39;version&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;any&#39;</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pkgtup</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
            <span class="k">return</span> <span class="n">attrs</span>

        <span class="k">try</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
                <span class="n">attrs</span><span class="p">[</span><span class="s">&#39;arch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
            <span class="k">if</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span>
                <span class="n">attrs</span><span class="p">[</span><span class="s">&#39;epoch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
            <span class="k">if</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">3</span><span class="p">]:</span>
                <span class="n">attrs</span><span class="p">[</span><span class="s">&#39;version&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
            <span class="k">if</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">4</span><span class="p">]:</span>
                <span class="n">attrs</span><span class="p">[</span><span class="s">&#39;release&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">pkgtup</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span>
        <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s">&quot;Malformed package tuple: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">pkgtup</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">attrs</span>

<div class="viewcode-block" id="YumCollection.packages_to_entry"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.packages_to_entry">[docs]</a>    <span class="k">def</span> <span class="nf">packages_to_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pkglist</span><span class="p">,</span> <span class="n">entry</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; When using the Python yum libraries, convert a list of</span>
<span class="sd">        package tuples to a Package entry.  See :ref:`yum-pkg-objects`</span>
<span class="sd">        and :ref:`pkg-objects` for more information on this process.</span>

<span class="sd">        If pkglist contains only one package, then its data is</span>
<span class="sd">        converted to a single ``BoundPackage`` entry that is added as</span>
<span class="sd">        a subelement of ``entry``.  If pkglist contains more than one</span>
<span class="sd">        package, then a parent ``BoundPackage`` entry is created and</span>
<span class="sd">        child ``Instance`` entries are added to it.</span>

<span class="sd">        :param pkglist: A list of package tuples to convert to an XML</span>
<span class="sd">                         Package entry</span>
<span class="sd">        :type pkglist: list of tuples</span>
<span class="sd">        :param entry: The base XML entry to add Package entries to.</span>
<span class="sd">                      This is modified in place.</span>
<span class="sd">        :type entry: lxml.etree._Element</span>
<span class="sd">        :returns: None</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">Collection</span><span class="o">.</span><span class="n">packages_to_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pkglist</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span>

        <span class="n">packages</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="k">for</span> <span class="n">pkg</span> <span class="ow">in</span> <span class="n">pkglist</span><span class="p">:</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="n">packages</span><span class="p">[</span><span class="n">pkg</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pkg</span><span class="p">)</span>
            <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
                <span class="n">packages</span><span class="p">[</span><span class="n">pkg</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[</span><span class="n">pkg</span><span class="p">]</span>
        <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">instances</span> <span class="ow">in</span> <span class="n">packages</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
            <span class="n">pkgattrs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ptype</span><span class="p">,</span>
                            <span class="n">origin</span><span class="o">=</span><span class="s">&#39;Packages&#39;</span><span class="p">,</span>
                            <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">instances</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
                <span class="n">pkg_el</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="s">&#39;BoundPackage&#39;</span><span class="p">,</span>
                                               <span class="o">**</span><span class="n">pkgattrs</span><span class="p">)</span>
                <span class="k">for</span> <span class="n">inst</span> <span class="ow">in</span> <span class="n">instances</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">SubElement</span><span class="p">(</span><span class="n">pkg_el</span><span class="p">,</span> <span class="s">&quot;Instance&quot;</span><span class="p">,</span>
                                          <span class="bp">self</span><span class="o">.</span><span class="n">_get_entry_attrs</span><span class="p">(</span><span class="n">inst</span><span class="p">))</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">attrs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_entry_attrs</span><span class="p">(</span><span class="n">instances</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
                <span class="n">attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">pkgattrs</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">SubElement</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="s">&#39;BoundPackage&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">attrs</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="YumCollection.get_new_packages"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.get_new_packages">[docs]</a>    <span class="k">def</span> <span class="nf">get_new_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial</span><span class="p">,</span> <span class="n">complete</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Compute the difference between the complete package list</span>
<span class="sd">        (as returned by :func:`complete`) and the initial package list</span>
<span class="sd">        computed from the specification, allowing for package tuples.</span>
<span class="sd">        See :ref:`yum-pkg-objects` and :ref:`pkg-objects` for more</span>
<span class="sd">        information on this process.</span>

<span class="sd">        :param initial: The initial package list</span>
<span class="sd">        :type initial: set of strings, but see :ref:`pkg-objects`</span>
<span class="sd">        :param complete: The final package list</span>
<span class="sd">        :type complete: set of strings, but see :ref:`pkg-objects`</span>
<span class="sd">        :return: set of tuples</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">initial_names</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">pkg</span> <span class="ow">in</span> <span class="n">initial</span><span class="p">:</span>
            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pkg</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
                <span class="n">initial_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pkg</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">initial_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pkg</span><span class="p">)</span>
        <span class="n">new</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">pkg</span> <span class="ow">in</span> <span class="n">complete</span><span class="p">:</span>
            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pkg</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
                <span class="n">name</span> <span class="o">=</span> <span class="n">pkg</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">name</span> <span class="o">=</span> <span class="n">pkg</span>
            <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">initial_names</span><span class="p">:</span>
                <span class="n">new</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pkg</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">new</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection.complete"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.complete">[docs]</a>    <span class="k">def</span> <span class="nf">complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packagelist</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Build a complete list of all packages and their dependencies.</span>

<span class="sd">        When using the Python yum libraries, this defers to the</span>
<span class="sd">        :ref:`bcfg2-yum-helper`; when using the builtin yum parser,</span>
<span class="sd">        this defers to</span>
<span class="sd">        :func:`Bcfg2.Server.Plugins.Packages.Collection.Collection.complete`.</span>

<span class="sd">        :param packagelist: Set of initial packages computed from the</span>
<span class="sd">                            specification.</span>
<span class="sd">        :type packagelist: set of strings, but see :ref:`pkg-objects`</span>
<span class="sd">        :returns: tuple of sets - The first element contains a set of</span>
<span class="sd">                  strings (but see :ref:`pkg-objects`) describing the</span>
<span class="sd">                  complete package list, and the second element is a</span>
<span class="sd">                  set of symbols whose dependencies could not be</span>
<span class="sd">                  resolved.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">Collection</span><span class="o">.</span><span class="n">complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packagelist</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">packagelist</span><span class="p">:</span>
            <span class="n">result</span> <span class="o">=</span> \
                <span class="bp">self</span><span class="o">.</span><span class="n">call_helper</span><span class="p">(</span><span class="s">&quot;complete&quot;</span><span class="p">,</span>
                                 <span class="nb">dict</span><span class="p">(</span><span class="n">packages</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="n">packagelist</span><span class="p">),</span>
                                      <span class="n">groups</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_relevant_groups</span><span class="p">())))</span>
            <span class="k">if</span> <span class="ow">not</span> <span class="n">result</span><span class="p">:</span>
                <span class="c"># some sort of error, reported by call_helper()</span>
                <span class="k">return</span> <span class="nb">set</span><span class="p">(),</span> <span class="n">packagelist</span>
            <span class="c"># json doesn&#39;t understand sets or tuples, so we get back a</span>
            <span class="c"># lists of lists (packages) and a list of unicode strings</span>
            <span class="c"># (unknown).  turn those into a set of tuples and a set of</span>
            <span class="c"># strings, respectively.</span>
            <span class="n">unknown</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">u</span><span class="p">)</span> <span class="k">for</span> <span class="n">u</span> <span class="ow">in</span> <span class="n">result</span><span class="p">[</span><span class="s">&#39;unknown&#39;</span><span class="p">]])</span>
            <span class="n">packages</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="nb">tuple</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">result</span><span class="p">[</span><span class="s">&#39;packages&#39;</span><span class="p">]])</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">filter_unknown</span><span class="p">(</span><span class="n">unknown</span><span class="p">)</span>
            <span class="k">return</span> <span class="n">packages</span><span class="p">,</span> <span class="n">unknown</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="nb">set</span><span class="p">(),</span> <span class="nb">set</span><span class="p">()</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumCollection.call_helper"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.call_helper">[docs]</a>    <span class="k">def</span> <span class="nf">call_helper</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">inputdata</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Make a call to :ref:`bcfg2-yum-helper`.  The yum libs have</span>
<span class="sd">        horrific memory leaks, so apparently the right way to get</span>
<span class="sd">        around that in long-running processes it to have a short-lived</span>
<span class="sd">        helper.  No, seriously -- check out the yum-updatesd code.</span>
<span class="sd">        It&#39;s pure madness.</span>

<span class="sd">        :param command: The :ref:`bcfg2-yum-helper` command to call.</span>
<span class="sd">        :type command: string</span>
<span class="sd">        :param inputdata: The input to pass to ``bcfg2-yum-helper`` on</span>
<span class="sd">                          stdin.  If this is None, no input will be</span>
<span class="sd">                          given at all.</span>
<span class="sd">        :type inputdata: Any JSON-encodable data structure.</span>
<span class="sd">        :returns: Varies depending on the return value of the</span>
<span class="sd">                  ``bcfg2-yum-helper`` command.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">helper</span><span class="p">,</span> <span class="s">&quot;-c&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfgfile</span><span class="p">]</span>
        <span class="n">verbose</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_flag</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="p">[</span><span class="s">&#39;verbose&#39;</span><span class="p">]</span>
        <span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
            <span class="n">cmd</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-v&quot;</span><span class="p">)</span>
        <span class="n">cmd</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">&quot;Packages: running </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cmd</span><span class="p">),</span> <span class="n">flag</span><span class="o">=</span><span class="n">verbose</span><span class="p">)</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">helper</span> <span class="o">=</span> <span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">stdin</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</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">&quot;Packages: Failed to execute </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                              <span class="p">(</span><span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cmd</span><span class="p">),</span> <span class="n">err</span><span class="p">))</span>
            <span class="k">return</span> <span class="bp">None</span>

        <span class="k">if</span> <span class="n">inputdata</span><span class="p">:</span>
            <span class="n">idata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">inputdata</span><span class="p">)</span>
            <span class="p">(</span><span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span><span class="p">)</span> <span class="o">=</span> <span class="n">helper</span><span class="o">.</span><span class="n">communicate</span><span class="p">(</span><span class="n">idata</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="p">(</span><span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span><span class="p">)</span> <span class="o">=</span> <span class="n">helper</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
        <span class="n">rv</span> <span class="o">=</span> <span class="n">helper</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
        <span class="k">if</span> <span class="n">rv</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">&quot;Packages: error running bcfg2-yum-helper &quot;</span>
                              <span class="s">&quot;(returned </span><span class="si">%d</span><span class="s">): </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rv</span><span class="p">,</span> <span class="n">stderr</span><span class="p">))</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">debug_log</span><span class="p">(</span><span class="s">&quot;Packages: debug info from bcfg2-yum-helper: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                           <span class="n">stderr</span><span class="p">,</span> <span class="n">flag</span><span class="o">=</span><span class="n">verbose</span><span class="p">)</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">stdout</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="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">&quot;Packages: error reading bcfg2-yum-helper &quot;</span>
                              <span class="s">&quot;output: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">err</span><span class="p">)</span>
            <span class="k">return</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="YumCollection.setup_data"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumCollection.setup_data">[docs]</a>    <span class="k">def</span> <span class="nf">setup_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force_update</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Do any collection-level data setup tasks. This is called</span>
<span class="sd">        when sources are loaded or reloaded by</span>
<span class="sd">        :class:`Bcfg2.Server.Plugins.Packages.Packages`.</span>

<span class="sd">        If the builtin yum parsers are in use, this defers to</span>
<span class="sd">        :func:`Bcfg2.Server.Plugins.Packages.Collection.Collection.setup_data`.</span>
<span class="sd">        If using the yum Python libraries, this cleans up cached yum</span>
<span class="sd">        metadata, regenerates the server-side yum config (in order to</span>
<span class="sd">        catch any new sources that have been added to this server),</span>
<span class="sd">        and then cleans up cached yum metadata again, in case the new</span>
<span class="sd">        config has any preexisting cache.</span>

<span class="sd">        :param force_update: Ignore all local cache and setup data</span>
<span class="sd">                             from its original upstream sources (i.e.,</span>
<span class="sd">                             the package repositories)</span>
<span class="sd">        :type force_update: bool</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">Collection</span><span class="o">.</span><span class="n">setup_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force_update</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">force_update</span><span class="p">:</span>
            <span class="c"># we call this twice: one to clean up data from the old</span>
            <span class="c"># config, and once to clean up data from the new config</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">call_helper</span><span class="p">(</span><span class="s">&quot;clean&quot;</span><span class="p">)</span>

        <span class="n">os</span><span class="o">.</span><span class="n">unlink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfgfile</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">write_config</span><span class="p">()</span>

        <span class="k">if</span> <span class="n">force_update</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">call_helper</span><span class="p">(</span><span class="s">&quot;clean&quot;</span><span class="p">)</span>

</div></div>
<div class="viewcode-block" id="YumSource"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource">[docs]</a><span class="k">class</span> <span class="nc">YumSource</span><span class="p">(</span><span class="n">Source</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Handle yum sources &quot;&quot;&quot;</span>

    <span class="c">#: :ref:`server-plugins-generators-packages-magic-groups` for</span>
    <span class="c">#: ``YumSource`` are &quot;yum&quot;, &quot;redhat&quot;, &quot;centos&quot;, and &quot;fedora&quot;</span>
    <span class="n">basegroups</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;yum&#39;</span><span class="p">,</span> <span class="s">&#39;redhat&#39;</span><span class="p">,</span> <span class="s">&#39;centos&#39;</span><span class="p">,</span> <span class="s">&#39;fedora&#39;</span><span class="p">]</span>

    <span class="c">#: YumSource sets the ``type`` on Package entries to &quot;yum&quot;</span>
    <span class="n">ptype</span> <span class="o">=</span> <span class="s">&#39;yum&#39;</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">basepath</span><span class="p">,</span> <span class="n">xsource</span><span class="p">,</span> <span class="n">setup</span><span class="p">):</span>
        <span class="n">Source</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">basepath</span><span class="p">,</span> <span class="n">xsource</span><span class="p">,</span> <span class="n">setup</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span> <span class="o">=</span> <span class="bp">None</span>
        <span class="k">if</span> <span class="n">HAS_PULP</span> <span class="ow">and</span> <span class="n">xsource</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;pulp_id&quot;</span><span class="p">):</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span> <span class="o">=</span> <span class="n">xsource</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;pulp_id&quot;</span><span class="p">)</span>

            <span class="n">_setup_pulp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="p">)</span>
            <span class="n">repoapi</span> <span class="o">=</span> <span class="n">RepositoryAPI</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">repo</span> <span class="o">=</span> <span class="n">repoapi</span><span class="o">.</span><span class="n">repository</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">)</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">gpgkeys</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">PULPCONFIG</span><span class="o">.</span><span class="n">cds</span><span class="p">[</span><span class="s">&#39;keyurl&#39;</span><span class="p">],</span> <span class="n">key</span><span class="p">)</span>
                                <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">repoapi</span><span class="o">.</span><span class="n">listkeys</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">)]</span>
            <span class="k">except</span> <span class="n">server</span><span class="o">.</span><span class="n">ServerRequestError</span><span class="p">:</span>
                <span class="n">err</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
                <span class="k">if</span> <span class="n">err</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">401</span><span class="p">:</span>
                    <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Packages: Error authenticating to Pulp: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">err</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
                <span class="k">elif</span> <span class="n">err</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">404</span><span class="p">:</span>
                    <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Packages: Pulp repo id </span><span class="si">%s</span><span class="s"> not found: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> \
                          <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">,</span> <span class="n">err</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
                <span class="k">else</span><span class="p">:</span>
                    <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Packages: Error </span><span class="si">%d</span><span class="s"> fetching pulp repo </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> \
                          <span class="p">(</span><span class="n">err</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">,</span> <span class="n">err</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
                <span class="k">raise</span> <span class="n">SourceInitError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
            <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</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">SourceInitError</span><span class="p">(</span><span class="s">&quot;Could not contact Pulp server: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                                      <span class="n">err</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">SourceInitError</span><span class="p">(</span><span class="s">&quot;Unknown error querying Pulp server: </span><span class="si">%s</span><span class="s">&quot;</span>
                                      <span class="o">%</span> <span class="n">err</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">rawurl</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">PULPCONFIG</span><span class="o">.</span><span class="n">cds</span><span class="p">[</span><span class="s">&#39;baseurl&#39;</span><span class="p">],</span>
                                     <span class="bp">self</span><span class="o">.</span><span class="n">repo</span><span class="p">[</span><span class="s">&#39;relative_path&#39;</span><span class="p">])</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">arches</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">repo</span><span class="p">[</span><span class="s">&#39;arch&#39;</span><span class="p">]]</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">packages</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deps</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="s">&#39;global&#39;</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())])</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">provides</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="s">&#39;global&#39;</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())])</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="n">x</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
                             <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;global&#39;</span><span class="p">]</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="bp">self</span><span class="o">.</span><span class="n">needed_paths</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">file_to_arch</span> <span class="o">=</span> <span class="nb">dict</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">Source</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>

    <span class="nd">@property</span>
<div class="viewcode-block" id="YumSource.use_yum"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.use_yum">[docs]</a>    <span class="k">def</span> <span class="nf">use_yum</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; True if we should use the yum Python libraries, False</span>
<span class="sd">        otherwise &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="n">HAS_YUM</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</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">&quot;packages:yum&quot;</span><span class="p">,</span>
                                                     <span class="s">&quot;use_yum_libraries&quot;</span><span class="p">,</span>
                                                     <span class="n">default</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="YumSource.save_state"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.save_state">[docs]</a>    <span class="k">def</span> <span class="nf">save_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; If using the builtin yum parser, save state to</span>
<span class="sd">        :attr:`cachefile`.  If using the Python yum libraries, yum</span>
<span class="sd">        handles caching and state and this method is a no-op.&quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="n">cache</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">,</span> <span class="s">&#39;wb&#39;</span><span class="p">)</span>
            <span class="n">cPickle</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">packages</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deps</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">,</span>
                          <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_map</span><span class="p">),</span> <span class="n">cache</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
            <span class="n">cache</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="YumSource.load_state"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.load_state">[docs]</a>    <span class="k">def</span> <span class="nf">load_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; If using the builtin yum parser, load saved state from</span>
<span class="sd">        :attr:`cachefile`.  If using the Python yum libraries, yum</span>
<span class="sd">        handles caching and state and this method is a no-op.&quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="n">data</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cachefile</span><span class="p">)</span>
            <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deps</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">,</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_map</span><span class="p">)</span> <span class="o">=</span> <span class="n">cPickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</div>
    <span class="nd">@property</span>
<div class="viewcode-block" id="YumSource.urls"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.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">&quot;&quot;&quot; A list of URLs to the base metadata file for each</span>
<span class="sd">        repository described by this source. &quot;&quot;&quot;</span>
        <span class="n">rv</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">umap</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_map</span><span class="p">:</span>
            <span class="n">rv</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_urls_from_repodata</span><span class="p">(</span><span class="n">umap</span><span class="p">[</span><span class="s">&#39;url&#39;</span><span class="p">],</span> <span class="n">umap</span><span class="p">[</span><span class="s">&#39;arch&#39;</span><span class="p">]))</span>
        <span class="k">return</span> <span class="n">rv</span>
</div>
    <span class="k">def</span> <span class="nf">_get_urls_from_repodata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">arch</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; When using the builtin yum parser, given the base URL of a</span>
<span class="sd">        repository, return the URLs of the various repo metadata files</span>
<span class="sd">        needed to get package data from the repo.</span>

<span class="sd">        If using the yum Python libraries, this just returns ``url``</span>
<span class="sd">        as it was passed in, but should realistically not be called.</span>

<span class="sd">        :param url: The base URL to the repository (i.e., the</span>
<span class="sd">                    directory that contains the ``repodata/`` directory)</span>
<span class="sd">        :type url: string</span>
<span class="sd">        :param arch: The architecture of the directory.</span>
<span class="sd">        :type arch: string</span>
<span class="sd">        :return: list of strings - URLs to metadata files</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="k">return</span> <span class="p">[</span><span class="n">url</span><span class="p">]</span>

        <span class="n">rmdurl</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">repodata/repomd.xml&#39;</span> <span class="o">%</span> <span class="n">url</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">repomd</span> <span class="o">=</span> <span class="n">fetch_url</span><span class="p">(</span><span class="n">rmdurl</span><span class="p">)</span>
        <span class="k">except</span> <span class="ne">ValueError</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">&quot;Packages: Bad url string </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">rmdurl</span><span class="p">)</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">except</span> <span class="n">HTTPError</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">&quot;Packages: Failed to fetch url </span><span class="si">%s</span><span class="s">. code=</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                              <span class="p">(</span><span class="n">rmdurl</span><span class="p">,</span> <span class="n">err</span><span class="o">.</span><span class="n">code</span><span class="p">))</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">except</span> <span class="n">URLError</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">&quot;Packages: Failed to fetch url </span><span class="si">%s</span><span class="s">. </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                              <span class="p">(</span><span class="n">rmdurl</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
            <span class="k">return</span> <span class="p">[]</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">xdata</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">XML</span><span class="p">(</span><span class="n">repomd</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">XMLSyntaxError</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">&quot;Packages: Failed to process metadata at </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span>
                              <span class="o">%</span> <span class="p">(</span><span class="n">rmdurl</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span>
            <span class="k">return</span> <span class="p">[]</span>

        <span class="n">urls</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">elt</span> <span class="ow">in</span> <span class="n">xdata</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">RPO</span> <span class="o">+</span> <span class="s">&#39;data&#39;</span><span class="p">):</span>
            <span class="k">if</span> <span class="n">elt</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;type&#39;</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;filelists&#39;</span><span class="p">,</span> <span class="s">&#39;primary&#39;</span><span class="p">]:</span>
                <span class="n">floc</span> <span class="o">=</span> <span class="n">elt</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">RPO</span> <span class="o">+</span> <span class="s">&#39;location&#39;</span><span class="p">)</span>
                <span class="n">fullurl</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="n">floc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;href&#39;</span><span class="p">)</span>
                <span class="n">urls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fullurl</span><span class="p">)</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">file_to_arch</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">escape_url</span><span class="p">(</span><span class="n">fullurl</span><span class="p">)]</span> <span class="o">=</span> <span class="n">arch</span>
        <span class="k">return</span> <span class="n">urls</span>

    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumSource.read_files"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.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="sd">&quot;&quot;&quot; When using the builtin yum parser, read and parse locally</span>
<span class="sd">        downloaded metadata files.  This diverges from the stock</span>
<span class="sd">        :func:`Bcfg2.Server.Plugins.Packages.Source.Source.read_files`</span>
<span class="sd">        quite a bit. &quot;&quot;&quot;</span>

        <span class="c"># we have to read primary.xml first, and filelists.xml afterwards;</span>
        <span class="n">primaries</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
        <span class="n">filelists</span> <span class="o">=</span> <span class="nb">list</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="n">fname</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">&#39;primary.xml.gz&#39;</span><span class="p">):</span>
                <span class="n">primaries</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
            <span class="k">elif</span> <span class="n">fname</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">&#39;filelists.xml.gz&#39;</span><span class="p">):</span>
                <span class="n">filelists</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>

        <span class="k">for</span> <span class="n">fname</span> <span class="ow">in</span> <span class="n">primaries</span><span class="p">:</span>
            <span class="n">farch</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">file_to_arch</span><span class="p">[</span><span class="n">fname</span><span class="p">]</span>
            <span class="n">fdata</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">parse</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span><span class="o">.</span><span class="n">getroot</span><span class="p">()</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">parse_primary</span><span class="p">(</span><span class="n">fdata</span><span class="p">,</span> <span class="n">farch</span><span class="p">)</span>
        <span class="k">for</span> <span class="n">fname</span> <span class="ow">in</span> <span class="n">filelists</span><span class="p">:</span>
            <span class="n">farch</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">file_to_arch</span><span class="p">[</span><span class="n">fname</span><span class="p">]</span>
            <span class="n">fdata</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">parse</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span><span class="o">.</span><span class="n">getroot</span><span class="p">()</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">parse_filelist</span><span class="p">(</span><span class="n">fdata</span><span class="p">,</span> <span class="n">farch</span><span class="p">)</span>

        <span class="c"># merge data</span>
        <span class="n">sdata</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="o">.</span><span class="n">values</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">packages</span><span class="p">[</span><span class="s">&#39;global&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">sdata</span><span class="o">.</span><span class="n">pop</span><span class="p">())</span>
        <span class="k">except</span> <span class="ne">IndexError</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">&quot;Packages: No packages in repo&quot;</span><span class="p">)</span>
        <span class="k">while</span> <span class="n">sdata</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="s">&#39;global&#39;</span><span class="p">]</span> <span class="o">=</span> \
                <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="s">&#39;global&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">intersection</span><span class="p">(</span><span class="n">sdata</span><span class="o">.</span><span class="n">pop</span><span class="p">())</span>

        <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="s">&#39;global&#39;</span><span class="p">:</span>
                <span class="k">continue</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> \
                <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">difference</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="s">&#39;global&#39;</span><span class="p">])</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">save_state</span><span class="p">()</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumSource.parse_filelist"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.parse_filelist">[docs]</a>    <span class="k">def</span> <span class="nf">parse_filelist</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">arch</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; parse filelists.xml.gz data &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="n">arch</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">[</span><span class="n">arch</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="k">for</span> <span class="n">pkg</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">FL</span> <span class="o">+</span> <span class="s">&#39;package&#39;</span><span class="p">):</span>
            <span class="k">for</span> <span class="n">fentry</span> <span class="ow">in</span> <span class="n">pkg</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">FL</span> <span class="o">+</span> <span class="s">&#39;file&#39;</span><span class="p">):</span>
                <span class="k">if</span> <span class="n">fentry</span><span class="o">.</span><span class="n">text</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">needed_paths</span><span class="p">:</span>
                    <span class="k">if</span> <span class="n">fentry</span><span class="o">.</span><span class="n">text</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">[</span><span class="n">arch</span><span class="p">]:</span>
                        <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">[</span><span class="n">arch</span><span class="p">][</span><span class="n">fentry</span><span class="o">.</span><span class="n">text</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">pkg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">))</span>
                    <span class="k">else</span><span class="p">:</span>
                        <span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="p">[</span><span class="n">arch</span><span class="p">][</span><span class="n">fentry</span><span class="o">.</span><span class="n">text</span><span class="p">]</span> <span class="o">=</span> \
                            <span class="nb">set</span><span class="p">([</span><span class="n">pkg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">)])</span>
</div>
    <span class="nd">@Bcfg2.Server.Plugin.track_statistics</span><span class="p">()</span>
<div class="viewcode-block" id="YumSource.parse_primary"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.parse_primary">[docs]</a>    <span class="k">def</span> <span class="nf">parse_primary</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">arch</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; parse primary.xml.gz data &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="n">arch</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="n">arch</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
        <span class="k">if</span> <span class="n">arch</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">deps</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">deps</span><span class="p">[</span><span class="n">arch</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="k">if</span> <span class="n">arch</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">[</span><span class="n">arch</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="k">for</span> <span class="n">pkg</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">getchildren</span><span class="p">():</span>
            <span class="k">if</span> <span class="ow">not</span> <span class="n">pkg</span><span class="o">.</span><span class="n">tag</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">&#39;package&#39;</span><span class="p">):</span>
                <span class="k">continue</span>
            <span class="n">pkgname</span> <span class="o">=</span> <span class="n">pkg</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">XP</span> <span class="o">+</span> <span class="s">&#39;name&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">text</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="n">arch</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="n">pdata</span> <span class="o">=</span> <span class="n">pkg</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">XP</span> <span class="o">+</span> <span class="s">&#39;format&#39;</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">deps</span><span class="p">[</span><span class="n">arch</span><span class="p">][</span><span class="n">pkgname</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
            <span class="n">pre</span> <span class="o">=</span> <span class="n">pdata</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">RP</span> <span class="o">+</span> <span class="s">&#39;requires&#39;</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">pre</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
                <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">pre</span><span class="o">.</span><span class="n">getchildren</span><span class="p">():</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">deps</span><span class="p">[</span><span class="n">arch</span><span class="p">][</span><span class="n">pkgname</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">))</span>
                    <span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&#39;/&#39;</span><span class="p">):</span>
                        <span class="bp">self</span><span class="o">.</span><span class="n">needed_paths</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">))</span>
            <span class="n">pro</span> <span class="o">=</span> <span class="n">pdata</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">RP</span> <span class="o">+</span> <span class="s">&#39;provides&#39;</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">pro</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
                <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">pro</span><span class="o">.</span><span class="n">getchildren</span><span class="p">():</span>
                    <span class="n">prov</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">)</span>
                    <span class="k">if</span> <span class="n">prov</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">[</span><span class="n">arch</span><span class="p">]:</span>
                        <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">[</span><span class="n">arch</span><span class="p">][</span><span class="n">prov</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">provides</span><span class="p">[</span><span class="n">arch</span><span class="p">][</span><span class="n">prov</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pkgname</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="YumSource.is_package"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.is_package">[docs]</a>    <span class="k">def</span> <span class="nf">is_package</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">package</span><span class="p">):</span>
        <span class="n">arch</span> <span class="o">=</span> <span class="p">[</span><span class="n">a</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">arches</span> <span class="k">if</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">metadata</span><span class="o">.</span><span class="n">groups</span><span class="p">]</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">arch</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">False</span>
        <span class="k">return</span> <span class="p">((</span><span class="n">package</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="s">&#39;global&#39;</span><span class="p">]</span> <span class="ow">or</span>
                 <span class="n">package</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">packages</span><span class="p">[</span><span class="n">arch</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="ow">and</span>
                <span class="n">package</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">blacklist</span> <span class="ow">and</span>
                <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">whitelist</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">package</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">whitelist</span><span class="p">))</span></div>
    <span class="n">is_package</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">is_package</span><span class="o">.</span><span class="n">__doc__</span>

<div class="viewcode-block" id="YumSource.get_vpkgs"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.get_vpkgs">[docs]</a>    <span class="k">def</span> <span class="nf">get_vpkgs</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="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="k">return</span> <span class="nb">dict</span><span class="p">()</span>

        <span class="n">rv</span> <span class="o">=</span> <span class="n">Source</span><span class="o">.</span><span class="n">get_vpkgs</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">for</span> <span class="n">arch</span><span class="p">,</span> <span class="n">fmdata</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filemap</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
            <span class="k">if</span> <span class="n">arch</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">metadata</span><span class="o">.</span><span class="n">groups</span> <span class="ow">and</span> <span class="n">arch</span> <span class="o">!=</span> <span class="s">&#39;global&#39;</span><span class="p">:</span>
                <span class="k">continue</span>
            <span class="k">for</span> <span class="n">filename</span><span class="p">,</span> <span class="n">pkgs</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">fmdata</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">filename</span><span class="p">]</span> <span class="o">=</span> <span class="n">pkgs</span>
        <span class="k">return</span> <span class="n">rv</span></div>
    <span class="n">get_vpkgs</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">get_vpkgs</span><span class="o">.</span><span class="n">__doc__</span>

<div class="viewcode-block" id="YumSource.unknown_filter"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.unknown_filter">[docs]</a>    <span class="k">def</span> <span class="nf">unknown_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">package</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; By default,</span>
<span class="sd">        :class:`Bcfg2.Server.Plugins.Packages.Source.Source` filters</span>
<span class="sd">        out unknown packages that start with &quot;choice&quot;, but that</span>
<span class="sd">        doesn&#39;t mean anything to Yum or RPM.  Instead, we filter out</span>
<span class="sd">        unknown packages that start with &quot;rpmlib&quot;, although this is</span>
<span class="sd">        likely legacy behavior; that would seem to indicate that a</span>
<span class="sd">        package required some RPM feature that isn&#39;t provided, which</span>
<span class="sd">        is a bad thing.  This should probably go away at some point.</span>

<span class="sd">        :param package: The name of a package that was unknown to the</span>
<span class="sd">                        backend</span>
<span class="sd">        :type package: string</span>
<span class="sd">        :returns: bool</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="n">package</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&quot;rpmlib&quot;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="YumSource.filter_unknown"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.filter_unknown">[docs]</a>    <span class="k">def</span> <span class="nf">filter_unknown</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unknown</span><span class="p">):</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_yum</span><span class="p">:</span>
            <span class="n">filtered</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
            <span class="k">for</span> <span class="n">unk</span> <span class="ow">in</span> <span class="n">unknown</span><span class="p">:</span>
                <span class="k">try</span><span class="p">:</span>
                    <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">unknown_filter</span><span class="p">(</span><span class="n">unk</span><span class="p">):</span>
                        <span class="n">filtered</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">unk</span><span class="p">)</span>
                <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
                    <span class="k">try</span><span class="p">:</span>
                        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">unknown_filter</span><span class="p">(</span><span class="n">unk</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
                            <span class="n">filtered</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">unk</span><span class="p">)</span>
                    <span class="k">except</span> <span class="p">(</span><span class="ne">IndexError</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">):</span>
                        <span class="k">pass</span>
            <span class="n">unknown</span><span class="o">.</span><span class="n">difference_update</span><span class="p">(</span><span class="n">filtered</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">Source</span><span class="o">.</span><span class="n">filter_unknown</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unknown</span><span class="p">)</span></div>
    <span class="n">filter_unknown</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">filter_unknown</span><span class="o">.</span><span class="n">__doc__</span>

<div class="viewcode-block" id="YumSource.setup_data"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.setup_data">[docs]</a>    <span class="k">def</span> <span class="nf">setup_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force_update</span><span class="o">=</span><span class="bp">False</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">use_yum</span><span class="p">:</span>
            <span class="n">Source</span><span class="o">.</span><span class="n">setup_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force_update</span><span class="o">=</span><span class="n">force_update</span><span class="p">)</span></div>
    <span class="n">setup_data</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> \
        <span class="s">&quot;``setup_data`` is only used by the builtin yum parser.  &quot;</span> <span class="o">+</span> \
        <span class="n">Source</span><span class="o">.</span><span class="n">setup_data</span><span class="o">.</span><span class="n">__doc__</span>

<div class="viewcode-block" id="YumSource.get_repo_name"><a class="viewcode-back" href="../../../../../development/packages.html#Bcfg2.Server.Plugins.Packages.Yum.YumSource.get_repo_name">[docs]</a>    <span class="k">def</span> <span class="nf">get_repo_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url_map</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Try to find a sensible name for a repository.  First use a</span>
<span class="sd">        repository&#39;s Pulp ID, if it has one; if not, then defer to</span>
<span class="sd">        :class:`Bcfg2.Server.Plugins.Packages.Source.Source.get_repo_name`</span>

<span class="sd">        :param url_map: A single :attr:`url_map` dict, i.e., any</span>
<span class="sd">                        single element of :attr:`url_map`.</span>
<span class="sd">        :type url_map: dict</span>
<span class="sd">        :returns: string - the name of the repository.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">pulp_id</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">Source</span><span class="o">.</span><span class="n">get_repo_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url_map</span><span class="p">)</span></div></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> |&nbsp;</li>
	<!--<li><a href="../../../../../search.html">search</a> |&nbsp;</li>-->
	<li><a href="../../../../../help/index.html">help</a> |&nbsp;</li>
	<li><a href="../../../../../contents.html">documentation </a> &raquo;</li>

          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../../Plugins.html" >Bcfg2.Server.Plugins</a> &raquo;</li>
          <li><a href="../Packages.html" >Bcfg2.Server.Plugins.Packages</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; 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>