BUG: Refs #212. Initial work towards better default configuration of batchmake

Author: Michael Grauer

modules/batchmake/Notification.php

@@ -9,17 +9,19 @@
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notices for more information.
 =========================================================================*/
+require_once BASE_PATH . '/modules/api/library/APIEnabledNotification.php';
 
 /** notification manager*/
-class Batchmake_Notification extends MIDAS_Notification
+class Batchmake_Notification extends ApiEnabled_Notification
   {
-  public $_moduleComponents=array('KWBatchmake');
   public $moduleName = 'batchmake';
-  public $_components = array('Utility', 'Internationalization');    
+  public $_components = array('Utility', 'Internationalization');     
+  public $_moduleComponents=array('KWBatchmake','Api'); 
 
   /** init notification process*/
   public function init()
     {
+    $this->enableWebAPI($this->moduleName);  
     $this->addCallBack('CALLBACK_CORE_GET_DASHBOARD', 'getDashboard');
     $this->addCallBack('CALLBACK_CORE_GET_LEFT_LINKS', 'getLeftLink');
     }//end init

modules/batchmake/constant/module.php

@@ -63,10 +63,10 @@
 
 // config paths
 define("MIDAS_BATCHMAKE_MODULE", "batchmake");
-define("MIDAS_BATCHMAKE_CONFIGS_PATH", BASE_PATH . "/modules/" . MIDAS_BATCHMAKE_MODULE . "/configs/");
-define("MIDAS_BATCHMAKE_MODULE_CONFIG", MIDAS_BATCHMAKE_CONFIGS_PATH . "module.ini");
-define("MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG", MIDAS_BATCHMAKE_CONFIGS_PATH . "module.local.ini");
-define("MIDAS_BATCHMAKE_MODULE_LOCAL_OLD_CONFIG", MIDAS_BATCHMAKE_CONFIGS_PATH . "module.local.ini.old");
+define("MIDAS_BATCHMAKE_CONFIGS_PATH", BASE_PATH . "/core/configs/" . MIDAS_BATCHMAKE_MODULE);
+//define("MIDAS_BATCHMAKE_MODULE_CONFIG", MIDAS_BATCHMAKE_CONFIGS_PATH . "module.ini");
+define("MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG", MIDAS_BATCHMAKE_CONFIGS_PATH . ".local.ini");
+define("MIDAS_BATCHMAKE_MODULE_LOCAL_OLD_CONFIG", MIDAS_BATCHMAKE_CONFIGS_PATH . ".local.ini.old");
 
 
 // submit button name for config

modules/batchmake/controllers/ConfigController.php

@@ -50,7 +50,46 @@ 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 
+   */
+  protected function createDefaultConfig($currentConfig)
+    {
+    $tmpDir = $this->getTempDirectory();
+    $defaultConfigDirs = array(MIDAS_BATCHMAKE_TMP_DIR_PROPERTY => $tmpDir.'/batchmake/tmp',
+    MIDAS_BATCHMAKE_BIN_DIR_PROPERTY => $tmpDir.'/batchmake/bin',
+    MIDAS_BATCHMAKE_SCRIPT_DIR_PROPERTY => $tmpDir.'/batchmake/script',
+    MIDAS_BATCHMAKE_APP_DIR_PROPERTY => $tmpDir.'/batchmake/bin',
+    MIDAS_BATCHMAKE_DATA_DIR_PROPERTY => $tmpDir.'/batchmake/data');
+    $returnedConfig = array();
+    foreach($currentConfig as $configProp => $configDir)
+      {
+      if(!isset($configProp) || !isset($configDir) || $configDir == "")
+        {
+        $configDir = $defaultConfigDirs[$configProp];
+        $returnedConfig[$configProp] = $configDir;  
+        // also create this directory to be sure it exists
+        if(!KWUtils::mkDir($configDir))
+          {
+          throw new Zend_Exception("Cannot create directory ".$configDir);
+          }
+        }
+      else
+        {
+        $returnedConfig[$configProp] = $configDir;
+        }
+      }
+    return $returnedConfig;    
+    }
+    
+    
+    
+    
 
   /**
    * @method indexAction(), will test the configuration that the user has set
@@ -60,6 +99,7 @@ public function indexAction()
     {
 
     $applicationConfig = $this->ModuleComponent->KWBatchmake->loadConfigProperties();
+    $applicationConfig = $this->createDefaultConfig($applicationConfig);
     $configPropertiesRequirements = $this->ModuleComponent->KWBatchmake->getConfigPropertiesRequirements();
     $configForm = $this->ModuleForm->Config->createConfigForm($configPropertiesRequirements);
     $formArray = $this->getFormAsArray($configForm);

modules/batchmake/controllers/components/ApiComponent.php

@@ -0,0 +1,76 @@
+<?php
+/*=========================================================================
+MIDAS Server
+Copyright (c) Kitware SAS. 20 rue de la Villette. All rights reserved.
+69328 Lyon, FRANCE.
+
+See Copyright.txt for details.
+This software is distributed WITHOUT ANY WARRANTY; without even
+the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.  See the above copyright notices for more information.
+=========================================================================*/
+
+/** Component for api methods */
+class Batchmake_ApiComponent extends AppComponent
+{
+    
+    
+  /**
+   * Helper function for verifying keys in an input array
+   */
+  private function _checkKeys($keys, $values)
+    {
+    foreach($keys as $key)
+      {
+      if(!array_key_exists($key, $values))
+        {
+        throw new Exception('Parameter '.$key.' must be set.', -1);
+        }
+      }
+    }
+    
+
+  /**
+   * @param tmp_dir the path to the batchmake temp dir
+   * @param bin_dir the path to the batchmake bin dir, should have BatchMake exe
+   * @param script_dir the path to the batchmake script dir, where bms files live
+   * @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 
+   * if the config is correct, the second value is a list of individual
+   * config values and their status.
+   */
+  public function testConfig($value)
+    {
+    // any values that aren't filled in, fill them in with a blank
+    $expectedKeys = array("tmp_dir", "bin_dir", "script_dir", "app_dir", "data_dir", "condor_bin_dir");
+    $replacements = array();
+    foreach($value as $key=>$value)
+      {
+      if(!isset($key))
+        {
+        $replacements[$key] = "";   
+        }
+      } 
+    foreach($replacements as $replacement=>$val)
+      {
+      $value[$replacement] = $val;
+      }
+    
+    
+    $this->_checkKeys(array('item_id', 'metric_name'), $value);  
+      
+    $componentLoader = new MIDAS_ComponentLoader();
+    $kwbatchmakeComponent = $componentLoader->loadComponent('KWBatchmake', 'batchmake');
+    return array($kwbatchmakeComponent->testconfig($value));
+    }
+    
+        
+    
+ 
+} // end class
+
+
+
+

modules/batchmake/controllers/components/KWBatchmakeComponent.php

@@ -91,17 +91,18 @@ public function __construct($alternateConfig = null, $executor = null)
    */
   protected function loadConfig()
     {
+    $path = MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG;
     if(file_exists(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG))
       {
       $config = parse_ini_file(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG, false);
       }
     else
       {
-      $config = parse_ini_file(MIDAS_BATCHMAKE_MODULE_CONFIG);
+      throw new Zend_Exception("The Batchmake module has not been enabled.  Enable it through the Midas administration tab");
       }
     return $config;
     }
-
+    
   /**
    * @method loadConfigProperties
    * will load the configuration property values for this module, and filter