Add changes for 91e330c

Contribution/Development.html

@@ -181,7 +181,7 @@ <h1>MetPX-Sarracenia Developer’s Guide<a class="headerlink" href="#metpx-sarra
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 <section id="tools-you-need">

Contribution/man_page_template.html

@@ -131,7 +131,7 @@ <h2>sr_title<a class="headerlink" href="#sr-title" title="Link to this heading">
 <dd class="field-odd"><p>1</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>

Explanation/SarraPluginDev.html

@@ -151,7 +151,7 @@ <h3>Revision Record<a class="headerlink" href="#revision-record" title="Link to
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 </section>

How2Guides/source.html

@@ -145,7 +145,7 @@ <h3>Revision Record<a class="headerlink" href="#revision-record" title="Link to
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 <p>A Sarracenia data pump is a web (or sftp) server with notifications for subscribers

How2Guides/subscriber.html

@@ -143,7 +143,7 @@ <h3>Revision Record<a class="headerlink" href="#revision-record" title="Link to
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 </section>

Reference/sr3.1.html

@@ -130,7 +130,7 @@ <h2>sr3 Sarracenia CLI<a class="headerlink" href="#sr3-sarracenia-cli" title="Li
 <dd class="field-odd"><p>1</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>

Reference/sr3_cpump.1.html

@@ -127,7 +127,7 @@ <h2>sr_shovel in C<a class="headerlink" href="#sr-shovel-in-c" title="Link to th
 <dd class="field-odd"><p>1</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>

Reference/sr3_credentials.7.html

@@ -124,7 +124,7 @@ <h2>SR3 Credential File Format<a class="headerlink" href="#sr3-credential-file-f
 <dd class="field-odd"><p>7</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>

Reference/sr3_options.7.html

@@ -128,7 +128,7 @@ <h2>SR3 Configuration File Format<a class="headerlink" href="#sr3-configuration-
 <dd class="field-odd"><p>7</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>
@@ -1705,6 +1705,13 @@ <h4>timeCopy (default: on)<a class="headerlink" href="#timecopy-default-on" titl
 <p>When set in a posting component, it has the effect of eliding the <em>atime</em> and <em>mtime</em>
 headers from the messages.</p>
 </section>
+<section id="topiccopy-default-off">
+<h4>topicCopy (default: off)<a class="headerlink" href="#topiccopy-default-off" title="Link to this heading"></a></h4>
+<p>Setting <em>topicCopy</em> to true tells sarracenia pass topics through unaltered.
+Sarracenia has a convention for how topics for products should be organized. There is
+a topicPrefix, followed by subtopics derived from the <em>relPath</em> field of the message.
+Some networks may choose to use different topic conventions, external to sarracenia.</p>
+</section>
 <section id="timeout-interval-default-0">
 <h4>timeout &lt;interval&gt; (default: 0)<a class="headerlink" href="#timeout-interval-default-0" title="Link to this heading"></a></h4>
 <p>The <strong>timeout</strong> option, sets the number of seconds to wait before aborting a

Reference/sr3_post.1.html

@@ -128,7 +128,7 @@ <h2>Publish the Availability of Files<a class="headerlink" href="#publish-the-av
 <dd class="field-odd"><p>1</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>

Reference/sr_post.7.html

@@ -133,7 +133,7 @@ <h2>Sarracenia v03 Notification Message Format/Protocol<a class="headerlink" hre
 <dd class="field-odd"><p>7</p>
 </dd>
 <dt class="field-even">Date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
 <dd class="field-odd"><p>UNKNOWN</p>

Tutorials/Install.html

@@ -134,7 +134,7 @@ <h2>Revision Record<a class="headerlink" href="#revision-record" title="Link to
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 </section>

_modules/sarracenia/config.html

@@ -204,6 +204,7 @@ <h1>Source code for sarracenia.config</h1><div class="highlight"><pre>
     <span class="s1">&#39;sourceFromExchange&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
     <span class="s1">&#39;sundew_compat_regex_first_match_is_zero&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
     <span class="s1">&#39;sourceFromExchange&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+    <span class="s1">&#39;topicCopy&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
     <span class="s1">&#39;v2compatRenameDoublePost&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
     <span class="s1">&#39;varTimeOffset&#39;</span><span class="p">:</span> <span class="mi">0</span>
 <span class="p">}</span>
