Code

Updated property handling
[gosa.git] / gosa-core / include / class_configRegistry.inc
index ea80efa573e8ed4068391eca325deabcae59bd87..5051d21b6221dc7412529932a38da648d2aabb29 100644 (file)
@@ -10,9 +10,33 @@ class configRegistry{
 
     public $status = 'none';
 
+    // Excludes property values defined in ldap 
+    public $ignoreLdapProperties = FALSE;
+
+    // Contains all classes with plInfo
+    public $classesWithInfo = array();
+
     function __construct($config)
     {
         $this->config = &$config;
+
+        // Detect classes that have a plInfo method 
+        global $class_mapping;
+        foreach ($class_mapping as $cname => $path){
+            $cmethods = get_class_methods($cname);
+            if (is_array($cmethods) && in_array_ics('plInfo',$cmethods)){
+
+                // Get plugin definitions
+                $def = call_user_func(array($cname, 'plInfo'));;
+
+                // Register Post Events (postmodfiy,postcreate,postremove,checkhook)
+                if(count($def)){
+                    $this->classesWithInfo[$cname] = $def;
+                }
+            }
+        }
+
+        // (Re)Load properties
         $this->reload();
     }
 
@@ -50,6 +74,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;
@@ -62,6 +100,14 @@ class configRegistry{
             }
         }
 
+        // Skip searching for LDAP defined properties if 'ignoreLdapProperties' is set to 'true'
+        //  in the config. 
+        $this->ignoreLdapProperties = FALSE;
+        if(isset($this->fileStoredProperties['core'][strtolower('ignoreLdapProperties')]) && 
+            preg_match("/(true|on)/i", $this->fileStoredProperties['core'][strtolower('ignoreLdapProperties')])){
+            $this->ignoreLdapProperties = TRUE;
+        }
+
         // Search for all config flags defined in the LDAP - BUT only if we ARE logged in. 
         if(!empty($this->config->current['CONFIG'])){
             $ldap = $this->config->get_ldap_link();
@@ -77,36 +123,29 @@ class configRegistry{
             $this->status = 'finished';
         }
 
-        global $class_mapping;
-        foreach ($class_mapping as $cname => $path){
-            $cmethods = get_class_methods($cname);
-            if (is_array($cmethods) && in_array_ics('plInfo',$cmethods)){
-
-                // Get plugin definitions
-                $def = call_user_func(array($cname, 'plInfo'));;
-
-                // Register Post Events (postmodfiy,postcreate,postremove,checkhook)
-                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' => 'command');
-                    $this->register($cname, $data);    
-                    $data = array('name' => 'postmodify','type' => 'command');
-                    $this->register($cname, $data);    
-                    $data = array('name' => 'check', 'type' => 'command');
-                    $this->register($cname, $data);    
-                }
-
-                if(isset($def['plProperties'])){
-                    foreach($def['plProperties'] as $property){
-                        $this->register($cname, $property);
-                    }
+        // Register plugin properties.
+        foreach ($this->classesWithInfo as $cname => $def){
+
+            // Detect class name
+            $name = $cname;
+            $name = (isset($def['plShortName'])) ? $def['plShortName'] : $cname;
+            $name = (isset($def['plDescription'])) ? $def['plDescription'] : $cname;
+
+            // Register post events
+            $this->classToName[$cname] = $name;
+            $data = array('name' => 'postcreate','type' => 'command');
+            $this->register($cname, $data);    
+            $data = array('name' => 'postremove','type' => 'command');
+            $this->register($cname, $data);    
+            $data = array('name' => 'postmodify','type' => 'command');
+            $this->register($cname, $data);    
+            $data = array('name' => 'check', 'type' => 'command');
+            $this->register($cname, $data);    
+
+            // Register properties 
+            if(isset($def['plProperties'])){
+                foreach($def['plProperties'] as $property){
+                    $this->register($cname, $property);
                 }
             }
         }
@@ -168,10 +207,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);
     }
 }
 
