From 22eec837528605073b7d5209e8d3ccbbf88726cc Mon Sep 17 00:00:00 2001
From: lissav <lissav@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Tue, 30 Oct 2012 19:21:28 +0000
Subject: [PATCH] This adds an interface to runxcmd to return the response
 structure, still needs test though

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@14166 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 perl-xCAT/xCAT/Utils.pm | 48 ++++++++++++++++++++++++++++++++---------
 1 file changed, 38 insertions(+), 10 deletions(-)

diff --git a/perl-xCAT/xCAT/Utils.pm b/perl-xCAT/xCAT/Utils.pm
index 4bc678c9c..ba52e46e2 100644
--- a/perl-xCAT/xCAT/Utils.pm
+++ b/perl-xCAT/xCAT/Utils.pm
@@ -1072,6 +1072,7 @@ sub runcmd
 
 	   reference to output
 
+
    Returns:
 	   see below
    Globals:
@@ -1091,12 +1092,19 @@ sub runcmd
              number > 0:    Display error msg and exit with the given code
 
    Example:
+      return output as reference to an array
 		my $outref = xCAT::Utils->runxcmd($cmd,$sub_req, -2, 1);
+      
+      return response structure from plugin 
+		my $outref = xCAT::Utils->runxcmd($cmd,$sub_req, -2, 2);
 
    Comments:
-		   If refoutput is true, then the output will be returned as a
+		   If refoutput is 1, then the output will be returned as a
 		   reference to an array for efficiency.
 
+		   If refoutput is 2, then the response structure will be returned  
+         as output.  runxcmd will not parse the request structure.
+
 		   Do not use the scalar string input for xdsh unless you are running
 		   a simple single-word command.  When building your request hash,
 		   the entire command string xdsh runs needs to be a single entry
@@ -1169,9 +1177,20 @@ sub runxcmd
         }
         push(@{$req->{arg}}, @cmdargs);
     }
-    $subreq->($req, \&runxcmd_output);
+    # call the plugin
+    if (defined ($refoutput)) {
+      if ($refoutput != 2)  {
+        $subreq->($req, \&runxcmd_output);
+      } else {  # do not parse return from plugin
+         $subreq->($req, \&runxcmd_output2); 
+      }
+    } else { 
+        $subreq->($req, \&runxcmd_output);
+    }
+   
     $::CALLBACK = $save_CALLBACK;    # in case the subreq call changed it
     my $outref = $::xcmd_outref;
+    
     if ($::RUNCMD_RC)
     {
         my $displayerror = 1;
@@ -1216,17 +1235,23 @@ sub runxcmd
             $xCAT::Utils::errno = 29;
         }
     }
-    if ($refoutput)
+    if ((defined($refoutput)) && ($refoutput == 1))
+        # output is reference to array
     {
         chomp(@$outref);
         return $outref;
     }
-    elsif (wantarray)
+    elsif ((defined($refoutput)) && ($refoutput == 2))
+       # output is structure returned from plugin
+    {
+        return $outref;
+    }
+    elsif (wantarray)   # array
     {
         chomp(@$outref);
         return @$outref;
     }
-    else
+    else   # string
     {
         my $line = join('', @$outref);
         chomp $line;
@@ -1300,13 +1325,16 @@ sub runxcmd_output
         }
     }
 
-    #  		my $i=0;
-    #	    foreach my $line ($resp->{info}->[$i]) {
-    #	      push (@dshresult, $line);
-    #	      $i++;
-    #	    }
     return 0;
 }
+# runxcmd_output2 -- Internal subroutine for runxcmd to capture the output
+#	from the xCAT daemon subrequest call. Returns output unparsed.
+sub runxcmd_output2
+{
+    my $resp = shift;
+    $::xcmd_outref = $resp;
+    return 0 ;
+}
 
 #--------------------------------------------------------------------------------