@@ -222,7 +223,7 @@ <h1>Source code for sarracenia.config</h1><div class="highlight"><pre>
     <span class="s1">&#39;messageDebugDump&#39;</span><span class="p">,</span> <span class="s1">&#39;mirror&#39;</span><span class="p">,</span> <span class="s1">&#39;timeCopy&#39;</span><span class="p">,</span> <span class="s1">&#39;notify_only&#39;</span><span class="p">,</span> <span class="s1">&#39;overwrite&#39;</span><span class="p">,</span> <span class="s1">&#39;post_on_start&#39;</span><span class="p">,</span> \
     <span class="s1">&#39;permCopy&#39;</span><span class="p">,</span> <span class="s1">&#39;persistent&#39;</span><span class="p">,</span> <span class="s1">&#39;queueBind&#39;</span><span class="p">,</span> <span class="s1">&#39;queueDeclare&#39;</span><span class="p">,</span> <span class="s1">&#39;randomize&#39;</span><span class="p">,</span> <span class="s1">&#39;recursive&#39;</span><span class="p">,</span> <span class="s1">&#39;realpathPost&#39;</span><span class="p">,</span> \
     <span class="s1">&#39;reconnect&#39;</span><span class="p">,</span> <span class="s1">&#39;report&#39;</span><span class="p">,</span> <span class="s1">&#39;reset&#39;</span><span class="p">,</span> <span class="s1">&#39;retry_refilter&#39;</span><span class="p">,</span> <span class="s1">&#39;retryEmptyBeforeExit&#39;</span><span class="p">,</span> <span class="s1">&#39;save&#39;</span><span class="p">,</span> <span class="s1">&#39;sundew_compat_regex_first_match_is_zero&#39;</span><span class="p">,</span> \
-    <span class="s1">&#39;sourceFromExchange&#39;</span><span class="p">,</span> <span class="s1">&#39;statehost&#39;</span><span class="p">,</span> <span class="s1">&#39;users&#39;</span><span class="p">,</span> <span class="s1">&#39;v2compatRenameDoublePost&#39;</span>
+    <span class="s1">&#39;sourceFromExchange&#39;</span><span class="p">,</span> <span class="s1">&#39;statehost&#39;</span><span class="p">,</span> <span class="s1">&#39;topicCopy&#39;</span><span class="p">,</span> <span class="s1">&#39;users&#39;</span><span class="p">,</span> <span class="s1">&#39;v2compatRenameDoublePost&#39;</span>
                 <span class="p">]</span>
 
 <span class="n">float_options</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span>

_modules/sarracenia/flow.html

@@ -135,6 +135,7 @@ <h1>Source code for sarracenia.flow</h1><div class="highlight"><pre>
     <span class="s1">&#39;messageRateMin&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="s1">&#39;sleep&#39;</span><span class="p">:</span> <span class="mf">0.1</span><span class="p">,</span>
     <span class="s1">&#39;topicPrefix&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;v03&#39;</span><span class="p">],</span>
+    <span class="s1">&#39;topicCopy&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
     <span class="s1">&#39;vip&#39;</span><span class="p">:</span> <span class="p">[]</span>
 <span class="p">}</span>
 

_modules/sarracenia/flow/shovel.html

@@ -78,7 +78,10 @@ <h1>Source code for sarracenia.flow.shovel</h1><div class="highlight"><pre>
 
 <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="vm">__name__</span><span class="p">)</span>
 
-<span class="n">default_options</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;acceptUnmatched&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;nodupe_ttl&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">}</span>
+<span class="n">default_options</span> <span class="o">=</span> <span class="p">{</span>
+        <span class="s1">&#39;acceptUnmatched&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> 
+        <span class="s1">&#39;nodupe_ttl&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+<span class="p">}</span>
 
 
 <div class="viewcode-block" id="Shovel">

_modules/sarracenia/flow/winnow.html

@@ -78,7 +78,10 @@ <h1>Source code for sarracenia.flow.winnow</h1><div class="highlight"><pre>
 
 <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="vm">__name__</span><span class="p">)</span>
 
-<span class="n">default_options</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;acceptUnmatched&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;nodupe_ttl&#39;</span><span class="p">:</span> <span class="mi">300</span><span class="p">}</span>
+<span class="n">default_options</span> <span class="o">=</span> <span class="p">{</span>
+        <span class="s1">&#39;acceptUnmatched&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> 
+        <span class="s1">&#39;nodupe_ttl&#39;</span><span class="p">:</span> <span class="mi">300</span><span class="p">,</span>
+<span class="p">}</span>
 
 
 <div class="viewcode-block" id="Winnow">

_modules/sarracenia/moth/amqp.html

@@ -231,7 +231,29 @@ <h1>Source code for sarracenia.moth.amqp</h1><div class="highlight"><pre>
                 <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;source&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">source</span>
                 <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;_deleteOnPost&#39;</span><span class="p">]</span> <span class="o">|=</span> <span class="nb">set</span><span class="p">([</span><span class="s1">&#39;source&#39;</span><span class="p">])</span>
 
