Code

Updated migration process
[gosa.git] / gosa-core / include / class_configRegistry.inc
index e0e09f94fcf5ee4f77248d840f9a9fe41426553a..d2c71a5946dadc093e145ef78618a49b79bb6d5b 100644 (file)
@@ -4,8 +4,6 @@ class configRegistry{
 
     public $config = NULL;
     public $properties = array();
-    public $mapByClass = array();
-    public $mapPropertyToClass = array();
     public $ldapStoredProperties = array(); 
     public $fileStoredProperties = array(); 
     public $classToName = array(); 
@@ -14,7 +12,6 @@ class configRegistry{
 
     function __construct($config)
     {
-        restore_error_handler();
         $this->config = &$config;
         $this->reload();
     }
@@ -30,9 +27,7 @@ class configRegistry{
         $this->ldapStoredProperties = array();
         $this->fileStoredProperties = array();
         $this->properties = array();
-        $this->mapByClass = array();
         $this->mapByName = array();
-        $this->mapPropertyToClass = array();
 
         // Search for config flags defined in the config file (TAB section)
         foreach($this->config->data['TABS'] as $tabname => $tabdefs){
@@ -55,6 +50,20 @@ class configRegistry{
             }
         }
 
+        // Search for config flags defined in the config file (MENU section)
+        foreach($this->config->data['MENU'] as $section => $entries){
+            foreach($entries as $entry){
+                if(count($entry) > 2 && isset($entry['CLASS'])){
+                    $class = $entry['CLASS'];
+                    foreach($entry as $name => $value){
+                        if(!in_array($name, array('CLASS','ACL'))){
+                            $this->fileStoredProperties[strtolower($class)][strtolower($name)] = $value;
+                        }
+                    }
+                }
+            }
+        }
+
         // Search for config flags defined in the config file (MAIN section)
         foreach($this->config->data['MAIN'] as $name => $value){
             $this->fileStoredProperties['core'][strtolower($name)] = $value;
@@ -91,15 +100,20 @@ class configRegistry{
                 $def = call_user_func(array($cname, 'plInfo'));;
 
                 // Register Post Events (postmodfiy,postcreate,postremove,checkhook)
-                if(isset($def['plShortName'])){
-                    $this->classToName[$cname] = $def['plShortName'];
-                    $data = array('name' => 'postcreate','type' => 'string');
+                if(count($def)){
+                    
+                    $name = $cname;
+                    $name = (isset($def['plShortName'])) ? $def['plShortName'] : $cname;
+                    $name = (isset($def['plDescription'])) ? $def['plDescription'] : $cname;
+
+                    $this->classToName[$cname] = $name;
+                    $data = array('name' => 'postcreate','type' => 'command');
                     $this->register($cname, $data);    
-                    $data = array('name' => 'postremove','type' => 'string');
+                    $data = array('name' => 'postremove','type' => 'command');
                     $this->register($cname, $data);    
-                    $data = array('name' => 'postmodify','type' => 'string');
+                    $data = array('name' => 'postmodify','type' => 'command');
                     $this->register($cname, $data);    
-                    $data = array('name' => 'checkhook', 'type' => 'string');
+                    $data = array('name' => 'check', 'type' => 'command');
                     $this->register($cname, $data);    
                 }
 
@@ -116,9 +130,8 @@ class configRegistry{
     {
         $id = count($this->properties);
         $this->properties[$id] = new gosaProperty($this,$class,$data);
-        $this->mapByName[$class][$data['name']] = $id;
-        $this->mapByClass[$class][] = $id;
-        $this->mapPropertyToClass[$id] = $class;
+        $p = strtolower("{$class}::{$data['name']}");
+        $this->mapByName[$p] = $id;
     }
 
     public function getAllProperties()
@@ -127,17 +140,18 @@ class configRegistry{
     }
 
     function propertyExists($class,$name)
-    {
-        if(!isset($this->mapByName[$class][$name])){
-        print_a(array($class,$name));
-
-        }
-        return(isset($this->mapByName[$class][$name]));
+    {       
+        $p = strtolower("{$class}::{$name}");
+        return(isset($this->mapByName[$p]));
     }
 
     private function getId($class,$name)
     {
-        return($this->mapByName[$class][$name]);    
+        $p = strtolower("{$class}::{$name}");
+        if(!isset($this->mapByName[$p])){
+            return(-1);
+        }       
+        return($this->mapByName[$p]);    
     }
 
     function getProperty($class,$name)
@@ -168,10 +182,21 @@ class configRegistry{
 
     function saveChanges()
     {
+        $migrate = array();
         foreach($this->properties as $prop){
-            $prop->save();
+
+            // Is this property modified
+            if(in_array($prop->getStatus(),array('modified','removed'))){
+
+                // Check if we've to migrate something before we can make the changes effective. 
+                if($prop->migrationRequired()){
+                    $migrate[] = $prop;
+                }else{
+                    $prop->save();
+                }
+            }
         }
-        $this->reload(TRUE);
+        return($migrate);
     }
 }
 
@@ -181,8 +206,10 @@ class gosaProperty
     protected $name = "";
     protected $class = "";
     protected $value = "";
+    protected $tmp_value = "";  // Used when modified but not saved 
     protected $type = "string";
     protected $default = "";
+    protected $defaults = "";
     protected $description = "";
     protected $check = "";
     protected $migrate = "";
@@ -191,6 +218,8 @@ class gosaProperty
     protected $parent = NULL;
     protected $data = array();
 
+    protected $migrationClass = NULL;
+
     /*!  The current property status
      *     'ldap'       Property is stored in ldap 
      *     'file'       Property is stored in the config file
@@ -200,7 +229,10 @@ class gosaProperty
     protected $status = 'undefined';
 
     protected $attributes = array('name','type','default','description','check',
-            'migrate','mandatory','group');
+            'migrate','mandatory','group','defaults');
+
+
+
 
     function __construct($parent,$classname,$data)
     {
@@ -218,6 +250,170 @@ class gosaProperty
 
         // Initialize with the current value
         $this->_restoreCurrentValue(); 
+
+    }
+
+    function migrationRequired()
+    {
+        // Instantiate migration class 
+        if(!empty($this->migrate) && $this->migrationClass == NULL){
+            if(!class_available($this->migrate)){
+                trigger_error("Cannot start migration for gosaProperty::'{$this->getName()}' class not found ({$this->migrate})!");
+            }else{
+                $class = $this->migrate;
+                $tmp = new $class($this->parent->config,$this);
+                if(! $tmp instanceof propertyMigration){ 
+                    trigger_error("Cannot start migration for gosaProperty::'{$this->getName()}' doesn't implement propertyMigration!");
+                }else{
+                    $this->migrationClass = $tmp;
+                }
+            }
+        }
+        if(empty($this->migrate) || $this->migrationClass == NULL){
+            return(FALSE);
+        }
+        return($this->migrationClass->checkForIssues());
+    }
+
+    function getMigrationClass()
+    {
+        return($this->migrationClass);
+    }
+
+    function check()
+    {
+        $val = $this->getValue(TRUE);
+        $return = TRUE;
+        if($this->mandatory && empty($val)){
+            $return = FALSE;
+        }
+
+        $check = $this->getCheck();
+        if(!empty($val) && !empty($check)){
+            $res = call_user_func(preg_split("/::/", $this->check),$messages=TRUE, $this->class,$this->name,$val, $this->type);
+            if(!$res){
+                $return = FALSE;
+            }
+        }
+        return($return);
+    }
+
+    static function isBool($message,$class,$name,$value, $type)
+    {
+        $match = in_array($value,array('true','false',''));
+
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::invalid($name,$value,"",_("Use 'true', 'false' or empty if allowed")), WARNING_DIALOG);
+        }
+    
+        return($match);
+    }
+
+    static function isString($message,$class,$name,$value, $type)
+    {
+        $match = TRUE;
+    
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::invalid($name), WARNING_DIALOG);
+        }
+
+        return($match);
+    }
+
+    static function isInteger($message,$class,$name,$value, $type)
+    {
+        $match = is_numeric($value) && !preg_match("/[^0-9]/", $value);
+
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::invalid($name, $value,'/[0-9]/'), WARNING_DIALOG);
+        }
+
+        return($match);
+    }
+
+    static function isPath($message,$class,$name,$value, $type)
+    {
+        $match = TRUE;
+    
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::invalid($name), WARNING_DIALOG);
+        }
+
+        return($match);
+    }
+
+    static function isWriteablePath($message,$class,$name,$value, $type)
+    {
+        $match = !empty($value)&&is_dir($value)&&is_writeable($value);
+    
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+
+            if(!is_dir($value)){
+                msg_dialog::display(_("Warning"), sprintf(_("The specified folder does not exists '%s'."), $value), WARNING_DIALOG);
+            }elseif(!is_writeable($value)){
+                msg_dialog::display(_("Warning"), sprintf(_("The specified folder cannot be used for writing '%s'."), $value), WARNING_DIALOG);
+            }
+        }
+
+        return($match);
+    }
+
+    static function isReadableFile($message,$class,$name,$value, $type)
+    {
+        $match = !empty($value) && is_readable($value) && is_file($value);
+
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+                
+            if(!is_file($value)){
+                msg_dialog::display(_("Warning"), sprintf(_("The specified file does not exists '%s'."), $value), WARNING_DIALOG);
+            }elseif(!is_readable($value)){
+                msg_dialog::display(_("Warning"), sprintf(_("The specified file cannot be used for reading '%s'."), $value), WARNING_DIALOG);
+            }
+        }
+
+        return($match);
+    }
+
+    static function isCommand($message,$class,$name,$value, $type)
+    {
+        $match = TRUE;
+
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::cmdinvalid($name,$value),  WARNING_DIALOG);
+        }
+        
+        return($match);
+    }
+
+    static function isDn($message,$class,$name,$value, $type)
+    {
+        $match = preg_match("/^([a-z]*=[^=,]*,)*[^=]*=[^=]*$/i", $value);
+
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::invalid($name,$value,'','cn=user,ou=people,dc=example,dc=de'),  WARNING_DIALOG);
+        }
+        
+        return($match);
+    }
+
+    static function isRdn($message,$class,$name,$value, $type)
+    {
+        $match = preg_match("/^([a-z]*=[^=,]*,)*[^=]*=[^=]*,$/i", $value);
+
+        // Display the reason for failing this check.         
+        if($message && ! $match){
+            msg_dialog::display(_("Warning"), msgPool::invalid($name,$value,'','ou=people,'),  WARNING_DIALOG);
+        }
+        
+        return($match);
     }
 
     private function _restoreCurrentValue()
@@ -231,9 +427,9 @@ class gosaProperty
         }
 
         // Second check for values in the config file.
-        if(isset($this->parent->fileStoredProperties[$this->class][strtolower($this->name)])){
+        if(isset($this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)])){
             $this->setStatus('file');
-            $this->value = $this->parent->fileStoredProperties[$this->class][strtolower($this->name)];
+            $this->value = $this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)];
             return;
         }
 
@@ -243,7 +439,6 @@ class gosaProperty
         }
     }
 
-    function getValue() { return($this->value); }
     function getMigrate() { return($this->migrate); }
     function getCheck() { return($this->check); }
     function getName() { return($this->name); }
@@ -252,14 +447,26 @@ class gosaProperty
     function getType() { return($this->type); }
     function getDescription() { return($this->description); }
     function getDefault() { return($this->default); }
+    function getDefaults() { return($this->defaults); }
     function getStatus() { return($this->status); }
     function isMandatory() { return($this->mandatory); }
 
     function setValue($str) 
     {
-        if($this->value != $str){
+        if(in_array($this->getStatus(), array('modified'))){
+            $this->tmp_value = $str; 
+        }elseif($this->value != $str){
             $this->setStatus('modified'); 
-            $this->value = $str; 
+            $this->tmp_value = $str; 
+        }
+    }
+
+    function getValue($temporary = FALSE) 
+    { 
+        if($temporary && in_array($this->getStatus(), array('modified'))){
+            return($this->tmp_value); 
+        }else{ 
+            return($this->value); 
         }
     }
 
@@ -275,7 +482,6 @@ class gosaProperty
     function save()
     {
         if($this->getStatus() == 'modified'){
-
             $ldap = $this->parent->config->get_ldap_link();
             $ldap->cd($this->parent->config->current['BASE']);
             $dn = "cn={$this->class},".$this->parent->config->current['CONFIG'];
@@ -285,13 +491,12 @@ class gosaProperty
                 $data = array(
                         'cn' => $this->class, 
                         'objectClass' => array('top','gosaConfig'),
-                        'gosaSetting' => $this->name.":".$this->value);
+                        'gosaSetting' => $this->name.":".$this->tmp_value);
 
                 $ldap->add($data);
                 if(!$ldap->success()){
                     echo $ldap->get_error();
                 }
-                $this->_restoreCurrentValue();
 
             }else{
                 $attrs = $ldap->fetch();
@@ -300,19 +505,20 @@ class gosaProperty
                 for($i = 0;$i<$attrs['gosaSetting']['count']; $i ++){
                     $set = $attrs['gosaSetting'][$i];
                     if(preg_match("/^{$this->name}:/", $set)){
-                        $set = "{$this->name}:{$this->value}";
+                        $set = "{$this->name}:{$this->tmp_value}";
                         $found = true;
                     }
                     $data['gosaSetting'][] = $set;
                 }
-                if(!$found) $data['gosaSetting'][] = "{$this->name}:{$this->value}";
+                if(!$found) $data['gosaSetting'][] = "{$this->name}:{$this->tmp_value}";
                 $ldap->cd($dn);
                 $ldap->modify($data);
                 if(!$ldap->success()){
                     echo $ldap->get_error();
                 }
-                $this->_restoreCurrentValue();
-            } 
+            }
+            $this->value = $this->tmp_value;
+            $this->setStatus('ldap'); 
         }elseif($this->getStatus() == 'removed'){
             $ldap = $this->parent->config->get_ldap_link();
             $ldap->cd($this->parent->config->current['BASE']);
@@ -351,4 +557,12 @@ class gosaProperty
     }
 }
 
+
+
+interface propertyMigration
+{
+    function __construct($config,$property);
+}
+
+
 ?>