tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Split up functions in PreservingIniWriter for better readabillity and add better comment handling 

Split up the function diffPropertyUpdates into two single functions. Change the
IniEditor to "glue" comments to section declarations.

resolves #4352
This commit is contained in:
Matthias Jentsch 2013-08-07 15:21:49 +02:00
parent c1338898a6
commit 76d7753860
2 changed files with 106 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
library/Icinga/Config/IniEditor.php
View File

@ -136,13 +136,13 @@ class IniEditor
return -1;
}
if (strlen($formatted) > 0) {
if (preg_match('/^'.$formatted.'\[\]/',$l) === 1 ||
if (preg_match('/^'.$formatted.'\[\]=/',$l) === 1 ||
preg_match(
'/^'.$formatted.$this->nestSeparator.$index.'/',$l) === 1){
'/^'.$formatted.$this->nestSeparator.$index.'=/',$l) === 1){
return $line;
}
} else {
if (preg_match('/^'.$index.'/',$l) === 1 ) {
if (preg_match('/^'.$index.'=/',$l) === 1 ) {
return $line;
}
}
@ -237,11 +237,24 @@ class IniEditor
if ($this->isSectionDeclaration($line)) {
$i--;
$line = $this->text[$i];
/*
* Ignore comments that are glued to the section declaration
*/
while ($i > 0 && preg_match('/^;/',$line) === 1) {
$i--;
$line = $this->text[$i];
}
/*
* Remove whitespaces between the sections
*/
while ($i > 0 && preg_match('/^[\s]*$/',$line) === 1) {
$this->deleteLine($i);
$i--;
$line = $this->text[$i];
}
/*
* Add a single whitespace
*/
if ($i !== 0) {
$this->insertAtLine($i + 1,'');
}
@ -315,6 +328,16 @@ class IniEditor
$started = isset($section) ? false: true;
foreach ($this->text as $line) {
if ($started && preg_match('/^\[/',$line) === 1) {
if ($i === 0) {
return $i;
}
/*
* ignore all comments 'glued' to the next section, to allow section
* comments in front of sections
*/
while (preg_match('/^;/',$this->text[$i - 1]) === 1) {
$i--;
}
return $i;
} elseif (preg_match('/^\['.$section.'.*\]/',$line) === 1) {
$started = true;
@ -376,10 +399,10 @@ class IniEditor
if ($inSection && preg_match('/^\[/',$line) === 1) {
return -1;
}
if ($inSection && preg_match('/^'.$key.'/',$line) === 1) {
if ($inSection && preg_match('/^'.$key.'=/',$line) === 1) {
return $i;
}
if (!$inSection && preg_match('/^\['.$section.'/',$line) === 1) {
if (!$inSection && preg_match('/^\[ *'.$section.' *[\]:]/',$line) === 1) {
$inSection = true;
}
$i++;

89
library/Icinga/Config/PreservingIniWriter.php
View File

@ -73,16 +73,49 @@ class PreservingIniWriter extends \Zend_Config_Writer_FileAbstract
Zend_Config $oldconfig,
Zend_Config $newconfig,
IniEditor $editor,
array $parents = array())
{
array $parents = array()
) {
$this->diffPropertyUpdates($oldconfig,$newconfig,$editor,$parents);
$this->diffPropertyDeletions($oldconfig,$newconfig,$editor,$parents);
}
/**
* Search for created and updated properties and use the editor to create or update these entries
*
* @param Zend_Config $oldconfig The config representing the state before the change
* @param Zend_Config $newconfig The config representing the state after the change
* @param IniEditor $eeditor The editor that should be used to edit the old config file
* @param array $parents The parent keys that should be respected when editing the config
*/
private function diffPropertyUpdates(
Zend_Config $oldconfig,
Zend_Config $newconfig,
IniEditor $editor,
array $parents = array()
) {
/*
* The current section. This value is null when processing
* the section-less root element
*/
$section = empty($parents) ? null : $parents[0];
/*
* Iterate over all properties in the new configuration file and search for changes
*/
foreach ($newconfig as $key => $value) {
$oldvalue = $oldconfig->get($key);
$nextParents = array_merge($parents,array($key));
$ident = empty($parents) ?
$keyIdentifier = empty($parents) ?
array($key) : array_slice($nextParents,1,null,true);
if ($value instanceof Zend_Config) {
/*
* The value is a nested Zend_Config, handle it recursively
*/
if (!isset($section)) {
/*
* Update the section declaration
*/
$extends = $newconfig->getExtends();
$extend = array_key_exists($key,$extends) ?
$extends[$key] : null;
@ -93,31 +126,65 @@ class PreservingIniWriter extends \Zend_Config_Writer_FileAbstract
}
$this->diffConfigs($oldvalue,$value,$editor,$nextParents);
} else {
/*
* The value is a plain value, use the editor to set it
*/
if (is_numeric($key)){
$editor->setArrayElement($ident,$value,$section);
$editor->setArrayElement($keyIdentifier,$value,$section);
} else {
$editor->set($ident,$value,$section);
$editor->set($keyIdentifier,$value,$section);
}
}
}
}
/**
* Search for deleted properties and use the editor to delete these entries
*
* @param Zend_Config $oldconfig The config representing the state before the change
* @param Zend_Config $newconfig The config representing the state after the change
* @param IniEditor $eeditor The editor that should be used to edit the old config file
* @param array $parents The parent keys that should be respected when editing the config
*/
private function diffPropertyDeletions(
Zend_Config $oldconfig,
Zend_Config $newconfig,
IniEditor $editor,
array $parents = array()
) {
/*
* The current section. This value is null when processing
* the section-less root element
*/
$section = empty($parents) ? null : $parents[0];
/*
* Iterate over all properties in the old configuration file and search for
* deleted properties
*/
foreach ($oldconfig as $key => $value) {
$nextParents = array_merge($parents,array($key));
$newvalue = $newconfig->get($key);
$ident = empty($parents) ?
$keyIdentifier = empty($parents) ?
array($key) : array_slice($nextParents,1,null,true);
if (!isset($newvalue)) {
if ($value instanceof Zend_Config) {
$this->diffConfigs(
$value,new Zend_Config(array()),$editor,$nextParents
);
/*
* The deleted value is a nested Zend_Config, handle it recursively
*/
$this->diffConfigs($value,new Zend_Config(array()),$editor,$nextParents);
if (!isset($section)) {
$editor->removeSection($key);
}
} else {
/*
* The deleted value is a plain value, use the editor to delete it
*/
if (is_numeric($key)) {
$editor->resetArrayElement($ident,$section);
$editor->resetArrayElement($keyIdentifier,$section);
} else {
$editor->reset($ident,$section);
$editor->reset($keyIdentifier,$section);
}
}
}