-            <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;subtopic&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">topic</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</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">o</span><span class="p">[</span><span class="s1">&#39;topicPrefix&#39;</span><span class="p">]):]</span>
+            <span class="n">msg_topic</span> <span class="o">=</span> <span class="n">topic</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
+
+            <span class="c1"># topic validation... deal with DMS topic scheme. https://github.com/MetPX/sarracenia/issues/1017</span>
+            <span class="k">if</span> <span class="s1">&#39;topicCopy&#39;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">o</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">o</span><span class="p">[</span><span class="s1">&#39;topicCopy&#39;</span><span class="p">]:</span>
+                <span class="n">topicOverride</span><span class="o">=</span><span class="kc">True</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="n">topicOverride</span><span class="o">=</span><span class="kc">False</span>
+                <span class="k">if</span> <span class="s1">&#39;relPath&#39;</span> <span class="ow">in</span> <span class="n">msg</span><span class="p">:</span>
+                    <span class="n">path_topic</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">o</span><span class="p">[</span><span class="s1">&#39;topicPrefix&#39;</span><span class="p">]</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">dirname</span><span class="p">(</span><span class="n">msg</span><span class="p">[</span><span class="s1">&#39;relPath&#39;</span><span class="p">])</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
+
+                    <span class="k">if</span> <span class="n">msg_topic</span> <span class="o">!=</span> <span class="n">path_topic</span><span class="p">:</span>
+                        <span class="n">topicOverride</span><span class="o">=</span><span class="kc">True</span>
+
+                <span class="c1"># set subtopic if possible.</span>
+                <span class="k">if</span> <span class="n">msg_topic</span><span class="p">[</span><span class="mi">0</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">o</span><span class="p">[</span><span class="s1">&#39;topicPrefix&#39;</span><span class="p">])]</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">o</span><span class="p">[</span><span class="s1">&#39;topicPrefix&#39;</span><span class="p">]:</span>
+                    <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;subtopic&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">msg_topic</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">o</span><span class="p">[</span><span class="s1">&#39;topicPrefix&#39;</span><span class="p">]):]</span>
+                <span class="k">else</span><span class="p">:</span>
+                    <span class="n">topicOverride</span><span class="o">=</span><span class="kc">True</span>
+
+            <span class="k">if</span> <span class="n">topicOverride</span><span class="p">:</span>
+                <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;topic&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">topic</span>
+                <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;_deleteOnPost&#39;</span><span class="p">]</span> <span class="o">|=</span> <span class="nb">set</span><span class="p">(</span> <span class="p">[</span><span class="s1">&#39;topic&#39;</span><span class="p">]</span> <span class="p">)</span>
+
             <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;ack_id&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">raw_msg</span><span class="o">.</span><span class="n">delivery_info</span><span class="p">[</span><span class="s1">&#39;delivery_tag&#39;</span><span class="p">]</span>
             <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;local_offset&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
             <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;_deleteOnPost&#39;</span><span class="p">]</span> <span class="o">|=</span> <span class="nb">set</span><span class="p">(</span> <span class="p">[</span><span class="s1">&#39;ack_id&#39;</span><span class="p">,</span> <span class="s1">&#39;exchange&#39;</span><span class="p">,</span> <span class="s1">&#39;local_offset&#39;</span><span class="p">,</span> <span class="s1">&#39;subtopic&#39;</span><span class="p">])</span>

_sources/Reference/sr3_options.7.rst.txt

@@ -1826,6 +1826,15 @@ When set in a posting component, it has the effect of eliding the *atime* and *m
 headers from the messages.
 
 
+topicCopy (default: off)
+------------------------
+
+Setting *topicCopy* to true tells sarracenia pass topics through unaltered.
+Sarracenia has a convention for how topics for products should be organized. There is
+a topicPrefix, followed by subtopics derived from the *relPath* field of the message.
+Some networks may choose to use different topic conventions, external to sarracenia.
+
+
 timeout <interval> (default: 0)
 -------------------------------
 

_sources/fr/Reference/sr3_options.7.rst.txt

@@ -1840,6 +1840,14 @@ rajouté au subtopic pour former une hiérarchie complète de thèmes (topics).
 Cette option s’applique aux liaisons d’abonnement.
 Indique la version des messages d'annonce reçus dans les subtopics. (V03 fait référence à `<sr3_post.7.html>`_)
 
+topicCopy (défaut: False)
+-------------------------
+
+Définir *topicCopy* à *true* indique à sarracenia de transmettre les *topic* des messages sans modification.
+Sarracenia a une convention sur la manière dont les *topic* des produits sont organisés. Il y a
+un *topicPrefix*, suivi de *subtopic* (sous-thèmes) dérivés du champ *relPath* du message.
+Certains réseaux peuvent choisir d'utiliser des conventions thématiques différentes, externes à la sarracenia.
+
 users <flag> (défaut: false)
 ----------------------------
 

fr/CommentFaire/source.html

@@ -144,7 +144,7 @@ <h3>Enregistrement de révision<a class="headerlink" href="#enregistrement-de-re
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 <p>Une pompe de données Sarracenia est un serveur Web (ou sftp) avec des notifications pour que les

fr/CommentFaire/subscriber.html

@@ -133,7 +133,7 @@ <h3>Enregistrement de révision<a class="headerlink" href="#enregistrement-de-re
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 </section>

fr/Contribution/Développement.html

@@ -142,7 +142,7 @@ <h1>Guide du développeur MetPX-Sarracenia<a class="headerlink" href="#guide-du-
 <dd class="field-odd"><p>UNKNOWN</p>
 </dd>
 <dt class="field-even">date<span class="colon">:</span></dt>
-<dd class="field-even"><p>Apr 25, 2024</p>
+<dd class="field-even"><p>Apr 26, 2024</p>
 </dd>
 </dl>
 <section id="outillage">