BUG: Refs #212. Better default configuration of batchmake.

When using the Config controller through the midas application, batchmake
now provides default paths and creates those directories for the config
variables it needs.  These dirs get created under the midas tmp dir.

Furthermore, the ajax call to test the config that the user has entered
has been moved to the more standard ajax libary methods, and an
ApiComponent has been created to provide web-api calls.

Author: Michael Grauer

modules/batchmake/controllers/ConfigController.php

@@ -50,13 +50,13 @@ protected function archiveOldModuleLocal()
       }
     }
 
-    
-    
+
+
   /**
    * will create default paths in the midas temp directory
    * for any properties not already set, except for the
    * condor bin dir; imposing a firmer hand on the user
-   * @param type $currentConfig 
+   * @param type $currentConfig
    */
   protected function createDefaultConfig($currentConfig)
     {
@@ -72,7 +72,7 @@ protected function createDefaultConfig($currentConfig)
       if((!isset($configProp) || !isset($configDir) || $configDir == "") && array_key_exists($configProp, $defaultConfigDirs))
         {
         $configDir = $defaultConfigDirs[$configProp];
-        $returnedConfig[$configProp] = $configDir;  
+        $returnedConfig[$configProp] = $configDir;
         // also create this directory to be sure it exists
         if(!KWUtils::mkDir($configDir))
           {
@@ -84,12 +84,12 @@ protected function createDefaultConfig($currentConfig)
         $returnedConfig[$configProp] = $configDir;
         }
       }
-    return $returnedConfig;    
+    return $returnedConfig;
     }
-    
-    
-    
-    
+
+
+
+
 
   /**
    * @method indexAction(), will test the configuration that the user has set
@@ -98,15 +98,14 @@ protected function createDefaultConfig($currentConfig)
   public function indexAction()
     {
     // get all the properties, not just the batchmake config
-    $fullConfig = $this->ModuleComponent->KWBatchmake->loadConfigProperties(null,false);
+    $fullConfig = $this->ModuleComponent->KWBatchmake->loadConfigProperties(null, false);
     // now get just the batchmake ones
     $batchmakeConfig = $this->ModuleComponent->KWBatchmake->filterBatchmakeConfigProperties($fullConfig);
-      
-//    $applicationConfig = $this->ModuleComponent->KWBatchmake->loadConfigProperties();
+    // create these properties as default dir locations in tmp
     $batchmakeConfig = $this->createDefaultConfig($batchmakeConfig);
     $configPropertiesRequirements = $this->ModuleComponent->KWBatchmake->getConfigPropertiesRequirements();
 
-    
+
 
     if($this->_request->isPost())
       {
@@ -116,65 +115,32 @@ public function indexAction()
 
       if(isset($submitConfig))
         {
+        // user wants to save config
         $this->archiveOldModuleLocal();
         // save only those properties we are interested for local configuration
         foreach($configPropertiesRequirements as $configProperty => $configPropertyRequirement)
           {
           $fullConfig[MIDAS_BATCHMAKE_GLOBAL_CONFIG_NAME][$this->moduleName.'.'.$configProperty] = $this->_getParam($configProperty);
           }
         $this->Component->Utility->createInitFile(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG, $fullConfig);
-//        $newsaver = array();
-//        foreach($configPropertiesRequirements as $configProperty => $configPropertyRequirement)
-//          {
-//          $newsaver[MIDAS_BATCHMAKE_GLOBAL_CONFIG_NAME][$this->moduleName.'.'.$configProperty] = $this->_getParam($configProperty);
-//          }
-//        $this->Component->Utility->createInitFile(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG, $newsaver);
         $msg = $this->t(MIDAS_BATCHMAKE_CHANGES_SAVED_STRING);
         echo JsonComponent::encode(array(true, $msg));
         }
       }
     else
       {
+      // populate config form with values
       $configForm = $this->ModuleForm->Config->createConfigForm($configPropertiesRequirements);
       $formArray = $this->getFormAsArray($configForm);
       foreach($configPropertiesRequirements as $configProperty => $configPropertyRequirement)
         {
         $formArray[$configProperty]->setValue($batchmakeConfig[$configProperty]);
         }
-      $this->view->configForm = $formArray; 
+      $this->view->configForm = $formArray;
       }
 
     }
 
 
 
-  /**
-   * @method testconfigAction()
-   * ajax function which tests config setup, performing
-   * validation on the current configuration set through the UI
-   */
-  public function testconfigAction()
-    {
-    if(!$this->getRequest()->isXmlHttpRequest())
-      {
-      $ajaxDirectLoadErrorString = $this->t(MIDAS_BATCHMAKE_AJAX_DIRECT_LOAD_ERROR_STRING);
-      throw new Zend_Exception($ajaxDirectLoadErrorString);
-      }
-    $this->_helper->layout->disableLayout();
-    $this->_helper->viewRenderer->setNoRender();
-
-
-    $configPropertiesParamVals = array();
-    $configPropertiesRequirements = $this->ModuleComponent->KWBatchmake->getConfigPropertiesRequirements();
-    foreach($configPropertiesRequirements as $configProperty => $configPropertyRequirement)
-      {
-      $configPropertiesParamVals[$configProperty] = $this->_getParam($configProperty);
-      }
-
-    $config_status =  $this->ModuleComponent->KWBatchmake->testconfig($configPropertiesParamVals);
-    $jsonout = JsonComponent::encode($config_status);
-    echo $jsonout;
-    }//end testconfigAction
-
-
 }//end class

