From 166e2cfc2dfbcc698bb1d98943b66f128779c83a Mon Sep 17 00:00:00 2001
From: Rudi Grinberg <rudi.grinberg@sourcefabric.org>
Date: Tue, 17 Jul 2012 11:20:58 -0400
Subject: [PATCH] cc-4105: Tweaked php method to have more consistent return
 values

---
 .../application/controllers/ApiController.php | 29 ++++++++++++++-----
 python_apps/pypo/recorder.py                  |  2 +-
 2 files changed, 22 insertions(+), 9 deletions(-)

diff --git a/airtime_mvc/application/controllers/ApiController.php b/airtime_mvc/application/controllers/ApiController.php
index 00ee79cdc..0689b5158 100644
--- a/airtime_mvc/application/controllers/ApiController.php
+++ b/airtime_mvc/application/controllers/ApiController.php
@@ -443,8 +443,17 @@ class ApiController extends Zend_Controller_Action
         $this->view->watched_dirs = $watchedDirsPath;
     }
 
-    public function dispatchMetaDataAction($md, $mode) 
+    public function dispatchMetaDataAction($md, $mode, $dryrun=false) 
     { 
+        // Replace this compound result in a hash with proper error handling later on
+        $return_hash = array();
+        if ( $dry_run ) { // for debugging we return garbage not to screw around with the db
+            return array(
+                'md' => $md,
+                'mode' => $mode,
+                'fileid' => 123456
+            );
+        }
         Application_Model_Preference::SetImportTimestamp();
         if ($mode == "create") {
             $filepath = $md['MDATA_KEY_FILEPATH'];
@@ -456,8 +465,8 @@ class ApiController extends Zend_Controller_Action
                 // path already exist
                 if ($file->getFileExistsFlag()) {
                     // file marked as exists
-                    # TODO : jsonify all the error messages mang
-                    return "File already exists in Airtime.";
+                    $return_hash['error'] =  "File already exists in Airtime.";
+                    return $return_hash;
                 } else {
                     // file marked as not exists
                     $file->setFileExistsFlag(true);
@@ -471,7 +480,8 @@ class ApiController extends Zend_Controller_Action
 
             //File is not in database anymore.
             if (is_null($file)) {
-                return "File does not exist in Airtime.";
+                $return_hash['error'] = "File does not exist in Airtime.";
+                return $return_hash;
             }
             //Updating a metadata change.
             else {
@@ -497,7 +507,8 @@ class ApiController extends Zend_Controller_Action
             $file = Application_Model_StoredFile::RecallByFilepath($filepath);
 
             if (is_null($file)) {
-                return "File doesn't exist in Airtime.";
+                $return_hash['error'] =  "File doesn't exist in Airtime.";
+                return $return_hash;
             }
             else {
                 $file->deleteByMediaMonitor();
@@ -511,9 +522,11 @@ class ApiController extends Zend_Controller_Action
             foreach($files as $file){
                 $file->deleteByMediaMonitor();
             }
-            return;
+            $return_hash['success'] = 1;
+            return $return_hash;
         }
-        return $file->getId();
+        $return_hash['fileid'] = $file->getId();
+        return $return_hash;
     } 
 
     public function reloadMetadataGroupAction()
@@ -530,7 +543,7 @@ class ApiController extends Zend_Controller_Action
             unset( $info_json['mode'] );
             // TODO : uncomment the following line to actually do something
             $response = $this->dispatchMetaDataAction($info_json, $info_json['mode']);
-            array_push($responses, $this->dispatchMetaDataAction($info_json, $info_json['mode']));
+            array_push($responses, $response);
             // Like wise, remove the following line when done
             // On recorded show requests we do some extra work here. Not sure what it actually is and it
             // was usually called from the python api
diff --git a/python_apps/pypo/recorder.py b/python_apps/pypo/recorder.py
index f63f47a5e..e0c8bee0c 100644
--- a/python_apps/pypo/recorder.py
+++ b/python_apps/pypo/recorder.py
@@ -42,7 +42,7 @@ def getDateTimeObj(time):
     # - perhaps validate the input before doing dangerous casts?
     # - rename this function to follow the standard convention
     # - rename time to something else so that the module name does not get
-    # shadowed
+    #   shadowed
     # - add docstring to document all behaviour of this function
     timeinfo = time.split(" ")
     date = [ int(x) for x in timeinfo[0].split("-") ]