fixes, format option for gsxcl

2 files changed, 107 insertions, 24 deletions

diff --git a/gsxcl b/gsxcl
index 7c09ecb..2db4d71 100755
--- a/gsxcl
+++ b/gsxcl
@@ -6,9 +6,15 @@
  * A test package and command line client to the GSX library
  * @package gsxlib
  * @author Filipp Lepalaan <filipp@mcare.fi>
+ * @license
+ * This program is free software. It comes without any warranty, to
+ * the extent permitted by applicable law. You can redistribute it
+ * and/or modify it under the terms of the Do What The Fuck You Want
+ * To Public License, Version 2, as published by Sam Hocevar. See
+ * http://sam.zoy.org/wtfpl/COPYING for more details.
  */
 
-if (FALSE) {
+if (TRUE) {
   error_reporting(E_ALL|E_STRICT);
 }
 
@@ -20,7 +26,7 @@ require 'gsxlib.php';
 if (count($argv) < 6) {
   echo <<<EOT
 
-usage: gsxcl -s sold-to -u username -p password [-r region] [-e environment] [-m warranty|parts] [-q query]
+usage: gsxcl -s sold-to -u username -p password [-r region] [-e environment] [-f format] [-m warranty|parts] [-q query]
   -s  sold-to     your GSX Sold-To account
   -u  username    the Apple ID with GSX WS API access
   -p  password    the password for the Apple ID
@@ -28,6 +34,7 @@ usage: gsxcl -s sold-to -u username -p password [-r region] [-e environment] [-m
                   "apac" (Asia-Pacific) or "la" (Latin America). Defaults to "emea".
   -e  environment the GSX environment. Either empty (production), "it" or "ut"
                   Defaults to production
+  -f  format      the output format. Either print_r (default), json, xml or csv
   -m  mode        what to search for. Currently one of: {$modes_str}. Defaults to "warranty"
   -q  query       a query string (serial number, order confirmation, repair number, EEE code, etc
                   Defaults to this machine's serial number
@@ -36,14 +43,19 @@ EOT;
   exit();
 }
 
-$opts = getopt('s:u:p:i::r:e:m:q:');
-$region = ($opts['r']) ? $opts['r'] : 'emea';
-$environment = ($opts['e']) ? $opts['e'] : null;
+$opts = getopt('s:u:p:i::r:e:m:q:f:');
+
+$region = (isset($opts['r'])) ? $opts['r'] : 'emea';
+$mode = (isset($opts['m'])) ? $opts['m'] : 'warranty';
+$format = (isset($opts['f'])) ? $opts['f'] : 'print_r';
+$environment = (isset($opts['e'])) ? $opts['e'] : null;
 
 $gsx = new GsxLib($opts['s'], $opts['u'], $opts['p'], $environment, $region);
 
-if (empty($opts['q'])) {
-  $opts['q'] = `/usr/sbin/system_profiler SPHardwareDataType | awk '/Serial Number/ {print $4}'`;
+if (!isset($opts['q'])) {
+  $query = `/usr/sbin/system_profiler SPHardwareDataType | awk '/Serial Number/ {print $4}'`;
+} else {
+  $query = $opts['q'];
 }
 
 if (isset($opts['i']))
@@ -61,37 +73,95 @@ if (isset($opts['i']))
   }
 }
 
-switch ($opts['m'])
+switch ($mode)
 {
   case 'warranty':
-    print_r($gsx->warrantyStatus($opts['q']));
+    $result = $gsx->warrantyStatus($query);
     break;
   case 'parts':
-    print_r($gsx->partsLookup($opts['q']));
+    $result = $gsx->partsLookup($query);
     break;
   case 'pending':
-    print_r($gsx->partsPendingReturn($opts['q']));
+    $result = $gsx->partsPendingReturn($query);
     break;
   case 'repair':
-    print_r($gsx->repairDetails($opts['q']));
+    $result = $gsx->repairDetails($query);
     break;
   case 'lookup':
-    print_r($gsx->repairLookup($opts['q']));
+    $result = $gsx->repairLookup($query);
     break;
   case 'status':
-    print_r($gsx->repairStatus($opts['q']));
+    $result = $gsx->repairStatus($query);
     break;
   case 'comptia':
-    print_r($gsx->compTiaCodes());
+    $result = $gsx->compTiaCodes();
     break;
   case 'label':
-    list($order, $part) = explode(':', $opts['q']);
+    list($order, $part) = explode(':', $query);
     $result = $gsx->returnLabel($order, $part);
     $name = $result->returnLabelFileName;
     echo $result->returnLabelFileData;
     break;
+}
+
+switch ($format)
+{
+  case 'json':
+    echo json_encode($result);
+    break;
+  case 'xml':
+    $xml = simplexml_load_string('<?xml version="1.0" encoding="utf-8"?><gsxResult />');
+    foreach ($result as $k => $v)
+    {
+      $key = (is_numeric($k)) ? 'item' : $k;
+      $value = (is_object($v)) ? null : $v;
+      $item = $xml->addChild($key, $value);
+      if (is_object($v)) {
+        foreach ($v as $vk => $vv) {
+          $item->addChild($vk, $vv);
+        }
+      }
+    }
+    echo $xml->asXML();
+    break;
+  case 'csv':
+    $i = 0;
+    $fo = fopen('php://stdout', 'w');
+    
+    foreach ($result as $k => $v)
+    {
+      if (is_object($v))
+      {
+        $keys = array();
+        $vals = array();
+        foreach ($v as $vk => $vv) 
+        {
+          if ($i == 0) {
+            $keys[] = $vk;
+          }
+          $vals[] = $vv;
+        }
+        // treat field names of first item as header row
+        if ($i == 0) {
+          fputcsv($fo, $keys);
+        }
+        fputcsv($fo, $vals);
+      } else {
+        $keys[] = $k;
+        $vals[] = $v;
+      }
+      $i++;
+    }
+    
+    if (count($result) === 1) {
+      fputcsv($fo, $keys);
+      fputcsv($fo, $vals);
+    }
+    
+    fclose($fo);
+    break;
   default:
-    print_r($gsx->warrantyStatus($opts['q']));
+    print_r($result);
     break;
 }
 
diff --git a/gsxlib.php b/gsxlib.php
index 3cc2702..d27ee7b 100644
--- a/gsxlib.php
+++ b/gsxlib.php
@@ -4,7 +4,6 @@
  * @package gsxlib
  * @author Filipp Lepalaan <filipp@mcare.fi>
  * http://gsxwsut.apple.com/apidocs/html/WSReference.html?user=asp
- * http://gsxwsut.apple.com/apidocs/html/WSArtifacts.html?user=asp
  * @license
  * This program is free software. It comes without any warranty, to
  * the extent permitted by applicable law. You can redistribute it
@@ -226,6 +225,11 @@ class GsxLib
   
   }
   
+  /**
+   * Get PDF label for part return
+   * @param string $returnOrder order number
+   * @param string $partNumber code of part being returned
+   */
   public function returnLabel($returnOrder, $partNumber)
   {
     if (!self::looksLike($returnOrder, 'returnOrder')) {
@@ -274,17 +278,19 @@ class GsxLib
   {
     $serialNumber = trim($serialNumber);
     // SNs should never start with an S, but they're often coded into barcodes
+    // and since an "old- ormat" SN + S would still qualify as a "new format" SN,
+    // we strip it here
     $serialNumber = ltrim($serialNumber, 'sS');
     
     if (!self::looksLike($serialNumber, 'serialNumber')) {
       exit('Invalid serial number: ' . $serialNumber);
     }
     
-    $a = array('WarrantyStatus' => array(
+    $req = array('WarrantyStatus' => array(
       'unitDetail'  => array('serialNumber' => $serialNumber)
     ));
     
-    return $this->request($a)->warrantyDetailInfo;
+    return $this->request($req)->warrantyDetailInfo;
   
   }
   
@@ -299,10 +305,16 @@ class GsxLib
     return $this->session_id;
   }
   
+  /**
+   * Do the actual SOAP request
+   */
   private function request($req)
   {
-    $result = false;
+    $result = FALSE;
+    
+    // split the request name and data
     list($r, $p) = each($req);
+    // add session info
     $p['userSession'] = array('userSessionId' => $this->session_id);
     $request = array($r.'Request' => $p);
     
@@ -312,6 +324,7 @@ class GsxLib
       return $result->$resp;
     }
     catch (SoapFault $e) {
+      print($this->client->__getLastRequest());
       trigger_error($e->getMessage());
     }
     
@@ -322,9 +335,9 @@ class GsxLib
   /**
    * Try to "categorise" a string
    * About identifying serial numbers - before 2010, Apple had a logical
-   *  serial number format, with structure, that you could id quite reliably.
-   *  unfortunately, it's no longer the case
-   * @param string $string
+   * serial number format, with structure, that you could id quite reliably.
+   * unfortunately, it's no longer the case
+   * @param string $string string to check
    */
   static function looksLike($string, $what = null)
   {