Removed fai functions.

-Will be added as class in a few seconds

git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@8361 594d385d-05f5-0310-b6e9-bd551577e9d8

diff --git a/gosa-core/plugins/admin/fai/functions_FAI.inc b/gosa-core/plugins/admin/fai/functions_FAI.inc
deleted file mode 100644 (file)
index 822860a..0000000
--- a/gosa-core/plugins/admin/fai/functions_FAI.inc
+++ /dev/null
@@ -1,742 +0,0 @@
-<?php
-
-define("DEBUG_FAI_FUNC",FALSE);
-
-
-class fai_func
-{
-
-  /* TEST PHASE .... */
-
-  /* Returns all object for the given release.
-     This function resolves the releases  
-     from base up to the given dn.
-   */
-  static function get_all_objects_for_given_base($Current_DN,$filter,$detailed = false)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-    $res = array();
-    $tmp = array();
-
-    if(!fai_func::is_release_department($Current_DN)) {
-      return($res);
-    }
-
-    /* Collect some basic informations and initialize some variables */ 
-    $base_release       = fai_func::get_release_dn($Current_DN);
-    $previous_releases  = array_reverse(fai_func::             get_previous_releases_of_this_release($base_release,true));
-
-    /* We must also include the given release dn */
-    $previous_releases[] = $base_release;
-
-    /* Walk through all releases */
-    foreach($previous_releases as $release){
-
-      /* Get fai departments */
-      $deps_to_search = fai_func::get_FAI_departments($release); 
-
-      /* For every single department  (ou=hoos,ou ..) */
-      foreach($deps_to_search as $fai_base){
-
-        /* Ldap search for fai classes specified in this release */
-        $attributes  = array("dn","objectClass","FAIstate","cn");
-        $res_tmp = get_list($filter,"fai",$fai_base,$attributes,GL_SUBSEARCH | GL_SIZELIMIT);
-
-        /* check the returned objects, and add/replace them in our return variable */
-        foreach($res_tmp as $attr){
-
-          $buffer = array();
-          $name = preg_replace("/".normalizePreg($release)."/i","",$attr['dn']);
-
-          if(isset($attr['FAIstate'][0])){
-            if(preg_match("/removed$/",$attr['FAIstate'][0])){
-              if(isset($res[$name])){
-                unset($res[$name]);
-              }
-              continue;
-            }
-          }
-
-          /* In detailed mode are some additonal informations visible */
-          if($detailed){
-
-            /* Create list of parents */
-            if(isset($res[$name])){
-              $buffer = $res[$name];
-              $buffer['parents'][] = $res[$name]['dn'];
-            }else{
-              $buffer['parents'] = array();
-            }
-
-            /* Append objectClass to resulsts */
-            foreach($attributes as $val){
-              if(isset($attr[$val])){
-                $buffer[$val] = $attr[$val];
-              }
-            }
-            unset($buffer['objectClass']['count']);
-          }
-
-          /* Add this object to our list */
-          $buffer['dn']           = $attr['dn'];
-          $res[$name] = $buffer;
-        }
-      }
-    }
-    return($res);
-  }
-
-
-  /* Return all relevant FAI departments */
-  static function get_FAI_departments($suffix = "")
-  {
-    $arr = array("hooks","scripts","disk","packages","profiles","templates","variables");
-    $tmp = array();
-    if(preg_match("/^,/",$suffix)){
-      $suffix = preg_replace("/^,/","",$suffix);
-    }
-    foreach($arr as $name){
-      if(empty($suffix)){
-        $tmp[$name] = "ou=".$name;
-      }else{
-        $tmp[$name] = "ou=".$name.",".$suffix;
-      }
-    }
-    return($tmp);
-  }
-
-
-  /* Return all releases within the given base */
-  static function get_all_releases_from_base($dn,$appendedName=false)
-  {
-    global $config;
-
-    if(!preg_match("/".normalizePreg(get_ou('faiou'))."/",$dn)){
-      $base = get_ou('faiou').$dn;
-    }else{
-      $base = $dn;
-    }
-    $res = array();  
-
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($base);
-    $ldap->search("(objectClass=FAIbranch)",array("ou","dn"));
-    while($attrs = $ldap->fetch()){
-      if($appendedName){
-        $res[$attrs['dn']] = convert_department_dn(preg_replace("/,".normalizePreg(get_ou('faiou')).".*$/","",$attrs['dn']));
-      }else{
-        $res[$attrs['dn']] = $attrs['ou'][0];
-      }
-    }
-    return($res);
-  }
-
-
-  /* Add this object to list of objects, that must be checked for release saving */
-  static function prepare_to_save_FAI_object($Current_DN,$objectAttrs,$removed = false)
-  {
-    /* Get ldap object */  
-    global $config;
-    $addObj['Current_DN'] = $Current_DN;
-    $addObj['objectAttrs']= $objectAttrs;
-    $addObj['removed']    = $removed;
-    $addObj['diff']       = TRUE;
-
-    if(!$removed){
-      $ldap = $config->get_ldap_link();
-      $ldap->cd($config->current['BASE']);
-
-      /* Get some basic informations */
-      $parent_obj   = fai_func::get_parent_release_object($Current_DN);
-      if(!empty($parent_obj)){
-        $ldap->cat($parent_obj,array("*"));
-        $attrs = fai_func::                           prepare_ldap_fetch_to_be_saved($ldap->fetch());
-
-        if(!fai_func::array_diff_FAI( $attrs,$objectAttrs)){
-          $addObj['diff'] = FALSE;
-        }
-      } 
-    }
-    $FAI_objects_to_save = session::get('FAI_objects_to_save') ;
-    $FAI_objects_to_save[$Current_DN] =  $addObj;
-    session::set('FAI_objects_to_save',$FAI_objects_to_save);
-  }
-
-
-  /* Detect differences in attribute arrays  */
-  static function array_diff_FAI($ar1,$ar2)
-  {
-
-    if((!isset($ar1['description'])) || (isset($ar1['description']) && (count($ar1['description']) == 0))){
-      $ar1['description'] = "";
-    }
-    if((!isset($ar2['description'])) || (isset($ar2['description']) && (count($ar2['description']) == 0))){
-      $ar2['description'] = "";
-    }
-
-    if(count($ar1) != count($ar2)) {
-      return (true);
-    }
-
-    foreach($ar1 as $key1 => $val1){
-
-      if((is_array($val1)) && (count($val1)==1)){
-        $ar1[$key1] = $val1[0];
-      }
-
-      if((is_array($ar2[$key1])) && (count($ar2[$key1])==1)){
-        $val1 = $val1[0];
-        $ar2[$key1] = $ar2[$key1][0];
-      }
-    }
-    ksort($ar1);
-    ksort($ar2);
-    if(count( array_diff($ar1,$ar2)) || fai_func::arr_diff($ar1,$ar2)){
-      return(true);
-    }else{
-      return(false);
-    }
-  }
-
-
-  static function arr_diff($ar1,$ar2)
-  {
-    foreach($ar1 as $ak1 => $av1){
-      if(!isset($ar2[$ak1]) || (!($av1 === $ar2[$ak1]))){
-        return(true);
-      }elseif(is_array($av1)){
-        return(fai_func::arr_diff($av1,$ar2[$ak1]));
-      }
-    }
-    return(FALSE);
-  }
-
-
-
-
-  /* check which objects must be saved, and save them */
-  static function save_release_changes_now()
-  {
-    /* Variable init*/
-    $to_save = array();
-
-    /* check which objects must be saved */
-    $FAI_objects_to_save = session::get('FAI_objects_to_save');
-    foreach($FAI_objects_to_save as $Current_DN => $object){
-      if($object['diff']){
-        $sub_name = $Current_DN;
-        while(isset($FAI_objects_to_save[$sub_name])){
-          $to_save[strlen($sub_name)][$sub_name] = $FAI_objects_to_save[$sub_name]; 
-          unset($FAI_objects_to_save[$sub_name]);
-          $sub_name = preg_replace('/^[^,]+,/', '', $sub_name);
-        }
-      }
-    }
-    session::set('FAI_objects_to_save',$FAI_objects_to_save);
-
-    /* Sort list of objects that must be saved, and ensure that 
-       container   objects are safed, before their childs are saved */
-    ksort($to_save);
-    $tmp = array();
-    foreach($to_save as $SubObjects){
-      foreach($SubObjects as $object){
-        $tmp[] = $object;
-      }
-    }
-    $to_save = $tmp;
-
-    /* Save objects and manage the correct release behavior*/
-    foreach($to_save as $save){
-
-      $Current_DN = $save['Current_DN'];
-      $removed    = $save['removed'];
-      $objectAttrs= $save['objectAttrs'];
-
-      /* Get ldap object */ 
-      global $config;
-      $ldap = $config->get_ldap_link();
-      $ldap->cd($config->current['BASE']);
-
-      /* Get some basic informations */
-      $base_release       = fai_func::get_release_dn($Current_DN);
-      $sub_releases       = fai_func::                       get_sub_releases_of_this_release($base_release,true);
-      $parent_obj         = fai_func::get_parent_release_object($Current_DN);
-      $following_releases = fai_func::                       get_sub_releases_of_this_release($base_release,true);
-
-      /* Check if given dn exists or if is a new entry */
-      $ldap->cat($Current_DN);
-      if(!$ldap->count()){
-        $is_new = true;
-      }else{
-        $is_new = false;
-      }
-
-      /* if parameter removed is true, we have to add FAIstate to the current attrs 
-         FAIstate should end with ...|removed after this operation */  
-      if($removed ){
-        $ldap->cat($Current_DN);
-
-        /* Get current object, because we must add the FAIstate ...|removed */
-        if((!$ldap->count()) && !empty($parent_obj)){
-          $ldap->cat($parent_obj);
-        }
-
-        /* Check if we have found a suiteable object */ 
-        if(!$ldap->count()){
-          echo "Error can't remove this object ".$Current_DN;
-          return;
-        }else{
-
-          /* Set FAIstate to current objectAttrs */
-          $objectAttrs = fai_func::                           prepare_ldap_fetch_to_be_saved($ldap->fetch());
-          if(isset($objectAttrs['FAIstate'][0])){
-            if(!preg_match("/removed$/",$objectAttrs['FAIstate'][0])){
-              $objectAttrs['FAIstate'][0] .= "|removed";
-            }
-          }else{
-            $objectAttrs['FAIstate'][0] = "|removed";
-          }
-        }
-      }
-
-      /* Check if this a leaf release or not */ 
-      if(count($following_releases) == 0 ){
-
-        /* This is a leaf object. It isn't inherited by any other object */    
-        if(DEBUG_FAI_FUNC) { 
-          echo "<b>Saving directly, is a leaf object</b><br> ".$Current_DN;
-          print_a($objectAttrs);
-        }
-        fai_func::save_FAI_object($Current_DN,$objectAttrs);
-      }else{
-
-        /* This object is inherited by some sub releases */  
-
-        /* Get all releases, that inherit this object */ 
-        $r = get_following_releases_that_inherit_this_object($Current_DN);
-
-        /* Get parent object */
-        $ldap->cat($parent_obj);
-        $parent_attrs = fai_func::                           prepare_ldap_fetch_to_be_saved($ldap->fetch());
-
-        /* New objects require special handling */
-        if($is_new){
-
-          /* check if there is already an entry named like this,
-             in one of our parent releases */
-          if(!empty($parent_obj)){
-            if(DEBUG_FAI_FUNC) { 
-              echo "There is already an entry named like this.</b><br>";
-
-              echo "<b>Saving main object</b>".$Current_DN;
-              print_a($objectAttrs);
-            }    
-            fai_func::save_FAI_object($Current_DN,$objectAttrs);
-
-            foreach($r as $key){
-              if(DEBUG_FAI_FUNC) { 
-                echo "<b>Saving parent to following release</b> ".$key;
-                print_a($parent_attrs);
-              }
-              fai_func::save_FAI_object($key,$parent_attrs);
-            }
-          }else{
-
-            if(DEBUG_FAI_FUNC) { 
-              echo "<b>Saving main object</b>".$Current_DN;
-              print_a($objectAttrs);
-            }
-            fai_func::save_FAI_object($Current_DN,$objectAttrs);
-
-            if(isset($objectAttrs['FAIstate'])){
-              $objectAttrs['FAIstate'] .= "|removed"; 
-            }else{
-              $objectAttrs['FAIstate'] = "|removed";
-            }
-
-            foreach($r as $key ){
-              if(DEBUG_FAI_FUNC) { 
-                echo "<b>Create an empty placeholder in follwing release</b> ".$key; 
-                print_a($objectAttrs);
-              }
-              fai_func::save_FAI_object($key,$objectAttrs);
-            }
-          }
-        }else{
-
-          /* check if we must patch the follwing release */
-          if(!empty($r)){
-            foreach($r as $key ){
-              if(DEBUG_FAI_FUNC) { 
-                echo "<b>Copy current objects original attributes to next release</b> ".$key;
-                print_a($parent_attrs);
-              }
-              fai_func::save_FAI_object($key,$parent_attrs);
-            }
-          }
-
-          if(DEBUG_FAI_FUNC) { 
-            echo "<b>Saving current object</b>".$parent_obj;
-            print_a($objectAttrs);
-          }
-          fai_func::save_FAI_object($parent_obj,$objectAttrs);
-
-          if(($parent_obj != $Current_DN)){
-            msg_dialog::display(_("Error"), sprintf(_("Error, following objects should be equal '%s' and '%s'"),$parent_obj,$Current_DN), ERROR_DIALOG);
-          }
-        }
-      }
-    } 
-    session::set('FAI_objects_to_save',array());
-  }
-
-
-  /* this function will remove all unused (deleted) objects,
-     that have no parent object */
-  static function clean_up_releases($Current_DN)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-
-    /* Collect some basic informations and initialize some variables */ 
-    $base_release       = fai_func::get_release_dn($Current_DN);
-    $previous_releases  = array_reverse(fai_func::             get_previous_releases_of_this_release($base_release,true));
-    $Kill = array();
-    $Skip = array();
-
-    /* We must also include the given release dn */
-    $previous_releases[] = $base_release;
-
-    /* Walk through all releases */
-    foreach($previous_releases as $release){
-
-      /* Get fai departments */
-      $deps_to_search = fai_func::get_FAI_departments($release); 
-
-      /* For every single department  (ou=hoos,ou ..) */
-      foreach($deps_to_search as $fai_base){
-
-        /* Ldap search for fai classes specified in this release */
-        $ldap->cd($fai_base);
-        $ldap->search("(objectClass=FAIclass)",array("dn","objectClass","FAIstate"));
-
-        /* check the returned objects, and add/replace them in our return variable */
-        while($attr = $ldap->fetch()){
-
-          $buffer = array();
-#        $name = str_ireplace($release,"",$attr['dn']);
-          $name = preg_replace("/".normalizePreg($release)."/i","",$attr['dn']);
-
-          if(isset($attr['FAIstate'][0])&&(preg_match("/removed$/",$attr['FAIstate'][0]))){
-
-            /* Check if this object is required somehow */    
-            if(!isset($Skip[$name])){
-              $Kill[$attr['dn']] = $attr['dn'];
-            }
-          }else{
-
-            /* This object is required (not removed), so do not 
-               delete any following sub releases of this object */
-            $Skip[$name] = $attr['dn'];
-          }
-        }
-      }
-    }
-    return($Kill);
-  }
-
-
-  /* Remove numeric index and 'count' from ldap->fetch result */
-  static function prepare_ldap_fetch_to_be_saved($attrs)
-  {
-    foreach($attrs as $key => $value){
-      if(is_numeric($key) || ($key == "count") || ($key == "dn")){
-        unset($attrs[$key]);
-      }
-      if(is_array($value) && isset($value['count'])){
-        unset($attrs[$key]['count']);
-      }
-    }
-    return($attrs);
-  }
-
-
-  /* Save given attrs to specified dn*/
-  static function save_FAI_object($dn,$attrs)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-    $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dn));
-    $ldap->cd($dn);
-
-    $ldap->cat($dn,array("dn"));
-    if($ldap->count()){
-
-      /* Remove FAIstate*/
-      if(!isset($attrs['FAIstate'])){
-        $attrs['FAIstate'] = array();
-      }
-
-      $ldap->modify($attrs);
-    }else{
-
-      /* Unset description if empty  */
-      if(empty($attrs['description'])){
-        unset($attrs['description']);
-      }    
-
-      $ldap->add($attrs);
-    }
-    show_ldap_error($ldap->get_error(),sprintf(_("Release management failed, can't save '%s'"),$dn));
-  }
-
-
-  /* Return FAIstate freeze branch or "" for specified release department */
-  static function get_release_tag($dn)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($dn);
-    $ldap->cat($dn,array("FAIstate"));
-
-    if($ldap->count()){
-
-      $attr = $ldap->fetch();
-      if(isset($attr['FAIstate'][0])){
-        if(preg_match("/freeze/",$attr['FAIstate'][0])){
-          return("freeze");
-        }elseif(preg_match("/branch/",$attr['FAIstate'][0])){
-          return("branch");
-        }
-      }
-    }
-    return("");
-  }
-
-
-  static function get_following_releases_that_inherit_this_object($dn)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-
-    $ret = array();
-
-    /* Get base release */
-    $base_release = fai_func::get_release_dn($dn);
-
-    /* Get previous release dns */
-    $sub_releases = fai_func::                       get_sub_releases_of_this_release($base_release);
-
-    /* Get dn suffix. Example  "FAIvairableEntry=keksdose,FAIvariable=Keksregal," */
-#  $dn_suffix = str_ireplace($base_release,"",$dn);
-    $dn_suffix = preg_replace("/".normalizePreg($base_release)."/i","",$dn);
-
-    /* Check if given object also exists whitin one of these releases */
-    foreach($sub_releases as $p_release => $name){
-
-      $check_dn = $dn_suffix.$p_release;
-
-      $ldap->cat($check_dn,array("dn","objectClass"));
-
-      if($ldap->count()){
-        //return($ret);
-      }else{
-        $ret[$check_dn]=$check_dn;
-      }
-    }
-    return($ret);
-  }
-
-
-  /* Get previous version of the object dn */
-  static function get_parent_release_object($dn,$include_myself=true)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-    $previous_releases= array();
-
-    /* Get base release */
-    $base_release = fai_func::get_release_dn($dn);
-    if($include_myself){
-      $previous_releases[] = $base_release;  
-    }
-
-    /* Get previous release dns */
-    $tmp = fai_func::             get_previous_releases_of_this_release($base_release,true);
-    foreach($tmp as $release){
-      $previous_releases[] = $release;
-    }
-
-    /* Get dn suffix. Example  "FAIvairableEntry=keksdose,FAIvariable=Keksregal," */
-#  $dn_suffix = str_ireplace($base_release,"",$dn);
-    $dn_suffix = preg_replace("/".normalizePreg($base_release)."/i","",$dn);
-
-    /* Check if given object also exists whitin one of these releases */
-    foreach($previous_releases as $p_release){
-      $check_dn = $dn_suffix.$p_release;
-      $ldap->cat($check_dn,array("dn","objectClass"));
-
-      if($ldap->count()){
-        return($check_dn);
-      }
-    }
-    return("");
-  }
-
-
-  /* return release names of all parent releases */
-  static function get_previous_releases_of_this_release($dn,$flat)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-    $ret = array();
-
-    /* Explode dns into pieces, to be able to build parent dns */
-    $dns_to_check = gosa_ldap_explode_dn(preg_replace("/".normalizePreg(",".$config->current['BASE'])."/i","",$dn));
-
-    if(!is_array($dns_to_check)){
-      return;  
-    }
-
-    /* Unset first entry which represents the given dn */
-    unset($dns_to_check['count']); 
-    unset($dns_to_check[key($dns_to_check)]);
-
-    /* Create dns addresses and check if this dn is a release dn */
-    $id = 0;
-    while(count($dns_to_check)){
-
-      /* build parent dn */
-      $new_dn = "";
-      foreach($dns_to_check as $part){
-        $new_dn .= $part.",";
-      }
-      $new_dn .= $config->current['BASE'];
-
-      /* check if this dn is a release */
-      if(fai_func::is_release_department($new_dn)){
-        if($flat){
-          $ret[$id] = $new_dn; 
-        }else{
-          $ret = array($new_dn=>$ret); 
-        }
-        $id ++;
-      }else{
-        return($ret);
-      }
-      reset($dns_to_check);
-      unset($dns_to_check[key($dns_to_check)]);
-    }
-    return($ret);
-  } 
-
-
-  /* This function returns all sub release names, recursivly  */
-  static function get_sub_releases_of_this_release($dn,$flat = false)
-  {
-    global $config;
-    $res  = array();
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-    $ldap->ls("(objectClass=FAIbranch)",$dn,array("objectClass","dn","ou"));
-    while($attr = $ldap->fetch()){
-
-      /* Append department name */
-      if($flat){
-        $res[$attr['dn']] = $attr['ou'][0];
-      }else{
-        $res[$attr['dn']] = array();
-      }
-
-      /* Get sub release departments of this department */
-      if(in_array("FAIbranch",$attr['objectClass'])) {
-        if($flat){
-          $tmp = fai_func::                       get_sub_releases_of_this_release($attr['dn'],$flat);
-          foreach($tmp as $dn => $value){
-            $res[$dn]=$value;
-          }
-        }else{
-          $res[$attr['dn']] = fai_func::                       get_sub_releases_of_this_release($attr['dn']);
-        }
-      }
-    }
-    return($res);
-  }
-
-
-  /* Check if the given department is a release department */
-  static function is_release_department($dn)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-    $ldap->cat($dn,array("objectClass","ou"));
-
-    /* Check objectClasses and name to check if this is a release department */
-    if($ldap->count()){
-      $attrs = $ldap->fetch();
-
-      $ou = "";
-      if(isset($attrs['ou'][0])){
-        $ou = $attrs['ou'][0]; 
-      }
-
-      if((in_array("FAIbranch",$attrs['objectClass'])) || ($ou == "fai")){
-        return($attrs['dn']);
-      }
-    }
-    return(false);
-  }
-
-
-  /* This function returns the dn of the object release */
-  static function get_release_dn($Current_DN)
-  {
-    global $config;
-    $ldap = $config->get_ldap_link();
-    $ldap->cd($config->current['BASE']);
-
-    /* Split dn into pices */ 
-    $dns_to_check = gosa_ldap_explode_dn(preg_replace("/".normalizePreg(",".$config->current['BASE'])."/i","",$Current_DN));
-
-    if(!is_array($dns_to_check)){
-      return;  
-    }
-
-    /* Use dn pieces, to create sub dns like 
-       ou=test,ou=1,ou=0...
-       ou=1,ou=0...
-       ou=0... 
-       To check which dn is our release container.
-     */
-    unset($dns_to_check['count']); 
-    while(count($dns_to_check)){
-
-      /* Create dn */
-      $new_dn = "";
-      foreach($dns_to_check as $part){
-        $new_dn .= $part.",";
-      }
-      $new_dn .= $config->current['BASE'];
-
-      /* Check if this dn is a release dn */
-      if(fai_func::is_release_department($new_dn)){
-        return($new_dn);
-      }
-
-      /* Remove first element of dn pieces */
-      reset($dns_to_check);
-      unset($dns_to_check[key($dns_to_check)]);
-    }
-    return("");
-  }
-}
-// vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
-?>