gosa-core/include/class_ldap.inc

   1 <?php
   2 /*
   3  * This code is part of GOsa (http://www.gosa-project.org)
   4  * Copyright (C) 2003-2008 GONICUS GmbH
   5  * Copyright (C) 2003 Alejandro Escanero Blanco <aescanero@chaosdimension.org>
   6  * Copyright (C) 1998  Eric Kilfoil <eric@ipass.net>
   7  *
   8  * ID: $$Id$$
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 define("ALREADY_EXISTING_ENTRY",-10001);
  26 define("UNKNOWN_TOKEN_IN_LDIF_FILE",-10002);
  27 define("NO_FILE_UPLOADED",10003);
  28 define("INSERT_OK",10000);
  29 define("SPECIALS_OVERRIDE", TRUE);
  30
  31 class LDAP{
  32
  33   var $hascon   =false;
  34   var $reconnect=false;
  35   var $tls      = false;
  36   var $cid;
  37   var $hasres   = array();
  38   var $sr       = array();
  39   var $re       = array();
  40   var $basedn   ="";
  41   var $start    = array(); // 0 if we are fetching the first entry, otherwise 1
  42   var $error    = ""; // Any error messages to be returned can be put here
  43   var $srp      = 0;
  44   var $objectClasses = array(); // Information read from slapd.oc.conf
  45   var $binddn   = "";
  46   var $bindpw   = "";
  47   var $hostname = "";
  48   var $follow_referral = FALSE;
  49   var $referrals= array();
  50   var $max_ldap_query_time = 0;   // 0, empty or negative values will disable this check
  51
  52   function LDAP($binddn,$bindpw, $hostname, $follow_referral= FALSE, $tls= FALSE)
  53   {
  54     global $config;
  55     $this->follow_referral= $follow_referral;
  56     $this->tls=$tls;
  57     $this->binddn=LDAP::convert($binddn);
  58
  59     $this->bindpw=$bindpw;
  60     $this->hostname=$hostname;
  61
  62     /* Check if MAX_LDAP_QUERY_TIME is defined */
  63     if(is_object($config) && $config->get_cfg_value("ldapMaxQueryTime") != ""){
  64       $str = $config->get_cfg_value("ldapMaxQueryTime");
  65       $this->max_ldap_query_time = (float)($str);
  66     }
  67
  68     $this->connect();
  69   }
  70
  71
  72   function getSearchResource()
  73   {
  74     $this->sr[$this->srp]= NULL;
  75     $this->start[$this->srp]= 0;
  76     $this->hasres[$this->srp]= false;
  77     return $this->srp++;
  78   }
  79
  80
  81   /* Function to replace all problematic characters inside a DN by \001XX, where
  82      \001 is decoded to chr(1) [ctrl+a]. It is not impossible, but very unlikely
  83      that this character is inside a DN.
  84
  85      Currently used codes:
  86      ,   => CO
  87      \2C => CO
  88      (   => OB
  89      )   => CB
  90      /   => SL
  91      \22 => DQ                                                                  */
  92   static function convert($dn)
  93   {
  94     if (SPECIALS_OVERRIDE == TRUE){
  95       $tmp= preg_replace(array("/\\\\,/", "/\\\\2C/", "/\(/", "/\)/", "/\//", "/\\\\22/", '/\\\\"/'),
  96           array("\001CO", "\001CO", "\001OB", "\001CB", "\001SL", "\001DQ", "\001DQ"),
  97           $dn);
  98       return (preg_replace('/,\s+/', ',', $tmp));
  99     } else {
 100       return ($dn);
 101     }
 102   }
 103
 104
 105   /* Function to fix all problematic characters inside a DN by replacing \001XX
 106      codes to their original values. See "convert" for mor information.
 107      ',' characters are always expanded to \, (not \2C), since all tested LDAP
 108      servers seem to take it the correct way.                                  */
 109   static function fix($dn)
 110   {
 111     if (SPECIALS_OVERRIDE == TRUE){
 112       return (preg_replace(array("/\001CO/", "/\001OB/", "/\001CB/", "/\001SL/", "/\001DQ/"),
 113             array("\,", "(", ")", "/", '\"'),
 114             $dn));
 115     } else {
 116       return ($dn);
 117     }
 118   }
 119
 120   /* Function to fix problematic characters in DN's that are used for search
 121      requests. I.e. member=....                                               */
 122   static function prepare4filter($dn)
 123   {
 124     $fixed= normalizeLdap(str_replace('\\\\', '\\\\\\', LDAP::fix($dn)));
 125     return str_replace('\\,', '\\\\,', $fixed);
 126   }
 127
 128
 129   function connect()
 130   {
 131     $this->hascon=false;
 132     $this->reconnect=false;
 133     if ($this->cid= @ldap_connect($this->hostname)) {
 134       @ldap_set_option($this->cid, LDAP_OPT_PROTOCOL_VERSION, 3);
 135       if (function_exists("ldap_set_rebind_proc") && $this->follow_referral) {
 136         @ldap_set_option($this->cid, LDAP_OPT_REFERRALS, 1);
 137         @ldap_set_rebind_proc($this->cid, array(&$this, "rebind"));
 138       }
 139       if (function_exists("ldap_start_tls") && $this->tls){
 140         @ldap_start_tls($this->cid);
 141       }
 142
 143       $this->error = "No Error";
 144       if ($bid = @ldap_bind($this->cid, LDAP::fix($this->binddn), $this->bindpw)) {
 145         $this->error = "Success";
 146         $this->hascon=true;
 147       } else {
 148         if ($this->reconnect){
 149           if ($this->error != "Success"){
 150             $this->error = "Could not rebind to " . $this->binddn;
 151           }
 152         } else {
 153           $this->error = "Could not bind to " . $this->binddn;
 154         }
 155       }
 156     } else {
 157       $this->error = "Could not connect to LDAP server";
 158     }
 159   }
 160
 161   function rebind($ldap, $referral)
 162   {
 163     $credentials= $this->get_credentials($referral);
 164     if (@ldap_bind($ldap, LDAP::fix($credentials['ADMINDN']), $credentials['ADMINPASSWORD'])) {
 165       $this->error = "Success";
 166       $this->hascon=true;
 167       $this->reconnect= true;
 168       return (0);
 169     } else {
 170       $this->error = "Could not bind to " . $credentials['ADMINDN'];
 171       return NULL;
 172     }
 173   }
 174
 175   function reconnect()
 176   {
 177     if ($this->reconnect){
 178       @ldap_unbind($this->cid);
 179       $this->cid = NULL;
 180     }
 181   }
 182
 183   function unbind()
 184   {
 185     @ldap_unbind($this->cid);
 186     $this->cid = NULL;
 187   }
 188
 189   function disconnect()
 190   {
 191     if($this->hascon){
 192       @ldap_close($this->cid);
 193       $this->hascon=false;
 194     }
 195   }
 196
 197   function cd($dir)
 198   {
 199     if ($dir == ".."){
 200       $this->basedn = $this->getParentDir();
 201     } else {
 202       $this->basedn = LDAP::convert($dir);
 203     }
 204   }
 205
 206   function getParentDir($basedn = "")
 207   {
 208     if ($basedn==""){
 209       $basedn = $this->basedn;
 210     } else {
 211       $basedn = LDAP::convert($basedn);
 212     }
 213     return(preg_replace("/[^,]*[,]*[ ]*(.*)/", "$1", $basedn));
 214   }
 215
 216
 217   function search($srp, $filter, $attrs= array())
 218   {
 219     if($this->hascon){
 220       if ($this->reconnect) $this->connect();
 221
 222       $start = microtime(true);
 223       $this->clearResult($srp);
 224       $this->sr[$srp] = @ldap_search($this->cid, LDAP::fix($this->basedn), $filter, $attrs);
 225       $this->error = @ldap_error($this->cid);
 226       $this->resetResult($srp);
 227       $this->hasres[$srp]=true;
 228
 229       /* Check if query took longer as specified in max_ldap_query_time */
 230       if($this->max_ldap_query_time){
 231         $diff = microtime(true) - $start;
 232         if($diff > $this->max_ldap_query_time){
 233           msg_dialog::display(_("Performance warning"), sprintf(_("LDAP performance is poor: last query took about %.2fs!"), $diff), WARNING_DIALOG);
 234         }
 235       }
 236
 237       $this->log("LDAP operation: time=".(microtime(true)-$start)." operation=search('".LDAP::fix($this->basedn)."', '$filter')");
 238       return($this->sr[$srp]);
 239     }else{
 240       $this->error = "Could not connect to LDAP server";
 241       return("");
 242     }
 243   }
 244
 245   function ls($srp, $filter = "(objectclass=*)", $basedn = "",$attrs = array("*"))
 246   {
 247     if($this->hascon){
 248       if ($this->reconnect) $this->connect();
 249
 250       $this->clearResult($srp);
 251       if ($basedn == "")
 252         $basedn = $this->basedn;
 253       else
 254         $basedn= LDAP::convert($basedn);
 255
 256       $start = microtime(true);
 257       $this->sr[$srp] = @ldap_list($this->cid, LDAP::fix($basedn), $filter,$attrs);
 258       $this->error = @ldap_error($this->cid);
 259       $this->resetResult($srp);
 260       $this->hasres[$srp]=true;
 261
 262        /* Check if query took longer as specified in max_ldap_query_time */
 263       if($this->max_ldap_query_time){
 264         $diff = microtime(true) - $start;
 265         if($diff > $this->max_ldap_query_time){
 266           msg_dialog::display(_("Performance warning"), sprintf(_("LDAP performance is poor: last query took about %.2fs!"), $diff), WARNING_DIALOG);
 267         }
 268       }
 269
 270       $this->log("LDAP operation: time=".(microtime(true) - $start)." operation=ls('".LDAP::fix($basedn)."', '$filter')");
 271
 272       return($this->sr[$srp]);
 273     }else{
 274       $this->error = "Could not connect to LDAP server";
 275       return("");
 276     }
 277   }
 278
 279   function cat($srp, $dn,$attrs= array("*"), $filter = "(objectclass=*)")
 280   {
 281     if($this->hascon){
 282       if ($this->reconnect) $this->connect();
 283
 284       $this->clearResult($srp);
 285       $this->sr[$srp] = @ldap_read($this->cid, LDAP::fix($dn), $filter,$attrs);
 286       $this->error = @ldap_error($this->cid);
 287       $this->resetResult($srp);
 288       $this->hasres[$srp]=true;
 289       return($this->sr[$srp]);
 290     }else{
 291       $this->error = "Could not connect to LDAP server";
 292       return("");
 293     }
 294   }
 295
 296   function object_match_filter($dn,$filter)
 297   {
 298     if($this->hascon){
 299       if ($this->reconnect) $this->connect();
 300       $res =  @ldap_read($this->cid, LDAP::fix($dn), $filter, array("objectClass"));
 301       $rv =   @ldap_count_entries($this->cid, $res);
 302       return($rv);
 303     }else{
 304       $this->error = "Could not connect to LDAP server";
 305       return(FALSE);
 306     }
 307   }
 308
 309   function set_size_limit($size)
 310   {
 311     /* Ignore zero settings */
 312     if ($size == 0){
 313       @ldap_set_option($this->cid, LDAP_OPT_SIZELIMIT, 10000000);
 314     }
 315     if($this->hascon){
 316       @ldap_set_option($this->cid, LDAP_OPT_SIZELIMIT, $size);
 317     } else {
 318       $this->error = "Could not connect to LDAP server";
 319     }
 320   }
 321
 322   function fetch($srp)
 323   {
 324     $att= array();
 325     if($this->hascon){
 326       if($this->hasres[$srp]){
 327         if ($this->start[$srp] == 0)
 328         {
 329           if ($this->sr[$srp]){
 330             $this->start[$srp] = 1;
 331             $this->re[$srp]= @ldap_first_entry($this->cid, $this->sr[$srp]);
 332           } else {
 333             return array();
 334           }
 335         } else {
 336           $this->re[$srp]= @ldap_next_entry($this->cid, $this->re[$srp]);
 337         }
 338         if ($this->re[$srp])
 339         {
 340           $att= @ldap_get_attributes($this->cid, $this->re[$srp]);
 341           $att['dn']= trim(LDAP::convert(@ldap_get_dn($this->cid, $this->re[$srp])));
 342         }
 343         $this->error = @ldap_error($this->cid);
 344         if (!isset($att)){
 345           $att= array();
 346         }
 347         return($att);
 348       }else{
 349         $this->error = "Perform a fetch with no search";
 350         return("");
 351       }
 352     }else{
 353       $this->error = "Could not connect to LDAP server";
 354       return("");
 355     }
 356   }
 357
 358   function resetResult($srp)
 359   {
 360     $this->start[$srp] = 0;
 361   }
 362
 363   function clearResult($srp)
 364   {
 365     if($this->hasres[$srp]){
 366       $this->hasres[$srp] = false;
 367       @ldap_free_result($this->sr[$srp]);
 368     }
 369   }
 370
 371   function getDN($srp)
 372   {
 373     if($this->hascon){
 374       if($this->hasres[$srp]){
 375
 376         if(!$this->re[$srp])
 377           {
 378           $this->error = "Perform a Fetch with no valid Result";
 379           }
 380           else
 381           {
 382           $rv = @ldap_get_dn($this->cid, $this->re[$srp]);
 383
 384           $this->error = @ldap_error($this->cid);
 385           return(trim(LDAP::convert($rv)));
 386            }
 387       }else{
 388         $this->error = "Perform a Fetch with no Search";
 389         return("");
 390       }
 391     }else{
 392       $this->error = "Could not connect to LDAP server";
 393       return("");
 394     }
 395   }
 396
 397   function count($srp)
 398   {
 399     if($this->hascon){
 400       if($this->hasres[$srp]){
 401         $rv = @ldap_count_entries($this->cid, $this->sr[$srp]);
 402         $this->error = @ldap_error($this->cid);
 403         return($rv);
 404       }else{
 405         $this->error = "Perform a Fetch with no Search";
 406         return("");
 407       }
 408     }else{
 409       $this->error = "Could not connect to LDAP server";
 410       return("");
 411     }
 412   }
 413
 414   function rm($attrs = "", $dn = "")
 415   {
 416     if($this->hascon){
 417       if ($this->reconnect) $this->connect();
 418       if ($dn == "")
 419         $dn = $this->basedn;
 420
 421       $r = ldap_mod_del($this->cid, LDAP::fix($dn), $attrs);
 422       $this->error = @ldap_error($this->cid);
 423       return($r);
 424     }else{
 425       $this->error = "Could not connect to LDAP server";
 426       return("");
 427     }
 428   }
 429
 430   function mod_add($attrs = "", $dn = "")
 431   {
 432     if($this->hascon){
 433       if ($this->reconnect) $this->connect();
 434       if ($dn == "")
 435         $dn = $this->basedn;
 436
 437       $r = @ldap_mod_add($this->cid, LDAP::fix($dn), $attrs);
 438       $this->error = @ldap_error($this->cid);
 439       return($r);
 440     }else{
 441       $this->error = "Could not connect to LDAP server";
 442       return("");
 443     }
 444   }
 445
 446   function rename($attrs, $dn = "")
 447   {
 448     if($this->hascon){
 449       if ($this->reconnect) $this->connect();
 450       if ($dn == "")
 451         $dn = $this->basedn;
 452
 453       $r = @ldap_mod_replace($this->cid, LDAP::fix($dn), $attrs);
 454       $this->error = @ldap_error($this->cid);
 455       return($r);
 456     }else{
 457       $this->error = "Could not connect to LDAP server";
 458       return("");
 459     }
 460   }
 461
 462   function rmdir($deletedn)
 463   {
 464     if($this->hascon){
 465       if ($this->reconnect) $this->connect();
 466       $r = @ldap_delete($this->cid, LDAP::fix($deletedn));
 467       $this->error = @ldap_error($this->cid);
 468       return($r ? $r : 0);
 469     }else{
 470       $this->error = "Could not connect to LDAP server";
 471       return("");
 472     }
 473   }
 474
 475
 476   /*! \brief Move the given Ldap entry from $source to $dest
 477       @param  String  $source The source dn.
 478       @param  String  $dest   The destination dn.
 479       @return Boolean TRUE on success else FALSE.
 480    */
 481   function rename_dn($source,$dest)
 482   {
 483     /* Check if source and destination are the same entry */
 484     if(strtolower($source) == strtolower($dest)){
 485       trigger_error("Source and destination can't be the same entry.");
 486       $this->error = "Source and destination can't be the same entry.";
 487       return(FALSE);
 488     }
 489
 490     /* Check if destination entry exists */
 491     if($this->dn_exists($dest)){
 492       trigger_error("Destination '$dest' already exists.");
 493       $this->error = "Destination '$dest' already exists.";
 494       return(FALSE);
 495     }
 496
 497     /* Extract the name and the parent part out ouf source dn.
 498         e.g.  cn=herbert,ou=department,dc=...
 499          parent   =>  ou=department,dc=...
 500          dest_rdn =>  cn=herbert
 501      */
 502     $parent   = preg_replace("/^[^,]+,/","", $dest);
 503     $dest_rdn = preg_replace("/,.*$/","",$dest);
 504
 505     if($this->hascon){
 506       if ($this->reconnect) $this->connect();
 507       $r= ldap_rename($this->cid,@LDAP::fix($source), @LDAP::fix($dest_rdn),@LDAP::fix($parent),TRUE);
 508       $this->error = ldap_error($this->cid);
 509
 510       /* Check if destination dn exists, if not the
 511           server may not support this operation */
 512       $r &= is_resource($this->dn_exists($dest));
 513       return($r);
 514     }else{
 515       $this->error = "Could not connect to LDAP server";
 516       return(FALSE);
 517     }
 518   }
 519
 520
 521   /**
 522   *  Function rmdir_recursive
 523   *
 524   *  Description: Based in recursive_remove, adding two thing: full subtree remove, and delete own node.
 525   *  Parameters:  The dn to delete
 526   *  GiveBack:    True on sucessfull , 0 in error, and "" when we don't get a ldap conection
 527   *
 528   */
 529   function rmdir_recursive($srp, $deletedn)
 530   {
 531     if($this->hascon){
 532       if ($this->reconnect) $this->connect();
 533       $delarray= array();
 534
 535       /* Get sorted list of dn's to delete */
 536       $this->ls ($srp, "(objectClass=*)",$deletedn);
 537       while ($this->fetch($srp)){
 538         $deldn= $this->getDN($srp);
 539         $delarray[$deldn]= strlen($deldn);
 540       }
 541       arsort ($delarray);
 542       reset ($delarray);
 543
 544       /* Really Delete ALL dn's in subtree */
 545       foreach ($delarray as $key => $value){
 546         $this->rmdir_recursive($srp, $key);
 547       }
 548
 549       /* Finally Delete own Node */
 550       $r = @ldap_delete($this->cid, LDAP::fix($deletedn));
 551       $this->error = @ldap_error($this->cid);
 552       return($r ? $r : 0);
 553     }else{
 554       $this->error = "Could not connect to LDAP server";
 555       return("");
 556     }
 557   }
 558
 559   function makeReadableErrors($error,$attrs)
 560   {
 561     global $config;
 562
 563     if($this->success()) return("");
 564
 565     $str = "";
 566     if(preg_match("/^objectClass: value #([0-9]*) invalid per syntax$/", $this->get_additional_error())){
 567       $oc = preg_replace("/^objectClass: value #([0-9]*) invalid per syntax$/","\\1", $this->get_additional_error());
 568       if(isset($attrs['objectClass'][$oc])){
 569         $str.= " - <b>objectClass: ".$attrs['objectClass'][$oc]."</b>";
 570       }
 571     }
 572     if($error == "Undefined attribute type"){
 573       $str = " - <b>attribute: ".preg_replace("/:.*$/","",$this->get_additional_error())."</b>";
 574     }
 575
 576     @DEBUG(DEBUG_LDAP,__LINE__,__FUNCTION__,__FILE__,$attrs,"Erroneous data");
 577
 578     return($str);
 579   }
 580
 581   function modify($attrs)
 582   {
 583     if(count($attrs) == 0){
 584       return (0);
 585     }
 586     if($this->hascon){
 587       if ($this->reconnect) $this->connect();
 588       $r = @ldap_modify($this->cid, LDAP::fix($this->basedn), $attrs);
 589       $this->error = @ldap_error($this->cid);
 590       if(!$this->success()){
 591         $this->error.= $this->makeReadableErrors($this->error,$attrs);
 592       }
 593       return($r ? $r : 0);
 594     }else{
 595       $this->error = "Could not connect to LDAP server";
 596       return("");
 597     }
 598   }
 599
 600   function add($attrs)
 601   {
 602     if($this->hascon){
 603       if ($this->reconnect) $this->connect();
 604       $r = @ldap_add($this->cid, LDAP::fix($this->basedn), $attrs);
 605       $this->error = @ldap_error($this->cid);
 606       if(!$this->success()){
 607         $this->error.= $this->makeReadableErrors($this->error,$attrs);
 608       }
 609       return($r ? $r : 0);
 610     }else{
 611       $this->error = "Could not connect to LDAP server";
 612       return("");
 613     }
 614   }
 615
 616   function create_missing_trees($srp, $target)
 617   {
 618     global $config;
 619
 620     $real_path= substr($target, 0, strlen($target) - strlen($this->basedn) -1 );
 621
 622     if ($target == $this->basedn){
 623       $l= array("dummy");
 624     } else {
 625       $l= array_reverse(gosa_ldap_explode_dn($real_path));
 626     }
 627     unset($l['count']);
 628     $cdn= $this->basedn;
 629     $tag= "";
 630
 631     /* Load schema if available... */
 632     $classes= $this->get_objectclasses();
 633
 634     foreach ($l as $part){
 635       if ($part != "dummy"){
 636         $cdn= "$part,$cdn";
 637       }
 638
 639       /* Ignore referrals */
 640       $found= false;
 641       foreach($this->referrals as $ref){
 642         $base= preg_replace('!^[^:]+://[^/]+/([^?]+).*$!', '\\1', $ref['URI']);
 643         if ($base == $cdn){
 644           $found= true;
 645           break;
 646         }
 647       }
 648       if ($found){
 649         continue;
 650       }
 651
 652       $this->cat ($srp, $cdn);
 653       $attrs= $this->fetch($srp);
 654
 655       /* Create missing entry? */
 656       if (count ($attrs)){
 657
 658         /* Catch the tag - if present */
 659         if (isset($attrs['gosaUnitTag'][0])){
 660           $tag= $attrs['gosaUnitTag'][0];
 661         }
 662
 663       } else {
 664         $type= preg_replace('/^([^=]+)=.*$/', '\\1', $cdn);
 665         $param= LDAP::fix(preg_replace('/^[^=]+=([^,]+).*$/', '\\1', $cdn));
 666         $param=preg_replace(array('/\\\\,/','/\\\\"/'),array(',','"'),$param);
 667
 668         $na= array();
 669
 670         /* Automatic or traditional? */
 671         if(count($classes)){
 672
 673           /* Get name of first matching objectClass */
 674           $ocname= "";
 675           foreach($classes as $class){
 676             if (isset($class['MUST']) && in_array($type, $class['MUST'])){
 677
 678               /* Look for first classes that is structural... */
 679               if (isset($class['STRUCTURAL'])){
 680                 $ocname= $class['NAME'];
 681                 break;
 682               }
 683
 684               /* Look for classes that are auxiliary... */
 685               if (isset($class['AUXILIARY'])){
 686                 $ocname= $class['NAME'];
 687               }
 688             }
 689           }
 690
 691           /* Bail out, if we've nothing to do... */
 692           if ($ocname == ""){
 693             msg_dialog::display(_("Internal error"), sprintf(_("Cannot automatically create subtrees with RDN '%s': no object class found!"),$type), FATAL_ERROR_DIALOG);
 694             exit();
 695           }
 696
 697           /* Assemble_entry */
 698           if ($tag != ""){
 699             $na['objectClass']= array($ocname, "gosaAdministrativeUnitTag");
 700             $na["gosaUnitTag"]= $tag;
 701           } else {
 702             $na['objectClass']= array($ocname);
 703           }
 704           if (isset($classes[$ocname]['AUXILIARY'])){
 705             $na['objectClass'][]= $classes[$ocname]['SUP'];
 706           }
 707           if ($type == "dc"){
 708             /* This is bad actually, but - tell me a better way? */
 709             $na['objectClass'][]= 'locality';
 710           }
 711           $na[$type]= $param;
 712
 713           // Fill in MUST values - but do not overwrite existing ones.
 714           if (is_array($classes[$ocname]['MUST'])){
 715             foreach($classes[$ocname]['MUST'] as $attr){
 716               if(isset($na[$attr]) && !empty($na[$attr])) continue;
 717               $na[$attr]= "filled";
 718             }
 719           }
 720
 721         } else {
 722
 723           /* Use alternative add... */
 724           switch ($type){
 725             case 'ou':
 726               if ($tag != ""){
 727                 $na["objectClass"]= array("organizationalUnit", "gosaAdministrativeUnitTag");
 728                 $na["gosaUnitTag"]= $tag;
 729               } else {
 730                 $na["objectClass"]= "organizationalUnit";
 731               }
 732               $na["ou"]= $param;
 733               break;
 734             case 'dc':
 735               if ($tag != ""){
 736                 $na["objectClass"]= array("dcObject", "top", "locality", "gosaAdministrativeUnitTag");
 737                 $na["gosaUnitTag"]= $tag;
 738               } else {
 739                 $na["objectClass"]= array("dcObject", "top", "locality");
 740               }
 741               $na["dc"]= $param;
 742               break;
 743             default:
 744               msg_dialog::display(_("Internal error"), sprintf(_("Cannot automatically create subtrees with RDN '%s': not supported"),$type), FATAL_ERROR_DIALOG);
 745               exit();
 746           }
 747
 748         }
 749         $this->cd($cdn);
 750         $this->add($na);
 751
 752         if (!$this->success()){
 753
 754           print_a(array($cdn,$na));
 755
 756           msg_dialog::display(_("LDAP error"), msgPool::ldaperror($this->get_error(), $cdn, LDAP_ADD, get_class()));
 757           return FALSE;
 758         }
 759       }
 760     }
 761
 762     return TRUE;
 763   }
 764
 765
 766   function recursive_remove($srp)
 767   {
 768     $delarray= array();
 769
 770     /* Get sorted list of dn's to delete */
 771     $this->search ($srp, "(objectClass=*)");
 772     while ($this->fetch($srp)){
 773       $deldn= $this->getDN($srp);
 774       $delarray[$deldn]= strlen($deldn);
 775     }
 776     arsort ($delarray);
 777     reset ($delarray);
 778
 779     /* Delete all dn's in subtree */
 780     foreach ($delarray as $key => $value){
 781       $this->rmdir($key);
 782     }
 783   }
 784
 785
 786   function get_attribute($dn, $name,$r_array=0)
 787   {
 788     $data= "";
 789     if ($this->reconnect) $this->connect();
 790     $sr= @ldap_read($this->cid, LDAP::fix($dn), "objectClass=*", array("$name"));
 791
 792     /* fill data from LDAP */
 793     if ($sr) {
 794       $ei= @ldap_first_entry($this->cid, $sr);
 795       if ($ei) {
 796         if ($info= @ldap_get_values_len($this->cid, $ei, "$name")){
 797           $data= $info[0];
 798         }
 799       }
 800     }
 801     if($r_array==0) {
 802       return ($data);
 803     } else {
 804       return ($info);
 805     }
 806   }
 807
 808
 809
 810   function get_additional_error()
 811   {
 812     $error= "";
 813     @ldap_get_option ($this->cid, LDAP_OPT_ERROR_STRING, $error);
 814     return ($error);
 815   }
 816
 817
 818   function success()
 819   {
 820     return (preg_match('/Success/i', $this->error));
 821   }
 822
 823
 824   function get_error()
 825   {
 826     if ($this->error == 'Success'){
 827       return $this->error;
 828     } else {
 829       $adderror= $this->get_additional_error();
 830       if ($adderror != ""){
 831         $error= $this->error." (".$this->get_additional_error().", ".sprintf(_("while operating on '%s' using LDAP server '%s'"), $this->basedn, $this->hostname).")";
 832       } else {
 833         $error= $this->error." (".sprintf(_("while operating on LDAP server %s"), $this->hostname).")";
 834       }
 835       return $error;
 836     }
 837   }
 838
 839   function get_credentials($url, $referrals= NULL)
 840   {
 841     $ret= array();
 842     $url= preg_replace('!\?\?.*$!', '', $url);
 843     $server= preg_replace('!^([^:]+://[^/]+)/.*$!', '\\1', $url);
 844
 845     if ($referrals === NULL){
 846       $referrals= $this->referrals;
 847     }
 848
 849     if (isset($referrals[$server])){
 850       return ($referrals[$server]);
 851     } else {
 852       $ret['ADMINDN']= LDAP::fix($this->binddn);
 853       $ret['ADMINPASSWORD']= $this->bindpw;
 854     }
 855
 856     return ($ret);
 857   }
 858
 859
 860   /*! \brief  Generates an ldif for all entries matching the filter settings, scope and limit.
 861    *  @param  $dn           The entry to export.
 862    *  @param  $filter       Limit the exported object to those maching this filter.
 863    *  @param  $scope        'base', 'sub' .. see manpage for 'ldapmodify' for details.
 864    *  @param  $limit        Limits the result.
 865    */
 866   function generateLdif ($dn, $filter= "(objectClass=*)", $attributes= array(),$scope = 'sub', $limit=0)
 867   {
 868
 869       // Attributes are unused !!
 870       $attrs = '';
 871
 872       // Ensure that limit is numeric if not skip here.
 873       if(!empty($limit) && !is_numeric($limit)){
 874           trigger_error(sprintf("Invalid parameter for limit '%s', a numeric value is required."), $limit);
 875           return(NULL);
 876       }
 877       $limit = (!$limit)?'':' -z '.$limit;
 878
 879       // Check scope values
 880       $scope = trim($scope);
 881       if(!empty($scope) && !in_array($scope, array('base', 'one', 'sub', 'children'))){
 882           trigger_error(sprintf("Invalid parameter for scope '%s', please use 'base', 'one', 'sub' or 'children'."), $scope);
 883           return(NULL);
 884       }
 885       $scope = (!empty($scope))?' -s '.$scope: '';
 886
 887       // First check if we are able to call 'ldapsearch' on the command line.
 888       $check = shell_exec('which ldapsearch');
 889       if(empty($check)){
 890         $this->error = sprintf(_("Missing command line programm '%s'!"), 'ldapsearch');
 891         return(NULL);
 892       }
 893
 894       // Prepare parameters to be valid for shell execution
 895       $dn = escapeshellarg($dn);
 896       $pwd = $this->bindpw;
 897       $host = escapeshellarg($this->hostname);
 898       $admin = escapeshellarg($this->binddn);
 899       $filter = escapeshellarg($filter);
 900
 901
 902       $cmd = "ldapsearch -x -LLLL -D {$admin} {$filter} {$limit} {$scope} -H {$host} -b {$dn} -w {$pwd} ";
 903
 904       // Create list of process pipes
 905       $descriptorspec = array(
 906               0 => array("pipe", "r"),  // stdin
 907               1 => array("pipe", "w"),  // stdout
 908               2 => array("pipe", "w")); // stderr
 909
 910       // Try to open the process
 911       $process = proc_open($cmd, $descriptorspec, $pipes);
 912       if (is_resource($process)) {
 913
 914           // Write the password to stdin
 915           fclose($pipes[0]);
 916
 917           // Get results from stdout and stderr
 918           $res = stream_get_contents($pipes[1]);
 919           $err = stream_get_contents($pipes[2]);
 920           fclose($pipes[1]);
 921
 922           // Close the process and check its return value
 923           if(proc_close($process) != 0){
 924               $this->error = $err;
 925               return(NULL);
 926           }
 927       }
 928       return($res);
 929   }
 930
 931
 932   function gen_xls ($srp, $dn, $filter= "(objectClass=*)", $attributes= array('*'), $recursive= TRUE,$r_array=0)
 933   {
 934     $display= array();
 935
 936       $this->cd($dn);
 937       $this->search($srp, "$filter");
 938
 939       $i=0;
 940       while ($attrs= $this->fetch($srp)){
 941         $j=0;
 942
 943         foreach ($attributes as $at){
 944           $display[$i][$j]= $this->get_attribute($attrs['dn'], $at,$r_array);
 945           $j++;
 946         }
 947
 948         $i++;
 949       }
 950
 951     return ($display);
 952   }
 953
 954
 955   function dn_exists($dn)
 956   {
 957     return @ldap_list($this->cid, LDAP::fix($dn), "(objectClass=*)", array("objectClass"));
 958   }
 959
 960
 961
 962   /*  This funktion imports ldifs
 963
 964       If DeleteOldEntries is true, the destination entry will be deleted first.
 965       If JustModify is true the destination entry will only be touched by the attributes specified in the ldif.
 966       if JustMofify id false the destination dn will be overwritten by the new ldif.
 967     */
 968
 969   function import_complete_ldif($srp, $str_attr,$error,$JustModify,$DeleteOldEntries)
 970   {
 971     if($this->reconnect) $this->connect();
 972
 973     /* First we have to split the string into empty lines.
 974        An empty line indicates an new Entry */
 975     $entries = preg_split("/\n/",$str_attr);
 976
 977     $data = "";
 978     $cnt = 0;
 979     $current_line = 0;
 980
 981     /* FIX ldif */
 982     $last = "";
 983     $tmp  = "";
 984     $i = 0;
 985     foreach($entries as $entry){
 986       if(preg_match("/^ /",$entry)){
 987         $tmp[$i] .= trim($entry);
 988       }else{
 989         $i ++;
 990         $tmp[$i] = trim($entry);
 991       }
 992     }
 993
 994     /* Every single line ... */
 995     foreach($tmp as $entry) {
 996       $current_line ++;
 997
 998       /* Removing Spaces to ..
 999          .. test if a new entry begins */
1000       $tmp  = str_replace(" ","",$data );
1001
1002       /* .. prevent empty lines in an entry */
1003       $tmp2 = str_replace(" ","",$entry);
1004
1005       /* If the Block ends (Empty Line) */
1006       if((empty($entry))&&(!empty($tmp))) {
1007         /* Add collected lines as a complete block */
1008         $all[$cnt] = $data;
1009         $cnt ++;
1010         $data ="";
1011       } else {
1012
1013         /* Append lines ... */
1014         if(!empty($tmp2)) {
1015           /* check if we need base64_decode for this line */
1016           if(strstr($tmp2, "::") !== false)
1017           {
1018             $encoded = explode("::",$entry);
1019             $attr  = trim($encoded[0]);
1020             $value = base64_decode(trim($encoded[1]));
1021             /* Add linenumber */
1022             $data .= $current_line."#".base64_encode($attr.":".$value)."\n";
1023           }
1024           else
1025           {
1026             /* Add Linenumber */
1027             $data .= $current_line."#".base64_encode($entry)."\n";
1028           }
1029         }
1030       }
1031     }
1032
1033     /* The Data we collected is not in the array all[];
1034        For example the Data is stored like this..
1035
1036        all[0] = "1#dn : .... \n
1037        2#ObjectType: person \n ...."
1038
1039        Now we check every insertblock and try to insert */
1040     foreach ( $all as $single) {
1041       $lineone = preg_split("/\n/",$single);
1042       $ndn = explode("#", $lineone[0]);
1043       $line = base64_decode($ndn[1]);
1044
1045       $dnn = explode (":",$line,2);
1046       $current_line = $ndn[0];
1047       $dn    = $dnn[0];
1048       $value = $dnn[1];
1049
1050       /* Every block must begin with a dn */
1051       if($dn != "dn") {
1052         $error= sprintf(_("This is not a valid DN: '%s'. A block for import should begin with 'dn: ...' in line %s"), $line, $current_line);
1053         return -2;
1054       }
1055
1056       /* Should we use Modify instead of Add */
1057       $usemodify= false;
1058
1059       /* Delete before insert */
1060       $usermdir= false;
1061
1062       /* The dn address already exists, Don't delete destination entry, overwrite it */
1063       if (($this->dn_exists($value))&&((!$JustModify)&&(!$DeleteOldEntries))) {
1064
1065         $usermdir = $usemodify = false;
1066
1067       /* Delete old entry first, then add new */
1068       } elseif(($this->dn_exists($value))&&($DeleteOldEntries)){
1069
1070         /* Delete first, then add */
1071         $usermdir = true;
1072
1073       } elseif(($this->dn_exists($value))&&($JustModify)) {
1074
1075         /* Modify instead of Add */
1076         $usemodify = true;
1077       }
1078
1079       /* If we can't Import, return with a file error */
1080       if(!$this->import_single_entry($srp, $single,$usemodify,$usermdir) ) {
1081         $error= sprintf(_("Error while importing dn: '%s', please check your LDIF from line %s on!"), $line,
1082                         $current_line);
1083         return UNKNOWN_TOKEN_IN_LDIF_FILE;      }
1084     }
1085
1086     return (INSERT_OK);
1087   }
1088
1089
1090   /* Imports a single entry
1091       If $delete is true;  The old entry will be deleted if it exists.
1092       if $modify is true;  All variables that are not touched by the new ldif will be kept.
1093       if $modify is false; The new ldif overwrites the old entry, and all untouched attributes get lost.
1094   */
1095   function import_single_entry($srp, $str_attr,$modify,$delete)
1096   {
1097     global $config;
1098
1099     if(!$config){
1100       trigger_error("Can't import ldif, can't read config object.");
1101     }
1102
1103
1104     if($this->reconnect) $this->connect();
1105
1106     $ret = false;
1107     $rows= preg_split("/\n/",$str_attr);
1108     $data= false;
1109
1110     foreach($rows as $row) {
1111
1112       /* Check if we use Linenumbers (when import_complete_ldif is called we use
1113          Linenumbers) Linenumbers are use like this 123#attribute : value */
1114       if(!empty($row)) {
1115         if(strpos($row,"#")!=FALSE) {
1116
1117           /* We are using line numbers
1118              Because there is a # before a : */
1119           $tmp1= explode("#",$row);
1120           $current_line= $tmp1[0];
1121           $row= base64_decode($tmp1[1]);
1122         }
1123
1124         /* Split the line into  attribute  and value */
1125         $attr   = explode(":", $row,2);
1126         $attr[0]= trim($attr[0]);  /* attribute */
1127         $attr[1]= $attr[1];  /* value */
1128
1129         /* Check :: was used to indicate base64_encoded strings */
1130         if($attr[1][0] == ":"){
1131           $attr[1]=trim(preg_replace("/^:/","",$attr[1]));
1132           $attr[1]=base64_decode($attr[1]);
1133         }
1134
1135         $attr[1] = trim($attr[1]);
1136
1137         /* Check for attributes that are used more than once */
1138         if(!isset($data[$attr[0]])) {
1139           $data[$attr[0]]=$attr[1];
1140         } else {
1141           $tmp = $data[$attr[0]];
1142
1143           if(!is_array($tmp)) {
1144             $new[0]=$tmp;
1145             $new[1]=$attr[1];
1146             $datas[$attr[0]]['count']=1;
1147             $data[$attr[0]]=$new;
1148           } else {
1149             $cnt = $datas[$attr[0]]['count'];
1150             $cnt ++;
1151             $data[$attr[0]][$cnt]=$attr[1];
1152             $datas[$attr[0]]['count'] = $cnt;
1153           }
1154         }
1155       }
1156     }
1157
1158     /* If dn is an index of data, we should try to insert the data */
1159     if(isset($data['dn'])) {
1160
1161       /* Fix dn */
1162       $tmp = gosa_ldap_explode_dn($data['dn']);
1163       unset($tmp['count']);
1164       $newdn ="";
1165       foreach($tmp as $tm){
1166         $newdn.= trim($tm).",";
1167       }
1168       $newdn = preg_replace("/,$/","",$newdn);
1169       $data['dn'] = $newdn;
1170
1171       /* Creating Entry */
1172       $this->cd($data['dn']);
1173
1174       /* Delete existing entry */
1175       if($delete){
1176         $this->rmdir_recursive($srp, $data['dn']);
1177       }
1178
1179       /* Create missing trees */
1180       $this->cd ($this->basedn);
1181       $this->cd($config->current['BASE']);
1182       $this->create_missing_trees($srp, preg_replace("/^[^,]+,/","",$data['dn']));
1183       $this->cd($data['dn']);
1184
1185       $dn = $data['dn'];
1186       unset($data['dn']);
1187
1188       if(!$modify){
1189
1190         $this->cat($srp, $dn);
1191         if($this->count($srp)){
1192
1193           /* The destination entry exists, overwrite it with the new entry */
1194           $attrs = $this->fetch($srp);
1195           foreach($attrs as $name => $value ){
1196             if(!is_numeric($name)){
1197               if(in_array($name,array("dn","count"))) continue;
1198               if(!isset($data[$name])){
1199                 $data[$name] = array();
1200               }
1201             }
1202           }
1203           $ret = $this->modify($data);
1204
1205         }else{
1206
1207           /* The destination entry doesn't exists, create it */
1208           $ret = $this->add($data);
1209         }
1210
1211       } else {
1212
1213         /* Keep all vars that aren't touched by this ldif */
1214         $ret = $this->modify($data);
1215       }
1216     }
1217
1218     if (!$this->success()){
1219       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($this->get_error(), $dn, "", get_class()));
1220     }
1221
1222     return($ret);
1223   }
1224
1225
1226   function importcsv($str)
1227   {
1228     $lines = preg_split("/\n/",$str);
1229     foreach($lines as $line)
1230     {
1231       /* continue if theres a comment */
1232       if(substr(trim($line),0,1)=="#"){
1233         continue;
1234       }
1235
1236       $line= str_replace ("\t\t","\t",$line);
1237       $line= str_replace ("\t"  ,"," ,$line);
1238       echo $line;
1239
1240       $cells = explode(",",$line )  ;
1241       $linet= str_replace ("\t\t",",",$line);
1242       $cells = preg_split("/\t/",$line);
1243       $count = count($cells);
1244     }
1245
1246   }
1247
1248   function get_objectclasses( $force_reload = FALSE)
1249   {
1250     $objectclasses = array();
1251     global $config;
1252
1253     /* Only read schema if it is allowed */
1254     if(isset($config) && preg_match("/config/i",get_class($config))){
1255       if ($config->get_cfg_value("schemaCheck") != "true"){
1256         return($objectclasses);
1257       }
1258     }
1259
1260     /* Return the cached results. */
1261     if(class_available('session') && session::global_is_set("LDAP_CACHE::get_objectclasses") && !$force_reload){
1262       $objectclasses = session::global_get("LDAP_CACHE::get_objectclasses");
1263       return($objectclasses);
1264     }
1265
1266           # Get base to look for schema
1267           $sr = @ldap_read ($this->cid, "", "objectClass=*", array("subschemaSubentry"));
1268           $attr = @ldap_get_entries($this->cid,$sr);
1269           if (!isset($attr[0]['subschemasubentry'][0])){
1270             return array();
1271           }
1272
1273           /* Get list of objectclasses and fill array */
1274           $nb= $attr[0]['subschemasubentry'][0];
1275           $objectclasses= array();
1276           $sr= ldap_read ($this->cid, $nb, "objectClass=*", array("objectclasses"));
1277           $attrs= ldap_get_entries($this->cid,$sr);
1278           if (!isset($attrs[0])){
1279             return array();
1280           }
1281           foreach ($attrs[0]['objectclasses'] as $val){
1282       if (preg_match('/^[0-9]+$/', $val)){
1283         continue;
1284       }
1285       $name= "OID";
1286       $pattern= explode(' ', $val);
1287       $ocname= preg_replace("/^.* NAME\s+\(*\s*'([^']+)'\s*\)*.*$/", '\\1', $val);
1288       $objectclasses[$ocname]= array();
1289
1290       foreach($pattern as $chunk){
1291         switch($chunk){
1292
1293           case '(':
1294                     $value= "";
1295                     break;
1296
1297           case ')': if ($name != ""){
1298                       $v = $this->value2container($value);
1299                       if(in_array($name, array('MUST', 'MAY')) && !is_array($v)){
1300                         $v = array($v);
1301                       }
1302                       $objectclasses[$ocname][$name]= $v;
1303                     }
1304                     $name= "";
1305                     $value= "";
1306                     break;
1307
1308           case 'NAME':
1309           case 'DESC':
1310           case 'SUP':
1311           case 'STRUCTURAL':
1312           case 'ABSTRACT':
1313           case 'AUXILIARY':
1314           case 'MUST':
1315           case 'MAY':
1316                     if ($name != ""){
1317                       $v = $this->value2container($value);
1318                       if(in_array($name, array('MUST', 'MAY')) && !is_array($v)){
1319                         $v = array($v);
1320                       }
1321                       $objectclasses[$ocname][$name]= $v;
1322                     }
1323                     $name= $chunk;
1324                     $value= "";
1325                     break;
1326
1327           default:  $value.= $chunk." ";
1328         }
1329       }
1330
1331           }
1332     if(class_available("session")){
1333       session::global_set("LDAP_CACHE::get_objectclasses",$objectclasses);
1334     }
1335
1336           return $objectclasses;
1337   }
1338
1339
1340   function value2container($value)
1341   {
1342     /* Set emtpy values to "true" only */
1343     if (preg_match('/^\s*$/', $value)){
1344       return true;
1345     }
1346
1347     /* Remove ' and " if needed */
1348     $value= preg_replace('/^[\'"]/', '', $value);
1349     $value= preg_replace('/[\'"] *$/', '', $value);
1350
1351     /* Convert to array if $ is inside... */
1352     if (preg_match('/\$/', $value)){
1353       $container= preg_split('/\s*\$\s*/', $value);
1354     } else {
1355       $container= chop($value);
1356     }
1357
1358     return ($container);
1359   }
1360
1361
1362   function log($string)
1363   {
1364     if (session::global_is_set('config')){
1365       $cfg = session::global_get('config');
1366       if (isset($cfg->current['LDAPSTATS']) && preg_match('/true/i', $cfg->current['LDAPSTATS'])){
1367         syslog (LOG_INFO, $string);
1368       }
1369     }
1370   }
1371
1372   /* added by Guido Serra aka Zeph <zeph@purotesto.it> */
1373   function getCn($dn){
1374     $simple= explode(",", $dn);
1375
1376     foreach($simple as $piece) {
1377       $partial= explode("=", $piece);
1378
1379       if($partial[0] == "cn"){
1380         return $partial[1];
1381       }
1382     }
1383   }
1384
1385
1386   function get_naming_contexts($server, $admin= "", $password= "")
1387   {
1388     /* Build LDAP connection */
1389     $ds= ldap_connect ($server);
1390     if (!$ds) {
1391       die ("Can't bind to LDAP. No check possible!");
1392     }
1393     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
1394     $r= ldap_bind ($ds, $admin, $password);
1395
1396     /* Get base to look for naming contexts */
1397     $sr  = @ldap_read ($ds, "", "objectClass=*", array("+"));
1398     $attr= @ldap_get_entries($ds,$sr);
1399
1400     return ($attr[0]['namingcontexts']);
1401   }
1402
1403
1404   function get_root_dse($server, $admin= "", $password= "")
1405   {
1406     /* Build LDAP connection */
1407     $ds= ldap_connect ($server);
1408     if (!$ds) {
1409       die ("Can't bind to LDAP. No check possible!");
1410     }
1411     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
1412     $r= ldap_bind ($ds, $admin, $password);
1413
1414     /* Get base to look for naming contexts */
1415     $sr  = @ldap_read ($ds, "", "objectClass=*", array("+"));
1416     $attr= @ldap_get_entries($ds,$sr);
1417
1418     /* Return empty array, if nothing was set */
1419     if (!isset($attr[0])){
1420       return array();
1421     }
1422
1423     /* Rework array... */
1424     $result= array();
1425     for ($i= 0; $i<$attr[0]['count']; $i++){
1426       $result[$attr[0][$i]]= $attr[0][$attr[0][$i]];
1427       unset($result[$attr[0][$i]]['count']);
1428     }
1429
1430     return ($result);
1431   }
1432
1433 }
1434 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
1435 ?>