Code

Replaced config->search with get_cfg_value
[gosa.git] / gosa-core / include / class_ldap.inc
index 4b578a8f9f910fde6e4bc0d93a31ba7f1958e103..21fc089307554f4e25d9449088097a3e13ed8ec9 100644 (file)
@@ -60,8 +60,8 @@ class LDAP{
     $this->hostname=$hostname;
 
     /* Check if MAX_LDAP_QUERY_TIME is defined */ 
-    if(is_object($config) && $config->get_cfg_value("ldapMaxQueryTime") != ""){
-      $str = $config->get_cfg_value("ldapMaxQueryTime");
+    if(is_object($config) && $config->get_cfg_value("core","ldapMaxQueryTime") != ""){
+      $str = $config->get_cfg_value("core","ldapMaxQueryTime");
       $this->max_ldap_query_time = (float)($str);
     }
 
@@ -87,12 +87,13 @@ class LDAP{
      \2C => CO
      (   => OB
      )   => CB
-     /   => SL                                                                  */
+     /   => SL                                                                  
+     \22 => DQ                                                                  */
   static function convert($dn)
   {
     if (SPECIALS_OVERRIDE == TRUE){
-      $tmp= preg_replace(array("/\\\\,/", "/\\\\2C/", "/\(/", "/\)/", "/\//"),
-          array("\001CO", "\001CO", "\001OB", "\001CB", "\001SL"),
+      $tmp= preg_replace(array("/\\\\,/", "/\\\\2C/", "/\(/", "/\)/", "/\//", "/\\\\22/", '/\\\\"/'),
+          array("\001CO", "\001CO", "\001OB", "\001CB", "\001SL", "\001DQ", "\001DQ"),
           $dn);
       return (preg_replace('/,\s+/', ',', $tmp));
     } else {
@@ -108,8 +109,8 @@ class LDAP{
   static function fix($dn)
   {
     if (SPECIALS_OVERRIDE == TRUE){
-      return (preg_replace(array("/\001CO/", "/\001OB/", "/\001CB/", "/\001SL/"),
-            array("\,", "(", ")", "/"),
+      return (preg_replace(array("/\001CO/", "/\001OB/", "/\001CB/", "/\001SL/", "/\001DQ/"),
+            array("\,", "(", ")", "/", '\"'),
             $dn));
     } else {
       return ($dn);
@@ -207,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));
   }
 
   
@@ -218,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);
@@ -227,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);
+          msg_dialog::display(_("Performance warning"), sprintf(_("LDAP performance is poor: last query took %.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";
@@ -252,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);
@@ -260,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);
+          msg_dialog::display(_("Performance warning"), sprintf(_("LDAP performance is poor: last query took %.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{
@@ -275,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);
@@ -556,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)
   {
@@ -566,11 +587,8 @@ 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() && 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])){
-          $this->error.= " <b>objectClass: ".$attrs['objectClass'][$oc]."</b>"; 
-        }
+      if(!$this->success()){
+        $this->error.= $this->makeReadableErrors($this->error,$attrs);
       }
       return($r ? $r : 0);
     }else{
@@ -585,11 +603,8 @@ 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() && 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])){
-          $this->error.= " <b>objectClass: ".$attrs['objectClass'][$oc]."</b>"; 
-        }
+      if(!$this->success()){
+        $this->error.= $this->makeReadableErrors($this->error,$attrs);
       }
       return($r ? $r : 0);
     }else{
@@ -647,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();
 
@@ -657,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'])){
@@ -674,7 +690,7 @@ class LDAP{
 
           /* Bail out, if we've nothing to do... */
           if ($ocname == ""){
-            msg_dialog::display(_("Internal error"), sprintf(_("Cannot automatically create subtrees with RDN '%s': no object class found!"),$type), FATAL_ERROR_DIALOG);
+            msg_dialog::display(_("Internal error"), sprintf(_("Cannot automatically create subtrees with RDN %s: no object class found"), bold($type)), FATAL_ERROR_DIALOG);
             exit();
           }
 
@@ -693,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";
             }
           }
@@ -722,7 +741,7 @@ class LDAP{
               $na["dc"]= $param;
               break;
             default:
-              msg_dialog::display(_("Internal error"), sprintf(_("Cannot automatically create subtrees with RDN '%s': not supported"),$type), FATAL_ERROR_DIALOG);
+              msg_dialog::display(_("Internal error"), sprintf(_("Cannot automatically create subtrees with RDN %s: not supported"), bold($type)), FATAL_ERROR_DIALOG);
               exit();
           }
 
@@ -809,9 +828,9 @@ class LDAP{
     } else {
       $adderror= $this->get_additional_error();
       if ($adderror != ""){
-        $error= $this->error." (".$this->get_additional_error().", ".sprintf(_("while operating on '%s' using LDAP server '%s'"), $this->basedn, $this->hostname).")";
+        $error= $this->error." (".$this->get_additional_error().", ".sprintf(_("while operating on %s using LDAP server %s"), bold($this->basedn), bold($this->hostname)).")";
       } else {
-        $error= $this->error." (".sprintf(_("while operating on LDAP server %s"), $this->hostname).")";
+        $error= $this->error." (".sprintf(_("while operating on LDAP server %s"), bold($this->hostname)).")";
       }
       return $error;
     }
@@ -838,27 +857,29 @@ 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  $attributes   Specify the attributes to export here, empty means all.
+   *  @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= "";
-
-    if ($recursive){
-      $this->cd($dn);
-      $this->ls($srp, $filter,$dn, array('dn','objectClass'));
-      $deps = array();
-
-      $display .= $this->gen_one_entry($dn)."\n";
-
-      while ($attrs= $this->fetch($srp)){
-        $deps[] = $attrs['dn'];
-      }
-      foreach($deps as $dn){
-        $display .= $this->gen_ldif($srp, $dn, $filter,$attributes,$recursive);
-      }
-    } else {
-      $display.= $this->gen_one_entry($dn);
-    }
-    return ($display);
+      $attrs  = (count($attributes))?implode($attributes,' '):'';
+      $scope = (!empty($scope))?' -s '.$scope: '';
+      $limit = (!$limit)?'':' -z '.$limit;
+      $dn = escapeshellarg($dn);
+      $admin = escapeshellarg($this->binddn);
+      $pwd = escapeshellarg($this->bindpw);
+      $filter = escapeshellarg($filter);
+      $host = escapeshellarg($this->hostname);
+      $cmd = "ldapsearch -x -LLLL -D {$admin} -w {$pwd} {$filter} {$limit} {$scope} -H {$host} -b {$dn} $attrs ";
+      ob_start();
+      passthru($cmd);
+      $res=ob_get_contents();
+      ob_end_clean();
+      return($res);
   }
 
 
@@ -885,57 +906,6 @@ class LDAP{
   }
 
 
-  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)
   {
     return @ldap_list($this->cid, LDAP::fix($dn), "(objectClass=*)", array("objectClass"));
@@ -954,9 +924,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; 
@@ -997,9 +967,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 */
@@ -1022,18 +992,18 @@ 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];
 
       /* Every block must begin with a dn */
       if($dn != "dn") {
-        $error= sprintf(_("This is not a valid DN: '%s'. A block for import should begin with 'dn: ...' in line %s"), $line, $current_line);
+        $error= sprintf(_("Invalid DN %s: block to be imported should start with 'dn: ...' in line %s"), bold($line), bold($current_line));
         return -2;  
       }
 