@@ -193,6 +243,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
@@ -204,6 +256,9 @@ class gosaProperty
     protected $attributes = array('name','type','default','description','check',
             'migrate','mandatory','group','defaults');
 
+
+
+
     function __construct($parent,$classname,$data)
     {
         // Set some basic infos 
@@ -220,6 +275,34 @@ 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()
@@ -246,7 +329,10 @@ class gosaProperty
 
         // 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);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The value '%s' specified for '%s:%s' is invalid. A bool value is required here!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
     
         return($match);
@@ -258,7 +344,10 @@ class gosaProperty
     
         // Display the reason for failing this check.         
         if($message && ! $match){
-            msg_dialog::display(_("Warning"), msgPool::invalid($name), WARNING_DIALOG);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The value '%s' specified for '%s:%s' is invalid. A string value is required here!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
 
         return($match);
@@ -270,7 +359,10 @@ class gosaProperty
 
         // Display the reason for failing this check.         
         if($message && ! $match){
-            msg_dialog::display(_("Warning"), msgPool::invalid($name, $value,'/[0-9]/'), WARNING_DIALOG);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The value '%s' specified for '%s:%s' is invalid. A numeric value is required here!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
 
         return($match);
@@ -278,27 +370,57 @@ class gosaProperty
 
     static function isPath($message,$class,$name,$value, $type)
     {
-        $match = TRUE;
+        $match = preg_match("#^(/[^/]*/){1}#", $value);
     
         // Display the reason for failing this check.         
         if($message && ! $match){
-            msg_dialog::display(_("Warning"), msgPool::invalid($name), WARNING_DIALOG);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The path '%s' specified for '%s:%s' is invalid!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
 
         return($match);
     }
 
-    static function isWriteablePath($message,$class,$name,$value, $type)
+    static function isReadablePath($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 folder '%s' specified for '%s:%s' does not exists!"), 
+                            bold($value),bold($class),bold($name)), 
+                        WARNING_DIALOG);
+            }elseif(!is_readable($value)){
+                msg_dialog::display(_("Warning"), 
+                        sprintf(_("The folder '%s' specified for '%s:%s' cannot be used for reading!"), 
+                            bold($value),bold($class),bold($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);
+                msg_dialog::display(_("Warning"), 
+                        sprintf(_("The folder '%s' specified for '%s:%s' does not exists!"), 
+                            bold($value),bold($class),bold($name)), 
+                        WARNING_DIALOG);
             }elseif(!is_writeable($value)){
-                msg_dialog::display(_("Warning"), sprintf(_("The specified folder cannot be used for writing '%s'."), $value), WARNING_DIALOG);
+                msg_dialog::display(_("Warning"), 
+                        sprintf(_("The folder '%s' specified for '%s:%s' cannot be used for writing!"), 
+                            bold($value),bold($class),bold($name)), 
+                        WARNING_DIALOG);
             }
         }
 
@@ -313,9 +435,15 @@ class gosaProperty
         if($message && ! $match){
                 
             if(!is_file($value)){
-                msg_dialog::display(_("Warning"), sprintf(_("The specified file does not exists '%s'."), $value), WARNING_DIALOG);
+                msg_dialog::display(_("Warning"), 
+                        sprintf(_("The file '%s' specified for '%s:%s' does not exists!"), 
+                            bold($value),bold($class),bold($name)), 
+                        WARNING_DIALOG);
             }elseif(!is_readable($value)){
-                msg_dialog::display(_("Warning"), sprintf(_("The specified file cannot be used for reading '%s'."), $value), WARNING_DIALOG);
+                msg_dialog::display(_("Warning"), 
+                        sprintf(_("The file '%s' specified for '%s:%s' cannot be read!"), 
+                            bold($value),bold($class),bold($name)), 
+                        WARNING_DIALOG);
             }
         }
 
@@ -328,7 +456,10 @@ class gosaProperty
 
         // Display the reason for failing this check.         
         if($message && ! $match){
-            msg_dialog::display(_("Warning"), msgPool::cmdinvalid($name,$value),  WARNING_DIALOG);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The command '%s' specified for '%s:%s' is invalid!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
         
         return($match);
@@ -340,7 +471,10 @@ class gosaProperty
 
         // Display the reason for failing this check.         
         if($message && ! $match){
-            msg_dialog::display(_("Warning"), msgPool::invalid($name,$value),  WARNING_DIALOG);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The dn '%s' specified for '%s:%s' is invalid!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
         
         return($match);
@@ -348,11 +482,14 @@ class gosaProperty
 
     static function isRdn($message,$class,$name,$value, $type)
     {
-        $match = preg_match("/^([a-z]*=[^=,]*,)*[^=]*=[^=]*$/i", $value);
+        $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),  WARNING_DIALOG);
+            msg_dialog::display(_("Warning"), 
+                    sprintf(_("The rdn '%s' specified for '%s:%s' is invalid!"), 
+                        bold($value),bold($class),bold($name)), 
+                    WARNING_DIALOG);
         }
         
         return($match);
@@ -360,7 +497,6 @@ class gosaProperty
 
     private function _restoreCurrentValue()
     {
-    
         // First check for values in the LDAP Database.
         if(isset($this->parent->ldapStoredProperties[$this->class][$this->name])){
             $this->setStatus('ldap');
@@ -369,9 +505,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;
         }
 
@@ -405,10 +541,24 @@ class gosaProperty
 
     function getValue($temporary = FALSE) 
     { 
-        if($temporary && in_array($this->getStatus(), array('modified'))){
-            return($this->tmp_value); 
+        if($temporary){
+            if(in_array($this->getStatus(), array('modified','removed'))){
+                return($this->tmp_value); 
+            }else{
+                return($this->value); 
+            }
         }else{ 
-            return($this->value); 
+
+            // Do not return ldap values if we've to ignore them.
+            if($this->parent->ignoreLdapProperties){
+                if(isset($this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)])){
+                    return($this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)]);
+                }else{
+                    return($this->getDefault());
+                }
+            }else{
+                return($this->value); 
+            }
         }
     }
 
@@ -416,8 +566,13 @@ class gosaProperty
     {
         if(in_array($this->getStatus(),array('ldap'))){
             $this->setStatus('removed'); 
-        }elseif(in_array($this->getStatus(),array('modified'))){
-            $this->_restoreCurrentValue();
+
+            // Second check for values in the config file.
+            if(isset($this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)])){
+                $this->tmp_value = $this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)];
+            }else{
+                $this->tmp_value = $this->getDefault();
+            }
         }
     }
 
