Code cleaning

src/includes/class/class.LSattr_html_select_object.php

@@ -45,11 +45,17 @@ class LSattr_html_select_object extends LSattr_html{
    *
    * @return LSformElement|false L'element du formulaire ajouté, ou false
    */
-  public function addToForm (&$form,$idForm,$data=NULL) {
+  public function addToForm (&$form, $idForm, $data=NULL) {
     $this -> config['attrObject'] = $this;
-    $element=$form -> addElement($this -> LSformElement_type, $this -> name, $this -> getLabel(), $this -> config, $this);
+    $element = $form -> addElement(
+      $this -> LSformElement_type,
+      $this -> name,
+      $this -> getLabel(),
+      $this -> config,
+      $this
+    );
     if(!$element) {
-      LSerror :: addErrorCode('LSform_06',$this -> name);
+      LSerror :: addErrorCode('LSform_06', $this -> name);
       return false;
     }
     if ($data) {
@@ -71,8 +77,8 @@ class LSattr_html_select_object extends LSattr_html{
    *
    * @return array La valeur formatée de l'attribut (array('DNs' => 'displayName'))
    **/
-  public function refreshForm($data,$fromDNs=false) {
+  public function refreshForm($data, $fromDNs=false) {
-    return $this -> getFormValues($data,$fromDNs);
+    return $this -> getFormValues($data, $fromDNs);
   }
 
   /**
@@ -174,8 +180,8 @@ class LSattr_html_select_object extends LSattr_html{
    *
    * @param mixed $values array|null Array of the input values ()
    * @param boolean $fromDNs boolean If true, considered provided values as DNs (default: false)
-   * @param boolean $retrieveAttrValues boolean If true, attribute values will be returned instead
+   * @param boolean $retrieveAttrValues boolean If true, final attribute values will be returned
-   *                                                of selected objects info (default: false)
+   *                                            instead of selected objects info (default: false)
    *
    * @author Benjamin Renard <brenard@easter-eggs.com>
    *
@@ -193,139 +199,166 @@ class LSattr_html_select_object extends LSattr_html{
       self :: log_warning('getFormValues(): $values is not array');
       return false;
     }
+    if (!LSsession :: loadLSclass("LSsearch"))
+      return false;
 
     // Retrieve/check selectable objects config
-    $objs = array();
+    $objs = [];
     $confs = $this -> getSelectableObjectsConfig($objs);
     if (!is_array($confs) || empty($confs)) {
       self :: log_warning('getFormValues(): invalid selectable objects config');
       return false;
     }
 
-    $selected_objects = array();
+    $selected_objects = [];
-    $unrecognizedValues = array();
+    $found_values = [];
-    $found_values = array();
+    $unrecognizedValues = [];
     foreach ($confs as $conf) {
+      $common_search_params = [
+        "filter" => $conf['filter'],
+        "attributes" => (
+          $retrieveAttrValues && !in_array($conf['value_attribute'], ["dn", "%{dn}"])?
+          [$conf['value_attribute']]:
+          [$objs[$conf['object_type']]->rdn_attr]
+        ),
+        "displayFormat" => (
+          $conf['display_name_format']?
+          $conf['display_name_format']:
+          $objs[$conf['object_type']] -> getDisplayNameFormat()
+        ),
+      ];
       foreach($values as $value) {
-        // If we already mark its value as unrecognized, pass
+        // Ignore empty value and value already marked as unrecognized
-        if (in_array($value, $unrecognizedValues))
+        if (empty($value) || in_array($value, $unrecognizedValues))
           continue;
 
-        // Ignore empty value
+        // Compute search params based on value attribute type (DN or attribute valued) and $fromDNs
-        if (empty($value))
+        if($fromDNs || in_array($conf['value_attribute'], ['dn', '%{dn}'])) {
-          continue;
+          if ($conf['onlyAccessible'] && !LSsession :: canAccess($conf['object_type'], $value)) {
-
+            self :: log_debug(
-        // Determine value attribute: DN/attribute valued (or force form DNs)
+              "getFormValues(): object {$conf['object_type']} '$value' is not accessible, pass"
-        if(($conf['value_attribute']=='dn') || ($conf['value_attribute']=='%{dn}') || $fromDNs) {
+            );
-          // Construct resulting list from DN values
-          if ($conf['onlyAccessible']) {
-            if (!LSsession :: canAccess($conf['object_type'], $value)) {
-              self :: log_debug("getFormValues(): ".$conf['object_type']."($value): not accessible, pass");
-              continue;
-            }
-          }
-
-          // Load object data (with custom filter if defined)
-          if(!$objs[$conf['object_type']] -> loadData($value, $conf['filter'])) {
-            self :: log_debug("getFormValues(): ".$conf['object_type']."($value): not found, pass");
             continue;
           }
-          self :: log_debug("getFormValues(): ".$conf['object_type']."($value): found");
+          $search_params = array_merge(
+            $common_search_params,
+            ["basedn" => $value, "scope" => "base"]
+          );
+        }
+        else {
+          $filter = Net_LDAP2_Filter::create($conf['value_attribute'], 'equals', $value);
+          $search_params = array_merge(
+            $common_search_params,
+            [
+              "filter" => (
+                $common_search_params["filter"]?
+                LSldap::combineFilters('and', [$common_search_params["filter"], $filter]):
+                $filter
+              ),
+            ]
+          );
+        }
 
-          // Check if it's the first this value match with an object
+        // Search object
-          if (isset($found_values[$value])) {
+        $LSsearch = new LSsearch(
-            // DN match with multiple object type
+          $conf['object_type'],
-            LSerror :: addErrorCode('LSattr_html_select_object_03',array('val' => $value, 'attribute' => $this -> name));
+          'LSattr_html_select_object::getFormValues',
-            $unrecognizedValues[] = $value;
+          $search_params,
-            unset($selected_objects[$found_values[$value]]);
+          true
-            break;
+        );
-          }
-          $found_values[$value] = $value;
 
-          if ($retrieveAttrValues) {
+        if(!$LSsearch -> run(false)) {
-            // Retrieve attribute value case: $selected_objects[dn] = attribute value
+          self :: log_warning(
-            if(($conf['value_attribute']=='dn') || ($conf['value_attribute']=='%{dn}')) {
+            "getFormValues(): error during search of object(s) {$conf['object_type']} ".
-              $selected_objects[$value] = $value;
+            "for value '$value', pass"
-            }
+          );
-            else {
+          continue;
-              $val = $objs[$conf['object_type']] -> getValue($conf['value_attribute']);
+        }
-              if (!empty($val)) {
+
-                $selected_objects[$value] = $val[0];
+        $entries = $LSsearch -> listEntries();
-              }
+        if (!is_array($entries) || empty($entries)) {
-              else {
+          self :: log_debug(
-                LSerror :: addErrorCode(
+            "getFormValues(): value '$value' not found as {$conf['object_type']}, pass"
-                  'LSattr_html_select_object_06',
+          );
-                  array(
+          continue;
-                    'name' => $objs[$conf['object_type']] -> getDisplayName($conf['display_name_format']),
+        }
-                    'attr' => $this -> name
+
-                  )
+        if (count($entries) > 1) {
-                );
+          self :: log_warning(
-              }
+            "getFormValues(): ".count($entries)." objects {$conf['object_type']} found ".
-            }
+            "for value '$value', pass: ".implode(" / ", array_keys($entries))
+          );
+          if (array_key_exists($value, $selected_objects))
+            unset($selected_objects[$value]);
+          $unrecognizedValues[] = $value;
+          $found_values[$value] = (
+            array_key_exists($value, $found_values)?
+            array_merge($found_values[$value], array_keys($entries)):
+            array_keys($entries)
+          );
+          break;
+        }
+        $entry = $entries[key($entries)];
+        self :: log_debug(
+          "getFormValues(): value '$value' found as {$conf['object_type']}: {$entry->dn}"
+        );
+
+        // Check if it's the first this value match with an object
+        if (array_key_exists($value, $found_values)) {
+          // DN match with multiple object type
+          LSerror :: addErrorCode(
+            'LSattr_html_select_object_03',
+            ['val' => $value, 'attribute' => $this -> name]
+          );
+          unset($selected_objects[$value]);
+          $unrecognizedValues[] = $value;
+          $found_values[$value][] = $entry->dn;
+          break;
+        }
+        $found_values[$value] = [$entry->dn];
+
+        if ($retrieveAttrValues) {
+          // Retrieve attribute value case: $selected_objects[dn] = attribute value
+          if(($conf['value_attribute']=='dn') || ($conf['value_attribute']=='%{dn}')) {
+            $selected_objects[$value] = $entry->dn;
           }
           else {
-            // General case: $selected_objects[dn] = array(name + object_type)
+            $val = ensureIsArray($entry -> get($conf['value_attribute']));
-            $selected_objects[$value] = array(
+            if (!empty($val)) {
-              'name' => $objs[$conf['object_type']] -> getDisplayName($conf['display_name_format']),
+              $selected_objects[$value] = $val[0];
-              'object_type' => $conf['object_type'],
+            }
-            );
+            else {
-            self :: log_debug("getFormValues(): ".$conf['object_type']."($value): ".varDump($selected_objects[$value]));
+              LSerror :: addErrorCode(
+                'LSattr_html_select_object_06',
+                array(
+                  'name' => $entry -> displayName,
+                  'attr' => $this -> name
+                )
+              );
+            }
           }
         }
         else {
-          // Construct resulting list from attributes values
+          // General case: $selected_objects[dn] = array(name + object_type)
-          $filter = Net_LDAP2_Filter::create($conf['value_attribute'], 'equals', $value);
+          $selected_objects[$value] = array(
-          if (isset($conf['filter']))
+            'name' => $entry -> displayName,
-            $filter = LSldap::combineFilters('and', array($filter, $conf['filter']));
+            'object_type' => $conf['object_type'],
-          $sparams = array();
+          );
-          $sparams['onlyAccessible'] = $conf['onlyAccessible'];
+          self :: log_debug(
-          $listobj = $objs[$conf['object_type']] -> listObjectsName(
+            "getFormValues(): object {$conf['object_type']} info for value '$value': ".
-            $filter,
+            varDump($selected_objects[$value])
-            NULL,
-            $sparams,
-            $conf['display_name_format']
           );
-          if (count($listobj)==1) {
-            if (isset($found_values[$value])) {
-                // Value match with multiple object type
-                LSerror :: addErrorCode('LSattr_html_select_object_03',array('val' => $value, 'attribute' => $this -> name));
-                $unrecognizedValues[] = $value;
-                unset($selected_objects[$found_values[$value]]);
-                break;
-            }
-            $dn = key($listobj);
-            $selected_objects[$dn] = array(
-              'name' => $listobj[$dn],
-              'object_type' => $conf['object_type'],
-            );
-            $found_values[$value] = $dn;
-          }
-          else if(count($listobj) > 1) {
-            LSerror :: addErrorCode('LSattr_html_select_object_03',array('val' => $value, 'attribute' => $this -> name));
-            if (!in_array($value, $unrecognizedValues))
-              $unrecognizedValues[] = $value;
-            break;
-          }
         }
       }
     }
 
-    // Check if all values have been found (or already considered as unrecognized)
-    foreach ($values as $value) {
-      if (!isset($found_values[$value]) && !in_array($value, $unrecognizedValues)) {
-        self :: log_debug("getFormValues(): value '$value' not recognized");
-        $unrecognizedValues[] = $value;
-      }
-    }
-
     // Retrieve attribute values case: return forged array values (list of attribute values)
     if ($retrieveAttrValues)
       return array_values($selected_objects);
 
     // General case
-    self :: log_debug("getFormValues(): unrecognizedValues=".varDump($unrecognizedValues));
+    $this -> unrecognizedValues = array_diff($values, array_keys($selected_objects));
-    $this -> unrecognizedValues = $unrecognizedValues;
+    self :: log_debug("getFormValues(): unrecognizedValues=".varDump($this -> unrecognizedValues));
-
     self :: log_debug("getFormValues(): final values=".varDump($selected_objects));
     return $selected_objects;
   }
@@ -347,7 +380,7 @@ class LSattr_html_select_object extends LSattr_html{
 
 
   /**
-   * Return array of atttribute values form array of form values
+   * Return array of attribute values form array of form values
    *
    * @param mixed $values Array of form values
    *

src/includes/class/class.LSformElement_select_object.php

@@ -140,7 +140,8 @@ class LSformElement_select_object extends LSformElement {
       $this -> attr_html -> getLSselectId(),
       $select_conf,
       boolval($this -> getParam('multiple', 0, 'int')),
-      $this -> values
+      $this -> values,
+      false
     );
     return True;
   }

src/includes/class/class.LSldap.php

@@ -462,8 +462,17 @@ class LSldap extends LSlog_staticLoggerClass {
    *
    * @return boolean  True if entry exists, false otherwise
    */
-  public static function exists($dn) {
+  public static function exists($dn, $filter=null) {
-    return is_a(self :: getLdapEntry($dn), 'Net_LDAP2_Entry');
+    $entry = self :: search(
+      $filter?$filter:"(objectClass=*)",
+      $dn,
+      [
+        "scope" => "base",
+        "attronly" => true,
+        "attributes" => ["objectClass"],
+      ]
+    );
+    return boolval($entry);
   }
 
  /**

src/includes/class/class.LSldapObject.php

@@ -149,6 +149,23 @@ class LSldapObject extends LSlog_staticLoggerClass {
     }
   }
 
+  /**
+   * Check if the specified object exists
+   * @param string $dn Object's DN
+   * @param string|Net_LDAP2_Filter|null $filter Extra LDAP that object must match (optional, default: null)
+   * @return bool
+   */
+  public static function exists($dn, $filter=null) {
+    return LSldap::exists(
+      $dn,
+      (
+        $filter?
+        LSldap::combineFilters("and", [static :: _getObjectFilter(), $filter]):
+        static :: _getObjectFilter()
+      )
+    );
+  }
+
   /**
    * Load object data from LDAP
    *
@@ -901,40 +918,43 @@ class LSldapObject extends LSlog_staticLoggerClass {
   }
 
   /**
-   * Retourne le filtre correpondants aux objetcClass de l'objet courant
+   * Return LDAP filter string of the current object type
    *
    * @author Benjamin Renard <brenard@easter-eggs.com>
    *
-   * @return Net_LDAP2_Filter le filtre ldap correspondant au type de l'objet
+   * @return Net_LDAP2_Filter LDAP filter as a Net_LDAP2_Filter object, or false in case of error
    */
   public function getObjectFilter() {
     return self :: _getObjectFilter($this -> type_name);
   }
 
   /**
-   * Retourne le filtre correpondants aux objetcClass de l'objet
+   * Return object type LDAP filter string
+   *
+   * @param string|null $type Object type (optional, default: called class)
    *
    * @author Benjamin Renard <brenard@easter-eggs.com>
    *
-   * @return Net_LDAP2_Filter|false le filtre ldap correspondant au type de l'objet, ou false
+   * @return Net_LDAP2_Filter|false LDAP filter as a Net_LDAP2_Filter object, or false in case of error
    */
-  public static function _getObjectFilter($type) {
+  public static function _getObjectFilter($type=null) {
-    $oc=LSconfig::get("LSobjects.$type.objectclass");
+    $type = $type?$type:get_called_class();
-    if(!is_array($oc)) return false;
+    $oc = LSconfig::get("LSobjects.$type.objectclass");
-    $filters=array();
+    if(!is_array($oc) || !$oc) return false;
+    $filters = [];
     foreach ($oc as $class) {
-      $filters[]=Net_LDAP2_Filter::create('objectClass','equals',$class);
+      $filters[] = Net_LDAP2_Filter::create('objectClass', 'equals', $class);
     }
 
-    $filter=LSconfig::get("LSobjects.$type.filter");
+    $filter = LSconfig::get("LSobjects.$type.filter");
     if ($filter) {
-      $filters[]=Net_LDAP2_Filter::parse($filter);
+      $filters[] = Net_LDAP2_Filter::parse($filter);
     }
 
-    $filter = LSldap::combineFilters('and',$filters);
+    $filter = LSldap::combineFilters('and', $filters);
     if ($filter)
       return $filter;
-    LSerror :: addErrorCode('LSldapObject_30',$type);
+    LSerror :: addErrorCode('LSldapObject_30', $type);
     return false;
   }
 
@@ -1004,37 +1024,40 @@ class LSldapObject extends LSlog_staticLoggerClass {
    *
    * @param Net_LDAP2_Filter|string|null $filter LDAP search filter
    * @param string|null $sbasedn Base DN of the search
-   * @param array $sparams Search parameters (as expected by Net_LDAP2::search())
+   * @param array|null $sparams Search parameters (as expected by Net_LDAP2::search())
    * @param string|false $displayFormat LSformat of objects's display name
    * @param bool $cache Enable/disable cache (default: true)
    *
    * @return array|false Tableau dn => name correspondant au resultat de la recherche, ou false
    */
-  public function listObjectsName($filter=NULL,$sbasedn=NULL,$sparams=array(),$displayFormat=false,$cache=true) {
+  public function listObjectsName($filter=NULL, $sbasedn=NULL, $sparams=null, $displayFormat=false, $cache=true) {
     if (!LSsession :: loadLSclass('LSsearch')) {
-      LSerror::addErrorCode('LSsession_05','LSsearch');
+      LSerror::addErrorCode('LSsession_05', 'LSsearch');
       return false;
     }
 
-    if (!$displayFormat) {
+    $params = [
-      $displayFormat = $this -> getDisplayNameFormat();
+      'displayFormat' => $displayFormat?$displayFormat:$this -> getDisplayNameFormat(),
-    }
-
-    $params = array(
-      'displayFormat' => $displayFormat,
       'basedn' => $sbasedn,
       'filter' => $filter
+    ];
+
+    $LSsearch = new LSsearch(
+      $this -> type_name,
+      'LSldapObject::listObjectsName',
+      (
+        is_array($sparams)?
+        $params = array_merge($sparams, $params):
+        $sparams
+      ),
+      true
     );
 
-    if (is_array($sparams)) {
+    return (
-      $params=array_merge($sparams,$params);
+      $LSsearch -> run($cache)?
-    }
+      $LSsearch -> listObjectsName():
-
+      false
-    $LSsearch = new LSsearch($this -> type_name,'LSldapObject::listObjectsName',$params,true);
+    );
-
-    $LSsearch -> run($cache);
-
-    return $LSsearch -> listObjectsName();
   }
 
 

src/includes/class/class.LSselect.php

@@ -51,9 +51,10 @@ class LSselect extends LSlog_staticLoggerClass {
    * @param boolean $multiple                   True if this selection permit to select more than one object, False otherwise (optional,
    *                                                  default: false)
    * @param array|null $current_selected_objects  Array of current selected objects (optional, see setSelectedObjects for format specification)
+   * @param bool $check_objects Check selected objects (optional, default: true)
    * @return void
    */
-  public static function init($id, $LSobjects, $multiple=false, $current_selected_objects=null) {
+  public static function init($id, $LSobjects, $multiple=false, $current_selected_objects=null, $check_objects=true) {
     if ( !isset($_SESSION['LSselect']) || !is_array($_SESSION['LSselect']))
       $_SESSION['LSselect'] = array();
     $_SESSION['LSselect'][$id] = array (
@@ -62,8 +63,11 @@ class LSselect extends LSlog_staticLoggerClass {
       'selected_objects' => array(),
     );
     if (is_array($current_selected_objects))
-      self :: setSelectedObjects($id, $current_selected_objects);
+      self :: setSelectedObjects($id, $current_selected_objects, $check_objects);
-    self :: log_debug("Initialized with id=$id: multiple=".($multiple?'yes':'no')." ".count($_SESSION['LSselect'][$id]['selected_objects'])." selected object(s).");
+    self :: log_debug(
+      "Initialized with id=$id: multiple=".($multiple?'yes':'no')." ".
+      count($_SESSION['LSselect'][$id]['selected_objects'])." selected object(s)."
+    );
   }
 
   /**
@@ -216,6 +220,7 @@ class LSselect extends LSlog_staticLoggerClass {
    * @param array $selected_objects Array of selectable object info with objects's DN
    *                                    as key and array of object's info as value. Objects's
    *                                    info currently contains only the object type (key=object_type).
+   * @param bool $check_objects Check selected objects (optional, default: true)
    *
    * @return array|false Array of selectable object info with objects's DN as key
    *                     and array of object's info as value. Objects's info returned
@@ -224,24 +229,37 @@ class LSselect extends LSlog_staticLoggerClass {
    *
    * @return void
    */
-  public static function setSelectedObjects($id, $selected_objects) {
+  public static function setSelectedObjects($id, $selected_objects, $check_objects=true) {
     if (!self :: exists($id))
       return;
     if (!is_array($selected_objects))
       return;
-    $_SESSION['LSselect'][$id]['selected_objects'] = array();
+    $previously_selected = $_SESSION['LSselect'][$id]['selected_objects'];
+    $_SESSION['LSselect'][$id]['selected_objects'] = [];
     foreach($selected_objects as $dn => $info) {
       if (!is_array($info) || !isset($info['object_type'])) {
         self :: log_warning("setSelectedObjects($id): invalid object info for dn='$dn'");
         continue;
       }
-      if (self :: checkObjectIsSelectable($id, $info['object_type'], $dn))
+      if (
-        $_SESSION['LSselect'][$id]['selected_objects'][$dn] = $info;
+        $check_objects
-      else {
+        && !(
-        self :: log_warning("setSelectedObjects($id): object type='".$info['object_type']."' and dn='$dn' is not selectable".varDump($_SESSION['LSselect'][$id]));
+          in_array($dn, $previously_selected)
+          || self :: checkObjectIsSelectable($id, $info['object_type'], $dn)
+        )
+      ) {
+        self :: log_warning(
+          "setSelectedObjects($id): object type='{$info['object_type']}' and dn='$dn' is not ".
+          "selectable"
+        );
+        continue;
       }
+      $_SESSION['LSselect'][$id]['selected_objects'][$dn] = $info;
     }
-    self :: log_debug("id=$id: updated with ".count($_SESSION['LSselect'][$id]['selected_objects'])." selected object(s).");
+    self :: log_debug(
+      "setSelectedObjects($id): updated with ".
+      count($_SESSION['LSselect'][$id]['selected_objects'])." selected object(s)."
+    );
   }
 
   /**
@@ -250,29 +268,46 @@ class LSselect extends LSlog_staticLoggerClass {
    * @param string $id The LSselect ID
    * @param string $object_type The object type
    * @param string $object_dn The object DN
+   * @param bool $check_exists Check if object exists in LDAP (optional, default: true)
    *
    * @return boolean True if object is selectable, false otherwise
    */
-  public static function checkObjectIsSelectable($id, $object_type, $object_dn) {
+  public static function checkObjectIsSelectable($id, $object_type, $object_dn, $check_exists=true) {
     if (!self :: exists($id)) {
-      self :: log_warning("checkObjectIsSelectable($id, $object_type, $object_dn): LSselect $id doesn't exists");
+      self :: log_warning(
+        "checkObjectIsSelectable($id, $object_type, $object_dn): LSselect $id doesn't exists"
+      );
       return false;
     }
     if (!array_key_exists($object_type, $_SESSION['LSselect'][$id]['LSobjects'])) {
-      self :: log_warning("checkObjectIsSelectable($id, $object_type, $object_dn): object type $object_type not selectabled");
+      self :: log_warning(
+        "checkObjectIsSelectable($id, $object_type, $object_dn): object type $object_type not ".
+        "selectable"
+      );
       return false;
     }
 
     // Load LSobject type
     if ( !LSsession :: loadLSobject($object_type) ) {
-      self :: log_warning("checkObjectIsSelectable($id, $object_type, $object_dn): fail to load object type $object_type");
+      self :: log_warning(
+        "checkObjectIsSelectable($id, $object_type, $object_dn): fail to load object type ".
+        $object_type
+      );
       return false;
     }
 
-    // Instanciate object and load object data from DN
+    // Check object exists
-    $object = new $object_type();
+    if (
-    if (!$object -> loadData($object_dn, self :: getConfig($id, "LSobjects.$object_type.filter", null))) {
+      $check_exists
-      self :: log_warning("checkObjectIsSelectable($id, $object_type, $object_dn): object $object_dn not found (or does not match with selection filter)");
+      && !$object_type :: exists(
+        $object_dn,
+        self :: getConfig($id, "LSobjects.$object_type.filter", null, "string")
+      )
+    ) {
+      self :: log_warning(
+        "checkObjectIsSelectable($id, $object_type, $object_dn): object $object_dn not found ".
+        "(or does not match with selection filter)"
+      );
       return false;
     }