modules/batchmake/controllers/components/ApiComponent.php

@@ -13,8 +13,8 @@
 /** Component for api methods */
 class Batchmake_ApiComponent extends AppComponent
 {
-    
-    
+
+
   /**
    * Helper function for verifying keys in an input array
    */
@@ -28,7 +28,7 @@ private function _checkKeys($keys, $values)
         }
       }
     }
-    
+
 
   /**
    * @param tmp_dir the path to the batchmake temp dir
@@ -37,7 +37,7 @@ private function _checkKeys($keys, $values)
    * @param app_dir the path to the dir housing executables
    * @param data_dir the path to the data export dir
    * @param condor_bin_dir the path to the location of the condor executables
-   * @return an array, the first value is a 0 if the config is incorrect or 1 
+   * @return an array, the first value is a 0 if the config is incorrect or 1
    * if the config is correct, the second value is a list of individual config values and their statuses.
    */
   public function testconfig($params)
@@ -49,24 +49,24 @@ public function testconfig($params)
       {
       if(!isset($params[$propKey]))
         {
-        $configParams[$propKey] = "";   
+        $configParams[$propKey] = "";
         }
       else
         {
-        $configParams[$propKey] = $params[$propKey];   
+        $configParams[$propKey] = $params[$propKey];
         }
-      }     
-    
-    //$this->_checkKeys(array('item_id', 'metric_name'), $value);  
-      
+      }
+
+    //$this->_checkKeys(array('item_id', 'metric_name'), $value);
+
     $componentLoader = new MIDAS_ComponentLoader();
     $kwbatchmakeComponent = $componentLoader->loadComponent('KWBatchmake', 'batchmake');
-    return array($kwbatchmakeComponent->testconfig($configParams));
+    return $kwbatchmakeComponent->testconfig($configParams);
     }
-    
-        
-    
- 
+
+
+
+
 } // end class
 
 

modules/batchmake/controllers/components/KWBatchmakeComponent.php

@@ -27,7 +27,7 @@ class Batchmake_KWBatchmakeComponent extends AppComponent
   MIDAS_BATCHMAKE_CONDOR_BIN_DIR_PROPERTY => MIDAS_BATCHMAKE_CHECK_IF_READABLE);
 
   /**
-   * accessor functin to return the names of the config propeties, and
+   * accessor function to return the names of the config propeties, and
    * their filesystem requirements;
    */
   public static function getConfigPropertiesRequirements()
@@ -43,7 +43,7 @@ public static function getConfigPropertiesRequirements()
   MIDAS_BATCHMAKE_EXE => MIDAS_BATCHMAKE_BIN_DIR_PROPERTY);
 
   /**
-   * accessor functin to return the application names, along with their
+   * accessor function to return the application names, along with their
    * expected location property.
    */
   public static function getApplicationsPaths()
@@ -87,6 +87,8 @@ public function __construct($alternateConfig = null, $executor = null)
 
   /**
    * helper function to load the correct config file
+   * @param bool $processSections param to be passed on to parse_ini_file,
+   * default is false
    * @return config array with config properties
    */
   protected function loadConfig($processSections = false)
@@ -102,9 +104,15 @@ protected function loadConfig($processSections = false)
       }
     return $config;
     }
-    
-    
-    
+
+
+  /**
+   * takes in an array read out of an ini file, looks in the 'global'
+   * space, and returns an array of only those properties that begin
+   * with batchmake.
+   * @param type $fullConfig
+   * @return type
+   */
   public function filterBatchmakeConfigProperties($fullConfig)
     {
     $batchmakeProps = array();
@@ -121,54 +129,41 @@ public function filterBatchmakeConfigProperties($fullConfig)
       }
     return $batchmakeProps;
     }
