include/functions_FAI.inc

   1 <?php
   2
   3 define("DEBUG_FAI_FUNC",FALSE);
   4
   5 /* TEST PHASE .... */
   6
   7 /* Returns all object for the given release.
   8    This function resolves the releases
   9    from base up to the given dn.
  10  */
  11 function get_all_objects_for_given_base($Current_DN,$filter,$detailed = false)
  12 {
  13   global $config;
  14   $ldap = $config->get_ldap_link();
  15   $ldap->cd($config->current['BASE']);
  16   $res = array();
  17   $tmp = array();
  18
  19   if(!is_release_department($Current_DN)) {
  20     return($res);
  21   }
  22
  23   /* Collect some basic informations and initialize some variables */
  24   $base_release       = get_release_dn($Current_DN);
  25   $previous_releases  = array_reverse(get_previous_releases_of_this_release($base_release,true));
  26
  27   /* We must also include the given release dn */
  28   $previous_releases[] = $base_release;
  29
  30   /* Walk through all releases */
  31   foreach($previous_releases as $release){
  32
  33     /* Get fai departments */
  34     $deps_to_search = get_FAI_departments($release);
  35
  36     /* For every single department  (ou=hoos,ou ..) */
  37     foreach($deps_to_search as $fai_base){
  38
  39       /* Ldap search for fai classes specified in this release */
  40       $res_tmp = get_list($filter,"fai",$fai_base,array("dn","objectClass","FAIstate"),GL_SUBSEARCH | GL_SIZELIMIT);
  41
  42       /* check the returned objects, and add/replace them in our return variable */
  43       foreach($res_tmp as $attr){
  44
  45         $buffer = array();
  46         $name = preg_replace("/".normalizePreg($release)."/i","",$attr['dn']);
  47
  48         if(isset($attr['FAIstate'][0])){
  49           if(preg_match("/removed$/",$attr['FAIstate'][0])){
  50             if(isset($res[$name])){
  51               unset($res[$name]);
  52             }
  53             continue;
  54           }
  55         }
  56
  57
  58         /* In detailed mode are some additonal informations visible */
  59         if($detailed){
  60
  61           /* Create list of parents */
  62           if(isset($res[$name])){
  63             $buffer = $res[$name];
  64             $buffer['parents'][] = $res[$name]['dn'];
  65           }else{
  66             $buffer['parents'] = array();
  67           }
  68
  69           /* Append objectClass to resulsts */
  70           $buffer['objectClass']  = $attr['objectClass'];
  71           unset($buffer['objectClass'][0]);
  72         }
  73
  74         /* Add this object to our list */
  75         $buffer['dn']           = $attr['dn'];
  76         $res[$name] = $buffer;
  77       }
  78     }
  79   }
  80   return($res);
  81 }
  82
  83
  84 /* Return all relevant FAI departments */
  85 function get_FAI_departments($suffix = "")
  86 {
  87   $arr = array("hooks","scripts","disk","packages","profiles","templates","variables");
  88   $tmp = array();
  89   if(preg_match("/^,/",$suffix)){
  90     $suffix = preg_replace("/^,/","",$suffix);
  91   }
  92   foreach($arr as $name){
  93     if(empty($suffix)){
  94       $tmp[$name] = "ou=".$name;
  95     }else{
  96       $tmp[$name] = "ou=".$name.",".$suffix;
  97     }
  98   }
  99   return($tmp);
 100 }
 101
 102
 103 /* Return all releases within the given base */
 104 function get_all_releases_from_base($dn,$appendedName=false)
 105 {
 106   global $config;
 107
 108   if(!preg_match("/ou=fai,ou=configs,ou=systems,/",$dn)){
 109     $base = "ou=fai,ou=configs,ou=systems,".$dn;
 110   }else{
 111     $base = $dn;
 112   }
 113   $res = array();
 114
 115   $ldap = $config->get_ldap_link();
 116   $ldap->cd($base);
 117   $ldap->search("(objectClass=FAIbranch)",array("ou","dn"));
 118   while($attrs = $ldap->fetch()){
 119     if($appendedName){
 120       $res[$attrs['dn']] = convert_department_dn(preg_replace("/,ou=fai,ou=configs,ou=system.*$/","",$attrs['dn']));
 121     }else{
 122       $res[$attrs['dn']] = $attrs['ou'][0];
 123     }
 124   }
 125   return($res);
 126 }
 127
 128
 129 /* Add this object to list of objects, that must be checked for release saving */
 130 function prepare_to_save_FAI_object($Current_DN,$objectAttrs,$removed = false)
 131 {
 132   /* Get ldap object */
 133   global $config;
 134   $addObj['Current_DN'] = $Current_DN;
 135   $addObj['objectAttrs']= $objectAttrs;
 136   $addObj['removed']    = $removed;
 137   $addObj['diff']       = TRUE;
 138
 139   if(!$removed){
 140     $ldap = $config->get_ldap_link();
 141     $ldap->cd($config->current['BASE']);
 142
 143     /* Get some basic informations */
 144     $parent_obj   = get_parent_release_object($Current_DN);
 145     if(!empty($parent_obj)){
 146       $ldap->cat($parent_obj,array("*"));
 147       $attrs = prepare_ldap_fetch_to_be_saved($ldap->fetch());
 148
 149       if(!array_diff_FAI( $attrs,$objectAttrs)){
 150         $addObj['diff'] = FALSE;
 151       }
 152     }
 153   }
 154
 155   $_SESSION['FAI_objects_to_save'][$Current_DN] =  $addObj;
 156 }
 157
 158
 159 /* Detect differences in attribute arrays  */
 160 function array_diff_FAI($ar1,$ar2)
 161 {
 162
 163   if((!isset($ar1['description'])) || (isset($ar1['description']) && (count($ar1['description']) == 0))){
 164     $ar1['description'] = "";
 165   }
 166   if((!isset($ar2['description'])) || (isset($ar2['description']) && (count($ar2['description']) == 0))){
 167     $ar2['description'] = "";
 168   }
 169
 170   if(count($ar1) != count($ar2)) {
 171     return (true);
 172   }
 173
 174   foreach($ar1 as $key1 => $val1){
 175
 176     if((is_array($val1)) && (count($val1)==1)){
 177       $ar1[$key1] = $val1[0];
 178     }
 179
 180     if((is_array($ar2[$key1])) && (count($ar2[$key1])==1)){
 181       $val1 = $val1[0];
 182       $ar2[$key1] = $ar2[$key1][0];
 183     }
 184   }
 185   ksort($ar1);
 186   ksort($ar2);
 187   if(count( array_diff($ar1,$ar2)) || arr_diff($ar1,$ar2)){
 188     return(true);
 189   }else{
 190     return(false);
 191   }
 192 }
 193
 194
 195 function arr_diff($ar1,$ar2)
 196 {
 197   foreach($ar1 as $ak1 => $av1){
 198     if(!isset($ar2[$ak1]) || (!($av1 === $ar2[$ak1]))){
 199       return(true);
 200     }elseif(is_array($av1)){
 201       return(arr_diff($av1,$ar2[$ak1]));
 202     }
 203   }
 204   return(FALSE);
 205 }
 206
 207
 208
 209
 210 /* check which objects must be saved, and save them */
 211 function save_release_changes_now()
 212 {
 213   /* Variable init*/
 214   $to_save = array();
 215
 216   /* check which objects must be saved */
 217   foreach($_SESSION['FAI_objects_to_save'] as $Current_DN => $object){
 218     if($object['diff']){
 219       $sub_name = $Current_DN;
 220       while(isset($_SESSION['FAI_objects_to_save'][$sub_name])){
 221         $to_save[strlen($sub_name)][$sub_name] = $_SESSION['FAI_objects_to_save'][$sub_name];
 222         unset($_SESSION['FAI_objects_to_save'][$sub_name]);
 223         $sub_name = preg_replace('/^[^,]+,/', '', $sub_name);
 224       }
 225     }
 226   }
 227
 228   /* Sort list of objects that must be saved, and ensure that
 229       container   objects are safed, before their childs are saved */
 230   ksort($to_save);
 231   $tmp = array();
 232   foreach($to_save as $SubObjects){
 233     foreach($SubObjects as $object){
 234       $tmp[] = $object;
 235     }
 236   }
 237   $to_save = $tmp;
 238
 239   /* Save objects and manage the correct release behavior*/
 240   foreach($to_save as $save){
 241
 242     $Current_DN = $save['Current_DN'];
 243     $removed    = $save['removed'];
 244     $objectAttrs= $save['objectAttrs'];
 245
 246     /* Get ldap object */
 247     global $config;
 248     $ldap = $config->get_ldap_link();
 249     $ldap->cd($config->current['BASE']);
 250
 251     /* Get some basic informations */
 252     $base_release       = get_release_dn($Current_DN);
 253     $sub_releases       = get_sub_releases_of_this_release($base_release,true);
 254     $parent_obj         = get_parent_release_object($Current_DN);
 255     $following_releases = get_sub_releases_of_this_release($base_release,true);
 256
 257     /* Check if given dn exists or if is a new entry */
 258     $ldap->cat($Current_DN);
 259     if(!$ldap->count()){
 260       $is_new = true;
 261     }else{
 262       $is_new = false;
 263     }
 264
 265     /* if parameter removed is true, we have to add FAIstate to the current attrs
 266           FAIstate should end with ...|removed after this operation */
 267     if($removed ){
 268       $ldap->cat($Current_DN);
 269
 270       /* Get current object, because we must add the FAIstate ...|removed */
 271       if((!$ldap->count()) && !empty($parent_obj)){
 272         $ldap->cat($parent_obj);
 273       }
 274
 275       /* Check if we have found a suiteable object */
 276       if(!$ldap->count()){
 277         echo "Error can't remove this object ".$Current_DN;
 278         return;
 279       }else{
 280
 281         /* Set FAIstate to current objectAttrs */
 282         $objectAttrs = prepare_ldap_fetch_to_be_saved($ldap->fetch());
 283         if(isset($objectAttrs['FAIstate'][0])){
 284           if(!preg_match("/removed$/",$objectAttrs['FAIstate'][0])){
 285             $objectAttrs['FAIstate'][0] .= "|removed";
 286           }
 287         }else{
 288           $objectAttrs['FAIstate'][0] = "|removed";
 289         }
 290       }
 291     }
 292
 293     /* Check if this a leaf release or not */
 294     if(count($following_releases) == 0 ){
 295
 296       /* This is a leaf object. It isn't inherited by any other object */
 297       if(DEBUG_FAI_FUNC) {
 298         echo "<b>Saving directly, is a leaf object</b><br> ".$Current_DN;
 299         print_a($objectAttrs);
 300       }
 301       save_FAI_object($Current_DN,$objectAttrs);
 302     }else{
 303
 304       /* This object is inherited by some sub releases */
 305
 306       /* Get all releases, that inherit this object */
 307       $r = get_following_releases_that_inherit_this_object($Current_DN);
 308
 309       /* Get parent object */
 310       $ldap->cat($parent_obj);
 311       $parent_attrs = prepare_ldap_fetch_to_be_saved($ldap->fetch());
 312
 313       /* New objects require special handling */
 314       if($is_new){
 315
 316         /* check if there is already an entry named like this,
 317             in one of our parent releases */
 318         if(!empty($parent_obj)){
 319           if(DEBUG_FAI_FUNC) {
 320             echo "There is already an entry named like this.</b><br>";
 321
 322             echo "<b>Saving main object</b>".$Current_DN;
 323             print_a($objectAttrs);
 324           }
 325           save_FAI_object($Current_DN,$objectAttrs);
 326
 327           foreach($r as $key){
 328             if(DEBUG_FAI_FUNC) {
 329               echo "<b>Saving parent to following release</b> ".$key;
 330               print_a($parent_attrs);
 331             }
 332             save_FAI_object($key,$parent_attrs);
 333           }
 334         }else{
 335
 336           if(DEBUG_FAI_FUNC) {
 337             echo "<b>Saving main object</b>".$Current_DN;
 338             print_a($objectAttrs);
 339           }
 340           save_FAI_object($Current_DN,$objectAttrs);
 341
 342           if(isset($objectAttrs['FAIstate'])){
 343             $objectAttrs['FAIstate'] .= "|removed";
 344           }else{
 345             $objectAttrs['FAIstate'] = "|removed";
 346           }
 347
 348           foreach($r as $key ){
 349             if(DEBUG_FAI_FUNC) {
 350               echo "<b>Create an empty placeholder in follwing release</b> ".$key;
 351               print_a($objectAttrs);
 352             }
 353             save_FAI_object($key,$objectAttrs);
 354           }
 355         }
 356       }else{
 357
 358         /* check if we must patch the follwing release */
 359         if(!empty($r)){
 360           foreach($r as $key ){
 361             if(DEBUG_FAI_FUNC) {
 362               echo "<b>Copy current objects original attributes to next release</b> ".$key;
 363               print_a($parent_attrs);
 364             }
 365             save_FAI_object($key,$parent_attrs);
 366           }
 367         }
 368
 369         if(DEBUG_FAI_FUNC) {
 370           echo "<b>Saving current object</b>".$parent_obj;
 371           print_a($objectAttrs);
 372         }
 373         save_FAI_object($parent_obj,$objectAttrs);
 374
 375         if(($parent_obj != $Current_DN)){
 376           print_red(sprintf(_("Error, following objects should be equal '%s' and '%s'"),$parent_obj,$Current_DN));
 377         }
 378       }
 379     }
 380   }
 381   $_SESSION['FAI_objects_to_save'] = array();
 382 }
 383
 384
 385 /* this function will remove all unused (deleted) objects,
 386     that have no parent object */
 387 function clean_up_releases($Current_DN)
 388 {
 389   global $config;
 390   $ldap = $config->get_ldap_link();
 391   $ldap->cd($config->current['BASE']);
 392
 393   /* Collect some basic informations and initialize some variables */
 394   $base_release       = get_release_dn($Current_DN);
 395   $previous_releases  = array_reverse(get_previous_releases_of_this_release($base_release,true));
 396   $Kill = array();
 397   $Skip = array();
 398
 399   /* We must also include the given release dn */
 400   $previous_releases[] = $base_release;
 401
 402   /* Walk through all releases */
 403   foreach($previous_releases as $release){
 404
 405     /* Get fai departments */
 406     $deps_to_search = get_FAI_departments($release);
 407
 408     /* For every single department  (ou=hoos,ou ..) */
 409     foreach($deps_to_search as $fai_base){
 410
 411       /* Ldap search for fai classes specified in this release */
 412       $ldap->cd($fai_base);
 413       $ldap->search("(objectClass=FAIclass)",array("dn","objectClass","FAIstate"));
 414
 415       /* check the returned objects, and add/replace them in our return variable */
 416       while($attr = $ldap->fetch()){
 417
 418         $buffer = array();
 419 #        $name = str_ireplace($release,"",$attr['dn']);
 420         $name = preg_replace("/".normalizePreg($release)."/i","",$attr['dn']);
 421
 422         if(isset($attr['FAIstate'][0])&&(preg_match("/removed$/",$attr['FAIstate'][0]))){
 423
 424           /* Check if this object is required somehow */
 425           if(!isset($Skip[$name])){
 426             $Kill[$attr['dn']] = $attr['dn'];
 427           }
 428         }else{
 429
 430           /* This object is required (not removed), so do not
 431               delete any following sub releases of this object */
 432           $Skip[$name] = $attr['dn'];
 433         }
 434       }
 435     }
 436   }
 437   return($Kill);
 438 }
 439
 440
 441 /* Remove numeric index and 'count' from ldap->fetch result */
 442 function prepare_ldap_fetch_to_be_saved($attrs)
 443 {
 444   foreach($attrs as $key => $value){
 445     if(is_numeric($key) || ($key == "count") || ($key == "dn")){
 446       unset($attrs[$key]);
 447     }
 448     if(is_array($value) && isset($value['count'])){
 449       unset($attrs[$key]['count']);
 450     }
 451   }
 452   return($attrs);
 453 }
 454
 455
 456 /* Save given attrs to specified dn*/
 457 function save_FAI_object($dn,$attrs)
 458 {
 459   global $config;
 460   $ldap = $config->get_ldap_link();
 461   $ldap->cd($config->current['BASE']);
 462   $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dn));
 463   $ldap->cd($dn);
 464
 465   $ldap->cat($dn,array("dn"));
 466   if($ldap->count()){
 467
 468     /* Remove FAIstate*/
 469     if(!isset($attrs['FAIstate'])){
 470       $attrs['FAIstate'] = array();
 471     }
 472
 473     $ldap->modify($attrs);
 474   }else{
 475
 476     /* Unset description if empty  */
 477     if(empty($attrs['description'])){
 478       unset($attrs['description']);
 479     }
 480
 481     $ldap->add($attrs);
 482   }
 483   show_ldap_error($ldap->get_error(),sprintf(_("Release management failed, can't save '%s'"),$dn));
 484 }
 485
 486
 487 /* Return FAIstate freeze branch or "" for specified release department */
 488 function get_release_tag($dn)
 489 {
 490   global $config;
 491   $ldap = $config->get_ldap_link();
 492   $ldap->cd($dn);
 493   $ldap->cat($dn,array("FAIstate"));
 494
 495   if($ldap->count()){
 496
 497     $attr = $ldap->fetch();
 498     if(isset($attr['FAIstate'][0])){
 499       if(preg_match("/freeze/",$attr['FAIstate'][0])){
 500         return("freeze");
 501       }elseif(preg_match("/branch/",$attr['FAIstate'][0])){
 502         return("branch");
 503       }
 504     }
 505   }
 506   return("");
 507 }
 508
 509
 510 function get_following_releases_that_inherit_this_object($dn)
 511 {
 512   global $config;
 513   $ldap = $config->get_ldap_link();
 514   $ldap->cd($config->current['BASE']);
 515
 516   $ret = array();
 517
 518   /* Get base release */
 519   $base_release = get_release_dn($dn);
 520
 521   /* Get previous release dns */
 522   $sub_releases = get_sub_releases_of_this_release($base_release);
 523
 524   /* Get dn suffix. Example  "FAIvairableEntry=keksdose,FAIvariable=Keksregal," */
 525 #  $dn_suffix = str_ireplace($base_release,"",$dn);
 526   $dn_suffix = preg_replace("/".normalizePreg($base_release)."/i","",$dn);
 527
 528   /* Check if given object also exists whitin one of these releases */
 529   foreach($sub_releases as $p_release => $name){
 530
 531     $check_dn = $dn_suffix.$p_release;
 532
 533     $ldap->cat($check_dn,array("dn","objectClass"));
 534
 535     if($ldap->count()){
 536       //return($ret);
 537     }else{
 538       $ret[$check_dn]=$check_dn;
 539     }
 540   }
 541   return($ret);
 542 }
 543
 544
 545 /* Get previous version of the object dn */
 546 function get_parent_release_object($dn,$include_myself=true)
 547 {
 548   global $config;
 549   $ldap = $config->get_ldap_link();
 550   $ldap->cd($config->current['BASE']);
 551   $previous_releases= array();
 552
 553   /* Get base release */
 554   $base_release = get_release_dn($dn);
 555   if($include_myself){
 556     $previous_releases[] = $base_release;
 557   }
 558
 559   /* Get previous release dns */
 560   $tmp = get_previous_releases_of_this_release($base_release,true);
 561   foreach($tmp as $release){
 562     $previous_releases[] = $release;
 563   }
 564
 565   /* Get dn suffix. Example  "FAIvairableEntry=keksdose,FAIvariable=Keksregal," */
 566 #  $dn_suffix = str_ireplace($base_release,"",$dn);
 567   $dn_suffix = preg_replace("/".normalizePreg($base_release)."/i","",$dn);
 568
 569   /* Check if given object also exists whitin one of these releases */
 570   foreach($previous_releases as $p_release){
 571     $check_dn = $dn_suffix.$p_release;
 572     $ldap->cat($check_dn,array("dn","objectClass"));
 573
 574     if($ldap->count()){
 575       return($check_dn);
 576     }
 577   }
 578   return("");
 579 }
 580
 581
 582 /* return release names of all parent releases */
 583 function get_previous_releases_of_this_release($dn,$flat)
 584 {
 585   global $config;
 586   $ldap = $config->get_ldap_link();
 587   $ldap->cd($config->current['BASE']);
 588   $ret = array();
 589
 590   /* Explode dns into pieces, to be able to build parent dns */
 591   $dns_to_check = gosa_ldap_explode_dn(preg_replace("/".normalizePreg(",".$config->current['BASE'])."/i","",$dn));
 592
 593   if(!is_array($dns_to_check)){
 594     return;
 595   }
 596
 597   /* Unset first entry which represents the given dn */
 598   unset($dns_to_check['count']);
 599   unset($dns_to_check[key($dns_to_check)]);
 600
 601   /* Create dns addresses and check if this dn is a release dn */
 602   $id = 0;
 603   while(count($dns_to_check)){
 604
 605     /* build parent dn */
 606     $new_dn = "";
 607     foreach($dns_to_check as $part){
 608       $new_dn .= $part.",";
 609     }
 610     $new_dn .= $config->current['BASE'];
 611
 612     /* check if this dn is a release */
 613     if(is_release_department($new_dn)){
 614       if($flat){
 615         $ret[$id] = $new_dn;
 616       }else{
 617         $ret = array($new_dn=>$ret);
 618       }
 619       $id ++;
 620     }else{
 621       return($ret);
 622     }
 623     reset($dns_to_check);
 624     unset($dns_to_check[key($dns_to_check)]);
 625   }
 626   return($ret);
 627 }
 628
 629
 630 /* This function returns all sub release names, recursivly  */
 631 function get_sub_releases_of_this_release($dn,$flat = false)
 632 {
 633   global $config;
 634   $res  = array();
 635   $ldap = $config->get_ldap_link();
 636   $ldap->cd($config->current['BASE']);
 637   $ldap->ls("(objectClass=FAIbranch)",$dn,array("objectClass","dn","ou"));
 638   while($attr = $ldap->fetch()){
 639
 640     /* Append department name */
 641     if($flat){
 642       $res[$attr['dn']] = $attr['ou'][0];
 643     }else{
 644       $res[$attr['dn']] = array();
 645     }
 646
 647     /* Get sub release departments of this department */
 648     if(in_array("FAIbranch",$attr['objectClass'])) {
 649       if($flat){
 650         $tmp = get_sub_releases_of_this_release($attr['dn'],$flat);
 651         foreach($tmp as $dn => $value){
 652           $res[$dn]=$value;
 653         }
 654       }else{
 655         $res[$attr['dn']] = get_sub_releases_of_this_release($attr['dn']);
 656       }
 657     }
 658   }
 659   return($res);
 660 }
 661
 662
 663 /* Check if the given department is a release department */
 664 function is_release_department($dn)
 665 {
 666   global $config;
 667   $ldap = $config->get_ldap_link();
 668   $ldap->cd($config->current['BASE']);
 669   $ldap->cat($dn,array("objectClass","ou"));
 670
 671   /* Check objectClasses and name to check if this is a release department */
 672   if($ldap->count()){
 673     $attrs = $ldap->fetch();
 674
 675     $ou = "";
 676     if(isset($attrs['ou'][0])){
 677       $ou = $attrs['ou'][0];
 678     }
 679
 680     if((in_array("FAIbranch",$attrs['objectClass'])) || ($ou == "fai")){
 681       return($attrs['dn']);
 682     }
 683   }
 684   return(false);
 685 }
 686
 687
 688 /* This function returns the dn of the object release */
 689 function get_release_dn($Current_DN)
 690 {
 691   global $config;
 692   $ldap = $config->get_ldap_link();
 693   $ldap->cd($config->current['BASE']);
 694
 695   /* Split dn into pices */
 696   $dns_to_check = gosa_ldap_explode_dn(preg_replace("/".normalizePreg(",".$config->current['BASE'])."/i","",$Current_DN));
 697
 698   if(!is_array($dns_to_check)){
 699     return;
 700   }
 701
 702   /* Use dn pieces, to create sub dns like
 703       ou=test,ou=1,ou=0...
 704               ou=1,ou=0...
 705                    ou=0...
 706     To check which dn is our release container.
 707   */
 708   unset($dns_to_check['count']);
 709   while(count($dns_to_check)){
 710
 711     /* Create dn */
 712     $new_dn = "";
 713     foreach($dns_to_check as $part){
 714       $new_dn .= $part.",";
 715     }
 716     $new_dn .= $config->current['BASE'];
 717
 718     /* Check if this dn is a release dn */
 719     if(is_release_department($new_dn)){
 720       return($new_dn);
 721     }
 722
 723     /* Remove first element of dn pieces */
 724     reset($dns_to_check);
 725     unset($dns_to_check[key($dns_to_check)]);
 726   }
 727   return("");
 728 }
 729
 730 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 731 ?>