Update config read order

background_scripts/update_check.php

@@ -31,14 +31,11 @@ function main()
 {
  global $logger;
 
- $configFile = new \Configuration\XdmodConfiguration(
+ $updateConfig = \Configuration\XdmodConfiguration::assocArrayFactory(
  'update_check.json',
  CONFIG_DIR,
  $logger
  );
- $configFile->initialize();
-
- $updateConfig = $configFile->toAssocArray();
 
  if (!$updateConfig['enabled']) {
  exit;

bin/acl-config

@@ -16,6 +16,7 @@ use CCR\DB\iDatabase;
 use CCR\Log;
 use CCR\Json;
 
+use Configuration\Configuration;
 use ETL\Utilities;
 use User\Roles;
 
@@ -124,20 +125,8 @@ function main()
  // roles/datawarehouse
  $results = array();
 
- $moduleConfig = new \Configuration\Configuration(
- CONFIG_DIR . '/modules.json',
- CONFIG_DIR,
- $log,
- array(
- 'local_config_dir' => CONFIG_DIR . '/modules.d'
- )
- );
- $moduleConfig->initialize();
-
  // Module Retrieval
- // We're using json_[decode/encode] here to essentially make a copy of $moduleConfig->transformedConfig
- // that will not keep a reference to the original object.
- $modules = json_decode(json_encode($moduleConfig->getTransformedConfig()), true);
+ $modules = Configuration::assocArrayFactory('modules.json', CONFIG_DIR, $log);
 
  // Remove the warning to users that this files contents are automatically
  // generated and that they modify it at their own risk.
@@ -153,35 +142,9 @@ function main()
  $allRoles = Roles::getRoleNames($blacklist);
 
  // Configuration Files
- $hierarchyConfig = new \Configuration\ModuleConfiguration(
- CONFIG_DIR . '/hierarchies.json',
- CONFIG_DIR,
- $log,
- array(
- 'local_config_dir' => CONFIG_DIR . '/hierarchies.d'
- )
- );
- $hierarchyConfig->initialize();
-
- $roleConfig = new \Configuration\ModuleConfiguration(
- CONFIG_DIR . '/roles.json',
- CONFIG_DIR,
- $log,
- array(
- 'local_config_dir' => CONFIG_DIR .'/roles.d'
- )
- );
- $roleConfig->initialize();
-
- $realmConfig = new \Configuration\ModuleConfiguration(
- CONFIG_DIR . '/datawarehouse.json',
- CONFIG_DIR,
- $log,
- array(
- 'local_config_dir' => CONFIG_DIR .'/datawarehouse.d'
- )
- );
- $realmConfig->initialize();
+ $hierarchyConfig = \Configuration\ModuleConfiguration::factory('hierarchies.json', CONFIG_DIR, $log);
+ $roleConfig = \Configuration\ModuleConfiguration::factory('roles.json', CONFIG_DIR, $log);
+ $realmConfig = \Configuration\ModuleConfiguration::factory('datawarehouse.json', CONFIG_DIR, $log);
 
  foreach ($modules as $module => $moduleData) {
 
@@ -2111,29 +2074,11 @@ function verifyConfigData()
 
  $invalid = array();
 
- $sections = array(
- 'modules' => true,
- 'roles' => true,
- 'datawarehouse' => false
- );
-
- $baseDir = CONFIG_DIR;
- foreach($sections as $section => $hasLocalConfig) {
- $baseFile = implode(DIRECTORY_SEPARATOR, array($baseDir, "$section.json"));
- $options = array();
- if ($hasLocalConfig) {
- $options['local_config_dir'] = implode(DIRECTORY_SEPARATOR, array($baseDir, "$section.d"));
- }
+ $sections = array('modules', 'roles', 'datawarehouse');
 
+ foreach($sections as $section) {
  try {
- $config = new \Configuration\XdmodConfiguration(
- $baseFile,
- $baseDir,
- $log,
- $options
- );
- $config->initialize();
-
+ \Configuration\XdmodConfiguration::assocArrayFactory("$section.json", CONFIG_DIR);
  $log->info("[SUCCESS] $section loaded successfully.");
  } catch (Exception $e) {
  $log->err("[FAIL] Unable to load section $section");

bin/xdmod-admin

@@ -207,16 +207,11 @@ function listResources()
 {
  global $logger;
 
- $configFile = new \Configuration\XdmodConfiguration(
+ $resourcesConfig = \Configuration\XdmodConfiguration::assocArrayFactory(
  'resources.json',
  CONFIG_DIR,
- $logger,
- array(
- 'force_array_return' => true
- )
+ $logger
  );
- $configFile->initialize();
- $resourcesConfig = $configFile->toAssocArray();
 
  foreach ($resourcesConfig as $resourceData) {
  echo 'Resource: ', $resourceData['resource'], "\n";

bin/xdmod-setup

@@ -44,13 +44,10 @@ function main()
 function checkForNewerVersion()
 {
  try {
- $configFile = new \Configuration\XdmodConfiguration(
+ $updateConfig = \Configuration\XdmodConfiguration::assocArrayFactory(
  'update_check.json',
  CONFIG_DIR
  );
- $configFile->initialize();
-
- $updateConfig = $configFile->toAssocArray();
 
  if (Version::isNewerVersionAvailable($updateConfig)) {
  $currVer = Version::getCurrentVersionNumber();

classes/Configuration/Configuration.php

@@ -233,7 +233,18 @@ public function __construct(
  }
 
  if ( isset($options['local_config_dir']) ) {
+
+ // Before continuing, make sure that the specified directory actually exists. It not
+ // existing could have unexpected consequences for an XDMoD installation.
+ if (!is_dir($options['local_config_dir'])) {
+ $this->logAndThrowException(sprintf("Unable to find the specified local configuration directory: %s", $options['local_config_dir']));
+ }
+
  $this->localConfigDir = $options['local_config_dir'];
+ } else {
+
+ // Set $localConfigDir to the default value.
+ $this->localConfigDir = implode(DIRECTORY_SEPARATOR, array($this->baseDir, sprintf("%s.d", basename($filename, '.json'))));
  }
 
  $this->isLocalConfig = ( isset($options['is_local_config']) && $options['is_local_config'] );
@@ -306,22 +317,16 @@ public function initialize($force = false)
 
  $this->interpretData();
 
- // Process any local configuration files.
-
- if ( ! $this->isLocalConfig && null !== $this->localConfigDir ) {
-
- if ( ! is_dir($this->localConfigDir) ) {
- $this->logger->debug(sprintf("Local configuration directory '%s' not found", $this->localConfigDir));
- return;
- }
+ // Process any local configuration files iff $localConfigDir exists, is actually a directory,
+ // and this is not a local config file itself.
+ if ( ! $this->isLocalConfig && null !== $this->localConfigDir && is_dir($this->localConfigDir) ) {
 
  if ( false === ($dh = @opendir($this->localConfigDir)) ) {
  $this->logAndThrowException(sprintf("Error opening configuration directory '%s'", $this->localConfigDir));
  }
 
- // Examine the subdirectory for .json files and parse each one, then merge the results back
- // into this object
-
+ // Examine the subdirectory for .json files and collect them for later use.
+ $files = array();
  while ( false !== ( $file = readdir($dh) ) ) {
 
  // Only process .json files
@@ -332,20 +337,29 @@ public function initialize($force = false)
  continue;
  }
 
- $fullPath = $this->localConfigDir . "/" . $file;
+ $files[] = $this->localConfigDir . "/" . $file;
+
+ } // while ( false !== ( $file = readdir($dh) ) )
+
+ // Sort the retrieved .json files.
+ sort($files, SORT_LOCALE_STRING);
+
+ // Process each .json file before merging into the main file.
+ foreach( $files as $file ) {
+
  try {
- $localConfigObj = $this->processLocalConfig($fullPath);
+ $localConfigObj = $this->processLocalConfig($file);
  } catch ( Exception $e ) {
- throw new Exception(sprintf("Processing %s: %s", $fullPath, $e->getMessage()));
+ throw new Exception(sprintf("Processing %s: %s", $file, $e->getMessage()));
  }
+
  $this->merge($localConfigObj);
- $localConfigObj->cleanup();
 
- } // while ( false !== ( $file = readdir($dh) ) )
+ $localConfigObj->cleanup();
+ } // foreach($files as $file)
 
  closedir($dh);
-
- } // if ( null !== $confSubdirectory )
+ } // if ( ! $this->isLocalConfig && null !== $this->localConfigDir && is_dir($this->localConfigDir) )
 
  $this->postMergeTasks();
 

classes/Configuration/XdmodConfiguration.php

@@ -69,17 +69,18 @@ protected function processExtends()
  {
  // This objects `transformedConfig` may be an object or an array of objects, this is handled
  // by the following `if/elseif` statement.
- if (is_array($this->transformedConfig)) {
- foreach($this->transformedConfig as $key => &$value) {
- if (is_object($value)) {
- $this->handleExtendsFor($value);
+ if (!$this->isLocalConfig) {
+ if (is_array($this->transformedConfig)) {
+ foreach($this->transformedConfig as $key => &$value) {
+ if (is_object($value)) {
+ $this->handleExtendsFor($value);
+ }
  }
- }
 
- } elseif(is_object($this->transformedConfig)) {
- $this->handleExtendsFor($this->transformedConfig);
+ } elseif(is_object($this->transformedConfig)) {
+ $this->handleExtendsFor($this->transformedConfig);
+ }
  }
-
  } // processExtends
 
  /**

classes/DB/FilterListBuilder.php

@@ -49,19 +49,12 @@ public function __construct()
  */
  public function buildAllLists()
  {
- $configFile = new \Configuration\XdmodConfiguration(
+ $config = \Configuration\XdmodConfiguration::assocArrayFactory(
  'datawarehouse.json',
  CONFIG_DIR,
- $this->_logger,
- array(
- 'local_config_dir' => implode(
- DIRECTORY_SEPARATOR,
- array(CONFIG_DIR, 'datawarehouse.d')
- )
- )
+ $this->_logger
  );
- $configFile->initialize();
- $config = $configFile->toAssocArray();
+
  // Get the realms to be processed.
  $realmNames = array_keys($config['realms']);
 
@@ -292,21 +285,11 @@ private function checkDimensionForRoles(GroupBy $groupBy)
  if (!isset(self::$rolesDimensionNames)) {
  self::$rolesDimensionNames = array();
 
- $configFile = new \Configuration\XdmodConfiguration(
+ $roles = \Configuration\XdmodConfiguration::assocArrayFactory(
  'roles.json',
  CONFIG_DIR,
- null,
- array(
- 'local_config_dir' => implode(
- DIRECTORY_SEPARATOR,
- array(CONFIG_DIR, 'roles.d')
- )
- )
- );
- $configFile->initialize();
-
- $config = $configFile->toAssocArray();
- $roles = $config['roles'];
+ null
+ )['roles'];
 
  foreach ($roles as $roleData) {
  $roleDimensionNames = \xd_utilities\array_get($roleData, 'dimensions', array());

classes/DataWarehouse.php

@@ -71,12 +71,10 @@ public function __destruct()
  */
  public static function getPersonIdFromPII($username, $organization) {
 
- $configFile = new \Configuration\XdmodConfiguration(
+ $config = \Configuration\XdmodConfiguration::assocArrayFactory(
  'user_management.json',
  CONFIG_DIR
  );
- $configFile->initialize();
- $config = $configFile->toAssocArray();
  $query = $config['person_mapping'];
 
  $dbh = self::connect();
@@ -367,17 +365,7 @@ public static function getAllocations($config = array())
  */
  public static function getCategories()
  {
- $configFile = new \Configuration\XdmodConfiguration(
- 'datawarehouse.json',
- CONFIG_DIR,
- null,
- array(
- 'local_config_dir' => implode(DIRECTORY_SEPARATOR, array(CONFIG_DIR, 'datawarehouse.d'))
- )
- );
- $configFile->initialize();
-
- $dwConfig = $configFile->toAssocArray();
+ $dwConfig = \Configuration\XdmodConfiguration::assocArrayFactory('datawarehouse.json', CONFIG_DIR);
 
  $categories = array();
  foreach ($dwConfig['realms'] as $realmName => $realm) {
@@ -403,17 +391,7 @@ public static function getCategories()
  */
  public static function getCategoryForRealm($realmName)
  {
- $configFile = new \Configuration\XdmodConfiguration(
- 'datawarehouse.json',
- CONFIG_DIR,
- null,
- array(
- 'local_config_dir' => implode(DIRECTORY_SEPARATOR, array(CONFIG_DIR, 'datawarehouse.d'))
- )
- );
- $configFile->initialize();
-
- $dwConfig = $configFile->toAssocArray();
+ $dwConfig = \Configuration\XdmodConfiguration::assocArrayFactory('datawarehouse.json', CONFIG_DIR);
 
  if (isset($dwConfig['realms'][$realmName]['category'])) {
  return $dwConfig['realms'][$realmName]['category'];

classes/DataWarehouse/Query/Query.php

@@ -1722,22 +1722,7 @@ protected static function getRealm()
  protected static function getConfigData()
  {
  if (!isset(self::$config)) {
- $configFile = new XdmodConfiguration(
- 'datawarehouse.json',
- CONFIG_DIR,
- null,
- array(
- 'local_config_dir' => implode(
- DIRECTORY_SEPARATOR,
- array(
- CONFIG_DIR,
- 'datawarehouse.d'
- )
- )
- )
- );
- $configFile->initialize();
- self::$config = $configFile->toAssocArray();
+ self::$config = XdmodConfiguration::assocArrayFactory('datawarehouse.json', CONFIG_DIR);
  }
 
  return self::$config;