--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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" xml:lang="en" lang="en">
+<head>
+ <title>Class: MCollective::RPC::Helpers</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">MCollective::RPC::Helpers</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../../files/lib/mcollective/rpc/helpers_rb.html">
+ lib/mcollective/rpc/helpers.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ Object
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Various utilities for the <a href="../RPC.html">RPC</a> system
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000050">add_simplerpc_options</a>
+ <a href="#M000045">extract_hosts_from_array</a>
+ <a href="#M000044">extract_hosts_from_json</a>
+ <a href="#M000049">old_rpcresults</a>
+ <a href="#M000046">rpcresults</a>
+ <a href="#M000048">text_for_flattened_result</a>
+ <a href="#M000047">text_for_result</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000050" class="method-detail">
+ <a name="M000050"></a>
+
+ <div class="method-heading">
+ <a href="#M000050" class="method-signature">
+ <span class="method-name">add_simplerpc_options</span><span class="method-args">(parser, options)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Add SimpleRPC common options
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000050-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 254</span>
+254: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">add_simplerpc_options</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
+255: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">""</span>
+256: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">"RPC Options"</span>
+257:
+258: <span class="ruby-comment cmt"># add SimpleRPC specific options to all clients that use our library</span>
+259: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--np'</span>, <span class="ruby-value str">'--no-progress'</span>, <span class="ruby-value str">'Do not show the progress bar'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+260: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:progress_bar</span>] = <span class="ruby-keyword kw">false</span>
+261: <span class="ruby-keyword kw">end</span>
+262:
+263: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--one'</span>, <span class="ruby-value str">'-1'</span>, <span class="ruby-value str">'Send request to only one discovered nodes'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+264: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:mcollective_limit_targets</span>] = <span class="ruby-value">1</span>
+265: <span class="ruby-keyword kw">end</span>
+266:
+267: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--batch SIZE'</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-value str">'Do requests in batches'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+268: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:batch_size</span>] = <span class="ruby-identifier">v</span>
+269: <span class="ruby-keyword kw">end</span>
+270:
+271: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--batch-sleep SECONDS'</span>, <span class="ruby-constant">Float</span>, <span class="ruby-value str">'Sleep time between batches'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+272: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:batch_sleep_time</span>] = <span class="ruby-identifier">v</span>
+273: <span class="ruby-keyword kw">end</span>
+274:
+275: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--limit-seed NUMBER'</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-value str">'Seed value for deterministic random batching'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+276: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:limit_seed</span>] = <span class="ruby-identifier">v</span>
+277: <span class="ruby-keyword kw">end</span>
+278:
+279: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--limit-nodes COUNT'</span>, <span class="ruby-value str">'--ln'</span>, <span class="ruby-value str">'--limit'</span>, <span class="ruby-value str">'Send request to only a subset of nodes, can be a percentage'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+280: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Invalid limit specified: #{v} valid limits are /^\d+%*$/"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\d+%*$/</span>
+281:
+282: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\d+$/</span>
+283: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:mcollective_limit_targets</span>] = <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_i</span>
+284: <span class="ruby-keyword kw">else</span>
+285: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:mcollective_limit_targets</span>] = <span class="ruby-identifier">v</span>
+286: <span class="ruby-keyword kw">end</span>
+287: <span class="ruby-keyword kw">end</span>
+288:
+289: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--json'</span>, <span class="ruby-value str">'-j'</span>, <span class="ruby-value str">'Produce JSON output'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+290: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:progress_bar</span>] = <span class="ruby-keyword kw">false</span>
+291: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:output_format</span>] = <span class="ruby-identifier">:json</span>
+292: <span class="ruby-keyword kw">end</span>
+293:
+294: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--display MODE'</span>, <span class="ruby-value str">'Influence how results are displayed. One of ok, all or failed'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+295: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"all"</span>
+296: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:force_display_mode</span>] = <span class="ruby-identifier">:always</span>
+297: <span class="ruby-keyword kw">else</span>
+298: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:force_display_mode</span>] = <span class="ruby-identifier">v</span>.<span class="ruby-identifier">intern</span>
+299: <span class="ruby-keyword kw">end</span>
+300:
+301: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"--display has to be one of 'ok', 'all' or 'failed'"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:ok</span>, <span class="ruby-identifier">:failed</span>, <span class="ruby-identifier">:always</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:force_display_mode</span>])
+302: <span class="ruby-keyword kw">end</span>
+303: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000045" class="method-detail">
+ <a name="M000045"></a>
+
+ <div class="method-heading">
+ <a href="#M000045" class="method-signature">
+ <span class="method-name">extract_hosts_from_array</span><span class="method-args">(hosts)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Given an array of something, make sure each is a string chomp off any new
+lines and return just the array of hosts
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000045-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 29</span>
+29: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">extract_hosts_from_array</span>(<span class="ruby-identifier">hosts</span>)
+30: [<span class="ruby-identifier">hosts</span>].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">host</span><span class="ruby-operator">|</span>
+31: <span class="ruby-identifier">raise</span> <span class="ruby-node">"#{host} should be a string"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">host</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+32: <span class="ruby-identifier">host</span>.<span class="ruby-identifier">chomp</span>
+33: <span class="ruby-keyword kw">end</span>
+34: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000044" class="method-detail">
+ <a name="M000044"></a>
+
+ <div class="method-heading">
+ <a href="#M000044" class="method-signature">
+ <span class="method-name">extract_hosts_from_json</span><span class="method-args">(json)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Parse JSON output as produced by printrpc and extract the
+"sender" of each rpc response
+</p>
+<p>
+The simplist valid JSON based data would be:
+</p>
+<p>
+[
+</p>
+<pre>
+ {"sender" => "example.com"},
+ {"sender" => "another.com"}
+</pre>
+<p>
+]
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000044-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 14</span>
+14: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">extract_hosts_from_json</span>(<span class="ruby-identifier">json</span>)
+15: <span class="ruby-identifier">hosts</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">json</span>)
+16:
+17: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"JSON hosts list is not an array"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">hosts</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
+18:
+19: <span class="ruby-identifier">hosts</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">host</span><span class="ruby-operator">|</span>
+20: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"JSON host list is not an array of Hashes"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">host</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+21: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"JSON host list does not have senders in it"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">host</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value str">"sender"</span>)
+22:
+23: <span class="ruby-identifier">host</span>[<span class="ruby-value str">"sender"</span>]
+24: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">uniq</span>
+25: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000049" class="method-detail">
+ <a name="M000049"></a>
+
+ <div class="method-heading">
+ <a href="#M000049" class="method-signature">
+ <span class="method-name">old_rpcresults</span><span class="method-args">(result, flags = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Backward compatible display block for results without a <a
+href="../DDL.html">DDL</a>
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000049-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 202</span>
+202: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">old_rpcresults</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
+203: <span class="ruby-identifier">result_text</span> = <span class="ruby-value str">""</span>
+204:
+205: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:flatten</span>]
+206: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span>
+207: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>] <span class="ruby-operator"><=</span> <span class="ruby-value">1</span>
+208: <span class="ruby-identifier">data</span> = <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:data</span>]
+209:
+210: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+211: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">pretty_inspect</span>
+212: <span class="ruby-keyword kw">else</span>
+213: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span>
+214: <span class="ruby-keyword kw">end</span>
+215: <span class="ruby-keyword kw">else</span>
+216: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">pretty_inspect</span>
+217: <span class="ruby-keyword kw">end</span>
+218: <span class="ruby-keyword kw">end</span>
+219:
+220: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">""</span>
+221: <span class="ruby-keyword kw">else</span>
+222: [<span class="ruby-identifier">result</span>].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span>
+223:
+224: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:verbose</span>]
+225: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"%-40s: %s\n"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">r</span>[<span class="ruby-identifier">:sender</span>], <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statusmsg</span>]]
+226:
+227: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>] <span class="ruby-operator"><=</span> <span class="ruby-value">1</span>
+228: <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:data</span>].<span class="ruby-identifier">pretty_inspect</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"\n"</span>).<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span> <span class="ruby-identifier">result_text</span> <span class="ruby-operator">+=</span> <span class="ruby-node">" #{m}"</span>}
+229: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n\n"</span>
+230: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>] <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
+231: <span class="ruby-comment cmt"># dont print anything, no useful data to display</span>
+232: <span class="ruby-comment cmt"># past what was already shown</span>
+233: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>] <span class="ruby-operator">==</span> <span class="ruby-value">3</span>
+234: <span class="ruby-comment cmt"># dont print anything, no useful data to display</span>
+235: <span class="ruby-comment cmt"># past what was already shown</span>
+236: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>] <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
+237: <span class="ruby-comment cmt"># dont print anything, no useful data to display</span>
+238: <span class="ruby-comment cmt"># past what was already shown</span>
+239: <span class="ruby-keyword kw">else</span>
+240: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" #{r[:statusmsg]}"</span>
+241: <span class="ruby-keyword kw">end</span>
+242: <span class="ruby-keyword kw">else</span>
+243: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>] <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+244: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"%-40s %s\n"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">r</span>[<span class="ruby-identifier">:sender</span>], <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statusmsg</span>])]
+245: <span class="ruby-keyword kw">end</span>
+246: <span class="ruby-keyword kw">end</span>
+247: <span class="ruby-keyword kw">end</span>
+248: <span class="ruby-keyword kw">end</span>
+249:
+250: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">""</span>
+251: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000046" class="method-detail">
+ <a name="M000046"></a>
+
+ <div class="method-heading">
+ <a href="#M000046" class="method-signature">
+ <span class="method-name">rpcresults</span><span class="method-args">(result, flags = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns a blob of text representing the results in a standard way
+</p>
+<p>
+It tries hard to do sane things so you often should not need to write your
+own display functions
+</p>
+<p>
+If the agent you are getting results for has a <a
+href="../DDL.html">DDL</a> it will use the hints in there to do the right
+thing specifically it will look at the values of display in the <a
+href="../DDL.html">DDL</a> to choose when to show results
+</p>
+<p>
+If you do not have a <a href="../DDL.html">DDL</a> you can pass these
+flags:
+</p>
+<pre>
+ printrpc exim.mailq, :flatten => true
+ printrpc exim.mailq, :verbose => true
+</pre>
+<p>
+If you‘ve asked it to flatten the result it will not print sender
+hostnames, it will just print the result as if it‘s one huge result,
+handy for things like showing a combined mailq.
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000046-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 54</span>
+ 54: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rpcresults</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
+ 55: <span class="ruby-identifier">flags</span> = {<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:flatten</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:console</span>, <span class="ruby-identifier">:force_display_mode</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">flags</span>)
+ 56:
+ 57: <span class="ruby-identifier">result_text</span> = <span class="ruby-value str">""</span>
+ 58: <span class="ruby-identifier">ddl</span> = <span class="ruby-keyword kw">nil</span>
+ 59:
+ 60: <span class="ruby-comment cmt"># if running in verbose mode, just use the old style print</span>
+ 61: <span class="ruby-comment cmt"># no need for all the DDL helpers obfuscating the result</span>
+ 62: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:format</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">:json</span>
+ 63: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">tty?</span>
+ 64: <span class="ruby-identifier">result_text</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">pretty_generate</span>(<span class="ruby-identifier">result</span>)
+ 65: <span class="ruby-keyword kw">else</span>
+ 66: <span class="ruby-identifier">result_text</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">to_json</span>
+ 67: <span class="ruby-keyword kw">end</span>
+ 68: <span class="ruby-keyword kw">else</span>
+ 69: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:verbose</span>]
+ 70: <span class="ruby-identifier">result_text</span> = <span class="ruby-identifier">old_rpcresults</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span>)
+ 71: <span class="ruby-keyword kw">else</span>
+ 72: [<span class="ruby-identifier">result</span>].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span>
+ 73: <span class="ruby-keyword kw">begin</span>
+ 74: <span class="ruby-identifier">ddl</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">r</span>.<span class="ruby-identifier">agent</span>).<span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">r</span>.<span class="ruby-identifier">action</span>.<span class="ruby-identifier">to_s</span>)
+ 75:
+ 76: <span class="ruby-identifier">sender</span> = <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:sender</span>]
+ 77: <span class="ruby-identifier">status</span> = <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statuscode</span>]
+ 78: <span class="ruby-identifier">message</span> = <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:statusmsg</span>]
+ 79: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">r</span>[<span class="ruby-identifier">:data</span>]
+ 80:
+ 81: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:force_display_mode</span>]
+ 82: <span class="ruby-identifier">display</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:force_display_mode</span>]
+ 83: <span class="ruby-keyword kw">else</span>
+ 84: <span class="ruby-identifier">display</span> = <span class="ruby-identifier">ddl</span>[<span class="ruby-identifier">:display</span>]
+ 85: <span class="ruby-keyword kw">end</span>
+ 86:
+ 87: <span class="ruby-comment cmt"># appand the results only according to what the DDL says</span>
+ 88: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">display</span>
+ 89: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:ok</span>
+ 90: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+ 91: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">text_for_result</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">result</span>, <span class="ruby-identifier">ddl</span>)
+ 92: <span class="ruby-keyword kw">end</span>
+ 93:
+ 94: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:failed</span>
+ 95: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
+ 96: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">text_for_result</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">result</span>, <span class="ruby-identifier">ddl</span>)
+ 97: <span class="ruby-keyword kw">end</span>
+ 98:
+ 99: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:always</span>
+100: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">text_for_result</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">result</span>, <span class="ruby-identifier">ddl</span>)
+101:
+102: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:flatten</span>
+103: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">text_for_flattened_result</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">result</span>)
+104:
+105: <span class="ruby-keyword kw">end</span>
+106: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+107: <span class="ruby-comment cmt"># no DDL so just do the old style print unchanged for</span>
+108: <span class="ruby-comment cmt"># backward compat</span>
+109: <span class="ruby-identifier">result_text</span> = <span class="ruby-identifier">old_rpcresults</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span>)
+110: <span class="ruby-keyword kw">end</span>
+111: <span class="ruby-keyword kw">end</span>
+112: <span class="ruby-keyword kw">end</span>
+113: <span class="ruby-keyword kw">end</span>
+114:
+115: <span class="ruby-identifier">result_text</span>
+116: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000048" class="method-detail">
+ <a name="M000048"></a>
+
+ <div class="method-heading">
+ <a href="#M000048" class="method-signature">
+ <span class="method-name">text_for_flattened_result</span><span class="method-args">(status, result)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns text representing a flattened result of only good data
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000048-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 189</span>
+189: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">text_for_flattened_result</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">result</span>)
+190: <span class="ruby-identifier">result_text</span> = <span class="ruby-value str">""</span>
+191:
+192: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator"><=</span> <span class="ruby-value">1</span>
+193: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+194: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">pretty_inspect</span>
+195: <span class="ruby-keyword kw">else</span>
+196: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>
+197: <span class="ruby-keyword kw">end</span>
+198: <span class="ruby-keyword kw">end</span>
+199: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000047" class="method-detail">
+ <a name="M000047"></a>
+
+ <div class="method-heading">
+ <a href="#M000047" class="method-signature">
+ <span class="method-name">text_for_result</span><span class="method-args">(sender, status, msg, result, ddl)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Return text representing a result
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000047-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 119</span>
+119: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">text_for_result</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">result</span>, <span class="ruby-identifier">ddl</span>)
+120: <span class="ruby-identifier">statusses</span> = [<span class="ruby-value str">""</span>,
+121: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-value str">"Request Aborted"</span>),
+122: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:yellow</span>, <span class="ruby-value str">"Unknown Action"</span>),
+123: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:yellow</span>, <span class="ruby-value str">"Missing Request Data"</span>),
+124: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:yellow</span>, <span class="ruby-value str">"Invalid Request Data"</span>),
+125: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-value str">"Unknown Request Status"</span>)]
+126:
+127: <span class="ruby-identifier">result_text</span> = <span class="ruby-value str">"%-40s %s\n"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">statusses</span>[<span class="ruby-identifier">status</span>]]
+128: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" %s\n"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:yellow</span>, <span class="ruby-identifier">msg</span>)] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">msg</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"OK"</span>
+129:
+130: <span class="ruby-comment cmt"># only print good data, ignore data that results from failure</span>
+131: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+132: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+133: <span class="ruby-comment cmt"># figure out the lengths of the display as strings, we'll use</span>
+134: <span class="ruby-comment cmt"># it later to correctly justify the output</span>
+135: <span class="ruby-identifier">lengths</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
+136: <span class="ruby-keyword kw">begin</span>
+137: <span class="ruby-identifier">ddl</span>[<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">k</span>][<span class="ruby-identifier">:display_as</span>].<span class="ruby-identifier">size</span>
+138: <span class="ruby-keyword kw">rescue</span>
+139: <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span>
+140: <span class="ruby-keyword kw">end</span>
+141: <span class="ruby-keyword kw">end</span>
+142:
+143: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">sort_by</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span>}.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
+144: <span class="ruby-comment cmt"># get all the output fields nicely lined up with a</span>
+145: <span class="ruby-comment cmt"># 3 space front padding</span>
+146: <span class="ruby-keyword kw">begin</span>
+147: <span class="ruby-identifier">display_as</span> = <span class="ruby-identifier">ddl</span>[<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">k</span>][<span class="ruby-identifier">:display_as</span>]
+148: <span class="ruby-keyword kw">rescue</span>
+149: <span class="ruby-identifier">display_as</span> = <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>
+150: <span class="ruby-keyword kw">end</span>
+151:
+152: <span class="ruby-identifier">display_length</span> = <span class="ruby-identifier">display_as</span>.<span class="ruby-identifier">size</span>
+153: <span class="ruby-identifier">padding</span> = <span class="ruby-identifier">lengths</span>.<span class="ruby-identifier">max</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">display_length</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>
+154: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" "</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">padding</span>
+155:
+156: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{display_as}:"</span>
+157:
+158: <span class="ruby-keyword kw">if</span> [<span class="ruby-constant">String</span>, <span class="ruby-constant">Numeric</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">result</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">class</span>)
+159: <span class="ruby-identifier">lines</span> = <span class="ruby-identifier">result</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"\n"</span>)
+160:
+161: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">lines</span>.<span class="ruby-identifier">empty?</span>
+162: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n"</span>
+163: <span class="ruby-keyword kw">else</span>
+164: <span class="ruby-identifier">lines</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+165: <span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">padtxt</span> = <span class="ruby-value str">" "</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">padtxt</span> = <span class="ruby-value str">" "</span> <span class="ruby-operator">*</span> (<span class="ruby-identifier">padding</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">display_length</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>)
+166:
+167: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{padtxt}#{line}\n"</span>
+168: <span class="ruby-keyword kw">end</span>
+169: <span class="ruby-keyword kw">end</span>
+170: <span class="ruby-keyword kw">else</span>
+171: <span class="ruby-identifier">padding</span> = <span class="ruby-value str">" "</span> <span class="ruby-operator">*</span> (<span class="ruby-identifier">lengths</span>.<span class="ruby-identifier">max</span> <span class="ruby-operator">+</span> <span class="ruby-value">5</span>)
+172: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">pretty_inspect</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"\n"</span>).<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">padding</span>) <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n"</span>
+173: <span class="ruby-keyword kw">end</span>
+174: <span class="ruby-keyword kw">end</span>
+175: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
+176: <span class="ruby-comment cmt"># for status 1 we dont want to show half baked</span>
+177: <span class="ruby-comment cmt"># data by default since the DDL will supply all the defaults</span>
+178: <span class="ruby-comment cmt"># it just doesnt look right</span>
+179: <span class="ruby-keyword kw">else</span>
+180: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n\t"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">pretty_inspect</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"\n"</span>).<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t"</span>)
+181: <span class="ruby-keyword kw">end</span>
+182: <span class="ruby-keyword kw">end</span>
+183:
+184: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n"</span>
+185: <span class="ruby-identifier">result_text</span>
+186: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file