-    
-    
+
+
   /**
    * @method loadConfigProperties
-   * will load the configuration property values for this module, and filter
-   * out only those properties that are in the 'batchmake.' config namespace,
-   * removing the 'batchmake.' from the key name.
+   * will load the configuration property values for this module
    * @param string $alternateConfig an array of alternate config props
    * @param boolean $batchmakeOnly whether to get all properties or only config
+   * properties that are in the 'batchmake.' config namespace,
+   * removing the 'batchmake.' from the key name if true.
    * @return array of batchmake module specific config properties
    */
   public function loadConfigProperties($alternateConfig = null, $batchmakeOnly = true)
     {
     // load the full config
     $rawConfig = $this->loadConfig(true);
+    // get the global namespace props
     $globalProps = $rawConfig['global'];
-    // now set all the batchmake properties, except if we have any alternatives
+    // now set all the batchmake properties if we have any alternatives
     $configPropertiesParamVals = array();
     if(isset($alternateConfig))
       {
       $configPropertiesParamVals = $alternateConfig;
       // set these properties in the rawConfig
       foreach($alternateConfig as $propKey => $propVal)
         {
-        $globalProps[MIDAS_BATCHMAKE_MODULE . '.' . $propKey] = $propVal;  
+        $globalProps[MIDAS_BATCHMAKE_MODULE . '.' . $propKey] = $propVal;
         }
       $rawConfig['global'] = $globalProps;
       }
-//    else
-//      {
+    // get out the batchmake props
     $batchmakeProps = $this->filterBatchmakeConfigProperties($rawConfig);
     foreach($batchmakeProps as $configProperty => $configPropertyVal)
       {
-      $configPropertiesParamVals[$configProperty] = $configPropertyVal;  
+      $configPropertiesParamVals[$configProperty] = $configPropertyVal;
       }
-      
-    /*  $configPropertiesParamVals = array();
-      $modulePropertyNamespace = MIDAS_BATCHMAKE_MODULE . '.';
-      foreach($globalProps as $configProperty => $configPropertyVal)
-        {
-        $ind = strpos($configProperty, $modulePropertyNamespace);
-        if($ind !== false && $ind  == 0)
-          {
-          $reducedKey = substr($configProperty, strpos($configProperty, '.') + 1);
-          $configPropertiesParamVals[$reducedKey] = $configPropertyVal;
-          }
-        }*/
-//      }
     // set the member fields for config variables
     $this->componentConfig = $configPropertiesParamVals;
     $this->configScriptDir = $this->componentConfig[MIDAS_BATCHMAKE_SCRIPT_DIR_PROPERTY];
@@ -184,44 +179,8 @@ public function loadConfigProperties($alternateConfig = null, $batchmakeOnly = t
       }
     else
       {
-      return $rawConfig; 
-      }
-    
-      
-/*    if(!isset($alternateConfig))
-      {
-      $rawConfig = $this->loadConfig();
-
-      // batchmakeOnly option says to remove all other properties than those
-      // prefixed with "batchmake."
-      if($batchmakeOnly)
-        {
-        $modulePropertyNamespace = MIDAS_BATCHMAKE_MODULE . '.';
-        foreach($rawConfig as $configProperty => $configPropertyVal)
-          {
-          $ind = strpos($configProperty, $modulePropertyNamespace);
-          if($ind !== false && $ind  == 0)
-            {
-            $reducedKey = substr($configProperty, strpos($configProperty, '.') + 1);
-            $configPropertiesParamVals[$reducedKey] = $configPropertyVal;
-            }
-          }
-        }
-      }
-    else
-      {
-      $configPropertiesParamVals = $alternateConfig;
+      return $rawConfig;
       }
-
-  */
-//    $this->componentConfig = $configPropertiesParamVals;
-//    $this->configScriptDir = $this->componentConfig[MIDAS_BATCHMAKE_SCRIPT_DIR_PROPERTY];
-//    $this->configAppDir = $this->componentConfig[MIDAS_BATCHMAKE_APP_DIR_PROPERTY];
-//    $this->configTmpDir = $this->componentConfig[MIDAS_BATCHMAKE_TMP_DIR_PROPERTY];
-//    $this->configBinDir = $this->componentConfig[MIDAS_BATCHMAKE_BIN_DIR_PROPERTY];
-//    $this->configDataDir = $this->componentConfig[MIDAS_BATCHMAKE_DATA_DIR_PROPERTY];
-//    $this->configCondorBinDir = $this->componentConfig[MIDAS_BATCHMAKE_CONDOR_BIN_DIR_PROPERTY];
-//    return $this->componentConfig;
     }
 
   // above here is config setup

modules/batchmake/models/AppDao.php

@@ -9,11 +9,11 @@
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notices for more information.
 =========================================================================*/
-
+/** AppDao class for batchmake module */
 class Batchmake_AppDao extends MIDAS_GlobalDao
   {
-  public $moduleName='batchmake';
- 
+  public $moduleName = 'batchmake';
+
   } //end class
 
 ?>

modules/batchmake/models/AppModel.php

@@ -10,10 +10,11 @@
 PURPOSE.  See the above copyright notices for more information.
 =========================================================================*/
 
+/** AppModel class for batchmake module */
 class Batchmake_AppModel extends MIDASModel
 {
-  public $moduleName='batchmake';
+  public $moduleName = 'batchmake';
+
 
-    
 }
 ?>