@@ -444,13 +599,15 @@ class gosaProperty
                 $attrs = $ldap->fetch();
                 $data = array();
                 $found = false;
-                for($i = 0;$i<$attrs['gosaSetting']['count']; $i ++){
-                    $set = $attrs['gosaSetting'][$i];
-                    if(preg_match("/^{$this->name}:/", $set)){
-                        $set = "{$this->name}:{$this->tmp_value}";
-                        $found = true;
+                if(isset($attrs['gosaSetting']['count'])){
+                    for($i = 0;$i<$attrs['gosaSetting']['count']; $i ++){
+                        $set = $attrs['gosaSetting'][$i];
+                        if(preg_match("/^{$this->name}:/", $set)){
+                            $set = "{$this->name}:{$this->tmp_value}";
+                            $found = true;
+                        }
+                        $data['gosaSetting'][] = $set;
                     }
-                    $data['gosaSetting'][] = $set;
                 }
                 if(!$found) $data['gosaSetting'][] = "{$this->name}:{$this->tmp_value}";
                 $ldap->cd($dn);
@@ -458,8 +615,9 @@ class gosaProperty
                 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']);
@@ -498,4 +656,12 @@ class gosaProperty
     }
 }
 
+
+
+interface propertyMigration
+{
+    function __construct($config,$property);
+}
+
+
 ?>