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 schemaCheckFinished()
{
return($this->schemaCheckFinished);
}
function validateSchemata($force = FALSE, $disableIncompatiblePlugins = 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($this->schemaCheckFailed);
// Prepare result array
$this->detectedSchemaIssues = array();
$this->detectedSchemaIssues['missing'] = array();
$this->detectedSchemaIssues['versionMismatch'] = array();
// Clear last results
$this->pluginsDeactivated = array();
// 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'])){
$this->pluginRequirements[$cname] = $defs['plRequirements'];
}
}
// Check schema requirements now $missing = $invalid = array();
foreach($this->pluginRequirements as $cname => $requirements){
// Check LDAP schema requirements for this plugins
$failure = FALSE;
if(isset($requirements['ldapSchema'])){
foreach($requirements['ldapSchema'] as $oc => $version){
if(rand(0,5)==1 || !$this->ocAvailable($oc)){
$this->detectedSchemaIssues['missing'][] = $oc;
$this->schemaCheckFailed = TRUE;
$failure = TRUE;
}elseif(!empty($version)){
$currentVersion = $this->getObjectClassVersion($oc);
if(1 || !empty($currentVersion) && !$this->ocVersionMatch($version, $currentVersion)){
if($currentVersion == -1){
$currentVersion = _("unknown");
}
$this->detectedSchemaIssues['versionMismatch'][] =
sprintf(_("%s has version %s but %s required!"), bold($oc),bold($currentVersion),bold($version));
$this->schemaCheckFailed = TRUE;
$failure = TRUE;
}
}
}
}
// Display corresponding plugins now
if($disableIncompatiblePlugins && $failure && isset($requirements['onFailureDisablePlugin'])){
foreach($requirements['onFailureDisablePlugin'] as $name){
$this->pluginsDeactivated[$name] = $name;
}
}
}
$this->schemaCheckFinished =TRUE;
session::un_set('plist');
return(!$this->schemaCheckFailed);
}
function getDisabledPlugins()
{
return($this->pluginsDeactivated);
}
function displayErrors()
{
$message = "";
if(count($this->detectedSchemaIssues['missing'])){
$message .=
_("The following objectClasses are missing:").
"
".
msgPool::buildList($this->detectedSchemaIssues['missing']).
"
";
}
if(count($this->detectedSchemaIssues['versionMismatch'])){
$message.=
_("The following objectClasses do not match the version requirements:").
"".
msgPool::buildList($this->detectedSchemaIssues['versionMismatch']).
"
";
}
if(count($this->pluginsDeactivated)){
$tmp = array();
foreach($this->pluginsDeactivated as $class){
$tmp[$class] = (isset($this->classToName[$class]))? $this->classToName[$class] : $class;
}
$message.= _("Due to unresolved requirements GOsa will deactivate the following plugins:").
"".
msgPool::buildList($tmp).
"
";
}
if($message != ""){
msg_dialog::display(_("Schema validation error"),$message, ERROR_DIALOG);
}
}
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
// everything loaded and registrered skip the reload.
// Status is 'finished' once we had a ldap connection (logged in)
if(!$force && $this->status == 'finished') return;
// Reset everything
$this->ldapStoredProperties = array();
$this->fileStoredProperties = array();
$this->properties = array();
$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){
// Check if the info is valid
if(isset($info['NAME']) && isset($info['CLASS'])){
// Check if there is nore than just the plugin definition
if(count($info) > 2){
foreach($info as $name => $value){
if(!in_array($name, array('CLASS','NAME'))){
$class= $info['CLASS'];
$this->fileStoredProperties[$class][strtolower($name)] = $value;
}
}
}
}
}
}
// 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();
$ldap->cd($this->config->current['CONFIG']);
$ldap->search('(&(objectClass=gosaConfig)(gosaSetting=*))', array('cn','gosaSetting'));
while($attrs = $ldap->fetch()){
$class = $attrs['cn'][0];
for($i=0; $i<$attrs['gosaSetting']['count']; $i++){
list($name,$value) = preg_split("/:/",$attrs['gosaSetting'][$i],2);
$this->ldapStoredProperties[$class][$name] = $value;
}
}
$this->status = 'finished';
}
// 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);
}
}
}
}
function register($class,$data)
{
$id = count($this->properties);
$this->properties[$id] = new gosaProperty($this,$class,$data);
$p = strtolower("{$class}::{$data['name']}");
$this->mapByName[$p] = $id;
}
public function getAllProperties()
{
return($this->properties);
}
function propertyExists($class,$name)
{
$p = strtolower("{$class}::{$name}");
return(isset($this->mapByName[$p]));
}
private function getId($class,$name)
{
$p = strtolower("{$class}::{$name}");
if(!isset($this->mapByName[$p])){
return(-1);
}
return($this->mapByName[$p]);
}
function getProperty($class,$name)
{
if($this->propertyExists($class,$name)){
return($this->properties[$this->getId($class,$name)]);
}
return(NULL);
}
function getPropertyValue($class,$name)
{
if($this->propertyExists($class,$name)){
$tmp = $this->getProperty($class,$name);
return($tmp->getValue());
}
return("");
}
function setPropertyValue($class,$name, $value)
{
if($this->propertyExists($class,$name)){
$tmp = $this->getProperty($class,$name);
return($tmp->setValue($value));
}
return("");
}
function saveChanges()
{
$migrate = array();
foreach($this->properties as $prop){
// 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);
}
}
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 = "";
protected $mandatory = FALSE;
protected $group = "default";
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
* 'undefined' Property is currently not stored anywhere
* 'modified' Property has been modified (should be saved)
*/
protected $status = 'undefined';
protected $attributes = array('name','type','default','description','check',
'migrate','mandatory','group','defaults');
function __construct($parent,$classname,$data)
{
// Set some basic infos
$this->parent = &$parent;
$this->class = $classname;
$this->data = $data;
// Get all relevant information from the data array (comes from plInfo)
foreach($this->attributes as $aName){
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[strtolower($this->class)][strtolower($this->name)])){
$this->setStatus('file');
$this->value = $this->parent->fileStoredProperties[strtolower($this->class)][strtolower($this->name)];
return;
}
// If there still wasn't found anything then fallback to the default.
if($this->getStatus() == 'undefined'){
$this->value = $this->getDefault();
}
}
function getMigrate() { return($this->migrate); }
function getCheck() { return($this->check); }
function getName() { return($this->name); }
function getClass() { return($this->class); }
function getGroup() { return($this->group); }
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(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()
{
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'];
$ldap->cat($dn);
if(!$ldap->count()){
$ldap->cd($dn);
$data = array(
'cn' => $this->class,
'objectClass' => array('top','gosaConfig'),
'gosaSetting' => $this->name.":".$this->tmp_value);
$ldap->add($data);
if(!$ldap->success()){
echo $ldap->get_error();
}
}else{
$attrs = $ldap->fetch();
$data = array();
$found = false;
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;
}
}
if(!$found) $data['gosaSetting'][] = "{$this->name}:{$this->tmp_value}";
$ldap->cd($dn);
$ldap->modify($data);
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('gosaSetting' => array());
for($i = 0;$i<$attrs['gosaSetting']['count']; $i ++){
$set = $attrs['gosaSetting'][$i];
if(preg_match("/^{$this->name}:/", $set)){
continue;
}
$data['gosaSetting'][] = $set;
}
$ldap->cd($dn);
$ldap->modify($data);
if(!$ldap->success()){
echo $ldap->get_error();
}
$this->_restoreCurrentValue();
}
}
private function setStatus($state)
{
if(!in_array($state, array('ldap','file','undefined','modified','removed'))) {
trigger_error("Unknown property status given '{$state}' for {$this->class}:{$this->name}!");
}else{
$this->status = $state;
}
}
function isValid()
{
return(TRUE);
}
}
interface propertyMigration
{
function __construct($config,$property);
}
?>