Code

Fixed typo
[gosa.git] / gosa-core / include / class_ldap.inc
index 8aa793cf1125952f874194a2b039c73393ce72ad..2227e664e613cdd5b3985de69691093f8a666fa1 100644 (file)
@@ -81,18 +81,21 @@ class LDAP{
   /* Function to replace all problematic characters inside a DN by \001XX, where
      \001 is decoded to chr(1) [ctrl+a]. It is not impossible, but very unlikely
      that this character is inside a DN.
-     
+
      Currently used codes:
-      ,   => CO
-      \2C => CO
-      (   => OB
-      )   => CB
-      /   => SL                                                                  */
+     ,   => CO
+     \2C => CO
+     (   => OB
+     )   => CB
+     /   => SL                                                                  
+     \22 => DQ                                                                  */
   static function convert($dn)
   {
-    if (SPECIALS_OVERRIDE === TRUE){
-      return preg_replace('/,\s+/', ',', str_replace(array('\\\\,', '\\\\2C', '\(/', '/\)', '\/'),
-                           array("\001CO", "\001CO", "\001OB", "\001CB", "\001SL"), $dn));
+    if (SPECIALS_OVERRIDE == TRUE){
+      $tmp= preg_replace(array("/\\\\,/", "/\\\\2C/", "/\(/", "/\)/", "/\//", "/\\\\22/", '/\\\\"/'),
+          array("\001CO", "\001CO", "\001OB", "\001CB", "\001SL", "\001DQ", "\001DQ"),
+          $dn);
+      return (preg_replace('/,\s+/', ',', $tmp));
     } else {
       return ($dn);
     }
@@ -105,20 +108,21 @@ class LDAP{
      servers seem to take it the correct way.                                  */
   static function fix($dn)
   {
-    if (SPECIALS_OVERRIDE === TRUE){
-      return (str_replace(array('\001CO', '\001OB', '\001CB', '\001SL'),
-                           array('\,', '(', ')', '/'), $dn));
+    if (SPECIALS_OVERRIDE == TRUE){
+      return (preg_replace(array("/\001CO/", "/\001OB/", "/\001CB/", "/\001SL/", "/\001DQ/"),
+            array("\,", "(", ")", "/", '\"'),
+            $dn));
     } else {
       return ($dn);
     }
   }
 
-
   /* Function to fix problematic characters in DN's that are used for search
      requests. I.e. member=....                                               */
   static function prepare4filter($dn)
   {
-       return normalizeLdap(preg_replace('/\\\\/', '\\\\\\', LDAP::fix($dn)));
+    $fixed= normalizeLdap(str_replace('\\\\', '\\\\\\', LDAP::fix($dn)));
+    return str_replace('\\,', '\\\\,', $fixed);
   }
 
 
@@ -204,9 +208,9 @@ class LDAP{
     if ($basedn==""){
       $basedn = $this->basedn;
     } else {
-      $basedn = LDAP::convert($this->basedn);
+      $basedn = LDAP::convert($basedn);
     }
-    return(ereg_replace("[^,]*[,]*[ ]*(.*)", "\\1", $basedn));
+    return(preg_replace("/[^,]*[,]*[ ]*(.*)/", "$1", $basedn));
   }
 
   
@@ -215,7 +219,7 @@ class LDAP{
     if($this->hascon){
       if ($this->reconnect) $this->connect();
 
-      $start = microtime();
+      $start = microtime(true);
       $this->clearResult($srp);
       $this->sr[$srp] = @ldap_search($this->cid, LDAP::fix($this->basedn), $filter, $attrs);
       $this->error = @ldap_error($this->cid);
@@ -224,13 +228,13 @@ class LDAP{
    
       /* Check if query took longer as specified in max_ldap_query_time */
       if($this->max_ldap_query_time){
-        $diff = get_MicroTimeDiff($start,microtime());
+        $diff = microtime(true) - $start;
         if($diff > $this->max_ldap_query_time){
           msg_dialog::display(_("Performance warning"), sprintf(_("LDAP performance is poor: last query took about %.2fs!"), $diff), WARNING_DIALOG);
         }
       }
 
-      $this->log("LDAP operation: time=".get_MicroTimeDiff($start,microtime())." operation=search('".LDAP::fix($this->basedn)."', '$filter')");
+      $this->log("LDAP operation: time=".(microtime(true)-$start)." operation=search('".LDAP::fix($this->basedn)."', '$filter')");
       return($this->sr[$srp]);
     }else{
       $this->error = "Could not connect to LDAP server";
@@ -249,7 +253,7 @@ class LDAP{
       else
         $basedn= LDAP::convert($basedn);
   
-      $start = microtime();
+      $start = microtime(true);
       $this->sr[$srp] = @ldap_list($this->cid, LDAP::fix($basedn), $filter,$attrs);
       $this->error = @ldap_error($this->cid);
       $this->resetResult($srp);
@@ -257,13 +261,13 @@ class LDAP{
 
        /* Check if query took longer as specified in max_ldap_query_time */
       if($this->max_ldap_query_time){
-        $diff = get_MicroTimeDiff($start,microtime());
+        $diff = microtime(true) - $start;
         if($diff > $this->max_ldap_query_time){
           msg_dialog::display(_("Performance warning"), sprintf(_("LDAP performance is poor: last query took about %.2fs!"), $diff), WARNING_DIALOG);
         }
       }
 
-      $this->log("LDAP operation: time=".get_MicroTimeDiff($start,microtime())." operation=ls('".LDAP::fix($basedn)."', '$filter')");
+      $this->log("LDAP operation: time=".(microtime(true) - $start)." operation=ls('".LDAP::fix($basedn)."', '$filter')");
 
       return($this->sr[$srp]);
     }else{
@@ -272,13 +276,12 @@ class LDAP{
     }
   }
 
-  function cat($srp, $dn,$attrs= array("*"))
+  function cat($srp, $dn,$attrs= array("*"), $filter = "(objectclass=*)")
   {
     if($this->hascon){
       if ($this->reconnect) $this->connect();
 
       $this->clearResult($srp);
-      $filter = "(objectclass=*)";
       $this->sr[$srp] = @ldap_read($this->cid, LDAP::fix($dn), $filter,$attrs);
       $this->error = @ldap_error($this->cid);
       $this->resetResult($srp);
@@ -415,7 +418,23 @@ class LDAP{
       if ($dn == "")
         $dn = $this->basedn;
 
-      $r = @ldap_mod_del($this->cid, LDAP::fix($dn), $attrs);
+      $r = ldap_mod_del($this->cid, LDAP::fix($dn), $attrs);
+      $this->error = @ldap_error($this->cid);
+      return($r);
+    }else{
+      $this->error = "Could not connect to LDAP server";
+      return("");
+    }
+  }
+
+  function mod_add($attrs = "", $dn = "")
+  {
+    if($this->hascon){
+      if ($this->reconnect) $this->connect();
+      if ($dn == "")
+        $dn = $this->basedn;
+
+      $r = @ldap_mod_add($this->cid, LDAP::fix($dn), $attrs);
       $this->error = @ldap_error($this->cid);
       return($r);
     }else{
@@ -461,9 +480,6 @@ class LDAP{
    */
   function rename_dn($source,$dest)
   {
-    $source = LDAP::fix($source);
-    $dest = LDAP::fix($dest);
-
     /* Check if source and destination are the same entry */
     if(strtolower($source) == strtolower($dest)){
       trigger_error("Source and destination can't be the same entry.");
@@ -483,12 +499,12 @@ class LDAP{
          parent   =>  ou=department,dc=...
          dest_rdn =>  cn=herbert
      */
-    $parent   = preg_replace("/^[^,]+,/","",$dest);
+    $parent   = preg_replace("/^[^,]+,/","", $dest);
     $dest_rdn = preg_replace("/,.*$/","",$dest);
-  
+
     if($this->hascon){
       if ($this->reconnect) $this->connect();
-      $r= ldap_rename($this->cid,$source,$dest_rdn,$parent,TRUE); 
+      $r= ldap_rename($this->cid,@LDAP::fix($source), @LDAP::fix($dest_rdn),@LDAP::fix($parent),TRUE); 
       $this->error = ldap_error($this->cid);
 
       /* Check if destination dn exists, if not the 
@@ -540,6 +556,27 @@ class LDAP{
     }
   }
 
+  function makeReadableErrors($error,$attrs)
+  { 
+    global $config;
+
+    if($this->success()) return("");
+
+    $str = "";
+    if(preg_match("/^objectClass: value #([0-9]*) invalid per syntax$/", $this->get_additional_error())){
+      $oc = preg_replace("/^objectClass: value #([0-9]*) invalid per syntax$/","\\1", $this->get_additional_error());
+      if(isset($attrs['objectClass'][$oc])){
+        $str.= " - <b>objectClass: ".$attrs['objectClass'][$oc]."</b>";
+      }
+    }
+    if($error == "Undefined attribute type"){
+      $str = " - <b>attribute: ".preg_replace("/:.*$/","",$this->get_additional_error())."</b>";
+    } 
+
+    @DEBUG(DEBUG_LDAP,__LINE__,__FUNCTION__,__FILE__,$attrs,"Erroneous data");
+
+    return($str);
+  }
 
   function modify($attrs)
   {
@@ -550,6 +587,9 @@ class LDAP{
       if ($this->reconnect) $this->connect();
       $r = @ldap_modify($this->cid, LDAP::fix($this->basedn), $attrs);
       $this->error = @ldap_error($this->cid);
+      if(!$this->success()){
+        $this->error.= $this->makeReadableErrors($this->error,$attrs);
+      }
       return($r ? $r : 0);
     }else{
       $this->error = "Could not connect to LDAP server";
@@ -563,6 +603,9 @@ class LDAP{
       if ($this->reconnect) $this->connect();
       $r = @ldap_add($this->cid, LDAP::fix($this->basedn), $attrs);
       $this->error = @ldap_error($this->cid);
+      if(!$this->success()){
+        $this->error.= $this->makeReadableErrors($this->error,$attrs);
+      }
       return($r ? $r : 0);
     }else{
       $this->error = "Could not connect to LDAP server";
@@ -619,7 +662,8 @@ class LDAP{
 
       } else {
         $type= preg_replace('/^([^=]+)=.*$/', '\\1', $cdn);
-        $param= preg_replace('/^[^=]+=([^,]+),.*$/', '\\1', $cdn);
+        $param= LDAP::fix(preg_replace('/^[^=]+=([^,]+).*$/', '\\1', $cdn));
+        $param=preg_replace(array('/\\\\,/','/\\\\"/'),array(',','"'),$param);
 
         $na= array();
 
@@ -629,7 +673,7 @@ class LDAP{
           /* Get name of first matching objectClass */
           $ocname= "";
           foreach($classes as $class){
-            if (isset($class['MUST']) && $class['MUST'] == "$type"){
+            if (isset($class['MUST']) && in_array($type, $class['MUST'])){
 
               /* Look for first classes that is structural... */
               if (isset($class['STRUCTURAL'])){
@@ -665,8 +709,11 @@ class LDAP{
             $na['objectClass'][]= 'locality';
           }
           $na[$type]= $param;
+
+          // Fill in MUST values - but do not overwrite existing ones.
           if (is_array($classes[$ocname]['MUST'])){
             foreach($classes[$ocname]['MUST'] as $attr){
+              if(isset($na[$attr]) && !empty($na[$attr])) continue;
               $na[$attr]= "filled";
             }
           }
@@ -703,6 +750,9 @@ class LDAP{
         $this->add($na);
     
         if (!$this->success()){
+
+          print_a(array($cdn,$na));
+
           msg_dialog::display(_("LDAP error"), msgPool::ldaperror($this->get_error(), $cdn, LDAP_ADD, get_class()));
           return FALSE;
         }
@@ -732,6 +782,7 @@ class LDAP{
     }
   }
 
+
   function get_attribute($dn, $name,$r_array=0)
   {
     $data= "";
@@ -747,12 +798,11 @@ class LDAP{
         }
       }
     }
-    if($r_array==0)
-    return ($data);
-    else
-    return ($info);
-  
-  
+    if($r_array==0) {
+      return ($data);
+    } else {
+      return ($info);
+    }
   }
  
 
@@ -807,27 +857,75 @@ class LDAP{
   }
 
 
-  function gen_ldif ($srp, $dn, $filter= "(objectClass=*)", $attributes= array('*'), $recursive= TRUE)
+  /*! \brief  Generates an ldif for all entries matching the filter settings, scope and limit.
+   *  @param  $dn           The entry to export.
+   *  @param  $filter       Limit the exported object to those maching this filter.
+   *  @param  $scope        'base', 'sub' .. see manpage for 'ldapmodify' for details.
+   *  @param  $limit        Limits the result.
+   */
+  function generateLdif ($dn, $filter= "(objectClass=*)", $attributes= array(),$scope = 'sub', $limit=0)
   {
-    $display= "";
+        
+      // Attributes are unused !!
+      $attrs = '';
 
-    if ($recursive){
-      $this->cd($dn);
-      $this->ls($srp, $filter,$dn, array('dn','objectClass'));
-      $deps = array();
+      // Ensure that limit is numeric if not skip here.
+      if(!empty($limit) && !is_numeric($limit)){
+          trigger_error(sprintf("Invalid parameter for limit '%s', a numeric value is required."), $limit);
+          return(NULL);
+      }
+      $limit = (!$limit)?'':' -z '.$limit;
 
-      $display .= $this->gen_one_entry($dn)."\n";
+      // Check scope values
+      $scope = trim($scope);
+      if(!empty($scope) && !in_array($scope, array('base', 'one', 'sub', 'children'))){
+          trigger_error(sprintf("Invalid parameter for scope '%s', please use 'base', 'one', 'sub' or 'children'."), $scope);
+          return(NULL);
+      }
+      $scope = (!empty($scope))?' -s '.$scope: '';
 
-      while ($attrs= $this->fetch($srp)){
-        $deps[] = $attrs['dn'];
+      // First check if we are able to call 'ldapsearch' on the command line.
+      $check = shell_exec('which ldapsearch');
+      if(empty($check)){
+        $this->error = sprintf(_("Missing command line programm '%s'!"), 'ldapsearch');
+        return(NULL);
       }
-      foreach($deps as $dn){
-        $display .= $this->gen_ldif($srp, $dn, $filter,$attributes,$recursive);
+
+      // Prepare parameters to be valid for shell execution
+      $dn = escapeshellarg($dn);
+      $pwd = $this->bindpw;
+      $host = escapeshellarg($this->hostname);
+      $admin = escapeshellarg($this->binddn);
+      $filter = escapeshellarg($filter);
+
+        
+      $cmd = "ldapsearch -x -LLLL -D {$admin} {$filter} {$limit} {$scope} -H {$host} -b {$dn} -w {$pwd} ";
+
+      // Create list of process pipes
+      $descriptorspec = array(
+              0 => array("pipe", "r"),  // stdin
+              1 => array("pipe", "w"),  // stdout
+              2 => array("pipe", "w")); // stderr
+
+      // Try to open the process
+      $process = proc_open($cmd, $descriptorspec, $pipes);
+      if (is_resource($process)) {
+
+          // Write the password to stdin
+          fclose($pipes[0]);
+
+          // Get results from stdout and stderr
+          $res = stream_get_contents($pipes[1]);
+          $err = stream_get_contents($pipes[2]);
+          fclose($pipes[1]);
+
+          // Close the process and check its return value
+          if(proc_close($process) != 0){
+              $this->error = $err;
+              return(NULL);
+          }
       }
-    } else {
-      $display.= $this->gen_one_entry($dn);
-    }
-    return ($display);
+      return($res);
   }
 
 
@@ -852,58 +950,7 @@ class LDAP{
 
     return ($display);
   }
-
-
-  function gen_one_entry($dn, $filter= "(objectClass=*)" , $name= array("*"))
-  {
-    $ret = "";
-    $data = "";
-    if($this->reconnect){
-      $this->connect();
-    }
-
-    /* Searching Ldap Tree */
-    $sr= @ldap_read($this->cid, LDAP::fix($dn), $filter, $name);
-
-    /* Get the first entry */   
-    $entry= @ldap_first_entry($this->cid, $sr);
-
-    /* Get all attributes related to that Objekt */
-    $atts = array();
     
-    /* Assemble dn */
-    $atts[0]['name']  = "dn";
-    $atts[0]['value'] = array('count' => 1, 0 => $dn);
-
-    /* Reset index */
-    $i = 1 ; 
-  $identifier = array();
-    $attribute= @ldap_first_attribute($this->cid,$entry,$identifier);
-    while ($attribute) {
-      $i++;
-      $atts[$i]['name']  = $attribute;
-      $atts[$i]['value'] = @ldap_get_values_len($this->cid, $entry, "$attribute");
-
-      /* Next one */
-      $attribute= @ldap_next_attribute($this->cid,$entry,$identifier);
-    }
-
-    foreach($atts as $at)
-    {
-      for ($i= 0; $i<$at['value']['count']; $i++){
-
-        /* Check if we must encode the data */
-        if(!preg_match('/^[a-z0-9+@#.=, \/ -]+$/i', $at['value'][$i])) {
-          $ret .= $at['name'].":: ".base64_encode($at['value'][$i])."\n";
-        } else {
-          $ret .= $at['name'].": ".$at['value'][$i]."\n";
-        }
-      }
-    }
-
-    return($ret);
-  }
-
 
   function dn_exists($dn)
   {
@@ -923,9 +970,9 @@ class LDAP{
   {
     if($this->reconnect) $this->connect();
 
-    /* First we have to splitt the string ito detect empty lines
+    /* First we have to split the string into empty lines.
        An empty line indicates an new Entry */
-    $entries = split("\n",$str_attr);
+    $entries = preg_split("/\n/",$str_attr);
 
     $data = "";
     $cnt = 0; 
@@ -966,9 +1013,9 @@ class LDAP{
         /* Append lines ... */
         if(!empty($tmp2)) {
           /* check if we need base64_decode for this line */
-          if(ereg("::",$tmp2))
+          if(strstr($tmp2, "::") !== false)
           {
-            $encoded = split("::",$entry);
+            $encoded = explode("::",$entry);
             $attr  = trim($encoded[0]);
             $value = base64_decode(trim($encoded[1]));
             /* Add linenumber */
@@ -991,11 +1038,11 @@ class LDAP{
        
        Now we check every insertblock and try to insert */
     foreach ( $all as $single) {
-      $lineone = split("\n",$single);  
-      $ndn = split("#", $lineone[0]);
+      $lineone = preg_split("/\n/",$single);  
+      $ndn = explode("#", $lineone[0]);
       $line = base64_decode($ndn[1]);
 
-      $dnn = split (":",$line,2);
+      $dnn = explode (":",$line,2);
       $current_line = $ndn[0];
       $dn    = $dnn[0];
       $value = $dnn[1];
@@ -1057,7 +1104,7 @@ class LDAP{
     if($this->reconnect) $this->connect();
 
     $ret = false;
-    $rows= split("\n",$str_attr);
+    $rows= preg_split("/\n/",$str_attr);
     $data= false;
 
     foreach($rows as $row) {
@@ -1069,13 +1116,13 @@ class LDAP{
 
           /* We are using line numbers 
              Because there is a # before a : */
-          $tmp1= split("#",$row);
+          $tmp1= explode("#",$row);
           $current_line= $tmp1[0];
           $row= base64_decode($tmp1[1]);
         }
 
         /* Split the line into  attribute  and value */
-        $attr   = split(":", $row,2);
+        $attr   = explode(":", $row,2);
         $attr[0]= trim($attr[0]);  /* attribute */
         $attr[1]= $attr[1];  /* value */
 
@@ -1178,7 +1225,7 @@ class LDAP{
   
   function importcsv($str)
   {
-    $lines = split("\n",$str);
+    $lines = preg_split("/\n/",$str);
     foreach($lines as $line)
     {
       /* continue if theres a comment */
@@ -1190,15 +1237,15 @@ class LDAP{
       $line= str_replace ("\t"  ,"," ,$line);
       echo $line;
 
-      $cells = split(",",$line )  ;
+      $cells = explode(",",$line )  ;
       $linet= str_replace ("\t\t",",",$line);
-      $cells = split("\t",$line);
+      $cells = preg_split("/\t/",$line);
       $count = count($cells);  
     }
 
   }
   
-  function get_objectclasses()
+  function get_objectclasses( $force_reload = FALSE)
   {
     $objectclasses = array();
     global $config;
@@ -1211,8 +1258,8 @@ class LDAP{
     }
 
     /* Return the cached results. */
-    if(class_available('session') && session::is_set("LDAP_CACHE::get_objectclasses")){
-      $objectclasses = session::get("LDAP_CACHE::get_objectclasses");
+    if(class_available('session') && session::global_is_set("LDAP_CACHE::get_objectclasses") && !$force_reload){
+      $objectclasses = session::global_get("LDAP_CACHE::get_objectclasses");
       return($objectclasses);
     }
        
@@ -1236,7 +1283,7 @@ class LDAP{
         continue;
       }
       $name= "OID";
-      $pattern= split(' ', $val);
+      $pattern= explode(' ', $val);
       $ocname= preg_replace("/^.* NAME\s+\(*\s*'([^']+)'\s*\)*.*$/", '\\1', $val);
       $objectclasses[$ocname]= array();
 
@@ -1248,7 +1295,11 @@ class LDAP{
                     break;
 
           case ')': if ($name != ""){
-                      $objectclasses[$ocname][$name]= $this->value2container($value);
+                      $v = $this->value2container($value);
+                      if(in_array($name, array('MUST', 'MAY')) && !is_array($v)){
+                        $v = array($v);
+                      }
+                      $objectclasses[$ocname][$name]= $v;
                     }
                     $name= "";
                     $value= "";
@@ -1263,7 +1314,11 @@ class LDAP{
           case 'MUST':
           case 'MAY':
                     if ($name != ""){
-                      $objectclasses[$ocname][$name]= $this->value2container($value);
+                      $v = $this->value2container($value);
+                      if(in_array($name, array('MUST', 'MAY')) && !is_array($v)){
+                        $v = array($v);
+                      }
+                      $objectclasses[$ocname][$name]= $v;
                     }
                     $name= $chunk;
                     $value= "";
@@ -1275,7 +1330,7 @@ class LDAP{
 
          }
     if(class_available("session")){
-      session::set("LDAP_CACHE::get_objectclasses",$objectclasses);
+      session::global_set("LDAP_CACHE::get_objectclasses",$objectclasses);
     }
 
          return $objectclasses;
@@ -1306,8 +1361,8 @@ class LDAP{
 
   function log($string)
   {
-    if (session::is_set('config')){
-      $cfg = session::get('config');
+    if (session::global_is_set('config')){
+      $cfg = session::global_get('config');
       if (isset($cfg->current['LDAPSTATS']) && preg_match('/true/i', $cfg->current['LDAPSTATS'])){
         syslog (LOG_INFO, $string);
       }
@@ -1316,10 +1371,10 @@ class LDAP{
 
   /* added by Guido Serra aka Zeph <zeph@purotesto.it> */
   function getCn($dn){
-    $simple= split(",", $dn);
+    $simple= explode(",", $dn);
 
     foreach($simple as $piece) {
-      $partial= split("=", $piece);
+      $partial= explode("=", $piece);
 
       if($partial[0] == "cn"){
         return $partial[1];