@@ -1062,7 +1032,7 @@ class LDAP{
      
       /* If we can't Import, return with a file error */
       if(!$this->import_single_entry($srp, $single,$usemodify,$usermdir) ) {
-        $error= sprintf(_("Error while importing dn: '%s', please check your LDIF from line %s on!"), $line,
+        $error= sprintf(_("Error while importing DN %s: please check LDIF from line %s on!"), bold($line),
                         $current_line);
         return UNKNOWN_TOKEN_IN_LDIF_FILE;      }
     }
@@ -1088,7 +1058,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) {
@@ -1100,13 +1070,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 */
 
@@ -1209,7 +1179,7 @@ class LDAP{
   
   function importcsv($str)
   {
-    $lines = split("\n",$str);
+    $lines = preg_split("/\n/",$str);
     foreach($lines as $line)
     {
       /* continue if theres a comment */
@@ -1221,9 +1191,9 @@ 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);  
     }
 
@@ -1236,7 +1206,7 @@ class LDAP{
 
     /* Only read schema if it is allowed */
     if(isset($config) && preg_match("/config/i",get_class($config))){
-      if ($config->get_cfg_value("schemaCheck") != "true"){
+      if ($config->get_cfg_value("core","schemaCheck") != "true"){
         return($objectclasses);
       } 
     }
@@ -1267,7 +1237,7 @@ class LDAP{
         continue;
       }
       $name= "OID";
-      $pattern= split(' ', $val);
+      $pattern= explode(' ', $val);
       $ocname= preg_replace("/^.* NAME\s+\(*\s*'([^']+)'\s*\)*.*$/", '\\1', $val);
       $objectclasses[$ocname]= array();
 
@@ -1279,7 +1249,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= "";
@@ -1294,7 +1268,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= "";
@@ -1347,10 +1325,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];