![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/gosa-core/include/class_configRegistry.inc b/gosa-core/include/class_configRegistry.inc
index 3e9cb3b275bbc7873ac2148d4252c1c5eb3634c0..8f882a58eb469f8276fa745214e7694f4e4320bd 100644 (file)
public $config = NULL;
public $properties = array();
- public $mapByClass = array();
- public $mapPropertyToClass = array();
public $ldapStoredProperties = array();
public $fileStoredProperties = array();
public $classToName = array();
public $status = 'none';
+ // Excludes property values defined in ldap
+ public $ignoreLdapProperties = FALSE;
+
+ // Contains all classes with plInfo
+ public $classesWithInfo = array();
+ public $pluginRequirements = array();
+ public $categoryToClass = array();
+
+ public $objectClasses = array();
+
+ public $schemaCheckFinished = FALSE;
+
function __construct($config)
{
- restore_error_handler();
$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();
}
+
+ function validateSchemata($force = FALSE, $disableIncompatiblePlugins = FALSE,$displayMessage = FALSE)
+ {
+ // We can check the schemata only with a valid LDAP connection
+ if(empty($this->config->current['CONFIG'])){
+ return(TRUE);
+ }
+
+ // Don't do things twice unless forced
+ if($this->schemaCheckFinished && !$force) return;
+
+ // Read objectClasses from ldap
+ if(!count($this->objectClasses)){
+ $ldap = $this->config->get_ldap_link();
+ $ldap->cd($this->config->current['BASE']);
+ $this->objectClasses = $ldap->get_objectclasses();
+ }
+
+ // Collect required schema infos
+ $this->pluginRequirements = array('ldapSchema' => array());
+ $this->categoryToClass = array();
+ foreach($this->classesWithInfo as $cname => $defs){
+ if(isset($defs['plRequirements']['ldapSchema'])){
+ $this->pluginRequirements['ldapSchema'][$cname] = $defs['plRequirements']['ldapSchema'];
+ }
+ }
+
+ // Check schema requirements now
+ $missing = $invalid = array();
+ foreach($this->pluginRequirements['ldapSchema'] as $cname => $requirements){
+ foreach($requirements as $oc => $version){
+ if(!$this->ocAvailable($oc)){
+ $missing[] = $oc;
+ }elseif(!empty($version)){
+ $currentVersion = $this->getObjectClassVersion($oc);
+ if(!empty($currentVersion) && !$this->ocVersionMatch($version, $currentVersion)){
+ if($currentVersion == -1){
+ $currentVersion = _("unknown");
+ }
+ $invalid[] = sprintf(_("%s has version %s but %s required!"), bold($oc),bold($currentVersion),bold($version));
+ }
+ }
+ }
+ }
+
+ if($displayMessage && count($missing)){
+ msg_dialog::display(_("Schema validation error"),
+ sprintf(_("The following objectClasses are missing! %s"), msgPool::buildList($missing)),
+ ERROR_DIALOG);
+ }
+ if($displayMessage && count($invalid)){
+ msg_dialog::display(_("Schema validation error"),
+ sprintf(_("The following objectClasses do not match the version requirements! %s"), msgPool::buildList($invalid)),
+ ERROR_DIALOG);
+ }
+
+ $this->schemaCheckFinished =TRUE;
+ }
+
+ function ocVersionMatch($required, $installed)
+ {
+ $operator = preg_replace('/^([=<>]*).*$/',"\\1",$required);
+ $required = preg_replace('/^[=<>]*(.*)$/',"\\1",$required);
+ return(version_compare($installed,$required, $operator));
+ }
+
+
+ function getObjectClassVersion($oc)
+ {
+ if(!isset($this->objectClasses[$oc])){
+ return(NULL);
+ }else{
+ $version = -1; // unknown
+ if(preg_match("/(v[^)]*)/", $this->objectClasses[$oc]['DESC'])){
+ $version = preg_replace('/^.*\(v([^)]*)\).*$/',"\\1", $this->objectClasses[$oc]['DESC']);
+ }
+ }
+ return($version);
+ }
+
+
+ // check wheter an objectClass is installed or not.
+ function ocAvailable($name)
+ {
+ return(isset($this->objectClasses[$name]));
+ }
+
+
function reload($force = FALSE)
{
// Do not reload the properties everytime, once we have
$this->ldapStoredProperties = array();
$this->fileStoredProperties = array();
$this->properties = array();
- $this->mapByClass = array();
- $this->mapPropertyToClass = array();
-
- // Search for config flags defined in the config file
+ $this->mapByName = array();
+
+ // Search for config flags defined in the config file (TAB section)
foreach($this->config->data['TABS'] as $tabname => $tabdefs){
foreach($tabdefs as $info){
}
}
+ // 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;
+ }
+
+ // Search for config flags defined in the config file (Current LOCATION section)
+ if(isset($this->config->current)){
+ foreach($this->config->current as $name => $value){
+ $this->fileStoredProperties['core'][strtolower($name)] = $value;
+ }
+ }
+
+ // 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();
}
$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(isset($def['plShortName'])){
- $this->classToName[$cname] = $def['plShortName'];
- $data = array('name' => 'postcreate','type' => 'string');
- $this->register($cname, $data);
- $data = array('name' => 'postremove','type' => 'string');
- $this->register($cname, $data);
- $data = array('name' => 'postmodify','type' => 'string');
- $this->register($cname, $data);
- $data = array('name' => 'checkhook', 'type' => 'string');
- $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);
}
}
}
{
$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()
}
function propertyExists($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)
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();
+ }
+ }
}
+ return($migrate);
}
}
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 = "";
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
protected $status = 'undefined';
protected $attributes = array('name','type','default','description','check',
- 'migrate','mandatory','group');
+ 'migrate','mandatory','group','defaults');
+
+
+
function __construct($parent,$classname,$data)
{
if(isset($data[$aName])){
$this->$aName = $data[$aName];
}
- }
+ }
+
+ // 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"),
+ 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);
+ }
+
+ static function isString($message,$class,$name,$value, $type)
+ {
+ $match = TRUE;
+
+ // Display the reason for failing this check.
+ if($message && ! $match){
+ 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);
+ }
+
+ 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"),
+ 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);
+ }
+
+ static function isPath($message,$class,$name,$value, $type)
+ {
+ $match = preg_match("#^(/[^/]*/){1}#", $value);
+
+ // Display the reason for failing this check.
+ if($message && ! $match){
+ 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 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 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 folder '%s' specified for '%s:%s' cannot be used for writing!"),
+ bold($value),bold($class),bold($name)),
+ 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 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 file '%s' specified for '%s:%s' cannot be read!"),
+ bold($value),bold($class),bold($name)),
+ 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"),
+ sprintf(_("The command '%s' specified for '%s:%s' is invalid!"),
+ bold($value),bold($class),bold($name)),
+ 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"),
+ sprintf(_("The dn '%s' specified for '%s:%s' is invalid!"),
+ bold($value),bold($class),bold($name)),
+ 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"),
+ sprintf(_("The rdn '%s' specified for '%s:%s' is invalid!"),
+ bold($value),bold($class),bold($name)),
+ WARNING_DIALOG);
+ }
+
+ return($match);
+ }
+
+ private function _restoreCurrentValue()
+ {
// First check for values in the LDAP Database.
if(isset($this->parent->ldapStoredProperties[$this->class][$this->name])){
$this->setStatus('ldap');
$this->value = $this->parent->ldapStoredProperties[$this->class][$this->name];
+ return;
}
// Second check for values in the config file.
- if(isset($this->parent->fileStoredProperties[$this->class][$this->name])){
+ if(isset($this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)])){
$this->setStatus('file');
- $this->value = $this->parent->fileStoredProperties[$this->class][$this->name];
+ $this->value = $this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)];
+ return;
}
// If there still wasn't found anything then fallback to the default.
}
}
- function getValue() { return($this->value); }
function getMigrate() { return($this->migrate); }
function getCheck() { return($this->check); }
function getName() { return($this->name); }
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)
{
- $this->setStatus('modified');
- $this->value = $str;
+ if(in_array($this->getStatus(), array('modified'))){
+ $this->tmp_value = $str;
+ }elseif($this->value != $str){
+ $this->setStatus('modified');
+ $this->tmp_value = $str;
+ }
+ }
+
+ function getValue($temporary = FALSE)
+ {
+ if($temporary){
+ if(in_array($this->getStatus(), array('modified','removed'))){
+ return($this->tmp_value);
+ }else{
+ return($this->value);
+ }
+ }else{
+
+ // 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);
+ }
+ }
}
function restoreDefault()
{
- $this->setStatus('removed');
+ if(in_array($this->getStatus(),array('ldap'))){
+ $this->setStatus('removed');
+
+ // 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();
+ }
+ }
}
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'];
if(!$ldap->count()){
$ldap->cd($dn);
$data = array(
- 'cn' => $this->class,
- 'objectClass' => array('top','gosaConfig'),
- 'gosaSetting' => $this->name.":".$this->value);
+ 'cn' => $this->class,
+ 'objectClass' => array('top','gosaConfig'),
+ 'gosaSetting' => $this->name.":".$this->tmp_value);
$ldap->add($data);
- if($ldap->success()){
- $this->status = 'ldap';
- }else{
+ if(!$ldap->success()){
echo $ldap->get_error();
}
+
}else{
$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->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->value}";
+ if(!$found) $data['gosaSetting'][] = "{$this->name}:{$this->tmp_value}";
$ldap->cd($dn);
$ldap->modify($data);
- if($ldap->success()){
- $this->status = 'ldap';
- }else{
+ if(!$ldap->success()){
echo $ldap->get_error();
}
- }
+ }
+ $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']);
$dn = "cn={$this->class},".$this->parent->config->current['CONFIG'];
$ldap->cat($dn);
$attrs = $ldap->fetch();
- $data = array();
+ $data = array('gosaSetting' => array());
for($i = 0;$i<$attrs['gosaSetting']['count']; $i ++){
$set = $attrs['gosaSetting'][$i];
if(preg_match("/^{$this->name}:/", $set)){
}
$ldap->cd($dn);
$ldap->modify($data);
- if($ldap->success()){
- $this->status = 'undefined';
-
- // Second check for values in the config file.
- if(isset($this->parent->fileStoredProperties[$this->class][$this->name])){
- $this->setStatus('file');
- $this->value = $this->parent->fileStoredProperties[$this->class][$this->name];
- }
-
- // If there still wasn't found anything then fallback to the default.
- if($this->getStatus() == 'undefined'){
- $this->value = $this->getDefault();
- }
-
- }else{
+ if(!$ldap->success()){
echo $ldap->get_error();
}
+ $this->_restoreCurrentValue();
}
}
}
}
+
+
+interface propertyMigration
+{
+ function __construct($config,$property);
+}
+
+
?>